Package SCons :: Module SConf

[frames] | no frames]

Module SConf

source code

SCons.SConf

Autoconf-like configuration support.

Classes

[hide private]

SConfWarning

SConfError

ConfigureDryRunError
Raised when a file or directory needs to be updated during a Configure process, but the user requested a dry-run

ConfigureCacheError
Raised when a use explicitely requested the cache feature, but the test is run the first time.

SConfBuildInfo
Special build info for targets of configure tests.

Streamer
'Sniffer' for a file-like writable object.

SConfBuildTask
This is almost the same as SCons.Script.BuildTask.

SConfBase
This is simply a class to represent a configure context.

CheckContext
Provides a context for configure tests.

Functions

[hide private]

SetBuildType(type)

source code

SetCacheMode(mode)
Set the Configure cache mode.

source code

SetProgressDisplay(display)
Set the progress display to use (called from SCons.Script)

source code

_createConfigH(target, source, env)

source code

_stringConfigH(target, source, env)

source code

CreateConfigHBuilder(env)
Called just before the building targets phase begins.

source code

_createSource(target, source, env)

source code

_stringSource(target, source, env)

source code

SConf(*args, **kw)

source code

CheckFunc(context, function_name, header=False, language=False)

source code

CheckType(context, type_name, includes='', language=False) source code

CheckTypeSize(context, type_name, includes='', language=False, expect=False) source code

CheckDeclaration(context, declaration, includes='', language=False) source code

createIncludesFromHeaders(headers, leaveLast, include_quotes='""') source code

CheckHeader(context, header, include_quotes='<>', language=False)
A test for a C or C++ header file. source code

CheckCHeader(context, header, include_quotes='""')
A test for a C header file. source code

CheckCXXHeader(context, header, include_quotes='""')
A test for a C++ header file. source code

CheckLib(context, library=False, symbol='main', header=False, language=False, autoadd=False)
A test for a library. source code

CheckLibWithHeader(context, libs, header, language, call=False, autoadd=False)
Another (more sophisticated) test for a library.

source code

Variables

[hide private]

__revision__ = 'src/engine/SCons/SConf.py 3266 2008/08/12 07:3...

build_type = False

build_types = ['clean', 'help']

dryrun = 0

AUTO = 0

FORCE = False

CACHE = 2

cache_mode = 0

progress_display = <SCons.Util.DisplayEngine instance at 0xca8...

SConfFS = False

_ac_build_counter = 0

_ac_config_logs = {}

_ac_config_hs = {}

sconf_global = False

BooleanTypes = [<type 'int'>, <type 'bool'>]

Function Details

[hide private]

SetCacheMode(mode)

source code

Set the Configure cache mode. mode must be one of "auto", "force", or "cache".

CheckLib(context, library=False, symbol=`'main'`, header=False, language=False, autoadd=False)

source code

A test for a library. See also CheckLibWithHeader. Note that library may also be None to test whether the given symbol compiles without flags.

CheckLibWithHeader(context, libs, header, language, call=False, autoadd=False)

source code

Another (more sophisticated) test for a library. Checks, if library and header is available for language (may be 'C' or 'CXX'). Call maybe be a valid expression _with_ a trailing ';'. As in CheckLib, we support library=None, to test if the call compiles without extra link flags.

Variables Details

[hide private]

revision

Value:

'src/engine/SCons/SConf.py 3266 2008/08/12 07:31:01 knight'

progress_display

Value:

SCons.Util.display

Module SConf

SetCacheMode(mode)

CheckLib(context, library=False, symbol='main', header=False, language=False, autoadd=False)

CheckLibWithHeader(context, libs, header, language, call=False, autoadd=False)

__revision__

progress_display

CheckLib(context, library=False, symbol=`'main'`, header=False, language=False, autoadd=False)

revision