review 1.0.0 → 1.1.0

data/lib/review/book/index.rb

@@ -0,0 +1,339 @@
+# encoding: utf-8
+#
+# Copyright (c) 2002-2007 Minero Aoki
+#               2008-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 LGPL, see the file "COPYING".
+#
+
+require 'review/extentions'
+require 'review/exception'
+
+module ReVIEW
+  module Book
+    class Index
+      def Index.parse(src, *args)
+        items = []
+        seq = 1
+        src.grep(%r<^//#{item_type()}>) do |line|
+          if id = line.slice(/\[(.*?)\]/, 1)
+            items.push item_class().new(id, seq)
+            seq += 1
+            if id == ""
+              warn "warning: no ID of #{item_type()} in #{line}"
+            end
+          end
+        end
+        new(items, *args)
+      end
+
+      Item = Struct.new(:id, :number)
+
+      def Index.item_class
+        self::Item
+      end
+
+      include Enumerable
+
+      def item_type
+        self.class.item_type
+      end
+
+      def initialize(items)
+        @items = items
+        @index = {}
+        items.each do |i|
+          warn "warning: duplicate ID: #{i.id} (#{i})" unless @index[i.id].nil?
+          @index[i.id] = i
+        end
+      end
+
+      def [](id)
+        @index.fetch(id)
+      rescue
+        raise KeyError
+      end
+
+      def number(id)
+        @index.fetch(id).number.to_s
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+
+      def has_key?(id)
+        return @index.has_key?(id)
+      end
+    end
+
+
+    class ChapterIndex < Index
+      def item_type
+        'chapter'
+      end
+
+      def number(id)
+        chapter = @index.fetch(id)
+        if chapter.on_CHAPS?
+          "#{I18n.t("chapter", chapter.number)}"
+        elsif chapter.on_PREDEF?
+          "#{chapter.number}"
+        elsif chapter.on_POSTDEF?
+          "#{I18n.t("appendix", chapter.number)}"
+        end
+      end
+
+      def title(id)
+        @index.fetch(id).title
+      end
+
+      def display_string(id)
+        "#{number(id)}「#{title(id)}」"
+      end
+    end
+
+
+    class ListIndex < Index
+      def ListIndex.item_type
+        '(list|listnum)'
+      end
+    end
+
+
+    class TableIndex < Index
+      def TableIndex.item_type
+        'table'
+      end
+    end
+
+
+    class FootnoteIndex < Index
+      Item = Struct.new(:id, :number, :content)
+
+      def FootnoteIndex.parse(src)
+        items = []
+        seq = 1
+        src.grep(%r<^//footnote>) do |line|
+          if m = /\[(.*?)\]\[(.*)\]/.match(line)
+            m1 = m[1].gsub(/\\(\])/){$1}
+            m2 = m[2].gsub(/\\(\])/){$1}
+            items.push Item.new(m1, seq, m2)
+          end
+          seq += 1
+        end
+        new(items)
+      end
+    end
+
+
+    class ImageIndex < Index
+      class Item
+        def initialize(id, number)
+          @id = id
+          @number = number
+          @pathes = nil
+        end
+
+        attr_reader :id
+        attr_reader :number
+        attr_writer :index    # internal use only
+
+        def bound?
+          not pathes().empty?
+        end
+
+        def path
+          pathes().first
+        end
+
+        def pathes
+          @pathes ||= @index.find_pathes(id)
+        end
+      end
+
+      def ImageIndex.item_type
+        '(image|graph)'
+      end
+
+      def initialize(items, chapid, basedir, types)
+        super items
+        items.each do |i|
+          i.index = self
+        end
+        @chapid = chapid
+        @basedir = basedir
+        @types = types
+      end
+
+      # internal use only
+      def find_pathes(id)
+        if ReVIEW.book.param["subdirmode"]
+          re = /\A#{id}(?i:#{@types.join('|')})\z/x
+          entries().select {|ent| re =~ ent }\
+            .sort_by {|ent| @types.index(File.extname(ent).downcase) }\
+            .map {|ent| "#{@basedir}/#{@chapid}/#{ent}" }
+        elsif ReVIEW.book.param["singledirmode"]
+          re = /\A#{id}(?i:#{@types.join('|')})\z/x
+          entries().select {|ent| re =~ ent }\
+            .sort_by {|ent| @types.index(File.extname(ent).downcase) }\
+            .map {|ent| "#{@basedir}/#{ent}" }
+        else
+          re = /\A#{@chapid.gsub('+', '\\\+').gsub('-', '\\\-')}-#{id}(?i:#{@types.join('|')})\z/x
+          entries().select {|ent| re =~ ent }\
+            .sort_by {|ent| @types.index(File.extname(ent).downcase) }\
+            .map {|ent| "#{@basedir}/#{ent}" }
+        end
+      end
+
+      private
+
+      def entries
+        # @entries: do not cache for graph
+        if ReVIEW.book.param["subdirmode"]
+          @entries = Dir.entries(File.join(@basedir, @chapid))
+        else
+          @entries = Dir.entries(@basedir)
+        end
+      rescue Errno::ENOENT
+        @entries = []
+      end
+    end
+
+    class IconIndex < ImageIndex
+      def IconIndex.parse(src, *args)
+        items = []
+        seq = 1
+        src.grep(%r!@<icon>!) do |line|
+          line.gsub(/@<icon>\{(.+?)\}/) do |m|
+            items.push item_class().new($1, seq)
+            seq += 1
+          end
+        end
+        new(items, *args)
+      end
+    end
+
+    class FormatRef
+      def initialize(locale, index)
+        @locale = locale
+        @index = index
+      end
+
+      def title(id)
+        sprintf(@locale["#{@index.item_type}_caption_format".intern],
+          @index.title(id))
+      end
+
+      def number(id)
+        sprintf(@locale["#{@index.item_type}_number_format".intern],
+          @index.number(id))
+      end
+
+      def method_missing(mid, *args, &block)
+        super unless @index.respond_to?(mid)
+        @index.__send__(mid, *args, &block)
+      end
+    end
+
+    class BibpaperIndex < Index
+      Item = Struct.new(:id, :number, :caption)
+
+      def BibpaperIndex.parse(src)
+        items = []
+        seq = 1
+        src.grep(%r<^//bibpaper>) do |line|
+          if m = /\[(.*?)\]\[(.*)\]/.match(line)
+            m1 = m[1].gsub(/\\(.)/){$1}
+            m2 = m[2].gsub(/\\(.)/){$1}
+            items.push Item.new(m1, seq, m2)
+          end
+          seq += 1
+        end
+        new(items)
+      end
+    end
+
+    class NumberlessImageIndex < ImageIndex
+      class Item < ImageIndex::Item
+        def initialize(id, number)
+          @id = id
+          @number = ""
+          @pathes = nil
+        end
+      end
+
+      def NumberlessImageIndex.item_type
+        'numberlessimage'
+      end
+
+      def number(id)
+        ""
+      end
+    end
+
+    class IndepImageIndex < ImageIndex
+      class Item < ImageIndex::Item
+        def initialize(id, number)
+          @id = id
+          @number = ""
+          @pathes = nil
+        end
+      end
+
+      def IndepImageIndex.item_type
+        'indepimage'
+      end
+
+      def number(id)
+        ""
+      end
+    end
+
+    class HeadlineIndex < Index
+      Item = Struct.new(:id, :number, :caption)
+
+      def HeadlineIndex.parse(src, chap)
+        items = []
+        indexs = []
+        headlines = []
+        src.each do |line|
+          if m = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/.match(line)
+            next if m[2] == 'column'
+            index = m[1].size - 2
+            if index >= 0
+              if indexs.size > (index + 1)
+                indexs = indexs.take(index + 1)
+                headlines = headlines.take(index + 1)
+              end
+              if indexs[index].nil?
+                (0..index).each{|i| indexs[i] = 0 if indexs[i].nil?}
+              end
+              indexs[index] += 1
+              headlines[index] = m[3].present? ? m[3].strip : m[4].strip
+              items.push Item.new(headlines.join("|"), indexs.dup, m[4].strip)
+            end
+          end
+        end
+        new(items, chap)
+      end
+
+      def initialize(items, chap)
+        @items = items
+        @chap = chap
+        @index = {}
+        items.each do |i|
+          warn "warning: duplicate ID: #{i.id}" unless @index[i.id].nil?
+          @index[i.id] = i
+        end
+      end
+
+      def number(id)
+        return ([@chap.number] + @index.fetch(id).number).join(".")
+      end
+    end
+  end
+end

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( ai psd eps pdf tif tiff png bmp jpg jpeg gif svg ))
+        @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