rake4latex 0.1.1 → 0.1.2

data/lib/rake4latex/clean.rb

@@ -18,21 +18,24 @@
 # Changes:
 # * Use File.delete (avoid stderr-messages of rm_r)
 # * Use LaTeXRunner.logger if available.
-# * Add task :basefile as prerequisite.
+# * Use uniq to avoid warnings for just deleted files.
 
-require 'rake'
+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
+task :clean do
+  Rake4LaTeX::Basefile.each{|file| file.set4clean } #late call is necessary. doc. says FileList would work without...
+  
+  logger = Rake4LaTeX::Logger  
   logger.info("Clean: delete helpfiles #{CLEAN.inspect}") if logger.info?
-  CLEAN.each { |fn| 
+  CLEAN.uniq.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 )
@@ -45,7 +48,7 @@ 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| 
+  CLOBBER.uniq.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 )

data/lib/rake4latex/glossaries.rb

@@ -0,0 +1,101 @@
+=begin rdoc
+Define tasks for usage of rake4latex with glossaries.sty
+
+More about glossaries.sty:
+* http://www.ctan.org/tex-archive/help/Catalogue/entries/glossaries.html
+* http://www.ctan.org/tex-archive/macros/latex/contrib/glossaries/
+* http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/glossaries/glossaries-manual.html
+
+ToDo:
+The logs from the glossaries are not analysed by Rake4LaTeX::TeXMessage
+=end
+
+
+=begin
+AUX-File:
+
+\@newglossary{label}{log}{out-ext}{in-ext}
+
+\@newglossary{main}{glg}{gls}{glo}
+\@newglossary{ext}{TeX-extensions}{glsext_in}{glsext_out}
+\@istfilename{sample.ist}
+
+Anschliessend makeindex rufen.
+
+Statt ind/idx werden 
+- gls => glo (default)
+- glsext_in => glsext_out (selbstdefiniert)
+verwendet.
+
+Zus�tzlich Index-file ist.
+=end
+
+
+module Rake4LaTeX
+=begin
+Extend the class by accessors for glossaries.sty.
+=end
+  class LaTeXRunner
+=begin rdoc
+Store information from glossaries.sty to transport it from
+tex_postrule_check to tex_postrule for 'gls'-task.
+=end
+  attr_accessor :glossaries
+=begin rdoc
+Format for the makefindex call neeeded for glossaries.sty.
+=end
+  attr_accessor :glossaries_format
+  end #LaTeXRunner
+end #Rake4LaTeX
+
+=begin
+Check glossaries.sty-infos after a TeX-run.
+
+The data are stored in Rake4LaTeX::LaTeXRunner#glossaries
+and Rake4LaTeX::LaTeXRunner#glossaries_format .
+=end
+desc "Build glossary with glossaries.sty"
+tex_postrule_check '.gls' do |args|
+  gls = {}
+  File.read(args[:task].name.ext('aux')).each{|auxline|
+    case auxline
+      when /\\@newglossary\{(.*)\}\{(.*)\}\{(.*)\}\{(.*)\}/
+        args[:logger].debug("Found Glossary #{$1}-#{$2}-#{$3}-#{$4}")
+        gls[$1] = { :log => $2, :out => $3, :in => $4 }
+      when /\\@istfilename\{(.*)\}/
+        args[:logger].debug("Found Glossary format definition #{$1}")
+        args[:texrunner].glossaries_format = $1
+    end
+  }
+
+  #Provide glossaries-data to gls-task.
+  args[:texrunner].glossaries = gls
+  gls.empty? ? false : true
+end
+
+
+=begin
+Build the glossaries from glossaries.sty.
+
+The data are taken from Rake4LaTeX::LaTeXRunner#glossaries
+and Rake4LaTeX::LaTeXRunner#glossaries_format .
+=end
+desc "Call Makeindex for glossaries with glossaries.sty"
+tex_postrule '.gls' => '.glo' do | t |
+  #fixme: check for t.texrunner.glossaries
+  t.texrunner.logger.info("Prepare glossaries #{t.texrunner.glossaries.keys.inspect}")
+  t.texrunner.logger.warn("No makeindex-style available for glossaries") unless t.texrunner.glossaries_format
+  t.texrunner.glossaries.each{|key, par|
+    cmd = Rake4LaTeX.build_cmd( 'makeindex', 
+          :file_in => t.name.ext(par[:in]), :file_out => t.name.ext(par[:out]),
+          :file_log => t.name.ext(par[:log]), :format => t.texrunner.glossaries_format
+            )
+#~ puts cmd
+    Rake4LaTeX::Logger.debug("Call #{cmd}")
+    stdout, stderr = catch_screen_output{ 
+      sh cmd
+    }
+    CLEAN.include(FileList.new("#{t.name.ext()}.{#{par[:in]},#{par[:out]},#{par[:log]}}"))
+  }#$gls.each
+  CLEAN.include(FileList.new(t.texrunner.glossaries_format))  if t.texrunner.glossaries_format
+end

data/lib/rake4latex/latexrunner.rb

@@ -7,19 +7,7 @@ It calls (pdf|xe|lua)LaTeX and checks if additional tools are needed.
 class LaTeXRunner
   #Define Infinity (needed for option maxruns.
   Infinity = 1.0/0
-  #
-  #Define the main settings for the runner.
-  #
-  #This values can be overwritten with
-  #   Rake.application.set_latexrunner_default(:loglevel, Log4r::DEBUG)
-  #
-  DEFAULT_SETTINGS = {
-    :main_file => nil,  #only needed for key-check. Must be defined later.
-    :maxruns => 5,
-    :program => :pdflatex,  #Valid entries see PROGRAMS
-    :loglevel => Log4r::INFO,
-    :texerrors_allowed => false,
-  }
+  
 =begin rdoc
 All tasks, which should be executed after a TeX-call.
 
@@ -56,15 +44,20 @@ Should return true or false.
 =begin rdoc
 Define a new runner.
 
-The settings contain the following values:
-* main_file, see LaTeXRunner#main_file
-* maxruns, see LaTeXRunner#maxruns
+The settings must contain:
+* main_file, see Rake4LaTeX::LaTeXRunner#main_file
+It may contain the following values:
+* maxruns, see Rake4LaTeX::LaTeXRunner#maxruns
+Defaults are defined in Rake4LaTeX::Basefile#settings4LaTeXRunner
 =end
   def initialize( settings )
     
-    #~ raise ArgumentError, "Task is no RakeTask but #{t.class}" unless task.is_a?(Rake::Task)
+    @main_file = settings[:main_file]
+    raise MainfileError, "main_file missing" unless @main_file
+    #Define or get Basefile
+    basefile = Rake4LaTeX::Basefile.set( @main_file )
 
-    @logger = Rake4LaTeX::Logger
+    @logger = basefile.logger
     #~ @logger = Log4r::Logger.new("LaTeXRunner #{settings[:main_file]}")
     #~ @logger.outputters = Log4r::StdoutOutputter.new('log_stdout')
     
@@ -72,7 +65,7 @@ The settings contain the following values:
     #This allows us to overwrite the program settings for a special LaTeXRunner.
     @programms = Programms.dup
     
