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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
"""SCons.Builder
XXX
"""
#
# 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__"
import os.path
import string
from Errors import UserError
import SCons.Action
import SCons.Node.FS
import SCons.Util
def Builder(**kw):
"""A factory for builder objects."""
if kw.has_key('action') and SCons.Util.is_Dict(kw['action']):
return apply(CompositeBuilder, (), kw)
elif kw.has_key('src_builder'):
return apply(MultiStepBuilder, (), kw)
else:
return apply(BuilderBase, (), kw)
class BuilderBase:
"""Base class for Builders, objects that create output
nodes (files) from input nodes (files).
"""
def __init__(self, name = None,
action = None,
prefix = '',
suffix = '',
src_suffix = '',
node_factory = SCons.Node.FS.default_fs.File,
scanner = None):
if name is None:
raise UserError, "You must specify a name for the builder."
self.name = name
self.action = SCons.Action.Action(action)
self.prefix = prefix
self.suffix = suffix
self.src_suffix = src_suffix
self.node_factory = node_factory
self.scanner = scanner
if self.suffix and self.suffix[0] not in '.$':
self.suffix = '.' + self.suffix
if self.src_suffix and self.src_suffix[0] not in '.$':
self.src_suffix = '.' + self.src_suffix
def __cmp__(self, other):
return cmp(self.__dict__, other.__dict__)
def _create_nodes(self, env, target = None, source = None):
"""Create and return lists of target and source nodes.
"""
def adjustixes(files, pre, suf):
ret = []
if SCons.Util.is_String(files):
files = string.split(files)
if not SCons.Util.is_List(files):
files = [files]
for f in files:
if SCons.Util.is_String(f):
if pre and f[:len(pre)] != pre:
path, fn = os.path.split(os.path.normpath(f))
f = os.path.join(path, pre + fn)
if suf:
if f[-len(suf):] != suf:
f = f + suf
ret.append(f)
return ret
tlist = SCons.Util.scons_str2nodes(adjustixes(target,
env.subst(self.prefix),
env.subst(self.suffix)),
self.node_factory)
slist = SCons.Util.scons_str2nodes(adjustixes(source,
None,
env.subst(self.src_suffix)),
self.node_factory)
return tlist, slist
def _init_nodes(self, env, tlist, slist):
"""Initialize lists of target and source nodes with all of
the proper Builder information.
"""
for t in tlist:
t.cwd = SCons.Node.FS.default_fs.getcwd() # XXX
t.builder_set(self)
t.env_set(env)
t.add_source(slist)
if self.scanner:
t.scanner_set(self.scanner.instance(env))
for s in slist:
s.env_set(env, 1)
scanner = env.get_scanner(os.path.splitext(s.name)[1])
if scanner:
s.scanner_set(scanner.instance(env))
if len(tlist) == 1:
tlist = tlist[0]
return tlist
def __call__(self, env, target = None, source = None):
tlist, slist = self._create_nodes(env, target, source)
return self._init_nodes(env, tlist, slist)
def execute(self, **kw):
"""Execute a builder's action to create an output object.
"""
return apply(self.action.execute, (), kw)
def get_raw_contents(self, **kw):
"""Fetch the "contents" of the builder's action.
"""
return apply(self.action.get_raw_contents, (), kw)
def get_contents(self, **kw):
"""Fetch the "contents" of the builder's action
(for signature calculation).
"""
return apply(self.action.get_contents, (), kw)
def src_suffixes(self):
if self.src_suffix != '':
return [self.src_suffix]
return []
class MultiStepBuilder(BuilderBase):
"""This is a builder subclass that can build targets in
multiple steps. The src_builder parameter to the constructor
accepts a builder that is called to build sources supplied to
this builder. The targets of that first build then become
the sources of this builder.
If this builder has a src_suffix supplied, then the src_builder
builder is NOT invoked if the suffix of a source file matches
src_suffix.
"""
def __init__(self, src_builder,
name = None,
action = None,
prefix = '',
suffix = '',
src_suffix = '',
node_factory = SCons.Node.FS.default_fs.File,
scanner=None):
BuilderBase.__init__(self, name, action, prefix, suffix, src_suffix,
node_factory, scanner)
self.src_builder = src_builder
def __call__(self, env, target = None, source = None):
slist = SCons.Util.scons_str2nodes(source, self.node_factory)
final_sources = []
src_suffix = env.subst(self.src_suffix)
for snode in slist:
path, ext = os.path.splitext(snode.abspath)
if not src_suffix or ext != src_suffix:
tgt = self.src_builder(env, target = [ path ],
source=snode)
if not SCons.Util.is_List(tgt):
final_sources.append(tgt)
else:
final_sources.extend(tgt)
else:
final_sources.append(snode)
return BuilderBase.__call__(self, env, target=target,
source=final_sources)
def src_suffixes(self):
return BuilderBase.src_suffixes(self) + self.src_builder.src_suffixes()
class CompositeBuilder(BuilderBase):
"""This is a convenient Builder subclass that can build different
files based on their suffixes. For each target, this builder
will examine the target's sources. If they are all the same
suffix, and that suffix is equal to one of the child builders'
src_suffix, then that child builder will be used. Otherwise,
UserError is thrown."""
def __init__(self, name = None,
prefix='',
suffix='',
action = {},
src_builder = []):
BuilderBase.__init__(self, name=name, prefix=prefix,
suffix=suffix)
if src_builder and not SCons.Util.is_List(src_builder):
src_builder = [src_builder]
self.src_builder = src_builder
self.builder_dict = {}
for suff, act in action.items():
# Create subsidiary builders for every suffix in the
# action dictionary. If there's a src_builder that
# matches the suffix, add that to the initializing
# keywords so that a MultiStepBuilder will get created.
kw = {'name' : name, 'action' : act, 'src_suffix' : suff}
src_bld = filter(lambda x, s=suff: x.suffix == s, self.src_builder)
if src_bld:
kw['src_builder'] = src_bld[0]
self.builder_dict[suff] = apply(Builder, (), kw)
def __call__(self, env, target = None, source = None):
tlist, slist = BuilderBase._create_nodes(self, env,
target=target, source=source)
# XXX These [bs]dict tables are invariant for each unique
# CompositeBuilder + Environment pair, so we should cache them.
bdict = {}
sdict = {}
for suffix, bld in self.builder_dict.items():
bdict[env.subst(bld.src_suffix)] = bld
sdict[suffix] = suffix
for s in bld.src_suffixes():
bdict[s] = bld
sdict[s] = suffix
for tnode in tlist:
suflist = map(lambda x, s=sdict: s[os.path.splitext(x.path)[1]],
slist)
last_suffix=''
for suffix in suflist:
if last_suffix and last_suffix != suffix:
raise UserError, "The builder for %s can only build source files of identical suffixes: %s." % (tnode.path, str(map(lambda t: str(t.path), tnode.sources)))
last_suffix = suffix
if last_suffix:
try:
bdict[last_suffix].__call__(env, target = tnode,
source = slist)
except KeyError:
raise UserError, "The builder for %s can not build files with suffix: %s" % (tnode.path, suffix)
if len(tlist) == 1:
tlist = tlist[0]
return tlist
def src_suffixes(self):
return reduce(lambda x, y: x + y,
map(lambda b: b.src_suffixes(),
self.builder_dict.values()))
|
