review 3.1.0 → 5.0.0

data/lib/review/book/index/item.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2008-2019 Minero Aoki, Kenshi Muto
+#
+# 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".
+#
+
+require 'review/extentions'
+require 'review/exception'
+require 'review/book/image_finder'
+require 'review/i18n'
+require 'review/logger'
+
+module ReVIEW
+  module Book
+    class Index
+      class Item
+        def initialize(id, number, caption = nil)
+          @id = id
+          @number = number
+          @caption = caption
+          @path = nil
+          @index = nil
+        end
+
+        attr_reader :id
+        attr_reader :number
+        attr_reader :caption
+        attr_accessor :index # internal use only
+
+        alias_method :content, :caption
+
+        def path
+          if @path
+            return @path
+          end
+
+          @path = @index.find_path(@id)
+
+          @path
+        end
+      end
+    end
+  end
+end

data/lib/review/book/page_metric.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -11,21 +11,21 @@ module ReVIEW
     class PageMetric
       MetricData = Struct.new(:n_lines, :n_columns)
 
-      def initialize(list_lines, list_columns, text_lines, text_columns, page_per_kbyte)
+      def initialize(list_lines, list_columns, text_lines, text_columns, _page_per_kbyte = 1)
+        # page_per_kbyte is obsolete. Just for backward compatibility
         @list = MetricData.new(list_lines, list_columns)
         @text = MetricData.new(text_lines, text_columns)
-        @page_per_kbyte = page_per_kbyte
       end
 
-      A5 = PageMetric.new(46, 80, 30, 74, 1)
-      B5 = PageMetric.new(46, 80, 30, 74, 2)
+      # based on review-jsbook's default
+      A5 = PageMetric.new(40, 34, 29, 34)
+      B5 = PageMetric.new(50, 40, 36, 40)
 
       attr_reader :list
       attr_reader :text
-      attr_reader :page_per_kbyte
 
       def ==(other)
-        self.list == other.list && self.text == other.text && self.page_per_kbyte == other.page_per_kbyte
+        self.list == other.list && self.text == other.text
       end
     end
   end

data/lib/review/book/part.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -6,27 +6,46 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 # For details of the GNU LGPL, see the file "COPYING".
 #
-require 'review/book/compilable'
+require 'review/book/book_unit'
 
 module ReVIEW
   module Book
-    class Part
-      include Compilable
+    class Part < BookUnit
+      def self.mkpart_from_namelistfile(book, path)
+        chaps = []
+        File.read(path, mode: 'rt:BOM|utf-8').split.each_with_index do |name, number|
+          if path =~ /PREDEF/
+            chaps << Chapter.mkchap(book, name)
+          else
+            chaps << Chapter.mkchap(book, name, number + 1)
+          end
+        end
+        Part.mkpart(chaps)
+      end
+
+      def self.mkpart_from_namelist(book, names)
+        Part.mkpart(names.map { |name| Chapter.mkchap_ifexist(book, name) }.compact)
+      end
+
+      def self.mkpart(chaps)
+        chaps.empty? ? nil : Part.new(chaps[0].book, nil, chaps)
+      end
 
       # if Part is dummy, `number` is nil.
       #
       def initialize(book, number, chapters, name = '', io = nil)
         @book = book
         @number = number
-        @chapters = chapters
         @name = name
+        @chapters = chapters
         @path = name
-        @content = nil
         if io
           @content = io.read
         elsif @path.present? && File.exist?(File.join(@book.config['contentdir'], @path))
-          @content = File.read(File.join(@book.config['contentdir'], @path), mode: 'r:BOM|utf-8')
-          @name = File.basename(@name, '.re')
+          @content = File.read(File.join(@book.config['contentdir'], @path), mode: 'rt:BOM|utf-8')
+          @name = File.basename(name, '.re')
+        else
+          @content = ''
         end
         if file?
           @title = nil
@@ -34,6 +53,19 @@ module ReVIEW
           @title = name
         end
         @volume = nil
+
+        super()
+      end
+
+      def generate_indexes
+        super
+
+        return unless content
+
+        @numberless_image_index = @indexes.numberless_image_index
+        @image_index = @indexes.image_index
+        @icon_index = @indexes.icon_index
+        @indepimage_index = @indexes.indepimage_index
       end
 
       attr_reader :number
@@ -45,8 +77,11 @@ module ReVIEW
       end
 
       def volume
-        vol = Volume.sum(@chapters.map(&:volume))
-        vol.page_per_kbyte = @book.page_metric.page_per_kbyte
+        if @number && file?
+          vol = Volume.count_file(File.join(@book.config['contentdir'], @path))
+        else
+          vol = Volume.new(0, 0, 0)
+        end
         vol
       end
 

data/lib/review/book/volume.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2007-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2007-2020 Minero Aoki, Kenshi Muto
 #               2002-2007 Minero Aoki
 #
 # This program is free software.
@@ -22,7 +22,7 @@ module ReVIEW
       end
 
       def self.sum(vols)
-        vols.inject(new) { |sum, i| sum + i }
+        vols.inject(new) { |sum, i| sum + i } # rubocop:disable Performance/Sum
       end
 
       def self.dummy
@@ -33,20 +33,19 @@ module ReVIEW
         @bytes = bytes
         @chars = chars
         @lines = lines
-        @page_per_kbyte = nil
       end
 
       attr_reader :bytes
       attr_reader :chars
       attr_accessor :lines
-      attr_accessor :page_per_kbyte
 
       def kbytes
         (@bytes.to_f / 1024).ceil
       end
 
       def page
-        (kbytes.to_f / @page_per_kbyte).ceil
+        # XXX:unrelibable
+        kbytes.to_f.ceil
       end
 
       def to_s

data/lib/review/builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2002-2018 Minero Aoki, Kenshi Muto
+# Copyright (c) 2002-2020 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -11,7 +11,6 @@ require 'review/textutils'
 require 'review/compiler'
 require 'review/sec_counter'
 require 'stringio'
-require 'cgi'
 require 'fileutils'
 require 'tempfile'
 require 'csv'
@@ -20,7 +19,7 @@ module ReVIEW
   class Builder
     include TextUtils
 
-    CAPTION_TITLES = %w[note memo tip info warning important caution notice].freeze
+    CAPTION_TITLES = Compiler.minicolumn_names
 
     def pre_paragraph
       nil
@@ -30,21 +29,17 @@ module ReVIEW
       nil
     end
 
-    attr_accessor :doc_status
+    attr_accessor :doc_status, :previous_list_type
 
-    def initialize(strict = false, *args)
+    def initialize(strict = false, *_args)
       @strict = strict
       @output = nil
       @logger = ReVIEW.logger
       @doc_status = {}
       @dictionary = {}
-      builder_init(*args)
+      @previous_list_type = nil
     end
 
-    def builder_init(*args)
-    end
-    private :builder_init
-
     def bind(compiler, chapter, location)
       @compiler = compiler
       @chapter = chapter
@@ -53,26 +48,62 @@ module ReVIEW
       if @chapter.present?
         @book = @chapter.book
       end
+      @chapter.generate_indexes
+      if @book
+        @book.generate_indexes
+      end
       @tabwidth = nil
       @tsize = nil
       if @book && @book.config
-        if @book.config['words_file']
-          load_words(@book.config['words_file'])
+        if words_file_path = @book.config['words_file']
+          if words_file_path.is_a?(String)
+            words_files = [words_file_path]
+          else
+            words_files = words_file_path
+          end
+          words_files.each do |f|
+            load_words(f)
+          end
         end
         if @book.config['tabwidth']
           @tabwidth = @book.config['tabwidth']
         end
+
+        if @book.config['join_lines_by_lang']
+          begin
+            require 'unicode/eaw'
+          rescue LoadError
+            warn 'not found unicode/eaw. disabled join_lines_by_lang feature.'
+            @book.config['join_lines_by_lang'] = nil
+          end
+        end
       end
       builder_init_file
     end
 
     def builder_init_file
       @sec_counter = SecCounter.new(5, @chapter)
+      @doc_status = {}
     end
     private :builder_init_file
 
+    def highlight?
+      false
+    end
+
+    def solve_nest(s)
+      check_nest
+      s.gsub(/\x01→.+?←\x01/, '')
+    end
+
+    def check_nest
+      if @children && !@children.empty?
+        error "//beginchild of #{@children.reverse.join(',')} misses //endchild"
+      end
+    end
+
     def result
-      @output.string
+      solve_nest(@output.string)
     end
 
     alias_method :raw_result, :result
@@ -122,59 +153,87 @@ module ReVIEW
 
     def list(lines, id, caption, lang = nil)
       begin
-        list_header id, caption, lang
+        list_header(id, caption, lang) if caption_top?('list')
+        list_body(id, lines, lang)
+        list_header(id, caption, lang) unless caption_top?('list')
       rescue KeyError
         error "no such list: #{id}"
       end
-      list_body id, lines, lang
     end
 
     def listnum(lines, id, caption, lang = nil)
       begin
