SCons/Tool/pdflatex.py

   1 """SCons.Tool.pdflatex
   2
   3 Tool-specific initialization for pdflatex.
   4 Generates .pdf files from .latex or .ltx 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 SCons.Action
  38 import SCons.Util
  39 import SCons.Tool.pdf
  40 import SCons.Tool.tex
  41
  42 PDFLaTeXAction = None
  43
  44 def PDFLaTeXAuxFunction(target = None, source= None, env=None):
  45     result = SCons.Tool.tex.InternalLaTeXAuxAction( PDFLaTeXAction, target, source, env )
  46     if result != 0:
  47         SCons.Tool.tex.check_file_error_message(env['PDFLATEX'])
  48     return result
  49
  50 PDFLaTeXAuxAction = None
  51
  52 def generate(env) -> None:
  53     """Add Builders and construction variables for pdflatex to an Environment."""
  54     global PDFLaTeXAction
  55     if PDFLaTeXAction is None:
  56         PDFLaTeXAction = SCons.Action.Action('$PDFLATEXCOM', '$PDFLATEXCOMSTR')
  57
  58     global PDFLaTeXAuxAction
  59     if PDFLaTeXAuxAction is None:
  60         PDFLaTeXAuxAction = SCons.Action.Action(PDFLaTeXAuxFunction,
  61                               strfunction=SCons.Tool.tex.TeXLaTeXStrFunction)
  62
  63     env.AppendUnique(LATEXSUFFIXES=SCons.Tool.LaTeXSuffixes)
  64
  65     from . import pdf
  66     pdf.generate(env)
  67
  68     bld = env['BUILDERS']['PDF']
  69     bld.add_action('.ltx', PDFLaTeXAuxAction)
  70     bld.add_action('.latex', PDFLaTeXAuxAction)
  71     bld.add_emitter('.ltx', SCons.Tool.tex.tex_pdf_emitter)
  72     bld.add_emitter('.latex', SCons.Tool.tex.tex_pdf_emitter)
  73
  74     SCons.Tool.tex.generate_common(env)
  75
  76 def exists(env):
  77     SCons.Tool.tex.generate_darwin(env)
  78     return env.Detect('pdflatex')
  79
  80 # Local Variables:
  81 # tab-width:4
  82 # indent-tabs-mode:nil
  83 # End:
  84 # vim: set expandtab tabstop=4 shiftwidth=4: