runtex 0.2.1

data/lib/Code_zum_Pluendern_rtex4newrtex.rb

@@ -0,0 +1,275 @@
+puts <<xx
+Kopiervorlage aus alter Version
+Sollte am Ende der Umsetzung leer sein.
+------------------------------
+xx
+
+require 'yaml'
+File.open('runtex_pathes.yaml'){|f| $conf = YAML.load(f)}
+
+#~ puts $conf.inspect
+basename = 'basename'
+
+exit
+#
+#Things to get better:
+#-	class Configuration is platform depending and only defined for Win2K
+#	- path and program for each tool
+#	- stdout/stderr/Log->Files
+#- Error and Warning-Analyses must be enforced	
+#- support multibib.sty (bibtex)
+#- support multind.sty 
+#- Option -c to remove all auxiliary files.
+#- Check in which source-file an error/warning occurs (input-list)
+#- Check on which output page an error/warning occurs (input-list)
+
+#
+#This class allows some precompile on the given TeX-File(s)
+#Actual a method for listings.sty is implemented.
+class Precompile
+  #This method overwrites the given file with the replacements for listings
+  def Precompile.mix_references!( filename )
+  
+    Logger.add(2, '', "Precompile #{filename} for cross-references")
+    pre = new( filename)
+    pre.listings_mix_references()
+    
+    new = File.new(filename, 'w')
+    new.puts pre.text()	#write the converted text
+    new.close	
+  end	#mix_references( template )
+  #Read the contents of the file
+  def initialize( filename)
+    @text = ''
+    File.open( filename ){ |f|
+      @text = f.readlines.to_s
+    }
+  end
+  attr_reader :text
+  #This function supports the handling of the package listings.
+  #Listings.sty allows you the insertion of external lsitings with the command
+  #	\lstinputlisting[firstline=<first>,lastline=<last>]{Programm}
+  #There is one Problem: Whats the value of <first> and <last>?
+  #Once a programm is finished, it is no problem. But when the program is still in develpment,
+  #you have to adapt the line numbering.
+  #It would be much nicer, if you could use something like 
+  #	\lstinputlisting[fromlabel=<first>,tolabel=<last>]{Programm}
+  #Well, I understand why it is dificult to make it in listings.sty.
+  #This method makes this work. It scans the listing file for the label and replaces it in the source.
+  def listings_mix_references( template = @text )
+    #This method scan a program file for the string TeXlabel{<label>} or LABEL{<label>} and stores the linenumber.
+    #The string can be redefined by a regular expression, $1 must be the label.
+    def scan_source( source, r = /[(TeXlabel)|(LABEL)]\{(.*?)?\}/ )
+      Logger.add(4, self.class, "Read File #{source} for cross-references")
+      labels	= Hash.new( 0 )
+      if !File.exist?( source )
+        Logger.add(3, self.class,  "Sourcecode #{source} nicht gefunden" )
+        return labels
+      end
+      #extend this Hash with a method get_label
+      File.open(source){ |f|
+        linenumber = 0
+        f.each{|l|
+          linenumber += 1
+          while l =~ r	#Perhaps there are mor then one label on a line
+            labels[$1] = linenumber
+            l.sub!( r ,'')	#delete label for next Regex-check
+          end
+      #Idee f�r ABAP: FORM/Endform automatisch mit Labels versehen?
+        }
+      }
+      Logger.add(5, self.class,  "Found labels in #{source}: #{labels.inspect}")
+      return labels
+    end 
+    def get_label( hash, key, source )
+      pos = hash.fetch(key, 0)
+      Logger.add(3, self.class,  "Label #{key} not found in #{source}") if pos == 0
+      return pos
+    end
+    #If this script is running more the once, the inputlistings would increase.
+    #So we clear it here to a "virgin" state.
+    @text.gsub!( 
+      /%(lstinputlisting\[.*?\]\{(.*?)\})\n.lstinputlisting\[.*?\]\{.*?\}/m,
+      '\\\\\1'
+      )
+    #\ABAPinput is a macro used in a privat package of the author ;-)
+    @text.gsub!( 
+      /%(ABAPinput\[.*?\]\{(.*?)\})\n.ABAPinpu\[.*?\]\{.*?\}/m,
+      '\\\\\1'
+      )
+    
+    sources = Hash.new()	#all Sources
+    #Replace all from/tolabe-listings with the new  first/lastline version.
+    #Remember the original labels in a TeX-comment (needed next time, the programm could change.
+    r = Regexp.new('\\\\(lstinputlisting|ABAPinput)\[.*(?:fromlabel=(.*?))(,.*)*(?:tolabel=(.*?))(,.*)*\]{(.*)}')
+    while m = r.match(@text)
+      old	= m[0]
+      source = m[6]
+      Logger.add(5, self.class, "Found lstinputlisting #{source}")
+      if ! sources.has_key?(source)
+        sources[source] = scan_source( source )
+      end
+      pos1 = get_label(sources[source], m[2], source ) + 1
+      pos2 = get_label(sources[source], m[4], source ) - 1
+      new	= '\\' + m[1] + '[' + 'firstline=' + pos1.to_s + m[3] +
+          'lastline=' + pos2.to_s + m[5].to_s + "]{" + source  + '}'
+      Logger.add(5, self.class,  "Command old:\t#{old}\nCommand new\t#{new}" )
+      @text = m.pre_match + "%#{old[1..-1]}\n" +	new + m.post_match
+    end
+    return @text
+  end	#mix_references
+end	#Precompile
+
+
+class DVIPS< Tool
+  def initialize( filename )
+    super()
+    @filename = filename
+    @logInclude	= false	#Add log-Files
+    @stdoutInclude	= false	#Add the stdout-Files
+    @stderrInclude	= true	#Add the stderr-Files same as ilg-file
+    @first		= true
+  end
+  def rerun?( log = nil )
+    return @first	#Postprocessor runs only once
+  end
+  def execute()
+    @first		= false
+    Logger.add( 5, self.class, "Execute #{Configuration.dvips}")
+    @dataChanged = false	#clear flag
+    stderrOff()
+    result = system( Configuration.dvips(@filename) )
+    stderrOn()
+    @log = get_stderr()
+    put_analyse( analyse( @log ) )
+    if !result
+      Logger.add(1, self.class, "Error executing #{self.class}")
+    end
+    add_stdout( self.class ) if @stdoutInclude
+    add_stderr( self.class ) if @stderrInclude
+    return result
+  end
+  def analyse( log=@log )
+    result = {	'Error'		=> 0,
+        'Warning'		=> 0,
+        'Informationlist' => [],
+        'Errorlist'	=> [],
+        'Warninglist'	=> [],
+      }
+    log.each{ |l|
+      if /This is (.*) Copyright/ =~ l
+        result['Informationlist'] << "Called #{$1}"
+      # check analyses
+      elsif /[Ee]rror/ =~ l
+        result['Error'] += 1
+        result[:error] << "#{l}"
+      elsif /[Ww]arning/ =~ l
+        result['Warning'] += 1
+        result[:warning] << "#{l}"
+      end
+    }
+    return result
+  end
+end	#DVIPS
+
+class PS2PDF< Tool
+  def initialize( filename )
+    super()
+    @filename = filename
+    @logInclude	= false	#Add log-Files
+    @stdoutInclude	= true	#Add the stdout-Files
+    @stderrInclude	= false	#Add the stderr-Files 
+    @first		= true
+  end
+  def rerun?( log = nil )
+    return @first	#Postprocessor runs only once
+  end
+  def execute()
+    @first		= false
+    Logger.add( 5, self.class, "Execute #{self.class} (#{Configuration.ps2pdf})")
+    @dataChanged = false	#clear flag
+    stdoutOff()
+    result = system( Configuration.ps2pdf( @filename ) )
+    stdoutOn()
+    @log = get_stdout()
+    put_analyse( analyse( @log ) )
+    if !result
+      Logger.add(1, self.class, "Error executing #{self.class}")
+    end
+    add_stdout( self.class ) if @stdoutInclude
+    add_stderr( self.class ) if @stderrInclude
+    return result
+  end
+  def analyse( log=@log )
+    result = {	'Error'		=> 0,
+        'Warning'		=> 0,
+        'Informationlist' => [],
+        'Errorlist'	=> [],
+        'Warninglist'	=> [],
+        }
+    log.each{ |l|
+      if /Unable to open the initial device, quitting./ =~ l
+        result['Error'] += 1
+        result[:error] << "Unable to open the initial device (PDF opened in Acrobat?)"
+      elsif /[Ee]rror/ =~ l
+        result['Error'] += 1
+        result[:error] << "#{l}"
+      elsif /[Ww]arning/ =~ l
+        result['Warning'] += 1
+        result[:warning] << "#{l}"
+      end
+    }
+    return result
+  end
+end	#PS2PDF
+
+class DVIPDFM< Tool
+  def initialize( filename )
+    super()
+    @filename = filename
+    @logInclude	= false	#Add log-Files
+    @stdoutInclude	= true	#Add the stdout-Files
+    @stderrInclude	= false	#Add the stderr-Files 
+    @first		= true
+  end
+  def rerun?( log = nil )
+    return @first	#Postprocessor runs only once
+  end
+  def execute()
+    @first		= false
+    Logger.add( 5, self.class, "Execute #{self.class} (#{Configuration.ps2pdf})")
+    @dataChanged = false	#clear flag
+    stdoutOff()
+    result = system( Configuration.dvipdfm( @filename ) )
+    stdoutOn()
+    @log = get_stdout()
+    put_analyse( analyse() )
+    if !result
+      Logger.add(1, self.class, "Error executing #{self.class}")
+    end
+    add_stdout( self.class ) if @stdoutInclude
+    add_stderr( self.class ) if @stderrInclude
+    return result
+  end
+  def analyse( log=@log )
+    result = {	'Error'		=> 0,
+        'Errorlist'	=> [],
+        'Warninglist'	=> [],
+        }
+    log.each{ |l|
+      if /Unable to open the initial device, quitting./ =~ l
+        result['Error'] += 1
+        result[:error] << "Unable to open the initial device (PDF opened in Acrobat?)"
+      elsif /[Ee]rror/ =~ l
+        result['Error'] += 1
+        result[:error] << "#{l}"
+      elsif /[Ww]arning/ =~ l
+        result['Warning'] += 1
+        result[:warning] << "#{l}"
+      end
+    }
+    return result
+  end
+end	#DVIPDFM
+
+

