rake4latex 0.0.1 → 0.1.0

data/lib/rake4latex/clean.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+# The 'rake/clean' file defines two file lists (CLEAN and CLOBBER) and
+# two rake tasks (:clean and :clobber).
+#
+# [:clean] Clean up the project by deleting scratch files and backup
+#          files.  Add files to the CLEAN file list to have the :clean
+#          target handle them.
+#
+# [:clobber] Clobber all generated and non-source files in a project.
+#            The task depends on :clean, so all the clean files will
+#            be deleted as well as files in the CLOBBER file list.
+#            The intent of this task is to return a project to its
+#            pristine, just unpacked state.
+#
+# This replaces the original clean.
+#
+# Changes:
+# * Use File.delete (avoid stderr-messages of rm_r)
+# * Use LaTeXRunner.logger if available.
+# * Add task :basefile as prerequisite.
+
+require 'rake'
+
+CLEAN = Rake::FileList["**/*~", "**/*.bak", "**/core"]
+CLEAN.clear_exclude.exclude { |fn| 
+  fn.pathmap("%f") == 'core' && File.directory?(fn) 
+}
+
+desc "Remove any temporary products."
+#~ task :clean do
+task :clean => :basefile do
+  logger = Rake4LaTeX::Logger
+  logger.info("Clean: delete helpfiles #{CLEAN.inspect}") if logger.info?
+  CLEAN.each { |fn| 
+    #~ rm_r fn rescue nil 
+    #~ logger.debug("Clean: delete #{fn}") if logger
+    File.delete(fn) rescue ( logger.warn("Clean: #{fn} not deleted") if logger )
+  }
+end
+
+CLOBBER = Rake::FileList.new
+
+desc "Remove any generated file."
+task :clobber => :clean do
+  logger = Rake4LaTeX::Logger
+  logger.info("Clobber: delete helpfiles #{(CLEAN + CLOBBER).inspect}") if logger.info?
+  CLOBBER.each { |fn| 
+    #~ rm_r fn rescue nil 
+    #~ logger.debug("Clobber: delete #{fn}") if logger
+    File.delete(fn) rescue ( logger.warn("Clobber: #{fn} not deleted") if logger )
+  }
+end

data/lib/rake4latex/latexdependencies.rb

@@ -1,3 +1,4 @@
+module Rake4LaTeX
 #
 #Class to determine dependecies of a LaTeX project.
 #
@@ -101,3 +102,4 @@ There is no check on the file found by kpsewhich ##fixme##
     deps
   end #self.find_included_files
 end #LaTeXDependencies
+end #Rake4LaTeX

data/lib/rake4latex/latexrunner.rb

@@ -1,3 +1,6 @@
+
+
+module Rake4LaTeX
 =begin rdoc
 Class which encapsulates all the information needed to call latex 
 as often as needed. 
@@ -17,7 +20,6 @@ class LaTeXRunner
     :maxruns => 5,
     :program => :pdflatex,  #Valid entries see PROGRAMS
     :loglevel => Log4r::INFO,
-    :options => ['-interaction=batchmode'],
     :texerrors_allowed => false,
   }
 =begin rdoc
@@ -63,9 +65,10 @@ The settings contain the following values:
   def initialize( settings )
     
     #~ raise ArgumentError, "Task is no RakeTask but #{t.class}" unless task.is_a?(Rake::Task)
-    
-    @logger = Log4r::Logger.new("LaTeXRunner #{settings[:main_file]}")
-    @logger.outputters = Log4r::StdoutOutputter.new('log_stdout')
+
+    @logger = Rake4LaTeX::Logger
+    #~ @logger = Log4r::Logger.new("LaTeXRunner #{settings[:main_file]}")
+    #~ @logger.outputters = Log4r::StdoutOutputter.new('log_stdout')
     
     DEFAULT_SETTINGS.merge(settings).each{|key, value|
       #~ puts "#{key}: #{value}"
@@ -81,17 +84,16 @@ The settings contain the following values:
         raise ArgumentError, "Undefined key #{key} for LaTeXRunner"
       end
     }
-
     raise MainfileError, "main_file missing" unless @main_file
     raise MainfileError, "main_file #{@main_file} not found" unless File.exist?(@main_file)
     raise ArgumentError, "Maxrun is no number" unless @maxruns.is_a?( Fixnum ) or @maxruns == Infinity
 
