review 3.1.0 → 5.0.0

data/lib/review/book/chapter.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2019 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -7,17 +7,30 @@
 # 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)
+        name += book.ext if File.extname(name).empty?
+        path = File.join(book.contentdir, name)
+        raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
+        Chapter.new(book, number, name, path)
+      end
+
+      def self.mkchap_ifexist(book, name, number = nil)
+        name += book.ext if File.extname(name).empty?
+        path = File.join(book.contentdir, name)
+        if File.file?(path)
+          Chapter.new(book, number, name, path)
+        end
+      end
+
       def initialize(book, number, name, path, io = nil)
         @book = book
         @number = number
@@ -35,38 +48,44 @@ module ReVIEW
           @content = nil
         end
         if !@content && @path && File.exist?(@path)
-          @content = File.read(@path, mode: 'r:BOM|utf-8')
+          @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
@@ -125,7 +144,7 @@ module ReVIEW
       private
 
       def on_file?(contents)
-        contents.lines.map(&:strip).include?("#{id}#{@book.ext}")
+        contents.map(&:strip).include?("#{id}#{@book.ext}")
       end
 
       # backward compatibility

data/lib/review/book/index.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -12,62 +12,49 @@ require 'review/exception'
 require 'review/book/image_finder'
 require 'review/i18n'
 require 'review/logger'
+require 'review/book/index/item'
 
 module ReVIEW
   module Book
     class Index
