review 5.0.0 → 5.3.0

data/lib/review/textmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2020 Kenshi Muto
+# Copyright (c) 2018-2021 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -16,10 +16,13 @@ require 'review/yamlloader'
 require 'review/topbuilder'
 require 'review/version'
 require 'review/makerhelper'
+require 'review/img_math'
+require 'review/loggable'
 
 module ReVIEW
   class TEXTMaker
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -27,15 +30,8 @@ module ReVIEW
       @basedir = nil
       @logger = ReVIEW.logger
       @plaintext = nil
-    end
-
-    def error(msg)
-      @logger.error msg
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn msg
+      @img_math = nil
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -70,29 +66,31 @@ module ReVIEW
     end
 
     def remove_old_files(path)
-      cleanup_mathimg('_review_math_text')
+      @img_math.cleanup_mathimg
       FileUtils.rm_rf(path)
     end
 
     def execute(*args)
       cmd_config, yamlfile = parse_opts(args)
-      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+      error! "#{yamlfile} not found." unless File.exist?(yamlfile)
 
       @config = ReVIEW::Configure.create(maker: 'textmaker',
                                          yamlfile: yamlfile,
                                          config: cmd_config)
+      @img_math = ReVIEW::ImgMath.new(@config, path_name: '_review_math_text')
 
       I18n.setup(@config['language'])
       begin
         generate_text_files(yamlfile)
+        @logger.success("built #{build_path}")
       rescue ApplicationError => e
         raise if @config['debug']
-        error(e.message)
+
+        error! e.message
       end
 
-      math_dir = "./#{@config['imagedir']}/_review_math_text"
-      if @config['imgmath'] && File.exist?(File.join(math_dir, '__IMGMATH_BODY__.map'))
-        make_math_images(math_dir)
+      if @config['math_format'] == 'imgmath'
+        @img_math.make_math_images
       end
     end
 
@@ -105,15 +103,19 @@ module ReVIEW
       @book = ReVIEW::Book::Base.new(@basedir, config: @config)
 
       build_body(@path, yamlfile)
+
+      if @compile_errors
+        app_error 'compile error, No TEXT file output.'
+      end
     end
 
     def build_body(basetmpdir, _yamlfile)
       base_path = Pathname.new(@basedir)
       builder = nil
       if @plaintext
-        builder = ReVIEW::PLAINTEXTBuilder.new
+        builder = ReVIEW::PLAINTEXTBuilder.new(img_math: @img_math)
       else
-        builder = ReVIEW::TOPBuilder.new
+        builder = ReVIEW::TOPBuilder.new(img_math: @img_math)
       end
       @converter = ReVIEW::Converter.new(@book, builder)
       @book.parts.each do |part|
@@ -158,8 +160,9 @@ module ReVIEW
       begin
         @converter.convert(filename, File.join(basetmpdir, textfile))
       rescue => e
-        warn "compile error in #{filename} (#{e.class})"
-        warn e.message
+        @compile_errors = true
+        error "compile error in #{filename} (#{e.class})"
+        error e.message
       end
     end
   end

data/lib/review/textutils.rb

@@ -15,7 +15,7 @@ module ReVIEW
       add = 0
       len = nil
       str.gsub("\t") do
-        len = ts - ($`.size + add) % ts
+        len = ts - (($`.size + add) % ts)
         add += len - 1
         ' ' * len
       end
@@ -51,6 +51,7 @@ module ReVIEW
       if tail.nil? || head.nil?
         return nil
       end
+
       space = true
       # rule 2
       if %i[F W H].include?(Unicode::Eaw.property(tail)) &&
@@ -71,12 +72,13 @@ module ReVIEW
         end
 
         # lazy than rule 3, but it looks better
-        if lazy &&
-           (%i[F W H].include?(Unicode::Eaw.property(tail)) &&
-            tail !~ /\p{Hangul}/) ||
-           (%i[F W H].include?(Unicode::Eaw.property(head)) &&
-            head !~ /\p{Hangul}/)
-          space = nil
+        if lazy
+          if (%i[F W H].include?(Unicode::Eaw.property(tail)) &&
+              tail !~ /\p{Hangul}/) ||
+             (%i[F W H].include?(Unicode::Eaw.property(head)) &&
+              head !~ /\p{Hangul}/)
+            space = nil
+          end
         end
       end
       space
