1"""SCons.Tool.dvipdf
2
3Tool-specific initialization for dvipdf.
4
5There normally shouldn't be any need to import this module directly.
6It will usually be imported through the generic SCons.Tool.Tool()
7selection method.
8
9"""
10
11#
12# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation
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
34__revision__ = "src/engine/SCons/Tool/dvipdf.py 4369 2009/09/19 15:58:29 scons"
35
36import SCons.Action
37import SCons.Defaults
38import SCons.Tool.pdf
39import SCons.Tool.tex
40import SCons.Util
41
42_null = SCons.Scanner.LaTeX._null
43
44def 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."""
47
48    try:
49        abspath = source[0].attributes.path
50    except AttributeError :
51        abspath =  ''
52
53    saved_env = SCons.Scanner.LaTeX.modify_env_var(env, 'TEXPICTS', abspath)
54
55    result = XXXDviAction(target, source, env)
56
57    if saved_env is _null:
58        try:
59            del env['ENV']['TEXPICTS']
60        except KeyError:
61            pass # was never set
62    else:
63        env['ENV']['TEXPICTS'] = saved_env
64
65    return result
66
67def DviPdfFunction(target = None, source= None, env=None):
68    result = DviPdfPsFunction(PDFAction,target,source,env)
69    return result
70
71def 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)
76    else:
77        result = ''
78    return result
79
80PDFAction = None
81DVIPDFAction = None
82
83def 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.
88    """
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)
93
94def generate(env):
95    """Add Builders and construction variables for dvipdf to an Environment."""
96    global PDFAction
97    if PDFAction is None:
98        PDFAction = SCons.Action.Action('$DVIPDFCOM', '$DVIPDFCOMSTR')
99
100    global DVIPDFAction
101    if DVIPDFAction is None:
102        DVIPDFAction = SCons.Action.Action(DviPdfFunction, strfunction = DviPdfStrFunction)
103
104    import pdf
105    pdf.generate(env)
106
107    bld = env['BUILDERS']['PDF']
108    bld.add_action('.dvi', DVIPDFAction)
109    bld.add_emitter('.dvi', PDFEmitter)
110
111    env['DVIPDF']      = 'dvipdf'
112    env['DVIPDFFLAGS'] = SCons.Util.CLVar('')
113    env['DVIPDFCOM']   = 'cd ${TARGET.dir} && $DVIPDF $DVIPDFFLAGS ${SOURCE.file} ${TARGET.file}'
114
115    # Deprecated synonym.
116    env['PDFCOM']      = ['$DVIPDFCOM']
117
118def exists(env):
119    return env.Detect('dvipdf')
120
121# Local Variables:
122# tab-width:4
123# indent-tabs-mode:nil
124# End:
125# vim: set expandtab tabstop=4 shiftwidth=4:
126