src/engine/SCons/Tool/latex.py

   1 """SCons.Tool.latex
   2
   3 Tool-specific initialization for LaTeX.
   4
   5 There normally shouldn't be any need to import this module directly.
   6 It will usually be imported through the generic SCons.Tool.Tool()
   7 selection method.
   8
   9 """
  10
  11 #
  12 # __COPYRIGHT__
  13 #
  14 # Permission is hereby granted, free of charge, to any person obtaining
  15 # a copy of this software and associated documentation files (the
  16 # "Software"), to deal in the Software without restriction, including
  17 # without limitation the rights to use, copy, modify, merge, publish,
  18 # distribute, sublicense, and/or sell copies of the Software, and to
  19 # permit persons to whom the Software is furnished to do so, subject to
  20 # the following conditions:
  21 #
  22 # The above copyright notice and this permission notice shall be included
  23 # in all copies or substantial portions of the Software.
  24 #
  25 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  26 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  27 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 #
  33
  34 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  35
  36 import SCons.Action
  37 import SCons.Defaults
  38 import SCons.Scanner.LaTeX
  39 import SCons.Util
  40 import SCons.Tool
  41 import SCons.Tool.tex
  42
  43 LaTeXAction = None
  44
  45 def LaTeXAuxFunction(target = None, source= None, env=None):
  46     SCons.Tool.tex.InternalLaTeXAuxAction( LaTeXAction, target, source, env )
  47
  48 LaTeXAuxAction = SCons.Action.Action(LaTeXAuxFunction, strfunction=None)
  49
  50 def generate(env):
  51     """Add Builders and construction variables for LaTeX to an Environment."""
  52     global LaTeXAction
  53     if LaTeXAction is None:
  54         LaTeXAction = SCons.Action.Action('$LATEXCOM', '$LATEXCOMSTR')
  55
  56     import dvi
  57     dvi.generate(env)
  58
  59     bld = env['BUILDERS']['DVI']
  60     bld.add_action('.ltx', LaTeXAuxAction)
  61     bld.add_action('.latex', LaTeXAuxAction)
  62     bld.add_emitter('.ltx', SCons.Tool.tex.tex_emitter)
  63     bld.add_emitter('.latex', SCons.Tool.tex.tex_emitter)
  64
  65     env['LATEX']        = 'latex'
  66     env['LATEXFLAGS']   = SCons.Util.CLVar('')
  67     env['LATEXCOM']     = 'cd ${TARGET.dir} && $LATEX $LATEXFLAGS ${SOURCE.file}'
  68     env['LATEXRETRIES'] = 3
  69
  70 def exists(env):
  71     return env.Detect('latex')