@@ -86,6 +88,7 @@ module ReVIEW
       unless @book.config['join_lines_by_lang']
         return lines.join
       end
+
       lazy = true
       lang = 'ja'
       0.upto(lines.size - 2) do |n|
@@ -96,16 +99,6 @@ module ReVIEW
       lines.join
     end
 
-    def defer_math_image(str, path, key)
-      # for Re:VIEW >3
-      File.open(File.join(File.dirname(path), "__IMGMATH_BODY__#{key}.tex"), 'w') do |f|
-        f.puts str
-      end
-      File.open(File.join(File.dirname(path), '__IMGMATH_BODY__.map'), 'a+') do |f|
-        f.puts key
-      end
-    end
-
     private
 
     # remove elements at the back of `lines` if element is empty string

data/lib/review/tocprinter.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
 #               1999-2007 Minero Aoki
 #
 # This program is free software.
@@ -36,34 +36,50 @@ module ReVIEW
   end
 
   class TOCPrinter
-    def self.execute(*args)
-      Signal.trap(:INT) { exit 1 }
-      if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
-        Signal.trap(:PIPE, 'IGNORE')
+    class Counter
+      def initialize(name: nil, level: nil, headline: nil, lines: nil, chars: nil, list_lines: nil, text_lines: nil, part: nil)
+        @name = name
+        @level = level
+        @headline = headline
+        @lines = lines
+        @chars = chars
+        @list_lines = list_lines
+        @text_lines = text_lines
+        @part = part
       end
+
+      attr_accessor :name, :level, :headline, :lines, :chars, :list_lines, :text_lines, :part
+    end
+
+    def self.execute(*args)
       new.execute(*args)
-    rescue Errno::EPIPE
-      exit 0
     end
 
     def initialize
       @logger = ReVIEW.logger
-      @config = ReVIEW::Configure.values
       @yamlfile = 'config.yml'
-      @book = ReVIEW::Book::Base.new('.', config: @config)
       @upper = 4
       @indent = true
       @buildonly = nil
       @detail = nil
+      @calc_char_width = nil
     end
 
+    attr_accessor :calc_char_width
+
     def execute(*args)
       parse_options(args)
-      unless File.readable?(@yamlfile)
-        @logger.error("No such fiile or can't open #{@yamlfile}.")
+      begin
+        @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
+        @book = ReVIEW::Book::Base.new('.', config: @config)
+        unless File.readable?(@yamlfile)
+          raise ReVIEW::FileNotFound, "No such fiile or can't open #{@yamlfile}."
+        end
+      rescue ReVIEW::ConfigError, ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
+        @logger.error e.message
         exit 1
       end
-      @book.load_config(@yamlfile)
+
       I18n.setup(@config['language'])
 
       if @detail
@@ -84,27 +100,27 @@ module ReVIEW
       begin
         @book.parts.each do |part|
           if part.name.present? && (@buildonly.nil? || @buildonly.include?(part.name))
-            result_array.push({ part: 'start' })
+            result_array.push(Counter.new(part: 'start'))
             if part.file?
-              result = build_chap(part)
-              result_array += parse_contents(part.name, @upper, result)
+              content = build_chap(part)
+              result_array.concat(parse_contents(part.name, @upper, content))
             else
               title = part.format_number + I18n.t('chapter_postfix') + part.title
-              result_array += [
-                { name: '', lines: 1, chars: title.size, list_lines: 0, text_lines: 1 },
-                { level: 0, headline: title, lines: 1, chars: title.size, list_lines: 0, text_lines: 1 }
-              ]
+              result_array.push(
+                Counter.new(name: '', lines: 1, chars: title.size, list_lines: 0, text_lines: 1),
+                Counter.new(level: 0, headline: title, lines: 1, chars: title.size, list_lines: 0, text_lines: 1)
+              )
             end
           end
 
           part.chapters.each do |chap|
             if @buildonly.nil? || @buildonly.include?(chap.name)
-              result = build_chap(chap)
-              result_array += parse_contents(chap.name, @upper, result)
+              content = build_chap(chap)
+              result_array.concat(parse_contents(chap.name, @upper, content))
             end
           end
           if part.name.present? && (@buildonly.nil? || @buildonly.include?(part.name))
