tmtms-review 1.0.0

data/lib/review/book/page_metric.rb

@@ -0,0 +1,38 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 Minero Aoki, 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 ReVIEW
+  module Book
+    class PageMetric
+
+      MetricData = Struct.new(:n_lines, :n_columns)
+
+      def PageMetric.a5
+        new(46, 80, 30, 74, 1)
+      end
+
+      def PageMetric.b5
+        new(46, 80, 30, 74, 2)
+      end
+      
+      def initialize(list_lines, list_columns, text_lines, text_columns, page_per_kbyte)
+        @list = MetricData.new(list_lines, list_columns)
+        @text = MetricData.new(text_lines, text_columns)
+        @page_per_kbyte = page_per_kbyte
+      end
+
+      attr_reader :list
+      attr_reader :text
+      attr_reader :page_per_kbyte
+
+    end
+  end
+end

data/lib/review/book/parameters.rb

@@ -0,0 +1,97 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 Minero Aoki, 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 ReVIEW
+  module Book
+    class Parameters
+
+      def Parameters.default
+        new()
+      end
+
+      def Parameters.load(path)
+        mod = Module.new
+        mod.module_eval File.read(path), path
+        new(
+          :chapter_file => const_get_safe(mod, :CHAPS_FILE),
+          :part_file    => const_get_safe(mod, :PART_FILE),
+          :bib_file     => const_get_safe(mod, :BIB_FILE),
+          :reject_file  => const_get_safe(mod, :REJECT_FILE) ||
+          const_get_safe(mod, :WORDS_FILE),
+          :predef_file  => const_get_safe(mod, :PREDEF_FILE),
+          :postdef_file => const_get_safe(mod, :POSTDEF_FILE),
+          :ext          => const_get_safe(mod, :EXT),
+          :image_dir    => const_get_safe(mod, :IMAGE_DIR),
+          :image_types  => const_get_safe(mod, :IMAGE_TYPES),
+          :page_metric  => get_page_metric(mod)
+          )
+      end
+
+      def Parameters.get_page_metric(mod)
+        if paper = const_get_safe(mod, :PAPER)
+          unless PageMetric.respond_to?(paper.downcase)
+            raise ConfigError, "unknown paper size: #{paper}"
+          end
+          return PageMetric.send(paper.downcase)
+        end
+        PageMetric.new(const_get_safe(mod, :LINES_PER_PAGE_list) || 46,
+          const_get_safe(mod, :COLUMNS_list)        || 80,
+          const_get_safe(mod, :LINES_PER_PAGE_text) || 30,
+          const_get_safe(mod, :COLUMNS_text)        || 74)  # 37zw
+      end
+
+      def Parameters.const_get_safe(mod, name)
+        return nil unless mod.const_defined?(name)
+        mod.const_get(name)
+      end
+      private_class_method :const_get_safe
+
+      def initialize(params = {})
+        @chapter_file = params[:chapter_file] || 'CHAPS'
+        @part_file    = params[:part_file]    || 'PART'
+        @reject_file  = params[:reject_file]  || 'REJECT'
+        @predef_file  = params[:predef_file]  || 'PREDEF'
+        @postdef_file = params[:postdef_file] || 'POSTDEF'
+        @page_metric  = params[:page_metric]  || PageMetric.a5
+        @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 pdf ))
+        @bib_file  = params[:bib_file]        || "bib#{@ext}"
+      end
+
+      def unify_exts(list)
+        list.map {|ext| (ext[0] == '.') ? ext : ".#{ext}" }
+      end
+      private :unify_exts
+
+      def self.path_param(name)
+        module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def #{name}
+          "\#{@basedir}/\#{@#{name}}"
+        end
+      End
+      end
+
+      path_param  :chapter_file
+      path_param  :part_file
+      path_param  :bib_file
+      path_param  :reject_file
+      path_param  :predef_file
+      path_param  :postdef_file
+      attr_reader :ext
+      path_param  :image_dir
+      attr_reader :image_types
+      attr_reader :page_metric
+
+    end
+  end
+end

data/lib/review/book/part.rb

@@ -0,0 +1,44 @@
+#
+# $Id: book.rb 4315 2009-09-02 04:15:24Z kmuto $
+#
+# Copyright (c) 2002-2008 Minero Aoki
+#               2009 Minero Aoki, 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".
+#
+require 'review/book/compilable'
+module ReVIEW
+  module Book
+    class Part
+      include Compilable
+
+      def initialize(book, number, chapters, name="")
+        @book = book
+        @number = number
+        @chapters = chapters
+        @path = name
+        @name = name ? File.basename(name, '.*') : nil
+      end
+
+      attr_reader :number
+      attr_reader :chapters
+      attr_reader :name
+
+      def each_chapter(&block)
+        @chapters.each(&block)
+      end
+
+      def volume
+        Volume.sum(@chapters.map {|chap| chap.volume })
+      end
+
+      def file?
+        (name.present? and path =~ /\.re\z/) ? true : false
+      end
+
+    end
+  end
+end