data/lib/catch_output.rb

@@ -0,0 +1,99 @@
+#
+#Catch screen output.
+#Can be used to avoid messages from programms called by system
+#
+#
+
+
+#Class Tempfile for temporary redirection of stdout and stderr
+require "tempfile" 
+
+#Catch screen output.
+#Can be used to avoid messages from programms called by system
+module Catch_output
+  STDOUT_ORIG	= STDOUT.clone()
+  STDERR_ORIG	= STDERR.clone()
+
+
+  #Catch stdout for the given block, but print stderr.
+  def catch_stdout( &block )
+    #~ raise 'no block' unless block_given? 
+    raise 'no block' unless block.is_a?(Proc)
+    stdout, stderr = catch_screen_output( true, false, &block )
+    return stdout
+  end #catch_stdout()
+
+  #Catch stderr for the given block, but print stdout.
+  def catch_stderr( &block )
+    #~ raise 'no block' unless block_given? 
+    raise 'no block' unless block.is_a?(Proc)
+    stdout, stderr = catch_screen_output( false, true, &block )
+    return stderr
+  end #catch_stderr()
+  
+  #Catch the screen output (stdout and stderr) for the given block.
+  #You can set, which output you want to catch.
+  #
+  #Returnvalue is an array with the result of stdout and stderr.
+  #If any output wasn't catched, the return value in the array is nil.
+  def catch_screen_output(
+      catch_stdout = true,
+      catch_stderr = true,
+      stdout_orig	= STDOUT.clone(),
+      stderr_orig	= STDERR.clone()
+      )
+      
+    raise 'no block' unless block_given? 
+       
+    if catch_stdout
+      #Create temporary file for stdout
+      tmpstdout = Tempfile.new( 'stdout')
+      #redirect stdout
+      STDOUT.reopen( tmpstdout ) 
+    end
+    if catch_stderr
+      #Create temporary file for stdout
+      tmpstderr = Tempfile.new( 'stderr')
+      #redirect stdout
+      STDERR.reopen( tmpstderr ) 
+    end
+    
+
+    yield #Execute the block
+    
+    if catch_stdout
+      #stdout is coming again to the screen.
+      tmpstdout.close()    
+      STDOUT.reopen( stdout_orig)
+      
+      # Get the result of stdout
+      tmpstdout.open()
+      stdout = tmpstdout.readlines().join
+      tmpstdout.close()
+    end
+    
+
+    if catch_stderr
+      #stderr is coming again to the screen.
+      tmpstderr.close()    
+      STDERR.reopen( stderr_orig)
+      
+      # Get the result of stderr
+      tmpstderr.open()
+      stderr = tmpstderr.readlines().join
+      tmpstderr.close()
+    end
+    return [ stdout, stderr ]
+  end
+end
+
+
+#Frame to use module Catch_output
+#
+#Example:
+#   Frame_catch_output.catch_stdout{ puts 11 }
+class Frame_catch_output
+  class << self 
+  include Catch_output
+  end
+end

