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

外挂编程

开发平台:

Windows_Unix

  1. """SCons.Util
  2. Various utility functions go here.
  3. """
  4. #
  5. # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
  6. #
  7. # Permission is hereby granted, free of charge, to any person obtaining
  8. # a copy of this software and associated documentation files (the
  9. # "Software"), to deal in the Software without restriction, including
  10. # without limitation the rights to use, copy, modify, merge, publish,
  11. # distribute, sublicense, and/or sell copies of the Software, and to
  12. # permit persons to whom the Software is furnished to do so, subject to
  13. # the following conditions:
  14. #
  15. # The above copyright notice and this permission notice shall be included
  16. # in all copies or substantial portions of the Software.
  17. #
  18. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  19. # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  20. # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21. # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22. # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23. # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24. # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25. #
  26. __revision__ = "src/engine/SCons/Util.py 3057 2008/06/09 22:21:00 knight"
  27. import SCons.compat
  28. import copy
  29. import os
  30. import os.path
  31. import re
  32. import string
  33. import sys
  34. import types
  35. from UserDict import UserDict
  36. from UserList import UserList
  37. from UserString import UserString
  38. # Don't "from types import ..." these because we need to get at the
  39. # types module later to look for UnicodeType.
  40. DictType        = types.DictType
  41. InstanceType    = types.InstanceType
  42. ListType        = types.ListType
  43. StringType      = types.StringType
  44. TupleType       = types.TupleType
  45. def dictify(keys, values, result={}):
  46.     for k, v in zip(keys, values):
  47.         result[k] = v
  48.     return result
  49. _altsep = os.altsep
  50. if _altsep is None and sys.platform == 'win32':
  51.     # My ActivePython 2.0.1 doesn't set os.altsep!  What gives?
  52.     _altsep = '/'
  53. if _altsep:
  54.     def rightmost_separator(path, sep, _altsep=_altsep):
  55.         rfind = string.rfind
  56.         return max(rfind(path, sep), rfind(path, _altsep))
  57. else:
  58.     rightmost_separator = string.rfind
  59. # First two from the Python Cookbook, just for completeness.
  60. # (Yeah, yeah, YAGNI...)
  61. def containsAny(str, set):
  62.     """Check whether sequence str contains ANY of the items in set."""
  63.     for c in set:
  64.         if c in str: return 1
  65.     return 0
  66. def containsAll(str, set):
  67.     """Check whether sequence str contains ALL of the items in set."""
  68.     for c in set:
  69.         if c not in str: return 0
  70.     return 1
  71. def containsOnly(str, set):
  72.     """Check whether sequence str contains ONLY items in set."""
  73.     for c in str:
  74.         if c not in set: return 0
  75.     return 1
  76. def splitext(path):
  77.     "Same as os.path.splitext() but faster."
  78.     sep = rightmost_separator(path, os.sep)
  79.     dot = string.rfind(path, '.')
  80.     # An ext is only real if it has at least one non-digit char
  81.     if dot > sep and not containsOnly(path[dot:], "0123456789."):
  82.         return path[:dot],path[dot:]
  83.     else:
  84.         return path,""
  85. def updrive(path):
  86.     """
  87.     Make the drive letter (if any) upper case.
  88.     This is useful because Windows is inconsitent on the case
  89.     of the drive letter, which can cause inconsistencies when
  90.     calculating command signatures.
  91.     """
  92.     drive, rest = os.path.splitdrive(path)
  93.     if drive:
  94.         path = string.upper(drive) + rest
  95.     return path
  96. class CallableComposite(UserList):
  97.     """A simple composite callable class that, when called, will invoke all
  98.     of its contained callables with the same arguments."""
  99.     def __call__(self, *args, **kwargs):
  100.         retvals = map(lambda x, args=args, kwargs=kwargs: apply(x,
  101.                                                                 args,
  102.                                                                 kwargs),
  103.                       self.data)
  104.         if self.data and (len(self.data) == len(filter(callable, retvals))):
  105.             return self.__class__(retvals)
  106.         return NodeList(retvals)
  107. class NodeList(UserList):
  108.     """This class is almost exactly like a regular list of Nodes
  109.     (actually it can hold any object), with one important difference.
  110.     If you try to get an attribute from this list, it will return that
  111.     attribute from every item in the list.  For example:
  112.     >>> someList = NodeList([ '  foo  ', '  bar  ' ])
  113.     >>> someList.strip()
  114.     [ 'foo', 'bar' ]
  115.     """
  116.     def __nonzero__(self):
  117.         return len(self.data) != 0
  118.     def __str__(self):
  119.         return string.join(map(str, self.data))
  120.     def __getattr__(self, name):
  121.         if not self.data:
  122.             # If there is nothing in the list, then we have no attributes to
  123.             # pass through, so raise AttributeError for everything.
  124.             raise AttributeError, "NodeList has no attribute: %s" % name
  125.         # Return a list of the attribute, gotten from every element
  126.         # in the list
  127.         attrList = map(lambda x, n=name: getattr(x, n), self.data)
  128.         # Special case.  If the attribute is callable, we do not want
  129.         # to return a list of callables.  Rather, we want to return a
  130.         # single callable that, when called, will invoke the function on
  131.         # all elements of this list.
  132.         if self.data and (len(self.data) == len(filter(callable, attrList))):
  133.             return CallableComposite(attrList)
  134.         return self.__class__(attrList)
  135. _get_env_var = re.compile(r'^$([_a-zA-Z]w*|{[_a-zA-Z]w*})$')
  136. def get_environment_var(varstr):
  137.     """Given a string, first determine if it looks like a reference
  138.     to a single environment variable, like "$FOO" or "${FOO}".
  139.     If so, return that variable with no decorations ("FOO").
  140.     If not, return None."""
  141.     mo=_get_env_var.match(to_String(varstr))
  142.     if mo:
  143.         var = mo.group(1)
  144.         if var[0] == '{':
  145.             return var[1:-1]
  146.         else:
  147.             return var
  148.     else:
  149.         return None
  150. class DisplayEngine:
  151.     def __init__(self):
  152.         self.__call__ = self.print_it
  153.     def print_it(self, text, append_newline=1):
  154.         if append_newline: text = text + 'n'
  155.         try:
  156.             sys.stdout.write(text)
  157.         except IOError:
  158.             # Stdout might be connected to a pipe that has been closed
  159.             # by now. The most likely reason for the pipe being closed
  160.             # is that the user has press ctrl-c. It this is the case,
  161.             # then SCons is currently shutdown. We therefore ignore
  162.             # IOError's here so that SCons can continue and shutdown
  163.             # properly so that the .sconsign is correctly written
  164.             # before SCons exits.
  165.             pass
  166.     def dont_print(self, text, append_newline=1):
  167.         pass
  168.     def set_mode(self, mode):
  169.         if mode:
  170.             self.__call__ = self.print_it
  171.         else:
  172.             self.__call__ = self.dont_print
  173. def render_tree(root, child_func, prune=0, margin=[0], visited={}):
  174.     """
  175.     Render a tree of nodes into an ASCII tree view.
  176.     root - the root node of the tree
  177.     child_func - the function called to get the children of a node
  178.     prune - don't visit the same node twice
  179.     margin - the format of the left margin to use for children of root.
  180.        1 results in a pipe, and 0 results in no pipe.
  181.     visited - a dictionary of visited nodes in the current branch if not prune,
  182.        or in the whole tree if prune.
  183.     """
  184.     rname = str(root)
  185.     children = child_func(root)
  186.     retval = ""
  187.     for pipe in margin[:-1]:
  188.         if pipe:
  189.             retval = retval + "| "
  190.         else:
  191.             retval = retval + "  "
  192.     if visited.has_key(rname):
  193.         return retval + "+-[" + rname + "]n"
  194.     retval = retval + "+-" + rname + "n"
  195.     if not prune:
  196.         visited = copy.copy(visited)
  197.     visited[rname] = 1
  198.     for i in range(len(children)):
  199.         margin.append(i<len(children)-1)
  200.         retval = retval + render_tree(children[i], child_func, prune, margin, visited
  201. )
  202.         margin.pop()
  203.     return retval
  204. IDX = lambda N: N and 1 or 0
  205. def print_tree(root, child_func, prune=0, showtags=0, margin=[0], visited={}):
  206.     """
  207.     Print a tree of nodes.  This is like render_tree, except it prints
  208.     lines directly instead of creating a string representation in memory,
  209.     so that huge trees can be printed.
  210.     root - the root node of the tree
  211.     child_func - the function called to get the children of a node
  212.     prune - don't visit the same node twice
  213.     showtags - print status information to the left of each node line
  214.     margin - the format of the left margin to use for children of root.
  215.        1 results in a pipe, and 0 results in no pipe.
  216.     visited - a dictionary of visited nodes in the current branch if not prune,
  217.        or in the whole tree if prune.
  218.     """
  219.     rname = str(root)
  220.     if showtags:
  221.         if showtags == 2:
  222.             print ' E         = exists'
  223.             print '  R        = exists in repository only'
  224.             print '   b       = implicit builder'
  225.             print '   B       = explicit builder'
  226.             print '    S      = side effect'
  227.             print '     P     = precious'
  228.             print '      A    = always build'
  229.             print '       C   = current'
  230.             print '        N  = no clean'
  231.             print '         H = no cache'
  232.             print ''
  233.         tags = ['[']
  234.         tags.append(' E'[IDX(root.exists())])
  235.         tags.append(' R'[IDX(root.rexists() and not root.exists())])
  236.         tags.append(' BbB'[[0,1][IDX(root.has_explicit_builder())] +
  237.                            [0,2][IDX(root.has_builder())]])
  238.         tags.append(' S'[IDX(root.side_effect)])
  239.         tags.append(' P'[IDX(root.precious)])
  240.         tags.append(' A'[IDX(root.always_build)])
  241.         tags.append(' C'[IDX(root.is_up_to_date())])
  242.         tags.append(' N'[IDX(root.noclean)])
  243.         tags.append(' H'[IDX(root.nocache)])
  244.         tags.append(']')
  245.     else:
  246.         tags = []
  247.     def MMM(m):
  248.         return ["  ","| "][m]
  249.     margins = map(MMM, margin[:-1])
  250.     children = child_func(root)
  251.     if prune and visited.has_key(rname) and children:
  252.         print string.join(tags + margins + ['+-[', rname, ']'], '')
  253.         return
  254.     print string.join(tags + margins + ['+-', rname], '')
  255.     visited[rname] = 1
  256.     if children:
  257.         margin.append(1)
  258.         map(lambda C, cf=child_func, p=prune, i=IDX(showtags), m=margin, v=visited:
  259.                    print_tree(C, cf, p, i, m, v),
  260.             children[:-1])
  261.         margin[-1] = 0
  262.         print_tree(children[-1], child_func, prune, IDX(showtags), margin, visited)
  263.         margin.pop()
  264. # Functions for deciding if things are like various types, mainly to
  265. # handle UserDict, UserList and UserString like their underlying types.
  266. #
  267. # Yes, all of this manual testing breaks polymorphism, and the real
  268. # Pythonic way to do all of this would be to just try it and handle the
  269. # exception, but handling the exception when it's not the right type is
  270. # often too slow.
  271. try:
  272.     class mystr(str):
  273.         pass
  274. except TypeError:
  275.     # An older Python version without new-style classes.
  276.     #
  277.     # The actual implementations here have been selected after timings
  278.     # coded up in in bench/is_types.py (from the SCons source tree,
  279.     # see the scons-src distribution), mostly against Python 1.5.2.
  280.     # Key results from those timings:
  281.     #
  282.     #   --  Storing the type of the object in a variable (t = type(obj))
  283.     #       slows down the case where it's a native type and the first
  284.     #       comparison will match, but nicely speeds up the case where
  285.     #       it's a different native type.  Since that's going to be
  286.     #       common, it's a good tradeoff.
  287.     #
  288.     #   --  The data show that calling isinstance() on an object that's
  289.     #       a native type (dict, list or string) is expensive enough
  290.     #       that checking up front for whether the object is of type
  291.     #       InstanceType is a pretty big win, even though it does slow
  292.     #       down the case where it really *is* an object instance a
  293.     #       little bit.
  294.     def is_Dict(obj):
  295.         t = type(obj)
  296.         return t is DictType or 
  297.                (t is InstanceType and isinstance(obj, UserDict))
  298.     def is_List(obj):
  299.         t = type(obj)
  300.         return t is ListType 
  301.             or (t is InstanceType and isinstance(obj, UserList))
  302.     def is_Sequence(obj):
  303.         t = type(obj)
  304.         return t is ListType 
  305.             or t is TupleType 
  306.             or (t is InstanceType and isinstance(obj, UserList))
  307.     def is_Tuple(obj):
  308.         t = type(obj)
  309.         return t is TupleType
  310.     if hasattr(types, 'UnicodeType'):
  311.         def is_String(obj):
  312.             t = type(obj)
  313.             return t is StringType 
  314.                 or t is UnicodeType 
  315.                 or (t is InstanceType and isinstance(obj, UserString))
  316.     else:
  317.         def is_String(obj):
  318.             t = type(obj)
  319.             return t is StringType 
  320.                 or (t is InstanceType and isinstance(obj, UserString))
  321.     def is_Scalar(obj):
  322.         return is_String(obj) or not is_Sequence(obj)
  323.     def flatten(obj, result=None):
  324.         """Flatten a sequence to a non-nested list.
  325.         Flatten() converts either a single scalar or a nested sequence
  326.         to a non-nested list. Note that flatten() considers strings
  327.         to be scalars instead of sequences like Python would.
  328.         """
  329.         if is_Scalar(obj):
  330.             return [obj]
  331.         if result is None:
  332.             result = []
  333.         for item in obj:
  334.             if is_Scalar(item):
  335.                 result.append(item)
  336.             else:
  337.                 flatten_sequence(item, result)
  338.         return result
  339.     def flatten_sequence(sequence, result=None):
  340.         """Flatten a sequence to a non-nested list.
  341.         Same as flatten(), but it does not handle the single scalar
  342.         case. This is slightly more efficient when one knows that
  343.         the sequence to flatten can not be a scalar.
  344.         """
  345.         if result is None:
  346.             result = []
  347.         for item in sequence:
  348.             if is_Scalar(item):
  349.                 result.append(item)
  350.             else:
  351.                 flatten_sequence(item, result)
  352.         return result
  353.     #
  354.     # Generic convert-to-string functions that abstract away whether or
  355.     # not the Python we're executing has Unicode support.  The wrapper
  356.     # to_String_for_signature() will use a for_signature() method if the
  357.     # specified object has one.
  358.     #
  359.     if hasattr(types, 'UnicodeType'):
  360.         UnicodeType = types.UnicodeType
  361.         def to_String(s):
  362.             if isinstance(s, UserString):
  363.                 t = type(s.data)
  364.             else:
  365.                 t = type(s)
  366.             if t is UnicodeType:
  367.                 return unicode(s)
  368.             else:
  369.                 return str(s)
  370.     else:
  371.         to_String = str
  372.     def to_String_for_signature(obj):
  373.         try:
  374.             f = obj.for_signature
  375.         except AttributeError:
  376.             return to_String_for_subst(obj)
  377.         else:
  378.             return f()
  379.     def to_String_for_subst(s):
  380.         if is_Sequence( s ):
  381.             return string.join( map(to_String_for_subst, s) )
  382.         return to_String( s )
  383. else:
  384.     # A modern Python version with new-style classes, so we can just use
  385.     # isinstance().
  386.     #
  387.     # We are using the following trick to speed-up these
  388.     # functions. Default arguments are used to take a snapshot of the
  389.     # the global functions and constants used by these functions. This
  390.     # transforms accesses to global variable into local variables
  391.     # accesses (i.e. LOAD_FAST instead of LOAD_GLOBAL).
  392.     DictTypes = (dict, UserDict)
  393.     ListTypes = (list, UserList)
  394.     SequenceTypes = (list, tuple, UserList)
  395.     # Empirically, Python versions with new-style classes all have
  396.     # unicode.
  397.     #
  398.     # Note that profiling data shows a speed-up when comparing
  399.     # explicitely with str and unicode instead of simply comparing
  400.     # with basestring. (at least on Python 2.5.1)
  401.     StringTypes = (str, unicode, UserString)
  402.     # Empirically, it is faster to check explicitely for str and
  403.     # unicode than for basestring.
  404.     BaseStringTypes = (str, unicode)
  405.     def is_Dict(obj, isinstance=isinstance, DictTypes=DictTypes):
  406.         return isinstance(obj, DictTypes)
  407.     def is_List(obj, isinstance=isinstance, ListTypes=ListTypes):
  408.         return isinstance(obj, ListTypes)
  409.     def is_Sequence(obj, isinstance=isinstance, SequenceTypes=SequenceTypes):
  410.         return isinstance(obj, SequenceTypes)
  411.     def is_Tuple(obj, isinstance=isinstance, tuple=tuple):
  412.         return isinstance(obj, tuple)
  413.     def is_String(obj, isinstance=isinstance, StringTypes=StringTypes):
  414.         return isinstance(obj, StringTypes)
  415.     def is_Scalar(obj, isinstance=isinstance, StringTypes=StringTypes, SequenceTypes=SequenceTypes):
  416.         # Profiling shows that there is an impressive speed-up of 2x
  417.         # when explicitely checking for strings instead of just not
  418.         # sequence when the argument (i.e. obj) is already a string.
  419.         # But, if obj is a not string than it is twice as fast to
  420.         # check only for 'not sequence'. The following code therefore
  421.         # assumes that the obj argument is a string must of the time.
  422.         return isinstance(obj, StringTypes) or not isinstance(obj, SequenceTypes)
  423.     def do_flatten(sequence, result, isinstance=isinstance, 
  424.                    StringTypes=StringTypes, SequenceTypes=SequenceTypes):
  425.         for item in sequence:
  426.             if isinstance(item, StringTypes) or not isinstance(item, SequenceTypes):
  427.                 result.append(item)
  428.             else:
  429.                 do_flatten(item, result)
  430.     def flatten(obj, isinstance=isinstance, StringTypes=StringTypes, 
  431.                 SequenceTypes=SequenceTypes, do_flatten=do_flatten):
  432.         """Flatten a sequence to a non-nested list.
  433.         Flatten() converts either a single scalar or a nested sequence
  434.         to a non-nested list. Note that flatten() considers strings
  435.         to be scalars instead of sequences like Python would.
  436.         """
  437.         if isinstance(obj, StringTypes) or not isinstance(obj, SequenceTypes):
  438.             return [obj]
  439.         result = []
  440.         for item in obj:
  441.             if isinstance(item, StringTypes) or not isinstance(item, SequenceTypes):
  442.                 result.append(item)
  443.             else:
  444.                 do_flatten(item, result)
  445.         return result
  446.     def flatten_sequence(sequence, isinstance=isinstance, StringTypes=StringTypes, 
  447.                          SequenceTypes=SequenceTypes, do_flatten=do_flatten):
  448.         """Flatten a sequence to a non-nested list.
  449.         Same as flatten(), but it does not handle the single scalar
  450.         case. This is slightly more efficient when one knows that
  451.         the sequence to flatten can not be a scalar.
  452.         """
  453.         result = []
  454.         for item in sequence:
  455.             if isinstance(item, StringTypes) or not isinstance(item, SequenceTypes):
  456.                 result.append(item)
  457.             else:
  458.                 do_flatten(item, result)
  459.         return result
  460.     #
  461.     # Generic convert-to-string functions that abstract away whether or
  462.     # not the Python we're executing has Unicode support.  The wrapper
  463.     # to_String_for_signature() will use a for_signature() method if the
  464.     # specified object has one.
  465.     #
  466.     def to_String(s, 
  467.                   isinstance=isinstance, str=str,
  468.                   UserString=UserString, BaseStringTypes=BaseStringTypes):
  469.         if isinstance(s,BaseStringTypes):
  470.             # Early out when already a string!
  471.             return s
  472.         elif isinstance(s, UserString):
  473.             # s.data can only be either a unicode or a regular
  474.             # string. Please see the UserString initializer.
  475.             return s.data
  476.         else:
  477.             return str(s)
  478.     def to_String_for_subst(s, 
  479.                             isinstance=isinstance, join=string.join, str=str, to_String=to_String,
  480.                             BaseStringTypes=BaseStringTypes, SequenceTypes=SequenceTypes,
  481.                             UserString=UserString):
  482.                             
  483.         # Note that the test cases are sorted by order of probability.
  484.         if isinstance(s, BaseStringTypes):
  485.             return s
  486.         elif isinstance(s, SequenceTypes):
  487.             l = []
  488.             for e in s:
  489.                 l.append(to_String_for_subst(e))
  490.             return join( s )
  491.         elif isinstance(s, UserString):
  492.             # s.data can only be either a unicode or a regular
  493.             # string. Please see the UserString initializer.
  494.             return s.data
  495.         else:
  496.             return str(s)
  497.     def to_String_for_signature(obj, to_String_for_subst=to_String_for_subst, 
  498.                                 AttributeError=AttributeError):
  499.         try:
  500.             f = obj.for_signature
  501.         except AttributeError:
  502.             return to_String_for_subst(obj)
  503.         else:
  504.             return f()
  505. # The SCons "semi-deep" copy.
  506. #
  507. # This makes separate copies of lists (including UserList objects)
  508. # dictionaries (including UserDict objects) and tuples, but just copies
  509. # references to anything else it finds.
  510. #
  511. # A special case is any object that has a __semi_deepcopy__() method,
  512. # which we invoke to create the copy, which is used by the BuilderDict
  513. # class because of its extra initialization argument.
  514. #
  515. # The dispatch table approach used here is a direct rip-off from the
  516. # normal Python copy module.
  517. _semi_deepcopy_dispatch = d = {}
  518. def _semi_deepcopy_dict(x):
  519.     copy = {}
  520.     for key, val in x.items():
  521.         # The regular Python copy.deepcopy() also deepcopies the key,
  522.         # as follows:
  523.         #
  524.         #    copy[semi_deepcopy(key)] = semi_deepcopy(val)
  525.         #
  526.         # Doesn't seem like we need to, but we'll comment it just in case.
  527.         copy[key] = semi_deepcopy(val)
  528.     return copy
  529. d[types.DictionaryType] = _semi_deepcopy_dict
  530. def _semi_deepcopy_list(x):
  531.     return map(semi_deepcopy, x)
  532. d[types.ListType] = _semi_deepcopy_list
  533. def _semi_deepcopy_tuple(x):
  534.     return tuple(map(semi_deepcopy, x))
  535. d[types.TupleType] = _semi_deepcopy_tuple
  536. def _semi_deepcopy_inst(x):
  537.     if hasattr(x, '__semi_deepcopy__'):
  538.         return x.__semi_deepcopy__()
  539.     elif isinstance(x, UserDict):
  540.         return x.__class__(_semi_deepcopy_dict(x))
  541.     elif isinstance(x, UserList):
  542.         return x.__class__(_semi_deepcopy_list(x))
  543.     else:
  544.         return x
  545. d[types.InstanceType] = _semi_deepcopy_inst
  546. def semi_deepcopy(x):
  547.     copier = _semi_deepcopy_dispatch.get(type(x))
  548.     if copier:
  549.         return copier(x)
  550.     else:
  551.         return x
  552. class Proxy:
  553.     """A simple generic Proxy class, forwarding all calls to
  554.     subject.  So, for the benefit of the python newbie, what does
  555.     this really mean?  Well, it means that you can take an object, let's
  556.     call it 'objA', and wrap it in this Proxy class, with a statement
  557.     like this
  558.                  proxyObj = Proxy(objA),
  559.     Then, if in the future, you do something like this
  560.                  x = proxyObj.var1,
  561.     since Proxy does not have a 'var1' attribute (but presumably objA does),
  562.     the request actually is equivalent to saying
  563.                  x = objA.var1
  564.     Inherit from this class to create a Proxy."""
  565.     def __init__(self, subject):
  566.         """Wrap an object as a Proxy object"""
  567.         self.__subject = subject
  568.     def __getattr__(self, name):
  569.         """Retrieve an attribute from the wrapped object.  If the named
  570.            attribute doesn't exist, AttributeError is raised"""
  571.         return getattr(self.__subject, name)
  572.     def get(self):
  573.         """Retrieve the entire wrapped object"""
  574.         return self.__subject
  575.     def __cmp__(self, other):
  576.         if issubclass(other.__class__, self.__subject.__class__):
  577.             return cmp(self.__subject, other)
  578.         return cmp(self.__dict__, other.__dict__)
  579. # attempt to load the windows registry module:
  580. can_read_reg = 0
  581. try:
  582.     import _winreg
  583.     can_read_reg = 1
  584.     hkey_mod = _winreg
  585.     RegOpenKeyEx = _winreg.OpenKeyEx
  586.     RegEnumKey = _winreg.EnumKey
  587.     RegEnumValue = _winreg.EnumValue
  588.     RegQueryValueEx = _winreg.QueryValueEx
  589.     RegError = _winreg.error
  590. except ImportError:
  591.     try:
  592.         import win32api
  593.         import win32con
  594.         can_read_reg = 1
  595.         hkey_mod = win32con
  596.         RegOpenKeyEx = win32api.RegOpenKeyEx
  597.         RegEnumKey = win32api.RegEnumKey
  598.         RegEnumValue = win32api.RegEnumValue
  599.         RegQueryValueEx = win32api.RegQueryValueEx
  600.         RegError = win32api.error
  601.     except ImportError:
  602.         class _NoError(Exception):
  603.             pass
  604.         RegError = _NoError
  605. if can_read_reg:
  606.     HKEY_CLASSES_ROOT = hkey_mod.HKEY_CLASSES_ROOT
  607.     HKEY_LOCAL_MACHINE = hkey_mod.HKEY_LOCAL_MACHINE
  608.     HKEY_CURRENT_USER = hkey_mod.HKEY_CURRENT_USER
  609.     HKEY_USERS = hkey_mod.HKEY_USERS
  610.     def RegGetValue(root, key):
  611.         """This utility function returns a value in the registry
  612.         without having to open the key first.  Only available on
  613.         Windows platforms with a version of Python that can read the
  614.         registry.  Returns the same thing as
  615.         SCons.Util.RegQueryValueEx, except you just specify the entire
  616.         path to the value, and don't have to bother opening the key
  617.         first.  So:
  618.         Instead of:
  619.           k = SCons.Util.RegOpenKeyEx(SCons.Util.HKEY_LOCAL_MACHINE,
  620.                 r'SOFTWAREMicrosoftWindowsCurrentVersion')
  621.           out = SCons.Util.RegQueryValueEx(k,
  622.                 'ProgramFilesDir')
  623.         You can write:
  624.           out = SCons.Util.RegGetValue(SCons.Util.HKEY_LOCAL_MACHINE,
  625.                 r'SOFTWAREMicrosoftWindowsCurrentVersionProgramFilesDir')
  626.         """
  627.         # I would use os.path.split here, but it's not a filesystem
  628.         # path...
  629.         p = key.rfind('\') + 1
  630.         keyp = key[:p]
  631.         val = key[p:]
  632.         k = RegOpenKeyEx(root, keyp)
  633.         return RegQueryValueEx(k,val)
  634. if sys.platform == 'win32':
  635.     def WhereIs(file, path=None, pathext=None, reject=[]):
  636.         if path is None:
  637.             try:
  638.                 path = os.environ['PATH']
  639.             except KeyError:
  640.                 return None
  641.         if is_String(path):
  642.             path = string.split(path, os.pathsep)
  643.         if pathext is None:
  644.             try:
  645.                 pathext = os.environ['PATHEXT']
  646.             except KeyError:
  647.                 pathext = '.COM;.EXE;.BAT;.CMD'
  648.         if is_String(pathext):
  649.             pathext = string.split(pathext, os.pathsep)
  650.         for ext in pathext:
  651.             if string.lower(ext) == string.lower(file[-len(ext):]):
  652.                 pathext = ['']
  653.                 break
  654.         if not is_List(reject) and not is_Tuple(reject):
  655.             reject = [reject]
  656.         for dir in path:
  657.             f = os.path.join(dir, file)
  658.             for ext in pathext:
  659.                 fext = f + ext
  660.                 if os.path.isfile(fext):
  661.                     try:
  662.                         reject.index(fext)
  663.                     except ValueError:
  664.                         return os.path.normpath(fext)
  665.                     continue
  666.         return None
  667. elif os.name == 'os2':
  668.     def WhereIs(file, path=None, pathext=None, reject=[]):
  669.         if path is None:
  670.             try:
  671.                 path = os.environ['PATH']
  672.             except KeyError:
  673.                 return None
  674.         if is_String(path):
  675.             path = string.split(path, os.pathsep)
  676.         if pathext is None:
  677.             pathext = ['.exe', '.cmd']
  678.         for ext in pathext:
  679.             if string.lower(ext) == string.lower(file[-len(ext):]):
  680.                 pathext = ['']
  681.                 break
  682.         if not is_List(reject) and not is_Tuple(reject):
  683.             reject = [reject]
  684.         for dir in path:
  685.             f = os.path.join(dir, file)
  686.             for ext in pathext:
  687.                 fext = f + ext
  688.                 if os.path.isfile(fext):
  689.                     try:
  690.                         reject.index(fext)
  691.                     except ValueError:
  692.                         return os.path.normpath(fext)
  693.                     continue
  694.         return None
  695. else:
  696.     def WhereIs(file, path=None, pathext=None, reject=[]):
  697.         import stat
  698.         if path is None:
  699.             try:
  700.                 path = os.environ['PATH']
  701.             except KeyError:
  702.                 return None
  703.         if is_String(path):
  704.             path = string.split(path, os.pathsep)
  705.         if not is_List(reject) and not is_Tuple(reject):
  706.             reject = [reject]
  707.         for d in path:
  708.             f = os.path.join(d, file)
  709.             if os.path.isfile(f):
  710.                 try:
  711.                     st = os.stat(f)
  712.                 except OSError:
  713.                     # os.stat() raises OSError, not IOError if the file
  714.                     # doesn't exist, so in this case we let IOError get
  715.                     # raised so as to not mask possibly serious disk or
  716.                     # network issues.
  717.                     continue
  718.                 if stat.S_IMODE(st[stat.ST_MODE]) & 0111:
  719.                     try:
  720.                         reject.index(f)
  721.                     except ValueError:
  722.                         return os.path.normpath(f)
  723.                     continue
  724.         return None
  725. def PrependPath(oldpath, newpath, sep = os.pathsep):
  726.     """This prepends newpath elements to the given oldpath.  Will only
  727.     add any particular path once (leaving the first one it encounters
  728.     and ignoring the rest, to preserve path order), and will
  729.     os.path.normpath and os.path.normcase all paths to help assure
  730.     this.  This can also handle the case where the given old path
  731.     variable is a list instead of a string, in which case a list will
  732.     be returned instead of a string.
  733.     Example:
  734.       Old Path: "/foo/bar:/foo"
  735.       New Path: "/biz/boom:/foo"
  736.       Result:   "/biz/boom:/foo:/foo/bar"
  737.     """
  738.     orig = oldpath
  739.     is_list = 1
  740.     paths = orig
  741.     if not is_List(orig) and not is_Tuple(orig):
  742.         paths = string.split(paths, sep)
  743.         is_list = 0
  744.     if is_List(newpath) or is_Tuple(newpath):
  745.         newpaths = newpath
  746.     else:
  747.         newpaths = string.split(newpath, sep)
  748.     newpaths = newpaths + paths # prepend new paths
  749.     normpaths = []
  750.     paths = []
  751.     # now we add them only if they are unique
  752.     for path in newpaths:
  753.         normpath = os.path.normpath(os.path.normcase(path))
  754.         if path and not normpath in normpaths:
  755.             paths.append(path)
  756.             normpaths.append(normpath)
  757.     if is_list:
  758.         return paths
  759.     else:
  760.         return string.join(paths, sep)
  761. def AppendPath(oldpath, newpath, sep = os.pathsep):
  762.     """This appends new path elements to the given old path.  Will
  763.     only add any particular path once (leaving the last one it
  764.     encounters and ignoring the rest, to preserve path order), and
  765.     will os.path.normpath and os.path.normcase all paths to help
  766.     assure this.  This can also handle the case where the given old
  767.     path variable is a list instead of a string, in which case a list
  768.     will be returned instead of a string.
  769.     Example:
  770.       Old Path: "/foo/bar:/foo"
  771.       New Path: "/biz/boom:/foo"
  772.       Result:   "/foo/bar:/biz/boom:/foo"
  773.     """
  774.     orig = oldpath
  775.     is_list = 1
  776.     paths = orig
  777.     if not is_List(orig) and not is_Tuple(orig):
  778.         paths = string.split(paths, sep)
  779.         is_list = 0
  780.     if is_List(newpath) or is_Tuple(newpath):
  781.         newpaths = newpath
  782.     else:
  783.         newpaths = string.split(newpath, sep)
  784.     newpaths = paths + newpaths # append new paths
  785.     newpaths.reverse()
  786.     normpaths = []
  787.     paths = []
  788.     # now we add them only of they are unique
  789.     for path in newpaths:
  790.         normpath = os.path.normpath(os.path.normcase(path))
  791.         if path and not normpath in normpaths:
  792.             paths.append(path)
  793.             normpaths.append(normpath)
  794.     paths.reverse()
  795.     if is_list:
  796.         return paths
  797.     else:
  798.         return string.join(paths, sep)
  799. if sys.platform == 'cygwin':
  800.     def get_native_path(path):
  801.         """Transforms an absolute path into a native path for the system.  In
  802.         Cygwin, this converts from a Cygwin path to a Windows one."""
  803.         return string.replace(os.popen('cygpath -w ' + path).read(), 'n', '')
  804. else:
  805.     def get_native_path(path):
  806.         """Transforms an absolute path into a native path for the system.
  807.         Non-Cygwin version, just leave the path alone."""
  808.         return path
  809. display = DisplayEngine()
  810. def Split(arg):
  811.     if is_List(arg) or is_Tuple(arg):
  812.         return arg
  813.     elif is_String(arg):
  814.         return string.split(arg)
  815.     else:
  816.         return [arg]
  817. class CLVar(UserList):
  818.     """A class for command-line construction variables.
  819.     This is a list that uses Split() to split an initial string along
  820.     white-space arguments, and similarly to split any strings that get
  821.     added.  This allows us to Do the Right Thing with Append() and
  822.     Prepend() (as well as straight Python foo = env['VAR'] + 'arg1
  823.     arg2') regardless of whether a user adds a list or a string to a
  824.     command-line construction variable.
  825.     """
  826.     def __init__(self, seq = []):
  827.         UserList.__init__(self, Split(seq))
  828.     def __coerce__(self, other):
  829.         return (self, CLVar(other))
  830.     def __str__(self):
  831.         return string.join(self.data)
  832. # A dictionary that preserves the order in which items are added.
  833. # Submitted by David Benjamin to ActiveState's Python Cookbook web site:
  834. #     http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/107747
  835. # Including fixes/enhancements from the follow-on discussions.
  836. class OrderedDict(UserDict):
  837.     def __init__(self, dict = None):
  838.         self._keys = []
  839.         UserDict.__init__(self, dict)
  840.     def __delitem__(self, key):
  841.         UserDict.__delitem__(self, key)
  842.         self._keys.remove(key)
  843.     def __setitem__(self, key, item):
  844.         UserDict.__setitem__(self, key, item)
  845.         if key not in self._keys: self._keys.append(key)
  846.     def clear(self):
  847.         UserDict.clear(self)
  848.         self._keys = []
  849.     def copy(self):
  850.         dict = OrderedDict()
  851.         dict.update(self)
  852.         return dict
  853.     def items(self):
  854.         return zip(self._keys, self.values())
  855.     def keys(self):
  856.         return self._keys[:]
  857.     def popitem(self):
  858.         try:
  859.             key = self._keys[-1]
  860.         except IndexError:
  861.             raise KeyError('dictionary is empty')
  862.         val = self[key]
  863.         del self[key]
  864.         return (key, val)
  865.     def setdefault(self, key, failobj = None):
  866.         UserDict.setdefault(self, key, failobj)
  867.         if key not in self._keys: self._keys.append(key)
  868.     def update(self, dict):
  869.         for (key, val) in dict.items():
  870.             self.__setitem__(key, val)
  871.     def values(self):
  872.         return map(self.get, self._keys)
  873. class Selector(OrderedDict):
  874.     """A callable ordered dictionary that maps file suffixes to
  875.     dictionary values.  We preserve the order in which items are added
  876.     so that get_suffix() calls always return the first suffix added."""
  877.     def __call__(self, env, source):
  878.         try:
  879.             ext = source[0].suffix
  880.         except IndexError:
  881.             ext = ""
  882.         try:
  883.             return self[ext]
  884.         except KeyError:
  885.             # Try to perform Environment substitution on the keys of
  886.             # the dictionary before giving up.
  887.             s_dict = {}
  888.             for (k,v) in self.items():
  889.                 if not k is None:
  890.                     s_k = env.subst(k)
  891.                     if s_dict.has_key(s_k):
  892.                         # We only raise an error when variables point
  893.                         # to the same suffix.  If one suffix is literal
  894.                         # and a variable suffix contains this literal,
  895.                         # the literal wins and we don't raise an error.
  896.                         raise KeyError, (s_dict[s_k][0], k, s_k)
  897.                     s_dict[s_k] = (k,v)
  898.             try:
  899.                 return s_dict[ext][1]
  900.             except KeyError:
  901.                 try:
  902.                     return self[None]
  903.                 except KeyError:
  904.                     return None
  905. if sys.platform == 'cygwin':
  906.     # On Cygwin, os.path.normcase() lies, so just report back the
  907.     # fact that the underlying Windows OS is case-insensitive.
  908.     def case_sensitive_suffixes(s1, s2):
  909.         return 0
  910. else:
  911.     def case_sensitive_suffixes(s1, s2):
  912.         return (os.path.normcase(s1) != os.path.normcase(s2))
  913. def adjustixes(fname, pre, suf, ensure_suffix=False):
  914.     if pre:
  915.         path, fn = os.path.split(os.path.normpath(fname))
  916.         if fn[:len(pre)] != pre:
  917.             fname = os.path.join(path, pre + fn)
  918.     # Only append a suffix if the suffix we're going to add isn't already
  919.     # there, and if either we've been asked to ensure the specific suffix
  920.     # is present or there's no suffix on it at all.
  921.     if suf and fname[-len(suf):] != suf and 
  922.        (ensure_suffix or not splitext(fname)[1]):
  923.             fname = fname + suf
  924.     return fname
  925. # From Tim Peters,
  926. # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52560
  927. # ASPN: Python Cookbook: Remove duplicates from a sequence
  928. # (Also in the printed Python Cookbook.)
  929. def unique(s):
  930.     """Return a list of the elements in s, but without duplicates.
  931.     For example, unique([1,2,3,1,2,3]) is some permutation of [1,2,3],
  932.     unique("abcabc") some permutation of ["a", "b", "c"], and
  933.     unique(([1, 2], [2, 3], [1, 2])) some permutation of
  934.     [[2, 3], [1, 2]].
  935.     For best speed, all sequence elements should be hashable.  Then
  936.     unique() will usually work in linear time.
  937.     If not possible, the sequence elements should enjoy a total
  938.     ordering, and if list(s).sort() doesn't raise TypeError it's
  939.     assumed that they do enjoy a total ordering.  Then unique() will
  940.     usually work in O(N*log2(N)) time.
  941.     If that's not possible either, the sequence elements must support
  942.     equality-testing.  Then unique() will usually work in quadratic
  943.     time.
  944.     """
  945.     n = len(s)
  946.     if n == 0:
  947.         return []
  948.     # Try using a dict first, as that's the fastest and will usually
  949.     # work.  If it doesn't work, it will usually fail quickly, so it
  950.     # usually doesn't cost much to *try* it.  It requires that all the
  951.     # sequence elements be hashable, and support equality comparison.
  952.     u = {}
  953.     try:
  954.         for x in s:
  955.             u[x] = 1
  956.     except TypeError:
  957.         pass    # move on to the next method
  958.     else:
  959.         return u.keys()
  960.     del u
  961.     # We can't hash all the elements.  Second fastest is to sort,
  962.     # which brings the equal elements together; then duplicates are
  963.     # easy to weed out in a single pass.
  964.     # NOTE:  Python's list.sort() was designed to be efficient in the
  965.     # presence of many duplicate elements.  This isn't true of all
  966.     # sort functions in all languages or libraries, so this approach
  967.     # is more effective in Python than it may be elsewhere.
  968.     try:
  969.         t = list(s)
  970.         t.sort()
  971.     except TypeError:
  972.         pass    # move on to the next method
  973.     else:
  974.         assert n > 0
  975.         last = t[0]
  976.         lasti = i = 1
  977.         while i < n:
  978.             if t[i] != last:
  979.                 t[lasti] = last = t[i]
  980.                 lasti = lasti + 1
  981.             i = i + 1
  982.         return t[:lasti]
  983.     del t
  984.     # Brute force is all that's left.
  985.     u = []
  986.     for x in s:
  987.         if x not in u:
  988.             u.append(x)
  989.     return u
  990. # From Alex Martelli,
  991. # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52560
  992. # ASPN: Python Cookbook: Remove duplicates from a sequence
  993. # First comment, dated 2001/10/13.
  994. # (Also in the printed Python Cookbook.)
  995. def uniquer(seq, idfun=None):
  996.     if idfun is None:
  997.         def idfun(x): return x
  998.     seen = {}
  999.     result = []
  1000.     for item in seq:
  1001.         marker = idfun(item)
  1002.         # in old Python versions:
  1003.         # if seen.has_key(marker)
  1004.         # but in new ones:
  1005.         if marker in seen: continue
  1006.         seen[marker] = 1
  1007.         result.append(item)
  1008.     return result
  1009. # A more efficient implementation of Alex's uniquer(), this avoids the
  1010. # idfun() argument and function-call overhead by assuming that all
  1011. # items in the sequence are hashable.
  1012. def uniquer_hashables(seq):
  1013.     seen = {}
  1014.     result = []
  1015.     for item in seq:
  1016.         #if not item in seen:
  1017.         if not seen.has_key(item):
  1018.             seen[item] = 1
  1019.             result.append(item)
  1020.     return result
  1021. # Much of the logic here was originally based on recipe 4.9 from the
  1022. # Python CookBook, but we had to dumb it way down for Python 1.5.2.
  1023. class LogicalLines:
  1024.     def __init__(self, fileobj):
  1025.         self.fileobj = fileobj
  1026.     def readline(self):
  1027.         result = []
  1028.         while 1:
  1029.             line = self.fileobj.readline()
  1030.             if not line:
  1031.                 break
  1032.             if line[-2:] == '\n':
  1033.                 result.append(line[:-2])
  1034.             else:
  1035.                 result.append(line)
  1036.                 break
  1037.         return string.join(result, '')
  1038.     def readlines(self):
  1039.         result = []
  1040.         while 1:
  1041.             line = self.readline()
  1042.             if not line:
  1043.                 break
  1044.             result.append(line)
  1045.         return result
  1046. class UniqueList(UserList):
  1047.     def __init__(self, seq = []):
  1048.         UserList.__init__(self, seq)
  1049.         self.unique = True
  1050.     def __make_unique(self):
  1051.         if not self.unique:
  1052.             self.data = uniquer_hashables(self.data)
  1053.             self.unique = True
  1054.     def __lt__(self, other):
  1055.         self.__make_unique()
  1056.         return UserList.__lt__(self, other)
  1057.     def __le__(self, other):
  1058.         self.__make_unique()
  1059.         return UserList.__le__(self, other)
  1060.     def __eq__(self, other):
  1061.         self.__make_unique()
  1062.         return UserList.__eq__(self, other)
  1063.     def __ne__(self, other):
  1064.         self.__make_unique()
  1065.         return UserList.__ne__(self, other)
  1066.     def __gt__(self, other):
  1067.         self.__make_unique()
  1068.         return UserList.__gt__(self, other)
  1069.     def __ge__(self, other):
  1070.         self.__make_unique()
  1071.         return UserList.__ge__(self, other)
  1072.     def __cmp__(self, other):
  1073.         self.__make_unique()
  1074.         return UserList.__cmp__(self, other)
  1075.     def __len__(self):
  1076.         self.__make_unique()
  1077.         return UserList.__len__(self)
  1078.     def __getitem__(self, i):
  1079.         self.__make_unique()
  1080.         return UserList.__getitem__(self, i)
  1081.     def __setitem__(self, i, item):
  1082.         UserList.__setitem__(self, i, item)
  1083.         self.unique = False
  1084.     def __getslice__(self, i, j):
  1085.         self.__make_unique()
  1086.         return UserList.__getslice__(self, i, j)
  1087.     def __setslice__(self, i, j, other):
  1088.         UserList.__setslice__(self, i, j, other)
  1089.         self.unique = False
  1090.     def __add__(self, other):
  1091.         result = UserList.__add__(self, other)
  1092.         result.unique = False
  1093.         return result
  1094.     def __radd__(self, other):
  1095.         result = UserList.__radd__(self, other)
  1096.         result.unique = False
  1097.         return result
  1098.     def __iadd__(self, other):
  1099.         result = UserList.__iadd__(self, other)
  1100.         result.unique = False
  1101.         return result
  1102.     def __mul__(self, other):
  1103.         result = UserList.__mul__(self, other)
  1104.         result.unique = False
  1105.         return result
  1106.     def __rmul__(self, other):
  1107.         result = UserList.__rmul__(self, other)
  1108.         result.unique = False
  1109.         return result
  1110.     def __imul__(self, other):
  1111.         result = UserList.__imul__(self, other)
  1112.         result.unique = False
  1113.         return result
  1114.     def append(self, item):
  1115.         UserList.append(self, item)
  1116.         self.unique = False
  1117.     def insert(self, i):
  1118.         UserList.insert(self, i)
  1119.         self.unique = False
  1120.     def count(self, item):
  1121.         self.__make_unique()
  1122.         return UserList.count(self, item)
  1123.     def index(self, item):
  1124.         self.__make_unique()
  1125.         return UserList.index(self, item)
  1126.     def reverse(self):
  1127.         self.__make_unique()
  1128.         UserList.reverse(self)
  1129.     def sort(self, *args, **kwds):
  1130.         self.__make_unique()
  1131.         #return UserList.sort(self, *args, **kwds)
  1132.         return apply(UserList.sort, (self,)+args, kwds)
  1133.     def extend(self, other):
  1134.         UserList.extend(self, other)
  1135.         self.unique = False
  1136. class Unbuffered:
  1137.     """
  1138.     A proxy class that wraps a file object, flushing after every write,
  1139.     and delegating everything else to the wrapped object.
  1140.     """
  1141.     def __init__(self, file):
  1142.         self.file = file
  1143.     def write(self, arg):
  1144.         try:
  1145.             self.file.write(arg)
  1146.             self.file.flush()
  1147.         except IOError:
  1148.             # Stdout might be connected to a pipe that has been closed
  1149.             # by now. The most likely reason for the pipe being closed
  1150.             # is that the user has press ctrl-c. It this is the case,
  1151.             # then SCons is currently shutdown. We therefore ignore
  1152.             # IOError's here so that SCons can continue and shutdown
  1153.             # properly so that the .sconsign is correctly written
  1154.             # before SCons exits.
  1155.             pass
  1156.     def __getattr__(self, attr):
  1157.         return getattr(self.file, attr)
  1158. def make_path_relative(path):
  1159.     """ makes an absolute path name to a relative pathname.
  1160.     """
  1161.     if os.path.isabs(path):
  1162.         drive_s,path = os.path.splitdrive(path)
  1163.         import re
  1164.         if not drive_s:
  1165.             path=re.compile("/*(.*)").findall(path)[0]
  1166.         else:
  1167.             path=path[1:]
  1168.     assert( not os.path.isabs( path ) ), path
  1169.     return path
  1170. # The original idea for AddMethod() and RenameFunction() come from the
  1171. # following post to the ActiveState Python Cookbook:
  1172. #
  1173. # ASPN: Python Cookbook : Install bound methods in an instance
  1174. # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/223613
  1175. #
  1176. # That code was a little fragile, though, so the following changes
  1177. # have been wrung on it:
  1178. #
  1179. # * Switched the installmethod() "object" and "function" arguments,
  1180. #   so the order reflects that the left-hand side is the thing being
  1181. #   "assigned to" and the right-hand side is the value being assigned.
  1182. #
  1183. # * Changed explicit type-checking to the "try: klass = object.__class__"
  1184. #   block in installmethod() below so that it still works with the
  1185. #   old-style classes that SCons uses.
  1186. #
  1187. # * Replaced the by-hand creation of methods and functions with use of
  1188. #   the "new" module, as alluded to in Alex Martelli's response to the
  1189. #   following Cookbook post:
  1190. #
  1191. # ASPN: Python Cookbook : Dynamically added methods to a class
  1192. # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/81732
  1193. def AddMethod(object, function, name = None):
  1194.     """
  1195.     Adds either a bound method to an instance or an unbound method to
  1196.     a class. If name is ommited the name of the specified function
  1197.     is used by default.
  1198.     Example:
  1199.       a = A()
  1200.       def f(self, x, y):
  1201.         self.z = x + y
  1202.       AddMethod(f, A, "add")
  1203.       a.add(2, 4)
  1204.       print a.z
  1205.       AddMethod(lambda self, i: self.l[i], a, "listIndex")
  1206.       print a.listIndex(5)
  1207.     """
  1208.     import new
  1209.     if name is None:
  1210.         name = function.func_name
  1211.     else:
  1212.         function = RenameFunction(function, name)
  1213.     try:
  1214.         klass = object.__class__
  1215.     except AttributeError:
  1216.         # "object" is really a class, so it gets an unbound method.
  1217.         object.__dict__[name] = new.instancemethod(function, None, object)
  1218.     else:
  1219.         # "object" is really an instance, so it gets a bound method.
  1220.         object.__dict__[name] = new.instancemethod(function, object, klass)
  1221. def RenameFunction(function, name):
  1222.     """
  1223.     Returns a function identical to the specified function, but with
  1224.     the specified name.
  1225.     """
  1226.     import new
  1227.     # Compatibility for Python 1.5 and 2.1.  Can be removed in favor of
  1228.     # passing function.func_defaults directly to new.function() once
  1229.     # we base on Python 2.2 or later.
  1230.     func_defaults = function.func_defaults
  1231.     if func_defaults is None:
  1232.         func_defaults = ()
  1233.     return new.function(function.func_code,
  1234.                         function.func_globals,
  1235.                         name,
  1236.                         func_defaults)
  1237. md5 = False
  1238. def MD5signature(s):
  1239.     return str(s)
  1240. try:
  1241.     import hashlib
  1242. except ImportError:
  1243.     pass
  1244. else:
  1245.     if hasattr(hashlib, 'md5'):
  1246.         md5 = True
  1247.         def MD5signature(s):
  1248.             m = hashlib.md5()
  1249.             m.update(str(s))
  1250.             return m.hexdigest()
  1251. def MD5collect(signatures):
  1252.     """
  1253.     Collects a list of signatures into an aggregate signature.
  1254.     signatures - a list of signatures
  1255.     returns - the aggregate signature
  1256.     """
  1257.     if len(signatures) == 1:
  1258.         return signatures[0]
  1259.     else:
  1260.         return MD5signature(string.join(signatures, ', '))
  1261. # From Dinu C. Gherman,
  1262. # Python Cookbook, second edition, recipe 6.17, p. 277.
  1263. # Also:
  1264. # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/68205
  1265. # ASPN: Python Cookbook: Null Object Design Pattern
  1266. class Null:
  1267.     """ Null objects always and reliably "do nothging." """
  1268.     def __new__(cls, *args, **kwargs):
  1269.         if not '_inst' in vars(cls):
  1270.             #cls._inst = type.__new__(cls, *args, **kwargs)
  1271.             cls._inst = apply(type.__new__, (cls,) + args, kwargs)
  1272.         return cls._inst
  1273.     def __init__(self, *args, **kwargs):
  1274.         pass
  1275.     def __call__(self, *args, **kwargs):
  1276.         return self
  1277.     def __repr__(self):
  1278.         return "Null()"
  1279.     def __nonzero__(self):
  1280.         return False
  1281.     def __getattr__(self, mname):
  1282.         return self
  1283.     def __setattr__(self, name, value):
  1284.         return self
  1285.     def __delattr__(self, name):
  1286.         return self
  1287. del __revision__