SCons/Tool/pdftex.py

   1 """SCons.Tool.pdftex
   2
   3 Tool-specific initialization for pdftex.
   4 Generates .pdf files from .tex files
   5
   6 There normally shouldn't be any need to import this module directly.
   7 It will usually be imported through the generic SCons.Tool.Tool()
   8 selection method.
   9
  10 """
  11
  12 #
  13 # __COPYRIGHT__
  14 #
  15 # Permission is hereby granted, free of charge, to any person obtaining
  16 # a copy of this software and associated documentation files (the
  17 # "Software"), to deal in the Software without restriction, including
  18 # without limitation the rights to use, copy, modify, merge, publish,
  19 # distribute, sublicense, and/or sell copies of the Software, and to
  20 # permit persons to whom the Software is furnished to do so, subject to
  21 # the following conditions:
  22 #
  23 # The above copyright notice and this permission notice shall be included
  24 # in all copies or substantial portions of the Software.
  25 #
  26 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  27 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  28 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  30 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  31 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  32 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  33 #
  34
  35 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  36
  37 import os
  38 import SCons.Action
  39 import SCons.Util
  40 import SCons.Tool.tex
  41
  42 PDFTeXAction = None
  43
  44 # This action might be needed more than once if we are dealing with
  45 # labels and bibtex.
  46 PDFLaTeXAction = None
  47
  48 def PDFLaTeXAuxAction(target = None, source= None, env=None):
  49     result = SCons.Tool.tex.InternalLaTeXAuxAction( PDFLaTeXAction, target, source, env )
  50     return result
  51
  52 def PDFTeXLaTeXFunction(target = None, source= None, env=None):
  53     """A builder for TeX and LaTeX that scans the source file to
  54     decide the "flavor" of the source and then executes the appropriate
  55     program."""
  56     basedir = os.path.split(str(source[0]))[0]
  57     abspath = os.path.abspath(basedir)
  58
  59     if SCons.Tool.tex.is_LaTeX(source,env,abspath):
  60         result = PDFLaTeXAuxAction(target,source,env)
  61         if result != 0:
  62             SCons.Tool.tex.check_file_error_message(env['PDFLATEX'])
  63     else:
  64         result = PDFTeXAction(target,source,env)
  65         if result != 0:
  66             SCons.Tool.tex.check_file_error_message(env['PDFTEX'])
  67     return result
  68
  69 PDFTeXLaTeXAction = None
  70
  71 def generate(env):
  72     """Add Builders and construction variables for pdftex to an Environment."""
  73     global PDFTeXAction
  74     if PDFTeXAction is None:
  75         PDFTeXAction = SCons.Action.Action('$PDFTEXCOM', '$PDFTEXCOMSTR')
  76
  77     global PDFLaTeXAction
  78     if PDFLaTeXAction is None:
  79         PDFLaTeXAction = SCons.Action.Action("$PDFLATEXCOM", "$PDFLATEXCOMSTR")
  80
  81     global PDFTeXLaTeXAction
  82     if PDFTeXLaTeXAction is None:
  83         PDFTeXLaTeXAction = SCons.Action.Action(PDFTeXLaTeXFunction,
  84                               strfunction=SCons.Tool.tex.TeXLaTeXStrFunction)
  85
  86     env.AppendUnique(LATEXSUFFIXES=SCons.Tool.LaTeXSuffixes)
  87
  88     from . import pdf
  89     pdf.generate(env)
  90
  91     bld = env['BUILDERS']['PDF']
  92     bld.add_action('.tex', PDFTeXLaTeXAction)
  93     bld.add_emitter('.tex', SCons.Tool.tex.tex_pdf_emitter)
  94
  95     # Add the epstopdf builder after the pdftex builder
  96     # so pdftex is the default for no source suffix
  97     pdf.generate2(env)
  98
  99     SCons.Tool.tex.generate_common(env)
 100
 101 def exists(env):
 102     SCons.Tool.tex.generate_darwin(env)
 103     return env.Detect('pdftex')
 104
 105 # Local Variables:
 106 # tab-width:4
 107 # indent-tabs-mode:nil
 108 # End:
 109 # vim: set expandtab tabstop=4 shiftwidth=4: