review 4.0.0 → 5.1.1

data/lib/review/pdfmaker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2019 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2021 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -22,11 +22,14 @@ require 'review/yamlloader'
 require 'review/version'
 require 'review/makerhelper'
 require 'review/template'
+require 'review/latexbox'
+require 'review/call_hook'
 
 module ReVIEW
   class PDFMaker
     include FileUtils
     include ReVIEW::LaTeXUtils
+    include ReVIEW::CallHook
 
     attr_accessor :config, :basedir
 
@@ -100,6 +103,7 @@ module ReVIEW
     def parse_opts(args)
       cmd_config = {}
       opts = OptionParser.new
+      @buildonly = nil
 
       opts.banner = 'Usage: review-pdfmaker configfile'
       opts.version = ReVIEW::VERSION
@@ -109,6 +113,7 @@ module ReVIEW
       end
       opts.on('--[no-]debug', 'Keep temporary files.') { |debug| cmd_config['debug'] = debug }
       opts.on('--ignore-errors', 'Ignore review-compile errors.') { cmd_config['ignore-errors'] = 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.parse!(args)
       if args.size != 1
@@ -120,20 +125,13 @@ module ReVIEW
     end
 
     def execute(*args)
-      @config = ReVIEW::Configure.values
-      @config.maker = 'pdfmaker'
       cmd_config, yamlfile = parse_opts(args)
       error "#{yamlfile} not found." unless File.exist?(yamlfile)
 
-      begin
-        loader = ReVIEW::YAMLLoader.new
-        @config.deep_merge!(loader.load_file(yamlfile))
-      rescue => e
-        error "yaml error #{e.message}"
-      end
+      @config = ReVIEW::Configure.create(maker: 'pdfmaker',
+                                         yamlfile: yamlfile,
+                                         config: cmd_config)
 
-      # YAML configs will be overridden by command line options.
-      @config.deep_merge!(cmd_config)
       I18n.setup(@config['language'])
       @basedir = File.absolute_path(File.dirname(yamlfile))
 
@@ -156,6 +154,7 @@ module ReVIEW
         generate_pdf
       rescue ApplicationError => e
         raise if @config['debug']
+
         error(e.message)
       end
     end
@@ -166,8 +165,13 @@ module ReVIEW
         if part.name.present?
           @config['use_part'] = true
           if part.file?
-            output_chaps(part.name)
-            input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
+            if @buildonly && !@buildonly.include?(part.name)
+              warn "skip #{part.name}.re"
+              input_files['CHAPS'] << %Q(\\part{}\n)
+            else
+              output_chaps(part.name)
+              input_files['CHAPS'] << %Q(\\input{#{part.name}.tex}\n)
+            end
           else
             input_files['CHAPS'] << %Q(\\part{#{part.name}}\n)
           end
@@ -175,11 +179,18 @@ module ReVIEW
 
         part.chapters.each do |chap|
           filename = File.basename(chap.path, '.*')
-          output_chaps(filename)
-          input_files['PREDEF'] << "\\input{#{filename}.tex}\n" if chap.on_predef?
-          input_files['CHAPS'] << "\\input{#{filename}.tex}\n" if chap.on_chaps?
-          input_files['APPENDIX'] << "\\input{#{filename}.tex}\n" if chap.on_appendix?
-          input_files['POSTDEF'] << "\\input{#{filename}.tex}\n" if chap.on_postdef?
+          entry = "\\input{#{filename}.tex}\n"
+          if @buildonly && !@buildonly.include?(filename)
+            warn "skip #{filename}.re"
+            entry = "\\chapter{}\n"
+          else
+            output_chaps(filename)
+          end
+
+          input_files['PREDEF'] << entry if chap.on_predef?
+          input_files['CHAPS'] << entry if chap.on_chaps?
+          input_files['APPENDIX'] << entry if chap.on_appendix?
+          input_files['POSTDEF'] << entry if chap.on_postdef?
         end
       end
 
@@ -191,7 +202,7 @@ module ReVIEW
       Dir.chdir(@path) do
         File.open("./#{@mastertex}.tex", 'wb') { |f| f.write template }
 
-        call_hook('hook_beforetexcompile')
+        call_hook('hook_beforetexcompile', Dir.pwd, @basedir, base_dir: @basedir)
 
         ## do compile
         if ENV['REVIEW_SAFE_MODE'].to_i & 4 > 0
@@ -234,32 +245,32 @@ module ReVIEW
           system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
         end
 
-        call_hook('hook_beforemakeindex')
-        if @config['pdfmaker']['makeindex'] && File.exist?("#{@mastertex}.idx")
+        call_hook('hook_beforemakeindex', Dir.pwd, @basedir, base_dir: @basedir)
+        if @config['pdfmaker']['makeindex'] && File.size?("#{@mastertex}.idx")
           system_or_raise(*[makeindex_command, makeindex_options, @mastertex].flatten.compact)
+          call_hook('hook_aftermakeindex', Dir.pwd, @basedir, base_dir: @basedir)
+          system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
         end
-        call_hook('hook_aftermakeindex')
 
         system_or_raise(*[texcommand, texoptions, "#{@mastertex}.tex"].flatten.compact)
-        call_hook('hook_aftertexcompile')
+        call_hook('hook_aftertexcompile', Dir.pwd, @basedir, base_dir: @basedir)
 
         if File.exist?("#{@mastertex}.dvi") && dvicommand.present?
           system_or_raise(*[dvicommand, dvioptions, "#{@mastertex}.dvi"].flatten.compact)
-          call_hook('hook_afterdvipdf')
+          call_hook('hook_afterdvipdf', Dir.pwd, @basedir, base_dir: @basedir)
         end
       end
     end
 
     def generate_pdf
       remove_old_file
-      erb_config
       @path = build_path
       begin
         @compile_errors = nil
 
-        book = ReVIEW::Book.load(@basedir)
-        book.config = @config
+        book = ReVIEW::Book::Base.new(@basedir, config: @config)
         @converter = ReVIEW::Converter.new(book, ReVIEW::LATEXBuilder.new)
+        erb_config
 
         @input_files = make_input_files(book)
 
@@ -280,6 +291,7 @@ module ReVIEW
         build_pdf
 
         FileUtils.cp(File.join(@path, "#{@mastertex}.pdf"), pdf_filepath)
+        @logger.success("built #{File.basename(pdf_filepath)}")
       ensure
         remove_entry_secure(@path) unless @config['debug']
       end
@@ -296,23 +308,13 @@ module ReVIEW
       end
     end
 
-    # PDFMaker#copy_images should copy image files _AND_ execute extractbb (or ebb).
+    # PDFMaker#copy_images should copy image files
     #
     def copy_images(from, to)
       return unless File.exist?(from)
+
       Dir.mkdir(to)
       ReVIEW::MakerHelper.copy_images_to_dir(from, to)
-      Dir.chdir(to) do
-        images = Dir.glob('**/*').find_all { |f| File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf|ai|eps|tif)\z/i }
-        break if images.empty?
-        if @config['pdfmaker']['bbox']
-          system_with_info('extractbb', '-B', @config['pdfmaker']['bbox'], *images)
-          system_or_raise('ebb', '-B', @config['pdfmaker']['bbox'], *images) unless system('extractbb', '-B', @config['pdfmaker']['bbox'], '-m', *images)
-        else
-          system_with_info('extractbb', *images)
-          system_or_raise('ebb', *images) unless system('extractbb', '-m', *images)
-        end
-      end
     end
 
     def make_custom_page(file)
@@ -320,6 +322,7 @@ module ReVIEW
       if File.exist?(file_sty)
         return File.read(file_sty)
       end
+
       nil
     end
 
@@ -370,11 +373,11 @@ module ReVIEW
           items.each_with_index do |item, rev|
             editstr = edit == 0 ? ReVIEW::I18n.t('first_edition') : ReVIEW::I18n.t('nth_edition', (edit + 1).to_s)
             revstr = ReVIEW::I18n.t('nth_impression', (rev + 1).to_s)
-            if item =~ /\A\d+\-\d+\-\d+\Z/
+            if item =~ /\A\d+-\d+-\d+\Z/
               buf << ReVIEW::I18n.t('published_by1', [date_to_s(item), editstr + revstr])
-            elsif item =~ /\A(\d+\-\d+\-\d+)[\s　](.+)/
+            elsif item =~ /\A(\d+-\d+-\d+)[\s　](.+)/
               # custom date with string
-              item.match(/\A(\d+\-\d+\-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
+              item.match(/\A(\d+-\d+-\d+)[\s　](.+)/) { |m| buf << ReVIEW::I18n.t('published_by3', [date_to_s(m[1]), m[2]]) }
             else
               # free format
               buf << item
@@ -440,38 +443,49 @@ module ReVIEW
       end
 
       @locale_latex = {}
-      part_tuple = I18n.get('part').split(/\%[A-Za-z]{1,3}/, 2)
-      chapter_tuple = I18n.get('chapter').split(/\%[A-Za-z]{1,3}/, 2)
-      appendix_tuple = I18n.get('appendix').split(/\%[A-Za-z]{1,3}/, 2)
-      @locale_latex['prepartname'] = part_tuple[0]
-      @locale_latex['postpartname'] = part_tuple[1]
-      @locale_latex['prechaptername'] = chapter_tuple[0]
-      @locale_latex['postchaptername'] = chapter_tuple[1]
-      @locale_latex['preappendixname'] = appendix_tuple[0]
-      @locale_latex['postappendixname'] = appendix_tuple[1]
-    end
-
-    def erb_content(file)
-      @texcompiler = File.basename(@config['texcommand'], '.*')
-      erb = ReVIEW::Template.load(file, '-')
-      @logger.debug("erb processes #{File.basename(file)}") if @config['debug']
-      erb.result(binding)
+      part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
+      chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
+      appendix_tuple = I18n.get('appendix').split(/%[A-Za-z]{1,3}/, 2)
+      @locale_latex['prepartname'] = part_tuple[0].to_s
+      @locale_latex['postpartname'] = part_tuple[1].to_s
+      @locale_latex['prechaptername'] = chapter_tuple[0].to_s
+      @locale_latex['postchaptername'] = chapter_tuple[1].to_s
+      @locale_latex['preappendixname'] = appendix_tuple[0].to_s
+      @locale_latex['postappendixname'] = appendix_tuple[1].to_s
+
+      if @config['pdfmaker']['boxsetting']
+        begin
+          @boxsetting = ReVIEW::LaTeXBox.new.tcbox(@config)
+        rescue ReVIEW::ConfigError => e
+          error e
+        end
+      end
     end
 
     def latex_config
-      erb_content(File.expand_path('./latex/config.erb', ReVIEW::Template::TEMPLATE_DIR))
+      result = ReVIEW::Template.generate(path: './latex/config.erb', mode: '-', binding: binding)
+      local_config_file = File.join(@basedir, 'layouts', 'config-local.tex.erb')
+      if File.exist?(local_config_file)
+        result << "%% BEGIN: config-local.tex.erb\n"
+        result << ReVIEW::Template.generate(path: 'layouts/config-local.tex.erb', mode: '-', binding: binding, template_dir: @basedir)
+        result << "%% END: config-local.tex.erb\n"
+      end
+      result
     end
 
     def template_content
-      template = File.expand_path('./latex/layout.tex.erb', ReVIEW::Template::TEMPLATE_DIR)
+      template_dir = ReVIEW::Template::TEMPLATE_DIR
       if @config.check_version('2', exception: false)
-        template = File.expand_path('./latex-compat2/layout.tex.erb', ReVIEW::Template::TEMPLATE_DIR)
+        template_path = './latex-compat2/layout.tex.erb'
+      else
+        template_path = './latex/layout.tex.erb'
       end
       layout_file = File.join(@basedir, 'layouts', 'layout.tex.erb')
       if File.exist?(layout_file)
-        template = layout_file
+        template_dir = @basedir
+        template_path = 'layouts/layout.tex.erb'
       end
-      erb_content(template)
+      ReVIEW::Template.generate(path: template_path, mode: '-', binding: binding, template_dir: template_dir)
     end
 
     def copy_sty(dirname, copybase, extname = 'sty')
@@ -483,6 +497,7 @@ module ReVIEW
       Dir.open(dirname) do |dir|
         dir.sort.each do |fname|
           next unless File.extname(fname).downcase == '.' + extname
+
           FileUtils.mkdir_p(copybase) unless Dir.exist?(copybase)
           if extname == 'erb'
             File.open(File.join(copybase, fname.sub(/\.erb\Z/, '')), 'w') do |f|
@@ -494,15 +509,5 @@ module ReVIEW
         end
       end
     end
-
-    def call_hook(hookname)
-      return if !@config['pdfmaker'].is_a?(Hash) || @config['pdfmaker'][hookname].nil?
-      hook = File.absolute_path(@config['pdfmaker'][hookname], @basedir)
-      if ENV['REVIEW_SAFE_MODE'].to_i & 1 > 0
-        warn 'hook configuration is prohibited in safe mode. ignored.'
-      else
-        system_or_raise(hook, Dir.pwd, @basedir)
-      end
-    end
   end
 end

data/lib/review/plaintextbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2019 Kenshi Muto
+# Copyright (c) 2018-2020 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -74,7 +74,26 @@ module ReVIEW
     private :blank
 
     def result
-      @output.string
+      solve_nest(@output.string)
+    end
+
+    def solve_nest(s)
+      check_nest
+      lines = []
+      clevel = []
+      s.split("\n", -1).each do |l| # -1 means don't omit last "\n"
+        if l =~ /\A\x01→(dl|ul|ol)←\x01/
+          clevel.push($1)
+          lines.push("\x01→END←\x01")
+        elsif l =~ %r{\A\x01→/(dl|ul|ol)←\x01}
+          clevel.pop
+          lines.push("\x01→END←\x01")
+        else
+          lines.push("\t" * clevel.size + l)
+        end
+      end
+
+      lines.join("\n").gsub(/\n*\x01→END←\x01\n*/, "\n")
     end
 
     def headline(level, _label, caption)
@@ -118,7 +137,7 @@ module ReVIEW
 
     def dd(lines)
       split_paragraph(lines).each do |paragraph|
-        puts paragraph.gsub(/\n/, '')
+        puts paragraph.delete("\n")
       end
     end
 
@@ -140,13 +159,19 @@ module ReVIEW
     def list(lines, id, caption, lang = nil)
       blank
       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}"
       end
       blank
-      list_body(id, lines, lang)
-      blank
     end
 
     def list_header(id, caption, _lang)
@@ -165,8 +190,13 @@ module ReVIEW
 
     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
 
@@ -183,23 +213,34 @@ module ReVIEW
 
     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
-        list_header(id, caption, lang)
+        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
-      listnum_body(lines, lang)
-      blank
     end
 
     def listnum_body(lines, _lang)
@@ -228,8 +269,9 @@ module ReVIEW
 
     def texequation(lines, id = nil, caption = '')
       blank
-      texequation_header(id, caption)
+      texequation_header(id, caption) if caption_top?('equation')
       puts lines.join("\n")
+      texequation_header(id, caption) unless caption_top?('equation')
       blank
     end
 
@@ -251,6 +293,10 @@ module ReVIEW
     end
 
     def table_header(id, caption)
+      unless caption_top?('table')
+        blank
+      end
+
       if id.nil?
         puts compile_inline(caption)
       elsif get_chap
@@ -258,7 +304,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)
@@ -471,18 +520,22 @@ module ReVIEW
     end
 
     def note(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('note', lines, caption)
     end
 
     def memo(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('memo', lines, caption)
     end
 
     def tip(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('tip', lines, caption)
     end
 
     def info(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('info', lines, caption)
     end
 
@@ -491,10 +544,12 @@ module ReVIEW
     end
 
     def best(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('best', lines, caption)
     end
 
     def important(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('important', lines, caption)
     end
 
@@ -503,6 +558,7 @@ module ReVIEW
     end
 
     def caution(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('caution', lines, caption)
     end
 
@@ -515,6 +571,7 @@ module ReVIEW
     end
 
     def notice(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('notice', lines, caption)
     end
 
@@ -543,11 +600,30 @@ module ReVIEW
     end
 
     def warning(lines, caption = nil)
+      check_nested_minicolumn
       base_parablock('warning', lines, caption)
     end
 
     alias_method :box, :insn
 
+    CAPTION_TITLES.each do |name|
+      class_eval %Q(
+        def #{name}_begin(caption = nil)
+          check_nested_minicolumn
+          @doc_status[:minicolumn] = '#{name}'
+          blank
+          if caption.present?
+            puts compile_inline(caption)
+          end
+        end
+
+        def #{name}_end
+          blank
+          @doc_status[:minicolumn] = nil
+        end
+      ), __FILE__, __LINE__ - 14
+    end
+
     def indepimage(_lines, _id, caption = nil, _metric = nil)
       blank
       puts "図　#{compile_inline(caption)}" if caption.present?
@@ -571,10 +647,18 @@ module ReVIEW
       ''
     end
 
+    def inline_ins(str)
+      str
+    end
+
     def inline_del(_str)
       ''
     end
 
+    def inline_tcy(str)
+      str
+    end
+
     def inline_br(_str)
       "\n"
     end
@@ -583,7 +667,7 @@ module ReVIEW
       str
     end
 
-    def inline_chap(id)
+    def inline_chap(id) # rubocop:disable Lint/UselessMethodDefinition
       # "「第#{super}章　#{inline_title(id)}」"
       # "第#{super}章"
       super