review 4.2.0 → 5.0.0

data/lib/review/book/bib.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2009-2020 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/book_unit'
+require 'review/lineinput'
+require 'review/preprocessor'
+
+module ReVIEW
+  module Book
+    class Bib < BookUnit
+      def number
+        nil
+      end
+    end
+  end
+end

data/lib/review/book/book_unit.rb

@@ -0,0 +1,155 @@
+# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+#               2002-2008 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".
+#
+require 'review/textutils'
+require 'review/index_builder'
+
+module ReVIEW
+  module Book
+    class BookUnit
+      include TextUtils
+      attr_reader :book
+      attr_reader :path
+      attr_reader :lines
+      attr_accessor :content
+
+      attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+                  :numberless_image_index, :image_index, :icon_index, :indepimage_index,
+                  :headline_index, :column_index
+
+      def initialize(file_content: nil, book: nil)
+        if book
+          @book = book
+        end
+        if file_content
+          @content = file_content
+        end
+        if @content
+          @lines = @content.lines
+        end
+      end
+
+      def execute_indexer(force: false)
+        if @index_builder && !force
+          return @index_builder
+        end
+
+        @index_builder = ReVIEW::IndexBuilder.new
+        compiler = ReVIEW::Compiler.new(@index_builder)
+        compiler.compile(self)
+        @index_builder
+      end
+
+      def generate_indexes(use_bib: false)
+        return unless content
+
+        @lines = content.lines
+
+        @indexes = execute_indexer
+
+        @list_index = @indexes.list_index
+        @table_index = @indexes.table_index
+        @equation_index = @indexes.equation_index
+        @footnote_index = @indexes.footnote_index
+        @headline_index = @indexes.headline_index
+        @column_index = @indexes.column_index
+        if use_bib
+          @book.bibpaper_index = @indexes.bibpaper_index
+        end
+      end
+
+      def dirname
+        @path && File.dirname(@path)
+      end
+
+      def basename
+        @path && File.basename(@path)
+      end
+
+      def name
+        @name && File.basename(@name, '.*')
+      end
+
+      alias_method :id, :name
+
+      def title
+        return @title if @title
+
+        @title = ''
+        return @title unless content
+        content.each_line do |line|
+          if line =~ /\A=+/
+            @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
+            break
+          end
+        end
+        @title
+      end
+
+      def size
+        content.size
+      end
+
+      def volume
+        @volume ||= Volume.count_file(path)
+      end
+
+      def list(id)
+        list_index[id]
+      end
+
+      def table(id)
+        table_index[id]
+      end
+
+      def equation(id)
+        equation_index[id]
+      end
+
+      def footnote(id)
+        footnote_index[id]
+      end
+
+      def image(id)
+        return image_index[id] if image_index.key?(id)
+        return icon_index[id] if icon_index.key?(id)
+        return numberless_image_index[id] if numberless_image_index.key?(id)
+        indepimage_index[id]
+      end
+
+      def bibpaper(id)
+        bibpaper_index[id]
+      end
+
+      def bibpaper_index
+        raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
+        @book.bibpaper_index
+      end
+
+      def headline(caption)
+        headline_index[caption]
+      end
+
+      def column(id)
+        column_index[id]
+      end
+
+      def next_chapter
+        book.next_chapter(self)
+      end
+
+      def prev_chapter
+        book.prev_chapter(self)
+      end
+
+      def image_bound?(item_id)
+        image(item_id).path
+      end
+    end
+  end
+end

data/lib/review/book/chapter.rb

@@ -7,15 +7,13 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 #
-require 'review/book/compilable'
+require 'review/book/book_unit'
 require 'review/lineinput'
 require 'review/preprocessor'
 
 module ReVIEW
   module Book
-    class Chapter
-      include Compilable
-
+    class Chapter < BookUnit
       attr_reader :number, :book
 
       def self.mkchap(book, name, number = nil)
@@ -53,35 +51,41 @@ module ReVIEW
           @content = File.read(@path, mode: 'rt:BOM|utf-8')
           @number = nil if %w[nonum nodisp notoc].include?(find_first_header_option)
         end
-        @list_index = nil
-        @table_index = nil
-        @equation_index = nil
-        @footnote_index = nil
-        @image_index = nil
-        @icon_index = nil
-        @numberless_image_index = nil
-        @indepimage_index = nil
-        @headline_index = nil
-        @column_index = nil
-        @volume = nil
+
+        super()
+      end
+
+      def generate_indexes
+        super
+
+        return unless content
+
+        @numberless_image_index = @indexes.numberless_image_index
+        @image_index = @indexes.image_index
+        @icon_index = @indexes.icon_index
+        @indepimage_index = @indexes.indepimage_index
       end
 
       def find_first_header_option
         f = LineInput.new(StringIO.new(@content))