-        list_header id, caption, lang
+        list_header(id, caption, lang) if caption_top?('list')
+        listnum_body(lines, lang)
+        list_header(id, caption, lang) unless caption_top?('list')
       rescue KeyError
         error "no such list: #{id}"
       end
-      listnum_body lines, lang
     end
 
-    def source(lines, caption, lang = nil)
-      source_header caption
-      source_body lines, lang
+    def source(lines, caption = nil, lang = nil)
+      source_header(caption) if caption_top?('list')
+      source_body(lines, lang)
+      source_header(caption) unless caption_top?('list')
     end
 
     def image(lines, id, caption, metric = nil)
-      if @chapter.image(id).bound?
-        image_image id, caption, metric
+      if @chapter.image_bound?(id)
+        image_image(id, caption, metric)
       else
         warn "image not bound: #{id}" if @strict
-        image_dummy id, caption, lines
+        image_dummy(id, caption, lines)
       end
     end
 
     def table(lines, id = nil, caption = nil)
-      rows = []
+      sepidx, rows = parse_table_rows(lines)
+      begin
+        if caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+        table_begin(rows.first.size)
+        table_rows(sepidx, rows)
+        table_end
+        if !caption_top?('table') && caption.present?
+          table_header(id, caption)
+        end
+      rescue KeyError
+        error "no such table: #{id}"
+      end
+    end
+
+    def table_row_separator_regexp
+      case @book.config['table_row_separator']
+      when 'tabs'
+        Regexp.new('\t+')
+      when 'singletab'
+        Regexp.new('\t')
+      when 'spaces'
+        Regexp.new('\s+')
+      when 'verticalbar'
+        Regexp.new('\s*\\' + escape('|') + '\s*')
+      else
+        error "Unknown value for 'table_row_separator', shold be: tabs, singletab, spaces, verticalbar"
+      end
+    end
+
+    def parse_table_rows(lines)
       sepidx = nil
+      rows = []
       lines.each_with_index do |line, idx|
-        if /\A[\=\-]{12}/ =~ line
-          # just ignore
-          # error "too many table separator" if sepidx
+        if /\A[=\-]{12}/ =~ line || /\A[={\-}]{12}/ =~ line
           sepidx ||= idx
           next
         end
-        rows.push(line.strip.split(/\t+/).map { |s| s.sub(/\A\./, '') })
+        rows.push(line.strip.split(table_row_separator_regexp).map { |s| s.sub(/\A\./, '') })
       end
       rows = adjust_n_cols(rows)
+      error 'no rows in the table' if rows.empty?
+      [sepidx, rows]
+    end
 
-      begin
-        if caption.present?
-          table_header id, caption
-        end
-      rescue KeyError
-        error "no such table: #{id}"
-      end
-      return if rows.empty?
-      table_begin rows.first.size
+    def table_rows(sepidx, rows)
       if sepidx
         sepidx.times do
           tr(rows.shift.map { |s| th(s) })
@@ -188,18 +247,17 @@ module ReVIEW
           tr([th(h)] + cs.map { |s| td(s) })
         end
       end
-      table_end
     end
 
     def adjust_n_cols(rows)
       rows.each do |cols|
-        while cols.last and cols.last.strip.empty?
+        while cols.last && cols.last.strip.empty?
           cols.pop
         end
       end
       n_maxcols = rows.map(&:size).max
       rows.each do |cols|
-        cols.concat [''] * (n_maxcols - cols.size)
+        cols.concat([''] * (n_maxcols - cols.size))
       end
       rows
     end
@@ -230,7 +288,7 @@ module ReVIEW
     end
 
     def inline_chapref(id)
-      compile_inline @book.chapter_index.display_string(id)
+      compile_inline(@book.chapter_index.display_string(id))
     rescue KeyError
       error "unknown chapter: #{id}"
     end
@@ -242,7 +300,7 @@ module ReVIEW
     end
 
     def inline_title(id)
-      compile_inline @book.chapter_index.title(id)
+      compile_inline(@book.chapter_index.title(id))
     rescue KeyError
       error "unknown chapter: #{id}"
     end
@@ -341,10 +399,10 @@ module ReVIEW
     end
 
     def bibpaper(lines, id, caption)
-      bibpaper_header id, caption
+      bibpaper_header(id, caption)
       unless lines.empty?
         puts
-        bibpaper_bibpaper id, caption, lines
+        bibpaper_bibpaper(id, caption, lines)
       end
       puts
     end
@@ -404,7 +462,12 @@ module ReVIEW
     end
 
     def inline_wb(s)
