SCons/Tool/dvipdf.py

   1 """SCons.Tool.dvipdf
   2
   3 Tool-specific initialization for dvipdf.
   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 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  34
  35 import SCons.Action
  36 import SCons.Defaults
  37 import SCons.Tool.pdf
  38 import SCons.Tool.tex
  39 import SCons.Util
  40
  41 _null = SCons.Scanner.LaTeX._null
  42
  43 def DviPdfPsFunction(XXXDviAction, target = None, source= None, env=None):
  44     """A builder for DVI files that sets the TEXPICTS environment
  45        variable before running dvi2ps or dvipdf."""
  46
  47     try:
  48         abspath = source[0].attributes.path
  49     except AttributeError :
  50         abspath =  ''
  51
  52     saved_env = SCons.Scanner.LaTeX.modify_env_var(env, 'TEXPICTS', abspath)
  53
  54     result = XXXDviAction(target, source, env)
  55
  56     if saved_env is _null:
  57         try:
  58             del env['ENV']['TEXPICTS']
  59         except KeyError:
  60             pass # was never set
  61     else:
  62         env['ENV']['TEXPICTS'] = saved_env
  63
  64     return result
  65
  66 def DviPdfFunction(target = None, source= None, env=None):
  67     result = DviPdfPsFunction(PDFAction,target,source,env)
  68     return result
  69
  70 def DviPdfStrFunction(target = None, source= None, env=None):
  71     """A strfunction for dvipdf that returns the appropriate
  72     command string for the no_exec options."""
  73     if env.GetOption("no_exec"):
  74         result = env.subst('$DVIPDFCOM',0,target,source)
  75     else:
  76         result = ''
  77     return result
  78
  79 PDFAction = None
  80 DVIPDFAction = None
  81
  82 def PDFEmitter(target, source, env):
  83     """Strips any .aux or .log files from the input source list.
  84     These are created by the TeX Builder that in all likelihood was
  85     used to generate the .dvi file we're using as input, and we only
  86     care about the .dvi file.
  87     """
  88     def strip_suffixes(n) -> bool:
  89         return not SCons.Util.splitext(str(n))[1] in ['.aux', '.log']
  90     source = [src for src in source if strip_suffixes(src)]
  91     return (target, source)
  92
  93 def generate(env) -> None:
  94     """Add Builders and construction variables for dvipdf to an Environment."""
  95     global PDFAction
  96     if PDFAction is None:
  97         PDFAction = SCons.Action.Action('$DVIPDFCOM', '$DVIPDFCOMSTR')
  98
  99     global DVIPDFAction
 100     if DVIPDFAction is None:
 101         DVIPDFAction = SCons.Action.Action(DviPdfFunction, strfunction = DviPdfStrFunction)
 102
 103     from . import pdf
 104     pdf.generate(env)
 105
 106     bld = env['BUILDERS']['PDF']
 107     bld.add_action('.dvi', DVIPDFAction)
 108     bld.add_emitter('.dvi', PDFEmitter)
 109
 110     env['DVIPDF']      = 'dvipdf'
 111     env['DVIPDFFLAGS'] = SCons.Util.CLVar('')
 112     env['DVIPDFCOM']   = 'cd ${TARGET.dir} && $DVIPDF $DVIPDFFLAGS ${SOURCE.file} ${TARGET.file}'
 113
 114 def exists(env):
 115     SCons.Tool.tex.generate_darwin(env)
 116     return env.Detect('dvipdf')
 117
 118 # Local Variables:
 119 # tab-width:4
 120 # indent-tabs-mode:nil
 121 # End:
 122 # vim: set expandtab tabstop=4 shiftwidth=4: