review 5.0.0 → 5.3.0

data/lib/review/latexbuilder.rb

@@ -1,6 +1,6 @@
 # Copyright (c) 2002-2007 Minero Aoki
 #               2008-2009 Minero Aoki, Kenshi Muto
-#               2010-2020 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
+#               2010-2021 Minero Aoki, Kenshi Muto, TAKAHASHI Masayoshi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -28,6 +28,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @chapter.book.image_types = %w[.ai .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif]
       @blank_needed = false
       @latex_tsize = nil
@@ -35,7 +36,6 @@ module ReVIEW
       @cellwidth = nil
       @ol_num = nil
       @first_line_num = nil
-      @sec_counter = SecCounter.new(5, @chapter)
       @foottext = {}
       setup_index
       initialize_metachars(@book.config['texcommand'])
@@ -51,6 +51,7 @@ module ReVIEW
         @index_db = load_idxdb(@book.config['pdfmaker']['makeindex_dic'])
       end
       return true unless @book.config['pdfmaker']['makeindex_mecab']
+
       begin
         begin
           require 'MeCab'
@@ -60,7 +61,7 @@ module ReVIEW
         require 'nkf'
         @index_mecab = MeCab::Tagger.new(@book.config['pdfmaker']['makeindex_mecab_opts'])
       rescue LoadError
-        warn 'not found MeCab'
+        warn 'not found MeCab', location: location
       end
     end
 
@@ -97,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 +158,7 @@ module ReVIEW
         puts macro('label', label) if label
       end
     rescue
-      error "unknown level: #{level}"
+      app_error "unknown level: #{level}"
     end
 
     def nonum_begin(level, _label, caption)
@@ -180,10 +183,10 @@ module ReVIEW
     end
 
     def nodisp_begin(level, _label, caption)
-      if @output.pos != 0
-        blank
-      else
+      if @output.pos == 0
         puts macro('clearpage')
+      else
+        blank
       end
       puts macro('addcontentsline', 'toc', HEADLINE[level], compile_inline(caption))
       # FIXME: headings
@@ -334,6 +337,7 @@ module ReVIEW
       blank
       puts '\begin{enumerate}'
       return true unless @ol_num
+
       puts "\\setcounter{enumi}{#{@ol_num - 1}}"
       @ol_num = nil
     end
@@ -478,7 +482,7 @@ module ReVIEW
               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
           rescue KeyError
-            error "no such list: #{id}"
+            app_error "no such list: #{id}"
           end
         end
       end
@@ -557,6 +561,7 @@ module ReVIEW
       if @book.config['pdfmaker']['use_original_image_size'] && s.empty? && !metric.present?
         return ' ' # pass empty to \reviewincludegraphics
       end
+
       s
     end
 
@@ -564,6 +569,7 @@ module ReVIEW
       if @book.config['pdfmaker']['image_scale2width'] && str =~ /\Ascale=([\d.]+)\Z/
         return "width=#{$1}\\maxwidth"
       end
+
       str
     end
 
@@ -571,13 +577,13 @@ module ReVIEW
       array.join(',')
     end
 
-    def image_image(id, caption, metric)
+    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" if caption.present?
+        captionstr = macro('caption', compile_inline(caption)) + "\n"
       else
-        captionstr = macro('reviewimagecaption', compile_inline(caption)) + "\n" if caption.present?
+        captionstr = macro('reviewimagecaption', compile_inline(caption)) + "\n"
       end
       captionstr << macro('label', image_label(id))
       @doc_status[:caption] = nil
@@ -586,7 +592,7 @@ module ReVIEW
       # image is always bound here
       puts "\\begin{reviewimage}%%#{id}"
 
-      if caption_top?('image') && captionstr
+      if caption_top?('image')
         puts captionstr
       end
 
@@ -601,7 +607,7 @@ module ReVIEW
         puts "\\#{command}[width=\\maxwidth]{#{@chapter.image(id).path}}"
       end
 
-      if !caption_top?('image') && captionstr
+      unless caption_top?('image')
         puts captionstr
       end
 
@@ -609,19 +615,19 @@ module ReVIEW
     end
 
     def image_dummy(id, caption, lines)
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
       puts '\begin{reviewdummyimage}'
-      # path = @chapter.image(id).path
-      puts "--[[path = #{id} (#{existence(id)})]]--"
+      puts escape("--[[path = #{id} (#{existence(id)})]]--")
       lines.each do |line|
