review 5.1.1 → 5.4.0

data/lib/review/index_builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #
 # This program is free software.
@@ -13,7 +13,8 @@ require 'review/sec_counter'
 
 module ReVIEW
   class IndexBuilder < Builder
-    attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+    attr_reader :list_index, :table_index, :equation_index,
+                :footnote_index, :endnote_index,
                 :numberless_image_index, :image_index, :icon_index, :indepimage_index,
                 :headline_index, :column_index, :bibpaper_index
 
@@ -24,9 +25,9 @@ module ReVIEW
     def check_id(id)
       if id
         if id =~ %r![#%\\{}\[\]~/$'"|*?&<>`\s]!
-          warn "deprecated ID: `#{$&}` in `#{id}`"
+          warn "deprecated ID: `#{$&}` in `#{id}`", location: location
         elsif id.start_with?('.')
-          warn "deprecated ID: `#{id}` begins from `.`"
+          warn "deprecated ID: `#{id}` begins from `.`", location: location
         end
       end
     end
@@ -51,14 +52,18 @@ module ReVIEW
     end
 
     def builder_init_file
-      @sec_counter = SecCounter.new(5, @chapter)
-
+      super
       @headline_stack = []
+      @crossref = {
+        footnote: {},
+        endnote: {}
+      }
 
       @list_index = ReVIEW::Book::ListIndex.new
       @table_index = ReVIEW::Book::TableIndex.new
       @equation_index = ReVIEW::Book::EquationIndex.new
       @footnote_index = ReVIEW::Book::FootnoteIndex.new
+      @endnote_index = ReVIEW::Book::EndnoteIndex.new
       @headline_index = ReVIEW::Book::HeadlineIndex.new(@chapter)
       @column_index = ReVIEW::Book::ColumnIndex.new
       @chapter_index = ReVIEW::Book::ChapterIndex.new
@@ -74,6 +79,14 @@ module ReVIEW
     private :builder_init_file
 
     def result
+      %i[footnote endnote].each do |name|
+        @crossref[name].each_pair do |k, v|
+          if v == 0
+            warn "#{@chapter.basename}: #{name} ID #{k} is not referred."
+          end
+        end
+      end
+
       nil
     end
 
@@ -88,11 +101,7 @@ module ReVIEW
 
       cursor = level - 2
 
-      if label
-        @headline_stack[cursor] = label
-      else
-        @headline_stack[cursor] = caption
-      end
+      @headline_stack[cursor] = (label || caption)
       if @headline_stack.size > cursor + 1
         @headline_stack = @headline_stack.take(cursor + 1)
       end
@@ -101,6 +110,7 @@ module ReVIEW
 
       item = ReVIEW::Book::Index::Item.new(item_id, @sec_counter.number_list, caption)
       @headline_index.add_item(item)
+      compile_inline(caption)
     end
 
     def nonum_begin(level, label, caption)
@@ -109,11 +119,7 @@ module ReVIEW
 
       cursor = level - 2
 
-      if label
-        @headline_stack[cursor] = label
-      else
-        @headline_stack[cursor] = caption
-      end
+      @headline_stack[cursor] = (label || caption)
       if @headline_stack.size > cursor + 1
         @headline_stack = @headline_stack.take(cursor + 1)
       end
@@ -133,11 +139,7 @@ module ReVIEW
 
       cursor = level - 2
 
-      if label
-        @headline_stack[cursor] = label
-      else
-        @headline_stack[cursor] = caption
-      end
+      @headline_stack[cursor] = (label || caption)
       if @headline_stack.size > cursor + 1
         @headline_stack = @headline_stack.take(cursor + 1)
       end
@@ -157,11 +159,7 @@ module ReVIEW
 
       cursor = level - 2
 
-      if label
-        @headline_stack[cursor] = label
-      else
-        @headline_stack[cursor] = caption
-      end
+      @headline_stack[cursor] = (label || caption)
       if @headline_stack.size > cursor + 1
         @headline_stack = @headline_stack.take(cursor + 1)
       end
@@ -248,56 +246,73 @@ module ReVIEW
 
     alias_method :lead, :read
 
-    def list(_lines, id, _caption, _lang = nil)
+    def list(lines, id, caption, _lang = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @list_index.size + 1)
       @list_index.add_item(item)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def source(_lines, _caption = nil, _lang = nil)
+    def source(lines, caption = nil, _lang = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def listnum(_lines, id, _caption, _lang = nil)
+    def listnum(lines, id, caption, _lang = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @list_index.size + 1)
       @list_index.add_item(item)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def emlist(lines, caption = nil, lang = nil)
+    def emlist(lines, caption = nil, _lang = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def emlistnum(lines, caption = nil, lang = nil)
+    def emlistnum(lines, caption = nil, _lang = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
     def cmd(lines, caption = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
     def quote(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def image(_lines, id, caption, _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @image_index.size + 1, caption)
       @image_index.add_item(item)
+      compile_inline(caption)
     end
 
-    def table(_lines, id = nil, caption = nil)
+    def table(lines, id = nil, caption = nil)
       check_id(id)
       if id
         item = ReVIEW::Book::Index::Item.new(id, @table_index.size + 1, caption)
         @table_index.add_item(item)
       end
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def emtable(_lines, _caption = nil)
+    def emtable(_lines, caption = nil)
       # item = ReVIEW::Book::TableIndex::Item.new(id, @table_index.size + 1)
       # @table_index << item
+      compile_inline(caption)
     end
 
     def comment(lines, comment = nil)
     end
 
-    def imgtable(_lines, id, _caption = nil, _metric = nil)
+    def imgtable(_lines, id, caption = nil, _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @table_index.size + 1)
       @table_index.add_item(item)
@@ -305,24 +320,37 @@ module ReVIEW
       ## to find image path
       item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
       @indepimage_index.add_item(item)
+      compile_inline(caption)
     end
 
     def footnote(id, str)
       check_id(id)
+      @crossref[:footnote][id] ||= 0
       item = ReVIEW::Book::Index::Item.new(id, @footnote_index.size + 1, str)
       @footnote_index.add_item(item)
+      compile_inline(str)
+    end
+
+    def endnote(id, str)
+      check_id(id)
+      @crossref[:endnote][id] ||= 0
+      item = ReVIEW::Book::Index::Item.new(id, @endnote_index.size + 1, str)
+      @endnote_index.add_item(item)
+      compile_inline(str)
     end
 
-    def indepimage(_lines, id, _caption = '', _metric = nil)
+    def indepimage(_lines, id, caption = '', _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
       @indepimage_index.add_item(item)
+      compile_inline(caption)
     end
 
-    def numberlessimage(_lines, id, _caption = '', _metric = nil)
+    def numberlessimage(_lines, id, caption = '', _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
       @indepimage_index.add_item(item)
+      compile_inline(caption)
     end
 
     def hr
@@ -335,10 +363,12 @@ module ReVIEW
     def blankline
     end
 
-    def flushright(_lines)
+    def flushright(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def centering(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def olnum(_num)
@@ -347,12 +377,16 @@ module ReVIEW
     def pagebreak
     end
 
-    def bpo(_lines)
+    def bpo(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def noindent
     end
 
+    def printendnotes
+    end
+
     def compile_inline(s)
       @compiler.text(s)
     end
@@ -389,7 +423,13 @@ module ReVIEW
       ''
     end
 
-    def inline_fn(_id)
+    def inline_fn(id)
+      @crossref[:footnote][id] = @crossref[:footnote][id] ? @crossref[:footnote][id] + 1 : 1
+      ''
+    end
+
+    def inline_endnote(id)
+      @crossref[:endnote][id] = @crossref[:endnote][id] ? @crossref[:endnote][id] + 1 : 1
       ''
     end
 
@@ -465,10 +505,12 @@ module ReVIEW
       ''
     end
 
-    def bibpaper(_lines, id, caption)
+    def bibpaper(lines, id, caption)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @bibpaper_index.size + 1, caption)
       @bibpaper_index.add_item(item)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
     def inline_hd(_id)
@@ -598,25 +640,18 @@ module ReVIEW
       ''
     end
 
-    def warn(msg)
-      @logger.warn "#{@location}: #{msg}"
-    end
-
-    def error(msg = '(no message)')
-      if msg =~ /builder does not support command/
-        # ignore
-        return
-      end
-
-      super
+    ## override
+    def error(msg = nil)
+      # ignore in indexing
     end
 
-    def texequation(_lines, id = nil, _caption = '')
+    def texequation(_lines, id = nil, caption = '')
       check_id(id)
       if id
         item = ReVIEW::Book::Index::Item.new(id, @equation_index.size + 1)
         @equation_index.add_item(item)
       end
+      compile_inline(caption)
     end
 
     def get_chap(_chapter = nil)
@@ -627,10 +662,16 @@ module ReVIEW
       ''
     end
 
-    def captionblock(_type, _lines, _caption, _specialstyle = nil)
+    def captionblock(_type, lines, caption, _specialstyle = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
       ''
     end
 
+    def graph(lines, id, _command, caption = '')
+      image(lines, id, caption)
+    end
+
     def tsize(_str)
       ''
     end

data/lib/review/init.rb

@@ -179,12 +179,12 @@ EOS
         content = content.split("\n").delete_if { |l| l.strip.start_with?('#') || l.strip.empty? }.join("\n")
       end
 
-      File.open(File.join(dir, 'config.yml'), 'w') { |f| f.write content }
+      File.write(File.join(dir, 'config.yml'), content)
       if @webui && !@web_result[2].empty?
         File.open(File.join(dir, 'config-ebook.yml'), 'w') do |f|
           f.puts <<EOT
 # for ebook PDF
-# REVIEW_CONFIG_FILE=config.yml rake pdf
+# REVIEW_CONFIG_FILE=config-ebook.yml rake pdf
 inherit: ["config.yml"]
 # bookname: book-ebook
 texdocumentclass: ["#{@web_result[0]}", "#{@web_result[2]}"]
@@ -257,7 +257,7 @@ EOS
         exit 1
       end
 
-      if filename =~ %r{\Ahttps?://}
+      if %r{\Ahttps?://}.match?(filename)
         begin
           @logger.info "Downloading from #{filename}"
           zipdata = Net::HTTP.get(URI.parse(filename))
@@ -334,7 +334,7 @@ EOS
       # validation
       if @web_result
         @web_result.each do |s|
-          if s !~ /\A[a-z0-9=_,.-]*\Z/i
+          unless /\A[a-z0-9=_,.-]*\Z/i.match?(s)
             @web_result = nil
             break
           end