review 4.1.0 → 5.2.0

data/lib/review/textutils.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #               2002-2007 Minero Aoki
 #
@@ -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)) &&
@@ -86,6 +87,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,17 +98,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__.tex'), 'a+') do |f|
-        f.puts str
-        f.puts '\\clearpage'
-      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,148 +1,293 @@
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
-#               2002-2007 Minero Aoki
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
+#               1999-2007 Minero Aoki
 #
 # 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 LGPL, see the file "COPYING".
+# For details of the GNU LGPL, see the file "COPYING".
 #
 
-require 'review/htmlutils'
-require 'review/tocparser'
+require 'review/book'
+require 'review/version'
+require 'optparse'
+require 'review/plaintextbuilder'
 
 module ReVIEW
-  class TOCPrinter
-    def self.default_upper_level
-      99 # no one use 99 level nest
+  class PLAINTEXTTocBuilder < PLAINTEXTBuilder
+    def headline(level, label, caption)
+      if @chapter.is_a?(ReVIEW::Book::Part)
+        print "\x01H0\x01" # XXX: don't modify level value. level value will be handled in sec_counter#prefix()
+      else
+        print "\x01H#{level}\x01"
+      end
+      # embed header information for tocparser
+      super(level, label, caption)
     end
 
-    def initialize(print_upper, param, out = $stdout)
-      @print_upper = print_upper
-      @config = param
-      @out = out
+    def base_block(type, lines, caption = nil)
+      puts "\x01STARTLIST\x01"
+      super(type, lines, caption)
+      puts "\x01ENDLIST\x01"
     end
 
-    def print_book(book)
-      book.each_part { |part| print_part(part) }
+    def blank
+      @blank_seen = true
     end
+  end
 
-    def print_part(part)
-      part.each_chapter { |chap| print_chapter(chap) }
+  class TOCPrinter
+    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 print_chapter(chap)
-      chap_node = TOCParser.chapter_node(chap)
-      print_node(1, chap_node)
-      print_children(chap_node)
+    def self.execute(*args)
+      new.execute(*args)
     end
 
-    def print?(level)
-      level <= @print_upper
+    def initialize
+      @logger = ReVIEW.logger
+      @yamlfile = 'config.yml'
+      @upper = 4
+      @indent = true
+      @buildonly = nil
+      @detail = nil
+      @calc_char_width = nil
     end
-  end
 
-  class TextTOCPrinter < TOCPrinter
-    private
+    attr_accessor :calc_char_width
 
-    def print_children(node)
-      return unless print?(node.level + 1)
-      node.each_section_with_index do |section, idx|
-        unless section.blank?
-          print_node(idx + 1, section)
-          print_children(section)
+    def execute(*args)
+      parse_options(args)
+      @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
+      @book = ReVIEW::Book::Base.new('.', config: @config)
+      unless File.readable?(@yamlfile)
+        @logger.error("No such fiile or can't open #{@yamlfile}.")
+        exit 1
+      end
+      I18n.setup(@config['language'])
+
+      if @detail
+        begin
+          require 'unicode/eaw'
+          @calc_char_width = true
+        rescue LoadError
+          @logger.warn('not found unicode/eaw library. page volume may be unreliable.')
+          @calc_char_width = nil
         end
       end
+
+      print_result(build_result_array)
     end
 
-    def print_node(number, node)
-      if node.chapter?
-        vol = node.volume
-        @out.printf("%3s %3dKB %6dC %5dL  %s (%s)\n",
-                    chapnumstr(node.number),
-                    vol.kbytes, vol.chars, vol.lines,
-                    node.label, node.chapter_id)
-      else ## for section node
-        @out.printf("%17s %5dL  %s\n",
-                    '', node.estimated_lines,
-                    "  #{'   ' * (node.level - 1)}#{number} #{node.label}")
+    def build_result_array
+      result_array = []
+      begin
+        @book.parts.each do |part|
+          if part.name.present? && (@buildonly.nil? || @buildonly.include?(part.name))
+            result_array.push(Counter.new(part: 'start'))
+            if part.file?
+              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.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)
+              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(Counter.new(part: 'end'))
+          end
+        end
+      rescue ReVIEW::FileNotFound, ReVIEW::CompileError => e
+        @logger.error e
+        exit 1
       end
+
+      result_array
     end
 
-    def chapnumstr(n)
-      n ? sprintf('%2d.', n) : '   '
+    def print_result(result_array)
+      result_array.each do |result|
+        if result.part
+          next
+        end
+
+        if result.name
+          # file information
+          if @detail
+            puts '============================='
+            printf("%6dC %5dL %5dP  %s\n", result.chars, result.lines, calc_pages(result).ceil, result.name)
+            puts '-----------------------------'
+          end
+          next
+        end
+
+        # section information
+        if @detail
+          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)
+        end
+        puts result.headline
+      end
     end
 
