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.Builder
  38 import SCons.Platform
  39 import SCons.Util
  40
  41 # Ghostscript goes by different names on different platforms...
  42 platform = SCons.Platform.platform_default()
  43
  44 if platform == 'os2':
  45     gs = 'gsos2'
  46 elif platform == 'win32':
  47     gs = 'gswin32c'
  48 else:
  49     gs = 'gs'
  50
  51 GhostscriptAction = None
  52
  53 def generate(env) -> None:
  54     """Add Builders and construction variables for Ghostscript to an
  55     Environment."""
  56     global GhostscriptAction
  57     # The following try-except block enables us to use the Tool
  58     # in standalone mode (without the accompanying pdf.py),
  59     # whenever we need an explicit call of gs via the Gs()
  60     # Builder ...
  61     try:
  62         if GhostscriptAction is None:
  63             GhostscriptAction = SCons.Action.Action('$GSCOM', '$GSCOMSTR')
  64
  65         from SCons.Tool import pdf
  66         pdf.generate(env)
  67
  68         bld = env['BUILDERS']['PDF']
  69         bld.add_action('.ps', GhostscriptAction)
  70     except ImportError as e:
  71         pass
  72
  73     gsbuilder = SCons.Builder.Builder(action = SCons.Action.Action('$GSCOM', '$GSCOMSTR'))
  74     env['BUILDERS']['Gs'] = gsbuilder
  75
  76     env['GS']      = gs
  77     env['GSFLAGS'] = SCons.Util.CLVar('-dNOPAUSE -dBATCH -sDEVICE=pdfwrite')
  78     env['GSCOM']   = '$GS $GSFLAGS -sOutputFile=$TARGET $SOURCES'
  79
  80
  81 def exists(env):
  82     if 'PS2PDF' in env:
  83         return env.Detect(env['PS2PDF'])
  84     else:
  85         return env.Detect(gs) or SCons.Util.WhereIs(gs)
  86
  87 # Local Variables:
  88 # tab-width:4
  89 # indent-tabs-mode:nil
  90 # End:
  91 # vim: set expandtab tabstop=4 shiftwidth=4: