scons/custom.py

   1 """custom
   2
   3 Custom builders and methods.
   4
   5 """
   6
   7 #
   8 # Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   9 # All Rights Reserved.
  10 #
  11 # Permission is hereby granted, free of charge, to any person obtaining a
  12 # copy of this software and associated documentation files (the
  13 # "Software"), to deal in the Software without restriction, including
  14 # without limitation the rights to use, copy, modify, merge, publish,
  15 # distribute, sub license, and/or sell copies of the Software, and to
  16 # permit persons to whom the Software is furnished to do so, subject to
  17 # the following conditions:
  18 #
  19 # The above copyright notice and this permission notice (including the
  20 # next paragraph) shall be included in all copies or substantial portions
  21 # of the Software.
  22 #
  23 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  24 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  26 # IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  27 # ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  28 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  29 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 #
  31
  32
  33 import os
  34 import os.path
  35 import re
  36 import sys
  37 import subprocess
  38
  39 import SCons.Action
  40 import SCons.Builder
  41 import SCons.Scanner
  42
  43 import fixes
  44
  45 import source_list
  46
  47 def quietCommandLines(env):
  48     # Quiet command lines
  49     # See also http://www.scons.org/wiki/HidingCommandLinesInOutput
  50     env['ASCOMSTR'] = "  Assembling $SOURCE ..."
  51     env['ASPPCOMSTR'] = "  Assembling $SOURCE ..."
  52     env['CCCOMSTR'] = "  Compiling $SOURCE ..."
  53     env['SHCCCOMSTR'] = "  Compiling $SOURCE ..."
  54     env['CXXCOMSTR'] = "  Compiling $SOURCE ..."
  55     env['SHCXXCOMSTR'] = "  Compiling $SOURCE ..."
  56     env['ARCOMSTR'] = "  Archiving $TARGET ..."
  57     env['RANLIBCOMSTR'] = "  Indexing $TARGET ..."
  58     env['LINKCOMSTR'] = "  Linking $TARGET ..."
  59     env['SHLINKCOMSTR'] = "  Linking $TARGET ..."
  60     env['LDMODULECOMSTR'] = "  Linking $TARGET ..."
  61     env['SWIGCOMSTR'] = "  Generating $TARGET ..."
  62     env['LEXCOMSTR'] = "  Generating $TARGET ..."
  63     env['YACCCOMSTR'] = "  Generating $TARGET ..."
  64     env['CODEGENCOMSTR'] = "  Generating $TARGET ..."
  65     env['INSTALLSTR'] = "  Installing $TARGET ..."
  66
  67
  68 def createConvenienceLibBuilder(env):
  69     """This is a utility function that creates the ConvenienceLibrary
  70     Builder in an Environment if it is not there already.
  71
  72     If it is already there, we return the existing one.
  73
  74     Based on the stock StaticLibrary and SharedLibrary builders.
  75     """
  76
  77     try:
  78         convenience_lib = env['BUILDERS']['ConvenienceLibrary']
  79     except KeyError:
  80         action_list = [ SCons.Action.Action("$ARCOM", "$ARCOMSTR") ]
  81         if env.Detect('ranlib'):
  82             ranlib_action = SCons.Action.Action("$RANLIBCOM", "$RANLIBCOMSTR")
  83             action_list.append(ranlib_action)
  84
  85         convenience_lib = SCons.Builder.Builder(action = action_list,
  86                                   emitter = '$LIBEMITTER',
  87                                   prefix = '$LIBPREFIX',
  88                                   suffix = '$LIBSUFFIX',
  89                                   src_suffix = '$SHOBJSUFFIX',
  90                                   src_builder = 'SharedObject')
  91         env['BUILDERS']['ConvenienceLibrary'] = convenience_lib
  92
  93     return convenience_lib
  94
  95
  96 # TODO: handle import statements with multiple modules
  97 # TODO: handle from import statements
  98 import_re = re.compile(r'^import\s+(\S+)$', re.M)
  99
 100 def python_scan(node, env, path):
 101     # http://www.scons.org/doc/0.98.5/HTML/scons-user/c2781.html#AEN2789
 102     contents = node.get_contents()
 103     source_dir = node.get_dir()
 104     imports = import_re.findall(contents)
 105     results = []
 106     for imp in imports:
 107         for dir in path:
 108             file = os.path.join(str(dir), imp.replace('.', os.sep) + '.py')
 109             if os.path.exists(file):
 110                 results.append(env.File(file))
 111                 break
 112             file = os.path.join(str(dir), imp.replace('.', os.sep), '__init__.py')
 113             if os.path.exists(file):
 114                 results.append(env.File(file))
 115                 break
 116     return results
 117
 118 python_scanner = SCons.Scanner.Scanner(function = python_scan, skeys = ['.py'])
 119
 120
 121 def code_generate(env, script, target, source, command):
 122     """Method to simplify code generation via python scripts.
 123
 124     http://www.scons.org/wiki/UsingCodeGenerators
 125     http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
 126     """
 127
 128     # We're generating code using Python scripts, so we have to be
 129     # careful with our scons elements.  This entry represents
 130     # the generator file *in the source directory*.
 131     script_src = env.File(script).srcnode()
 132
 133     # This command creates generated code *in the build directory*.
 134     command = command.replace('$SCRIPT', script_src.path)
 135     action = SCons.Action.Action(command, "$CODEGENCOMSTR")
 136     code = env.Command(target, source, action)
 137
 138     # Explicitly mark that the generated code depends on the generator,
 139     # and on implicitly imported python modules
 140     path = (script_src.get_dir(),)
 141     deps = [script_src]
 142     deps += script_src.get_implicit_deps(env, python_scanner, path)
 143     env.Depends(code, deps)
 144
 145     # Running the Python script causes .pyc files to be generated in the
 146     # source directory.  When we clean up, they should go too. So add side
 147     # effects for .pyc files
 148     for dep in deps:
 149         pyc = env.File(str(dep) + 'c')
 150         env.SideEffect(pyc, code)
 151
 152     return code
 153
 154
 155 def createCodeGenerateMethod(env):
 156     env.Append(SCANNERS = python_scanner)
 157     env.AddMethod(code_generate, 'CodeGenerate')
 158
 159
 160 def _pkg_check_modules(env, name, modules):
 161     '''Simple wrapper for pkg-config.'''
 162
 163     env['HAVE_' + name] = False
 164
 165     # For backwards compatability
 166     env[name.lower()] = False
 167
 168     if env['platform'] == 'windows':
 169         return
 170
 171     if not env.Detect('pkg-config'):
 172         return
 173
 174     if subprocess.call(["pkg-config", "--exists", ' '.join(modules)]) != 0:
 175         return
 176
 177     # Other flags may affect the compilation of unrelated targets, so store
 178     # them with a prefix, (e.g., XXX_CFLAGS, XXX_LIBS, etc)
 179     try:
 180         flags = env.ParseFlags('!pkg-config --cflags --libs ' + ' '.join(modules))
 181     except OSError:
 182         return
 183     prefix = name + '_'
 184     for flag_name, flag_value in flags.iteritems():
 185         assert '_' not in flag_name
 186         env[prefix + flag_name] = flag_value
 187
 188     env['HAVE_' + name] = True
 189
 190 def pkg_check_modules(env, name, modules):
 191
 192     sys.stdout.write('Checking for %s...' % name)
 193     _pkg_check_modules(env, name, modules)
 194     result = env['HAVE_' + name]
 195     sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
 196
 197     # XXX: For backwards compatability
 198     env[name.lower()] = result
 199
 200
 201 def pkg_use_modules(env, names):
 202     '''Search for all environment flags that match NAME_FOO and append them to
 203     the FOO environment variable.'''
 204
 205     names = env.Flatten(names)
 206
 207     for name in names:
 208         prefix = name + '_'
 209
 210         if not 'HAVE_' + name in env:
 211             print 'Attempt to use unknown module %s' % name
 212             env.Exit(1)
 213
 214         if not env['HAVE_' + name]:
 215             print 'Attempt to use unavailable module %s' % name
 216             env.Exit(1)
 217
 218         flags = {}
 219         for flag_name, flag_value in env.Dictionary().iteritems():
 220             if flag_name.startswith(prefix):
 221                 flag_name = flag_name[len(prefix):]
 222                 if '_' not in flag_name:
 223                     flags[flag_name] = flag_value
 224         if flags:
 225             env.MergeFlags(flags)
 226
 227
 228 def createPkgConfigMethods(env):
 229     env.AddMethod(pkg_check_modules, 'PkgCheckModules')
 230     env.AddMethod(pkg_use_modules, 'PkgUseModules')
 231
 232
 233 def parse_source_list(env, filename, names=None):
 234     # parse the source list file
 235     parser = source_list.SourceListParser()
 236     src = env.File(filename).srcnode()
 237     sym_table = parser.parse(src.abspath)
 238
 239     if names:
 240         if isinstance(names, basestring):
 241             names = [names]
 242
 243         symbols = names
 244     else:
 245         symbols = sym_table.keys()
 246
 247     # convert the symbol table to source lists
 248     src_lists = {}
 249     for sym in symbols:
 250         val = sym_table[sym]
 251         src_lists[sym] = [f for f in val.split(' ') if f]
 252
 253     # if names are given, concatenate the lists
 254     if names:
 255         srcs = []
 256         for name in names:
 257             srcs.extend(src_lists[name])
 258
 259         return srcs
 260     else:
 261         return src_lists
 262
 263 def createParseSourceListMethod(env):
 264     env.AddMethod(parse_source_list, 'ParseSourceList')
 265
 266
 267 def generate(env):
 268     """Common environment generation code"""
 269
 270     verbose = env.get('verbose', False) or not env.get('quiet', True)
 271     if not verbose:
 272         quietCommandLines(env)
 273
 274     # Custom builders and methods
 275     createConvenienceLibBuilder(env)
 276     createCodeGenerateMethod(env)
 277     createPkgConfigMethods(env)
 278     createParseSourceListMethod(env)
 279
 280     # for debugging
 281     #print env.Dump()
 282
 283
 284 def exists(env):
 285     return 1