review 5.2.0 → 5.5.0

data/lib/review/idgxmlmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2021 Kenshi Muto
+# Copyright (c) 2019-2022 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -74,9 +74,13 @@ module ReVIEW
       cmd_config, yamlfile = parse_opts(args)
       error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      @config = ReVIEW::Configure.create(maker: 'idgxmlmaker',
-                                         yamlfile: yamlfile,
-                                         config: cmd_config)
+      begin
+        @config = ReVIEW::Configure.create(maker: 'idgxmlmaker',
+                                           yamlfile: yamlfile,
+                                           config: cmd_config)
+      rescue ReVIEW::ConfigError => e
+        error! e.message
+      end
       I18n.setup(@config['language'])
       begin
         generate_idgxml_files(yamlfile)
@@ -119,7 +123,7 @@ module ReVIEW
         if s.success?
           File.write(xmlfile, o) # override
         end
-      rescue => e
+      rescue StandardError => e
         warn("filter error for #{xmlfile}: #{e.message}")
       end
     end
@@ -159,13 +163,11 @@ module ReVIEW
     end
 
     def build_chap(chap, base_path, basetmpdir, ispart)
-      filename = ''
-
-      if ispart.present?
-        filename = chap.path
-      else
-        filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
-      end
+      filename = if ispart.present?
+                   chap.path
+                 else
+                   Pathname.new(chap.path).relative_path_from(base_path).to_s
+                 end
       id = File.basename(filename).sub(/\.re\Z/, '')
       if @buildonly && !@buildonly.include?(id)
         warn "skip #{id}.re"
@@ -177,7 +179,7 @@ module ReVIEW
       begin
         @converter.convert(filename, File.join(basetmpdir, xmlfile))
         apply_filter(File.join(basetmpdir, xmlfile))
-      rescue => e
+      rescue StandardError => e
         @compile_errors = true
         error "compile error in #{filename} (#{e.class})"
         error e.message

data/lib/review/img_math.rb

@@ -104,6 +104,7 @@ module ReVIEW
           end
         rescue CompileError
           FileUtils.cp([tex_path,
+                        File.join(File.dirname(tex_path), '__IMGMATH_BODY__.tex'),
                         File.join(File.dirname(tex_path), '__IMGMATH__.log')],
                        math_real_dir)
           error! "LaTeX math compile error. See #{math_real_dir}/__IMGMATH__.log for details."

data/lib/review/index_builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2022 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
 
@@ -53,11 +54,16 @@ module ReVIEW
     def builder_init_file
       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
@@ -73,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
 
@@ -87,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
@@ -100,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)
@@ -108,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
@@ -132,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
@@ -156,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
@@ -247,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)
@@ -304,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 indepimage(_lines, id, _caption = '', _metric = nil)
+    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)
       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
@@ -334,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)
@@ -346,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
@@ -388,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
 
@@ -464,16 +505,30 @@ 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)
       ''
     end
 
+    def inline_secref(_id)
+      ''
+    end
+
+    def inline_sec(_id)
+      ''
+    end
+
+    def inline_sectitle(_id)
+      ''
+    end
+
     def inline_bib(_id)
       ''
     end
@@ -602,12 +657,13 @@ module ReVIEW
       # 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)
@@ -618,10 +674,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

data/lib/review/latexbuilder.rb

@@ -1,6 +1,6 @@
 # Copyright (c) 2002-2007 Minero Aoki
 #               2008-2009 Minero Aoki, Kenshi Muto
-#               2010-2021 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
+#               2010-2022 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -98,6 +98,8 @@ module ReVIEW
     private :puts
 
     def result
+      check_printendnotes
+
       if @chapter.is_a?(ReVIEW::Book::Part) && !@book.config.check_version('2', exception: false)
         puts '\end{reviewpart}'
       end
@@ -155,7 +157,7 @@ module ReVIEW
         puts macro('label', sec_label(anchor))
         puts macro('label', label) if label
       end
-    rescue
+    rescue StandardError
       app_error "unknown level: #{level}"
     end
 
@@ -197,12 +199,11 @@ module ReVIEW
       blank
       @doc_status[:column] = true
 
-      target = nil
-      if label
-        target = "\\hypertarget{#{column_label(label)}}{}"
-      else
-        target = "\\hypertarget{#{column_label(caption)}}{}"
-      end
+      target = if label
+                 "\\hypertarget{#{column_label(label)}}{}"
+               else
+                 "\\hypertarget{#{column_label(caption)}}{}"
+               end
 
       @doc_status[:caption] = true
       if @book.config.check_version('2', exception: false)
@@ -474,11 +475,11 @@ module ReVIEW
           captionstr = macro(command + 'caption', compile_inline(caption))
         else
           begin
