lsst.sconsUtils.dependencies.Configuration Class Reference

Base class for defining how to configure an LSST sconsUtils package. More...

Inheritance diagram for lsst.sconsUtils.dependencies.Configuration:

Public Member Functions
def	__init__
	Initialize the configuration object. More...
def	addCustomTests
	Add custom SCons configuration tests to the Configure Context passed to the configure() method. More...
def	configure
	Update an SCons environment to make use of the package. More...

Static Public Member Functions
def	parseFilename
	Parse the name of a .cfg file, returning the package name and root directory. More...
def	getEupsData

Public Attributes
	root
	eupsProduct
	version
	doxygen
	libs
	paths
	provides

Detailed Description

Base class for defining how to configure an LSST sconsUtils package.

Aliased as lsst.sconsUtils.Configuration.

An ups/*.cfg file should contain an instance of this class called "config". Most LSST packages will be able to use this class directly instead of subclassing it.

The only important method is configure(), which modifies an SCons environment to use the package. If a subclass overrides configure, it may not need to call the base class init(), whose only purpose is to define a number of instance variables used by configure().

Definition at line 110 of file dependencies.py.

Constructor & Destructor Documentation

def lsst.sconsUtils.dependencies.Configuration.__init__	(		self,
			cfgFile,
			headers = (),
			libs = None,
			hasSwigFiles = True,
			includeFileDirs = ["include",
			libFileDirs = ["lib",
			hasDoxygenInclude = False,
			hasDoxygenTag = True,
			eupsProduct = None
	)

Initialize the configuration object.

Parameters

cfgFile	The name of the calling .cfg file, usually just passed in with the special variable file. This will be parsed to extract the package name and root.
headers	A list of headers provided by the package, to be used in autoconf-style tests.
libs	A list or dictionary of libraries provided by the package. If a dictionary is provided, libs["main"] should contain a list of regular libraries provided by the library. Other keys are "python" and "test", which refer to libraries that are only linked against compiled Python modules and unit tests, respectively. If a list is provided, the list is used as "main". These are used both for autoconf-style tests and to support env.getLibs(...), which recursively computes the libraries a package must be linked with.
hasSwigFiles	If True, the package provides SWIG interface files in "<root>/python".
hasDoxygenInclude	If True, the package provides a Doxygen include file with the name "<root>/doc/<name>.inc".
hasDoxygenTag	If True, the package generates a Doxygen TAG file.
includeFileDirs	List of directories that should be searched for include files
libFileDirs	List of directories that should be searched for libraries
eupsProduct	Name of the EUPS product for the package, if different from the name of the .cfg file.

Definition at line 154 of file dependencies.py.

                 hasDoxygenInclude=False, hasDoxygenTag=True, eupsProduct=None):
        self.name, self.root = self.parseFilename(cfgFile)
        if eupsProduct is None:
            eupsProduct = self.name
        self.eupsProduct = eupsProduct
        version, productDir = self.getEupsData(self.eupsProduct)
        if version is not None:
            self.version = version
        if productDir is None:
            state.log.warn("Could not find EUPS product dir for '%s'; using %s."
                           % (self.eupsProduct, self.root))
        else:
            self.root = os.path.realpath(productDir)
        self.doxygen = {
            # Doxygen tag files generated by this package
            "tags": ([os.path.join(self.root, "doc", "%s.tag" % self.name)]
                     if hasDoxygenTag else []),
            # Doxygen include files to include in the configuration of dependent products
            "includes": ([os.path.join(self.root, "doc", "%s.inc" % self.name)]
                         if hasDoxygenInclude else [])
            }
        if libs is None:
            self.libs = {
                # Normal libraries provided by this package
                "main": [self.name],
                # Libraries provided that should only be linked with Python modules
                "python":[],
                # Libraries provided that should only be linked with unit test code
                "test":[],
                }
        elif "main" in libs:
            self.libs = libs
        else:
            self.libs = {"main": libs, "python": [], "test": []}
        self.paths = {}
        if hasSwigFiles:
            self.paths["SWIGPATH"] = [os.path.join(self.root, "python")]
        else:
            self.paths["SWIGPATH"] = []

        for pathName, subDirs in [("CPPPATH", includeFileDirs),
                                  ("LIBPATH", libFileDirs),]:
            self.paths[pathName] = []

            if state.env.linkFarmDir:
                continue

            for subDir in subDirs:
                pathDir = os.path.join(self.root, subDir)
                if os.path.isdir(pathDir):
                    self.paths[pathName].append(pathDir)

        self.provides = {
            "headers": tuple(headers),
            "libs": tuple(self.libs["main"])
            }