review 0.9.0 → 1.0.0

data/lib/epubmaker/resource.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+# = resource.rb -- Message resources for EPUBMaker.
+#
+# Copyright (c) 2010 Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+
+module EPUBMaker
+
+# EPUBMaker::Resource contains message translation resources for EPUBMaker.
+  class Resource
+    # Construct message resource object with using +params+["language"] value.
+    def initialize(params)
+      @hash = nil
+      begin
+        @hash = __send__ params["language"]
+      rescue
+        @hash = __send__ :en
+      end
+      
+      @hash.each_pair do |k, v|
+        @hash[k] = params[k] unless params[k].nil?
+      end
+    end
+    
+    # Return message translation for +key+.
+    def v(key)
+      return @hash[key]
+    end
+    
+    private
+    # English messages.
+    def en
+      {
+        "toctitle" => "Table of Contents",
+        "covertitle" => "Cover",
+        "titlepagetitle" => "Title Page",
+        "colophontitle" => "Colophon",
+        "c-aut" => "Author",
+        "c-dsr" => "Designer",
+        "c-ill" => "Illustrator",
+        "c-edt" => "Editor",
+        "c-prt" => "Publisher",
+      }
+    end
+    
+    # Japanese messages.
+    def ja
+      {
+        "toctitle" => "目次",
+        "covertitle" => "表紙",
+        "titlepagetitle" => "権利表記",
+        "colophontitle" => "奥付",
+        "c-aut" => "著　者",
+        "c-dsr" => "デザイン",
+        "c-ill" => "イラスト",
+        "c-edt" => "編　集",
+        "c-prt" => "発行所",
+      }
+    end
+  end
+end

data/lib/review.rb

@@ -1,4 +1,4 @@
+require 'review/i18n'
 require 'review/exception'
-require 'review/env'
 require 'review/compiler'
 require 'review/htmlbuilder'

data/lib/review/book.rb

@@ -32,7 +32,11 @@ module ReVIEW
     def Book.load_default
       %w( . .. ../.. ).each do |basedir|
         if File.file?("#{basedir}/CHAPS")
-          return load(basedir)
+          book = load(basedir)
+          if File.file?("#{basedir}/config.rb")
+            book.instance_variable_set("@parameters", Parameters.load("#{basedir}/config.rb"))
+          end
+          return book
         end
       end
       new('.')
@@ -114,7 +118,17 @@ module ReVIEW
     end
 
     def read_CHAPS
-      File.read("#{@basedir}/#{chapter_file}")
+      res = ""
+      File.open("#{@basedir}/#{chapter_file}") do |f|
+        while line = f.gets
+          if /\A#/ =~ line
+            next
+          end
+          line.gsub!(/#.*$/, "")
+          res << line
+        end
+      end
+      res
     rescue Errno::ENOENT
       Dir.glob("#{@basedir}/*#{ext()}").sort.join("\n")
     end
@@ -207,7 +221,7 @@ module ReVIEW
     end
 
     def mkchap(name)
-      name += ext unless File.extname(name) == ext
+      name += ext if File.extname(name) == ""
       path = "#{@basedir}/#{name}"
       raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
       Chapter.new(self, nil, name, path)
@@ -310,7 +324,7 @@ module ReVIEW
       @ext          = params[:ext]          || '.re'
       @image_dir    = params[:image_dir]    || 'images'
       @image_types  = unify_exts(params[:image_types]  ||
-                                 %w( eps ai tif tiff png bmp jpg jpeg gif svg ))
+                                 %w( eps ai tif tiff png bmp jpg jpeg gif svg pdf ))
       @bib_file  = params[:bib_file]        || "bib#{@ext}"
     end
 
@@ -424,6 +438,7 @@ module ReVIEW
       @table_index = nil
       @footnote_index = nil
       @image_index = nil
+      @icon_index = nil
       @numberless_image_index = nil
       @indepimage_index = nil
       @headline_index = nil
@@ -537,6 +552,7 @@ module ReVIEW
 
     def image(id)
       return image_index()[id] if image_index().has_key?(id)
+      return icon_index()[id] if icon_index().has_key?(id)
       return numberless_image_index()[id] if numberless_image_index().has_key?(id)
       indepimage_index()[id]
     end
@@ -555,6 +571,13 @@ module ReVIEW
       @image_index
     end
 
