review 3.0.0 → 4.2.0

data/lib/review/plaintextbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018 Kenshi Muto
+# Copyright (c) 2018-2020 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -87,7 +87,7 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts lines.join
+      puts join_lines_to_paragraph(lines)
     end
 
     def ul_end
@@ -100,7 +100,7 @@ module ReVIEW
     end
 
     def ol_item(lines, num)
-      puts "#{num}　#{lines.join}"
+      puts "#{num}　#{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -127,7 +127,7 @@ module ReVIEW
     end
 
     def paragraph(lines)
-      puts lines.join
+      puts join_lines_to_paragraph(lines)
     end
 
     def read(lines)
@@ -137,27 +137,47 @@ module ReVIEW
 
     alias_method :lead, :read
 
-    def list_header(id, caption, _lang)
+    def list(lines, id, caption, lang = nil)
+      blank
+      begin
+        if caption_top?('list')
+          list_header(id, caption, lang)
+          blank
+        end
+        list_body(id, lines, lang)
+        unless caption_top?('list')
+          blank
+          list_header(id, caption, lang)
+        end
+      rescue KeyError
+        error "no such list: #{id}"
+      end
       blank
+    end
+
+    def list_header(id, caption, _lang)
       if get_chap
         puts %Q(#{I18n.t('list')}#{I18n.t('format_number', [get_chap, @chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)})
       else
         puts %Q(#{I18n.t('list')}#{I18n.t('format_number_without_chapter', [@chapter.list(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)})
       end
-      blank
     end
 
     def list_body(_id, lines, _lang)
       lines.each do |line|
         puts detab(line)
       end
-      blank
     end
 
     def base_block(_type, lines, caption = nil)
       blank
-      puts compile_inline(caption) if caption.present?
+      if caption_top?('list') && caption.present?
+        puts compile_inline(caption)
+      end
       puts lines.join("\n")
+      if !caption_top?('list') && caption.present?
+        puts compile_inline(caption)
+      end
       blank
     end
 
@@ -169,15 +189,38 @@ module ReVIEW
     end
 
     def emlist(lines, caption = nil, _lang = nil)
-      base_block 'emlist', lines, caption
+      base_block('emlist', lines, caption)
     end
 
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
-      puts compile_inline(caption) if caption.present?
+      if caption_top?('list')
+        puts compile_inline(caption) if caption.present?
+      end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
+      unless caption_top?('list')
+        puts compile_inline(caption) if caption.present?
+      end
+      blank
+    end
+
+    def listnum(lines, id, caption, lang = nil)
+      blank
+      begin
+        if caption_top?('list')
+          list_header(id, caption, lang)
+          blank
+        end
+        listnum_body(lines, lang)
+        unless caption_top?('list')
+          blank
+          list_header(id, caption, lang)
+        end
+      rescue KeyError
+        error "no such list: #{id}"
+      end
       blank
     end
 
@@ -185,15 +228,14 @@ module ReVIEW
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
-      blank
     end
 
     def cmd(lines, caption = nil)
-      base_block 'cmd', lines, caption
+      base_block('cmd', lines, caption)
     end
 
     def quote(lines)
-      base_parablock 'quote', lines, nil
+      base_parablock('quote', lines, nil)
     end
 
     def image(_lines, id, caption, _metric = nil)
@@ -207,58 +249,35 @@ module ReVIEW
     end
 
     def texequation(lines, id = nil, caption = '')
+      blank
+      texequation_header(id, caption) if caption_top?('equation')
+      puts lines.join("\n")
+      texequation_header(id, caption) unless caption_top?('equation')
+      blank
+    end
+
+    def texequation_header(id, caption)
       if id
-        blank
         if get_chap
           puts "#{I18n.t('equation')}#{I18n.t('format_number', [get_chap, @chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
         else
           puts "#{I18n.t('equation')}#{I18n.t('format_number_without_chapter', [@chapter.equation(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
         end
       end
-
-      puts lines.join("\n")
-      blank
     end
 
-    def table(lines, id = nil, caption = nil)
-      blank
-      rows = []
-      sepidx = nil
-      lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
-          sepidx ||= idx
-          next
-        end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
-      end
-      rows = adjust_n_cols(rows)
-
-      begin
-        table_header(id, caption) if caption.present?
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      return if rows.empty?
-      table_begin rows.first.size
-      if sepidx
-        sepidx.times do
-          tr(rows.shift.map { |s| th(s) })
-        end
-        rows.each do |cols|
-          tr(cols.map { |s| td(s) })
-        end
-      else
-        rows.each do |cols|
-          h, *cs = *cols
-          tr([th(h)] + cs.map { |s| td(s) })
-        end
+    def table(lines, id = nil, caption = nil, noblank = nil)
+      unless noblank
+        blank
       end
-      table_end
+      super(lines, id, caption)
     end
 
     def table_header(id, caption)
+      unless caption_top?('table')
+        blank
+      end
+
       if id.nil?
         puts compile_inline(caption)
       elsif get_chap
@@ -266,7 +285,10 @@ module ReVIEW
       else
         puts "#{I18n.t('table')}#{I18n.t('format_number_without_chapter', [@chapter.table(id).number])}#{I18n.t('caption_prefix_idgxml')}#{compile_inline(caption)}"
       end
-      blank
+
+      if caption_top?('table')
+        blank
+      end
     end
 
     def table_begin(_ncols)
@@ -344,8 +366,8 @@ module ReVIEW
     end
 
     def bibpaper(lines, id, caption)
-      bibpaper_header id, caption
-      bibpaper_bibpaper id, caption, lines unless lines.empty?
+      bibpaper_header(id, caption)
+      bibpaper_bibpaper(id, caption, lines) unless lines.empty?
     end
 
     def bibpaper_header(id, caption)
@@ -354,7 +376,7 @@ module ReVIEW
     end
 
     def bibpaper_bibpaper(_id, _caption, lines)
-      print split_paragraph(lines).join
+      puts split_paragraph(lines).join("\n")
     end
 
     def inline_bib(id)
@@ -364,13 +386,12 @@ module ReVIEW
     end
 
     def inline_hd_chap(chap, id)
-      if chap.number
-        n = chap.headline_index.number(id)
-        if @book.config['secnolevel'] >= n.split('.').size
-          return I18n.t('hd_quote', [n, compile_inline(chap.headline(id).caption)])
-        end
+      n = chap.headline_index.number(id)
+      if n.present? && chap.number && over_secnolevel?(n)
+        I18n.t('hd_quote', [n, compile_inline(chap.headline(id).caption)])
+      else
+        I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
       end
-      I18n.t('hd_quote_without_number', compile_inline(chap.headline(id).caption))
     rescue KeyError
       error "unknown headline: #{id}"
     end
@@ -472,87 +493,87 @@ module ReVIEW
     end
 
     def flushright(lines)
-      base_parablock 'flushright', lines, nil
+      base_parablock('flushright', lines, nil)
     end
 
     def centering(lines)
-      base_parablock 'centering', lines, nil
+      base_parablock('centering', lines, nil)
     end
 
     def note(lines, caption = nil)
-      base_parablock 'note', lines, caption
+      base_parablock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
-      base_parablock 'memo', lines, caption
+      base_parablock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
-      base_parablock 'tip', lines, caption
+      base_parablock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
-      base_parablock 'info', lines, caption
+      base_parablock('info', lines, caption)
     end
 
     def planning(lines, caption = nil)
-      base_parablock 'planning', lines, caption
+      base_parablock('planning', lines, caption)
     end
 
     def best(lines, caption = nil)
-      base_parablock 'best', lines, caption
+      base_parablock('best', lines, caption)
     end
 
     def important(lines, caption = nil)
-      base_parablock 'important', lines, caption
+      base_parablock('important', lines, caption)
     end
 
     def security(lines, caption = nil)
-      base_parablock 'security', lines, caption
+      base_parablock('security', lines, caption)
     end
 
     def caution(lines, caption = nil)
-      base_parablock 'caution', lines, caption
+      base_parablock('caution', lines, caption)
     end
 
     def term(lines)
-      base_parablock 'term', lines, nil
+      base_parablock('term', lines, nil)
     end
 
     def link(lines, caption = nil)
-      base_parablock 'link', lines, caption
+      base_parablock('link', lines, caption)
     end
 
     def notice(lines, caption = nil)
-      base_parablock 'notice', lines, caption
+      base_parablock('notice', lines, caption)
     end
 
     def point(lines, caption = nil)
-      base_parablock 'point', lines, caption
+      base_parablock('point', lines, caption)
     end
 
     def shoot(lines, caption = nil)
-      base_parablock 'shoot', lines, caption
+      base_parablock('shoot', lines, caption)
     end
 
     def reference(lines)
-      base_parablock 'reference', lines, nil
+      base_parablock('reference', lines, nil)
     end
 
     def practice(lines)
-      base_parablock 'practice', lines, nil
+      base_parablock('practice', lines, nil)
     end
 
     def expert(lines)
-      base_parablock 'expert', lines, nil
+      base_parablock('expert', lines, nil)
     end
 
     def insn(lines, caption = nil)
-      base_block 'insn', lines, caption
+      base_block('insn', lines, caption)
     end
 
     def warning(lines, caption = nil)
-      base_parablock 'warning', lines, caption
+      base_parablock('warning', lines, caption)
     end
 
     alias_method :box, :insn
@@ -573,7 +594,7 @@ module ReVIEW
     end
 
     def bpo(lines)
-      base_block 'bpo', lines, nil
+      base_block('bpo', lines, nil)
     end
 
     def inline_dtp(_str)
@@ -623,7 +644,7 @@ module ReVIEW
     end
 
     def source(lines, caption = nil, _lang = nil)
-      base_block 'source', lines, caption
+      base_block('source', lines, caption)
     end
 
     def inline_labelref(_idref)

data/lib/review/preprocessor.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2010-2019 Minero Aoki, Kenshi Muto
 #               2002-2009 Minero Aoki
 #
 # This program is free software.
@@ -43,41 +43,20 @@ module ReVIEW
   class Preprocessor
     include ErrorUtils
 
-    class Strip
-      def initialize(f)
-        @f = f
-      end
-
-      def path
-        @f.path
-      end
-
-      def lineno
-        @f.lineno
-      end
-
-      def gets
-        @f.each_line do |line|
-          return "\#@\#\n" if /\A\#@/ =~ line
-          return line
-        end
-        nil
-      end
-    end
-
     def initialize(repo, param)
       @repository = repo
       @config = param
       @logger = ReVIEW.logger
+      @leave_content = nil
     end
 
     def process(inf, outf)
-      init_errorutils inf
+      init_errorutils(inf)
       @f = outf
       begin
-        preproc inf
-      rescue Errno::ENOENT => err
-        error err.message
+        preproc(inf)
+      rescue Errno::ENOENT => e
+        error e.message
       end
     end
 
@@ -101,11 +80,12 @@ module ReVIEW
           direc = parse_directive(line, 1, 'stderr')
           @f.print line
           get_output(expand(direc.arg), direc['stderr']).each { |out| @f.print out.string }
-          skip_list f
+          skip_list(f)
 
         when /\A\#@mapfile/
           direc = parse_directive(line, 1, 'eval')
           path = expand(direc.arg)
+          @leave_content = File.extname(path) == '.re'
           if direc['eval']
             ent = evaluate(path, ent)
           else
@@ -116,6 +96,7 @@ module ReVIEW
         when /\A\#@map(?:range)?/
           direc = parse_directive(line, 2, 'unindent')
           path = expand(direc.args[0])
+          @leave_content = File.extname(path) == '.re'
           ent = @repository.fetch_range(path, direc.args[1]) or
             error "unknown range: #{path}: #{direc.args[1]}"
           ent = (direc['unindent'] ? unindent(ent, direc['unindent']) : ent)
@@ -127,6 +108,9 @@ module ReVIEW
         when /\A\#@/
           op = line.slice(/@(\w+)/, 1)
           warn "unknown directive: #{line.strip}" unless known_directive?(op)
+          if op == 'warn'
+            warn line.strip.sub(/\#@warn\((.+)\)/, '\1')
+          end
           @f.print line
 
         when /\A\s*\z/ # empty line
@@ -147,15 +131,15 @@ module ReVIEW
       @f.print directive_line
       newlines.each do |line|
         if with_lineno
-          print_number line.number
+          print_number(line.number)
         end
         @f.print line.string
       end
-      skip_list f
+      skip_list(f)
     end
 
     def print_number(num)
-      @f.printf '%4s  ', (num ? num.to_s : '')
+      @f.printf('%4s  ', (num ? num.to_s : ''))
     end
 
     def skip_list(f)
@@ -166,9 +150,11 @@ module ReVIEW
           @f.print line
           return nil
         when %r{\A//\}}
-          warn '//} seen in list'
-          @f.print line
-          return nil
+          unless @leave_content
+            warn '//} seen in list'
+            @f.print line
+            return nil
+          end
         when /\A\#@\w/
           warn "#{line.slice(/\A\#@\w+/)} seen in list"
           @f.print line
@@ -293,7 +279,7 @@ module ReVIEW
       Open3.popen3(cmd) do |_stdin, stdout, stderr|
         out = stdout.readlines
         if use_stderr
-          out.concat stderr.readlines
+          out.concat(stderr.readlines)
         else
           err = stderr.readlines
         end
@@ -357,6 +343,7 @@ module ReVIEW
     private
 
     def file_descripter(fname)
+      @leave_content = File.extname(fname) == '.re'
       return @repository[fname] if @repository[fname]
 
       @repository[fname] = git?(fname) ? parse_git_blob(fname) : parse_file(fname)
@@ -374,7 +361,7 @@ module ReVIEW
     end
 
     def parse_file(fname)
-      File.open(fname, 'r:BOM|utf-8') do |f|
+      File.open(fname, 'rt:BOM|utf-8') do |f|
         init_errorutils f
         return _parse_file(f)
       end
@@ -416,14 +403,14 @@ module ReVIEW
             error "begin x2: #{key}"
           end
           (repo[type] ||= {})[spec] = curr[key] = []
-          opened.push [type, spec]
+          opened.push([type, spec])
 
         when %r{(?:\A\#@|\#@@)([a-z]+)/(\w+)\}}
           type = check_type($1)
           spec = check_spec($2)
           curr.delete("#{type}/#{spec}") or
             error "end before begin: #{type}/#{spec}"
-          opened.delete "#{type}/#{spec}"
+          opened.delete("#{type}/#{spec}")
 
         when /(?:\A\#@|\#@@)\}/
           type, spec = opened.last
@@ -436,17 +423,17 @@ module ReVIEW
 
         when /\A\#@-/ # does not increment line number.
           line = canonical($')
-          curr.each_value { |list| list.push Line.new(nil, line) }
+          curr.each_value { |list| list.push(Line.new(nil, line)) }
 
         else
           next if yacchack and line.strip == ';'
           line = canonical(line)
-          curr.each_value { |list| list.push Line.new(lineno, line) }
+          curr.each_value { |list| list.push(Line.new(lineno, line)) }
           lineno += 1
         end
       end
       if curr.size > 1
-        curr.delete 'WHOLE'
+        curr.delete('WHOLE')
         curr.each { |range, lines| @logger.warn "#{filename}: unclosed range: #{range} (begin @#{lines.first.number})" }
         raise ApplicationError, 'ERROR'
       end
@@ -455,6 +442,10 @@ module ReVIEW
     end
 
     def canonical(line)
+      if @leave_content
+        return line
+      end
+
       tabwidth = @config['tabwidth'] || 8
       if tabwidth > 0
         detab(line, tabwidth).rstrip + "\n"