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.
46 def quietCommandLines(env
):
48 # See also http://www.scons.org/wiki/HidingCommandLinesInOutput
49 env
['ASCOMSTR'] = " Assembling $SOURCE ..."
50 env
['ASPPCOMSTR'] = " Assembling $SOURCE ..."
51 env
['CCCOMSTR'] = " Compiling $SOURCE ..."
52 env
['SHCCCOMSTR'] = " Compiling $SOURCE ..."
53 env
['CXXCOMSTR'] = " Compiling $SOURCE ..."
54 env
['SHCXXCOMSTR'] = " Compiling $SOURCE ..."
55 env
['ARCOMSTR'] = " Archiving $TARGET ..."
56 env
['RANLIBCOMSTR'] = " Indexing $TARGET ..."
57 env
['LINKCOMSTR'] = " Linking $TARGET ..."
58 env
['SHLINKCOMSTR'] = " Linking $TARGET ..."
59 env
['LDMODULECOMSTR'] = " Linking $TARGET ..."
60 env
['SWIGCOMSTR'] = " Generating $TARGET ..."
61 env
['LEXCOMSTR'] = " Generating $TARGET ..."
62 env
['YACCCOMSTR'] = " Generating $TARGET ..."
63 env
['CODEGENCOMSTR'] = " Generating $TARGET ..."
64 env
['INSTALLSTR'] = " Installing $TARGET ..."
67 def createConvenienceLibBuilder(env
):
68 """This is a utility function that creates the ConvenienceLibrary
69 Builder in an Environment if it is not there already.
71 If it is already there, we return the existing one.
73 Based on the stock StaticLibrary and SharedLibrary builders.
77 convenience_lib
= env
['BUILDERS']['ConvenienceLibrary']
79 action_list
= [ SCons
.Action
.Action("$ARCOM", "$ARCOMSTR") ]
80 if env
.Detect('ranlib'):
81 ranlib_action
= SCons
.Action
.Action("$RANLIBCOM", "$RANLIBCOMSTR")
82 action_list
.append(ranlib_action
)
84 convenience_lib
= SCons
.Builder
.Builder(action
= action_list
,
85 emitter
= '$LIBEMITTER',
86 prefix
= '$LIBPREFIX',
87 suffix
= '$LIBSUFFIX',
88 src_suffix
= '$SHOBJSUFFIX',
89 src_builder
= 'SharedObject')
90 env
['BUILDERS']['ConvenienceLibrary'] = convenience_lib
92 return convenience_lib
95 # TODO: handle import statements with multiple modules
96 # TODO: handle from import statements
97 import_re
= re
.compile(r
'^import\s+(\S+)$', re
.M
)
99 def python_scan(node
, env
, path
):
100 # http://www.scons.org/doc/0.98.5/HTML/scons-user/c2781.html#AEN2789
101 contents
= node
.get_contents()
102 source_dir
= node
.get_dir()
103 imports
= import_re
.findall(contents
)
107 file = os
.path
.join(str(dir), imp
.replace('.', os
.sep
) + '.py')
108 if os
.path
.exists(file):
109 results
.append(env
.File(file))
111 file = os
.path
.join(str(dir), imp
.replace('.', os
.sep
), '__init__.py')
112 if os
.path
.exists(file):
113 results
.append(env
.File(file))
117 python_scanner
= SCons
.Scanner
.Scanner(function
= python_scan
, skeys
= ['.py'])
120 def code_generate(env
, script
, target
, source
, command
):
121 """Method to simplify code generation via python scripts.
123 http://www.scons.org/wiki/UsingCodeGenerators
124 http://www.scons.org/doc/0.98.5/HTML/scons-user/c2768.html
127 # We're generating code using Python scripts, so we have to be
128 # careful with our scons elements. This entry represents
129 # the generator file *in the source directory*.
130 script_src
= env
.File(script
).srcnode()
132 # This command creates generated code *in the build directory*.
133 command
= command
.replace('$SCRIPT', script_src
.path
)
134 action
= SCons
.Action
.Action(command
, "$CODEGENCOMSTR")
135 code
= env
.Command(target
, source
, action
)
137 # Explicitly mark that the generated code depends on the generator,
138 # and on implicitly imported python modules
139 path
= (script_src
.get_dir(),)
141 deps
+= script_src
.get_implicit_deps(env
, python_scanner
, path
)
142 env
.Depends(code
, deps
)
144 # Running the Python script causes .pyc files to be generated in the
145 # source directory. When we clean up, they should go too. So add side
146 # effects for .pyc files
148 pyc
= env
.File(str(dep
) + 'c')
149 env
.SideEffect(pyc
, code
)
154 def createCodeGenerateMethod(env
):
155 env
.Append(SCANNERS
= python_scanner
)
156 env
.AddMethod(code_generate
, 'CodeGenerate')
159 def _pkg_check_modules(env
, name
, modules
):
160 '''Simple wrapper for pkg-config.'''
162 env
['HAVE_' + name
] = False
164 # For backwards compatability
165 env
[name
.lower()] = False
167 if env
['platform'] == 'windows':
170 if not env
.Detect('pkg-config'):
173 if subprocess
.call(["pkg-config", "--exists", ' '.join(modules
)]) != 0:
176 # Other flags may affect the compilation of unrelated targets, so store
177 # them with a prefix, (e.g., XXX_CFLAGS, XXX_LIBS, etc)
179 flags
= env
.ParseFlags('!pkg-config --cflags --libs ' + ' '.join(modules
))
183 for flag_name
, flag_value
in flags
.iteritems():
184 assert '_' not in flag_name
185 env
[prefix
+ flag_name
] = flag_value
187 env
['HAVE_' + name
] = True
189 def pkg_check_modules(env
, name
, modules
):
191 sys
.stdout
.write('Checking for %s...' % name
)
192 _pkg_check_modules(env
, name
, modules
)
193 result
= env
['HAVE_' + name
]
194 sys
.stdout
.write(' %s\n' % ['no', 'yes'][int(bool(result
))])
196 # XXX: For backwards compatability
197 env
[name
.lower()] = result
200 def pkg_use_modules(env
, names
):
201 '''Search for all environment flags that match NAME_FOO and append them to
202 the FOO environment variable.'''
204 names
= env
.Flatten(names
)
209 if not 'HAVE_' + name
in env
:
210 print 'Attempt to use unknown module %s' % name
213 if not env
['HAVE_' + name
]:
214 print 'Attempt to use unavailable module %s' % name
218 for flag_name
, flag_value
in env
.Dictionary().iteritems():
219 if flag_name
.startswith(prefix
):
220 flag_name
= flag_name
[len(prefix
):]
221 if '_' not in flag_name
:
222 flags
[flag_name
] = flag_value
224 env
.MergeFlags(flags
)
227 def createPkgConfigMethods(env
):
228 env
.AddMethod(pkg_check_modules
, 'PkgCheckModules')
229 env
.AddMethod(pkg_use_modules
, 'PkgUseModules')
233 """Common environment generation code"""
235 verbose
= env
.get('verbose', False) or not env
.get('quiet', True)
237 quietCommandLines(env
)
239 # Custom builders and methods
240 createConvenienceLibBuilder(env
)
241 createCodeGenerateMethod(env
)
242 createPkgConfigMethods(env
)