Package SCons :: Module Conftest

Module Conftest

SCons.Conftest

Autoconf-like configuration support; low level implementation of tests.

Functions

CheckBuilder(context, text=None, language=None)
Configure check to see if the compiler works. Note that this uses the current value of compiler and linker flags, make sure $CFLAGS, $CPPFLAGS and $LIBS are set correctly. "language" should be "C" or "C++" and is used to select the compiler. Default is "C". "text" may be used to specify the code to be build. Returns an empty string for success, an error message for failure.

source code

CheckCC(context)
Configure check for a working C compiler.

source code

CheckSHCC(context)
Configure check for a working shared C compiler.

source code

CheckCXX(context)
Configure check for a working CXX compiler.

source code

CheckSHCXX(context)
Configure check for a working shared CXX compiler.

source code

_check_empty_program(context, comp, text, language, use_shared=False)
Return 0 on success, 1 otherwise.

source code

CheckFunc(context, function_name, header=None, language=None)
Configure check for a function "function_name". "language" should be "C" or "C++" and is used to select the compiler. Default is "C". Optional "header" can be defined to define a function prototype, include a header file or anything else that comes before main(). Sets HAVE_function_name in context.havedict according to the result. Note that this uses the current value of compiler and linker flags, make sure $CFLAGS, $CPPFLAGS and $LIBS are set correctly. Returns an empty string for success, an error message for failure.

source code

CheckHeader(context, header_name, header=None, language=None, include_quotes=None)
Configure check for a C or C++ header file "header_name". Optional "header" can be defined to do something before including the header file (unusual, supported for consistency). "language" should be "C" or "C++" and is used to select the compiler. Default is "C". Sets HAVE_header_name in context.havedict according to the result. Note that this uses the current value of compiler and linker flags, make sure $CFLAGS and $CPPFLAGS are set correctly. Returns an empty string for success, an error message for failure.

source code

CheckType(context, type_name, fallback=None, header=None, language=None)
Configure check for a C or C++ type "type_name". Optional "header" can be defined to include a header file. "language" should be "C" or "C++" and is used to select the compiler. Default is "C". Sets HAVE_type_name in context.havedict according to the result. Note that this uses the current value of compiler and linker flags, make sure $CFLAGS, $CPPFLAGS and $LIBS are set correctly. Returns an empty string for success, an error message for failure.

source code

CheckTypeSize(context, type_name, header=None, language=None, expect=None)
This check can be used to get the size of a given type, or to check whether the type is of expected size.

source code

CheckDeclaration(context, symbol, includes=None, language=None)
Checks whether symbol is declared.

source code

CheckLib(context, libs, func_name=None, header=None, extra_libs=None, call=None, language=None, autoadd=1, append=True)
Configure check for a C or C++ libraries "libs". Searches through the list of libraries, until one is found where the test succeeds. Tests if "func_name" or "call" exists in the library. Note: if it exists in another library the test succeeds anyway! Optional "header" can be defined to include a header file. If not given a default prototype for "func_name" is added. Optional "extra_libs" is a list of library names to be added after "lib_name" in the build command. To be used for libraries that "lib_name" depends on. Optional "call" replaces the call to "func_name" in the test code. It must consist of complete C statements, including a trailing ";". Both "func_name" and "call" arguments are optional, and in that case, just linking against the libs is tested. "language" should be "C" or "C++" and is used to select the compiler. Default is "C". Note that this uses the current value of compiler and linker flags, make sure $CFLAGS, $CPPFLAGS and $LIBS are set correctly. Returns an empty string for success, an error message for failure.

source code

CheckProg(context, prog_name)
Configure check for a specific program.

source code

_YesNoResult(context, ret, key, text, comment=None)
Handle the result of a test with a "yes" or "no" result.

source code

_Have(context, key, have, comment=None)
Store result of a test in context.havedict and context.headerfilename.

source code

