review 1.4.0 → 1.5.0

data/lib/review/layout.tex.erb

@@ -6,6 +6,10 @@
 \usepackage{wrapfig}
 \definecolor{shadecolor}{gray}{0.9}
 \definecolor{shadecolorb}{gray}{0.1}
+\definecolor{reviewgreen}{rgb}{0,0.4,0}
+\definecolor{reviewblue}{rgb}{0.2,0.2,0.4}
+\definecolor{reviewred}{rgb}{0.7,0,0}
+\definecolor{reviewdarkred}{rgb}{0.3,0,0}
 \usepackage[utf8]{inputenc}
 \usepackage{ascmac}
 \usepackage{float}
@@ -42,6 +46,43 @@
             pdftitle={<%= values["booktitle"] %>},%
             pdfauthor={<%= values["aut"] %>}]{hyperref}
 
+<% if config["highlight"] && config["highlight"]["latex"] == "listings" %>
+<%   if config["language"] == "ja" %>
+\usepackage{listings,jlisting}
+<%   else %>
+\usepackage{listings}
+<%   end %>
+\renewcommand{\lstlistingname}{<%I18n.t("list")%>}
+\lstset{%
+  breaklines=true,%
+  breakautoindent=false,%
+  breakindent=0pt,%
+  fontadjust=true,%
+  backgroundcolor=\color{shadecolor},%
+  frame=single,%
+  framerule=0pt,%
+  basicstyle=\ttfamily\scriptsize,%
+  commentstyle=\color{reviewgreen},%
+  identifierstyle=\color{reviewblue},%
+  stringstyle=\color{reviewred},%
+  keywordstyle=\bfseries\color{reviewdarkred},%
+}
+\lstnewenvironment{reviewemlistlst}[1][]{%
+  \lstset{#1}}{}
+
+\lstnewenvironment{reviewemlistnumlst}[1][]{%
+  \lstset{numbers=left, #1}}{}
+
+\lstnewenvironment{reviewlistlst}[1][]{%
+  \lstset{#1}}{}
+
+\lstnewenvironment{reviewlistnumlst}[1][]{%
+  \lstset{numbers=left, #1}}{}
+
+\lstnewenvironment{reviewcmdlst}[1][]{%
+  \lstset{backgroundcolor=\color{white}, frameround=tttt, frame=trbl, #1}}{}
+<% end %>
+
 \newenvironment{reviewimage}{%
   \begin{figure}[H]
     \begin{center}}{%
@@ -83,7 +124,7 @@
   \vspace{2zw}}
 
 \newcommand{\reviewcolumnhead}[2]{%
-{\noindent\large ■コラム: #2}}
+{\noindent\large <%= I18n.t("column_head")%>: #2}}
 
 \newcommand{\reviewtablecaption}[1]{%
   \caption{#1}}
@@ -107,20 +148,24 @@
   \medskip{\small\noindent #1}\vspace*{-1.3zw}}
 
 \newcommand{\reviewimageref}[2]{%
-  図 #1}
+  <%= I18n.t("image")%> #1}
 \newcommand{\reviewtableref}[2]{%
-  表 #1}
+  <%= I18n.t("table")%> #1}
 \newcommand{\reviewlistref}[1]{%
-  リスト #1}
+  <%= I18n.t("list")%> #1}
 \newcommand{\reviewbibref}[2]{%
   #1}
 \newcommand{\reviewcolumnref}[2]{%
-  コラム #1}
+  <%= I18n.t("columnname")%> #1}
 \newcommand{\reviewsecref}[2]{%
   #1}
 
 \newcommand{\reviewminicolumntitle}[1]{%
-  {\large ■メモ：#1}\\}
+  {\large <%= I18n.t("memo_head")%>: #1}\\}
+
+<% if values["toctitle"].present? %>
+\renewcommand{\contentsname}{<%= values["toctitle"]%>}
+<% end %>
 
 \newenvironment{reviewminicolumn}{%
   \vspace{1.5zw}\begin{screen}}{%
@@ -162,6 +207,8 @@
   \appendix}
 
 \makeatletter
+%% maxwidth is the original width if it is less than linewidth
+%% otherwise use linewidth (to make sure the graphics do not exceed the margin)
 \def\maxwidth{%
   \ifdim\Gin@nat@width>\linewidth
     \linewidth
@@ -203,7 +250,7 @@
         <%= authors %>
       \end{tabular}\par}%
     \vfill
-    {\large <%= values["date"] %> 版\hspace{2zw}<%= values["prt"] %>　発行\par}%
+    {\large <%= values["date"] %> <%= I18n.t("version")%>\hspace{2zw}<%= I18n.t("published_by", values["prt"])%>\par}%
 \vskip4zw\mbox{}
   \end{center}%
 \end{titlepage}

data/lib/review/markdownbuilder.rb

@@ -49,6 +49,23 @@ module ReVIEW
       puts "\n"
     end
 
+    def list_header(id, caption, lang)
+      if get_chap.nil?
+        puts %Q[リスト#{@chapter.list(id).number} #{compile_inline(caption)}]
+      else
+        puts %Q[リスト#{get_chap}.#{@chapter.list(id).number} #{compile_inline(caption)}]
+      end
+      lang ||= ""
+      puts "```#{lang}"
+    end
+
+    def list_body(id, lines, lang)
+      lines.each do |line|
+        puts detab(line)
+      end
+      puts '```'
+    end
+
     def ul_begin
       blank if @ul_indent == 0
       @ul_indent += 1
@@ -82,12 +99,13 @@ module ReVIEW
       blank
     end
 
-    def emlist(lines, caption = nil)
+    def emlist(lines, caption = nil, lang = nil)
       blank
       if caption
         puts caption
       end
-      puts "```"
+      lang ||= ""
+      puts "```#{lang}"
       lines.each do |line|
         puts detab(line)
       end
@@ -161,7 +179,7 @@ module ReVIEW
     end
 
     def cmd(lines)
-      puts "```"
+      puts "```shell-session"
       lines.each do |line|
         puts detab(line)
       end

data/lib/review/pdfmaker.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# Copyright (c) 2010-2014 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2015 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -22,6 +22,10 @@ module ReVIEW
     include FileUtils
     include ReVIEW::LaTeXUtils
 
+    def system_or_raise(*args)
+      Kernel.system(*args) or raise("failed to run command: #{args.join(' ')}")
+    end
+
     def error(msg)
       $stderr.puts "#{File.basename($0, '.*')}: error: #{msg}"
       exit 1
@@ -33,9 +37,7 @@ module ReVIEW
 
     def check_book(config)
       pdf_file = config["bookname"]+".pdf"
-      if File.exist? pdf_file
-        error "file already exists:#{pdf_file}"
-      end
+      File.unlink(pdf_file) if File.exist?(pdf_file)
     end
 
     def build_path(config)
@@ -89,10 +91,11 @@ module ReVIEW
       config.merge!(YAML.load_file(yamlfile))
       # YAML configs will be overridden by command line options.
       config.merge!(cmd_config)
-      generate_pdf(config)
+      I18n.setup(config["language"])
+      generate_pdf(config, yamlfile)
     end
 
-    def generate_pdf(config)
+    def generate_pdf(config, yamlfile)
       check_book(config)
       @basedir = Dir.pwd
       @path = build_path(config)
@@ -102,10 +105,12 @@ module ReVIEW
       @chaps_fnames = Hash.new{|h, key| h[key] = ""}
       @compile_errors = nil
 
-      ReVIEW::Book.load(@basedir).parts.each do |part|
+      book = ReVIEW::Book.load(@basedir)
+      book.config = config
+      book.parts.each do |part|
         if part.name.present?
           if part.file?
-            output_parts(part.name, config)
+            output_chaps(part.name, config, yamlfile)
             @chaps_fnames["CHAPS"] << %Q|\\input{#{part.name}.tex}\n|
           else
             @chaps_fnames["CHAPS"] << %Q|\\part{#{part.name}}\n|
@@ -113,12 +118,12 @@ module ReVIEW
         end
 
         part.chapters.each do |chap|
-          filename = "#{File.basename(chap.path, ".*")}.tex"
-          output_chaps(filename, config)
-          @chaps_fnames["PREDEF"]  << "\\input{#{filename}}\n" if chap.on_PREDEF?
-          @chaps_fnames["CHAPS"]   << "\\input{#{filename}}\n" if chap.on_CHAPS?
-          @chaps_fnames["APPENDIX"] << "\\input{#{filename}}\n" if chap.on_APPENDIX?
-          @chaps_fnames["POSTDEF"] << "\\input{#{filename}}\n" if chap.on_POSTDEF?
+          filename = File.basename(chap.path, ".*")
+          output_chaps(filename, config, yamlfile)
+          @chaps_fnames["PREDEF"]  << "\\input{#{filename}.tex}\n" if chap.on_PREDEF?
+          @chaps_fnames["CHAPS"]   << "\\input{#{filename}.tex}\n" if chap.on_CHAPS?
+          @chaps_fnames["APPENDIX"] << "\\input{#{filename}.tex}\n" if chap.on_APPENDIX?
+          @chaps_fnames["POSTDEF"] << "\\input{#{filename}.tex}\n" if chap.on_POSTDEF?
         end
       end
 
@@ -136,26 +141,47 @@ module ReVIEW
 
       copy_images("./images", "#{@path}/images")
       copyStyToDir(Dir.pwd + "/sty", @path)
+      copyStyToDir(Dir.pwd + "/sty", @path, "fd")
+      copyStyToDir(Dir.pwd + "/sty", @path, "cls")
       copyStyToDir(Dir.pwd, @path, "tex")
 
       Dir.chdir(@path) {
         template = get_template(config)
         File.open("./book.tex", "wb"){|f| f.write(template)}
 
+        call_hook("hook_beforetexcompile", config)
+
         ## do compile
         enc = config["params"].to_s.split(/\s+/).find{|i| i =~ /\A--outencoding=/ }
         kanji = 'utf8'
-        if enc
-          kanji = enc.split(/\=/).last.gsub(/-/, '').downcase
+        texcommand = "platex"
+        texoptions = "-kanji=#{kanji}"
+        dvicommand = "dvipdfmx"
+        dvioptions = "-d 5"
+
+        if ENV["REVIEW_SAFE_MODE"].to_i & 4 > 0
+          warn "command configuration is prohibited in safe mode. ignored."
+        else
+          texcommand = config["texcommand"] if config["texcommand"]
+          dvicommand = config["dvicommand"] if config["dvicommand"]
+          dvioptions = config["dvioptions"] if config["dvioptions"]
+          if enc
+            kanji = enc.split(/\=/).last.gsub(/-/, '').downcase
+            texoptions = "-kanji=#{kanji}"
+          end
+          texoptions = config["texoptions"] if config["texoptions"]
         end
-        texcommand = config["texcommand"] || "platex"
         3.times do
-          system("#{texcommand} -kanji=#{kanji} book.tex")
+          system_or_raise("#{texcommand} #{texoptions} book.tex")
         end
-        if File.exist?("book.dvi")
-          system("dvipdfmx -d 5 book.dvi")
+        call_hook("hook_aftertexcompile", config)
+
+      if File.exist?("book.dvi")
+          system_or_raise("#{dvicommand} #{dvioptions} book.dvi")
         end
       }
+      call_hook("hook_afterdvipdf", config)
+      
       FileUtils.cp("#{@path}/book.pdf", "#{@basedir}/#{bookname}.pdf")
 
       unless config["debug"]
@@ -163,20 +189,9 @@ module ReVIEW
       end
     end
 
-    def output_chaps(filename, config)
-      $stderr.puts "compiling #{filename}"
-      cmd = "#{ReVIEW::MakerHelper.bindir}/review-compile --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename} > #{@path}/#{filename}"
-      if system cmd
-        # OK
-      else
-        @compile_errors = true
-        warn cmd
-      end
-    end
-
-    def output_parts(filename, config)
+    def output_chaps(filename, config, yamlfile)
       $stderr.puts "compiling #{filename}.tex"
-      cmd = "review-compile --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename}.re | sed -e s/\\chapter{/\\part{/ > #{@path}/#{filename}.tex"
+      cmd = "#{ReVIEW::MakerHelper.bindir}/review-compile --yaml=#{yamlfile} --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename}.re > #{@path}/#{filename}.tex"
       if system cmd
         # OK
       else
@@ -185,7 +200,6 @@ module ReVIEW
       end
     end
 
-
     def copy_images(from, to)
       if File.exist?(from)
         Dir.mkdir(to)
@@ -194,9 +208,10 @@ module ReVIEW
           images = Dir.glob("**/*").find_all{|f|
             File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf)\z/
           }
+          break if images.empty?
           system("extractbb", *images)
           unless system("extractbb", "-m", *images)
-            system("ebb", *images)
+            system_or_raise("ebb", *images)
           end
         end
       end
@@ -238,13 +253,16 @@ module ReVIEW
     def make_authors(config)
       authors = ""
       if config["aut"].present?
-        authors = join_with_separator(config["aut"], ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("author_postfix")
+        author_names = join_with_separator(config["aut"], ReVIEW::I18n.t("names_splitter"))
+        authors = ReVIEW::I18n.t("author_with_label", author_names)
       end
       if config["csl"].present?
-        authors += " \\\\\n"+join_with_separator(config["csl"], ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("supervisor_postfix")
+        csl_names = join_with_separator(config["csl"], ReVIEW::I18n.t("names_splitter"))
+        authors += " \\\\\n"+ ReVIEW::I18n.t("supervisor_with_label", csl_names)
       end
       if config["trl"].present?
-        authors += " \\\\\n"+join_with_separator(config["trl"], ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("translator_postfix")
+        trl_names = join_with_separator(config["trl"], ReVIEW::I18n.t("names_splitter"))
+        authors += " \\\\\n"+ ReVIEW::I18n.t("translator_with_label", trl_names)
       end
       authors
     end
@@ -286,6 +304,17 @@ module ReVIEW
         }
       }
     end
+
+    def call_hook(hookname, config)
+      if config["pdfmaker"].instance_of?(Hash) && config["pdfmaker"][hookname]
+        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
 end
 

data/lib/review/sec_counter.rb

@@ -35,7 +35,7 @@ module ReVIEW
     end
 
     def anchor(level)
-      str = "#{@chapter.number}"
+      str = "#{@chapter.format_number(false)}"
       0.upto(level-2) do |i|
         str << "-#{@counter[i]}"
       end

data/lib/review/tocparser.rb

@@ -13,7 +13,6 @@
 require 'review/preprocessor'
 require 'review/book'
 require 'review/textbuilder'
-require 'forwardable'
 
 module ReVIEW
 
@@ -44,7 +43,7 @@ module ReVIEW
           error! filename, f.lineno, "section level too deep: #{lev}" if lev > 5
           if path.empty?
             # missing chapter label
-            path.push Chapter.new(get_label(line), id, filename)
+            path.push Chapter.new(get_label(line), id, filename, chap.book.page_metric)
             roots.push path.first
           end
           next if get_label(line) =~ /\A\[\// # ex) "[/column]"
@@ -57,7 +56,7 @@ module ReVIEW
 
         when /\A= /
           path.clear
-          path.push Chapter.new(get_label(line), id, filename)
+          path.push Chapter.new(get_label(line), id, filename, chap.book.page_metric)
           roots.push path.first
 
         when %r<\A//\w+(?:\[.*?\])*\{\s*\z>
@@ -99,7 +98,10 @@ module ReVIEW
 
     def compile_label(line)
       b = ReVIEW::TEXTBuilder.new
-      b.bind(ReVIEW::Compiler.new(b), nil, nil)
+      dummy_book = ReVIEW::Book::Base.load
+      dummy_chapter = ReVIEW::Book::Chapter.new(dummy_book, 1, '-', nil, StringIO.new)
+      dummy_loc = Location.new("", StringIO.new)
+      b.bind(ReVIEW::Compiler.new(b), dummy_chapter, dummy_loc)
       b.compile_inline(line)
     end
 
@@ -206,10 +208,11 @@ module ReVIEW
 
     class Chapter < Section
 
-      def initialize(label, id, path)
+      def initialize(label, id, path, page_metric)
         super 1, label, path
         @chapter_id = id
         @path = path
+        @page_metric = page_metric
         @volume = nil
         @number = nil
       end
@@ -226,6 +229,7 @@ module ReVIEW
         return @volume if @volume
         return Book::Volume.dummy unless @path
         @volume = Book::Volume.count_file(@path)
+        @volume.page_per_kbyte = @page_metric.page_per_kbyte
         @volume.lines = estimated_lines()
         @volume
       end

data/lib/review/topbuilder.rb

@@ -242,7 +242,7 @@ module ReVIEW
 
     end
 
-    def list_header(id, caption)
+    def list_header(id, caption, lang)
       blank
       puts "◆→開始:#{@titles["list"]}←◆"
       if get_chap.nil?
@@ -253,7 +253,7 @@ module ReVIEW
       blank
     end
 
-    def list_body(id, lines)
+    def list_body(id, lines, lang)
       lines.each do |line|
         puts detab(line)
       end
@@ -279,11 +279,11 @@ module ReVIEW
       blank
     end
 
-    def emlist(lines, caption = nil)
+    def emlist(lines, caption = nil, lang = nil)
       base_block "emlist", lines, caption
     end
 
-    def emlistnum(lines, caption = nil)
+    def emlistnum(lines, caption = nil, lang = nil)
       blank
       puts "◆→開始:#{@titles["emlist"]}←◆"
       puts "■#{compile_inline(caption)}" unless caption.nil?
@@ -295,7 +295,7 @@ module ReVIEW
       blank
     end
 
-    def listnum_body(lines)
+    def listnum_body(lines, lang)
       lines.each_with_index do |line, i|
         puts (i + 1).to_s.rjust(2) + ": #{line}"
       end
@@ -750,7 +750,7 @@ module ReVIEW
         end
       else
       end
-      "#{chs[0]}#{@chapter.env.chapter_index.number(id)}#{chs[1]}#{@chapter.env.chapter_index.title(id)}#{chs[2]}"
+      "#{chs[0]}#{@book.chapter_index.number(id)}#{chs[1]}#{@book.chapter_index.title(id)}#{chs[2]}"
     rescue KeyError
       error "unknown chapter: #{id}"
       nofunc_text("[UnknownChapter:#{id}]")