-    Rake.application.latexrunner = self
     @basename = File.basename(@main_file)
     @input_dir = File.dirname(@main_file)
     @full_input_dir = File.expand_path(@input_dir)
 
-    @logger.name.replace("LaTeXRunner #{@basename}")
+    #This replacement is global in Rake4LaTeX::Logger -> May be a problem with multiple documents, parallel tasks...
+    @logger.name.replace("LaTeXRunner #{@basename}") #no, only one global Logger.
     @logger.info( "StartLaTeXRunner for #{@main_file}")
 
     @rerun_necessary = true #initialize
@@ -146,10 +148,8 @@ The settings contain the following values:
   It determines the latex command line and calls <tt>run_latex_as_needed</tt>.
 =end
   def execute()
-    
-    cmd = "#{@program} #{@options.join ' '} " + 
-        #~ "-output-directory=#@full_output_dir 
-        " #{@basename}"
+
+    cmd = Rake4LaTeX.build_cmd( @program, :filename => @basename )
     Dir.chdir(@input_dir) do
       @texruns = 0
       while rerun_necessary?
@@ -159,7 +159,7 @@ The settings contain the following values:
       end
     end
     #Guarentee that help files are deleted fin clean.
-    set4clean( @basename )
+    Rake4LaTeX.set4clean( @basename )
     
     plural_s = "#{@texruns} run#{@texruns>1 ? 's': ''}"
     if @rerun_necessary
@@ -191,7 +191,8 @@ The settings contain the following values:
       raise RuntimeError, "There where #@program errors. "\
           "See #{@main_file.ext('.log')} for details"  unless @texerrors_allowed
     end
-        
+    
+    helpfiles = %w{aux toc lof lot}
     #Build the checksums.
     FileList["#{@basename.ext('*')}"].each do |file|
       # Compare old and new MD5 digest for the given file.
@@ -201,16 +202,30 @@ The settings contain the following values:
             @logger.debug("new file #{file}")
             checksums[file] = :changed
           when File.open(file){|f| MD5.new(f.read).hexdigest}
-            @logger.debug("Unchanged file #{file}")
+            #no message needed
+            #~ @logger.debug("Unchanged file #{file}")
           else
             @logger.debug("  Changed file #{file}" )
             checksums[file] = :changed
           end
         }
+      #Special rules for additional files
+      case file
+        #Build by gloss.sty
+        when /#{@basename.ext()}\.(.+)\.aux/
+          gloss_name = $1
+          helpfiles << "#{$1}.aux"
+          @logger.debug("Detected additional aux-file <#{file}>" )
+          if ! Post_Prerequisites_check["#{gloss_name}.bbl"] 
+            @logger.info("Define additional rule <#{gloss_name}.bbl> (gloss.sty)" )
+            Post_Prerequisites_check[".#{gloss_name}.bbl"] = Post_Prerequisites_check[".bbl"] 
+            tex_postrule ".#{gloss_name}.bbl" => ".#{gloss_name}.aux"
+          end
+      end
     end
  
     #check changes in some files.
