src/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__
  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.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     SCons.Tool.tex.InternalLaTeXAuxAction( PDFLaTeXAction, target, source, env )
  48
  49 def PDFTeXLaTeXFunction(target = None, source= None, env=None):
  50     """A builder for TeX and LaTeX that scans the source file to
  51     decide the "flavor" of the source and then executes the appropriate
  52     program."""
  53     if SCons.Tool.tex.is_LaTeX(source):
  54         PDFLaTeXAuxAction(target,source,env)
  55     else:
  56         PDFTeXAction(target,source,env)
  57     return 0
  58
  59 PDFTeXLaTeXAction = None
  60
  61 def generate(env):
  62     """Add Builders and construction variables for pdftex to an Environment."""
  63     global PDFTeXAction
  64     if PDFTeXAction is None:
  65         PDFTeXAction = SCons.Action.Action('$PDFTEXCOM', '$PDFTEXCOMSTR')
  66
  67     global PDFLaTeXAction
  68     if PDFLaTeXAction is None:
  69         PDFLaTeXAction = SCons.Action.Action("$PDFLATEXCOM", "$PDFLATEXCOMSTR")
  70
  71     global PDFTeXLaTeXAction
  72     if PDFTeXLaTeXAction is None:
  73         PDFTeXLaTeXAction = SCons.Action.Action(PDFTeXLaTeXFunction,
  74                                                 strfunction=None)
  75
  76     import pdf
  77     pdf.generate(env)
  78
  79     bld = env['BUILDERS']['PDF']
  80     bld.add_action('.tex', PDFTeXLaTeXAction)
  81     bld.add_emitter('.tex', SCons.Tool.tex.tex_emitter)
  82
  83     env['PDFTEX']      = 'pdftex'
  84     env['PDFTEXFLAGS'] = SCons.Util.CLVar('')
  85     env['PDFTEXCOM']   = 'cd ${TARGET.dir} && $PDFTEX $PDFTEXFLAGS ${SOURCE.file}'
  86
  87     # Duplicate from latex.py.  If latex.py goes away, then this is still OK.
  88     env['PDFLATEX']      = 'pdflatex'
  89     env['PDFLATEXFLAGS'] = SCons.Util.CLVar('')
  90     env['PDFLATEXCOM']   = 'cd ${TARGET.dir} && $PDFLATEX $PDFLATEXFLAGS ${SOURCE.file}'
  91     env['LATEXRETRIES']  = 3
  92
  93 def exists(env):
  94     return env.Detect('pdftex')