data/lib/runtex.rb

@@ -0,0 +1,221 @@
+#
+#This program translates a (La)TeX-File as often as necessary and
+#gives a log-overview.
+#
+#
+#Some programs with a similar functionalty
+#- texify (miktex)
+
+#- texexec (ConTeXt)
+#- rubber (Python) http://ebeffara.free.fr/stuff/rubber/
+#- texi2pdf (or texi2dvi)
+#- mk Perl script http://www.servalys.nl/tex/mk.html
+#
+#Sometimes 'make' is recommended for this task,
+#but make makes problems with the multiple calls 
+#of LaTeX.
+#
+#This script consider:
+#- index (normal makeindex and multiple indices with indes.sty or splitindex)
+#- glossaries.sty
+#- bibliography
+#- rails and rails.sty
+#- ...
+#
+# %%%%%%%%%%%%%%%%%%%%
+# % License
+# %%%%%%%%%%%%%%%%%%%%
+# %% Copyright 2009 Knut Lickert
+# %
+# % This work may be distributed and/or modified under the
+# % conditions of the LaTeX Project Public License, either version 1.3
+# % of this license or (at your option) any later version.
+# % The latest version of this license is in
+# %   http://www.latex-project.org/lppl.txt
+# % and version 1.3 or later is part of all distributions of LaTeX
+# % version 2005/12/01 or later.
+# %
+# % This work has the LPPL maintenance status `maintained'.
+# % 
+# % The Current Maintainer of this work is Knut Lickert.
+# %
+#
+
+require 'log4r'      
+require 'zip/zip'   #The log files are stored in a zip.
+require 'optparse'
+require 'yaml'
+
+#Some Tools have screen output.
+#runtex should run silent in background, so we have to redirect the output.
+require 'catch_output'
+
+module RunTeX
+CONFIGURATION = File.dirname(__FILE__) + '/runtex_pathes.yaml'
+
+require 'runtex_job_chain'
+require 'runtex_tool'
+require 'runtex_latex'
+require 'runtex_makeindex'
+require 'runtex_splitindex'
+require 'runtex_rail'
+require 'runtex_bibtex'
+end #module runtex
+
+#Analyse from ARGV when called from Desktop
+def start_from_desktop( )
+  
+options = {
+  :format => 'pdflualatex',
+  :overfull => 100, #report overfull boxes > this value
+  :underfull => 9000, #report underfull boxes > this badness
+}
+
+optparser = OptionParser.new{ |opts|
+  opts.banner = <<BANNER
+runtex.rb: Translate a TeX-File.
+    This tool checks, how often the file must be translated to 
+    create a document with correct references.
+    Usage:
+        runtex.rb [switches] source[.tex]
+    
+    Known Problems:
+    - Not tested on different systems (PS2PDF will work only on windows)
+    - The errors statistic count some errors twice 
+    (or do you want to loose errors)
+    - index.sty is not supported. Use index2.sty instead 
+    Detailed informations: http://ruby.lickert.net/runtex
+    
+Switches:
+    -h <switch> for details of option <switch>
+BANNER
+
+  #~ opts.on('-h', '--help' ){ |selection|
+      #~ puts opts.banner()
+      #~ STDIN.getc if @@wait
+      #~ exit	
+  #~ }
+  #~ opts.on('-H', '--HELP' ){ |selection|			
+      #~ puts opt.help( '--HELP' )
+      #~ STDIN.getc if @@wait
+      #~ exit
+  #~ }
+      #~ puts "Option #{option}#{selection} not known\nUse -h for help"
+
+  opts.on('-a', "--action ACTION", '--chain ACTION', %Q|Define the action chain
+    A chain defines the steps from source to the target.
+    - pdfLaTeX	
+    - pdfLuaLaTeX [default]
+    - XeLaTeX
+    - LaTeX
+    - LaTeXPS	Call LaTeX and then create a 
+        Postscript file (dvips)
+    - LaTeXPSPDF	Call LaTeX and then create a PDF 
+        via dvips and ghostscript
+    -LaTeXPDF	Call LaTeX and then create a PDF with dvipdfm
+    remark:	Each tool may define a "subchain"
+      (pdf)LaTeX calls bibtex, makeindex, rail if necessary|.gsub(/^\t/, '')
+    ){ |selection|			
+      selection = '?' if ! selection.respond_to?( :downcase )
+      case selection.downcase 
+      when 'latex', 'pdflatex', 'pdflualatex', 'xelatex'
+        options[:format] = selection.to_sym
+      when 'latexps', 'latexpdf', 'latexpspdf'
+        puts "Sorry, not supported yet"
+      else
+        puts "Action chain #{selection} not valid"
+        STDIN.getc if $stdin.tty? 
+        exit
+      end	#case selection
+  }
+
+  opts.on('-o', "--overfull OVERFULL",
+    "Set the limit, from which overfull boxes are reported"
+    ){ |selection|		
+      options[:overfull] = selection.to_i		
+  }
+
+  opts.on('-u', "--underfull UNDERFULL", "Set the limit, from which underfull boxes are reported"){ |selection|
+      options[:underfull] = selection.to_i	
+  }
+  
+  #~ opts.on('-p', "--precompile PRE", %q|The given file(s) are precompiled.
+    #~ Conversions of the precompiler:
+    #~ - listings.sty:
+      #~ \lstinputlisting[fromlabel=<label>,tolabel=<label>]{file} to 
+      #~ \lstinputlisting[firstline=<num>,lastline=<num>] {file}
+      #~ file must contain tags like "TeXlabel{label}"
+  #~ |.gsub(/^\t/, '')){ |selection|
+      #~ selection.each{|f|
+        #~ Precompile.mix_references!( f )
+        #~ }	
+  #~ }
+  }
+
+  begin
+    optparser.parse!
+  #~ rescue OptionParser::MissingArgument => err
+  #~ rescue OptionParser::InvalidOption => err
+  rescue OptionParser::MissingArgument, OptionParser::InvalidOption => err
+    puts "Error:\t#{err}"
+    #Ausgabe der Schnittstelle
+    puts optparser.banner
+  end
+
+  
+  if ARGV.size == 0
+    #Message if called by exe created with rubyscript2exe
+    puts "Add file to translate or -h for help" if /app.rb/ =~ $0
+  end
+  ARGV.each{|arg|
+    if arg =~ /\.(tex|dtx)$/
+      job = RunTeX::Job_chain.new(arg, options)
+    else
+      job = RunTeX::Job_chain.new("#{arg}.tex", options)
+    end
+    job.log.level = Log4r::WARN
+    job.start(options[:format])
+  }
+
+  if ARGV.empty?
+    puts "No TeX-File given" 
+    exit
+  end
+ 
+  puts "Thanks for using #{File.basename($0)}."
+  STDIN.getc if $stdin.tty?
+
+end	#start_from_desktop( )
+
+start_from_desktop( ) if __FILE__ == $0
+
+__END__
+lox: fixme.sty
+out: hyperref.ste
+tex: TeX-Source-file
+aux: Auxiliary file, created by LaTeX
+toc: table of contents (LaTeX)
+bib: Bibliography, define bib-entries for BibTeX
+bbl: Result of BibTeX
+blg: Logfile from BibTeX
+idx: Index, input for makeindex (LaTeX)
+ind: Index, output from makeindex
+ilg: Logfile by makeindex
+glo: Glossary, definitions for glossaries.sty 
+gls: Glossary, corresponds to ind (glossaries.sty)
+glg: Logfile from glossaries.sty, corresponds to ilg
+ist: Style file for makeindex
+rai: Rail-input file (rail)
+rao: Rail-output file (rail)
+log: logfile (TeX)
+dvi: Result of (La)TeX.
+pdf: Portable document format, result of the tex-run
+sty: Style-file (LaTeX)
+cls: document class definition (LaTeX)
+dtx: source for cls/sty-files. (LaTeX)
+ins: Install-file to create cls/sty from dtx. (LaTeX)
+nav: Help-File Navigation (hyperref?) (LaTeX)
+ps: Post-Script
+eps: encapsulated Post-Script
+lof: List of figures (LaTeX)
+lot: List of tables (LaTeX)