data/lib/review/book/volume.rb

@@ -0,0 +1,65 @@
+#
+# $Id: volume.rb 3883 2008-02-10 11:48:23Z aamine $
+#
+# Copyright (c) 2002-2007 Minero Aoki
+#
+# 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 ReVIEW
+  module Book
+    class Volume
+
+      def Volume.count_file(path)
+        b = c = l = 0
+        File.foreach(path) do |line|
+          next if %r<\A\#@> =~ line
+          text = line.gsub(/\s+/, '')
+          b += text.bytesize
+          c += text.charsize
+          l += 1
+        end
+        new(b, c, l)
+      end
+
+      def Volume.sum(vols)
+        vols.inject(new()) {|sum, i| sum + i }
+      end
+
+      def Volume.dummy
+        new(-1, -1, -1)
+      end
+
+      def initialize(bytes = 0, chars = 0, lines = 0)
+        @bytes = bytes
+        @chars = chars
+        @lines = lines
+      end
+
+      attr_reader :bytes
+      attr_reader :chars
+      attr_accessor :lines
+
+      def kbytes
+        (@bytes.to_f / 1024).ceil
+      end
+
+      def page
+        (kbytes.to_f/ReVIEW.book.page_metric.page_per_kbyte).ceil
+      end
+
+      def to_s
+        "#{kbytes()}KB #{@chars}C #{@lines}L #{page()}P"
+      end
+
+      def +(other)
+        Volume.new(@bytes + other.bytes,
+          @chars + other.chars,
+          @lines + other.lines)
+      end
+
+    end
+  end
+end

data/lib/review/builder.rb

