b8e9c6f94cce6a04e4145e0358a19031bbcbc7bf
[scons.git] / src / engine / SCons / Tool / gs.py
1 """SCons.Tool.gs
2
3 Tool-specific initialization for Ghostscript.
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
34 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
35
36 import SCons.Action
37 import SCons.Platform
38 import SCons.Util
39
40 # Ghostscript goes by different names on different platforms...
41 platform = SCons.Platform.platform_default()
42
43 if platform == 'os2':
44     gs = 'gsos2'
45 elif platform == 'win32':
46     gs = 'gswin32c'
47 else:
48     gs = 'gs'
49
50 GhostscriptAction = None
51
52 def generate(env):
53     """Add Builders and construction variables for Ghostscript to an
54     Environment."""
55
56     global GhostscriptAction
57     if GhostscriptAction is None:
58         GhostscriptAction = SCons.Action.Action('$GSCOM', '$GSCOMSTR')
59
60     import pdf
61     pdf.generate(env)
62
63     bld = env['BUILDERS']['PDF']
64     bld.add_action('.ps', GhostscriptAction)
65
66     env['GS']      = gs
67     env['GSFLAGS'] = SCons.Util.CLVar('-dNOPAUSE -dBATCH -sDEVICE=pdfwrite')
68     env['GSCOM']   = '$GS $GSFLAGS -sOutputFile=$TARGET $SOURCES'
69
70
71 def exists(env):
72     if env.has_key('PS2PDF'):
73         return env.Detect(env['PS2PDF'])
74     else:
75         return env.Detect(gs) or SCons.Util.WhereIs(gs)