Dependencies and Configuration

Classes
class	lsst.sconsUtils.dependencies.Configuration
	Base class for defining how to configure an LSST sconsUtils package. More...
class	lsst.sconsUtils.dependencies.ExternalConfiguration
	A Configuration subclass for external (third-party) packages. More...
class	lsst.sconsUtils.dependencies.PackageTree
	A class for loading and managing the dependency tree of a package, as defined by its configuration module (.cfg) file. More...

Functions
def	lsst.sconsUtils.dependencies.configure (packageName, versionString=None, eupsProduct=None, eupsProductPath=None, noCfgFile=False)
	Recursively configure a package using ups/.cfg files. More...
def	lsst.sconsUtils.dependencies.CustomCFlagCheck (context, flag, append=True)
	A configuration test that checks whether a C compiler supports a particular flag. More...
def	lsst.sconsUtils.dependencies.CustomCppFlagCheck (context, flag, append=True)
	A configuration test that checks whether a C++ compiler supports a particular flag. More...
def	lsst.sconsUtils.dependencies.CustomCompileCheck (context, message, source, extension=".cc")
	A configuration test that checks whether the given source code compiles. More...
def	lsst.sconsUtils.dependencies.CustomLinkCheck (context, message, source, extension=".cc")
	A configuration test that checks whether the given source code compiles and links. More...
def	lsst.sconsUtils.dependencies.getLibs (env, categories="main")
	Get the libraries the package should be linked with. More...

Detailed Description

Function Documentation

configure()

def lsst.sconsUtils.dependencies.configure	(		packageName,
			versionString = None,
			eupsProduct = None,
			eupsProductPath = None,
			noCfgFile = False
	)

Recursively configure a package using ups/.cfg files.

Aliased as lsst.sconsUtils.configure().

Usually, LSST packages will call this function through scripts.BasicSConstruct.

Parameters

packageName	Name of the package being built; must correspond to a .cfg file in ups/.
versionString	Version-control system string to be parsed for version information ($HeadURL$ for SVN).
eupsProduct	Name of the EUPS product being built. Defaults to and is almost always the name of the package.
eupsProductPath	An alternate directory where the package should be installed.
noCfgFile	If True, this package has no .cfg file

Returns

an SCons Environment object (which is also available as lsst.sconsUtils.env).

Definition at line 38 of file dependencies.py.

def configure(packageName, versionString=None, eupsProduct=None, eupsProductPath=None, noCfgFile=False):
    if not state.env.GetOption("no_progress"):
        state.log.info("Setting up environment to build package '%s'." % packageName)
    if eupsProduct is None:
        eupsProduct = packageName
    if versionString is None:
        versionString = "git"
    state.env['eupsProduct'] = eupsProduct
    state.env['packageName'] = packageName
    #
    # Setup installation directories and variables
    #
    SCons.Script.Help(state.opts.GenerateHelpText(state.env))
    state.env.installing = [t for t in SCons.Script.BUILD_TARGETS if t == "install"]
    state.env.declaring = [t for t in SCons.Script.BUILD_TARGETS if t == "declare" or t == "current"]
    state.env.linkFarmDir = state.env.GetOption("linkFarmDir")
    if state.env.linkFarmDir:
        state.env.linkFarmDir = os.path.abspath(os.path.expanduser(state.env.linkFarmDir))
    prefix = installation.setPrefix(state.env, versionString, eupsProductPath)
    state.env['prefix'] = prefix
    state.env["libDir"] = "%s/lib" % prefix
    state.env["pythonDir"] = "%s/python" % prefix
    #
    # Process dependencies
    #
    state.log.traceback = state.env.GetOption("traceback")
    state.log.verbose = state.env.GetOption("verbose")
    packages = PackageTree(packageName, noCfgFile=noCfgFile)
    state.log.flush()  # if we've already hit a fatal error, die now.
    state.env.libs = {"main": [], "python": [], "test": []}
    state.env.doxygen = {"tags": [], "includes": []}
    state.env['CPPPATH'] = []
    state.env['LIBPATH'] = []

    # XCPPPATH is a new variable defined by sconsUtils - it's like CPPPATH, but the headers
    # found there aren't treated as dependencies.  This can make scons a lot faster.
    state.env['XCPPPATH'] = []

    # XCPPPPREFIX is a replacement for SCons' built-in INCPREFIX. It is used
    # when compiling headers in XCPPPATH directories. Here, we set it to
    # `-isystem`, so that those are regarded as "system headers" and warnings
    # are suppressed.
    state.env['XCPPPREFIX'] = "-isystem "

    state.env['_CPPINCFLAGS'] = \
        "$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)}"\
        " ${_concat(XCPPPREFIX, XCPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)"
    state.env['_SWIGINCFLAGS'] = state.env['_CPPINCFLAGS'] \
                                      .replace("CPPPATH", "SWIGPATH") \
                                      .replace("XCPPPREFIX", "SWIGINCPREFIX")

    if state.env.linkFarmDir:
        for d in [state.env.linkFarmDir, "#"]:
            state.env.Append(CPPPATH=os.path.join(d, "include"))
            state.env.Append(LIBPATH=os.path.join(d, "lib"))
        state.env['SWIGPATH'] = state.env['CPPPATH']

    if not state.env.GetOption("clean") and not state.env.GetOption("help"):
        packages.configure(state.env, check=state.env.GetOption("checkDependencies"))
        for target in state.env.libs:
            state.log.info("Libraries in target '%s': %s" % (target, state.env.libs[target]))
    state.env.dependencies = packages
    state.log.flush()


# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

CustomCFlagCheck()

def lsst.sconsUtils.dependencies.CustomCFlagCheck	(		context,
			flag,
			append = True
	)

A configuration test that checks whether a C compiler supports a particular flag.

Parameters

context	Configuration context.
flag	Flag to test, e.g. "-fvisibility-inlines-hidden".
append	Automatically append the flag to context.env["CCFLAGS"] if the compiler supports it?

Definition at line 321 of file dependencies.py.

def CustomCFlagCheck(context, flag, append=True):
    context.Message("Checking if C compiler supports " + flag + " flag ")
    ccflags = context.env["CCFLAGS"]
    context.env.Append(CCFLAGS=flag)
    result = context.TryCompile("int main(int argc, char **argv) { return 0; }", ".c")
    context.Result(result)
    if not append or not result:
        context.env.Replace(CCFLAGS=ccflags)
    return result

CustomCompileCheck()

def lsst.sconsUtils.dependencies.CustomCompileCheck	(		context,
			message,
			source,
			extension = ".cc"
	)

A configuration test that checks whether the given source code compiles.

Parameters

context	Configuration context.
message	Message disaplyed on console prior to running the test.
source	Source code to compile. param extension Identifies the language of the source code. Use ".c" for C, and ".cc" for C++ (the default).

Definition at line 361 of file dependencies.py.

def CustomCompileCheck(context, message, source, extension=".cc"):
    context.Message(message)

    env = context.env
    if (env.GetOption("clean") or env.GetOption("help") or env.GetOption("no_exec")):
        result = True
    else:
        result = context.TryCompile(source, extension)

    context.Result(result)

    return result

CustomCppFlagCheck()

def lsst.sconsUtils.dependencies.CustomCppFlagCheck	(		context,
			flag,
			append = True
	)

A configuration test that checks whether a C++ compiler supports a particular flag.

Parameters

context	Configuration context.
flag	Flag to test, e.g. "-fvisibility-inlines-hidden".
append	Automatically append the flag to context.env["CXXFLAGS"] if the compiler supports it?

Definition at line 341 of file dependencies.py.

def CustomCppFlagCheck(context, flag, append=True):
    context.Message("Checking if C++ compiler supports " + flag + " flag ")
    cxxflags = context.env["CXXFLAGS"]
    context.env.Append(CXXFLAGS=flag)
    result = context.TryCompile("int main(int argc, char **argv) { return 0; }", ".cc")
    context.Result(result)
    if not append or not result:
        context.env.Replace(CXXFLAGS=cxxflags)
    return result

CustomLinkCheck()

def lsst.sconsUtils.dependencies.CustomLinkCheck	(		context,
			message,
			source,
			extension = ".cc"
	)

A configuration test that checks whether the given source code compiles and links.

Parameters

context	Configuration context.
message	Message disaplyed on console prior to running the test.
source	Source code to compile. param extension Identifies the language of the source code. Use ".c" for C, and ".cc" for C++ (the default).

Definition at line 384 of file dependencies.py.

def CustomLinkCheck(context, message, source, extension=".cc"):
    context.Message(message)
    result = context.TryLink(source, extension)
    context.Result(result)
    return result


# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

getLibs()

def lsst.sconsUtils.dependencies.getLibs	(		env,
			categories = "main"
	)

Get the libraries the package should be linked with.

Parameters

categories

A string containing whitespace-delimited categories. Standard categories are "main", "python", and "test". Default is "main". A special virtual category "self" can be provided, returning the results of targets="main" with the env["packageName"] removed.

Typically, main libraries will be linked with LIBS=getLibs("self"), Python modules will be linked with LIBS=getLibs("main python") and C++-coded test programs will be linked with LIBS=getLibs("main test"). """

Definition at line 569 of file dependencies.py.

def getLibs(env, categories="main"):
    libs = []
    removeSelf = False
    for category in categories.split():
        if category == "self":
            category = "main"
            removeSelf = True
        for lib in env.libs[category]:
            if lib not in libs:
                libs.append(lib)
    if removeSelf:
        try:
            libs.remove(env["packageName"])
        except ValueError:
            pass
    return libs


SConsEnvironment.getLibs = getLibs