3 Tool-specific initialization for dvipdf.
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/dvipdf.py 3842 2008/12/20 22:59:52 scons"
42 _null = SCons.Scanner.LaTeX._null
44 def DviPdfPsFunction(XXXDviAction, target = None, source= None, env=None):
45 """A builder for DVI files that sets the TEXPICTS environment
46 variable before running dvi2ps or dvipdf."""
49 abspath = source[0].attributes.path
50 except AttributeError :
53 saved_env = SCons.Scanner.LaTeX.modify_env_var(env, 'TEXPICTS', abspath)
55 result = XXXDviAction(target, source, env)
57 if saved_env is _null:
59 del env['ENV']['TEXPICTS']
63 env['ENV']['TEXPICTS'] = saved_env
67 def DviPdfFunction(target = None, source= None, env=None):
68 result = DviPdfPsFunction(PDFAction,target,source,env)
71 def DviPdfStrFunction(target = None, source= None, env=None):
72 """A strfunction for dvipdf that returns the appropriate
73 command string for the no_exec options."""
74 if env.GetOption("no_exec"):
75 result = env.subst('$DVIPDFCOM',0,target,source)
83 def PDFEmitter(target, source, env):
84 """Strips any .aux or .log files from the input source list.
85 These are created by the TeX Builder that in all likelihood was
86 used to generate the .dvi file we're using as input, and we only
87 care about the .dvi file.
89 def strip_suffixes(n):
90 return not SCons.Util.splitext(str(n))[1] in ['.aux', '.log']
91 source = filter(strip_suffixes, source)
92 return (target, source)
95 """Add Builders and construction variables for dvipdf to an Environment."""
98 PDFAction = SCons.Action.Action('$DVIPDFCOM', '$DVIPDFCOMSTR')
101 if DVIPDFAction is None:
102 DVIPDFAction = SCons.Action.Action(DviPdfFunction, strfunction = DviPdfStrFunction)
107 bld = env['BUILDERS']['PDF']
108 bld.add_action('.dvi', DVIPDFAction)
109 bld.add_emitter('.dvi', PDFEmitter)
111 env['DVIPDF'] = 'dvipdf'
112 env['DVIPDFFLAGS'] = SCons.Util.CLVar('')
113 env['DVIPDFCOM'] = 'cd ${TARGET.dir} && $DVIPDF $DVIPDFFLAGS ${SOURCE.file} ${TARGET.file}'
115 # Deprecated synonym.
116 env['PDFCOM'] = ['$DVIPDFCOM']
119 return env.Detect('dvipdf')