review 4.1.0 → 5.2.0

data/lib/review/htmlutils.rb

@@ -7,19 +7,16 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 #
 
-require 'cgi/util'
+begin
+  require 'cgi/escape'
+rescue
+  require 'cgi/util'
+end
+
 module ReVIEW
   module HTMLUtils
-    ESC = {
-      '&' => '&',
-      '<' => '&lt;',
-      '>' => '&gt;',
-      '"' => '&quot;'
-    } # .freeze
-
     def escape(str)
-      t = ESC
-      str.gsub(/[&"<>]/) { |c| t[c] }
+      CGI.escapeHTML(str)
     end
 
     alias_method :escape_html, :escape # for backward compatibility
@@ -137,7 +134,7 @@ module ReVIEW
       elsif id =~ /\A[0-9_.-][a-z0-9_.-]*\Z/i
         "id_#{id}" # dummy prefix
       else
-        "id_#{CGI.escape(id.gsub('_', '__')).gsub('%', '_').gsub('+', '-')}" # escape all
+        "id_#{CGI.escape(id.gsub('_', '__')).tr('%', '_').tr('+', '-')}" # escape all
       end
     end
   end

data/lib/review/i18n.rb

@@ -91,6 +91,7 @@ module ReVIEW
       else
         user_i18n.each do |key, values|
           raise KeyError, "Invalid locale file: #{path}" unless values.is_a?(Hash)
+
           @store[key].merge!(values)
         end
       end
@@ -125,7 +126,7 @@ module ReVIEW
       frmt.gsub!('%%', '##')
 
       unless args.is_a?(Array)
-        args = args.nil? && frmt !~ /\%/ ? [] : [args]
+        args = args.nil? && frmt !~ /%/ ? [] : [args]
       end
 
       percents = frmt.scan(/%[A-Za-z]{1,3}/)

data/lib/review/idgxmlbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -46,11 +46,8 @@ module ReVIEW
       '.xml'
     end
 
-    def builder_init
-    end
-    private :builder_init
-
     def builder_init_file
+      super
       @warns = []
       @errors = []
       @section = 0
@@ -89,19 +86,27 @@ module ReVIEW
         s += '</sect>' if @section > 0
         s += '</chapter>' if @chapter.number > 0
       end
-      @output.string + s + "</#{@rootelement}>\n"
+      solve_nest(@output.string) + s + "</#{@rootelement}>\n"
+    end
+
+    def solve_nest(s)
+      check_nest
+      s.gsub("</dd></dl>\x01→dl←\x01", '').
+        gsub("\x01→/dl←\x01", "</dd></dl>←END\x01").
+        gsub("</li></ul>\x01→ul←\x01", '').
+        gsub("\x01→/ul←\x01", "</li></ul>←END\x01").
+        gsub("</li></ol>\x01→ol←\x01", '').
+        gsub("\x01→/ol←\x01", "</li></ol>←END\x01").
+        gsub("</dl>←END\x01<dl>", '').
+        gsub("</ul>←END\x01<ul>", '').
+        gsub("</ol>←END\x01<ol>", '').
+        gsub("←END\x01", '')
     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
@@ -109,12 +114,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
 
@@ -122,30 +121,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
@@ -160,6 +146,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
@@ -198,7 +201,7 @@ module ReVIEW
 
     def ol_begin
       puts '<ol>'
-      @ol_num ||= 1
+      @ol_num ||= 1 # rubocop:disable Naming/MemoizedInstanceVariableName
     end
 
     def ol_item(lines, num)
@@ -263,7 +266,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)
@@ -272,6 +275,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
@@ -351,7 +355,9 @@ module ReVIEW
 
     def quotedlist(lines, css_class, caption)
       print %Q(<list type='#{css_class}'>)
-      puts "<caption aid:pstyle='#{css_class}-title'>#{compile_inline(caption)}</caption>" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "<caption aid:pstyle='#{css_class}-title'>#{compile_inline(caption)}</caption>"
+      end
       print '<pre>'
       no = 1
       lines.each do |line|
@@ -366,7 +372,11 @@ module ReVIEW
         print '</listinfo>' if @book.config['listinfo']
         no += 1
       end
-      puts '</pre></list>'
+      puts '</pre>'
+      if !caption_top?('list') && caption.present?
+        puts "<caption aid:pstyle='#{css_class}-title'>#{compile_inline(caption)}</caption>"
+      end
+      puts '</list>'
     end
     private :quotedlist
 
@@ -410,26 +420,29 @@ module ReVIEW
     def image_image(id, caption, metric = nil)
       metrics = parse_metric('idgxml', metric)
       puts '<img>'
+      image_header(id, caption) if caption_top?('image')
       puts %Q(<Image href="file://#{@chapter.image(id).path.sub(%r{\A./}, '')}"#{metrics} />)
-      image_header(id, caption)
+      image_header(id, caption) unless caption_top?('image')
       puts '</img>'
     end
 
     def image_dummy(id, caption, lines)
       puts '<img>'
+      image_header(id, caption) if caption_top?('image')
       print %Q(<pre aid:pstyle="dummyimage">)
       lines.each do |line|
         print detab(line)
         print "\n"
       end
       print '</pre>'
-      image_header(id, caption)
+      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
@@ -439,13 +452,15 @@ module ReVIEW
 
     def texequation(lines, id = nil, caption = '')
       @texblockequation += 1
+      caption_str = nil
       if id
         puts '<equationblock>'
         if get_chap.nil?
-          puts %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
+          caption_str = %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
         else
-          puts %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
+          caption_str = %Q(<caption>#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}</caption>)
         end
+        puts caption_str if caption_top?('equation')
       end
 
       puts %Q(<replace idref="texblock-#{@texblockequation}">)
@@ -455,6 +470,7 @@ module ReVIEW
       puts '</replace>'
 
       if id
+        puts caption_str unless caption_top?('equation')
         puts '</equationblock>'
       end
     end
@@ -470,19 +486,26 @@ module ReVIEW
       puts '<table>'
 
       begin
-        table_header(id, caption) if caption.present?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
 
-      if @tablewidth.nil?
-        print '<tbody>'
-      else
-        print %Q(<tbody xmlns:aid5="http://ns.adobe.com/AdobeInDesign/5.0/" aid:table="table" aid:trows="#{rows.length}" aid:tcols="#{@col}">)
+        if @tablewidth.nil?
+          print '<tbody>'
+        else
+          print %Q(<tbody xmlns:aid5="http://ns.adobe.com/AdobeInDesign/5.0/" aid:table="table" aid:trows="#{rows.length}" aid:tcols="#{@col}">)
+        end
+        @table_id = id
+        table_rows(sepidx, rows)
+        puts '</tbody>'
+
+        if !caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+      rescue KeyError
+        app_error "no such table: #{id}"
       end
-      @table_id = id
-      table_rows(sepidx, rows)
-      puts '</tbody></table>'
+      puts '</table>'
       @tsize = nil
     end
 
@@ -490,7 +513,7 @@ module ReVIEW
       sepidx = nil
       rows = []
       lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
+        if /\A[=\-]{12}/ =~ line
           sepidx ||= idx
           next
         end
@@ -502,7 +525,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
 
@@ -517,11 +540,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
@@ -596,17 +619,23 @@ module ReVIEW
       if @chapter.image_bound?(id)
         metrics = parse_metric('idgxml', metric)
         puts '<table>'
-        table_header(id, caption) if caption.present?
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
         puts %Q(<imgtable><Image href="file://#{@chapter.image(id).path.sub(%r{\A./}, '')}"#{metrics} /></imgtable>)
+        if !caption_top?('table') && caption.present?
+          table_header(id, caption)
+        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")
@@ -628,7 +657,7 @@ 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 compile_ruby(base, ruby)
@@ -641,7 +670,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
@@ -690,7 +719,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
 
@@ -740,11 +769,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
@@ -919,18 +956,22 @@ module ReVIEW
     end
 
     def note(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('info', lines, caption)
     end
 
@@ -943,6 +984,7 @@ module ReVIEW
     end
 
     def important(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('important', lines, caption)
     end
 
@@ -951,10 +993,12 @@ module ReVIEW
     end
 
     def caution(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('caution', lines, caption)
     end
 
     def warning(lines, caption = nil)
+      check_nested_minicolumn
       captionblock('warning', lines, caption)
     end
 
@@ -967,6 +1011,7 @@ module ReVIEW
     end
 
     def notice(lines, caption = nil)
+      check_nested_minicolumn
       if caption
         captionblock('notice-t', lines, caption, 'notice-title')
       else
@@ -1002,7 +1047,35 @@ module ReVIEW
       captionblock('expert', lines, nil)
     end
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          if '#{name}' == 'notice' && caption.present?
+            @doc_status[:minicolumn] = '#{name}-t'
+            print "<#{name}-t>"
+          else
+            @doc_status[:minicolumn] = '#{name}'
+            print "<#{name}>"
+          end
+          if caption.present?
+            puts %Q(<title aid:pstyle='#{name}-title'>\#{compile_inline(caption)}</title>)
+          end
+        end
+
+        def #{name}_end
+          if '#{name}' == 'notice' && @doc_status[:minicolumn] == 'notice-t'
+            print "</#{name}-t>"
+          else
+            print "</#{name}>"
+          end
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 23
+    end
+
     def syntaxblock(type, lines, caption)
+      captionstr = nil
       if caption.present?
         titleopentag = %Q(caption aid:pstyle="#{type}-title")
         titleclosetag = 'caption'
@@ -1010,9 +1083,13 @@ module ReVIEW
           titleopentag = %Q(floattitle type="insn")
           titleclosetag = 'floattitle'
         end
-        puts %Q(<#{type}><#{titleopentag}>#{compile_inline(caption)}</#{titleclosetag}>)
+        captionstr = %Q(<#{titleopentag}>#{compile_inline(caption)}</#{titleclosetag}>)
+      end
+      print "<#{type}>"
+      if caption_top?('list')
+        puts captionstr
       else
-        puts "<#{type}>"
+        puts ''
       end
 
       no = 1
@@ -1028,6 +1105,9 @@ module ReVIEW
         print '</listinfo>' if @book.config['listinfo']
         no += 1
       end
+      unless caption_top?('list')
+        print captionstr
+      end
       puts "</#{type}>"
     end
 
@@ -1042,12 +1122,17 @@ module ReVIEW
     def indepimage(_lines, id, caption = nil, metric = nil)
       metrics = parse_metric('idgxml', metric)
       puts '<img>'
+      if caption_top?('image')
+        puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
+      end
       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?
       end
-      puts %Q(<caption>#{compile_inline(caption)}</caption>) if caption.present?
       puts '</img>'
     end
 
@@ -1101,10 +1186,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]}"
@@ -1122,7 +1207,7 @@ module ReVIEW
         end
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def inline_chap(id)
@@ -1132,7 +1217,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)
@@ -1143,13 +1228,18 @@ module ReVIEW
         title
       end
     rescue KeyError
-      error "unknown chapter: #{id}"
+      app_error "unknown chapter: #{id}"
     end
 
     def source(lines, caption = nil, lang = nil)
       puts '<source>'
-      source_header(caption)
+      if caption_top?('list')
+        source_header(caption)
+      end
       source_body(lines, lang)
+      unless caption_top?('list')
+        source_header(caption)
+      end
       puts '</source>'
     end
 
@@ -1181,7 +1271,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)
@@ -1192,7 +1282,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)