review 3.0.0 → 4.2.0

data/lib/review/rstbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -67,13 +67,13 @@ module ReVIEW
     end
     private :builder_init_file
 
-    def print(s)
+    def print(*s)
       @blank_seen = false
       super
     end
     private :print
 
-    def puts(s)
+    def puts(*s)
       @blank_seen = false
       super
     end
@@ -103,13 +103,13 @@ module ReVIEW
           blank
         end
         puts '=' * caption.size * 2
-      when 2 then
+      when 2
         p = '='
-      when 3 then
+      when 3
         p = '-'
-      when 4 then
+      when 4
         p = '`'
-      when 5 then
+      when 5
         p = '~'
       end
 
@@ -124,7 +124,7 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts '  ' * (@ul_indent - 1) + "* #{lines.join}"
+      puts '  ' * (@ul_indent - 1) + "* #{join_lines_to_paragraph(lines)}"
     end
 
     def ul_end
@@ -138,7 +138,7 @@ module ReVIEW
     end
 
     def ol_item(lines, _num)
-      puts '  ' * (@ol_indent - 1) + "#. #{lines.join}"
+      puts '  ' * (@ol_indent - 1) + "#. #{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -167,7 +167,7 @@ module ReVIEW
       if @in_role
         pre = '   '
       end
-      puts pre + lines.join
+      puts pre + join_lines_to_paragraph(lines)
       puts "\n"
     end
 
@@ -575,87 +575,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
@@ -682,7 +682,7 @@ module ReVIEW
     end
 
     def bpo(lines)
-      base_block 'bpo', lines, nil
+      base_block('bpo', lines, nil)
     end
 
     def inline_dtp(_str)
@@ -714,7 +714,7 @@ module ReVIEW
     end
 
     def source(lines, caption = nil, _lang = nil)
-      base_block 'source', lines, caption
+      base_block('source', lines, caption)
     end
 
     def inline_ttibold(str)

data/lib/review/textmaker.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
@@ -15,9 +15,12 @@ require 'review/book'
 require 'review/yamlloader'
 require 'review/topbuilder'
 require 'review/version'
+require 'review/makerhelper'
 
 module ReVIEW
   class TEXTMaker
+    include MakerHelper
+
     attr_accessor :config, :basedir
 
     def initialize
@@ -27,12 +30,12 @@ module ReVIEW
     end
 
     def error(msg)
-      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @logger.error msg
       exit 1
     end
 
     def warn(msg)
-      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      @logger.warn msg
     end
 
     def self.execute(*args)
@@ -42,10 +45,12 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-textmaker [-n] configfile'
       opts.version = ReVIEW::VERSION
       opts.on('-n', 'No decoration.') { @plaintext = true }
+      opts.on('-y', '--only file1,file2,...', 'Build only specified files.') { |v| @buildonly = v.split(/\s*,\s*/).map { |m| m.strip.sub(/\.re\Z/, '') } }
       opts.on('--help', 'Prints this message and quit.') do
         puts opts.help
         exit 0
@@ -65,6 +70,7 @@ module ReVIEW
     end
 
     def remove_old_files(path)
+      cleanup_mathimg('_review_math_text')
       FileUtils.rm_rf(path)
     end
 
@@ -80,6 +86,7 @@ module ReVIEW
       rescue => e
         error "yaml error #{e.message}"
       end
+
       # YAML configs will be overridden by command line options.
       @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
@@ -89,6 +96,11 @@ module ReVIEW
         raise if @config['debug']
         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)
+      end
     end
 
     def generate_text_files(yamlfile)
@@ -144,6 +156,10 @@ module ReVIEW
         filename = Pathname.new(chap.path).relative_path_from(base_path).to_s
       end
       id = File.basename(filename).sub(/\.re\Z/, '')
+      if @buildonly && !@buildonly.include?(id)
+        warn "skip #{id}.re"
+        return
+      end
 
       textfile = "#{id}.txt"
 

data/lib/review/textutils.rb

@@ -1,4 +1,13 @@
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+#                         KADO Masanori
+#               2002-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.
+#
 require 'nkf'
+require 'digest'
 
 module ReVIEW
   module TextUtils
@@ -26,10 +35,75 @@ module ReVIEW
         end
       end
 
+      blocked_lines.map! { |i| join_lines_to_paragraph(i) }
+
       if pre && post
