1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
"""SCons.Node
The Node package for the SCons software construction utility.
"""
#
# Copyright (c) 2001 Steven Knight
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
from SCons.Errors import BuildError
import string
import types
import copy
# Node states
#
# These are in "priority" order, so that the maximum value for any
# child/dependency of a node represents the state of that node if
# it has no builder of its own. The canonical example is a file
# system directory, which is only up to date if all of its children
# were up to date.
pending = 1
executing = 2
up_to_date = 3
executed = 4
failed = 5
class Node:
"""The base Node class, for entities that we know how to
build, or use to build other Nodes.
"""
def __init__(self):
self.sources = []
self.depends = []
self.parents = []
self.builder = None
self.scanner = None
self.scanned = 0
self.env = None
self.state = None
self.bsig = None
self.csig = None
self.use_signature = 1
def build(self):
"""Actually build the node. Return the status from the build."""
if not self.builder:
return None
sources = map(lambda x: str(x), self.sources)
stat = self.builder.execute(env = self.env.Dictionary(),
target = str(self), source = sources)
if stat != 0:
raise BuildError(node = self, stat = stat)
return stat
def builder_set(self, builder):
self.builder = builder
def builder_sig_adapter(self):
"""Create an adapter for calculating a builder's signature.
The underlying signature class will call get_contents()
to fetch the signature of a builder, but the actual
content of that signature depends on the node and the
environment (for construction variable substitution),
so this adapter provides the right glue between the two.
"""
class Adapter:
def __init__(self, node):
self.node = node
def get_contents(self):
env = self.node.env.Dictionary()
return self.node.builder.get_contents(env = env)
return Adapter(self)
def scanner_set(self, scanner):
self.scanner = scanner
def scan(self):
self.scanned = 1
def env_set(self, env, safe=0):
if safe and self.env:
return
self.env = env
def get_bsig(self):
"""Get the node's build signature (based on the signatures
of its dependency files and build information)."""
return self.bsig
def set_bsig(self, bsig):
"""Set the node's build signature (based on the signatures
of its dependency files and build information)."""
self.bsig = bsig
def get_csig(self):
"""Get the signature of the node's content."""
return self.csig
def set_csig(self, csig):
"""Set the signature of the node's content."""
self.csig = csig
def add_dependency(self, depend):
"""Adds dependencies. The depend argument must be a list."""
self._add_child(self.depends, depend)
def add_source(self, source):
"""Adds sources. The source argument must be a list."""
self._add_child(self.sources, source)
def _add_child(self, collection, child):
"""Adds 'child' to 'collection'. The 'child' argument must be a list"""
if type(child) is not type([]):
raise TypeError("child must be a list")
child = filter(lambda x, s=collection: x not in s, child)
if child:
collection.extend(child)
for c in child:
c._add_parent(self)
def _add_parent(self, parent):
"""Adds 'parent' to the list of parents of this node"""
if parent not in self.parents: self.parents.append(parent)
def children(self):
if not self.scanned:
self.scan()
return self.sources + self.depends
def get_parents(self):
return self.parents
def set_state(self, state):
self.state = state
def get_state(self):
return self.state
def current(self):
return None
def children_are_executed(self):
return reduce(lambda x,y: ((y.get_state() == executed
or y.get_state() == up_to_date)
and x),
self.children(),
1)
def get_children(node): return node.children()
def ignore_cycle(node, stack): pass
class Wrapper:
def __init__(self, node, kids_func):
self.node = node
self.kids = copy.copy(kids_func(node))
# XXX randomize kids here, if requested
def __str__(self):
return str(self.node)
class Walker:
"""An iterator for walking a Node tree.
This is depth-first, children are visited before the parent.
The Walker object can be initialized with any node, and
returns the next node on the descent with each next() call.
'kids_func' is an optional function that will be called to
get the children of a node instead of calling 'children'.
'cycle_func' is an optional function that will be called
when a cycle is detected.
This class does not get caught in node cycles caused, for example,
by C header file include loops.
"""
def __init__(self, node, kids_func=get_children, cycle_func=ignore_cycle):
self.kids_func = kids_func
self.cycle_func = cycle_func
self.stack = [Wrapper(node, self.kids_func)]
self.history = {} # used to efficiently detect and avoid cycles
self.history[node] = None
def next(self):
"""Return the next node for this walk of the tree.
This function is intentionally iterative, not recursive,
to sidestep any issues of stack size limitations.
"""
while self.stack:
if self.stack[-1].kids:
node = self.stack[-1].kids.pop(0)
if self.history.has_key(node):
self.cycle_func(node, self.stack)
else:
self.stack.append(Wrapper(node, self.kids_func))
self.history[node] = None
else:
node = self.stack.pop().node
del self.history[node]
return node
def is_done(self):
return not self.stack
|