_LogFailed(context, text, msg)
Write to the log about a failed program. Add line numbers, so that error messages can be understood.

source code

_lang2suffix(lang)
Convert a language name to a suffix. When "lang" is empty or None C is assumed. Returns a tuple (lang, suffix, None) when it works. For an unrecognized language returns (None, None, msg).

source code

Variables

[hide private]

LogInputFiles = 1

LogErrorMessages = 1

__package__ = 'SCons'

Function Details

[hide private]

CheckCC(context)

source code

Configure check for a working C compiler.

This checks whether the C compiler, as defined in the $CC construction variable, can compile a C source file. It uses the current $CCCOM value too, so that it can test against non working flags.

CheckSHCC(context)

source code

Configure check for a working shared C compiler.

This checks whether the C compiler, as defined in the $SHCC construction variable, can compile a C source file. It uses the current $SHCCCOM value too, so that it can test against non working flags.

CheckCXX(context)

source code

Configure check for a working CXX compiler.

This checks whether the CXX compiler, as defined in the $CXX construction variable, can compile a CXX source file. It uses the current $CXXCOM value too, so that it can test against non working flags.

CheckSHCXX(context)

source code

Configure check for a working shared CXX compiler.

This checks whether the CXX compiler, as defined in the $SHCXX construction variable, can compile a CXX source file. It uses the current $SHCXXCOM value too, so that it can test against non working flags.

CheckTypeSize(context, type_name, header=None, language=None, expect=None)

source code

This check can be used to get the size of a given type, or to check whether the type is of expected size.

Arguments:

type : str

the type to check
includes : sequence

list of headers to include in the test code before testing the type
language : str

'C' or 'C++'
expect : int

if given, will test wether the type has the given number of bytes. If not given, will automatically find the size.

Returns:

status : int: 0 if the check failed, or the found size of the type if the check succeeded.

CheckDeclaration(context, symbol, includes=None, language=None)

source code

Checks whether symbol is declared.

Use the same test as autoconf, that is test whether the symbol is defined as a macro or can be used as an r-value.

Arguments:

symbol : str: the symbol to check
includes : str: Optional "header" can be defined to include a header file.
language : str: only C and C++ supported.

Returns:

status : bool: True if the check failed, False if succeeded.

CheckProg(context, prog_name)

source code

Configure check for a specific program.

Check whether program prog_name exists in path. If it is found, returns the path for it, otherwise returns None.

_YesNoResult(context, ret, key, text, comment=None)

source code

Handle the result of a test with a "yes" or "no" result.

Parameters:

ret - is the return value: empty if OK, error message when not.
key - is the name of the symbol to be defined (HAVE_foo).
text - is the source code of the program used for testing.
comment - is the C comment to add above the line defining the symbol (the comment is automatically put inside a /* */). If None, no comment is added.

_Have(context, key, have, comment=None)

source code

Store result of a test in context.havedict and context.headerfilename.

The value of "have" can be:

1 - Feature is defined, add "#define key".
0 - Feature is not defined, add "/* #undef key */". Adding "undef" is what autoconf does. Not useful for the compiler, but it shows that the test was done.
number - Feature is defined to this number "#define key have". Doesn't work for 0 or 1, use a string then.
string - Feature is defined to this string "#define key have".

Parameters:

key - - is a "HAVE_abc" name. It is turned into all CAPITALS and non-alphanumerics are replaced by an underscore.
have - - value as it should appear in the header file, include quotes when desired and escape special characters!
comment - is the C comment to add above the line defining the symbol (the comment is automatically put inside a /* */). If None, no comment is added.

_lang2suffix(lang)

source code

Convert a language name to a suffix. When "lang" is empty or None C is assumed. Returns a tuple (lang, suffix, None) when it works. For an unrecognized language returns (None, None, msg).

Where:

lang = the unified language name
suffix = the suffix, including the leading dot
msg = an error message