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
  37 import SCons.Action
  38 import SCons.Builder
  39 import SCons.Scanner
  40
  41 import fixes
  42
  43
  44 def quietCommandLines(env):
  45     # Quiet command lines
  46     # See also http://www.scons.org/wiki/HidingCommandLinesInOutput
  47     env['ASCOMSTR'] = "  Assembling $SOURCE ..."
  48     env['ASPPCOMSTR'] = "  Assembling $SOURCE ..."
  49     env['CCCOMSTR'] = "  Compiling $SOURCE ..."
  50     env['SHCCCOMSTR'] = "  Compiling $SOURCE ..."
  51     env['CXXCOMSTR'] = "  Compiling $SOURCE ..."
  52     env['SHCXXCOMSTR'] = "  Compiling $SOURCE ..."
  53     env['ARCOMSTR'] = "  Archiving $TARGET ..."
  54     env['RANLIBCOMSTR'] = "  Indexing $TARGET ..."
  55     env['LINKCOMSTR'] = "  Linking $TARGET ..."
  56     env['SHLINKCOMSTR'] = "  Linking $TARGET ..."
  57     env['LDMODULECOMSTR'] = "  Linking $TARGET ..."
  58     env['SWIGCOMSTR'] = "  Generating $TARGET ..."
  59
  60
  61 def createConvenienceLibBuilder(env):
  62     """This is a utility function that creates the ConvenienceLibrary
  63     Builder in an Environment if it is not there already.
  64
  65     If it is already there, we return the existing one.
  66
  67     Based on the stock StaticLibrary and SharedLibrary builders.
  68     """
  69
  70     try:
  71         convenience_lib = env['BUILDERS']['ConvenienceLibrary']
  72     except KeyError:
  73         action_list = [ SCons.Action.Action("$ARCOM", "$ARCOMSTR") ]
  74         if env.Detect('ranlib'):
  75             ranlib_action = SCons.Action.Action("$RANLIBCOM", "$RANLIBCOMSTR")
  76             action_list.append(ranlib_action)
  77
  78         convenience_lib = SCons.Builder.Builder(action = action_list,
  79                                   emitter = '$LIBEMITTER',
  80                                   prefix = '$LIBPREFIX',
  81                                   suffix = '$LIBSUFFIX',
  82                                   src_suffix = '$SHOBJSUFFIX',
  83                                   src_builder = 'SharedObject')
  84         env['BUILDERS']['ConvenienceLibrary'] = convenience_lib
  85
  86     return convenience_lib
  87
  88
  89 # TODO: handle import statements with multiple modules
  90 # TODO: handle from import statements
  91 import_re = re.compile(r'^import\s+(\S+)$', re.M)
  92
  93 def python_scan(node, env, path):
  94     # http://www.scons.org/doc/0.98.5/HTML/scons-user/c2781.html#AEN2789
  95     contents = node.get_contents()
  96     source_dir = node.get_dir()
  97     imports = import_re.findall(contents)
  98     results = []
  99     for imp in imports:
 100         for dir in path:
 101             file = os.path.join(str(dir), imp.replace('.', os.sep) + '.py')
 102             if os.path.exists(file):
 103                 results.append(env.File(file))
 104                 break
 105             file = os.path.join(str(dir), imp.replace('.', os.sep), '__init__.py')
 106             if os.path.exists(file):
 107                 results.append(env.File(file))
 108                 break
 109     return results
 110
 111 python_scanner = SCons.Scanner.Scanner(function = python_scan, skeys = ['.py'])
 112
 113
 114 def code_generate(env, script, target, source, command):
 115     """Method to simplify code generation via python scripts.
 116
 117     http://www.scons.org/wiki/UsingCodeGenerators
 118     http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
 119     """
 120
 121     # We're generating code using Python scripts, so we have to be
 122     # careful with our scons elements.  This entry represents
 123     # the generator file *in the source directory*.
 124     script_src = env.File(script).srcnode()
 125
 126     # This command creates generated code *in the build directory*.
 127     command = command.replace('$SCRIPT', script_src.path)
 128     code = env.Command(target, source, command)
 129
 130     # Explicitly mark that the generated code depends on the generator,
 131     # and on implicitly imported python modules
 132     path = (script_src.get_dir(),)
 133     deps = [script_src]
 134     deps += script_src.get_implicit_deps(env, python_scanner, path)
 135     env.Depends(code, deps)
 136
 137     # Running the Python script causes .pyc files to be generated in the
 138     # source directory.  When we clean up, they should go too. So add side
 139     # effects for .pyc files
 140     for dep in deps:
 141         pyc = env.File(str(dep) + 'c')
 142         env.SideEffect(pyc, code)
 143
 144     return code
 145
 146
 147 def createCodeGenerateMethod(env):
 148     env.Append(SCANNERS = python_scanner)
 149     env.AddMethod(code_generate, 'CodeGenerate')
 150
 151
 152 def symlink(target, source, env):
 153     target = str(target[0])
 154     source = str(source[0])
 155     if os.path.islink(target) or os.path.exists(target):
 156         os.remove(target)
 157     os.symlink(os.path.basename(source), target)
 158
 159 def install_program(env, source):
 160     source = str(source[0])
 161     target_dir =  os.path.join(env.Dir('#.').srcnode().abspath, env['build'], 'bin')
 162     target_name = str(source)
 163     env.InstallAs(os.path.join(target_dir, target_name), source)
 164
 165 def install_shared_library(env, source, version = ()):
 166     source = str(source[0])
 167     version = tuple(map(str, version))
 168     target_dir =  os.path.join(env.Dir('#.').srcnode().abspath, env['build'], 'lib')
 169     target_name = '.'.join((str(source),) + version)
 170     last = env.InstallAs(os.path.join(target_dir, target_name), source)
 171     while len(version):
 172         version = version[:-1]
 173         target_name = '.'.join((str(source),) + version)
 174         action = SCons.Action.Action(symlink, "$TARGET -> $SOURCE")
 175         last = env.Command(os.path.join(target_dir, target_name), last, action)
 176
 177 def createInstallMethods(env):
 178     env.AddMethod(install_program, 'InstallProgram')
 179     env.AddMethod(install_shared_library, 'InstallSharedLibrary')
 180
 181
 182 def generate(env):
 183     """Common environment generation code"""
 184
 185     if env.get('quiet', True):
 186         quietCommandLines(env)
 187
 188     # Custom builders and methods
 189     createConvenienceLibBuilder(env)
 190     createCodeGenerateMethod(env)
 191     createInstallMethods(env)
 192
 193     # for debugging
 194     #print env.Dump()
 195
 196
 197 def exists(env):
 198     return 1