src/engine/SCons/Node/Python.py

   1 """scons.Node.Python
   2
   3 Python nodes.
   4
   5 """
   6
   7 #
   8 # __COPYRIGHT__
   9 #
  10 # Permission is hereby granted, free of charge, to any person obtaining
  11 # a copy of this software and associated documentation files (the
  12 # "Software"), to deal in the Software without restriction, including
  13 # without limitation the rights to use, copy, modify, merge, publish,
  14 # distribute, sublicense, and/or sell copies of the Software, and to
  15 # permit persons to whom the Software is furnished to do so, subject to
  16 # the following conditions:
  17 #
  18 # The above copyright notice and this permission notice shall be included
  19 # in all copies or substantial portions of the Software.
  20 #
  21 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  22 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  23 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  25 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  26 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  27 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  28 #
  29
  30 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
  31
  32 import SCons.Node
  33
  34 class ValueNodeInfo(SCons.Node.NodeInfoBase):
  35     pass
  36
  37 class ValueBuildInfo(SCons.Node.BuildInfoBase):
  38     pass
  39
  40 class Value(SCons.Node.Node):
  41     """A class for Python variables, typically passed on the command line
  42     or generated by a script, but not from a file or some other source.
  43     """
  44
  45     NodeInfo = ValueNodeInfo
  46     BuildInfo = ValueBuildInfo
  47
  48     def __init__(self, value):
  49         SCons.Node.Node.__init__(self)
  50         self.value = value
  51
  52     def __str__(self):
  53         return repr(self.value)
  54
  55     def build(self):
  56         """A "builder" for Values."""
  57         pass
  58
  59     current = SCons.Node.Node.children_are_up_to_date
  60
  61     def is_under(self, dir):
  62         # Make Value nodes get built regardless of
  63         # what directory scons was run from. Value nodes
  64         # are outside the filesystem:
  65         return 1
  66
  67     def get_contents(self):
  68         """The contents of a Value are the concatenation
  69         of all the contents of its sources with the node's value itself."""
  70         contents = str(self.value)
  71         for kid in self.children(None):
  72             contents = contents + kid.get_contents()
  73         return contents
  74
  75     def get_csig(self, calc=None):
  76         """Because we're a Python value node and don't have a real
  77         timestamp, we get to ignore the calculator and just use the
  78         value contents."""
  79         try:
  80             binfo = self.binfo
  81         except AttributeError:
  82             binfo = self.binfo = self.new_binfo()
  83         try:
  84             return binfo.ninfo.csig
  85         except AttributeError:
  86             binfo.ninfo.csig = self.get_contents()
  87             self.store_info(binfo)
  88             return binfo.ninfo.csig