+        puts "\n"
         puts detab(line.rstrip)
       end
       puts macro('label', image_label(id))
       @doc_status[:caption] = true
       if @book.config.check_version('2', exception: false)
         puts macro('caption', compile_inline(caption)) if caption.present?
-      else
-        puts macro('reviewimagecaption', compile_inline(caption)) if caption.present?
+      elsif caption.present?
+        puts macro('reviewimagecaption', compile_inline(caption))
       end
       @doc_status[:caption] = nil
       puts '\end{reviewdummyimage}'
@@ -696,10 +702,11 @@ module ReVIEW
           puts "\\#{command}[width=\\maxwidth]{#{@chapter.image(id).path}}"
         end
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         puts '\begin{reviewdummyimage}'
-        puts "--[[path = #{escape(id)} (#{existence(id)})]]--"
+        puts escape("--[[path = #{escape(id)} (#{existence(id)})]]--")
         lines.each do |line|
+          puts "\n"
           puts detab(line.rstrip)
         end
       end
@@ -732,7 +739,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       table_begin(rows.first.size)
       table_rows(sepidx, rows)
@@ -817,7 +824,7 @@ module ReVIEW
       ret = []
       s = ''
       brace = nil
-      size.split('').each do |ch|
+      size.chars.each do |ch|
         case ch
         when '|'
           next
@@ -830,15 +837,11 @@ module ReVIEW
           ret << s
           s = ''
         else
-          if brace
+          if brace || s.empty?
             s << ch
           else
-            if s.empty?
-              s << ch
-            else
-              ret << s
-              s = ch
-            end
+            ret << s
+            s = ch
           end
         end
       end
@@ -898,7 +901,7 @@ module ReVIEW
 
     def imgtable(lines, id, caption = nil, metric = nil)
       unless @chapter.image_bound?(id)
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         image_dummy(id, caption, lines)
         return
       end
@@ -916,7 +919,7 @@ module ReVIEW
         end
         puts macro('label', table_label(id))
       rescue ReVIEW::KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       imgtable_image(id, caption, metric)
 
@@ -1007,6 +1010,7 @@ module ReVIEW
 
     def direct(lines, fmt)
       return unless fmt == 'latex'
+
       lines.each do |line|
         puts line
       end
@@ -1014,6 +1018,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return true unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(escape(comment))
@@ -1045,35 +1050,35 @@ module ReVIEW
     def inline_chapref(id)
       title = super
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{title}}"
+        "\\reviewchapref{#{title}}{chap:#{id}}"
       else
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_chap(id)
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{@book.chapter_index.number(id)}}"
+        "\\reviewchapref{#{@book.chapter_index.number(id)}}{chap:#{id}}"
       else
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
     def inline_title(id)
       title = super
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{title}}"
+        "\\reviewchapref{#{title}}{chap:#{id}}"
       else
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")
     end
 
@@ -1090,7 +1095,7 @@ module ReVIEW
         macro('reviewlistref', I18n.t('format_number', [get_chap(chapter), chapter.list(id).number]))
       end
     rescue KeyError
-      error "unknown list: #{id}"
+      app_error "unknown list: #{id}"
     end
 
     def inline_table(id)
@@ -1101,7 +1106,7 @@ module ReVIEW
         macro('reviewtableref', I18n.t('format_number', [get_chap(chapter), chapter.table(id).number]), table_label(id, chapter))
       end
     rescue KeyError
-      error "unknown table: #{id}"
+      app_error "unknown table: #{id}"
     end
 
     def inline_img(id)
@@ -1112,7 +1117,7 @@ module ReVIEW
         macro('reviewimageref', I18n.t('format_number', [get_chap(chapter), chapter.image(id).number]), image_label(id, chapter))
       end
     rescue KeyError
-      error "unknown image: #{id}"
+      app_error "unknown image: #{id}"
     end
 
     def inline_eq(id)
@@ -1123,13 +1128,13 @@ module ReVIEW
         macro('reviewequationref', I18n.t('format_number', [get_chap(chapter), chapter.equation(id).number]))
       end
     rescue KeyError
-      error "unknown equation: #{id}"
+      app_error "unknown equation: #{id}"
     end
 
     def footnote(id, content)
       if @book.config['footnotetext'] || @foottext[id]
         if @doc_status[:column]
