rake4latex 0.1.0 → 0.1.1

data/{call_rake4latex.rb → bin/call_rake4latex.rb}

@@ -122,8 +122,6 @@ opts.on("-v", "--version", "Version") { |v|
   puts "Rake4LaTeX-Caller Version #{Rake4LaTeX::VERSION}" 
 }
 
-
-
 #Parsen der Parameter mit Exception bei ung�ltigen Parametern
 begin
 	opts.parse!
@@ -139,7 +137,7 @@ begin
         task (:default => :touch)
       when :dependecies
         puts "Build dependecies for #{target.ext('tex')}" if PARSE_MESSAGES
-        LaTeXDependencies.get_dependecies(target.ext('tex'), :inputs, :flat).each{|dep|
+        TeXfile.new(target.ext('tex')).includes(:recursive, :uniq).each{|dep|
           puts "     => #{dep.inspect}" if PARSE_MESSAGES
           task (target => dep)
         }
@@ -166,3 +164,8 @@ TASK_AFTER_TeX.each{|task|
 
 app = Rake.application
 app[:default].invoke
+
+if $0 == __FILE__
+  puts "Finished, please enter any key"
+  STDIN.getc
+end

data/lib/rake4latex.rb

@@ -26,7 +26,11 @@ A not-so minimal rakefile looks like this:
 
 You can generate a rakefile template with:
   require 'rake4latex'
-  puts Rake4LaTeX.template( [basename] )
+  puts Rake4LaTeX.build_rakefile( [basename, :all ] )
+
+The method will print a rakefile definition.
+
+More about the task can be found in section 'Special Tasks'
 
 ===call_rake4latex.rb
 When you think, your project is too small to create a rakefile,
@@ -98,24 +102,15 @@ You must define your dependencies your own (but there is a help to do so, see ne
 Example:
   file 'testdocument.dvi' => ['testdocument.tex', 'testincludes/testinclude1.tex']
 
-
-===Determine Dependecies: LaTeXDependencies.get_dependecies( )
+===Determine Dependecies
 You can automatically compute dependencies for the latex task:
-  LaTeXDependencies.new(filename).get_dependecies( *options )
-Options may be:
-* :inputs:
-
-  The input file (the one which is passed to latex) is read, and the arguments of the 
-  <tt>\includeonly</tt>, <tt>\include</tt> and <tt>\input</tt> latex commands are
-  extracted. Each of this these files is scanned again for dependecies.
- 
-  The result is a nested array with all dependecies.
-
-* :flat:
-  The (nested) result is flatted and double entries are deleted.
+  Rake4LaTeX::TeXfile.new(filename).includes( [options] )
 
 You can use it already direct in your dependecies definition:
-  file 'testdocument.dvi' => LaTeXDependencies.new('testdocument.tex').get_dependecies( *options )
+  file 'testdocument.dvi' => Rake4LaTeX::TeXfile.new('testdocument.tex').includes(:recursive, :uniq )
+
+Alternative you can generate your rakefile:
+  Rake4LaTeX.build_rakefile( filename )
 
 ===Dependecies for BibTeX
 BibTeX depends on two files:
@@ -135,18 +130,14 @@ The bbl-dependecy is needed to start a new BibTeX-run.
 The following tools are supported by rake4latex:
 * Makeindex with makeidx.sty
 * BibTeX
+* Rail[http://www.ctan.org/tex-archive/support/rail/]
 
 ===Supported (checked) packages
 The rake process to generate the document is independent of any 
 package.
-But some packages requires additional TeX-runs.
-
-The following packages are tested and work fine:
-* minitoc
-* longtable
-* supertabular
+But some packages requires additional actions.
 
-For the following packages exists special solutions:
+For the following packages exist special solutions:
 * splitindex (splitindex is replaced by internal routines) 
   http://www.ctan.org/tex-archive/macros/latex/contrib/splitindex/
 * gloss (glossary based on bibTeX) 
@@ -154,6 +145,97 @@ For the following packages exists special solutions:
 * rail (creating rail-diagramms)
   http://www.ctan.org/tex-archive/support/rail/
 
+==Special Tasks
+===basefile
+There are some tasks in Rake4LaTeX who needs a connected TeX-file.
+The task basefile defines such a connection.
+
+From rakes view, it's just a dummy-task to define prerequisites 
+for other tasks.
+
+Tasks using basefile are:
+* touch
+* statistic
+* log_overview
+* log_archive
+* clean
+* clobber
+
+If you build a pdf (or dvi), basefile-actions are done in background.
+
+It is recommended to define your main-file as basefile.
+Without this, clean... may not work correct.
+
+
+
+===touch
+The touch task changes the modification data for the touched file.
+In the result you can force a new TeX-run.
+
+Usage:
+  task :touch => 'myfile.tex'
+  task :default => touch
+
+With 
+  task :basefile => 'myfile'
+touch is also connected with your sourcefile.
+
+===statistic
+Get a very short overview on the log-content.
+Errors and warnings are counted for each log (TeX, bibTeX, makeindex...)
+
+Usage:
+  task :basefile => 'myfile'
+  task :statistic
+  task :default => [ 'myfile.pdf', :statistic ]
+
+See also Rake4LaTeX#TeX_Statistic#stat_summary
+
+===log_overview
+A log-file is created with a log-summary (TeX_Statistic#stat_summary),
+all errors and warnings from TeX and the tools and
+a detailed analyse for the TeX-log.
+
+You should do this task always _before_ a clean-task.
+
+Usage:
+  task :basefile => 'myfile'
+  task :log_overview
+  task :default => [ 'myfile.pdf', :log_overview ]
+
+
+See also Rake4LaTeX#TeX_Statistic#overview
+
+===clean
+TeX and the related tools build a lot of auxiliary files.
+When you have them, you can delete the auxiliary files.
+
+The task _clean_ does exactly this.
+
+If you also want to delete the results (pdf...) you can use the task
+_clobber_.
+
+Usage:
+  task :basefile => 'myfile'
+  task :default => [ 'myfile.pdf', :clean ]
+
+
+===log_archive
+With _clean_ you loose all logs. 
+With _log_archive_ you create a zip-file with all logs.
+
+_log_archive_ makes only sense in combination with _clean_. 
+First archive the logs, then delete them with _clean_.
+After this you have _one_ file with all your logs and 
+in case of errors you can make analyses in the archived logs.
+
+You should do this task always _before_ a clean-task.
+
+Usage:
+  task :basefile => 'myfile'
+  task :default => [ 'myfile.pdf', :log_archive, :clean ]
+
+
 ==Adding new tasks
 ===Normal tasks
 Task to generate pictures or other stuff needed to
@@ -213,33 +295,15 @@ See also section 'Multiple runs'
   * No plan to solve it.
     Not a big problem, and why you need a rakefile for such simple tex-files?
     
-* No usage of kpsewhich.
-
-  LaTeXDependencies#get_dependecies checks dependecies only relative to 
-  the file location.
-  kpsewhich is not used.
-  * Would be nice escpecially for BibTeX and scan for \bibliography{xxx}
-  * Low priority
-
 ===Packages with problems
 There are additional packages requiring additonal runs.
 
-* glossaries (glossary based on makeindex)  - support not planned.
+* glossaries (glossary based on makeindex)  - see test cases or use gloss.sty.
 * multiind/index (multiple index) - support not planned. 
   Please use splitindex or inform me about your need.
-* rail (rail syntax diagramms) - see tests, the rakefile includes the solution.
-
-
 
 =end
 
-<<weiter
-fixmes
-- glossaries
-
-task statistic/log-analyse ausbauen.
-task pack unpack logarchive
-weiter
 
 #
 #Load the base functions and load subfiles.

data/lib/rake4latex/analyse_texfile.rb

@@ -0,0 +1,375 @@
+
+if $0 == __FILE__
+require 'rake4latex'
+end
+
+module Rake4LaTeX
+=begin rdoc
+This class collects informations for an existing (La)TeX-File.
+
+It can be used to determine dependecies of a LaTeX project.
+
+What's not done:
+* check kpsewhich if files are not found
+* Analyse styles
+* 
+
+=end
+class TeXfile
+
+  #fixme: global logger
+  @@log = Log4r::Logger.new("LaTeXRunner", Log4r::ERROR)
+  @@log.outputters = Log4r::StdoutOutputter.new('log_stdout')
+
+=begin rdoc
+Define a TeXfile.
+
+If the include-analyse should work correct,
+the work directory should be the place, where you find your file.
+
+If filename is :dummy, you get a dummy-file for little extracts.
+=end
+  def initialize( filename )
+
+    @filename = filename      
+    @@log.debug("TeXfile to analyse: #{@filename}")
+    #~ @@log.warn("Start TeXfile analyse in foreign directory") unless File.dirname(filename) == '.'
+
+    #List of filenames of the includes
+    @includes = []
+    #Hash with the objects for the include files.
+    @include_object = {}
+    @bibliography = []
+    @gloss = {} #bib-files for gloss.sty
+    @splitindex = {}
+    
+    if @filename != :dummy
+      @basename = File.basename(filename)
+      raise ArgumentError, "File #{@filename} not found" unless File.exist?(@filename)
+      analyse( File.read(@filename) )
+    end
+  end
+=begin rdoc
+List of all includes.
+
+Options:
+* :recurssive - get all includes, including includes of includes
+* :uniq - delete double includes
+=end
+  def includes( *options )
+    if options.include?(:recursive)
+      includes = tree.flatten - [ @filename ]
+    else
+      includes = @includes
+    end
+    includes.uniq! if options.include?(:uniq)
+    includes
+  end
+=begin rdoc
+If bibTeX is used, this Array contains all bibliography.
+=end
+  attr_reader :bibliography
+=begin rdoc
+If gloss.sty is used, this Hash contains all glossaries and there bibliography.
+=end
+  attr_reader :gloss
+=begin rdoc
+If splitindex is used, this Array contains all indeces.
+=end
+  attr_reader :splitindex
+  
+=begin rdoc
+Analyse the file.
+
+Search dependecies by sanning for 
+* \input/\include
+* \bibliography
+* \printgloss (gloss.sty, like bibliography)
+* \newindex (splitindex, like makeindex)
+=end
+  def analyse(content )
+
+    content.each{ |line|
+      #Skip comments
+      #Remarks/Bug: 
+      #* \% is not detected.
+      #* \iffalse...\fi is not detected.
+      line.sub!(/%.*/, '')
+      break if line =~ %r{\\endinput(\s|\Z)}  #Stop at \endinput
+      #Detect \macro[]{}
+      line.scan(/\\(include|input|includeonly|bibliography|printgloss|newindex)(\[.*?\])?\{([^}]+)\}/){|m|
+        case m[0]
+          #~ when 'includeonly'  
+          when 'include', 'input'
+            includename = m[2].ext('tex')  #add the extension tex if not already done.
+            @includes << includename
+          when 'bibliography'
+            #~ @bibliography << m[2].ext('bib')
+            @bibliography << m[2].split(/,/).map{|f| f.ext('bib')}
+            @bibliography.flatten!
+          when 'printgloss'
+            m[1]  = 'gls' unless m[1]
+            @gloss[m[1]] ||= [] << m[2].split(/,/).map{|f| f.ext('bib')}
+            @gloss[m[1]].flatten!
+          when 'newindex'
+            #m[1] contains the optional name
+            @splitindex[m[2]] = m[1]
+        end #case m[0]
+      }#line.scan
+    }#File.foreach
+
+    @includes.each{|includename|
+      if File.exist?(includename)
+        if @include_object[includename]
+          #fixme recursiv...
+          #This check detects only a double input in one file.
+          @@log.warn("Double input of #{includename} in #{@filename}")
+        else
+          @include_object[includename] = TeXfile.new(includename)
+        end
+      else
+        @@log.warn("Include-File #{includename} not found")
+      end
+    }
+
+    #Check the bibTeX-File in the TeXMF-trees (using kpsewhich)
+    @bibliography.map!{|bib| kpsewhich(bib) }
+    @gloss.each{|key,bibs| bibs.map!{|bib| kpsewhich(bib) }}
+  end
+=begin rdoc
+Check with kpsewhich to get a file location.
+
+If nothing is found, take the original name.
+=end
+  def kpsewhich( filename )
+    hit = `kpsewhich #{filename}`
+    @@log.warn("Include-File #{filename} not found") if hit.empty?
+    hit.empty? ? filename : hit.strip
+  end
+=begin
+Get a tree-like view of all includes.
+=end
+  def tree()
+    tree = [@filename]
+    #Only first occurence and without a sequence
+    #~ @include_object.each{|name, inc|
+      #~ tree << inc.tree
+    #~ }
+
+    @includes.each{|name|
+      if @include_object[name]
+        tree << @include_object[name].tree
+      else
+        tree << name
+      end
+    }
+
+    tree
+  end
+  def inspect()
+    "<TeXfile #{@filename}>"
+  end
+end #TeXfile
+
+
+#List of all options for Rake4LaTeX.build_rakefile
+BUILD_RAKEFILE_OPTIONS = [
+    :pdf, #add rule to create a pdf
+    :dvi,  #add rule to create a dvi
+    :dependecies, #Analyse dependecies and add them
+    :bib, #Add bibliography-dependecies (1)
+    :gloss, #Add gloss.sty-dependecies
+    :splitindex
+]
+#
+#Build a rakefile
+#
+#Options:
+#* :pdf - add rule to create a pdf
+#* :dvi - add rule to create a dvi
+#* :dependecies - Analyse dependecies and add them
+#* :bib: Add bibliography-dependecies (1)
+#* :gloss: Add gloss.sty-dependecies
+#* :splitindex
+#* :all - all options,
+#
+#Remarks:
+#
+#(1) The bibTeX-files are searched via kpsewhich.
+#local files get a "./" in froint of hte name.
+#
+def self.build_rakefile( filename, *options )
+  
+  options.concat(BUILD_RAKEFILE_OPTIONS) if options.delete(:all )
+  ( options - BUILD_RAKEFILE_OPTIONS ).each{|opt|
+    Rake4LaTeX::Logger.warn("Undefined option #{opt} in Rake4LaTeX.build_rakefile")
+  }
+  basename = filename.ext()
+  tex_name = filename.ext('tex')
+  pdf_name = filename.ext('pdf')
+  dvi_name = filename.ext('dvi')
+  aux_name = filename.ext('aux')
+  texfile = Rake4LaTeX::TeXfile.new(tex_name)
+  #
+  #Template for a basic rakefile
+  #
+  template = <<Template
+=begin
+Rakefile for LaTeX-project #{basename}
+
+Generated by Rake4LaTeX.build_rakefile, #{Date.today}
+
+=end
+require 'rake4latex'
+
+#Needed for some actions without a previous TeX-call
+task :basefile => '#{tex_name}'
+
+Template
+
+  template << <<Template
+#
+# Define Dependecies
+#
+Template
+
+  template << "file '#{pdf_name}' => '#{tex_name}'\n" if options.include?(:pdf)
+  template << "file '#{dvi_name}' => '#{tex_name}'\n" if options.include?(:dvi)
+  if options.include?(:dependecies) 
+    includes = texfile.includes(:uniq, :recursive)
+    if ! includes.empty?
+      template << <<Template
+#{texfile.tree.to_yaml.map{|line| "# #{line}"}}
+dependecies = [ 
+#{includes.map{|f| "  \"#{f}\",\n"}}]
+Template
+      template << "file '#{pdf_name}' => dependecies\n" if options.include?(:pdf)
+      template << "file '#{dvi_name}' => dependecies\n" if options.include?(:dvi)
+    end
+  end #options.include?(:dependecies)
+
+  if options.include?(:bib) and ! texfile.bibliography.empty?
+    template << <<Template
+
+=begin
+bib-file dependecies
+=end
+Template
+    template << "file '#{basename}.bbl' => #{texfile.bibliography.uniq.inspect}\n"
+    template << "file '#{pdf_name}' => #{texfile.bibliography.uniq.inspect}\n" if options.include?(:pdf)
+    template << "file '#{dvi_name}' => #{texfile.bibliography.uniq.inspect}\n" if options.include?(:dvi)
+  end #options.include?(:bib)
+  
+  if options.include?(:gloss) and ! texfile.gloss.empty?
+    template << <<Template
+
+=begin
+bib-file dependecies for gloss-style
+=end
+Template
+    texfile.gloss.each{|glossar, bib|
+      template << "# glossar #{glossar}\n"
+      template << "file '#{basename}.#{glossar}.bbl' => #{bib.uniq.inspect}\n"
+      template << "file '#{basename}.#{glossar}.bbl' => '#{aux_name}'\n"
+      
+      template << "file '#{pdf_name}' => #{bib.uniq.inspect}\n" if options.include?(:pdf)
+      template << "file '#{dvi_name}' => #{bib.uniq.inspect}\n" if options.include?(:dvi)
+    }
+  end #options.include?(:bib)
+
+  if options.include?(:splitindex) and ! texfile.splitindex.empty?
+    template << <<Template
+
+=begin
+dependecies for splitindex
+=end
+Template
+    texfile.splitindex.each{|splitindex, indexname|
+      template << "# Index #{splitindex} #{indexname}\n"
+      template << "file '#{basename}-#{splitindex}.ind' => '#{basename}-#{splitindex}.idx'\n"
+      template << "file '#{pdf_name}' => '#{basename}-#{splitindex}.ind'\n" if options.include?(:pdf)
+      template << "file '#{dvi_name}' => '#{basename}-#{splitindex}.ind'\n" if options.include?(:dvi)
+    }
+  end #options.include?(:bib)
+
+
+  template << <<Template
+
+#Force the compilation
+task :touch => '#{tex_name}'
+
+Template
+
+  template << <<Template
+=begin
+Define the default tasks
+=end
+#~ task :default => :touch  #Force the first TeX-call
+Template
+
+  template << "task :default => '#{pdf_name}' #build the pdf\n" if options.include?(:pdf)
+  template << "task :default => '#{dvi_name}' #build the dvi\n" if options.include?(:dvi)
+
+  template << <<Template
+
+=begin
+Closing Tasks
+=end
+task :default => :statistic #Get an overview on errors and warnings
+task :default => :clean #delete helpfiles
+
+Template
+
+  template << <<Template
+=begin
+Make the rakefile self-executable
+=end
+if $0 == __FILE__
+  app = Rake.application
+  #~ Rake4LaTeX.set_latexrunner_default(:texerrors_allowed, true)
+  app[:default].invoke  #start default tasks
+end
+Template
+
+  template
+end #self.template( filename = nil)
+
+
+end #Rake4LaTeX
+
+if $0 == __FILE__
+  #fixmes:
+  #Parameter "xx.sty" -> analyse also this style
+
+  #~ file = Rake4LaTeX::TeXfile.new(:dummy)
+  #~ file.analyse(<<'xx'
+#~ \input{aaa}
+#~ \bibliography{test}
+#~ \bibliography{testdocument}
+#~ xx
+#~ )
+  #~ puts file
+  #~ puts file.includes.inspect
+  #~ puts file.bibliography.inspect
+  #~ puts file.splitindex.inspect
+  #~ puts file.tree.to_yaml
+  #~ exit
+
+Dir.chdir('../../test'){
+  #~ Dir.chdir('gloss'){
+  Dir.chdir('bibtex'){
+  #~ Dir.chdir('includes'){
+  #~ Dir.chdir('splitindex'){
+    #~ file = Rake4LaTeX::TeXfile.new('testdocument.tex')
+    #~ puts file
+    #~ puts file.includes.inspect
+    #~ puts file.bibliography.inspect
+    #~ puts file.splitindex.inspect
+    #~ puts file.tree.to_yaml
+    
+    #~ puts Rake4LaTeX.build_rakefile('testdocument.tex', :dvi, :pdf, :dependecies, :bib, :gloss, :splitindex )
+    puts Rake4LaTeX.build_rakefile('testdocument.tex', :all)
+  }
+}
+
+end