1 """SCons.Script.SConscript
3 This module defines the Python API provided to SConscript and SConstruct
11 # Permission is hereby granted, free of charge, to any person obtaining
12 # a 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, sublicense, 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 shall be included
20 # in all copies or substantial portions of the Software.
22 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
23 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
24 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
37 import SCons.Environment
40 import SCons.Node.Alias
44 import SCons.Script.Main
57 # The following variables used to live in this module. Some
58 # SConscript files out there may have referred to them directly as
59 # SCons.Script.SConscript.*. This is now supported by some special
60 # handling towards the bottom of the SConscript.__init__.py module.
63 #BuildTargets = TargetList()
64 #CommandLineTargets = []
67 class SConscriptReturn(Exception):
70 launch_dir = os.path.abspath(os.curdir)
74 # global exports set by Export():
80 def get_calling_namespaces():
81 """Return the locals and globals for the function that called
82 into this module in the current call stack."""
84 except ZeroDivisionError:
85 # Don't start iterating with the current stack-frame to
86 # prevent creating reference cycles (f_back is safe).
87 frame = sys.exc_info()[2].tb_frame.f_back
89 # Find the first frame that *isn't* from this file. This means
90 # that we expect all of the SCons frames that implement an Export()
91 # or SConscript() call to be in this file, so that we can identify
92 # the first non-Script.SConscript frame as the user's local calling
93 # environment, and the locals and globals dictionaries from that
94 # frame as the calling namespaces. See the comment below preceding
95 # the DefaultEnvironmentCall block for even more explanation.
96 while frame.f_globals.get("__name__") == __name__:
99 return frame.f_locals, frame.f_globals
102 def compute_exports(exports):
103 """Compute a dictionary of exports given one of the parameters
104 to the Export() function or the exports argument to SConscript()."""
106 loc, glob = get_calling_namespaces()
110 for export in exports:
111 if SCons.Util.is_Dict(export):
112 retval.update(export)
115 retval[export] = loc[export]
117 retval[export] = glob[export]
119 raise SCons.Errors.UserError, "Export of non-existent variable '%s'"%x
124 """A frame on the SConstruct/SConscript call stack"""
125 def __init__(self, fs, exports, sconscript):
126 self.globals = BuildDefaultGlobals()
128 self.prev_dir = fs.getcwd()
129 self.exports = compute_exports(exports) # exports from the calling SConscript
130 # make sure the sconscript attr is a Node.
131 if isinstance(sconscript, SCons.Node.Node):
132 self.sconscript = sconscript
133 elif sconscript == '-':
134 self.sconscript = None
136 self.sconscript = fs.File(str(sconscript))
138 # the SConstruct/SConscript call stack:
141 # For documentation on the methods in this file, see the scons man-page
143 def Return(*vars, **kw):
146 fvars = SCons.Util.flatten(vars)
148 for v in string.split(var):
149 retval.append(call_stack[-1].globals[v])
151 raise SCons.Errors.UserError, "Return of non-existent variable '%s'"%x
154 call_stack[-1].retval = retval[0]
156 call_stack[-1].retval = tuple(retval)
158 stop = kw.get('stop', True)
161 raise SConscriptReturn
164 stack_bottom = '% Stack boTTom %' # hard to define a variable w/this name :)
166 def _SConscript(fs, *files, **kw):
168 sd = fs.SConstruct_dir.rdir()
169 exports = kw.get('exports', [])
171 # evaluate each SConscript file
174 call_stack.append(Frame(fs, exports, fn))
175 old_sys_path = sys.path
177 SCons.Script.sconscript_reading = SCons.Script.sconscript_reading + 1
179 exec sys.stdin in call_stack[-1].globals
181 if isinstance(fn, SCons.Node.Node):
187 # Change directory to the top of the source
188 # tree to make sure the os's cwd and the cwd of
189 # fs match so we can open the SConscript.
190 fs.chdir(top, change_os_dir=1)
193 _file_ = open(actual.get_abspath(), "r")
194 elif f.srcnode().rexists():
195 actual = f.srcnode().rfile()
196 _file_ = open(actual.get_abspath(), "r")
197 elif f.has_src_builder():
198 # The SConscript file apparently exists in a source
199 # code management system. Build it, but then clear
200 # the builder so that it doesn't get built *again*
201 # during the actual build phase.
206 _file_ = open(f.get_abspath(), "r")
208 # Chdir to the SConscript directory. Use a path
209 # name relative to the SConstruct file so that if
210 # we're using the -f option, we're essentially
211 # creating a parallel SConscript directory structure
212 # in our local directory tree.
214 # XXX This is broken for multiple-repository cases
215 # where the SConstruct and SConscript files might be
216 # in different Repositories. For now, cross that
217 # bridge when someone comes to it.
219 src_dir = kw['src_dir']
221 ldir = fs.Dir(f.dir.get_path(sd))
223 ldir = fs.Dir(src_dir)
224 if not ldir.is_under(f.dir):
225 # They specified a source directory, but
226 # it's above the SConscript directory.
227 # Do the sensible thing and just use the
228 # SConcript directory.
229 ldir = fs.Dir(f.dir.get_path(sd))
231 fs.chdir(ldir, change_os_dir=sconscript_chdir)
233 # There was no local directory, so we should be
234 # able to chdir to the Repository directory.
235 # Note that we do this directly, not through
236 # fs.chdir(), because we still need to
237 # interpret the stuff within the SConscript file
238 # relative to where we are logically.
239 fs.chdir(ldir, change_os_dir=0)
240 os.chdir(actual.dir.get_abspath())
242 # Append the SConscript directory to the beginning
243 # of sys.path so Python modules in the SConscript
244 # directory can be easily imported.
245 sys.path = [ f.dir.get_abspath() ] + sys.path
247 # This is the magic line that actually reads up
248 # and executes the stuff in the SConscript file.
249 # The locals for this frame contain the special
250 # bottom-of-the-stack marker so that any
251 # exceptions that occur when processing this
252 # SConscript can base the printed frames at this
253 # level and not show SCons internals as well.
254 call_stack[-1].globals.update({stack_bottom:1})
255 old_file = call_stack[-1].globals.get('__file__')
257 del call_stack[-1].globals['__file__']
262 exec _file_ in call_stack[-1].globals
263 except SConscriptReturn:
266 if old_file is not None:
267 call_stack[-1].globals.update({__file__:old_file})
269 SCons.Warnings.warn(SCons.Warnings.MissingSConscriptWarning,
270 "Ignoring missing SConscript '%s'" % f.path)
273 SCons.Script.sconscript_reading = SCons.Script.sconscript_reading - 1
274 sys.path = old_sys_path
275 frame = call_stack.pop()
277 fs.chdir(frame.prev_dir, change_os_dir=sconscript_chdir)
279 # There was no local directory, so chdir to the
280 # Repository directory. Like above, we do this
282 fs.chdir(frame.prev_dir, change_os_dir=0)
283 rdir = frame.prev_dir.rdir()
284 rdir._create() # Make sure there's a directory there.
286 os.chdir(rdir.get_abspath())
288 # We still couldn't chdir there, so raise the error,
289 # but only if actions are being executed.
291 # If the -n option was used, the directory would *not*
292 # have been created and we should just carry on and
293 # let things muddle through. This isn't guaranteed
294 # to work if the SConscript files are reading things
295 # from disk (for example), but it should work well
296 # enough for most configurations.
297 if SCons.Action.execute_actions:
300 results.append(frame.retval)
302 # if we only have one script, don't return a tuple
303 if len(results) == 1:
306 return tuple(results)
308 def SConscript_exception(file=sys.stderr):
309 """Print an exception stack trace just for the SConscript file(s).
310 This will show users who have Python errors where the problem is,
311 without cluttering the output with all of the internal calls leading
312 up to where we exec the SConscript."""
313 exc_type, exc_value, exc_tb = sys.exc_info()
315 while tb and not tb.tb_frame.f_locals.has_key(stack_bottom):
318 # We did not find our exec statement, so this was actually a bug
319 # in SCons itself. Show the whole stack.
321 stack = traceback.extract_tb(tb)
323 type = exc_type.__name__
324 except AttributeError:
326 if type[:11] == "exceptions.":
328 file.write('%s: %s:\n' % (type, exc_value))
329 for fname, line, func, text in stack:
330 file.write(' File "%s", line %d:\n' % (fname, line))
331 file.write(' %s\n' % text)
334 """Annotate a node with the stack frame describing the
335 SConscript file and line number that created it."""
336 tb = sys.exc_info()[2]
337 while tb and not tb.tb_frame.f_locals.has_key(stack_bottom):
340 # We did not find any exec of an SConscript file: what?!
341 raise SCons.Errors.InternalError, "could not find SConscript stack frame"
342 node.creator = traceback.extract_stack(tb)[0]
344 # The following line would cause each Node to be annotated using the
345 # above function. Unfortunately, this is a *huge* performance hit, so
346 # leave this disabled until we find a more efficient mechanism.
347 #SCons.Node.Annotate = annotate
349 class SConsEnvironment(SCons.Environment.Base):
350 """An Environment subclass that contains all of the methods that
351 are particular to the wrapper SCons interface and which aren't
352 (or shouldn't be) part of the build engine itself.
354 Note that not all of the methods of this class have corresponding
355 global functions, there are some private methods.
359 # Private methods of an SConsEnvironment.
361 def _exceeds_version(self, major, minor, v_major, v_minor):
362 """Return 1 if 'major' and 'minor' are greater than the version
363 in 'v_major' and 'v_minor', and 0 otherwise."""
364 return (major > v_major or (major == v_major and minor > v_minor))
366 def _get_major_minor_revision(self, version_string):
367 """Split a version string into major, minor and (optionally)
370 This is complicated by the fact that a version string can be
371 something like 3.2b1."""
372 version = string.split(string.split(version_string, ' ')[0], '.')
373 v_major = int(version[0])
374 v_minor = int(re.match('\d+', version[1]).group())
375 if len(version) >= 3:
376 v_revision = int(re.match('\d+', version[2]).group())
379 return v_major, v_minor, v_revision
381 def _get_SConscript_filenames(self, ls, kw):
383 Convert the parameters passed to # SConscript() calls into a list
384 of files and export variables. If the parameters are invalid,
385 throws SCons.Errors.UserError. Returns a tuple (l, e) where l
386 is a list of SConscript filenames and e is a list of exports.
394 raise SCons.Errors.UserError, \
395 "Invalid SConscript usage - no parameters"
397 if not SCons.Util.is_List(dirs):
399 dirs = map(str, dirs)
401 name = kw.get('name', 'SConscript')
403 files = map(lambda n, name = name: os.path.join(n, name), dirs)
412 exports = self.Split(ls[1])
416 raise SCons.Errors.UserError, \
417 "Invalid SConscript() usage - too many arguments"
419 if not SCons.Util.is_List(files):
422 if kw.get('exports'):
423 exports.extend(self.Split(kw['exports']))
425 variant_dir = kw.get('variant_dir') or kw.get('build_dir')
428 raise SCons.Errors.UserError, \
429 "Invalid SConscript() usage - can only specify one SConscript with a variant_dir"
430 duplicate = kw.get('duplicate', 1)
431 src_dir = kw.get('src_dir')
433 src_dir, fname = os.path.split(str(files[0]))
434 files = [os.path.join(str(variant_dir), fname)]
436 if not isinstance(src_dir, SCons.Node.Node):
437 src_dir = self.fs.Dir(src_dir)
439 if not isinstance(fn, SCons.Node.Node):
440 fn = self.fs.File(fn)
441 if fn.is_under(src_dir):
442 # Get path relative to the source directory.
443 fname = fn.get_path(src_dir)
444 files = [os.path.join(str(variant_dir), fname)]
447 kw['src_dir'] = variant_dir
448 self.fs.VariantDir(variant_dir, src_dir, duplicate)
450 return (files, exports)
453 # Public methods of an SConsEnvironment. These get
454 # entry points in the global name space so they can be called
455 # as global functions.
458 def Configure(self, *args, **kw):
459 if not SCons.Script.sconscript_reading:
460 raise SCons.Errors.UserError, "Calling Configure from Builders is not supported."
461 kw['_depth'] = kw.get('_depth', 0) + 1
462 return apply(SCons.Environment.Base.Configure, (self,)+args, kw)
464 def Default(self, *targets):
465 SCons.Script._Set_Default_Targets(self, targets)
467 def EnsureSConsVersion(self, major, minor, revision=0):
468 """Exit abnormally if the SCons version is not late enough."""
469 scons_ver = self._get_major_minor_revision(SCons.__version__)
470 if scons_ver < (major, minor, revision):
472 scons_ver_string = '%d.%d.%d' % (major, minor, revision)
474 scons_ver_string = '%d.%d' % (major, minor)
475 print "SCons %s or greater required, but you have SCons %s" % \
476 (scons_ver_string, SCons.__version__)
479 def EnsurePythonVersion(self, major, minor):
480 """Exit abnormally if the Python version is not late enough."""
482 v_major, v_minor, v_micro, release, serial = sys.version_info
483 python_ver = (v_major, v_minor)
484 except AttributeError:
485 python_ver = self._get_major_minor_revision(sys.version)[:2]
486 if python_ver < (major, minor):
487 v = string.split(sys.version, " ", 1)[0]
488 print "Python %d.%d or greater required, but you have Python %s" %(major,minor,v)
491 def Exit(self, value=0):
494 def Export(self, *vars):
496 global_exports.update(compute_exports(self.Split(var)))
498 def GetLaunchDir(self):
502 def GetOption(self, name):
503 name = self.subst(name)
504 return SCons.Script.Main.GetOption(name)
506 def Help(self, text):
507 text = self.subst(text, raw=1)
508 SCons.Script.HelpFunction(text)
510 def Import(self, *vars):
512 frame = call_stack[-1]
513 globals = frame.globals
514 exports = frame.exports
516 var = self.Split(var)
519 globals.update(global_exports)
520 globals.update(exports)
522 if exports.has_key(v):
523 globals[v] = exports[v]
525 globals[v] = global_exports[v]
527 raise SCons.Errors.UserError, "Import of non-existent variable '%s'"%x
529 def SConscript(self, *ls, **kw):
530 def subst_element(x, subst=self.subst):
531 if SCons.Util.is_List(x):
536 ls = map(subst_element, ls)
538 for key, val in kw.items():
539 if SCons.Util.is_String(val):
540 val = self.subst(val)
541 elif SCons.Util.is_List(val):
544 if SCons.Util.is_String(v):
550 files, exports = self._get_SConscript_filenames(ls, subst_kw)
551 subst_kw['exports'] = exports
552 return apply(_SConscript, [self.fs,] + files, subst_kw)
554 def SConscriptChdir(self, flag):
555 global sconscript_chdir
556 sconscript_chdir = flag
558 def SetOption(self, name, value):
559 name = self.subst(name)
560 SCons.Script.Main.SetOption(name, value)
565 SCons.Environment.Environment = SConsEnvironment
567 def Configure(*args, **kw):
568 if not SCons.Script.sconscript_reading:
569 raise SCons.Errors.UserError, "Calling Configure from Builders is not supported."
571 return apply(SCons.SConf.SConf, args, kw)
573 # It's very important that the DefaultEnvironmentCall() class stay in this
574 # file, with the get_calling_namespaces() function, the compute_exports()
575 # function, the Frame class and the SConsEnvironment.Export() method.
576 # These things make up the calling stack leading up to the actual global
577 # Export() or SConscript() call that the user issued. We want to allow
578 # users to export local variables that they define, like so:
584 # To support this, the get_calling_namespaces() function assumes that
585 # the *first* stack frame that's not from this file is the local frame
586 # for the Export() or SConscript() call.
588 _DefaultEnvironmentProxy = None
590 def get_DefaultEnvironmentProxy():
591 global _DefaultEnvironmentProxy
592 if not _DefaultEnvironmentProxy:
593 default_env = SCons.Defaults.DefaultEnvironment()
594 _DefaultEnvironmentProxy = SCons.Environment.NoSubstitutionProxy(default_env)
595 return _DefaultEnvironmentProxy
597 class DefaultEnvironmentCall:
598 """A class that implements "global function" calls of
599 Environment methods by fetching the specified method from the
600 DefaultEnvironment's class. Note that this uses an intermediate
601 proxy class instead of calling the DefaultEnvironment method
602 directly so that the proxy can override the subst() method and
603 thereby prevent expansion of construction variables (since from
604 the user's point of view this was called as a global function,
605 with no associated construction environment)."""
606 def __init__(self, method_name, subst=0):
607 self.method_name = method_name
609 self.factory = SCons.Defaults.DefaultEnvironment
611 self.factory = get_DefaultEnvironmentProxy
612 def __call__(self, *args, **kw):
614 method = getattr(env, self.method_name)
615 return apply(method, args, kw)
618 def BuildDefaultGlobals():
620 Create a dictionary containing all the default globals for
621 SConstruct and SConscript files.
625 if GlobalDict is None:
629 d = SCons.Script.__dict__
630 def not_a_module(m, d=d, mtype=type(SCons.Script)):
631 return type(d[m]) != mtype
632 for m in filter(not_a_module, dir(SCons.Script)):
635 return GlobalDict.copy()
639 # indent-tabs-mode:nil
641 # vim: set expandtab tabstop=4 shiftwidth=4: