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
'^\s*import\s+(\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))
116 #print node, map(str, results)
119 python_scanner
= SCons
.Scanner
.Scanner(function
= python_scan
, skeys
= ['.py'])
122 def code_generate(env
, script
, target
, source
, command
):
123 """Method to simplify code generation via python scripts.
125 http://www.scons.org/wiki/UsingCodeGenerators
126 http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
129 # We're generating code using Python scripts, so we have to be
130 # careful with our scons elements. This entry represents
131 # the generator file *in the source directory*.
132 script_src
= env
.File(script
).srcnode()
134 # This command creates generated code *in the build directory*.
135 command
= command
.replace('$SCRIPT', script_src
.path
)
136 action
= SCons
.Action
.Action(command
, "$CODEGENCOMSTR")
137 code
= env
.Command(target
, source
, action
)
139 # Explicitly mark that the generated code depends on the generator,
140 # and on implicitly imported python modules
141 path
= (script_src
.get_dir(),)
143 deps
+= script_src
.get_implicit_deps(env
, python_scanner
, path
)
144 env
.Depends(code
, deps
)
146 # Running the Python script causes .pyc files to be generated in the
147 # source directory. When we clean up, they should go too. So add side
148 # effects for .pyc files
150 pyc
= env
.File(str(dep
) + 'c')
151 env
.SideEffect(pyc
, code
)
156 def createCodeGenerateMethod(env
):
157 env
.Append(SCANNERS
= python_scanner
)
158 env
.AddMethod(code_generate
, 'CodeGenerate')
161 def _pkg_check_modules(env
, name
, modules
):
162 '''Simple wrapper for pkg-config.'''
164 env
['HAVE_' + name
] = False
166 # For backwards compatability
167 env
[name
.lower()] = False
169 if env
['platform'] == 'windows':
172 if not env
.Detect('pkg-config'):
175 if subprocess
.call(["pkg-config", "--exists", ' '.join(modules
)]) != 0:
178 # Strip version expressions from modules
179 modules
= [module
.split(' ', 1)[0] for module
in modules
]
181 # Other flags may affect the compilation of unrelated targets, so store
182 # them with a prefix, (e.g., XXX_CFLAGS, XXX_LIBS, etc)
184 flags
= env
.ParseFlags('!pkg-config --cflags --libs ' + ' '.join(modules
))
188 for flag_name
, flag_value
in flags
.iteritems():
189 assert '_' not in flag_name
190 env
[prefix
+ flag_name
] = flag_value
192 env
['HAVE_' + name
] = True
194 def pkg_check_modules(env
, name
, modules
):
196 sys
.stdout
.write('Checking for %s (%s)...' % (name
, ' '.join(modules
)))
197 _pkg_check_modules(env
, name
, modules
)
198 result
= env
['HAVE_' + name
]
199 sys
.stdout
.write(' %s\n' % ['no', 'yes'][int(bool(result
))])
201 # XXX: For backwards compatability
202 env
[name
.lower()] = result
205 def pkg_use_modules(env
, names
):
206 '''Search for all environment flags that match NAME_FOO and append them to
207 the FOO environment variable.'''
209 names
= env
.Flatten(names
)
214 if not 'HAVE_' + name
in env
:
215 raise Exception('Attempt to use unknown module %s' % name
)
217 if not env
['HAVE_' + name
]:
218 raise Exception('Attempt to use unavailable module %s' % name
)
221 for flag_name
, flag_value
in env
.Dictionary().iteritems():
222 if flag_name
.startswith(prefix
):
223 flag_name
= flag_name
[len(prefix
):]
224 if '_' not in flag_name
:
225 flags
[flag_name
] = flag_value
227 env
.MergeFlags(flags
)
230 def createPkgConfigMethods(env
):
231 env
.AddMethod(pkg_check_modules
, 'PkgCheckModules')
232 env
.AddMethod(pkg_use_modules
, 'PkgUseModules')
235 def parse_source_list(env
, filename
, names
=None):
236 # parse the source list file
237 parser
= source_list
.SourceListParser()
238 src
= env
.File(filename
).srcnode()
240 cur_srcdir
= env
.Dir('.').srcnode().abspath
241 top_srcdir
= env
.Dir('#').abspath
242 top_builddir
= os
.path
.join(top_srcdir
, env
['build_dir'])
244 # Normalize everything to / slashes
245 cur_srcdir
= cur_srcdir
.replace('\\', '/')
246 top_srcdir
= top_srcdir
.replace('\\', '/')
247 top_builddir
= top_builddir
.replace('\\', '/')
249 # Populate the symbol table of the Makefile parser.
250 parser
.add_symbol('top_srcdir', top_srcdir
)
251 parser
.add_symbol('top_builddir', top_builddir
)
253 sym_table
= parser
.parse(src
.abspath
)
256 if isinstance(names
, basestring
):
261 symbols
= sym_table
.keys()
263 # convert the symbol table to source lists
268 for f
in val
.split():
270 # Process source paths
271 if f
.startswith(top_builddir
+ '/src'):
272 # Automake puts build output on a `src` subdirectory, but
273 # SCons does not, so strip it here.
274 f
= top_builddir
+ f
[len(top_builddir
+ '/src'):]
275 if f
.startswith(cur_srcdir
+ '/'):
276 # Prefer relative source paths, as absolute files tend to
277 # cause duplicate actions.
278 f
= f
[len(cur_srcdir
+ '/'):]
281 src_lists
[sym
] = srcs
283 # if names are given, concatenate the lists
287 srcs
.extend(src_lists
[name
])
293 def createParseSourceListMethod(env
):
294 env
.AddMethod(parse_source_list
, 'ParseSourceList')
298 """Common environment generation code"""
300 verbose
= env
.get('verbose', False) or not env
.get('quiet', True)
302 quietCommandLines(env
)
304 # Custom builders and methods
305 createConvenienceLibBuilder(env
)
306 createCodeGenerateMethod(env
)
307 createPkgConfigMethods(env
)
308 createParseSourceListMethod(env
)