-            result_array.push({ part: 'end' })
+            result_array.push(Counter.new(part: 'end'))
           end
         end
       rescue ReVIEW::FileNotFound, ReVIEW::CompileError => e
@@ -117,15 +133,15 @@ module ReVIEW
 
     def print_result(result_array)
       result_array.each do |result|
-        if result[:part]
+        if result.part
           next
         end
 
-        if result[:name]
+        if result.name
           # file information
           if @detail
             puts '============================='
-            printf("%6dC %5dL %5dP  %s\n", result[:chars], result[:lines], calc_pages(result).ceil, result[:name])
+            printf("%6dC %5dL %5dP  %s\n", result.chars, result.lines, calc_pages(result).ceil, result.name)
             puts '-----------------------------'
           end
           next
@@ -133,42 +149,39 @@ module ReVIEW
 
         # section information
         if @detail
-          printf('%6dC %5dL %5.1fP  ', result[:chars], result[:lines], calc_pages(result))
+          printf('%6dC %5dL %5.1fP  ', result.chars, result.lines, calc_pages(result))
         end
-        if @indent && result[:level]
-          print '  ' * (result[:level] == 0 ? 0 : result[:level] - 1)
+        if @indent && result.level
+          print '  ' * (result.level == 0 ? 0 : result.level - 1)
         end
-        puts result[:headline]
+        puts result.headline
       end
     end
 
     def calc_pages(result)
-      p = 0
-      p += result[:list_lines].to_f / @book.page_metric.list.n_lines
-      p += result[:text_lines].to_f / @book.page_metric.text.n_lines
-      p
+      (result.list_lines.to_f / @book.page_metric.list.n_lines) +
+        (result.text_lines.to_f / @book.page_metric.text.n_lines)
     end
 
-    def calc_linesize(l)
-      return l.size unless @calc_char_width
-      w = 0
-      l.split('').each do |c|
+    def calc_linesize(line)
+      return line.size unless @calc_char_width
+
+      line.each_char.inject(0) do |result, char|
         # XXX: should include A also?
-        if %i[Na H N].include?(Unicode::Eaw.property(c))
-          w += 0.5 # halfwidth
+        if %i[Na H N].include?(Unicode::Eaw.property(char))
+          result + 0.5 # halfwidth
         else
-          w += 1
+          result + 1
         end
       end
-      w
     end
 
     def parse_contents(name, upper, content)
       headline_array = []
-      counter = { lines: 0, chars: 0, list_lines: 0, text_lines: 0 }
+      counter = Counter.new(lines: 0, chars: 0, list_lines: 0, text_lines: 0)
       listmode = nil
 
-      content.split("\n").each do |l|
+      content.each_line(chomp: true) do |l|
         if l.start_with?("\x01STARTLIST\x01")
           listmode = true
           next
@@ -180,58 +193,67 @@ module ReVIEW
           level = $1.to_i
           l = $'
           if level <= upper
-            if counter[:chars] > 0
+            if counter.chars > 0
               headline_array.push(counter)
             end
             headline = l
-            counter = {
+            counter = Counter.new(
               level: level,
               headline: headline,
               lines: 1,
               chars: headline.size,
               list_lines: 0,
               text_lines: 1
-            }
+            )
             next
           end
         end
 
-        counter[:lines] += 1
-        counter[:chars] += l.size
+        counter.lines += 1
+        counter.chars += l.size
 
         if listmode
           # code list: calculate line wrapping
-          if l.size == 0
-            counter[:list_lines] += 1
-          else
-            counter[:list_lines] += (calc_linesize(l) - 1) / @book.page_metric.list.n_columns + 1
-          end
+          counter.list_lines += calc_line_wrapping(l, mode: :list)
         else
           # normal paragraph: calculate line wrapping
-          if l.size == 0
-            counter[:text_lines] += 1
-          else
-            counter[:text_lines] += (calc_linesize(l) - 1) / @book.page_metric.text.n_columns + 1
-          end
+          counter.text_lines += calc_line_wrapping(l, mode: :text)
         end
       end
       headline_array.push(counter)
 
-      total_lines = 0
-      total_chars = 0
-      total_list_lines = 0
-      total_text_lines = 0
+      total = calc_total_count(name, headline_array)
+      headline_array.unshift(total)
+    end
+
+    def calc_line_wrapping(line, mode:)
+      return 1 if line.size == 0
+
+      case mode
+      when :list
+        ((calc_linesize(line) - 1) / @book.page_metric.list.n_columns) + 1
+      else # mode == :text
+        ((calc_linesize(line) - 1) / @book.page_metric.text.n_columns) + 1
+      end
+    end
+
+    def calc_total_count(name, headline_array)
+      total = Counter.new(name: name,
+                          lines: 0,
+                          chars: 0,
+                          list_lines: 0,
+                          text_lines: 0)
 
       headline_array.each do |h|
-        next unless h[:lines]
-        total_lines += h[:lines]
-        total_chars += h[:chars]
-        total_list_lines += h[:list_lines]
-        total_text_lines += h[:text_lines]
+        next unless h.lines
+
+        total.lines += h.lines
+        total.chars += h.chars
+        total.list_lines += h.list_lines
+        total.text_lines += h.text_lines
       end
 
-      headline_array.delete_if(&:empty?).
-        unshift({ name: name, lines: total_lines, chars: total_chars, list_lines: total_list_lines, text_lines: total_text_lines })
+      total
     end
 
     def build_chap(chap)
@@ -239,8 +261,8 @@ module ReVIEW
       begin
         compiler.compile(@book.chapter(chap.name))
       rescue ReVIEW::ApplicationError => e
-        @logger.error e
-        exit 1
+        @logger.error e.message
+        ''
       end
     end
 

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -78,7 +78,7 @@ module ReVIEW
 
     def dd(lines)
       split_paragraph(lines).each do |paragraph|
-        puts "\t#{paragraph.gsub(/\n/, '')}"
+        puts "\t#{paragraph.delete("\n")}"
       end
     end
 
@@ -105,7 +105,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       puts "◆→終了:#{@titles['list']}←◆"
       blank
@@ -178,7 +178,7 @@ module ReVIEW
           list_header(id, caption, lang)
         end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
       puts "◆→終了:#{@titles['list']}←◆"
       blank
@@ -202,7 +202,7 @@ module ReVIEW
       if @chapter.image_bound?(id)
         puts "◆→#{@chapter.image(id).path}#{metrics}←◆"
       else
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         lines.each do |line|
           puts line
         end
@@ -228,15 +228,12 @@ module ReVIEW
       puts "◆→開始:#{@titles['texequation']}←◆"
       texequation_header(id, caption) if caption_top?('equation')
 
