review 5.0.0 → 5.3.0

data/lib/review/idgxmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -47,6 +47,7 @@ module ReVIEW
     end
 
     def builder_init_file
+      super
       @warns = []
       @errors = []
       @section = 0
@@ -77,6 +78,8 @@ module ReVIEW
     end
 
     def result
+      check_printendnotes
+
       s = ''
       if @secttags
         s += '</sect4>' if @subsubsubsection > 0
@@ -103,15 +106,9 @@ module ReVIEW
     end
 
     def headline(level, label, caption)
+      output_close_sect_tags(level)
       case level
       when 1
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-          print '</sect2>' if @subsection > 0
-          print '</sect>' if @section > 0
-        end
-
         print %Q(<chapter id="chap:#{@chapter.number}">) if @secttags
 
         @section = 0
@@ -119,12 +116,6 @@ module ReVIEW
         @subsubsection = 0
         @subsubsubsection = 0
       when 2
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-          print '</sect2>' if @subsection > 0
-          print '</sect>' if @section > 0
-        end
         @section += 1
         print %Q(<sect id="sect:#{@chapter.number}.#{@section}">) if @secttags
 
@@ -132,30 +123,17 @@ module ReVIEW
         @subsubsection = 0
         @subsubsubsection = 0
       when 3
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-          print '</sect2>' if @subsection > 0
-        end
-
         @subsection += 1
         print %Q(<sect2 id="sect:#{@chapter.number}.#{@section}.#{@subsection}">) if @secttags
 
         @subsubsection = 0
         @subsubsubsection = 0
       when 4
-        if @secttags
-          print '</sect4>' if @subsubsubsection > 0
-          print '</sect3>' if @subsubsection > 0
-        end
-
         @subsubsection += 1
         print %Q(<sect3 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}">) if @secttags
 
         @subsubsubsection = 0
       when 5
-        print '</sect4>' if @secttags && @subsubsubsection > 0
-
         @subsubsubsection += 1
         print %Q(<sect4 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}.#{@subsubsubsection}">) if @secttags
       when 6 # rubocop:disable Lint/EmptyWhen
@@ -170,6 +148,23 @@ module ReVIEW
       puts %Q(<title#{label} aid:pstyle="h#{level}">#{prefix}#{compile_inline(caption)}</title><?dtp level="#{level}" section="#{prefix}#{toccaption}"?>)
     end
 
+    def output_close_sect_tags(level)
+      if @secttags
+        if level <= 5 && @subsubsubsection > 0
+          print '</sect4>'
+        end
+        if level <= 4 && @subsubsection > 0
+          print '</sect3>'
+        end
+        if level <= 3 && @subsection > 0
+          print '</sect2>'
+        end
+        if level <= 2 && @section > 0
+          print '</sect>'
+        end
+      end
+    end
+
     def ul_begin
       level = block_given? ? yield : ''
       level = nil if level == 1
@@ -208,7 +203,7 @@ module ReVIEW
 
     def ol_begin
       puts '<ol>'
-      @ol_num ||= 1
+      @ol_num ||= 1 # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def ol_item(lines, num)
@@ -273,7 +268,7 @@ module ReVIEW
         I18n.t('column', compile_inline(chapter.column(id).caption))
       end
     rescue KeyError
-      error "unknown column: #{id}"
+      app_error "unknown column: #{id}"
     end
 
     def inline_list(id)
@@ -282,6 +277,7 @@ module ReVIEW
 
     def list_header(id, caption, _lang)
       return true unless caption.present?
+
       if get_chap.nil?
         puts %Q(<caption>#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
       else
@@ -443,11 +439,12 @@ module ReVIEW
       print '</pre>'
       image_header(id, caption) unless caption_top?('image')
       puts '</img>'
-      warn "image not bound: #{id}"
+      warn "image not bound: #{id}", location: location
     end
 
     def image_header(id, caption)
       return true unless caption.present?
+
       if get_chap.nil?
         puts %Q(<caption>#{I18n.t('image')}#{I18n.t('format_number_without_chapter', [@chapter.image(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
       else
@@ -508,7 +505,7 @@ module ReVIEW
           table_header(id, caption)
         end
       rescue KeyError
-        error "no such table: #{id}"
+        app_error "no such table: #{id}"
       end
       puts '</table>'
       @tsize = nil
@@ -530,7 +527,7 @@ module ReVIEW
         col2 = rows[rows.length - 1].split(table_row_separator_regexp).length
         @col = col2 if col2 > @col
       end
-      error 'no rows in the table' if rows.empty?
+      app_error 'no rows in the table' if rows.empty?
       [sepidx, rows]
     end
 
@@ -545,11 +542,11 @@ module ReVIEW
           cellwidth.size.times do |n|
             cellwidth[n] = cellwidth[n].to_f / @book.config['pt_to_mm_unit'].to_f
             totallength += cellwidth[n]
-            warn "total length exceeds limit for table: #{@table_id}" if totallength > @tablewidth
+            warn "total length exceeds limit for table: #{@table_id}", location: location if totallength > @tablewidth
           end
           if cellwidth.size < @col
             cw = (@tablewidth - totallength) / (@col - cellwidth.size)
-            warn "auto cell sizing exceeds limit for table: #{@table_id}" if cw <= 0
+            warn "auto cell sizing exceeds limit for table: #{@table_id}", location: location if cw <= 0
             (cellwidth.size..(@col - 1)).each { |i| cellwidth[i] = cw }
           end
         end
@@ -633,13 +630,14 @@ module ReVIEW
         end
         puts '</table>'
       else
-        warn "image not bound: #{id}" if @strict
+        warn "image not bound: #{id}", location: location if @strict
         image_dummy(id, caption, lines)
       end
     end
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       lines.unshift(escape(comment)) unless comment.blank?
       str = lines.join("\n")
@@ -661,7 +659,25 @@ module ReVIEW
     def inline_fn(id)
       %Q(<footnote>#{compile_inline(@chapter.footnote(id).content.strip)}</footnote>)
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
+    end
+
+    def inline_endnote(id)
+      %Q(<span type='endnoteref' idref='endnoteb-#{normalize_id(id)}'>(#{@chapter.endnote(id).number})</span>)
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
+    end
+
+    def endnote_begin
+      puts '<endnotes>'
+    end
+
+    def endnote_end
+      puts '</endnotes>'
+    end
+
+    def endnote_item(id)
+      puts %Q(<endnote id='endnoteb-#{normalize_id(id)}'><span type='endnotenumber'>(#{@chapter.endnote(id).number})</span>\t#{compile_inline(@chapter.endnote(id).content)}</endnote>)
     end
 
     def compile_ruby(base, ruby)
@@ -674,7 +690,7 @@ module ReVIEW
         then escape("#{word}（#{alt.strip}）")
         else escape(word)
         end +
-      '</keyword>' +
+        '</keyword>' +
         %Q(<index value="#{escape(word)}" />) +
         if alt
           alt.split(/\s*,\s*/).collect! { |e| %Q(<index value="#{escape(e.strip)}" />) }.join
@@ -723,7 +739,7 @@ module ReVIEW
           sprintf('&#x%x;', 9392 + str[0] - 65)
         end
       else
-        error "can't parse maru: #{str}"
+        app_error "can't parse maru: #{str}"
       end
     end
 
@@ -773,11 +789,19 @@ module ReVIEW
       %Q(<underline>#{escape(str)}</underline>)
     end
 
+    def inline_ins(str)
+      %Q(<ins>#{escape(str)}</ins>)
+    end
+
+    def inline_del(str)
+      %Q(<del>#{escape(str)}</del>)
+    end
+
     def inline_icon(id)
       begin
         %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}" type="inline" />)
       rescue
-        warn "image not bound: #{id}"
+        warn "image not bound: #{id}", location: location
         ''
       end
     end
@@ -1124,7 +1148,7 @@ module ReVIEW
       begin
         puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A\./}, '')}"#{metrics} />)
       rescue
-        warn %Q(image not bound: #{id})
+        warn %Q(image not bound: #{id}), location: location
       end
       unless caption_top?('image')
         puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
@@ -1182,10 +1206,10 @@ module ReVIEW
         chs = ['', '「', '」']
         if @book.config['chapref']
           chs2 = @book.config['chapref'].split(',')
-          if chs2.size != 3
-            error '--chapsplitter must have exactly 3 parameters with comma.'
-          else
+          if chs2.size == 3
             chs = chs2
+          else
+            app_error '--chapsplitter must have exactly 3 parameters with comma.'
           end
         end
         s = "#{chs[0]}#{@book.chapter_index.number(id)}#{chs[1]}#{@book.chapter_index.title(id)}#{chs[2]}"
@@ -1203,7 +1227,7 @@ module ReVIEW
         end
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
@@ -1213,7 +1237,7 @@ module ReVIEW
         @book.chapter_index.number(id)
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_title(id)
@@ -1224,7 +1248,7 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def source(lines, caption = nil, lang = nil)
@@ -1267,7 +1291,7 @@ module ReVIEW
     def inline_bib(id)
       %Q(<span type='bibref' idref='#{id}'>[#{@chapter.bibpaper(id).number}]</span>)
     rescue KeyError
-      error "unknown bib: #{id}"
+      app_error "unknown bib: #{id}"
     end
 
     def inline_hd_chap(chap, id)
@@ -1278,7 +1302,7 @@ module ReVIEW
         I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
     rescue KeyError
-      error "unknown headline: #{id}"
+      app_error "unknown headline: #{id}"
     end
 
     def inline_recipe(id)

data/lib/review/idgxmlmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2019 Kenshi Muto
+# Copyright (c) 2019-2021 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -16,10 +16,12 @@ require 'review/yamlloader'
 require 'review/idgxmlbuilder'
 require 'review/version'
 require 'review/makerhelper'
+require 'review/loggable'
 
 module ReVIEW
   class IDGXMLMaker
     include MakerHelper
+    include Loggable
 
     attr_accessor :config, :basedir
 
@@ -27,15 +29,7 @@ module ReVIEW
       @basedir = nil
       @logger = ReVIEW.logger
       @plaintext = nil
-    end
-
-    def error(msg)
-      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
-      exit 1
-    end
-
-    def warn(msg)
-      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @compile_errors = nil
     end
 
     def self.execute(*args)
@@ -78,7 +72,7 @@ module ReVIEW
 
     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: 'idgxmlmaker',
                                          yamlfile: yamlfile,
@@ -86,9 +80,11 @@ module ReVIEW
       I18n.setup(@config['language'])
       begin
         generate_idgxml_files(yamlfile)
+        @logger.success("built #{build_path}")
       rescue ApplicationError => e
         raise if @config['debug']
-        error(e.message)
+
+        error! e.message
       end
     end
 
@@ -104,6 +100,10 @@ module ReVIEW
       end
 
       build_body(@path, yamlfile)
+
+      if @compile_errors
+        app_error 'compile error, No IDGXML file output.'
+      end
     end
 
     def apply_filter(xmlfile)
@@ -178,8 +178,9 @@ module ReVIEW
         @converter.convert(filename, File.join(basetmpdir, xmlfile))
         apply_filter(File.join(basetmpdir, xmlfile))
       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/img_math.rb

@@ -0,0 +1,239 @@
+require 'fileutils'
+require 'shellwords'
+require 'review/loggable'
+
+module ReVIEW
+  class ImgMath
+    include Loggable
+
+    def initialize(config, path_name: '_review_math')
+      @config = config
+      @logger = ReVIEW.logger
+      @math_dir = File.join(@config['imagedir'], path_name)
+      @math_maps = {}
+    end
+
+    def cleanup_mathimg
+      if @config['math_format'] == 'imgmath' && Dir.exist?(@math_dir)
+        FileUtils.rm_rf(@math_dir)
+      end
+    end
+
+    def defer_math_image(str, key)
+      # for Re:VIEW >3
+      @math_maps[key] = str
+      File.join(@math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")
+    end
+
+    def make_math_image(str, key, fontsize = 12)
+      # Re:VIEW 2 compatibility
+
+      img_path = File.join(@math_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")
+      Dir.mkdir(@math_dir) unless Dir.exist?(@math_dir)
+      fontsize2 = (fontsize * 1.2).round.to_i
+      texsrc = <<-EOB
+\\documentclass[12pt]{article}
+\\usepackage[utf8]{inputenc}
+\\usepackage{amsmath}
+\\usepackage{amsthm}
+\\usepackage{amssymb}
+\\usepackage{amsfonts}
+\\usepackage{anyfontsize}
+\\usepackage{bm}
+\\pagestyle{empty}
+
+\\begin{document}
+\\fontsize{#{fontsize}}{#{fontsize2}}\\selectfont #{str}
+\\end{document}
+      EOB
+      Dir.mktmpdir do |tmpdir|
+        tex_path = File.join(tmpdir, 'tmpmath.tex')
+        dvi_path = File.join(tmpdir, 'tmpmath.dvi')
+        File.write(tex_path, texsrc)
+        cmd = "latex --interaction=nonstopmode --output-directory=#{tmpdir} #{tex_path} && dvipng -T tight -z9 -o #{img_path} #{dvi_path}"
+        out, status = Open3.capture2e(cmd)
+        unless status.success?
+          raise ApplicationError, "latex compile error\n\nError log:\n#{out}"
+        end
+
+        img_path
+      end
+    end
+
+    def make_math_images
+      return if @math_maps.empty?
+
+      Dir.mkdir(@math_dir) unless Dir.exist?(@math_dir)
+      fontsize = @config['imgmath_options']['fontsize'].to_f
+      lineheight = @config['imgmath_options']['lineheight'].to_f
+
+      texsrc = default_imgmath_preamble
+      if @config['imgmath_options']['preamble_file'] && File.readable?(@config['imgmath_options']['preamble_file'])
+        texsrc = File.read(@config['imgmath_options']['preamble_file'])
+      end
+
+      texsrc << <<-EOB
+\\begin{document}
+\\fontsize{#{fontsize}}{#{lineheight}}\\selectfont
+\\input{__IMGMATH_BODY__}
+\\end{document}
+      EOB
+
+      math_real_dir = File.realpath(@math_dir)
+      Dir.mktmpdir do |tmpdir|
+        File.open(File.join(tmpdir, '__IMGMATH_BODY__.tex'), 'w') do |f|
+          @math_maps.keys.sort.each do |key|
+            f.puts "% #{key}"
+            f.puts @math_maps[key]
+            f.puts '\\clearpage'
+            f.puts
+          end
+        end
+
+        tex_path = File.join(tmpdir, '__IMGMATH__.tex')
+        File.write(tex_path, texsrc)
+
+        begin
+          case @config['imgmath_options']['converter']
+          when 'pdfcrop'
+            make_math_images_pdfcrop(tmpdir, tex_path, math_real_dir)
+          when 'dvipng'
+            make_math_images_dvipng(tmpdir, tex_path, math_real_dir)
+          else
+            error! "unknown math converter error. imgmath_options/converter parameter should be 'pdfcrop' or 'dvipng'."
+          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."
+        end
+      end
+      @math_maps.clear
+    end
+
+    private
+
+    def default_imgmath_preamble
+      <<-EOB
+\\documentclass[uplatex,a3paper,landscape]{jsarticle}
+\\usepackage[deluxe,uplatex]{otf}
+\\usepackage[T1]{fontenc}
+\\usepackage{textcomp}
+\\usepackage{lmodern}
+\\usepackage[dvipdfmx]{graphicx}
+\\usepackage[dvipdfmx,table]{xcolor}
+\\usepackage[utf8]{inputenc}
+\\usepackage{ascmac}
+\\usepackage{float}
+\\usepackage{alltt}
+\\usepackage{amsmath}
+\\usepackage{amssymb}
+\\usepackage{amsfonts}
+\\usepackage{anyfontsize}
+\\usepackage{bm}
+\\pagestyle{empty}
+% \\setpaperwidth{1000mm}
+      EOB
+    end
+
+    def make_math_images_pdfcrop(dir, tex_path, math_real_dir)
+      Dir.chdir(dir) do
+        dvi_path = '__IMGMATH__.dvi'
+        pdf_path = '__IMGMATH__.pdf'
+        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
+        if !status.success? || (!File.exist?(dvi_path) && !File.exist?(pdf_path))
+          raise CompileError
+        end
+
+        if File.exist?(dvi_path)
+          out, status = Open3.capture2e(*[@config['dvicommand'], @config['dvioptions'].shellsplit, dvi_path].flatten.compact)
+          if !status.success? || !File.exist?(pdf_path)
+            @logger.error "error in #{@config['dvicommand']}. Error log:\n#{out}"
+            raise CompileError
+          end
+        end
+        args = @config['imgmath_options']['pdfcrop_cmd'].shellsplit
+        args.map! do |m|
+          m.sub('%i', pdf_path).
+            sub('%o', '__IMGMATH__pdfcrop.pdf')
+        end
+        out, status = Open3.capture2e(*args)
+        unless status.success?
+          @logger.error "error in pdfcrop. Error log:\n#{out}"
+          raise CompileError
+        end
+        pdf_path = '__IMGMATH__pdfcrop.pdf'
+        pdf_path2 = pdf_path
+
+        @math_maps.keys.sort.each_with_index do |key, idx|
+          page = idx + 1
+          if File.exist?(File.join(math_real_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}"))
+            # made already
+            next
+          end
+
+          if @config['imgmath_options']['extract_singlepage']
+            # if extract_singlepage = true, split each page
+            args = @config['imgmath_options']['pdfextract_cmd'].shellsplit
+
+            args.map! do |m|
+              m.sub('%i', pdf_path).
+                sub('%o', "__IMGMATH__pdfcrop_p#{page}.pdf").
+                sub('%O', "__IMGMATH__pdfcrop_p#{page}").
+                sub('%p', page.to_s)
+            end
+            out, status = Open3.capture2e(*args)
+            unless status.success?
+              @logger.error "error in pdf extracting. Error log:\n#{out}"
+              raise CompileError
+            end
+
+            pdf_path2 = "__IMGMATH__pdfcrop_p#{page}.pdf"
+          end
+
+          args = @config['imgmath_options']['pdfcrop_pixelize_cmd'].shellsplit
+          args.map! do |m|
+            m.sub('%i', pdf_path2).
+              sub('%t', @config['imgmath_options']['format']).
+              sub('%o', File.join(math_real_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
+              sub('%O', File.join(math_real_dir, "_gen_#{key}")).
+              sub('%p', page.to_s)
+          end
+          out, status = Open3.capture2e(*args)
+          unless status.success?
+            @logger.error "error in pdf pixelizing. Error log:\n#{out}"
+            raise CompileError
+          end
+        end
+      end
+    end
+
+    def make_math_images_dvipng(dir, tex_path, math_real_dir)
+      Dir.chdir(dir) do
+        dvi_path = '__IMGMATH__.dvi'
+        out, status = Open3.capture2e(*[@config['texcommand'], @config['texoptions'].shellsplit, tex_path].flatten.compact)
+        if !status.success? || !File.exist?(dvi_path)
+          raise CompileError
+        end
+
+        @math_maps.keys.sort.each_with_index do |key, idx|
+          page = idx + 1
+          args = @config['imgmath_options']['dvipng_cmd'].shellsplit
+          args.map! do |m|
+            m.sub('%i', dvi_path).
+              sub('%o', File.join(math_real_dir, "_gen_#{key}.#{@config['imgmath_options']['format']}")).
+              sub('%O', File.join(math_real_dir, "_gen_#{key}")).
+              sub('%p', page.to_s)
+          end
+          out, status = Open3.capture2e(*args)
+          unless status.success?
+            @logger.error "error in dvipng. Error log:\n#{out}"
+            raise CompileError
+          end
+        end
+      end
+    end
+  end
+end