-          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block."
+          warn "//footnote[#{id}] is in the column block. It is recommended to move out of the column block.", location: location
         end
         puts macro("footnotetext[#{@chapter.footnote(id).number}]", compile_inline(content.strip))
       end
@@ -1145,7 +1150,20 @@ module ReVIEW
         macro('footnote', compile_inline(@chapter.footnote(id).content.strip))
       end
     rescue KeyError
-      error "unknown footnote: #{id}"
+      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
@@ -1231,6 +1249,10 @@ module ReVIEW
       end
     end
 
+    def inline_ins(str)
+      macro('reviewinsert', escape(str))
+    end
+
     def inline_del(str)
       macro('reviewstrike', escape(str))
     end
@@ -1263,7 +1285,7 @@ module ReVIEW
         str = I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
       if @book.config['chapterlink']
-        anchor = n.gsub(/\./, '-')
+        anchor = n.tr('.', '-')
         macro('reviewsecref', str, sec_label(anchor))
       else
         str
@@ -1275,7 +1297,7 @@ module ReVIEW
             I18n.t('column', compile_inline(chapter.column(id).caption)),
             column_label(id, chapter))
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_raw(str) # rubocop:disable Lint/UselessMethodDefinition
@@ -1314,7 +1336,7 @@ module ReVIEW
         end
         macro(command, @chapter.image(id).path)
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         "\\verb|--[[path = #{id} (#{existence(id)})]]--|"
       end
     end
@@ -1338,7 +1360,7 @@ module ReVIEW
     end
 
     def inline_tcy(str)
-      macro('rensuji', escape(str))
+      macro('reviewtcy', escape(str))
     end
 
     def inline_balloon(str)
@@ -1361,23 +1383,22 @@ module ReVIEW
     end
 
     def index(str)
+      # XXX: mendex/upmendex specific
       sa = str.split('<<>>')
 
       sa.map! do |item|
         if @index_db[item]
-          escape_index(escape(@index_db[item])) + '@' + escape_index(escape(item))
-        else
-          if item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
-            esc_item = escape_index(escape(item))
-            if esc_item != item
-              "#{escape_index(item)}@#{esc_item}"
-            else
-              esc_item
-            end
+          escape_mendex_key(escape_index(@index_db[item])) + '@' + escape_mendex_display(escape_index(escape(item)))
+        elsif item =~ /\A[[:ascii:]]+\Z/ || @index_mecab.nil?
+          esc_item = escape_mendex_display(escape_index(escape(item)))
+          if esc_item == item
+            esc_item
           else
-            yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
-            escape_index(escape(yomi)) + '@' + escape_index(escape(item))
+            "#{escape_mendex_key(escape_index(item))}@#{esc_item}"
           end
+        else
+          yomi = NKF.nkf('-w --hiragana', @index_mecab.parse(item).force_encoding('UTF-8').chomp)
+          escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
         end
       end
 

data/lib/review/latexutils.rb

@@ -59,7 +59,7 @@ module ReVIEW
         end
       end
 
