review 5.0.0 → 5.1.0

data/lib/review/index_builder.rb

@@ -607,6 +607,7 @@ module ReVIEW
         # ignore
         return
       end
+
       super
     end
 

data/lib/review/init.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2018-2019 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2018-2021 Masanori Kado, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -209,9 +209,9 @@ EOT
       FileUtils.cp(Dir.glob(File.join(tdir, '*.*')), texmacrodir)
 
       if @template == 'review-jsbook'
-        # provide jsbook from vendor/. current version is 2018/06/23
+        # provide jsbook from vendor/. current version is 2020/10/09
         FileUtils.cp(File.join(@review_dir, 'vendor/jsclasses/jsbook.cls'), File.join(texmacrodir, 'jsbook.cls'))
-        # provide gentombow from vendor/. current version is 2018/08/30 v0.9j
+        # provide gentombow from vendor/. current version is 2019/07/21 v0.9k
         FileUtils.cp(File.join(@review_dir, 'vendor/gentombow/gentombow.sty'), File.join(texmacrodir, 'gentombow.sty'))
       end
     end
@@ -286,7 +286,7 @@ EOS
       begin
         Zip::File.open(filename) do |zip|
           zip.each do |entry|
-            fname = entry.name.gsub('\\', '/')
+            fname = entry.name.tr('\\', '/')
             if fname =~ /__MACOSX/ || fname =~ /\.DS_Store/
               next
             end

data/lib/review/latexbox.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2021 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/logger'
+module ReVIEW
+  class LaTeXBox
+    def initialize
+      @logger = ReVIEW.logger
+    end
+
+    def tcbox(config)
+      ret = ''
+
+      %w[column note memo tip info warning important caution notice].each do |name|
+        if config['pdfmaker'].nil? || config['pdfmaker']['boxsetting'].nil? ||
+           config['pdfmaker']['boxsetting'][name].nil? ||
+           config['pdfmaker']['boxsetting'][name]['style'].nil?
+          next
+        end
+
+        options = '[]'
+        options_with_caption = '[]'
+        if config['pdfmaker']['boxsetting'][name]['options']
+          options = "[#{config['pdfmaker']['boxsetting'][name]['options']}]"
+          options_with_caption = options
+        end
+
+        if config['pdfmaker']['boxsetting'][name]['options_with_caption']
+          options_with_caption = "[#{config['pdfmaker']['boxsetting'][name]['options_with_caption']}]"
+        end
+
+        ret << <<EOT
+\\renewenvironment{review#{name}}[1][]{%
+  \\csdef{rv@tmp@withcaption}{true}
+  \\notblank{##1}{
+    \\begin{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@caption}{##1}#{options_with_caption}
+   }{
+    \\csundef{rv@tmp@withcaption}
+    \\begin{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@nocaption}#{options}
+   }
+}{
+  \\ifcsdef{rv@tmp@withcaption}{
+    \\end{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@caption}
+  }{
+    \\end{rv@#{config['pdfmaker']['boxsetting'][name]['style']}@nocaption}
+  }
+}
+EOT
+      end
+
+      ret
+    end
+  end
+end

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
@@ -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'
@@ -180,10 +181,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 +335,7 @@ module ReVIEW
       blank
       puts '\begin{enumerate}'
       return true unless @ol_num
+
       puts "\\setcounter{enumi}{#{@ol_num - 1}}"
       @ol_num = nil
     end
@@ -557,6 +559,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 +567,7 @@ module ReVIEW
       if @book.config['pdfmaker']['image_scale2width'] && str =~ /\Ascale=([\d.]+)\Z/
         return "width=#{$1}\\maxwidth"
       end
+
       str
     end
 
@@ -571,13 +575,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 +590,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 +605,7 @@ module ReVIEW
         puts "\\#{command}[width=\\maxwidth]{#{@chapter.image(id).path}}"
       end
 
-      if !caption_top?('image') && captionstr
+      unless caption_top?('image')
         puts captionstr
       end
 
@@ -1007,6 +1011,7 @@ module ReVIEW
 
     def direct(lines, fmt)
       return unless fmt == 'latex'
+
       lines.each do |line|
         puts line
       end
@@ -1014,6 +1019,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return true unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(escape(comment))
@@ -1045,7 +1051,7 @@ module ReVIEW
     def inline_chapref(id)
       title = super
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{title}}"
+        "\\reviewchapref{#{title}}{chap:#{id}}"
       else
         title
       end
@@ -1056,7 +1062,7 @@ module ReVIEW
 
     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
@@ -1068,7 +1074,7 @@ module ReVIEW
     def inline_title(id)
       title = super
       if @book.config['chapterlink']
-        "\\hyperref[chap:#{id}]{#{title}}"
+        "\\reviewchapref{#{title}}{chap:#{id}}"
       else
         title
       end
@@ -1231,6 +1237,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 +1273,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
@@ -1361,22 +1371,23 @@ 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))
+          escape_mendex_key(escape_index(@index_db[item])) + '@' + escape_mendex_display(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 = escape_mendex_display(escape_index(escape(item)))
+            if esc_item == item
               esc_item
+            else
+              "#{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_index(escape(yomi)) + '@' + escape_index(escape(item))
+            escape_mendex_key(escape_index(yomi)) + '@' + escape_mendex_display(escape_index(escape(item)))
           end
         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/logger.rb

@@ -6,10 +6,49 @@ module ReVIEW
       super(io, progname: progname)
       self.formatter = ->(severity, _datetime, name, msg) { "#{severity} #{name}: #{msg}\n" }
     end
+
+    def ttylogger?
+      nil
+    end
+
+    def success(_log)
+      # empty (for backward compatibility)
+    end
   end
 
-  def self.logger
-    @logger ||= ReVIEW::Logger.new($stderr, progname: File.basename($PROGRAM_NAME, '.*'))
+  begin
+    require 'tty-logger'
+    class TTYLogger < ::TTY::Logger
+      def ttylogger?
+        true
+      end
+    end
+  rescue LoadError
+    nil
+  end
+
+  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)