3 Custom builders and methods.
8 # Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
19 # The above copyright notice and this permission notice (including the
20 # next paragraph) shall be included in all copies or substantial portions
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.
47 def quietCommandLines(env):
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 ..."
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.
72 If it is already there, we return the existing one.
74 Based on the stock StaticLibrary and SharedLibrary builders.
78 convenience_lib = env['BUILDERS']['ConvenienceLibrary']
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)
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
93 return convenience_lib
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)
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)
108 file = os.path.join(str(dir), imp.replace('.', os.sep) + '.py')
109 if os.path.exists(file):
110 results.append(env.File(file))
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))
118 python_scanner = SCons.Scanner.Scanner(function = python_scan, skeys = ['.py'])
121 def code_generate(env, script, target, source, command):
122 """Method to simplify code generation via python scripts.
124 http://www.scons.org/wiki/UsingCodeGenerators
125 http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
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()
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)
138 # Explicitly mark that the generated code depends on the generator,
139 # and on implicitly imported python modules
140 path = (script_src.get_dir(),)
142 deps += script_src.get_implicit_deps(env, python_scanner, path)
143 env.Depends(code, deps)
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
149 pyc = env.File(str(dep) + 'c')
150 env.SideEffect(pyc, code)
155 def createCodeGenerateMethod(env):
156 env.Append(SCANNERS = python_scanner)
157 env.AddMethod(code_generate, 'CodeGenerate')
160 def _pkg_check_modules(env, name, modules):
161 '''Simple wrapper for pkg-config.'''
163 env['HAVE_' + name] = False
165 # For backwards compatability
166 env[name.lower()] = False
168 if env['platform'] == 'windows':
171 if not env.Detect('pkg-config'):
174 if subprocess.call(["pkg-config", "--exists", ' '.join(modules)]) != 0:
177 # Strip version expressions from modules
178 modules = [module.split(' ', 1)[0] for module in modules]
180 # Other flags may affect the compilation of unrelated targets, so store
181 # them with a prefix, (e.g., XXX_CFLAGS, XXX_LIBS, etc)
183 flags = env.ParseFlags('!pkg-config --cflags --libs ' + ' '.join(modules))
187 for flag_name, flag_value in flags.iteritems():
188 assert '_' not in flag_name
189 env[prefix + flag_name] = flag_value
191 env['HAVE_' + name] = True
193 def pkg_check_modules(env, name, modules):
195 sys.stdout.write('Checking for %s (%s)...' % (name, ' '.join(modules)))
196 _pkg_check_modules(env, name, modules)
197 result = env['HAVE_' + name]
198 sys.stdout.write(' %s\n' % ['no', 'yes'][int(bool(result))])
200 # XXX: For backwards compatability
201 env[name.lower()] = result
204 def pkg_use_modules(env, names):
205 '''Search for all environment flags that match NAME_FOO and append them to
206 the FOO environment variable.'''
208 names = env.Flatten(names)
213 if not 'HAVE_' + name in env:
214 raise Exception('Attempt to use unknown module %s' % name)
216 if not env['HAVE_' + name]:
217 raise Exception('Attempt to use unavailable module %s' % name)
220 for flag_name, flag_value in env.Dictionary().iteritems():
221 if flag_name.startswith(prefix):
222 flag_name = flag_name[len(prefix):]
223 if '_' not in flag_name:
224 flags[flag_name] = flag_value
226 env.MergeFlags(flags)
229 def createPkgConfigMethods(env):
230 env.AddMethod(pkg_check_modules, 'PkgCheckModules')
231 env.AddMethod(pkg_use_modules, 'PkgUseModules')
234 def parse_source_list(env, filename, names=None):
235 # parse the source list file
236 parser = source_list.SourceListParser()
237 src = env.File(filename).srcnode()
238 sym_table = parser.parse(src.abspath)
241 if isinstance(names, basestring):
246 symbols = sym_table.keys()
248 # convert the symbol table to source lists
252 src_lists[sym] = [f for f in val.split(' ') if f]
254 # if names are given, concatenate the lists
258 srcs.extend(src_lists[name])
264 def createParseSourceListMethod(env):
265 env.AddMethod(parse_source_list, 'ParseSourceList')
269 """Common environment generation code"""
271 verbose = env.get('verbose', False) or not env.get('quiet', True)
273 quietCommandLines(env)
275 # Custom builders and methods
276 createConvenienceLibBuilder(env)
277 createCodeGenerateMethod(env)
278 createPkgConfigMethods(env)
279 createParseSourceListMethod(env)