-      @metachars_re = /[#{Regexp.escape(@metachars.keys.join(''))}]/u
+      @metachars_re = /[#{Regexp.escape(@metachars.keys.join(''))}]/u # rubocop:disable Style/RedundantArgument
 
       @metachars_invert = @metachars.invert
     end
@@ -81,6 +81,14 @@ module ReVIEW
       str.gsub(/[@!|"]/) { |s| '"' + s }
     end
 
+    def escape_mendex_key(str)
+      str.gsub('"|', '｜').tr('{', '｛').tr('}', '｝')
+    end
+
+    def escape_mendex_display(str)
+      str.gsub('\{', '\reviewleftcurlybrace{}').gsub('\}', '\reviewrightcurlybrace{}')
+    end
+
     def escape_url(str)
       str.gsub(/[\#%]/) { |s| '\\' + s }
     end

data/lib/review/lineinput.rb

@@ -1,7 +1,33 @@
-require 'lineinput'
+#
+# Copyright (c) 2002-2020 Minero Aoki, Masayoshi Takahashi, Kenshi Muto
+#
+# This program is free software.
+# You can distribute/modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+#
+require 'review/exception'
 
 module ReVIEW
-  class LineInput < LineInput
+  class LineInput
+    INVALID_CHARACTER_PATTERN = /[\x00-\x08\x0b-\x0c\x0e-\x1f]/ # accept 0x09: TAB, 0x0a: LF, 0x0d: CR
+
+    attr_reader :lineno
+
+    def initialize(f)
+      @input = f
+      @buf = []
+      @lineno = 0
+      @eof_p = false
+    end
+
+    def inspect
+      "\#<#{self.class} file=#{@input.inspect} line=#{lineno}>"
+    end
+
+    def eof?
+      @eof_p
+    end
+
     def skip_comment_lines
       n = 0
       while line = gets
@@ -13,5 +39,89 @@ module ReVIEW
       end
       n
     end
+
+    def gets
+      unless @buf.empty?
+        @lineno += 1
+        return @buf.pop
+      end
+      return nil if @eof_p # to avoid ARGF blocking.
+
+      line = @input.gets
+      @eof_p = true unless line
+      @lineno += 1
+      invalid_char = lookup_invalid_char(line)
+      if invalid_char
+        raise SyntaxError, "found invalid control-sequence character (#{sprintf('%#x', invalid_char.codepoints[0])})."
+      end
+
+      line
+    end
+
+    def peek
+      line = gets
+      ungets(line) if line
+      line
+    end
+
+    def next?
+      peek ? true : false
+    end
+
+    def skip_blank_lines
+      n = 0
+      while line = gets
+        unless line.strip.empty?
+          ungets(line)
+          return n
+        end
+        n += 1
+      end
+      n
+    end
+
+    def each
+      while line = gets
+        yield line
+      end
+    end
+
+    def while_match(re)
+      while line = gets
+        unless re =~ line
+          ungets(line)
+          return
+        end
+        yield line
+      end
+      nil
+    end
+
+    def until_match(re)
+      while line = gets
+        if re =~ line
+          ungets(line)
+          return
+        end
+        yield line
+      end
+      nil
+    end
+
+    private
+
+    def ungets(line)
+      return unless line
+
+      @lineno -= 1
+      @buf.push(line)
+      line
+    end
+
+    def lookup_invalid_char(line)
+      if line =~ INVALID_CHARACTER_PATTERN
+        $&
+      end
+    end
   end
 end

data/lib/review/loggable.rb

@@ -0,0 +1,27 @@
+module ReVIEW
+  module Loggable
+    attr_reader :logger
+
+    def error(msg, location: nil)
+      logger.error(msg, location: location)
+    end
+
+    def app_error(msg)
+      raise ApplicationError, msg
+    end
+
+    def error!(msg, location: nil)
+      logger.error(msg, location: location)
+
+      exit 1
+    end
+
+    def warn(msg, location: nil)
+      logger.warn(msg, location: location)
+    end
+
+    def debug(msg, location: nil)
+      logger.debug(msg, location: location)
+    end
+  end
+end

data/lib/review/logger.rb

@@ -6,10 +6,97 @@ module ReVIEW
       super(io, progname: progname)
       self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
+
+    def warn(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def error(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def debug(msg, location: nil)
+      if location
+        super("#{location}: #{msg}")
+      else
+        super(msg)
+      end
+    end
+
+    def ttylogger?
+      nil
+    end
+
+    def success(_log)
+      # empty (for backward compatibility)
+    end
+  end
+
+  begin
+    require 'tty-logger'
+    class TTYLogger < ::TTY::Logger
+      def warn(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def error(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def debug(msg, location: nil)
+        if location
+          super("#{location}: #{msg}")
+        else
+          super(msg)
+        end
+      end
+
+      def ttylogger?
+        true
+      end
+    end
+  rescue LoadError
+    nil
   end
 
-  def self.logger
-    @logger ||= ReVIEW::Logger.new($stderr, progname: File.basename($PROGRAM_NAME, '.*'))
+  def self.logger(level: 'info')
+    if const_defined?(:TTYLogger)
+      @logger ||= TTYLogger.new do |config|
+        config.level = level.to_sym
+        config.handlers = [
+          [:console,
+           {
+             styles: {
+               debug: { label: 'DEBUG' },
+               info: { label: 'INFO', color: :magenta },
+               success: { label: 'SUCCESS' },
+               wait: { label: 'WAIT' },
+               warn: { label: 'WARN' },
+               error: { label: 'ERROR' },
+               fatal: { label: 'FATAL' }
+             }
+           }]
+        ]
+      end
+    else
+      @logger ||= ReVIEW::Logger.new($stderr, progname: File.basename($PROGRAM_NAME, '.*'))
+    end
   end
 
   def self.logger=(logger)