-      if @book.config['imgmath']
+      if @book.config['math_format'] == 'imgmath'
         fontsize = @book.config['imgmath_options']['fontsize'].to_f
         lineheight = @book.config['imgmath_options']['lineheight'].to_f
         math_str = "\\begin{equation*}\n\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont\n#{lines.join("\n")}\n\\end{equation*}\n"
         key = Digest::SHA256.hexdigest(math_str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math_text')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
-        defer_math_image(math_str, img_path, key)
+        img_path = @img_math.defer_math_image(math_str, key)
         puts "◆→math:#{File.basename(img_path)}←◆"
       else
         puts lines.join("\n")
@@ -274,6 +271,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(comment)
@@ -289,7 +287,25 @@ module ReVIEW
     def inline_fn(id)
       "【注#{@chapter.footnote(id).number}】"
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
+    end
+
+    def inline_endnote(id)
+      "【後注#{@chapter.endnote(id).number}】"
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
+    end
+
+    def endnote_begin
+      puts '◆→開始:後注←◆'
+    end
+
+    def endnote_end
+      puts '◆→終了:後注←◆'
+    end
+
+    def endnote_item(id)
+      puts "【後注#{@chapter.endnote(id).number}】#{compile_inline(@chapter.endnote(id).content)}"
     end
 
     def compile_ruby(base, ruby)
@@ -367,11 +383,23 @@ module ReVIEW
       "＠#{str}＠◆→＠〜＠部分に下線←◆"
     end
 
+    def inline_ins(str)
+      "◆→開始:挿入表現←◆#{str}◆→終了:挿入表現←◆"
+    end
+
+    def inline_del(str)
+      "◆→開始:削除表現←◆#{str}◆→終了:削除表現←◆"
+    end
+
+    def inline_tcy(str)
+      "◆→開始:回転←◆#{str}◆→終了:縦回転←◆"
+    end
+
     def inline_icon(id)
       begin
         "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}←◆"
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         "◆→画像 #{id}←◆"
       end
     end
@@ -397,13 +425,10 @@ module ReVIEW
     end
 
     def inline_m(str)
-      if @book.config['imgmath']
+      if @book.config['math_format'] == 'imgmath'
         math_str = '$' + str + '$'
         key = Digest::SHA256.hexdigest(str)
-        math_dir = File.join(@book.config['imagedir'], '_review_math_text')
-        Dir.mkdir(math_dir) unless Dir.exist?(math_dir)
-        img_path = File.join(math_dir, "_gen_#{key}.#{@book.config['imgmath_options']['format']}")
-        defer_math_image(math_str, img_path, key)
+        img_path = @img_math.defer_math_image(math_str, key)
         %Q(◆→TeX式ここから←◆◆→math:#{File.basename(img_path)}←◆◆→TeX式ここまで←◆)
       else
         %Q(◆→TeX式ここから←◆#{str}◆→TeX式ここまで←◆)
@@ -418,7 +443,7 @@ module ReVIEW
     def inline_bib(id)
       %Q([#{@chapter.bibpaper(id).number}])
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def noindent
@@ -480,7 +505,7 @@ module ReVIEW
       begin
         puts "◆→画像 #{@chapter.image(id).path.sub(%r{\A\./}, '')}#{metrics}←◆"
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         puts "◆→画像 #{id}←◆"
       end
       if !caption_top?('image') && caption.present?

data/lib/review/update.rb

@@ -301,6 +301,7 @@ module ReVIEW
         if !config['htmlversion'].present? || config['htmlversion'].to_f >= HTML_VERSION.to_f
           next
         end
+
         if confirm("%s: Update '%s' to '%s' from '%s'?", [File.basename(yml), 'htmlversion', HTML_VERSION, config['htmlversion']])
           rewrite_yml(yml, 'htmlversion', HTML_VERSION)
         end
@@ -313,6 +314,7 @@ module ReVIEW
         if !config['chapter_quote'].present? || config['chapter_quote'].scan('%s').size != 1
           next
         end
+
         v = config['chapter_quote'].sub('%s', '%s %s')
         if confirm("%s: 'chapter_quote' now takes 2 values. Update '%s' to '%s'?", [File.basename(yml), config['chapter_quote'], v])
           rewrite_yml(yml, 'chapter_quote', v)
@@ -414,9 +416,7 @@ module ReVIEW
             opts << "paper=#{v.sub('j', '').sub('paper', '')}"
           when /[\d.]+ptj/ # not cared...
             opts << "fontsize=#{v.sub('j', '')}"
-          when /[\d.]+pt/
-            opts << "fontsize=#{v}"
-          when /[\d.]+Q/
+          when /[\d.]+pt/, /[\d.]+Q/
             opts << "fontsize=#{v}"
           when 'landscape', 'oneside', 'twoside', 'vartwoside', 'onecolumn',
                'twocolumn', 'titlepage', 'notitlepage', 'openright',
@@ -442,9 +442,7 @@ module ReVIEW
             opts << "paper=#{v.sub('j', '').sub('paper', '')}"
           when /[\d.]+ptj/ # not cared...
             opts << "fontsize=#{v.sub('j', '')}"
-          when /[\d.]+pt/
-            opts << "fontsize=#{v}"
-          when /[\d.]+Q/
+          when /[\d.]+pt/, /[\d.]+Q/
             opts << "fontsize=#{v}"
           when 'landscape', 'oneside', 'twoside', 'onecolumn', 'twocolumn', 'titlepage', 'notitlepage', 'openright', 'openany', 'leqno', 'fleqn', 'draft', 'final', 'report'
             # pass-through
@@ -516,6 +514,7 @@ module ReVIEW
         if !config['texcommand'] || config['texcommand'] !~ /\s+-/
           next
         end
+
         # option should be moved to texoptions
         cmd, opts = config['texcommand'].split(/\s+-/, 2)
         opts = "-#{opts}"

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.3.0'.freeze
 end