summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Environment.py
blob: f85f72380edf6d312e78082b111c4a982a8bbb2a (plain)
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
"""SCons.Environment

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 copy
import os.path
import re
import types
import SCons.Util
import SCons.Builder
from SCons.Errors import UserError
from UserList import UserList

def Command():
    pass	# XXX

def Install():
    pass	# XXX

def InstallAs():
    pass	# XXX



def _deepcopy_atomic(x, memo):
	return x
copy._deepcopy_dispatch[types.ModuleType] = _deepcopy_atomic
copy._deepcopy_dispatch[types.ClassType] = _deepcopy_atomic
copy._deepcopy_dispatch[types.FunctionType] = _deepcopy_atomic
copy._deepcopy_dispatch[types.MethodType] = _deepcopy_atomic
copy._deepcopy_dispatch[types.TracebackType] = _deepcopy_atomic
copy._deepcopy_dispatch[types.FrameType] = _deepcopy_atomic
copy._deepcopy_dispatch[types.FileType] = _deepcopy_atomic



class Environment:
    """Base class for construction Environments.  These are
    the primary objects used to communicate dependency and
    construction information to the build engine.

    Keyword arguments supplied when the construction Environment
    is created are construction variables used to initialize the
    Environment.
    """

    # See the documentation for the __autogenerate() method
    # for an explanation of this variable...
    AUTO_GEN_VARS = ( ( '_LIBFLAGS',
                        'LIBS',
                        'LIBLINKPREFIX',
                        'LIBLINKSUFFIX' ),
                      ( '_LIBDIRFLAGS',
                        'LIBPATH',
                        'LIBDIRPREFIX',
                        'LIBDIRSUFFIX' ),
                      ( '_INCFLAGS',
                        'CPPPATH',
                        'INCPREFIX',
                        'INCSUFFIX' ) )

    def __init__(self, **kw):
	import SCons.Defaults
	self._dict = copy.deepcopy(SCons.Defaults.ConstructionEnvironment)
	if kw.has_key('BUILDERS') and type(kw['BUILDERS']) != type([]):
	        kw['BUILDERS'] = [kw['BUILDERS']]
        if kw.has_key('SCANNERS') and type(kw['SCANNERS']) != type([]):
                kw['SCANNERS'] = [kw['SCANNERS']]
	self._dict.update(copy.deepcopy(kw))
        self.__autogenerate()

	class BuilderWrapper:
	    """Wrapper class that allows an environment to
	    be associated with a Builder at instantiation.
	    """
	    def __init__(self, env, builder):
		self.env = env
		self.builder = builder
	
	    def __call__(self, target = None, source = None):
		return self.builder(self.env, target, source)

	    # This allows a Builder to be executed directly
	    # through the Environment to which it's attached.
	    # In practice, we shouldn't need this, because
	    # builders actually get executed through a Node.
	    # But we do have a unit test for this, and can't
	    # yet rule out that it would be useful in the
	    # future, so leave it for now.
	    def execute(self, **kw):
	    	kw['env'] = self
	    	apply(self.builder.execute, (), kw)

	for b in self._dict['BUILDERS']:
	    setattr(self, b.name, BuilderWrapper(self, b))

        for s in self._dict['SCANNERS']:
            setattr(self, s.name, s)

    def __autogenerate(self):
        """Autogenerate the "interpolated" environment variables.
        We read a static structure that tells us how.  AUTO_GEN_VARS
        is a tuple of tuples.  Each inner tuple has four elements,
        each strings referring to an environment variable, and describing
        how to autogenerate a particular variable.  The elements are:

        0 - The variable to generate
        1 - The "source" variable, usually a list
        2 - The "prefix" variable
        3 - The "suffix" variable

        The autogenerated variable is a list, consisting of every
        element of the source list, or a single element if the source
        is a string, with the prefix and suffix
        concatenated."""

        for strVarAuto, strSrc, strPref, strSuff, in self.AUTO_GEN_VARS:
            if self._dict.has_key(strSrc):
                src_var = self._dict[strSrc]
                if type(src_var) is types.ListType or \
                   isinstance(src_var, UserList):
                    src_var = map(str, src_var)
                else:
                    src_var = [ str(src_var), ]
            else:
                src_var = []

            try:
                prefix = str(self._dict[strPref])
            except KeyError:
                prefix=''

            try:
                suffix = str(self._dict[strSuff])
            except KeyError:
                suffix =''

            self._dict[strVarAuto] = map(lambda x, suff=suffix, pref=prefix: \
                                         pref + os.path.normpath(str(x)) + suff,
                                         src_var)

    def __cmp__(self, other):
	return cmp(self._dict, other._dict)

    def Builders(self):
	pass	# XXX

    def Copy(self, **kw):
	"""Return a copy of a construction Environment.  The
	copy is like a Python "deep copy"--that is, independent
	copies are made recursively of each objects--except that
	a reference is copied when an object is not deep-copyable
	(like a function).  There are no references to any mutable
	objects in the original Environment.
	"""
	clone = copy.deepcopy(self)
	apply(clone.Update, (), kw)
	return clone

    def Scanners(self):
	pass	# XXX

    def	Update(self, **kw):
	"""Update an existing construction Environment with new
	construction variables and/or values.
	"""
	self._dict.update(copy.deepcopy(kw))
        self.__autogenerate()

    def	Depends(self, target, dependency):
	"""Explicity specify that 'target's depend on 'dependency'."""
	tlist = SCons.Util.scons_str2nodes(target)
	dlist = SCons.Util.scons_str2nodes(dependency)
	for t in tlist:
	    t.add_dependency(dlist)

	if len(tlist) == 1:
	    tlist = tlist[0]
	return tlist

    def Dictionary(self, *args):
	if not args:
	    return self._dict
	dlist = map(lambda x, s=self: s._dict[x], args)
	if len(dlist) == 1:
	    dlist = dlist[0]
	return dlist

    def Command(self, target, source, action):
        """Builds the supplied target files from the supplied
        source files using the supplied action.  Action may
        be any type that the Builder constructor will accept
        for an action."""
        bld = SCons.Builder.Builder(name="Command", action=action)
        return bld(self, target, source)

    def subst(self, string):
	"""Recursively interpolates construction variables from the
	Environment into the specified string, returning the expanded
	result.  Construction variables are specified by a $ prefix
	in the string and begin with an initial underscore or
	alphabetic character followed by any number of underscores
	or alphanumeric characters.  The construction variable names
	may be surrounded by curly braces to separate the name from
	trailing characters.
	"""
	return SCons.Util.scons_subst(string, self._dict, {})

    def get_scanner(self, skey):
        """Find the appropriate scanner given a key (usually a file suffix).
        Does a linear search. Could be sped up by creating a dictionary if
        this proves too slow.
        """
        if self._dict['SCANNERS']:
            for scanner in self._dict['SCANNERS']:
                if skey in scanner.skeys:
                    return scanner
        return None