review 3.1.0 → 5.0.0

data/lib/review/idgxmlmaker.rb

@@ -0,0 +1,186 @@
+# Copyright (c) 2019 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 the GNU LGPL, see the file "COPYING".
+#
+require 'optparse'
+require 'yaml'
+require 'fileutils'
+
+require 'review/converter'
+require 'review/configure'
+require 'review/book'
+require 'review/yamlloader'
+require 'review/idgxmlbuilder'
+require 'review/version'
+require 'review/makerhelper'
+
+module ReVIEW
+  class IDGXMLMaker
+    include MakerHelper
+
+    attr_accessor :config, :basedir
+
+    def initialize
+      @basedir = nil
+      @logger = ReVIEW.logger
+      @plaintext = nil
+    end
+
+    def error(msg)
+      @logger.error "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+      exit 1
+    end
+
+    def warn(msg)
+      @logger.warn "#{File.basename($PROGRAM_NAME, '.*')}: #{msg}"
+    end
+
+    def self.execute(*args)
+      self.new.execute(*args)
+    end
+
+    def parse_opts(args)
+      cmd_config = {}
+      opts = OptionParser.new
+      @table = nil
+      @filter = nil
+      @buildonly = nil
+
+      opts.banner = 'Usage: review-idgxmlmaker [options] configfile'
+      opts.version = ReVIEW::VERSION
+      opts.on('-w', '--width widthoftypepage', 'Specify the width of type page for layouting tables (mm).') { |v| @table = v }
+      opts.on('-f', '--filter filterprogrampath', 'Specify the filter path.') { |v| @filter = v }
+      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
+      end
+
+      opts.parse!(args)
+      if args.size != 1
+        puts opts.help
+        exit 0
+      end
+
+      [cmd_config, args[0]]
+    end
+
+    def build_path
+      "#{@config['bookname']}-idgxml"
+    end
+
+    def remove_old_files(path)
+      FileUtils.rm_rf(path)
+    end
+
+    def execute(*args)
+      cmd_config, yamlfile = parse_opts(args)
+      error "#{yamlfile} not found." unless File.exist?(yamlfile)
+
+      @config = ReVIEW::Configure.create(maker: 'idgxmlmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
+      I18n.setup(@config['language'])
+      begin
+        generate_idgxml_files(yamlfile)
+      rescue ApplicationError => e
+        raise if @config['debug']
+        error(e.message)
+      end
+    end
+
+    def generate_idgxml_files(yamlfile)
+      @basedir = File.dirname(yamlfile)
+      @path = build_path
+      remove_old_files(@path)
+      Dir.mkdir(@path)
+
+      @book = ReVIEW::Book::Base.new(@basedir, config: @config)
+      if @table
+        @book.config['tableopt'] = @table
+      end
+
+      build_body(@path, yamlfile)
+    end
+
+    def apply_filter(xmlfile)
+      return unless @filter
+
+      # pass filename information to filter by environment variable
+      ENV['REVIEW_FNAME'] = File.basename(xmlfile).sub(/.xml\Z/, '.re')
+      begin
+        o, e, s = Open3.capture3(@filter, stdin_data: File.read(xmlfile))
+        unless e.empty?
+          warn("filter error for #{xmlfile}: #{e}")
+        end
+        if s.success?
+          File.write(xmlfile, o) # override
+        end
+      rescue => e
+        warn("filter error for #{xmlfile}: #{e.message}")
+      end
+    end
+
+    def build_body(basetmpdir, _yamlfile)
+      base_path = Pathname.new(@basedir)
+      @converter = ReVIEW::Converter.new(@book, ReVIEW::IDGXMLBuilder.new)
+      @book.parts.each do |part|
+        if part.name.present?
+          if part.file?
+            build_chap(part, base_path, basetmpdir, true)
+          else
+            xmlfile = "part_#{part.number}.xml"
+            build_part(part, basetmpdir, xmlfile)
+          end
+        end
+
+        part.chapters.each { |chap| build_chap(chap, base_path, basetmpdir, false) }
+      end
+    end
+
+    def build_part(part, basetmpdir, xmlfile)
+      File.open(File.join(basetmpdir, xmlfile), 'w') do |f|
+        title = ReVIEW::I18n.t('part', part.number)
+        if part.name.strip.present?
+          title << ReVIEW::I18n.t('chapter_postfix')
+          title << part.name.strip
+        end
+        f.puts '<?xml version="1.0" encoding="UTF-8"?>'
+        f.print '<doc xmlns:aid="http://ns.adobe.com/AdobeInDesign/4.0/"><title aid:pstyle="h1">'
+        f.print h(title)
+        f.print '</title><?dtp level="1" section="'
+        f.print h(title)
+        f.puts '"?></doc>'
+      end
+      apply_filter(File.join(basetmpdir, xmlfile))
+    end
+
+    def build_chap(chap, base_path, basetmpdir, ispart)
+      filename = ''
+
+      if ispart.present?
+        filename = chap.path
+      else
+        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
+
+      xmlfile = "#{id}.xml"
+
+      begin
+        @converter.convert(filename, File.join(basetmpdir, xmlfile))
+        apply_filter(File.join(basetmpdir, xmlfile))
+      rescue => e
+        warn "compile error in #{filename} (#{e.class})"
+        warn e.message
+      end
+    end
+  end
+end

data/lib/review/index_builder.rb

@@ -0,0 +1,653 @@
+# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+#                         KADO Masanori
+#
+# 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 'review/book/index'
+require 'review/exception'
+require 'review/builder'
+require 'review/sec_counter'
+
+module ReVIEW
+  class IndexBuilder < Builder
+    attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+                :numberless_image_index, :image_index, :icon_index, :indepimage_index,
+                :headline_index, :column_index, :bibpaper_index
+
+    def initialize(strict = false, *args)
+      super
+    end
+
+    def check_id(id)
+      if id
+        if id =~ %r![#%\\{}\[\]~/$'"|*?&<>`\s]!
+          warn "deprecated ID: `#{$&}` in `#{id}`"
+        elsif id.start_with?('.')
+          warn "deprecated ID: `#{id}` begins from `.`"
+        end
+      end
+    end
+
+    def pre_paragraph
+      ''
+    end
+
+    def post_paragraph
+      ''
+    end
+
+    def bind(compiler, chapter, location)
+      @compiler = compiler
+      @chapter = chapter
+      @location = location
+      @output = StringIO.new
+      if @chapter.present?
+        @book = @chapter.book
+      end
+      builder_init_file
+    end
+
+    def builder_init_file
+      @sec_counter = SecCounter.new(5, @chapter)
+
+      @headline_stack = []
+
+      @list_index = ReVIEW::Book::ListIndex.new
+      @table_index = ReVIEW::Book::TableIndex.new
+      @equation_index = ReVIEW::Book::EquationIndex.new
+      @footnote_index = ReVIEW::Book::FootnoteIndex.new
+      @headline_index = ReVIEW::Book::HeadlineIndex.new(@chapter)
+      @column_index = ReVIEW::Book::ColumnIndex.new
+      @chapter_index = ReVIEW::Book::ChapterIndex.new
+      @bibpaper_index = ReVIEW::Book::BibpaperIndex.new
+
+      if @book
+        @image_index = ReVIEW::Book::ImageIndex.new(@chapter)
+        @icon_index = ReVIEW::Book::IconIndex.new(@chapter)
+        @numberless_image_index = ReVIEW::Book::NumberlessImageIndex.new(@chapter)
+        @indepimage_index = ReVIEW::Book::IndepImageIndex.new(@chapter)
+      end
+    end
+    private :builder_init_file
+
+    def result
+      nil
+    end
+
+    def target_name
+      'index'
+    end
+
+    def headline(level, label, caption)
+      check_id(label)
+      @sec_counter.inc(level)
+      return if level < 2
+
+      cursor = level - 2
+
+      if label
+        @headline_stack[cursor] = label
+      else
+        @headline_stack[cursor] = caption
+      end
+      if @headline_stack.size > cursor + 1
+        @headline_stack = @headline_stack.take(cursor + 1)
+      end
+
+      item_id = @headline_stack.join('|')
+
+      item = ReVIEW::Book::Index::Item.new(item_id, @sec_counter.number_list, caption)
+      @headline_index.add_item(item)
+    end
+
+    def nonum_begin(level, label, caption)
+      check_id(label)
+      return if level < 2
+
+      cursor = level - 2
+
+      if label
+        @headline_stack[cursor] = label
+      else
+        @headline_stack[cursor] = caption
+      end
+      if @headline_stack.size > cursor + 1
+        @headline_stack = @headline_stack.take(cursor + 1)
+      end
+
+      item_id = @headline_stack.join('|')
+
+      item = ReVIEW::Book::Index::Item.new(item_id, nil, caption)
+      @headline_index.add_item(item)
+    end
+
+    def nonum_end(_level)
+    end
+
+    def notoc_begin(level, label, caption)
+      check_id(label)
+      return if level < 2
+
+      cursor = level - 2
+
+      if label
+        @headline_stack[cursor] = label
+      else
+        @headline_stack[cursor] = caption
+      end
+      if @headline_stack.size > cursor + 1
+        @headline_stack = @headline_stack.take(cursor + 1)
+      end
+
+      item_id = @headline_stack.join('|')
+
+      item = ReVIEW::Book::Index::Item.new(item_id, nil, caption)
+      @headline_index.add_item(item)
+    end
+
+    def notoc_end(_level)
+    end
+
+    def nodisp_begin(level, label, caption)
+      check_id(label)
+      return if level < 2
+
+      cursor = level - 2
+
+      if label
+        @headline_stack[cursor] = label
+      else
+        @headline_stack[cursor] = caption
+      end
+      if @headline_stack.size > cursor + 1
+        @headline_stack = @headline_stack.take(cursor + 1)
+      end
+
+      item_id = @headline_stack.join('|')
+
+      item = ReVIEW::Book::Index::Item.new(item_id, nil, caption)
+      @headline_index.add_item(item)
+    end
+
+    def nodisp_end(_level)
+    end
+
+    def column_begin(_level, label, caption)
+      check_id(label)
+      item_id = label || caption
+      item = ReVIEW::Book::Index::Item.new(item_id, @column_index.size + 1, caption)
+      @column_index.add_item(item)
+    end
+
+    def column_end(_level)
+    end
+
+    def xcolumn_begin(_level, label, _caption)
+      check_id(label)
+    end
+
+    def xcolumn_end(_level)
+    end
+
+    def sup_begin(_level, label, _caption)
+      check_id(label)
+    end
+
+    def sup_end(_level)
+    end
+
+    def ul_begin
+    end
+
+    def ul_item_begin(lines)
+    end
+
+    def ul_item_end
+    end
+
+    def ul_end
+    end
+
+    def ol_begin
+    end
+
+    def ol_item(lines, _num)
+    end
+
+    def ol_end
+    end
+
+    def dl_begin
+    end
+
+    def dt(line)
+    end
+
+    def dd(lines)
+    end
+
+    def dl_end
+    end
+
+    def paragraph(lines)
+    end
+
+    def parasep
+      ''
+    end
+
+    def nofunc_text(_str)
+      ''
+    end
+
+    def read(_lines)
+    end
+
+    alias_method :lead, :read
+
+    def list(_lines, id, _caption, _lang = nil)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @list_index.size + 1)
+      @list_index.add_item(item)
+    end
+
+    def source(_lines, _caption = nil, _lang = nil)
+    end
+
+    def listnum(_lines, id, _caption, _lang = nil)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @list_index.size + 1)
+      @list_index.add_item(item)
+    end
+
+    def emlist(lines, caption = nil, lang = nil)
+    end
+
+    def emlistnum(lines, caption = nil, lang = nil)
+    end
+
+    def cmd(lines, caption = nil)
+    end
+
+    def quote(lines)
+    end
+
+    def image(_lines, id, caption, _metric = nil)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @image_index.size + 1, caption)
+      @image_index.add_item(item)
+    end
+
+    def table(_lines, id = nil, caption = nil)
+      check_id(id)
+      if id
+        item = ReVIEW::Book::Index::Item.new(id, @table_index.size + 1, caption)
+        @table_index.add_item(item)
+      end
+    end
+
+    def emtable(_lines, _caption = nil)
+      # item = ReVIEW::Book::TableIndex::Item.new(id, @table_index.size + 1)
+      # @table_index << item
+    end
+
+    def comment(lines, comment = nil)
+    end
+
+    def imgtable(_lines, id, _caption = nil, _metric = nil)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @table_index.size + 1)
+      @table_index.add_item(item)
+
+      ## to find image path
+      item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
+      @indepimage_index.add_item(item)
+    end
+
+    def footnote(id, str)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @footnote_index.size + 1, str)
+      @footnote_index.add_item(item)
+    end
+
+    def indepimage(_lines, id, _caption = '', _metric = nil)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
+      @indepimage_index.add_item(item)
+    end
+
+    def numberlessimage(_lines, id, _caption = '', _metric = nil)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
+      @indepimage_index.add_item(item)
+    end
+
+    def hr
+    end
+
+    def label(id)
+      check_id(id)
+    end
+
+    def blankline
+    end
+
+    def flushright(_lines)
+    end
+
+    def centering(lines)
+    end
+
+    def olnum(_num)
+    end
+
+    def pagebreak
+    end
+
+    def bpo(_lines)
+    end
+
+    def noindent
+    end
+
+    def compile_inline(s)
+      @compiler.text(s)
+    end
+
+    def inline_chapref(_id)
+      ''
+    end
+
+    def inline_chap(_id)
+      ''
+    end
+
+    def inline_title(_id)
+      ''
+    end
+
+    def inline_list(_id)
+      ''
+    end
+
+    def inline_img(_id)
+      ''
+    end
+
+    def inline_imgref(_id)
+      ''
+    end
+
+    def inline_table(_id)
+      ''
+    end
+
+    def inline_eq(_id)
+      ''
+    end
+
+    def inline_fn(_id)
+      ''
+    end
+
+    def inline_i(_str)
+      ''
+    end
+
+    def inline_b(_str)
+      ''
+    end
+
+    def inline_ami(_str)
+      ''
+    end
+
+    def inline_bou(str)
+      str
+    end
+
+    def inline_tti(_str)
+      ''
+    end
+
+    def inline_ttb(_str)
+      ''
+    end
+
+    def inline_dtp(_str)
+      ''
+    end
+
+    def inline_code(_str)
+      ''
+    end
+
+    def inline_idx(_str)
+      ''
+    end
+
+    def inline_hidx(_str)
+      ''
+    end
+
+    def inline_br(_str)
+      ''
+    end
+
+    def inline_m(_str)
+      ''
+    end
+
+    def firstlinenum(_num)
+      ''
+    end
+
+    def inline_ruby(_arg)
+      ''
+    end
+
+    def inline_kw(_arg)
+      ''
+    end
+
+    def inline_href(_arg)
+      ''
+    end
+
+    def inline_hr(_arg)
+      ''
+    end
+
+    def text(_str)
+      ''
+    end
+
+    def bibpaper(_lines, id, caption)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @bibpaper_index.size + 1, caption)
+      @bibpaper_index.add_item(item)
+    end
+
+    def inline_hd(_id)
+      ''
+    end
+
+    def inline_bib(_id)
+      ''
+    end
+
+    def inline_column(_id)
+      ''
+    end
+
+    def inline_column_chap(_chapter, _id)
+      ''
+    end
+
+    def inline_pageref(_id)
+      ''
+    end
+
+    def inline_tcy(_arg)
+      ''
+    end
+
+    def inline_balloon(_arg)
+      ''
+    end
+
+    def inline_w(_s)
+      ''
+    end
+
+    def inline_wb(_s)
+      ''
+    end
+
+    def inline_abbr(_str)
+      ''
+    end
+
+    def inline_acronym(_str)
+      ''
+    end
+
+    def inline_cite(_str)
+      ''
+    end
+
+    def inline_dfn(_str)
+      ''
+    end
+
+    def inline_em(_str)
+      ''
+    end
+
+    def inline_kbd(_str)
+      ''
+    end
+
+    def inline_samp(_str)
+      ''
+    end
+
+    def inline_strong(_str)
+      ''
+    end
+
+    def inline_var(_str)
+      ''
+    end
+
+    def inline_big(_str)
+      ''
+    end
+
+    def inline_small(_str)
+      ''
+    end
+
+    def inline_sub(_str)
+      ''
+    end
+
+    def inline_sup(_str)
+      ''
+    end
+
+    def inline_tt(_str)
+      ''
+    end
+
+    def inline_del(_str)
+      ''
+    end
+
+    def inline_ins(_str)
+      ''
+    end
+
+    def inline_u(_str)
+      ''
+    end
+
+    def inline_recipe(_str)
+      ''
+    end
+
+    def inline_icon(id)
+      check_id(id)
+      item = ReVIEW::Book::Index::Item.new(id, @icon_index.size + 1)
+      @icon_index.add_item(item)
+      ''
+    end
+
+    def inline_uchar(_str)
+      ''
+    end
+
+    def raw(_str)
+      ''
+    end
+
+    def embed(_lines, _arg = nil)
+      ''
+    end
+
+    def warn(msg)
+      @logger.warn "#{@location}: #{msg}"
+    end
+
+    def error(msg = '(no message)')
+      if msg =~ /builder does not support command/
+        # ignore
+        return
+      end
+      super
+    end
+
+    def texequation(_lines, id = nil, _caption = '')
+      check_id(id)
+      if id
+        item = ReVIEW::Book::Index::Item.new(id, @equation_index.size + 1)
+        @equation_index.add_item(item)
+      end
+    end
+
+    def get_chap(_chapter = nil)
+      ''
+    end
+
+    def extract_chapter_id(_chap_ref)
+      ''
+    end
+
+    def captionblock(_type, _lines, _caption, _specialstyle = nil)
+      ''
+    end
+
+    def tsize(_str)
+      ''
+    end
+
+    def inline_raw(_args)
+      ''
+    end
+
+    def inline_embed(_args)
+      ''
+    end
+
+    def highlight?
+      false
+    end
+
+    def unknown_command(*_args)
+      # ignore
+    end
+  end
+end # module ReVIEW