-    %w{aux toc lof lot}.each{|ext|
+     helpfiles.each{|ext|
       next unless checksums[@basename.ext(ext)] == :changed
       @rerun_necessary = true
       @logger.info("Rerun necessary (#{ext}-file changed)" ) if @rerun_necessary
@@ -266,3 +281,4 @@ The settings contain the following values:
   end
 
 end #LaTeXRunner
+end #Rake4LaTeX

data/lib/rake4latex/rake4latex.yaml

@@ -0,0 +1,76 @@
+bibtex: 
+  cmd: bibtex
+  parameters: 
+  - value_key: :source
+dvipdfm: 
+  cmd: dvipdfm
+  parameters: 
+  - value_key: :filename
+dvips: 
+  cmd: dvips
+  parameters: 
+  - value_key: :filename
+latex: 
+  cmd: latex
+  parameters: 
+  - value: -interaction=batchmode
+  - name: -output-directory=
+    value_key: :output_dir
+    optional: true
+  - value_key: :filename
+makeindex: 
+  cmd: makeindex
+  parameters: 
+  - name: -s
+    value_key: :format
+    optional: true
+  - name: -o
+    value_key: :file_out
+    optional: true
+  - name: -t
+    value_key: :file_log
+    optional: true
+  - value_key: :file_in
+pdflatex: 
+  cmd: pdflatex
+  parameters: 
+  parameters: 
+  - value: -interaction=batchmode
+  - name: -output-directory=
+    value_key: :output_dir
+    optional: true
+  - value_key: :filename
+lualatex: 
+  cmd: lualatex
+  parameters: 
+  parameters: 
+  - value: -interaction=batchmode
+  - name: -output-directory=
+    value_key: :output_dir
+    optional: true
+  - value_key: :filename
+ps2pdf: 
+  cmd: ps2pdf
+  parameters:
+  - value_key: :filename
+rail: 
+  cmd: C:/usr/texmf/tex/Latex/rail/rail.exe
+  comment: 
+  - name: -t
+    value_key: :railfile
+    space_separated: true
+    comment: This command works only with 8 character filenames.
+  parameters: 
+  - name: <
+    value_key: :railfile
+    space_separated: true
+    comment: With stdin we can use longer filenames. The processor must save the result as rao-file.
+xelatex: 
+  cmd: xelatex
+  parameters: 
+  parameters: 
+  - value: -interaction=batchmode
+  - name: -output-directory=
+    value_key: :output_dir
+    optional: true
+  - value_key: :filename

data/lib/rake4latex/rules.rb

@@ -1,9 +1,36 @@
+=begin rdoc
+Collection of rules to build a LaTeX-project.
+
+This file defines how to build:
+* dvi (latex)
+* ind (makeindex)
+* bbl (BibTeX)
+* ps (ps2pdf)
+
+There is no definition how to create a pdf.
+This may be done via different ways. You can select your version on your own:
+* ../rake4latex_dvipdfm.rb
+* ../rake4latex_lualatex.rb
+* ../rake4latex_pdflatex.rb (Default)
+* ../rake4latex_ps2pdf.rb
+* ../rake4latex_xelatex.rb
+
+=end
+
+#
+#Generate pdf-rules/files
+#
+#~ %w{xe lua}.each{|x|
+  #~ File.open("../rake4latex_#{x}latex.rb", 'w'){|f| f << File.read('../rake4latex_pdflatex.rb').gsub(/pdf(latex)/i, "#{x}\\1")}
+#~ }
+#~ Dir['../rake4latex_*'].each{|x| puts "* #{x}" }
+
+
 #Some Tools have screen output.
-#runtex should run silent in background, so we have to redirect the output.
+#Rake4LaTeX should run silent in background, so we have to redirect the output.
 require 'catch_output'
 include Catch_output
 
-
 desc "Show compiled source in Adobe Acrobat Reader."
 task :acroread do |t|
   t.prerequisites.each{|pre|
@@ -17,7 +44,7 @@ desc "Set the basefile - needed for clean and statistic"
 task :basefile do |task|
   task.prerequisites.each{|pre|
     #~ puts "Set basefile #{pre.inspect}"
-    set4clean( pre )
+    Rake4LaTeX.set4clean( pre )
     file :statistic => pre
   }
   task.reenable() #If not the second call for clean will not work.
@@ -37,7 +64,7 @@ end
 
 desc "Build a dvi-file with LaTeX"
 rule '.dvi' => '.tex' do |t|
-  runner =   LaTeXRunner.new( 
+  runner =   Rake4LaTeX::LaTeXRunner.new( 
     :main_file => t.source,
     :program => :latex,
     :dummy => nil
@@ -45,24 +72,32 @@ rule '.dvi' => '.tex' do |t|
   runner.execute  #Does all the work and calls the "post-prerequisites"
 end
 
-desc "Build a pdf-file with pdfLaTeX"
-rule '.pdf' => '.tex' do |t|
-  runner =   LaTeXRunner.new( 
-    :main_file => t.source,
-    :program => :pdflatex,
-    :dummy => nil
-    )
-  runner.execute  #Does all the work and calls the "post-prerequisites"
+desc "Build a ps-file from dvi"
+rule '.ps' => '.dvi' do |t|
+  Rake4LaTeX::Logger.info("Call dvips for <#{t.source}>")
+  cmd = Rake4LaTeX.build_cmd( 'dvips', :filename => t.source )
+  
+  stdout, stderr = catch_screen_output{ 
+    sh cmd
+    #stdout -> empty
+    #stderr -> log.
+  }
+  if $? != 0
+    Rake4LaTeX::Logger.fatal("There where dvips errors. \n#{stdout}")
+  end
 end
 
+
+
 desc "Call Makeindex"
 tex_postrule '.ind' => '.idx' do |t, args |
   #check for splitidx
-  splitidx = Splitindex.new(t.source, Rake.application.latexrunner.logger)
+  splitidx = Rake4LaTeX::Splitindex.new(t.source, Rake4LaTeX::Logger)
   if splitidx.makeindex?   #standard index, no splitidx
     #makeindex writes to stderr -> catch it
+    cmd = Rake4LaTeX.build_cmd( 'makeindex', :file_in => t.source )
     stdout, stderr = catch_screen_output{ 
-      sh "makeindex #{t.source}"
+      sh cmd
     }
   else  #splitidx used
     #call splitindex
@@ -85,6 +120,8 @@ tex_postrule_check '.bbl' do |args|
     if ( args[:checksums][auxfile] == :changed and File.read(auxfile) =~ /bibdata/ )
       necessary = "#{auxfile} changed" 
     end
+  else
+    args[:logger].warn("\t#{auxfile} not found in bbl-precheck")
   end
   #Check all prerequisites.
   #This should be the aux-file and (optional) bib-files.
@@ -111,23 +148,58 @@ tex_postrule_check '.bbl' do |args|
   } unless necessary
   necessary #return parameter
 end
+
 #Define the rule
 tex_postrule '.bbl' => '.aux' do |t|  
+  cmd = Rake4LaTeX.build_cmd( 'bibtex', :source => t.source )
   stdout, stderr = catch_screen_output{ 
-    puts `bibtex #{t.source}`
+    puts `#{cmd}`
   }
   if $? != 0
-    Rake.application.latexrunner.logger.fatal("There where BibTeX errors. \n#{stdout}")
+    Rake4LaTeX::Logger.fatal("There where BibTeX errors. \n#{stdout}")
   end
 end
 
-desc "Build a statistic for TeX project"
+#Support for rail
+#http://www.ctan.org/tex-archive/support/rail/
+desc "Call Rail"
+tex_postrule '.rao' => '.rai' do |t|
+  #Rail works only with filenames with 8 characters.
+  #So we use stdin.
+  cmd = Rake4LaTeX.build_cmd( 'rail', :railfile => t.source )
+  Rake4LaTeX::Logger.debug("Call rail: #{cmd}")
+  stdout, stderr = catch_screen_output{ 
+    puts `#{cmd}`
+  }
+  error = false
+  if $? != 0
+    Rake4LaTeX::Logger.fatal("There where Rail errors.")
+    error = true
+  end
+  stderr.each{|errline|
+    Rake4LaTeX::Logger.error("Rail error: #{errline.strip}")
+    error = true
+  }
+  if error
+    Rake4LaTeX::Logger.warn("No rail diagramms generated")
+  else
+    #Now we have to save the result and delete some stuff.
+    stdout.sub!(/^(This is Rail.*)/, '%\1') #%This is Rail, Version 1.1 #0
+    stdout.sub!(/^(\(stdin.*)/, '%\1')  
+    stdout.sub!(/^\)/, '%\1)')		#last line
+    File.open(t.source.ext('rao'), 'w'){|f| f << stdout }    
+  end
+end
 
+
+
+
+desc "Build a statistic for TeX project"
 task :statistic => :basefile do |t|
   puts "Statistics:"
   t.prerequisites.each{|pre|
     next if pre == 'basefile' #exclude task :basefile
-    stat = TeX_Statistic.new(pre)
+    stat = Rake4LaTeX::TeX_Statistic.new(pre)
     puts stat
   }
 end

data/lib/rake4latex/splitindex.rb

@@ -1,3 +1,5 @@
+
+module Rake4LaTeX
 #
 #Checks for a given idx-file if splitindx is used.
 #
@@ -55,8 +57,9 @@ class Splitindex
   #
   #Call makeindex for the given idx-file
   def call_makeindex( idxname )
+      cmd = Rake4LaTeX.build_cmd( 'makeindex', :file_in => idxname )    
       stdout, stderr = catch_screen_output{ 
-        puts `makeindex #{idxname}`
+        puts `#{cmd}`
       }
       if $? != 0
         @logger.fatal("There where Makeindex errors. for #{idxname}\n#{stderr}")
@@ -72,7 +75,7 @@ class Splitindex
     #~ idxnames
   #~ end
 end #Splitindex
-
+end #Rake4LaTeX
 __END__
     #Get existing index-data first