-    def volume_columns(level, volstr)
-      cols = ['', '', '', nil]
-      cols[level - 1] = volstr
-      cols[0, 3] # does not display volume of level-4 section
+    def calc_pages(result)
+      (result.list_lines.to_f / @book.page_metric.list.n_lines) +
+        (result.text_lines.to_f / @book.page_metric.text.n_lines)
     end
-  end
 
-  class HTMLTOCPrinter < TOCPrinter
-    include HTMLUtils
+    def calc_linesize(line)
+      return line.size unless @calc_char_width
 
-    def print_book(book)
-      @out.puts '<ul class="book-toc">'
-      book.each_part { |part| print_part(part) }
-      @out.puts '</ul>'
+      line.each_char.inject(0) do |result, char|
+        # XXX: should include A also?
+        if %i[Na H N].include?(Unicode::Eaw.property(char))
+          result + 0.5 # halfwidth
+        else
+          result + 1
+        end
+      end
     end
 
-    def print_part(part)
-      if part.number
-        @out.puts li(part.title)
+    def parse_contents(name, upper, content)
+      headline_array = []
+      counter = Counter.new(lines: 0, chars: 0, list_lines: 0, text_lines: 0)
+      listmode = nil
+
+      content.each_line(chomp: true) do |l|
+        if l.start_with?("\x01STARTLIST\x01")
+          listmode = true
+          next
+        elsif l.start_with?("\x01ENDLIST\x01")
+          listmode = nil
+          next
+        elsif l =~ /\A\x01H(\d)\x01/
+          # headline
+          level = $1.to_i
+          l = $'
+          if level <= upper
+            if counter.chars > 0
+              headline_array.push(counter)
+            end
+            headline = l
+            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
+
+        if listmode
+          # code list: calculate line wrapping
+          counter.list_lines += calc_line_wrapping(l, mode: :list)
+        else
+          # normal paragraph: calculate line wrapping
+          counter.text_lines += calc_line_wrapping(l, mode: :text)
+        end
       end
-      super
+      headline_array.push(counter)
+
+      total = calc_total_count(name, headline_array)
+      headline_array.unshift(total)
     end
 
-    def print_chapter(chap)
-      chap_node = TOCParser.chapter_node(chap)
-      ext = chap.book.config['htmlext'] || 'html'
-      path = chap.path.sub(/\.re/, '.' + ext)
-      label = if chap_node.number && chap.on_chaps?
-                "#{chap.number} #{chap.title}"
-              else
-                chap.title
-              end
-      @out.puts li(a_name(path, escape_html(label)))
-      return unless print?(2)
-      if print?(3)
-        @out.puts chap_sections_to_s(chap_node)
-      else
-        @out.puts chapter_to_s(chap_node)
+    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
 
-    private
+    def calc_total_count(name, headline_array)
+      total = Counter.new(name: name,
+                          lines: 0,
+                          chars: 0,
+                          list_lines: 0,
+                          text_lines: 0)
 
-    def chap_sections_to_s(chap)
-      return '' if chap.section_size < 1
-      res = []
-      res << '<ol>'
-      chap.each_section { |sec| res << li(escape_html(sec.label)) }
-      res << '</ol>'
-      res.join("\n")
-    end
+      headline_array.each do |h|
+        next unless h.lines
 
-    def chapter_to_s(chap)
-      res = []
-      chap.each_section do |sec|
-        res << li(escape_html(sec.label))
-        next unless print?(4)
-        next unless sec.section_size > 0
-        res << '<ul>'
-        sec.each_section { |node| res << li(escape_html(node.label)) }
-        res << '</ul>'
+        total.lines += h.lines
+        total.chars += h.chars
+        total.list_lines += h.list_lines
+        total.text_lines += h.text_lines
       end
-      res.join("\n")
+
+      total
     end
 
-    def li(content)
-      "<li>#{content}</li>"
+    def build_chap(chap)
+      compiler = ReVIEW::Compiler.new(ReVIEW::PLAINTEXTTocBuilder.new)
+      begin
+        compiler.compile(@book.chapter(chap.name))
+      rescue ReVIEW::ApplicationError => e
+        @logger.error e.message
+        ''
+      end
     end
 
-    def a_name(name, label)
-      %Q(<a name="#{name}">#{label}</a>)
+    def parse_options(args)
+      opts = OptionParser.new
+      opts.version = ReVIEW::VERSION
+      opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| @yamlfile = yaml }
+      opts.on('-y', '--only file1,file2,...', 'list only specified files.') do |v|
+        @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') }
+      end
+      opts.on('-l', '--level N', 'list upto N level (default=4)') do |n|
+        @upper = n.to_i
+      end
+      opts.on('-d', '--detail', 'show characters and lines of each section.') do
+        @detail = true
+      end
+      opts.on('--noindent', "don't indent headlines.") do
+        @indent = nil
+      end
+      opts.on('--help', 'print this message and quit.') do
+        puts opts.help
+        exit 0
+      end
+      begin
+        opts.parse!(args)
+      rescue OptionParser::ParseError => e
+        @logger.error e.message
+        $stderr.puts opts.help
+        exit 1
+      end
     end
   end
 end

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2020 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
 
