tools/scons-1.2.0/engine/SCons/Tool/pdftex.py

   1 """SCons.Tool.pdftex
   2
   3 Tool-specific initialization for pdftex.
   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 (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  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__ = "src/engine/SCons/Tool/pdftex.py 3842 2008/12/20 22:59:52 scons"
  35
  36 import SCons.Action
  37 import SCons.Util
  38 import SCons.Tool.tex
  39
  40 PDFTeXAction = None
  41
  42 # This action might be needed more than once if we are dealing with
  43 # labels and bibtex.
  44 PDFLaTeXAction = None
  45
  46 def PDFLaTeXAuxAction(target = None, source= None, env=None):
  47     result = SCons.Tool.tex.InternalLaTeXAuxAction( PDFLaTeXAction, target, source, env )
  48     return result
  49
  50 def PDFTeXLaTeXFunction(target = None, source= None, env=None):
  51     """A builder for TeX and LaTeX that scans the source file to
  52     decide the "flavor" of the source and then executes the appropriate
  53     program."""
  54     if SCons.Tool.tex.is_LaTeX(source):
  55         result = PDFLaTeXAuxAction(target,source,env)
  56     else:
  57         result = PDFTeXAction(target,source,env)
  58     return result
  59
  60 PDFTeXLaTeXAction = None
  61
  62 def generate(env):
  63     """Add Builders and construction variables for pdftex to an Environment."""
  64     global PDFTeXAction
  65     if PDFTeXAction is None:
  66         PDFTeXAction = SCons.Action.Action('$PDFTEXCOM', '$PDFTEXCOMSTR')
  67
  68     global PDFLaTeXAction
  69     if PDFLaTeXAction is None:
  70         PDFLaTeXAction = SCons.Action.Action("$PDFLATEXCOM", "$PDFLATEXCOMSTR")
  71
  72     global PDFTeXLaTeXAction
  73     if PDFTeXLaTeXAction is None:
  74         PDFTeXLaTeXAction = SCons.Action.Action(PDFTeXLaTeXFunction,
  75                               strfunction=SCons.Tool.tex.TeXLaTeXStrFunction)
  76
  77     import pdf
  78     pdf.generate(env)
  79
  80     bld = env['BUILDERS']['PDF']
  81     bld.add_action('.tex', PDFTeXLaTeXAction)
  82     bld.add_emitter('.tex', SCons.Tool.tex.tex_pdf_emitter)
  83
  84     # Add the epstopdf builder after the pdftex builder
  85     # so pdftex is the default for no source suffix
  86     pdf.generate2(env)
  87
  88     env['PDFTEX']      = 'pdftex'
  89     env['PDFTEXFLAGS'] = SCons.Util.CLVar('-interaction=nonstopmode')
  90     env['PDFTEXCOM']   = 'cd ${TARGET.dir} && $PDFTEX $PDFTEXFLAGS ${SOURCE.file}'
  91
  92     # Duplicate from latex.py.  If latex.py goes away, then this is still OK.
  93     env['PDFLATEX']      = 'pdflatex'
  94     env['PDFLATEXFLAGS'] = SCons.Util.CLVar('-interaction=nonstopmode')
  95     env['PDFLATEXCOM']   = 'cd ${TARGET.dir} && $PDFLATEX $PDFLATEXFLAGS ${SOURCE.file}'
  96     env['LATEXRETRIES']  = 3
  97
  98 def exists(env):
  99     return env.Detect('pdftex')