-    DEFAULT_SETTINGS.merge(settings).each{|key, value|
+    basefile.settings4LaTeXRunner.merge(settings).each{|key, value|
       #~ puts "#{key}: #{value}"
       case key
       when :main_file; @main_file = value
@@ -87,7 +80,7 @@ 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
 
@@ -95,8 +88,6 @@ The settings contain the following values:
     @input_dir = File.dirname(@main_file)
     @full_input_dir = File.expand_path(@input_dir)
 
-    #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
@@ -164,8 +155,6 @@ The settings contain the following values:
         run_latex_once(cmd)
       end
     end
-    #Guarentee that help files are deleted in clean.
-    Rake4LaTeX.set4clean( @basename )
     
     plural_s = "#{@texruns} run#{@texruns>1 ? 's': ''}"
     if @rerun_necessary
@@ -187,7 +176,7 @@ The settings contain the following values:
     checksums = {}
     FileList["#{@basename.ext('*')}"].each do |file|
         # Computes a MD5 digest for the given file, reading the file.
-        File.open(file){|f| checksums[file] = MD5.new(f.read).hexdigest }
+        File.open(file){|f| checksums[file] = Digest::MD5.hexdigest(f.read) }
     end
 
     @logger.info("Excute #{cmd}")
@@ -209,7 +198,7 @@ The settings contain the following values:
           when nil
             @logger.debug("new file #{file}")
             checksums[file] = :changed
-          when File.open(file){|f| MD5.new(f.read).hexdigest}
+          when File.open(file){|f|  Digest::MD5.hexdigest(f.read) }
             #no message needed
             #~ @logger.debug("Unchanged file #{file}")
           else
@@ -280,7 +269,7 @@ The settings contain the following values:
           @logger.info("Call target #{post_prereq.name} (#{reason4call})" )
           post_prereq.invoke() 
           File.open(post_prereq.name){|f|
-              @rerun_necessary = (MD5.new(f.read).hexdigest != checksums[f.path])
+              @rerun_necessary = ( Digest::MD5.hexdigest(f.read) != checksums[f.path])
               @logger.info("Rerun necessary (#{f.path} changed)" ) if @rerun_necessary
           } unless @rerun_necessary #check not necessary, if we already need an additional run
           break #Only one call necessary

data/lib/rake4latex/rules.rb

@@ -28,7 +28,7 @@ This may be done via different ways. You can select your version on your own:
 
 #Some Tools have screen output.
 #Rake4LaTeX should run silent in background, so we have to redirect the output.
-require 'catch_output'
+require 'knut_tools/catch_output'
 include Catch_output
 
 desc "Show compiled source in Adobe Acrobat Reader."
@@ -40,46 +40,16 @@ task :acroread do |t|
   }
 end
 
+=begin
+Alternative definition instead Rake4LaTeX::Basefile.set(filename)
+=end
 desc "Set the basefile - needed for clean and statistic"
 task :basefile do |task|
   task.prerequisites.each{|pre|
     #~ puts "Set basefile #{pre.inspect}"
-    Rake4LaTeX.set4clean( pre )
-    file :statistic => pre
+    puts "Task basefile defined for #{pre.inspect} (Please replace it with: Rake4LaTeX::Basefile.set)"
+    Rake4LaTeX::Basefile.new(pre)
   }
-  task.reenable() #If not the second call for clean will not work.
-end
-task :default => :basefile
-
-desc "Build a log-overview file"
-task :log_overview => :basefile do
-  Rake.application[:statistic].prerequisites.each{|pre|
-    next if pre == 'basefile' #exclude task :basefile
-    stat = Rake4LaTeX::TeX_Statistic.new(pre)
-    #Filename also used in set4clean
-    File.open("#{pre.ext()}.overview.txt", 'w'){|f| 
-      f << stat.overview()
-    }
-  }
-end
-
-desc "Archive all log-files to zip-file"
-task :log_archive => :basefile do
-  require 'zip/zipfilesystem'
-  Zip::ZipFile.open("rake4latex_log_archive.zip", Zip::ZipFile::CREATE ){|zip|
-    puts "Pack #{zip.name}"
-    #Store all Files to be deleted
-    CLEAN.each{|filename|
-      zip.file.open(File.basename(filename), 'w'){|f| f << File.open(filename,"rb") {|io| io.read} }
-    }
-    Rake.application[:statistic].prerequisites.each{|pre|
-      next if pre == 'basefile' #exclude task :basefile
-      stat = Rake4LaTeX::TeX_Statistic.new(pre)
-      zip.file.open("#{pre}.overview.txt", 'w'){|f| 
-        f << stat.overview()
-      }
-    }    
-  } #close zip-file
 end
 
 #
@@ -92,6 +62,9 @@ task :touch do |task|
   }
 end
 
