3 Tool-specific initialization for pdflatex.
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()
12 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
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:
22 # The above copyright notice and this permission notice shall be included
23 # in all copies or substantial portions of the Software.
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.
34 __revision__ = "src/engine/SCons/Tool/pdflatex.py 3842 2008/12/20 22:59:52 scons"
43 def PDFLaTeXAuxFunction(target = None, source= None, env=None):
44 result = SCons.Tool.tex.InternalLaTeXAuxAction( PDFLaTeXAction, target, source, env )
47 PDFLaTeXAuxAction = None
50 """Add Builders and construction variables for pdflatex to an Environment."""
52 if PDFLaTeXAction is None:
53 PDFLaTeXAction = SCons.Action.Action('$PDFLATEXCOM', '$PDFLATEXCOMSTR')
55 global PDFLaTeXAuxAction
56 if PDFLaTeXAuxAction is None:
57 PDFLaTeXAuxAction = SCons.Action.Action(PDFLaTeXAuxFunction,
58 strfunction=SCons.Tool.tex.TeXLaTeXStrFunction)
63 bld = env['BUILDERS']['PDF']
64 bld.add_action('.ltx', PDFLaTeXAuxAction)
65 bld.add_action('.latex', PDFLaTeXAuxAction)
66 bld.add_emitter('.ltx', SCons.Tool.tex.tex_pdf_emitter)
67 bld.add_emitter('.latex', SCons.Tool.tex.tex_pdf_emitter)
69 env['PDFLATEX'] = 'pdflatex'
70 env['PDFLATEXFLAGS'] = SCons.Util.CLVar('-interaction=nonstopmode')
71 env['PDFLATEXCOM'] = 'cd ${TARGET.dir} && $PDFLATEX $PDFLATEXFLAGS ${SOURCE.file}'
72 env['LATEXRETRIES'] = 3
75 return env.Detect('pdflatex')