tools/scons-1.2.0/engine/SCons/Tool/wix.py

   1 """SCons.Tool.wix
   2
   3 Tool-specific initialization for wix, the Windows Installer XML Tool.
   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 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  12 #
  13 # Permission is hereby granted, free of charge, to any person obtaining
  14 # a copy of this software and associated documentation files (the
  15 # "Software"), to deal in the Software without restriction, including
  16 # without limitation the rights to use, copy, modify, merge, publish,
  17 # distribute, sublicense, and/or sell copies of the Software, and to
  18 # permit persons to whom the Software is furnished to do so, subject to
  19 # the following conditions:
  20 #
  21 # The above copyright notice and this permission notice shall be included
  22 # in all copies or substantial portions of the Software.
  23 #
  24 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  25 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  26 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 #
  32
  33 __revision__ = "src/engine/SCons/Tool/wix.py 3842 2008/12/20 22:59:52 scons"
  34
  35 import SCons.Builder
  36 import SCons.Action
  37 import os
  38 import string
  39
  40 def generate(env):
  41     """Add Builders and construction variables for WiX to an Environment."""
  42     if not exists(env):
  43       return
  44
  45     env['WIXCANDLEFLAGS'] = ['-nologo']
  46     env['WIXCANDLEINCLUDE'] = []
  47     env['WIXCANDLECOM'] = '$WIXCANDLE $WIXCANDLEFLAGS -I $WIXCANDLEINCLUDE -o ${TARGET} ${SOURCE}'
  48
  49     env['WIXLIGHTFLAGS'].append( '-nologo' )
  50     env['WIXLIGHTCOM'] = "$WIXLIGHT $WIXLIGHTFLAGS -out ${TARGET} ${SOURCES}"
  51
  52     object_builder = SCons.Builder.Builder(
  53         action      = '$WIXCANDLECOM',
  54         suffix      = '.wxiobj',
  55         src_suffix  = '.wxs')
  56
  57     linker_builder = SCons.Builder.Builder(
  58         action      = '$WIXLIGHTCOM',
  59         src_suffix  = '.wxiobj',
  60         src_builder = object_builder)
  61
  62     env['BUILDERS']['WiX'] = linker_builder
  63
  64 def exists(env):
  65     env['WIXCANDLE'] = 'candle.exe'
  66     env['WIXLIGHT']  = 'light.exe'
  67
  68     # try to find the candle.exe and light.exe tools and
  69     # add the install directory to light libpath.
  70     #for path in os.environ['PATH'].split(os.pathsep):
  71     for path in string.split(os.environ['PATH'], os.pathsep):
  72         if not path:
  73             continue
  74
  75         # workaround for some weird python win32 bug.
  76         if path[0] == '"' and path[-1:]=='"':
  77             path = path[1:-1]
  78
  79         # normalize the path
  80         path = os.path.normpath(path)
  81
  82         # search for the tools in the PATH environment variable
  83         try:
  84             if env['WIXCANDLE'] in os.listdir(path) and\
  85                env['WIXLIGHT']  in os.listdir(path):
  86                    env.PrependENVPath('PATH', path)
  87                    env['WIXLIGHTFLAGS'] = [ os.path.join( path, 'wixui.wixlib' ),
  88                                             '-loc',
  89                                             os.path.join( path, 'WixUI_en-us.wxl' ) ]
  90                    return 1
  91         except OSError:
  92             pass # ignore this, could be a stale PATH entry.
  93
  94     return None