-            if get_chap.nil?
-              captionstr = macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-            else
-              captionstr = macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-            end
+            captionstr = if get_chap.nil?
+                           macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                         else
+                           macro('reviewlistcaption', "#{I18n.t('list')}#{I18n.t('format_number_header', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                         end
           rescue KeyError
             app_error "no such list: #{id}"
           end
@@ -576,13 +577,12 @@ module ReVIEW
     end
 
     def image_image(id, caption = '', metric = nil)
-      captionstr = nil
       @doc_status[:caption] = true
-      if @book.config.check_version('2', exception: false)
-        captionstr = macro('caption', compile_inline(caption)) + "\n"
-      else
-        captionstr = macro('reviewimagecaption', compile_inline(caption)) + "\n"
-      end
+      captionstr = if @book.config.check_version('2', exception: false)
+                     macro('caption', compile_inline(caption)) + "\n"
+                   else
+                     macro('reviewimagecaption', compile_inline(caption)) + "\n"
+                   end
       captionstr << macro('label', image_label(id))
       @doc_status[:caption] = nil
 
@@ -803,7 +803,7 @@ module ReVIEW
       end
 
       if @tsize
-        if @tsize =~ /\A[\d., ]+\Z/
+        if /\A[\d., ]+\Z/.match?(@tsize)
           @cellwidth = @tsize.split(/\s*,\s*/)
           @cellwidth.collect! { |i| "p{#{i}mm}" }
           puts macro('begin', 'reviewtable', '|' + @cellwidth.join('|') + '|')
@@ -856,7 +856,7 @@ module ReVIEW
     end
 
     def th(s, cellwidth = 'l')
-      if /\\\\/ =~ s
+      if /\\\\/.match?(s)
         if !@book.config.check_version('2', exception: false) && cellwidth =~ /\{/
           macro('reviewth', s.gsub("\\\\\n", '\\newline{}'))
         else
@@ -869,7 +869,7 @@ module ReVIEW
     end
 
     def td(s, cellwidth = 'l')
-      if /\\\\/ =~ s
+      if /\\\\/.match?(s)
         if !@book.config.check_version('2', exception: false) && cellwidth =~ /\{/
           s.gsub("\\\\\n", '\\newline{}')
         else
@@ -968,11 +968,11 @@ module ReVIEW
 
       if id
         puts macro('begin', 'reviewequationblock')
-        if get_chap.nil?
-          captionstr = macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-        else
-          captionstr = macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
-        end
+        captionstr = if get_chap.nil?
+                       macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                     else
+                       macro('reviewequationcaption', "#{I18n.t('equation')}#{I18n.t('format_number_header', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix')}#{compile_inline(caption)}")
+                     end
       end
 
       if caption_top?('equation') && captionstr
@@ -1151,6 +1151,19 @@ module ReVIEW
       app_error "unknown footnote: #{id}"
     end
 
+    def inline_endnote(id)
+      macro('endnote', compile_inline(@chapter.endnote(id).content.strip))
+    rescue KeyError
+      app_error "unknown footnote: #{id}"
+    end
+
+    def printendnotes
+      @shown_endnotes = true
+      blank
+      puts '\theendnotes'
+      blank
+    end
+
     BOUTEN = '・'.freeze
 
     def inline_bou(str)
@@ -1264,11 +1277,11 @@ module ReVIEW
 
     def inline_hd_chap(chap, id)
       n = chap.headline_index.number(id)
-      if n.present? && chap.number && over_secnolevel?(n)
-        str = I18n.t('hd_quote', [chap.headline_index.number(id), compile_inline(chap.headline(id).caption)])
-      else
-        str = I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
-      end
+      str = if n.present? && chap.number && over_secnolevel?(n)
+              I18n.t('hd_quote', [chap.headline_index.number(id), compile_inline(chap.headline(id).caption)])
+            else
+              I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
+            end
       if @book.config['chapterlink']
         anchor = n.tr('.', '-')
         macro('reviewsecref', str, sec_label(anchor))
@@ -1277,6 +1290,28 @@ module ReVIEW
       end
     end
 
+    def inline_sec(id)
+      if @book.config['chapterlink']
+        n = super(id)
+        anchor = n.tr('.', '-')
+        macro('reviewsecref', n, sec_label(anchor))
+      else
+        super(id)
+      end
+    rescue KeyError
+      app_error "unknown headline: #{id}"
+    end
+
+    def inline_sectitle(id)
+      if @book.config['chapterlink']
+        chap, id2 = extract_chapter_id(id)
+        anchor = chap.headline_index.number(id2).tr('.', '-')
+        macro('reviewsecref', super(id), sec_label(anchor))
+      else
+        super(id)
+      end
+    end
+
     def inline_column_chap(chapter, id)
       macro('reviewcolumnref',
             I18n.t('column', compile_inline(chapter.column(id).caption)),
@@ -1345,7 +1380,7 @@ module ReVIEW
     end
 
     def inline_tcy(str)
-      macro('rensuji', escape(str))
+      macro('reviewtcy', escape(str))
     end
 
     def inline_balloon(str)
@@ -1399,7 +1434,7 @@ module ReVIEW
     end
 
     def compile_href(url, label)
-      if /\A[a-z]+:/ =~ url
+      if /\A[a-z]+:/.match?(url)
         if label
           macro('href', escape_url(url), escape(label))
         else

data/lib/review/lineinput.rb

@@ -31,7 +31,7 @@ module ReVIEW
     def skip_comment_lines
       n = 0
       while line = gets
-        unless line.strip =~ /\A\#@/
+        unless /\A\#@/.match?(line.strip)
           ungets(line)
           return n
         end
@@ -88,7 +88,7 @@ module ReVIEW
 
     def while_match(re)
       while line = gets
-        unless re =~ line
+        unless re&.match?(line)
           ungets(line)
           return
         end
@@ -99,7 +99,7 @@ module ReVIEW
 
     def until_match(re)
       while line = gets
-        if re =~ line
+        if re&.match?(line)
           ungets(line)
           return
         end

data/lib/review/location.rb

@@ -22,7 +22,7 @@ module ReVIEW
     def string
       begin
         "#{@filename}:#{@f.lineno}"
-      rescue
+      rescue StandardError
         "#{@filename}:nil"
       end
     end