SConscript.py
上传用户:market2
上传日期:2018-11-18
资源大小:18786k
文件大小:23k
源码类别:

外挂编程

开发平台:

Windows_Unix

  1. """SCons.Script.SConscript
  2. This module defines the Python API provided to SConscript and SConstruct
  3. files.
  4. """
  5. #
  6. # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  7. #
  8. # Permission is hereby granted, free of charge, to any person obtaining
  9. # a copy of this software and associated documentation files (the
  10. # "Software"), to deal in the Software without restriction, including
  11. # without limitation the rights to use, copy, modify, merge, publish,
  12. # distribute, sublicense, and/or sell copies of the Software, and to
  13. # permit persons to whom the Software is furnished to do so, subject to
  14. # the following conditions:
  15. #
  16. # The above copyright notice and this permission notice shall be included
  17. # in all copies or substantial portions of the Software.
  18. #
  19. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  20. # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  21. # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  23. # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  24. # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  25. # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26. #
  27. __revision__ = "src/engine/SCons/Script/SConscript.py 3057 2008/06/09 22:21:00 knight"
  28. import SCons
  29. import SCons.Action
  30. import SCons.Builder
  31. import SCons.Defaults
  32. import SCons.Environment
  33. import SCons.Errors
  34. import SCons.Node
  35. import SCons.Node.Alias
  36. import SCons.Node.FS
  37. import SCons.Platform
  38. import SCons.SConf
  39. import SCons.Script.Main
  40. import SCons.Tool
  41. import SCons.Util
  42. import os
  43. import os.path
  44. import re
  45. import string
  46. import sys
  47. import traceback
  48. import types
  49. import UserList
  50. # The following variables used to live in this module.  Some
  51. # SConscript files out there may have referred to them directly as
  52. # SCons.Script.SConscript.*.  This is now supported by some special
  53. # handling towards the bottom of the SConscript.__init__.py module.
  54. #Arguments = {}
  55. #ArgList = []
  56. #BuildTargets = TargetList()
  57. #CommandLineTargets = []
  58. #DefaultTargets = []
  59. class SConscriptReturn(Exception):
  60.     pass
  61. launch_dir = os.path.abspath(os.curdir)
  62. GlobalDict = None
  63. # global exports set by Export():
  64. global_exports = {}
  65. # chdir flag
  66. sconscript_chdir = 1
  67. def get_calling_namespaces():
  68.     """Return the locals and globals for the function that called
  69.     into this module in the current call stack."""
  70.     try: 1/0
  71.     except ZeroDivisionError: frame = sys.exc_info()[2].tb_frame
  72.     # Find the first frame that *isn't* from this file.  This means
  73.     # that we expect all of the SCons frames that implement an Export()
  74.     # or SConscript() call to be in this file, so that we can identify
  75.     # the first non-Script.SConscript frame as the user's local calling
  76.     # environment, and the locals and globals dictionaries from that
  77.     # frame as the calling namespaces.  See the comment below preceding
  78.     # the DefaultEnvironmentCall block for even more explanation.
  79.     while frame.f_globals.get("__name__") == __name__:
  80.         frame = frame.f_back
  81.     return frame.f_locals, frame.f_globals
  82. def compute_exports(exports):
  83.     """Compute a dictionary of exports given one of the parameters
  84.     to the Export() function or the exports argument to SConscript()."""
  85.     loc, glob = get_calling_namespaces()
  86.     retval = {}
  87.     try:
  88.         for export in exports:
  89.             if SCons.Util.is_Dict(export):
  90.                 retval.update(export)
  91.             else:
  92.                 try:
  93.                     retval[export] = loc[export]
  94.                 except KeyError:
  95.                     retval[export] = glob[export]
  96.     except KeyError, x:
  97.         raise SCons.Errors.UserError, "Export of non-existent variable '%s'"%x
  98.     return retval
  99. class Frame:
  100.     """A frame on the SConstruct/SConscript call stack"""
  101.     def __init__(self, fs, exports, sconscript):
  102.         self.globals = BuildDefaultGlobals()
  103.         self.retval = None
  104.         self.prev_dir = fs.getcwd()
  105.         self.exports = compute_exports(exports)  # exports from the calling SConscript
  106.         # make sure the sconscript attr is a Node.
  107.         if isinstance(sconscript, SCons.Node.Node):
  108.             self.sconscript = sconscript
  109.         elif sconscript == '-':
  110.             self.sconscript = None
  111.         else:
  112.             self.sconscript = fs.File(str(sconscript))
  113. # the SConstruct/SConscript call stack:
  114. call_stack = []
  115. # For documentation on the methods in this file, see the scons man-page
  116. def Return(*vars, **kw):
  117.     retval = []
  118.     try:
  119.         fvars = SCons.Util.flatten(vars)
  120.         for var in fvars:
  121.             for v in string.split(var):
  122.                 retval.append(call_stack[-1].globals[v])
  123.     except KeyError, x:
  124.         raise SCons.Errors.UserError, "Return of non-existent variable '%s'"%x
  125.     if len(retval) == 1:
  126.         call_stack[-1].retval = retval[0]
  127.     else:
  128.         call_stack[-1].retval = tuple(retval)
  129.     stop = kw.get('stop', True)
  130.     if stop:
  131.         raise SConscriptReturn
  132. stack_bottom = '% Stack boTTom %' # hard to define a variable w/this name :)
  133. def _SConscript(fs, *files, **kw):
  134.     top = fs.Top
  135.     sd = fs.SConstruct_dir.rdir()
  136.     exports = kw.get('exports', [])
  137.     # evaluate each SConscript file
  138.     results = []
  139.     for fn in files:
  140.         call_stack.append(Frame(fs, exports, fn))
  141.         old_sys_path = sys.path
  142.         try:
  143.             SCons.Script.sconscript_reading = SCons.Script.sconscript_reading + 1
  144.             if fn == "-":
  145.                 exec sys.stdin in call_stack[-1].globals
  146.             else:
  147.                 if isinstance(fn, SCons.Node.Node):
  148.                     f = fn
  149.                 else:
  150.                     f = fs.File(str(fn))
  151.                 _file_ = None
  152.                 # Change directory to the top of the source
  153.                 # tree to make sure the os's cwd and the cwd of
  154.                 # fs match so we can open the SConscript.
  155.                 fs.chdir(top, change_os_dir=1)
  156.                 if f.rexists():
  157.                     _file_ = open(f.rfile().get_abspath(), "r")
  158.                 elif f.has_src_builder():
  159.                     # The SConscript file apparently exists in a source
  160.                     # code management system.  Build it, but then clear
  161.                     # the builder so that it doesn't get built *again*
  162.                     # during the actual build phase.
  163.                     f.build()
  164.                     f.built()
  165.                     f.builder_set(None)
  166.                     if f.exists():
  167.                         _file_ = open(f.get_abspath(), "r")
  168.                 if _file_:
  169.                     # Chdir to the SConscript directory.  Use a path
  170.                     # name relative to the SConstruct file so that if
  171.                     # we're using the -f option, we're essentially
  172.                     # creating a parallel SConscript directory structure
  173.                     # in our local directory tree.
  174.                     #
  175.                     # XXX This is broken for multiple-repository cases
  176.                     # where the SConstruct and SConscript files might be
  177.                     # in different Repositories.  For now, cross that
  178.                     # bridge when someone comes to it.
  179.                     try:
  180.                         src_dir = kw['src_dir']
  181.                     except KeyError:
  182.                         ldir = fs.Dir(f.dir.get_path(sd))
  183.                     else:
  184.                         ldir = fs.Dir(src_dir)
  185.                         if not ldir.is_under(f.dir):
  186.                             # They specified a source directory, but
  187.                             # it's above the SConscript directory.
  188.                             # Do the sensible thing and just use the
  189.                             # SConcript directory.
  190.                             ldir = fs.Dir(f.dir.get_path(sd))
  191.                     try:
  192.                         fs.chdir(ldir, change_os_dir=sconscript_chdir)
  193.                     except OSError:
  194.                         # There was no local directory, so we should be
  195.                         # able to chdir to the Repository directory.
  196.                         # Note that we do this directly, not through
  197.                         # fs.chdir(), because we still need to
  198.                         # interpret the stuff within the SConscript file
  199.                         # relative to where we are logically.
  200.                         fs.chdir(ldir, change_os_dir=0)
  201.                         # TODO Not sure how to handle src_dir here
  202.                         os.chdir(f.rfile().dir.get_abspath())
  203.                     # Append the SConscript directory to the beginning
  204.                     # of sys.path so Python modules in the SConscript
  205.                     # directory can be easily imported.
  206.                     sys.path = [ f.dir.get_abspath() ] + sys.path
  207.                     # This is the magic line that actually reads up
  208.                     # and executes the stuff in the SConscript file.
  209.                     # The locals for this frame contain the special
  210.                     # bottom-of-the-stack marker so that any
  211.                     # exceptions that occur when processing this
  212.                     # SConscript can base the printed frames at this
  213.                     # level and not show SCons internals as well.
  214.                     call_stack[-1].globals.update({stack_bottom:1})
  215.                     old_file = call_stack[-1].globals.get('__file__')
  216.                     try:
  217.                         del call_stack[-1].globals['__file__']
  218.                     except KeyError:
  219.                         pass
  220.                     try:
  221.                         try:
  222.                             exec _file_ in call_stack[-1].globals
  223.                         except SConscriptReturn:
  224.                             pass
  225.                     finally:
  226.                         if old_file is not None:
  227.                             call_stack[-1].globals.update({__file__:old_file})
  228.                 else:
  229.                     SCons.Warnings.warn(SCons.Warnings.MissingSConscriptWarning,
  230.                              "Ignoring missing SConscript '%s'" % f.path)
  231.         finally:
  232.             SCons.Script.sconscript_reading = SCons.Script.sconscript_reading - 1
  233.             sys.path = old_sys_path
  234.             frame = call_stack.pop()
  235.             try:
  236.                 fs.chdir(frame.prev_dir, change_os_dir=sconscript_chdir)
  237.             except OSError:
  238.                 # There was no local directory, so chdir to the
  239.                 # Repository directory.  Like above, we do this
  240.                 # directly.
  241.                 fs.chdir(frame.prev_dir, change_os_dir=0)
  242.                 rdir = frame.prev_dir.rdir()
  243.                 rdir._create()  # Make sure there's a directory there.
  244.                 os.chdir(rdir.get_abspath())
  245.             results.append(frame.retval)
  246.     # if we only have one script, don't return a tuple
  247.     if len(results) == 1:
  248.         return results[0]
  249.     else:
  250.         return tuple(results)
  251. def SConscript_exception(file=sys.stderr):
  252.     """Print an exception stack trace just for the SConscript file(s).
  253.     This will show users who have Python errors where the problem is,
  254.     without cluttering the output with all of the internal calls leading
  255.     up to where we exec the SConscript."""
  256.     exc_type, exc_value, exc_tb = sys.exc_info()
  257.     tb = exc_tb
  258.     while tb and not tb.tb_frame.f_locals.has_key(stack_bottom):
  259.         tb = tb.tb_next
  260.     if not tb:
  261.         # We did not find our exec statement, so this was actually a bug
  262.         # in SCons itself.  Show the whole stack.
  263.         tb = exc_tb
  264.     stack = traceback.extract_tb(tb)
  265.     try:
  266.         type = exc_type.__name__
  267.     except AttributeError:
  268.         type = str(exc_type)
  269.         if type[:11] == "exceptions.":
  270.             type = type[11:]
  271.     file.write('%s: %s:n' % (type, exc_value))
  272.     for fname, line, func, text in stack:
  273.         file.write('  File "%s", line %d:n' % (fname, line))
  274.         file.write('    %sn' % text)
  275. def annotate(node):
  276.     """Annotate a node with the stack frame describing the
  277.     SConscript file and line number that created it."""
  278.     tb = sys.exc_info()[2]
  279.     while tb and not tb.tb_frame.f_locals.has_key(stack_bottom):
  280.         tb = tb.tb_next
  281.     if not tb:
  282.         # We did not find any exec of an SConscript file: what?!
  283.         raise SCons.Errors.InternalError, "could not find SConscript stack frame"
  284.     node.creator = traceback.extract_stack(tb)[0]
  285. # The following line would cause each Node to be annotated using the
  286. # above function.  Unfortunately, this is a *huge* performance hit, so
  287. # leave this disabled until we find a more efficient mechanism.
  288. #SCons.Node.Annotate = annotate
  289. class SConsEnvironment(SCons.Environment.Base):
  290.     """An Environment subclass that contains all of the methods that
  291.     are particular to the wrapper SCons interface and which aren't
  292.     (or shouldn't be) part of the build engine itself.
  293.     Note that not all of the methods of this class have corresponding
  294.     global functions, there are some private methods.
  295.     """
  296.     #
  297.     # Private methods of an SConsEnvironment.
  298.     #
  299.     def _exceeds_version(self, major, minor, v_major, v_minor):
  300.         """Return 1 if 'major' and 'minor' are greater than the version
  301.         in 'v_major' and 'v_minor', and 0 otherwise."""
  302.         return (major > v_major or (major == v_major and minor > v_minor))
  303.     def _get_major_minor_revision(self, version_string):
  304.         """Split a version string into major, minor and (optionally)
  305.         revision parts.
  306.         This is complicated by the fact that a version string can be
  307.         something like 3.2b1."""
  308.         version = string.split(string.split(version_string, ' ')[0], '.')
  309.         v_major = int(version[0])
  310.         v_minor = int(re.match('d+', version[1]).group())
  311.         if len(version) >= 3:
  312.             v_revision = int(re.match('d+', version[2]).group())
  313.         else:
  314.             v_revision = 0
  315.         return v_major, v_minor, v_revision
  316.     def _get_SConscript_filenames(self, ls, kw):
  317.         """
  318.         Convert the parameters passed to # SConscript() calls into a list
  319.         of files and export variables.  If the parameters are invalid,
  320.         throws SCons.Errors.UserError. Returns a tuple (l, e) where l
  321.         is a list of SConscript filenames and e is a list of exports.
  322.         """
  323.         exports = []
  324.         if len(ls) == 0:
  325.             try:
  326.                 dirs = kw["dirs"]
  327.             except KeyError:
  328.                 raise SCons.Errors.UserError, 
  329.                       "Invalid SConscript usage - no parameters"
  330.             if not SCons.Util.is_List(dirs):
  331.                 dirs = [ dirs ]
  332.             dirs = map(str, dirs)
  333.             name = kw.get('name', 'SConscript')
  334.             files = map(lambda n, name = name: os.path.join(n, name), dirs)
  335.         elif len(ls) == 1:
  336.             files = ls[0]
  337.         elif len(ls) == 2:
  338.             files   = ls[0]
  339.             exports = self.Split(ls[1])
  340.         else:
  341.             raise SCons.Errors.UserError, 
  342.                   "Invalid SConscript() usage - too many arguments"
  343.         if not SCons.Util.is_List(files):
  344.             files = [ files ]
  345.         if kw.get('exports'):
  346.             exports.extend(self.Split(kw['exports']))
  347.         variant_dir = kw.get('variant_dir') or kw.get('build_dir')
  348.         if variant_dir:
  349.             if len(files) != 1:
  350.                 raise SCons.Errors.UserError, 
  351.                     "Invalid SConscript() usage - can only specify one SConscript with a variant_dir"
  352.             duplicate = kw.get('duplicate', 1)
  353.             src_dir = kw.get('src_dir')
  354.             if not src_dir:
  355.                 src_dir, fname = os.path.split(str(files[0]))
  356.                 files = [os.path.join(str(variant_dir), fname)]
  357.             else:
  358.                 if not isinstance(src_dir, SCons.Node.Node):
  359.                     src_dir = self.fs.Dir(src_dir)
  360.                 fn = files[0]
  361.                 if not isinstance(fn, SCons.Node.Node):
  362.                     fn = self.fs.File(fn)
  363.                 if fn.is_under(src_dir):
  364.                     # Get path relative to the source directory.
  365.                     fname = fn.get_path(src_dir)
  366.                     files = [os.path.join(str(variant_dir), fname)]
  367.                 else:
  368.                     files = [fn.abspath]
  369.                 kw['src_dir'] = variant_dir
  370.             self.fs.VariantDir(variant_dir, src_dir, duplicate)
  371.         return (files, exports)
  372.     #
  373.     # Public methods of an SConsEnvironment.  These get
  374.     # entry points in the global name space so they can be called
  375.     # as global functions.
  376.     #
  377.     def Configure(self, *args, **kw):
  378.         if not SCons.Script.sconscript_reading:
  379.             raise SCons.Errors.UserError, "Calling Configure from Builders is not supported."
  380.         kw['_depth'] = kw.get('_depth', 0) + 1
  381.         return apply(SCons.Environment.Base.Configure, (self,)+args, kw)
  382.     def Default(self, *targets):
  383.         SCons.Script._Set_Default_Targets(self, targets)
  384.     def EnsureSConsVersion(self, major, minor, revision=0):
  385.         """Exit abnormally if the SCons version is not late enough."""
  386.         scons_ver = self._get_major_minor_revision(SCons.__version__)
  387.         if scons_ver < (major, minor, revision):
  388.             if revision:
  389.                 scons_ver_string = '%d.%d.%d' % (major, minor, revision)
  390.             else:
  391.                 scons_ver_string = '%d.%d' % (major, minor)
  392.             print "SCons %s or greater required, but you have SCons %s" % 
  393.                   (scons_ver_string, SCons.__version__)
  394.             sys.exit(2)
  395.     def EnsurePythonVersion(self, major, minor):
  396.         """Exit abnormally if the Python version is not late enough."""
  397.         try:
  398.             v_major, v_minor, v_micro, release, serial = sys.version_info
  399.             python_ver = (v_major, v_minor)
  400.         except AttributeError:
  401.             python_ver = self._get_major_minor_revision(sys.version)[:2]
  402.         if python_ver < (major, minor):
  403.             v = string.split(sys.version, " ", 1)[0]
  404.             print "Python %d.%d or greater required, but you have Python %s" %(major,minor,v)
  405.             sys.exit(2)
  406.     def Exit(self, value=0):
  407.         sys.exit(value)
  408.     def Export(self, *vars):
  409.         for var in vars:
  410.             global_exports.update(compute_exports(self.Split(var)))
  411.     def GetLaunchDir(self):
  412.         global launch_dir
  413.         return launch_dir
  414.     def GetOption(self, name):
  415.         name = self.subst(name)
  416.         return SCons.Script.Main.GetOption(name)
  417.     def Help(self, text):
  418.         text = self.subst(text, raw=1)
  419.         SCons.Script.HelpFunction(text)
  420.     def Import(self, *vars):
  421.         try:
  422.             frame = call_stack[-1]
  423.             globals = frame.globals
  424.             exports = frame.exports
  425.             for var in vars:
  426.                 var = self.Split(var)
  427.                 for v in var:
  428.                     if v == '*':
  429.                         globals.update(global_exports)
  430.                         globals.update(exports)
  431.                     else:
  432.                         if exports.has_key(v):
  433.                             globals[v] = exports[v]
  434.                         else:
  435.                             globals[v] = global_exports[v]
  436.         except KeyError,x:
  437.             raise SCons.Errors.UserError, "Import of non-existent variable '%s'"%x
  438.     def SConscript(self, *ls, **kw):
  439.         def subst_element(x, subst=self.subst):
  440.             if SCons.Util.is_List(x):
  441.                 x = map(subst, x)
  442.             else:
  443.                 x = subst(x)
  444.             return x
  445.         ls = map(subst_element, ls)
  446.         subst_kw = {}
  447.         for key, val in kw.items():
  448.             if SCons.Util.is_String(val):
  449.                 val = self.subst(val)
  450.             elif SCons.Util.is_List(val):
  451.                 result = []
  452.                 for v in val:
  453.                     if SCons.Util.is_String(v):
  454.                         v = self.subst(v)
  455.                     result.append(v)
  456.                 val = result
  457.             subst_kw[key] = val
  458.         files, exports = self._get_SConscript_filenames(ls, subst_kw)
  459.         subst_kw['exports'] = exports
  460.         return apply(_SConscript, [self.fs,] + files, subst_kw)
  461.     def SConscriptChdir(self, flag):
  462.         global sconscript_chdir
  463.         sconscript_chdir = flag
  464.     def SetOption(self, name, value):
  465.         name = self.subst(name)
  466.         SCons.Script.Main.SetOption(name, value)
  467. #
  468. #
  469. #
  470. SCons.Environment.Environment = SConsEnvironment
  471. def Configure(*args, **kw):
  472.     if not SCons.Script.sconscript_reading:
  473.         raise SCons.Errors.UserError, "Calling Configure from Builders is not supported."
  474.     kw['_depth'] = 1
  475.     return apply(SCons.SConf.SConf, args, kw)
  476. # It's very important that the DefaultEnvironmentCall() class stay in this
  477. # file, with the get_calling_namespaces() function, the compute_exports()
  478. # function, the Frame class and the SConsEnvironment.Export() method.
  479. # These things make up the calling stack leading up to the actual global
  480. # Export() or SConscript() call that the user issued.  We want to allow
  481. # users to export local variables that they define, like so:
  482. #
  483. #       def func():
  484. #           x = 1
  485. #           Export('x')
  486. #
  487. # To support this, the get_calling_namespaces() function assumes that
  488. # the *first* stack frame that's not from this file is the local frame
  489. # for the Export() or SConscript() call.
  490. _DefaultEnvironmentProxy = None
  491. def get_DefaultEnvironmentProxy():
  492.     global _DefaultEnvironmentProxy
  493.     if not _DefaultEnvironmentProxy:
  494.         default_env = SCons.Defaults.DefaultEnvironment()
  495.         _DefaultEnvironmentProxy = SCons.Environment.NoSubstitutionProxy(default_env)
  496.     return _DefaultEnvironmentProxy
  497. class DefaultEnvironmentCall:
  498.     """A class that implements "global function" calls of
  499.     Environment methods by fetching the specified method from the
  500.     DefaultEnvironment's class.  Note that this uses an intermediate
  501.     proxy class instead of calling the DefaultEnvironment method
  502.     directly so that the proxy can override the subst() method and
  503.     thereby prevent expansion of construction variables (since from
  504.     the user's point of view this was called as a global function,
  505.     with no associated construction environment)."""
  506.     def __init__(self, method_name, subst=0):
  507.         self.method_name = method_name
  508.         if subst:
  509.             self.factory = SCons.Defaults.DefaultEnvironment
  510.         else:
  511.             self.factory = get_DefaultEnvironmentProxy
  512.     def __call__(self, *args, **kw):
  513.         env = self.factory()
  514.         method = getattr(env, self.method_name)
  515.         return apply(method, args, kw)
  516. def BuildDefaultGlobals():
  517.     """
  518.     Create a dictionary containing all the default globals for
  519.     SConstruct and SConscript files.
  520.     """
  521.     global GlobalDict
  522.     if GlobalDict is None:
  523.         GlobalDict = {}
  524.         import SCons.Script
  525.         d = SCons.Script.__dict__
  526.         def not_a_module(m, d=d, mtype=type(SCons.Script)):
  527.              return type(d[m]) != mtype
  528.         for m in filter(not_a_module, dir(SCons.Script)):
  529.              GlobalDict[m] = d[m]
  530.     return GlobalDict.copy()