-      def self.parse(src, *args)
-        items = []
-        seq = 1
-        src.grep(%r{\A//#{item_type}}) do |line|
-          if id = line.slice(/\[(.*?)\]/, 1)
-            items.push item_class.new(id, seq)
-            seq += 1
-            if id.empty?
-              ReVIEW.logger.warn "warning: no ID of #{item_type} in #{line}"
-            end
-          end
-        end
-        new(items, *args)
-      end
-
-      Item = Struct.new(:id, :number)
-
-      def self.item_class
-        self::Item
-      end
-
       include Enumerable
 
       def item_type
         self.class.item_type
       end
 
-      def initialize(items)
-        @items = items
+      def initialize
         @index = {}
         @logger = ReVIEW.logger
-        items.each do |i|
-          if @index[i.id]
-            @logger.warn "warning: duplicate ID: #{i.id} (#{i})"
-          end
-          @index[i.id] = i
-        end
         @image_finder = nil
       end
 
+      def size
+        @index.size
+      end
+
+      def add_item(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
+          item.index = self
+        end
+      end
+
       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
 
-        @items.each do |i|
-          if i.id.split('|').include?(id)
-            return i
+        @index.each_value do |item|
+          if item.id.split('|').include?(id)
+            return item
           end
         end
         raise KeyError, "not found key '#{id}' for #{self.class}"
@@ -78,7 +65,7 @@ module ReVIEW
       end
 
       def each(&block)
-        @items.each(&block)
+        @index.values.each(&block)
       end
 
       def key?(id)
@@ -93,8 +80,9 @@ module ReVIEW
       end
 
       def number(id)
-        chapter = @index.fetch(id)
+        chapter_item = @index.fetch(id)
         begin
+          chapter = chapter_item.content
           chapter.format_number
         rescue # part
           I18n.t('part', chapter.number)
@@ -102,9 +90,9 @@ module ReVIEW
       end
 
       def title(id)
-        @index.fetch(id).title
+        @index.fetch(id).content.title
       rescue # non-file part
-        @index.fetch(id).name
+        @index.fetch(id).content.name
       end
 
       def display_string(id)
@@ -135,81 +123,24 @@ module ReVIEW
     end
 
     class FootnoteIndex < Index
-      Item = Struct.new(:id, :number, :content)
-
-      def self.parse(src)
-        items = []
-        seq = 1
-        src.grep(%r{\A//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
-      def self.parse(src, *args)
-        items = []
-        seq = 1
-        src.grep(%r{\A//#{item_type}}) do |line|
-          # ex. ["//image", "id", "", "caption"]
-          elements = line.split(/\[(.*?)\]/)
-          if elements[1].present?
-            if line =~ %r{\A//imgtable}
-              items.push item_class.new(elements[1], 0, elements[3])
-            else ## %r<\A//(image|graph)>
-              items.push item_class.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
-        new(items, *args)
-      end
-
       def self.item_type
         '(image|graph|imgtable)'
       end
 
-      class Item
-        def initialize(id, number, caption = nil)
-          @id = id
-          @number = number
-          @caption = caption
-          @path = nil
-        end
-
-        attr_reader :id
-        attr_reader :number
-        attr_reader :caption
-        attr_writer :index # internal use only
-
-        def bound?
-          path
-        end
-
-        def path
-          @path ||= @index.find_path(id)
-        end
-      end
-
       attr_reader :image_finder
 
-      def initialize(items, chapid, basedir, types, builder)
-        super items
-        items.each do |i|
-          i.index = self
-        end
-        @chapid = chapid
-        @basedir = basedir
-        @types = types
+      def initialize(chapter)
+        super()
+        @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
@@ -220,47 +151,9 @@ module ReVIEW
     end
 
     class IconIndex < ImageIndex
-      def initialize(items, chapid, basedir, types, builder)
-        @items = items
-        @index = {}
-        items.each { |i| @index[i.id] = i }
-        items.each { |i| i.index = self }
-        @chapid = chapid
-        @basedir = basedir
-        @types = types
-
-        @image_finder = ImageFinder.new(basedir, chapid, builder, types)
-      end
-
-      def self.parse(src, *args)
-        items = []
-        seq = 1
-        src.grep(/@<icon>/) do |line|
-          line.gsub(/@<icon>\{(.+?)\}/) do
-            items.push item_class.new($1, seq)
-            seq += 1
-          end
-        end
-        new(items, *args)
-      end
     end
 
     class BibpaperIndex < Index
-      Item = Struct.new(:id, :number, :caption)
-
-      def self.parse(src)
-        items = []
-        seq = 1
-        src.grep(%r{\A//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
@@ -268,18 +161,12 @@ module ReVIEW
         'numberlessimage'
       end
 
-      class Item < ImageIndex::Item
-      end
-
       def number(_id)
         ''
       end
     end
 
     class IndepImageIndex < ImageIndex
-      class Item < ImageIndex::Item
-      end
-
       def self.item_type
         '(indepimage|imgtable)'
       end
@@ -291,108 +178,27 @@ module ReVIEW
 
     class HeadlineIndex < Index
       HEADLINE_PATTERN = /\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/
-      Item = Struct.new(:id, :number, :caption)
-      attr_reader :items
-
-      def self.parse(src, chap)
-        items = []
-        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 =~ %r{\A//\}}
-            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)
-            indexs = indexs.take(index + 1)
-            headlines = headlines.take(index + 1)
-          end
-          if indexs[index].nil?
-            (0..index).each do |i|
-              indexs[i] ||= 0
-            end
-          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
-        new(items, chap)
-      end
-
-      def initialize(items, chap)
-        @items = items
-        @chap = chap
-        @index = {}
-        @logger = ReVIEW.logger
-        items.each do |i|
-          if @index[i.id]
-            @logger.warn "warning: duplicate ID: #{i.id}"
-          end
-          @index[i.id] = i
-        end
+      def initialize(chapter)
+        super()
+        @chapter = chapter
       end
 
       def number(id)
-        n = @chap.number
+        unless self[id].number
+          # when notoc
+          return ''
+        end
+        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\](?:\{(.+?)\})?(.*)/
-      Item = Struct.new(:id, :number, :caption)
-
-      def self.parse(src, *_args)
-        items = []
-        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?
-
-          items.push item_class.new(id, seq, caption)
-          seq += 1
-        end
-        new(items)
-      end
     end
   end
 end