@@ -95,12 +95,18 @@ module ReVIEW
       blank
       puts "◆→開始:#{@titles['list']}←◆"
       begin
-        list_header(id, caption, lang)
+        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}"
+        app_error "no such list: #{id}"
       end
-      blank
-      list_body(id, lines, lang)
       puts "◆→終了:#{@titles['list']}←◆"
       blank
     end
@@ -122,8 +128,13 @@ module ReVIEW
     def base_block(type, lines, caption = nil)
       blank
       puts "◆→開始:#{@titles[type]}←◆"
-      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
       puts "◆→終了:#{@titles[type]}←◆"
       blank
     end
@@ -140,10 +151,15 @@ module ReVIEW
     def emlistnum(lines, caption = nil, _lang = nil)
       blank
       puts "◆→開始:#{@titles['emlist']}←◆"
-      puts "■#{compile_inline(caption)}" if caption.present?
+      if caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       lines.each_with_index do |line, i|
         puts((i + 1).to_s.rjust(2) + ": #{line}")
       end
+      if !caption_top?('list') && caption.present?
+        puts "■#{compile_inline(caption)}"
+      end
       puts "◆→終了:#{@titles['emlist']}←◆"
       blank
     end
@@ -152,12 +168,18 @@ module ReVIEW
       blank
       puts "◆→開始:#{@titles['list']}←◆"
       begin
-        list_header(id, caption, lang)
+        if caption_top?('list') && caption.present?
+          list_header(id, caption, lang)
+          blank
+        end
+        listnum_body(lines, lang)
+        if !caption_top?('list') && caption.present?
+          blank
+          list_header(id, caption, lang)
+        end
       rescue KeyError
-        error "no such list: #{id}"
+        app_error "no such list: #{id}"
       end
-      blank
-      listnum_body(lines, lang)
       puts "◆→終了:#{@titles['list']}←◆"
       blank
     end
@@ -173,16 +195,22 @@ module ReVIEW
       metrics = " #{metrics}" if metrics.present?
       blank
       puts "◆→開始:#{@titles['image']}←◆"
-      image_header(id, caption)
-      blank
+      if caption_top?('image')
+        image_header(id, caption)
+        blank
+      end
       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
       end
+      unless caption_top?('image')
+        blank
+        image_header(id, caption)
+      end
       puts "◆→終了:#{@titles['image']}←◆"
       blank
     end
@@ -198,22 +226,20 @@ module ReVIEW
     def texequation(lines, id = nil, caption = '')
       blank
       puts "◆→開始:#{@titles['texequation']}←◆"
-      texequation_header(id, caption)
+      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")
       end
 
+      texequation_header(id, caption) unless caption_top?('equation')
       puts "◆→終了:#{@titles['texequation']}←◆"
       blank
     end
@@ -245,6 +271,7 @@ module ReVIEW
 
     def comment(lines, comment = nil)
       return unless @book.config['draft']
+
       lines ||= []
       unless comment.blank?
         lines.unshift(comment)
@@ -260,7 +287,7 @@ module ReVIEW
     def inline_fn(id)
       "【注#{@chapter.footnote(id).number}】"
     rescue KeyError
-      error "unknown footnote: #{id}"
+      app_error "unknown footnote: #{id}"
     end
 
     def compile_ruby(base, ruby)
@@ -338,11 +365,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
@@ -368,13 +407,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式ここまで←◆)
@@ -389,7 +425,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
@@ -415,17 +451,48 @@ module ReVIEW
       blank
     end
 
+    def common_block_begin(type, _level, _label, caption = nil)
+      blank
+      puts "◆→開始:#{@titles[type]}←◆"
+      puts '■' + compile_inline(caption) if caption.present?
+    end
+
+    def common_block_end(type, _level)
+      puts "◆→終了:#{@titles[type]}←◆"
+      blank
+    end
+
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          common_block_begin('#{name}', nil, nil, caption)
+        end
+
+        def #{name}_end
+          common_block_end('#{name}', nil)
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 11
+    end
+
     def indepimage(_lines, id, caption = nil, metric = nil)
       metrics = parse_metric('top', metric)
       metrics = " #{metrics}" if metrics.present?
       blank
+      if caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       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
-      puts "図　#{compile_inline(caption)}" if caption.present?
+      if !caption_top?('image') && caption.present?
+        puts "図　#{compile_inline(caption)}"
+      end
       blank
     end