+    def icon_index
+      @icon_index ||= IconIndex.parse(lines(), id(),
+                                        "#{book.basedir}#{@book.image_dir}",
+                                        @book.image_types)
+      @icon_index
+    end
+
     def indepimage_index
       @indepimage_index ||=
         IndepImageIndex.parse(lines(), id(),

data/lib/review/builder.rb

@@ -11,10 +11,12 @@ require 'review/index'
 require 'review/exception'
 require 'stringio'
 require 'nkf'
+require 'cgi'
 
 module ReVIEW
 
   class Builder
+    CAPTION_TITLES = %w(note memo tip info planning best important security caution term link notice point shoot reference practice expert)
 
     def pre_paragraph
       nil
@@ -196,21 +198,21 @@ module ReVIEW
     end
 
     def inline_list(id)
-      "リスト#{@chapter.list(id).number}"
+      "#{I18n.t("list")}#{@chapter.list(id).number}"
     rescue KeyError
       error "unknown list: #{id}"
       nofunc_text("[UnknownList:#{id}]")
     end
 
     def inline_img(id)
-      "図#{@chapter.image(id).number}"
+      "#{I18n.t("image")}#{@chapter.image(id).number}"
     rescue KeyError
       error "unknown image: #{id}"
       nofunc_text("[UnknownImage:#{id}]")
     end
 
     def inline_table(id)
-      "表#{@chapter.table(id).number}"
+      "#{I18n.t("table")}#{@chapter.table(id).number}"
     rescue KeyError
       error "unknown table: #{id}"
       nofunc_text("[UnknownTable:#{id}]")
@@ -240,6 +242,7 @@ module ReVIEW
     def inline_href(arg)
       url, label = *arg.scan(/(?:(?:(?:\\\\)*\\,)|[^,\\]+)+/).map(&:lstrip)
       url = url.gsub(/\\,/, ",").strip
+      label = label.gsub(/\\,/, ",").strip if label
       compile_href(url, label)
     end
 
@@ -248,12 +251,12 @@ module ReVIEW
     end
 
     def bibpaper(lines, id, caption)
-      puts "<div>"
       bibpaper_header id, caption
       unless lines.empty?
+        puts ""
         bibpaper_bibpaper id, caption, lines
       end
-      puts "</div>"
+      puts ""
     end
 
     def inline_hd(id)
@@ -264,28 +267,44 @@ module ReVIEW
     end
 
     def raw(str)
-      print str.gsub("\\n", "\n")
+      if matched = str.match(/\|(.*?)\|(.*)/)
+        builders = matched[1].split(/,/).map{|i| i.gsub(/\s/, '') }
+        c = self.class.to_s.gsub(/ReVIEW::/, '').gsub(/Builder/, '').downcase
+        if builders.include?(c)
+          print matched[2].gsub("\\n", "\n")
+        else
+          ""
+        end
+      else
+        warn "It is recommended to set builder(s)."
+        print str.gsub("\\n", "\n")
+      end
     end
 
     def find_pathes(id)
-      if ReVIEW.book.param["subdirmode"].nil?
-        re = /\A#{@chapter.name}-#{id}(?i:#{@book.image_types.join('|')})\z/x
+      if ReVIEW.book.param["subdirmode"]
+        re = /\A#{id}(?i:#{@chapter.name.join('|')})\z/x
         entries().select {|ent| re =~ ent }\
-        .sort_by {|ent| @book.image_types.index(File.extname(ent).downcase) }\
-        .map {|ent| "#{@book.basedir}/#{ent}" }
-      else
+          .sort_by {|ent| @book.image_types.index(File.extname(ent).downcase) }\
+          .map {|ent| "#{@book.basedir}/#{@chapter.name}/#{ent}" }
+      elsif ReVIEW.book.param["singledirmode"]
         re = /\A#{id}(?i:#{@chapter.name.join('|')})\z/x
         entries().select {|ent| re =~ ent }\
-        .sort_by {|ent| @book.image_types.index(File.extname(ent).downcase) }\
-        .map {|ent| "#{@book.asedir}/#{@chapter.name}/#{ent}" }
+          .sort_by {|ent| @book.image_types.index(File.extname(ent).downcase) }\
+          .map {|ent| "#{@book.basedir}/#{ent}" }
+      else
+        re = /\A#{@chapter.name}-#{id}(?i:#{@book.image_types.join('|')})\z/x
+        entries().select {|ent| re =~ ent }\
+          .sort_by {|ent| @book.image_types.index(File.extname(ent).downcase) }\
+          .map {|ent| "#{@book.basedir}/#{ent}" }
       end
     end
-    
+
     def entries
-      if ReVIEW.book.param["subdirmode"].nil?
-        @entries ||= Dir.entries(@book.basedir + @book.image_dir)
-      else
+      if ReVIEW.book.param["subdirmode"]
         @entries ||= Dir.entries(File.join(@book.basedir + @book.image_dir, @chapter.name))
+      else
+        @entries ||= Dir.entries(@book.basedir + @book.image_dir)
       end
     rescue Errno::ENOENT
     @entries = []
@@ -299,11 +318,37 @@ module ReVIEW
       raise ApplicationError, "#{@location}: error: #{msg}"
     end
 
-    def getChap(chapter = @chapter)
+    def handle_metric(str)
+      str
+    end
+
+    def result_metric(array)
+      array.join(',')
+    end
+
+    def parse_metric(type, metric)
+      return "" if metric.nil? || metric.empty?
+      params = metric.split(/,\s*/)
+      results = []
+      params.each do |p|
+        if p =~ /\A.+?::/
+          if p =~ /\A#{type}::/
+              p.sub!(/\A#{type}::/, '')
+          else
+            next
+          end
+        end
+        p = handle_metric(p)
+        results.push(p)
+      end
+      return result_metric(results)
+    end
+
+    def get_chap(chapter = @chapter)
       if ReVIEW.book.param["secnolevel"] > 0 && !chapter.number.nil? && !chapter.number.to_s.empty?
-        return "#{chapter.number}."
+        return "#{chapter.number}"
       end
-      return ""
+      return nil
     end
 
     def extract_chapter_id(chap_ref)
@@ -314,6 +359,94 @@ module ReVIEW
         return [@chapter, chap_ref]
       end
     end
+
+    def captionblock(type, lines, caption, specialstyle = nil)
+      raise NotImplementedError
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q{
+        def #{name}(lines, caption = nil)
+          captionblock("#{name}", lines, caption)
+        end
+      }
+    end
+
+    def graph(lines, id, command, caption = nil)
+      dir = @book.basedir + @book.image_dir
+      file = "#{@chapter.name}-#{id}.#{image_ext}"
+      if ReVIEW.book.param["subdirmode"]
+        dir = File.join(dir, @chapter.name)
+        file = "#{id}.#{image_ext}"
+      elsif ReVIEW.book.param["singledirmode"]
+        file = "#{id}.#{image_ext}"
+      end
+      file_path = File.join(dir, file)
+
+      line = CGI.unescapeHTML(lines.join("\n"))
+      cmds = {
+        :graphviz => "echo '#{line}' | dot -T#{image_ext} -o#{file_path}",
+        :gnuplot  => "echo 'set terminal " +
+        "#{(image_ext == "eps") ? "postscript eps" : image_ext}\n" +
+        " set output \"#{file_path}\"\n#{line}' | gnuplot",
+        :blockdiag => "echo '#{line}' "+
+        "| blockdiag -a -T #{image_ext} -o #{file_path} /dev/stdin",
+        :aafigure => "echo '#{line}' | aafigure -t#{image_ext} -o#{file_path}",
+      }
+      cmd = cmds[command.to_sym]
+      warn cmd
+      system cmd
+
+      image(lines, id, caption)
+    end
+
+    def image_ext
+      raise NotImplementedError
+    end
+
+    def inline_include(file_name)
+      enc = inencoding()
+      compile_inline NKF.nkf("--#{enc}", File.open(file_name).read)
+    end
+
+    def include(file_name)
+      enc = inencoding()
+      File.foreach(file_name) do |line|
+        paragraph([NKF.nkf("--#{enc}", line)])
+      end
+    end
+
+    def inencoding
+      if ReVIEW.book.param["inencoding"].nil?
+        enc = "utf8"
+      else
+        # UTF-8, SJIS, EUC => utf8, sjis, euc
+        enc = ReVIEW.book.param["inencoding"].gsub(/-/, '').downcase
+      end
+    end
+    private :inencoding
+
+    def ul_item_begin(lines)
+      ul_item(lines)
+    end
+
+    def ul_item_end
+    end
+
+    def inline_raw(args)
+      if matched = args.match(/\|(.*?)\|(.*)/)
+        builders = matched[1].split(/,/).map{|i| i.gsub(/\s/, '') }
+        c = self.class.to_s.gsub(/ReVIEW::/, '').gsub(/Builder/, '').downcase
+        if builders.include?(c)
+          matched[2].gsub("\\n", "\n")
+        else
+          ""
+        end
+      else
+        warn "It is recommended to set builder(s)."
+        args.gsub("\\n", "\n")
+      end
+    end
   end
 
 end   # module ReVIEW

data/lib/review/compiler.rb

@@ -143,6 +143,7 @@ module ReVIEW
     defblock :doorquote, 1
     defblock :talk, 0
     defblock :texequation, 0
+    defblock :graph, 1..3
 
     defblock :address, 0
     defblock :blockquote, 0
@@ -163,11 +164,13 @@ module ReVIEW
     defsingle :label, 1
     defsingle :raw, 1
     defsingle :tsize, 1
+    defsingle :include, 1
 
     definline :chapref
     definline :chap
     definline :title
     definline :img
+    definline :icon
     definline :list
     definline :table
     definline :fn
@@ -210,6 +213,8 @@ module ReVIEW
     definline :uchar
     definline :idx
     definline :hidx
+    definline :comment
+    definline :include
 
     private
 
@@ -228,8 +233,8 @@ module ReVIEW
         when %r<\A\s*:\s>
           compile_dlist f
         when %r<\A//\}>
-          error 'block end seen but not opened'
           f.gets
+          error 'block end seen but not opened'
         when %r<\A//[a-z]+>
           name, args, lines = read_command(f)
           syntax = syntax_descriptor(name)
@@ -266,16 +271,25 @@ module ReVIEW
       caption = m[4].strip
       index = level - 1
       if tag
-        open_tagged_section tag, level, label, caption
+        if tag !~ /\A\//
+          close_current_tagged_section(level)
+          open_tagged_section(tag, level, label, caption)
+        else
+          open_tag = tag[1..-1]
+          prev_tag_info = @tagged_section.pop
+          unless prev_tag_info.first == open_tag
+            raise CompileError, "#{open_tag} is not opened."
+          end
+          @strategy.warn("It is not recommended to use \"#{line.chomp}\"")
+          close_tagged_section(*prev_tag_info)
+        end
       else
         if @headline_indexs.size > (index + 1)
           @headline_indexs = @headline_indexs[0..index]
         end
         @headline_indexs[index] = 0 if @headline_indexs[index].nil?
         @headline_indexs[index] += 1
-        while @tagged_section.last and @tagged_section.last[1] >= level
-          close_tagged_section(* @tagged_section.pop)
-        end
+        close_current_tagged_section(level)
         if ReVIEW.book.param["hdnumberingmode"]
           caption = @chapter.on_CHAPS? ? "#{@headline_indexs.join('.')} #{caption}" : caption
           warn "--hdnumberingmode is deprecated. use --level option."
@@ -284,6 +298,12 @@ module ReVIEW
       end
     end
 
+    def close_current_tagged_section(level)
+      while @tagged_section.last and @tagged_section.last[1] >= level
+        close_tagged_section(* @tagged_section.pop)
+      end
+    end
+
     def headline(level, label, caption)
       @strategy.headline level, label, caption
     end
@@ -319,15 +339,46 @@ module ReVIEW
     end
 
     def compile_ulist(f)
-      @strategy.ul_begin
+      level = 0
       f.while_match(/\A\s+\*/) do |line|
-        buf = [text(line.sub(/\*/, '').strip)]
+
+        buf = [text(line.sub(/\*+/, '').strip)]
         f.while_match(/\A\s+(?!\*)\S/) do |cont|
           buf.push text(cont.strip)
         end
-        @strategy.ul_item buf
+
+        line =~ /\A\s+(\*+)/
+        current_level = $1.size
+        if level == current_level
+          @strategy.ul_item_end
+          # body
+          @strategy.ul_item_begin buf
+        elsif level < current_level # down
+          level_diff = current_level - level
+          level = current_level
+          (1..(level_diff - 1)).to_a.reverse.each do |i|
+            @strategy.ul_begin {i}
+            @strategy.ul_item_begin []
+          end
+          @strategy.ul_begin {level}
+          @strategy.ul_item_begin buf
+        elsif level > current_level # up
+          level_diff = level - current_level
+          level = current_level
+          (1..level_diff).to_a.reverse.each do |i|
+            @strategy.ul_item_end
+            @strategy.ul_end {level + i}
+            @strategy.ul_item_end
+          end
+          # body
+          @strategy.ul_item_begin buf
+        end
+      end
+
+      (1..level).to_a.reverse.each do |i|
+        @strategy.ul_item_end
+        @strategy.ul_end {i}
       end
-      @strategy.ul_end
     end
 
     def compile_olist(f)
@@ -440,7 +491,7 @@ module ReVIEW
 
     def text(str)
       return '' if str.empty?
-      words = str.split(/(@<\w+>\{(?:[^\}\\]+|\\.)*\})/, -1)
+      words = str.split(/(@<\w+>\{(?:[^\}\\]|\\.)*?\})/, -1)
       words.each do |w|
         error "`@<xxx>' seen but is not valid inline op: #{w}" if w.scan(/@<\w+>/).size > 1 && !/\A@<raw>/.match(w)
       end