SCons.SConf

Package SCons :: Module SConf

[show private | hide private]

Module SCons.SConf

SCons.SConf

Autoconf-like configuration support.

Classes
`CheckContext`	Provides a context for configure tests.
`SConfBase`	This is simply a class to represent a configure context.
`SConfBuildInfo`	Special build info for targets of configure tests.
`SConfBuildTask`	This is almost the same as SCons.Script.BuildTask.
`Streamer`	'Sniffer' for a file-like writable object.

Exceptions
`ConfigureCacheError`	Raised when a use explicitely requested the cache feature, but the test is run the first time.
`ConfigureDryRunError`	Raised when a file or directory needs to be updated during a Configure process, but the user requested a dry-run
`SConfError`
`SConfWarning`

Function Summary
	`CheckCHeader(context, header, include_quotes)` A test for a C header file.
	`CheckCXXHeader(context, header, include_quotes)` A test for a C++ header file.
	`CheckFunc(context, function_name, header, language)`
	`CheckHeader(context, header, include_quotes, language)` A test for a C or C++ header file.
	`CheckLib(context, library, symbol, header, language, autoadd)` A test for a library.
	`CheckLibWithHeader(context, libs, header, language, call, autoadd)` Another (more sophisticated) test for a library.
	`CheckType(context, type_name, includes, language)`
	`CheckTypeSize(context, type_name, includes, language, expect)`
	`CreateConfigHBuilder(env)` Called just before the building targets phase begins.
	`createIncludesFromHeaders(headers, leaveLast, include_quotes)`
	`SConf(args, *kw)`
	`SetBuildType(type)`
	`SetCacheMode(mode)` Set the Configure cache mode.
	`SetProgressDisplay(display)` Set the progress display to use (called from SCons.Script)
	`_createConfigH(target, source, env)`
	`_createSource(target, source, env)`
	`_stringConfigH(target, source, env)`
	`_stringSource(target, source, env)`

Function Details

CheckCHeader(context, header, include_quotes='""')

A test for a C header file.

CheckCXXHeader(context, header, include_quotes='""')

A test for a C++ header file.

CheckHeader(context, header, include_quotes='<>', language=None)

A test for a C or C++ header file.

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

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=None, autoadd=1)

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.

CreateConfigHBuilder(env)

Called just before the building targets phase begins.

SetCacheMode(mode)

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

SetProgressDisplay(display)

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

Generated by Epydoc 2.1 on Wed Dec 12 09:39:32 2007

http://epydoc.sf.net