-        blocked_lines.map! { |i| [pre] + i + [post] }
+        blocked_lines.map! { |i| pre + i + post }
+      end
+
+      blocked_lines
+    end
+
+    def add_space?(line1, line2, lang, lazy = nil)
+      # https://drafts.csswg.org/css-text-3/#line-break-transform
+      tail = line1[-1]
+      head = line2[0]
+      if tail.nil? || head.nil?
+        return nil
+      end
+      space = true
+      # rule 2
+      if %i[F W H].include?(Unicode::Eaw.property(tail)) &&
+         %i[F W H].include?(Unicode::Eaw.property(head)) &&
+         tail !~ /\p{Hangul}/ && head !~ /\p{Hangul}/
+        space = nil
+      end
+
+      if %w[ja zh zh_CN zh_TW yi].include?(lang)
+        # rule 3
+        if (%i[F W H].include?(Unicode::Eaw.property(tail)) &&
+            tail !~ /\p{Hangul}/ &&
+            (head =~ /\p{P}/ || head =~ /\p{S}/ || Unicode::Eaw.property(head) == :A)) ||
+           (%i[F W H].include?(Unicode::Eaw.property(head)) &&
+            head !~ /\p{Hangul}/ &&
+            (tail =~ /\p{P}/ || head =~ /\p{S}/ || Unicode::Eaw.property(tail) == :A))
+          space = nil
+        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
+        end
+      end
+      space
+    end
+
+    def join_lines_to_paragraph(lines)
+      unless @book.config['join_lines_by_lang']
+        return lines.join
+      end
+      lazy = true
+      lang = 'ja'
+      0.upto(lines.size - 2) do |n|
+        if add_space?(lines[n], lines[n + 1], lang, lazy)
+          lines[n] += ' '
+        end
+      end
+      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
-      blocked_lines.map(&:join)
     end
 
     private

data/lib/review/tocprinter.rb

@@ -1,148 +1,277 @@
-# Copyright (c) 2008-2017 Minero Aoki, Kenshi Muto
-#               2002-2007 Minero Aoki
+# Copyright (c) 2008-2020 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
+    def self.execute(*args)
+      Signal.trap(:INT) { exit 1 }
+      if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
+        Signal.trap(:PIPE, 'IGNORE')
+      end
+      new.execute(*args)
+    rescue Errno::EPIPE
+      exit 0
     end
 
-    def print_chapter(chap)
-      chap_node = TOCParser.chapter_node(chap)
-      print_node 1, chap_node
-      print_children chap_node
+    def initialize
+      @logger = ReVIEW.logger
+      @config = ReVIEW::Configure.values
+      @yamlfile = 'config.yml'
+      @book = ReVIEW::Book::Base.load
+      @upper = 4
+      @indent = true
+      @buildonly = nil
+      @detail = nil
     end
 
-    def print?(level)
-      level <= @print_upper
+    def execute(*args)
+      parse_options(args)
+      @book.config = ReVIEW::Configure.values
+      unless File.readable?(@yamlfile)
+        @logger.error("No such fiile or can't open #{@yamlfile}.")
+        exit 1
+      end
+      @book.load_config(@yamlfile)
+      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
-  end
 
-  class TextTOCPrinter < TOCPrinter
-    private
+    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({ part: 'start' })
+            if part.file?
+              result = build_chap(part)
+              result_array += parse_contents(part.name, @upper, result)
+            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 }
+              ]
+            end
+          end
 
-    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
+          part.chapters.each do |chap|
+            if @buildonly.nil? || @buildonly.include?(chap.name)
+              result = build_chap(chap)
+              result_array += parse_contents(chap.name, @upper, result)
+            end
+          end
+          if part.name.present? && (@buildonly.nil? || @buildonly.include?(part.name))
+            result_array.push({ part: 'end' })
+          end
         end
+      rescue ReVIEW::FileNotFound => e
+        @logger.error e
+        exit 1
       end
+
+      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 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 chapnumstr(n)
-      n ? sprintf('%2d.', n) : '   '
+    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
     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_linesize(l)
+      return l.size unless @calc_char_width
+      w = 0
+      l.split('').each do |c|
+        # XXX: should include A also?
+        if %i[Na H N].include?(Unicode::Eaw.property(c))
+          w += 0.5 # halfwidth
+        else
+          w += 1
+        end
+      end
+      w
     end
-  end
 
-  class HTMLTOCPrinter < TOCPrinter
-    include HTMLUtils
+    def parse_contents(name, upper, content)
+      headline_array = []
+      counter = { lines: 0, chars: 0, list_lines: 0, text_lines: 0 }
+      listmode = nil
 
-    def print_book(book)
-      @out.puts '<ul class="book-toc">'
-      book.each_part { |part| print_part(part) }
-      @out.puts '</ul>'
-    end
+      content.split("\n").each 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 = {
+              level: level,
+              headline: headline,
+              lines: 1,
+              chars: headline.size,
+              list_lines: 0,
+              text_lines: 1
+            }
+            next
+          end
+        end
 
-    def print_part(part)
-      if part.number
-        @out.puts li(part.title)
-      end
-      super
-    end
+        counter[:lines] += 1
+        counter[:chars] += l.size
 
-    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)
+        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
+        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
+        end
       end
-    end
+      headline_array.push(counter)
 
-    private
+      total_lines = 0
+      total_chars = 0
+      total_list_lines = 0
+      total_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]
+        total_lines += h[:lines]
+        total_chars += h[:chars]
+        total_list_lines += h[:list_lines]
+        total_text_lines += h[:text_lines]
+      end
 
-    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>'
-      end
-      res.join("\n")
+      headline_array.delete_if(&:empty?).
+        unshift({ name: name, lines: total_lines, chars: total_chars, list_lines: total_list_lines, text_lines: total_text_lines })
     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
+        exit 1
+      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