@@ -0,0 +1,444 @@
+# encoding: utf-8
+#
+# Copyright (c) 2002-2009 Minero Aoki
+#
+# 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.
+#
+
+require 'review/book/index'
+require 'review/exception'
+require 'review/textutils'
+require 'stringio'
+require 'cgi'
+
+module ReVIEW
+
+  class Builder
+    include TextUtils
+
+    CAPTION_TITLES = %w(note memo tip info planning best important security caution term link notice point shoot reference practice expert)
+
+    def pre_paragraph
+      nil
+    end
+    def post_paragraph
+      nil
+    end
+
+    def initialize(strict = false, *args)
+      @strict = strict
+      @tabwidth = nil
+      if ReVIEW.book.param && ReVIEW.book.param["tabwidth"]
+        @tabwidth = ReVIEW.book.param["tabwidth"]
+      end
+      builder_init(*args)
+    end
+
+    def builder_init(*args)
+    end
+    private :builder_init
+
+    def bind(compiler, chapter, location)
+      @compiler = compiler
+      @chapter = chapter
+      @location = location
+      @output = StringIO.new
+      @book = ReVIEW.book
+      builder_init_file
+    end
+
+    def builder_init_file
+    end
+    private :builder_init_file
+
+    def result
+      @output.string
+    end
+
+    alias :raw_result result
+
+    def print(*s)
+      @output.print *s.map{|i|
+        convert_outencoding(i, ReVIEW.book.param["outencoding"])
+      }
+    end
+
+    def puts(*s)
+      @output.puts *s.map{|i|
+        convert_outencoding(i, ReVIEW.book.param["outencoding"])
+      }
+    end
+
+    def list(lines, id, caption)
+      begin
+        list_header id, caption
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      list_body lines
+    end
+
+    def listnum(lines, id, caption)
+      begin
+        list_header id, caption
+      rescue KeyError
+        error "no such list: #{id}"
+      end
+      listnum_body lines
+    end
+
+    def source(lines, caption)
+      source_header caption
+      source_body lines
+    end
+
+    def image(lines, id, caption, metric = nil)
+      if @chapter.image(id).bound?
+        image_image id, caption, metric
+      else
+        warn "image not bound: #{id}" if @strict
+        image_dummy id, caption, lines
+      end
+    end
+
+    def table(lines, id = nil, caption = nil)
+      rows = []
+      sepidx = nil
+      lines.each_with_index do |line, idx|
+        if /\A[\=\-]{12}/ =~ line
+          # just ignore
+          #error "too many table separator" if sepidx
+          sepidx ||= idx
+          next
+        end
+        rows.push line.strip.split(/\t+/).map {|s| s.sub(/\A\./, '') }
+      end
+      rows = adjust_n_cols(rows)
+
+      begin
+        table_header id, caption unless caption.nil?
+      rescue KeyError => err
+        error "no such table: #{id}"
+      end
+      return if rows.empty?
+      table_begin rows.first.size
+      if sepidx
+        sepidx.times do
+          tr rows.shift.map {|s| th(s) }
+        end
+        rows.each do |cols|
+          tr cols.map {|s| td(s) }
+        end
+      else
+        rows.each do |cols|
+          h, *cs = *cols
+          tr [th(h)] + cs.map {|s| td(s) }
+        end
+      end
+      table_end
+    end
+
+    def adjust_n_cols(rows)
+      rows.each do |cols|
+        while cols.last and cols.last.strip.empty?
+          cols.pop
+        end
+      end
+      n_maxcols = rows.map {|cols| cols.size }.max
+      rows.each do |cols|
+        cols.concat [''] * (n_maxcols - cols.size)
+      end
+      rows
+    end
+    private :adjust_n_cols
+
+    #def footnote(id, str)
+    #  @footnotes.push [id, str]
+    #end
+    #
+    #def flush_footnote
+    #  footnote_begin
+    #  @footnotes.each do |id, str|
+    #    footnote_item(id, str)
+    #  end
+    #  footnote_end
+    #end
+
+    def compile_inline(s)
+      @compiler.text(s)
+    end
+
+    def inline_chapref(id)
+      @chapter.env.chapter_index.display_string(id)
+    rescue KeyError
+      error "unknown chapter: #{id}"
+      nofunc_text("[UnknownChapter:#{id}]")
+    end
+
+    def inline_chap(id)
+      @chapter.env.chapter_index.number(id)
+    rescue KeyError
+      error "unknown chapter: #{id}"
+      nofunc_text("[UnknownChapter:#{id}]")
+    end
+
+    def inline_title(id)
+      @chapter.env.chapter_index.title(id)
+    rescue KeyError
+      error "unknown chapter: #{id}"
+      nofunc_text("[UnknownChapter:#{id}]")
+    end
+
+    def inline_list(id)
+      "#{I18n.t("list")}#{@chapter.list(id).number}"
+    rescue KeyError
+      error "unknown list: #{id}"
+      nofunc_text("[UnknownList:#{id}]")
+    end
+
+    def inline_img(id)
+      "#{I18n.t("image")}#{@chapter.image(id).number}"
+    rescue KeyError
+      error "unknown image: #{id}"
+      nofunc_text("[UnknownImage:#{id}]")
+    end
+
+    def inline_table(id)
+      "#{I18n.t("table")}#{@chapter.table(id).number}"
+    rescue KeyError
+      error "unknown table: #{id}"
+      nofunc_text("[UnknownTable:#{id}]")
+    end
+
+    def inline_fn(id)
+      @chapter.footnote(id).content
+    rescue KeyError
+      error "unknown footnote: #{id}"
+      nofunc_text("[UnknownFootnote:#{id}]")
+    end
+
+    def inline_bou(str)
+      text(str)
+    end
+
+    def inline_ruby(arg)
+      base, ruby = *arg.split(',', 2)
+      compile_ruby(base, ruby)
+    end
+
+    def inline_kw(arg)
+      word, alt = *arg.split(',', 2)
+      compile_kw(word, alt)
+    end
+
+    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
+
+    def text(str)
+      str
+    end
+
+    def bibpaper(lines, id, caption)
+      bibpaper_header id, caption
+      unless lines.empty?
+        puts ""
+        bibpaper_bibpaper id, caption, lines
+      end
+      puts ""
+    end
+
+    def inline_hd(id)
+      m = /\A(\w+)\|(.+)/.match(id)
+      chapter = @book.chapters.detect{|chap| chap.id == m[1]} if m && m[1]
+      return inline_hd_chap(chapter, m[2]) if chapter
+      return inline_hd_chap(@chapter, id)
+    end
+
+    def raw(str)
+      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
+        print str.gsub("\\n", "\n")
+      end
+    end
+
+    def find_pathes(id)
+      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}/#{@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.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"]
+        @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 = []
+    end
+
+    def warn(msg)
+      $stderr.puts "#{@location}: warning: #{msg}"
+    end
+
+    def error(msg)
+      raise ApplicationError, "#{@location}: error: #{msg}"
+    end
+
+    def handle_metric(str)
+      str
+    end
+
+    def result_metric(array)
+      array.join(',')
+    end
+
+    def parse_metric(type, metric)
+      return "" if metric.blank?
+      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}"
+      end
+      return nil
+    end
+
+    def extract_chapter_id(chap_ref)
+      m = /\A([\w+-]+)\|(.+)/.match(chap_ref)
+      if m
+        return [@book.chapters.detect{|chap| chap.id == m[1]}, m[2]]
+      else
+        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)
+      compile_inline convert_inencoding(File.open(file_name).read,
+                                        ReVIEW.book.param["inencoding"])
+    end
+
+    def include(file_name)
+      File.foreach(file_name) do |line|
+        paragraph([convert_inencoding(line, ReVIEW.book.param["inencoding"])])
+      end
+    end
+
+    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
+        args.gsub("\\n", "\n")
+      end
+    end
+
+    ## override TextUtils::detab
+    def detab(str, num = nil)
+      if num
+        super(str, num)
+      elsif @tabwidth
+        super(str, @tabwidth)
+      else
+        super(str)
+      end
+    end
+  end
+
+end   # module ReVIEW