env = Environment(tools = ['msvc', 'lex'])
.EE
+Non-built-in tools may be specified using the toolpath argument:
+
+.ES
+env = Environment(tools = ['foo'], toolpath = ['tools'])
+.EE
+
+This looks for a tool specification in tools/foo.py. foo.py should
+have two functions: generate(env) and exists(env). generate()
+modifies the passed in environment and exists() should return a true
+value if the tool is available. Tools in the toolpath are used before
+any of the built-in ones. For example, adding gcc.py to the toolpath
+would override the built-in gcc tool.
+
The elements of the tools list may also
be functions or callable objects,
in which case the Environment() method
env3 = env.Copy(CCFLAGS = '-g')
.EE
.IP
-Additionally, a list of tools may be specified, as in the Environment
-constructor:
+Additionally, a list of tools and a toolpath may be specified, as in
+the Environment constructor:
.ES
def MyTool(env): env['FOO'] = 'bar'
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
-.RI Tool( string )
+.RI Tool( string, toolpath=[] )
Returns a callable object
that can be used to initialize
a construction environment using the
env = Environment()
t = Tool('msvc')
t(env) # adds 'msvc' to the TOOLS variable
+u = Tool('opengl', toolpath = ['tools'])
+u(env) # adds 'opengl' to the TOOLS variable
.EE
.TP
-.RI env.Tool( string )
+.RI env.Tool( string [, toolpath] )
Applies the callable object for the specified tool
.I string
to the environment through which the method was called.
.ES
env.Tool('gcc')
+env.Tool('opengl', toolpath = ['build/tools'])
.EE
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
copy = x
return copy
-def apply_tools(env, tools):
+def apply_tools(env, tools, toolpath):
if tools:
for tool in tools:
if SCons.Util.is_String(tool):
- tool = SCons.Tool.Tool(tool)
- tool(env)
+ env.Tool(tool, toolpath)
+ else:
+ tool(env)
class BuilderWrapper:
"""Wrapper class that associates an environment with a Builder at
def __init__(self,
platform=None,
tools=None,
+ toolpath=[],
options=None,
**kw):
self.fs = SCons.Node.FS.default_fs
tools = self._dict.get('TOOLS', None)
if tools is None:
tools = ['default']
- apply_tools(self, tools)
+ apply_tools(self, tools, toolpath)
# Reapply the passed in variables after calling the tools,
# since they should overide anything set by the tools:
self._dict[envname][name] = nv
- def Copy(self, tools=None, **kw):
+ def Copy(self, tools=None, toolpath=[], **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
except KeyError:
pass
- apply_tools(clone, tools)
+ apply_tools(clone, tools, toolpath)
# Apply passed-in variables after the new tools.
apply(clone.Replace, (), kw)
name = name[:-len(old_suffix)]
return os.path.join(dir, new_prefix+name+new_suffix)
- def Tool(self, tool):
+ def Tool(self, tool, toolpath=[]):
tool = self.subst(tool)
- return SCons.Tool.Tool(tool)(self)
+ return SCons.Tool.Tool(tool, map(self.subst, toolpath))(self)
def WhereIs(self, prog, path=None, pathext=None):
"""Find prog in the path.
--- /dev/null
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# 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 sys
+import time
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.write('SConstruct', """
+def foo(env):
+ env['TOOL_FOO'] = 1
+
+env1 = Environment(tools=[foo, 'bar'], toolpath=['tools'])
+print "env1['TOOL_FOO'] =", env1.get('TOOL_FOO')
+print "env1['TOOL_BAR'] =", env1.get('TOOL_BAR')
+
+# pick a built-in tool with pretty simple behavior
+env2 = Environment(tools=['SCCS'])
+print "env2['SCCS'] =", env2.get('SCCS')
+print "env2['TOOL_SCCS1'] =", env2.get('TOOL_SCCS1')
+print "env2['TOOL_SCCS2'] =", env2.get('TOOL_SCCS2')
+
+env3 = Environment(tools=['SCCS'], toolpath=['.'])
+print "env3['SCCS'] =", env3.get('SCCS')
+print "env3['TOOL_SCCS1'] =", env3.get('TOOL_SCCS1')
+print "env3['TOOL_SCCS2'] =", env3.get('TOOL_SCCS2')
+
+env4 = Environment(tools=['SCCS'], toolpath=['tools'])
+print "env4['SCCS'] =", env4.get('SCCS')
+print "env4['TOOL_SCCS1'] =", env4.get('TOOL_SCCS1')
+print "env4['TOOL_SCCS2'] =", env4.get('TOOL_SCCS2')
+
+env5 = Environment(tools=['SCCS'], toolpath=['tools', '.'])
+print "env5['SCCS'] =", env5.get('SCCS')
+print "env5['TOOL_SCCS1'] =", env5.get('TOOL_SCCS1')
+print "env5['TOOL_SCCS2'] =", env5.get('TOOL_SCCS2')
+
+env6 = Environment(tools=['SCCS'], toolpath=['.', 'tools'])
+print "env6['SCCS'] =", env6.get('SCCS')
+print "env6['TOOL_SCCS1'] =", env6.get('TOOL_SCCS1')
+print "env6['TOOL_SCCS2'] =", env6.get('TOOL_SCCS2')
+
+env7 = Environment(TOOLPATH="tools", tools=['SCCS'], toolpath=['$TOOLPATH'])
+print "env7['SCCS'] =", env7.get('SCCS')
+print "env7['TOOL_SCCS1'] =", env7.get('TOOL_SCCS1')
+print "env7['TOOL_SCCS2'] =", env7.get('TOOL_SCCS2')
+
+env8 = Environment(tools=[])
+env8.Tool('SCCS', toolpath=['tools'])
+print "env8['SCCS'] =", env8.get('SCCS')
+print "env8['TOOL_SCCS1'] =", env8.get('TOOL_SCCS1')
+print "env8['TOOL_SCCS2'] =", env8.get('TOOL_SCCS2')
+
+env9 = Environment(tools=[])
+Tool('SCCS', toolpath=['tools'])(env9)
+print "env9['SCCS'] =", env9.get('SCCS')
+print "env9['TOOL_SCCS1'] =", env9.get('TOOL_SCCS1')
+print "env9['TOOL_SCCS2'] =", env9.get('TOOL_SCCS2')
+
+env0 = Environment(TOOLPATH='tools', tools=[])
+env0.Tool('SCCS', toolpath=['$TOOLPATH'])
+print "env0['SCCS'] =", env0.get('SCCS')
+print "env0['TOOL_SCCS1'] =", env0.get('TOOL_SCCS1')
+print "env0['TOOL_SCCS2'] =", env0.get('TOOL_SCCS2')
+""")
+
+test.write('SCCS.py', r"""\
+def generate(env):
+ env['TOOL_SCCS1'] = 1
+def exists(env):
+ return 1
+""")
+
+test.subdir('tools')
+
+test.write(['tools', 'SCCS.py'], r"""\
+def generate(env):
+ env['TOOL_SCCS2'] = 1
+def exists(env):
+ return 1
+""")
+
+test.write(['tools', 'bar.py'], r"""\
+def generate(env):
+ env['TOOL_BAR'] = 1
+def exists(env):
+ return 1
+""")
+
+test.run(arguments = '.', stdout = """\
+scons: Reading SConscript files ...
+env1['TOOL_FOO'] = 1
+env1['TOOL_BAR'] = 1
+env2['SCCS'] = sccs
+env2['TOOL_SCCS1'] = None
+env2['TOOL_SCCS2'] = None
+env3['SCCS'] = None
+env3['TOOL_SCCS1'] = 1
+env3['TOOL_SCCS2'] = None
+env4['SCCS'] = None
+env4['TOOL_SCCS1'] = None
+env4['TOOL_SCCS2'] = 1
+env5['SCCS'] = None
+env5['TOOL_SCCS1'] = None
+env5['TOOL_SCCS2'] = 1
+env6['SCCS'] = None
+env6['TOOL_SCCS1'] = 1
+env6['TOOL_SCCS2'] = None
+env7['SCCS'] = None
+env7['TOOL_SCCS1'] = None
+env7['TOOL_SCCS2'] = 1
+env8['SCCS'] = None
+env8['TOOL_SCCS1'] = None
+env8['TOOL_SCCS2'] = 1
+env9['SCCS'] = None
+env9['TOOL_SCCS1'] = None
+env9['TOOL_SCCS2'] = 1
+env0['SCCS'] = None
+env0['TOOL_SCCS1'] = None
+env0['TOOL_SCCS2'] = 1
+scons: done reading SConscript files.
+scons: Building targets ...
+scons: `.' is up to date.
+scons: done building targets.
+""")
+
+test.pass_test()
projects / scons.git / commitdiff