-      inline_b(unescape(inline_w(s)))
+      translated = @dictionary[s]
+      if translated
+        inline_b(translated)
+      else
+        inline_b("[missing word: #{s}]")
+      end
     end
 
     def raw(str)
@@ -423,9 +486,9 @@ module ReVIEW
       if arg
         builders = arg.gsub(/^\s*\|/, '').gsub(/\|\s*$/, '').gsub(/\s/, '').split(',')
         c = target_name
-        print lines.join if builders.include?(c)
+        print lines.join("\n") + "\n" if builders.include?(c)
       else
-        print lines.join
+        print lines.join("\n") + "\n"
       end
     end
 
@@ -478,7 +541,9 @@ module ReVIEW
     def extract_chapter_id(chap_ref)
       m = /\A([\w+-]+)\|(.+)/.match(chap_ref)
       if m
-        return [@book.contents.detect { |chap| chap.id == m[1] }, m[2]]
+        ch = @book.contents.detect { |chap| chap.id == m[1] }
+        raise KeyError unless ch
+        return [ch, m[2]]
       end
       [@chapter, chap_ref]
     end
@@ -490,9 +555,36 @@ module ReVIEW
     CAPTION_TITLES.each do |name|
       class_eval %Q(
         def #{name}(lines, caption = nil)
+          check_nested_minicolumn
           captionblock("#{name}", lines, caption)
         end
-      )
+
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          if caption
+            puts compile_inline(caption)
+          end
+        end
+
+        def #{name}_end
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 17
+    end
+
+    def check_nested_minicolumn
+      if @doc_status[:minicolumn]
+        error "#{@location}: nested mini-column is not allowed"
+      end
+    end
+
+    def in_minicolumn?
+      @doc_status[:minicolumn]
+    end
+
+    def minicolumn_block_name?(name)
+      CAPTION_TITLES.include?(name)
     end
 
     def graph(lines, id, command, caption = '')
@@ -502,13 +594,13 @@ module ReVIEW
       file = "#{id}.#{image_ext}"
       file_path = File.join(dir, file)
 
-      line = self.unescape(lines.join("\n"))
+      content = lines.join("\n") + "\n"
 
       tf = Tempfile.new('review_graph')
-      tf.puts line
+      tf.puts content
       tf.close
       begin
-        file_path = send("graph_#{command}".to_sym, id, file_path, line, tf.path)
+        file_path = send("graph_#{command}".to_sym, id, file_path, content, tf.path)
       ensure
         tf.unlink
       end
@@ -556,7 +648,7 @@ EOTGNUPLOT
         file_path.sub!(/\.pdf\Z/, '.eps')
       end
       system_graph(id, 'java', '-jar', 'plantuml.jar', "-t#{ext}", '-charset', 'UTF-8', tf_path)
-      FileUtils.mv "#{tf_path}.#{ext}", file_path
+      FileUtils.mv("#{tf_path}.#{ext}", file_path)
       file_path
     end
 
@@ -565,7 +657,7 @@ EOTGNUPLOT
     end
 
     def inline_include(file_name)
-      compile_inline File.read(file_name, mode: 'rt:BOM|utf-8').chomp
+      compile_inline(File.read(file_name, mode: 'rt:BOM|utf-8').chomp)
     end
 
     def ul_item_begin(lines)
@@ -614,6 +706,10 @@ EOTGNUPLOT
       end
     end
 
+    def over_secnolevel?(n)
+      @book.config['secnolevel'] >= n.to_s.split('.').size
+    end
+
     ## override TextUtils::detab
     def detab(str, num = nil)
       if num
@@ -629,8 +725,28 @@ EOTGNUPLOT
       str
     end
 
-    def unescape(str)
-      str
+    def beginchild
+      @children ||= []
+      unless @previous_list_type
+        error "//beginchild is shown, but previous element isn't ul, ol, or dl"
+      end
+      puts "\x01→#{@previous_list_type}←\x01"
+      @children.push(@previous_list_type)
+    end
+
+    def endchild
+      if @children.nil? || @children.empty?
+        error "//endchild is shown, but any opened //beginchild doesn't exist"
+      else
+        puts "\x01→/#{@children.pop}←\x01"
+      end
+    end
+
+    def caption_top?(type)
+      unless %w[top bottom].include?(@book.config['caption_position'][type])
+        warn("invalid caption_position/#{type} parameter. 'top' is assumed")
+      end
+      @book.config['caption_position'][type] != 'bottom'
     end
   end
 end # module ReVIEW