+=begin
+Call LaTeX
+=end
 desc "Build a dvi-file with LaTeX"
 rule '.dvi' => '.tex' do |task|
   runner =   Rake4LaTeX::LaTeXRunner.new( 
@@ -102,9 +75,13 @@ rule '.dvi' => '.tex' do |task|
   runner.execute  #Does all the work and calls the "post-prerequisites"
 end
 
+=begin
+Call dvips
+=end
 desc "Build a ps-file from dvi"
 rule '.ps' => '.dvi' do |task|
-  Rake4LaTeX::Logger.info("Call dvips for <#{task.source}>")
+  
+  Rake4LaTeX::Basefile.set(task.source).logger.info("Call dvips for <#{task.source}>")
   cmd = Rake4LaTeX.build_cmd( 'dvips', :filename => task.source )
   
   stdout, stderr = catch_screen_output{ 
@@ -113,16 +90,18 @@ rule '.ps' => '.dvi' do |task|
     #stderr -> log.
   }
   if $? != 0
-    Rake4LaTeX::Logger.fatal("There where dvips errors. \n#{stdout}")
+    Rake4LaTeX::Basefile.set(task.source).fatal("There where dvips errors. \n#{stdout}")
   end
 end
 
-
-
+=begin
+Call Makenindex
+=end
 desc "Call Makeindex"
 tex_postrule '.ind' => '.idx' do |task|
   #check for splitidx
-  splitidx = Rake4LaTeX::Splitindex.new(task.source, Rake4LaTeX::Logger)
+  #If you use index.sty you will get an error.
+  splitidx = Rake4LaTeX::Splitindex.new(task.source, task.texrunner.logger)
   if splitidx.makeindex?   #standard index, no splitidx
     #makeindex writes to stderr -> catch it
     cmd = Rake4LaTeX.build_cmd( 'makeindex', { :file_in => task.source }, task )
@@ -136,6 +115,9 @@ tex_postrule '.ind' => '.idx' do |task|
   end
 end
 
+=begin
+Call BibTeX
+=end
 desc "Call BibTeX"
 #Define the precheck
 tex_postrule_check '.bbl' do |args|
@@ -154,6 +136,13 @@ tex_postrule_check '.bbl' do |args|
   else
     args[:logger].warn("\t#{auxfile} not found in bbl-precheck")
   end
+  
+  #Check, if the bbl is missing.
+  #may occur, if the bbl-file was deleted manual, but no change in aux...
+  # fixme -- provoziert unn�tige bibtex-laeufe.
+  #~ bblfile = args[:task].name.ext('bbl')
+  #~ necessary = "#{bblfile} missing"  unless File.exist?(bblfile)
+    
   #Check all prerequisites.
   #This should be the aux-file and (optional) bib-files.
   args[:task].prerequisites.each{|post_prereq_pre|  
@@ -192,8 +181,10 @@ tex_postrule '.bbl' => '.aux' do |task|
   end
 end
 
-#Support for rail
-#http://www.ctan.org/tex-archive/support/rail/
+=begin
+Call Rail
+http://www.ctan.org/tex-archive/support/rail/
+=end
 desc "Call Rail"
 tex_postrule '.rao' => '.rai' do |task|
   #Rail works only with filenames with 8 characters.
@@ -208,7 +199,7 @@ tex_postrule '.rao' => '.rai' do |task|
     task.texrunner.logger.fatal("There where Rail errors.")
     error = true
   end
-  stderr.each{|errline|
+  stderr.each_line{|errline|
     task.texrunner.logger.error("Rail error: #{errline.strip}")
     error = true
   }
@@ -225,15 +216,51 @@ tex_postrule '.rao' => '.rai' do |task|
   CLEAN.include(task.name)
 end
 
+=begin
+End Task and TeX-independend tasks.
 
-desc "Build a statistic for TeX project"
-task :statistic => :basefile do |task|
-  task.prerequisites.each{|pre|
-    next if pre == 'basefile' #exclude task :basefile
-    stat = Rake4LaTeX::TeX_Statistic.new(pre)
-    puts "Statistic for #{pre}:"
-    puts stat.stat_summary.map{|e| "  #{e}"}
-    #~ puts stat
-  }
-end
+This tasks require a previous Rake4LaTeX::Basefile.set
+=end
+
+
+
+=begin
+Build Statistic.
+
+The main action is defined in Rake4LaTeX::Basefile
+=end
+desc "Build a statistic for all TeX project"
+task :statistic 
+
+=begin
+Show the log-overview
+=end
+desc "Show the log-overview"
+task :log_overview
+
+=begin
+Build a log-overview file
+=end
+desc "Build a log-overview file"
+task :log_overview_file
 
+=begin
+Archive all log-files to zip-file
+=end
+desc "Archive all log-files to zip-file"
+task :log_archive do
+  require 'zip/zipfilesystem'
+  Zip::ZipFile.open("rake4latex_log_archive.zip", Zip::ZipFile::CREATE ){|zip|
+    puts "Pack #{zip.name}"
+    #Store all Files to be deleted
+    CLEAN.each{|filename|
+      zip.file.open(File.basename(filename), 'w'){|f| f << File.open(filename,"rb") {|io| io.read} }
+    }
+    Rake4LaTeX::Basefile.each{|basefile|
+      stat = Rake4LaTeX::TeX_Statistic.new(basefile.basename)
+      zip.file.open("#{basefile.basename}.overview.txt", 'w'){|f| 
+        f << stat.overview()
+      }
+    }    
+  } #close zip-file
+end