Yab.Core.ToolsetBase

Package Yab :: Module Core :: Class ToolsetBase

[show private | hide private]

Class ToolsetBase

Delegator --+    
            |    
     BuildEnv --+
                |
               ToolsetBase

Known Subclasses:: Toolset, Toolset

The base class for all Toolsets.

A toolset represents the set of build tools available in a particular environment.

Method Summary
	`__init__(self, id, **kw)`
	`__getattr__(self, attr)`
	`__setattr__(self, attr, value)`
	`calc_env(self)`
	`command(self, command, targets, sources, clean, in_dir, locate, delegator)` Construct a target object that represents the result of running the given command.
	`copy(self, target, source, delegator)` Create a build target that represents copying the source to the target.
	`delay_load(self, lib_name, delegator)` Specify that the given library should be loaded on an as needed basis instead of at startup time.
	`get_toolset(self, delegator)` Used to get a handle to the toolset object from a generated target
	`get_variant(self, delegator)` Return the variant we are currently building.
	`make_c_obj(self, sources, locate, delegator)` Create a build target that represents a C object file.
	`make_cpp_obj(self, sources, locate, delegator)` Create a build target that represents a C++ object file.
	`make_executable(self, prog_name, locate, def_file, delegator)` Create a build target that represents an executable program.
	`make_shared_lib(self, lib_name, version, locate, delegator)` Create a build target that represents a shared library.
	`print_features(self)` Print the feature values set on this toolset.
	`shared_linkable(self, delegator)` Return true if a target can be included in a shared library.
	`test_compiler(self, test_name, code, ext, file, run_it)` Run a test against the C compiler in this toolset.
	`use_std_cpp(self, delegator)` Specify that the standard C++ template library will be used.
Inherited from BuildEnv
	`get_env(self)` This function will combine the environment variables with those of its delegate and return a dictionary containing the merged result.
	`get_locate(self)` Locate can not be a build variable because it is needed when the build environment is constructed in order to specify where the targets reside.
	`run_command(self, unparsed_command, in_dir, real_command, globals)` Parse the command, replacing $ expressions, and run it.
	`subst_vars(self, cmd, globals)` Take a command string and replace the $ forms with evaluated pythod results.

Class Variable Summary
Inherited from BuildEnv
`SRE_Pattern`	`escape_re` = `\$\{([^\}]*)\}`
`SRE_Pattern`	`escape_re2` = `\$([_A-Za-z0-9]+)`

Method Details

command(self, command, targets=[], sources=[], clean=None, in_dir=None, locate=None, delegator=None)

Construct a target object that represents the result of running the given command.

See the user's guide documentation on the minishell. Targets is a list of files that this command will generate. Sources is a list of input files.

If clean is specified, it must be a python function that deletes the target and any intermidiate files generated by the command. If all files that are generated are specified in the targets list, there is no need to specify a clean function. Yab will automatically delete them when necessary.

In_dir is the directory to run the command in. The default is the same directory in which the calling YAB script resides.

Locate can be used to override the default output directory for the command.

copy(self, target, source, delegator=None)

Create a build target that represents copying the source to the target.

delay_load(self, lib_name, delegator=None)

Specify that the given library should be loaded on an as needed basis instead of at startup time.

Currently noop on anything other than Visual C++

get_toolset(self, delegator=None)

Used to get a handle to the toolset object from a generated target

get_variant(self, delegator=None)

Return the variant we are currently building.

make_c_obj(self, sources, locate=None, delegator=None)

Create a build target that represents a C object file.

You probably shouldn't call this directly unless you are going to ship the object file as part of the distribution. Instead, call add_sources on an executable or library target.

make_cpp_obj(self, sources, locate=None, delegator=None)

Create a build target that represents a C++ object file.

You probably shouldn't call this directly unless you are going to ship the object file as part of the distribution. Instead, call add_sources on an executable or library target.

make_executable(self, prog_name, locate=None, def_file=None, delegator=None)

Create a build target that represents an executable program.

make_shared_lib(self, lib_name, version=None, locate=None, delegator=None)

Create a build target that represents a shared library.

On windows, the result is a dll. On cygwin, this is the same as make_static_lib.

If version is specified, it is in the form major.minor, and will create an output file according the the platform conventions

print_features(self)

Print the feature values set on this toolset.

shared_linkable(self, delegator=None)

Return true if a target can be included in a shared library.

test_compiler(self, test_name=None, code=None, ext='.cpp', file=None, run_it=None)

Run a test against the C compiler in this toolset.

Each test should have a unique name. Yab will cache the test result using this name for speed. It will only run the test the first time yab is run on the machine, or when the --no-cache command line argument is given.

If code is specified, it should be a string containing the C code to compile. If file is given the code is retrieved from this file.

If the code doesn't compile the method returns None.

If run_it is true, the code is then run and the method returns the exit code.

use_std_cpp(self, delegator=None)

Specify that the standard C++ template library will be used.

Checks the appropriate compiler settings and adds the appropriate libraries for each platform

Generated by Epydoc 2.0 on Fri Aug 15 16:30:52 2003

http://epydoc.sf.net