-        while f.next?
-          case f.peek
-          when /\A=+[\[\s\{]/
-            m = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/.match(f.gets)
-            return m[2] # tag
-          when %r{/\A//[a-z]+/}
-            line = f.gets
-            if line.rstrip[-1, 1] == '{'
-              f.until_match(%r{\A//\}})
+        begin
+          while f.next?
+            case f.peek
+            when /\A=+[\[\s{]/
+              m = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/.match(f.gets)
+              return m[2] # tag
+            when %r{/\A//[a-z]+/}
+              line = f.gets
+              if line.rstrip[-1, 1] == '{'
+                f.until_match(%r{\A//\}})
+              end
             end
+            f.gets
           end
-          f.gets
+          nil
+        rescue ArgumentError => e
+          raise ReVIEW::CompileError, "#{@name}: #{e}"
         end
-        nil
       end
 
       def inspect

data/lib/review/book/index.rb

@@ -17,21 +17,6 @@ require 'review/book/index/item'
 module ReVIEW
   module Book
     class Index
-      def self.parse(src, *args)
-        index = self.new(*args)
-        seq = 1
-        src.grep(%r{\A//#{item_type}}) do |line|
-          if id = line.slice(/\[(.*?)\]/, 1)
-            index.add_item(ReVIEW::Book::Index::Item.new(id, seq))
-            seq += 1
-            if id.empty?
-              ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
-            end
-          end
-        end
-        index
-      end
-
       include Enumerable
 
       def item_type
@@ -44,9 +29,13 @@ module ReVIEW
         @image_finder = nil
       end
 
+      def size
+        @index.size
+      end
+
       def add_item(item)
-        if @index[item.id]
-          @logger.warn "warning: duplicate ID: #{item.id} (#{item})"
+        if @index[item.id] && self.class != ReVIEW::Book::IconIndex
+          @logger.warn "warning: duplicate ID: #{item.id} (#{item.inspect})"
         end
         @index[item.id] = item
         if item.class != ReVIEW::Book::Chapter
@@ -57,13 +46,13 @@ module ReVIEW
       def [](id)
         @index.fetch(id)
       rescue
-        if @index.keys.map { |i| i.split('|').last }.flatten. # unfold all ids
-           each_with_object(Hash.new(0)) { |i, h| h[i] += 1 }. # number of occurrences
+        index_keys = @index.keys.map { |i| i.split('|').last }.flatten # unfold all ids
+        if index_keys.each_with_object(Hash.new(0)) { |i, h| h[i] += 1 }. # number of occurrences
            select { |k, v| k == id && v > 1 }.present? # detect duplicated
           raise KeyError, "key '#{id}' is ambiguous for #{self.class}"
         end
 
-        @index.values.each do |item|
+        @index.each_value do |item|
           if item.id.split('|').include?(id)
             return item
           end
@@ -134,55 +123,24 @@ module ReVIEW
     end
 
     class FootnoteIndex < Index
-      def self.parse(src)
-        index = self.new
-        seq = 1
-        src.grep(%r{\A//footnote}) do |line|
-          if m = /\[(.*?)\]\[(.*)\]/.match(line)
-            m1 = m[1].gsub(/\\(\])/) { $1 }
-            m2 = m[2].gsub(/\\(\])/) { $1 }
-            index.add_item(Item.new(m1, seq, m2))
-          end
-          seq += 1
-        end
-        index
-      end
     end
 
     class ImageIndex < Index
-      def self.parse(src, *args)
-        index = self.new(*args)
-        seq = 1
-        src.grep(%r{\A//#{item_type}}) do |line|
-          # ex. ["//image", "id", "", "caption"]
-          elements = line.split(/\[(.*?)\]/)
-          if elements[1].present?
-            if line.start_with?('//imgtable')
-              index.add_item(ReVIEW::Book::Index::Item.new(elements[1], 0, elements[3]))
-            else ## %r<\A//(image|graph)>
-              index.add_item(ReVIEW::Book::Index::Item.new(elements[1], seq, elements[3]))
-              seq += 1
-            end
-            if elements[1] == ''
-              ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
-            end
-          end
-        end
-        index
-      end
-
       def self.item_type
         '(image|graph|imgtable)'
       end
 
       attr_reader :image_finder
 
-      def initialize(chapid, basedir, types, builder)
+      def initialize(chapter)
         super()
-        @chapid = chapid
-        @basedir = basedir
-        @types = types
-        @logger = ReVIEW.logger
+        @chapter = chapter
+        book = @chapter.book
+
+        chapid = chapter.id
+        basedir = book.imagedir
+        builder = book.config['builder']
+        types = book.image_types
 
         @image_finder = ReVIEW::Book::ImageFinder.new(basedir, chapid, builder, types)
       end
@@ -193,43 +151,9 @@ module ReVIEW
     end
 
     class IconIndex < ImageIndex
-      def initialize(chapid, basedir, types, builder)
-        @index = {}
-        @chapid = chapid
-        @basedir = basedir
-        @types = types
-        @logger = ReVIEW.logger
-
-        @image_finder = ImageFinder.new(basedir, chapid, builder, types)
-      end
-
-      def self.parse(src, *args)
-        index = self.new(*args)
-        seq = 1
-        src.grep(/@<icon>/) do |line|
-          line.gsub(/@<icon>\{(.+?)\}/) do
-            index.add_item(ReVIEW::Book::Index::Item.new($1, seq))
-            seq += 1
-          end
-        end
-        index
-      end
     end
 
     class BibpaperIndex < Index
-      def self.parse(src)
-        index = self.new
-        seq = 1
-        src.grep(%r{\A//bibpaper}) do |line|
-          if m = /\[(.*?)\]\[(.*)\]/.match(line)
-            m1 = m[1].gsub(/\\(.)/) { $1 }
-            m2 = m[2].gsub(/\\(.)/) { $1 }
-            index.add_item(Item.new(m1, seq, m2))
-          end
-          seq += 1
-        end
-        index
-      end
     end
 
     class NumberlessImageIndex < ImageIndex
@@ -255,77 +179,9 @@ module ReVIEW
     class HeadlineIndex < Index
       HEADLINE_PATTERN = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/
 
-      def self.parse(src, chap)
-        headline_index = self.new(chap)
-        indexs = []
-        headlines = []
-        inside_column = false
-        inside_block = nil
-        column_level = -1
-        src.each do |line|
-          if line =~ %r{\A//[a-z]+.*\{\Z}
-            inside_block = true
-            next
-          elsif line.start_with?('//}')
-            inside_block = nil
-            next
-          elsif inside_block
-            next
-          end
-
-          m = HEADLINE_PATTERN.match(line)
-          if m.nil? || m[1].size > 10 # Ignore too deep index
-            next
-          end
-
-          index = m[1].size - 2
-
-          # column
-          if m[2] == 'column'
-            inside_column = true
-            column_level = index
-            next
-          elsif m[2] == '/column'
-            inside_column = false
-            next
-          end
-          if indexs.blank? || index <= column_level
-            inside_column = false
-          end
-          next if inside_column
-          next if m[4].strip.empty? # no title
-
-          next unless index >= 0
-          if indexs.size > (index + 1)
-            unless %w[nonum notoc nodisp].include?(m[2])
-              indexs = indexs.take(index + 1)
-            end
-            headlines = headlines.take(index + 1)
-          end
-          if indexs[index].nil?
-            (0..index).each do |i|
-              indexs[i] ||= 0
-            end
-          end
-
-          if %w[nonum notoc nodisp].include?(m[2])
-            headlines[index] = m[3].present? ? m[3].strip : m[4].strip
-            item_id = headlines.join('|')
-            headline_index.add_item(Item.new(item_id, nil, m[4].strip))
-          else
-            indexs[index] += 1
-            headlines[index] = m[3].present? ? m[3].strip : m[4].strip
-            item_id = headlines.join('|')
-            headline_index.add_item(Item.new(item_id, indexs.dup, m[4].strip))
-          end
-        end
-        headline_index
-      end
-
-      def initialize(chap)
-        @chap = chap
-        @index = {}
-        @logger = ReVIEW.logger
+      def initialize(chapter)
+        super()
+        @chapter = chapter
       end
 
       def number(id)
@@ -333,34 +189,16 @@ module ReVIEW
           # when notoc
           return ''
         end
-        n = @chap.number
+        n = @chapter.number
         # XXX: remove magic number (move to lib/review/book/chapter.rb)
-        if @chap.on_appendix? && @chap.number > 0 && @chap.number < 28
-          n = @chap.format_number(false)
+        if @chapter.on_appendix? && @chapter.number > 0 && @chapter.number < 28
+          n = @chapter.format_number(false)
         end
         ([n] + self[id].number).join('.')
       end
     end
 
     class ColumnIndex < Index
-      COLUMN_PATTERN = /\A(=+)\[column\](?:\{(.+?)\})?(.*)/
-
-      def self.parse(src, *_args)
-        index = self.new
-        seq = 1
-        src.each do |line|
-          m = COLUMN_PATTERN.match(line)
-          next unless m
-          _level = m[1] ## not use it yet
-          id = m[2]
-          caption = m[3].strip
-          id = caption if id.nil? || id.empty?
-
-          index.add_item(ReVIEW::Book::Index::Item.new(id, seq, caption))
-          seq += 1
-        end
-        index
-      end
     end
   end
 end