-## \file
-# \brief SENFSCons package
-
-## \package senfscons.SENFSCons
-# \brief Build helpers and utilities
-#
-# The SENFSCons package contains a number of build helpers and
-# utilities which are used to simplify commmon tasks.
-#
-# The utitlities of this package are grouped into:
-# <dl><dt>\ref use</dt><dd>help using complex environments and
-# configure the construction environmen correspondingly</dd>
-#
-# <dt>\ref target</dt><dd>simplify building common targest and include
-# enhanced functionality like unit-testing.</dd></dl>
-#
-# Additionally for external use are
-# <dl><dt>MakeEnvironment()</dt><dd>Build construction
-# environment</dd>
-#
-# <dt>GlobSources()</dt><dd>Utility to find source files</dd></dl>
-#
-# All other functions are for internal use only.
-
import os.path, glob
import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS
import SCons.Defaults, SCons.Action
from SCons.Script import *
-## \defgroup use Predefined Framework Configurators
-#
-# The following framework configurators are used in the top level \c
-# SConstruct file to simplify more complex configurations.
-#
-# Each of the framework configurators introduces additional
-# configuration parameters to \ref sconfig
-
-## \defgroup target Target Helpers
-#
-# To specify standard targets, the following helpers can be used. They
-# automatically integrate several modules (like documentation,
-# unit-testing etc).
-
-## \defgroup builder Builders
-#
-# The SENFSCons framework includes a series of builders. Each builder
-# is defined in it's own package.
-
-# Tools to load in MakeEnvironment
-SCONS_TOOLS = [
- "Doxygen",
- "Dia2Png",
- "PkgDraw",
- "CopyToDir",
- "ProgramNoScan",
- "CompileCheck",
-]
-
-opts = None
-finalizers = []
-
-# This is the directory SENFSCons.py resides
-basedir = os.path.abspath(os.path.split(__file__)[0])
-
-## \brief Initialize configuration options
-# \internal
-def InitOpts():
- global opts
- if opts is not None: return
- opts = SCons.Options.Options('SConfig')
- opts.Add('CXX', 'C++ compiler to use', 'g++')
- opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '')
- opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
- opts.Add('EXTRA_CCFLAGS', 'Additional compilation parameters', '')
- opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
- opts.Add(SCons.Options.BoolOption('debug','Enable debug symbols in binaries',0))
- opts.Add(SCons.Options.BoolOption('profile','Enable profiling',0))
- opts.Add('PREFIX', 'Installation prefix', '/usr/local')
- opts.Add('LIBINSTALLDIR', 'Library install dir', '$PREFIX/lib')
- opts.Add('BININSTALLDIR', 'Executable install dir', '$PREFIX/bin')
- opts.Add('INCLUDEINSTALLDIR', 'Include-file install dir', '$PREFIX/include')
- opts.Add('OBJINSTALLDIR', 'Static object file install dir', '$LIBINSTALLDIR')
- opts.Add('DOCINSTALLDIR', 'Documentation install dir', '$PREFIX/doc')
- opts.Add('CPP_INCLUDE_EXTENSIONS', 'File extensions to include in source install',
- [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti', '.mpp' ])
- opts.Add('CPP_EXCLUDE_EXTENSIONS', 'File extensions to exclude from source install',
- [ '.test.hh' ])
-
-# A finalizer is any callable object. All finalizers will be called
-# in MakeEnvironment. We use them so every finalizer has knowledge of
-# all frameworks in use (e.g.: the boost runtime depends on the use of
-# stlport).
-
-## \brief Register finalizer
-# \internal
-def Finalizer(f):
- global finalizers
- finalizers.append(f)
-
-## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
-#
-# Configure the use of the <a href="http://www.boost.org">Boost</a>
-# libraries. Most of these libraries are header-only, some however
-# depend on a built library. The library selection is somewhat
-# involved and depends on the threading model and the type of build
-# (debug or final).
-#
-# \par Configuration Parameters:
-# <table class="senf">
-# <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
-# <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
-# <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
-# <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
-# <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
-# <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
-# </table>
-#
-# You can either specify \c BOOST_VARIANT explicitly or specify \c
-# BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
-# BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
-# to \c gd, If \c BOOST_TOOLSET is specified and you have included
-# STLPort support (UseSTLPort()), then \c p is appended to both
-# runtimes.
-#
-# The Boost configuration can get realtively complex. If the boost
-# libraries are provided by the distribution, you probably don't need
-# to specify any parameters. If your configuration is more complex,
-# refer to the <a
-# href="http://www.boost.org/tools/build/v2/index.html">Boost.Build</a>
-# documentation for a definition of the terms used above (toolset,
-# variant, runtime ...).
-#
-# \ingroup use
-def UseBoost():
- global opts
- InitOpts()
- opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
- opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
- opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
- opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
- opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
- opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
- opts.Add('BOOST_PREFIX', 'The prefix into which boost is installed', '')
- opts.Add('BOOST_VERSION', 'The version of boost to use', '')
- Finalizer(FinalizeBoost)
-
-## \brief Finalize Boost environment
-# \internal
-def FinalizeBoost(env):
- env.Tool('BoostUnitTests', [basedir])
-
- if env['BOOST_TOOLSET']:
- runtime = ""
- if env['final'] : runtime += env.get('BOOST_RUNTIME','')
- else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
- if env['STLPORT_LIB'] : runtime += "p"
- if runtime: runtime = "-" + runtime
- env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
-
- if env['BOOST_VARIANT'] and env['BOOST_VERSION']:
- env['BOOST_VARIANT'] = env['BOOST_VARIANT'] + '-%s' % env['BOOST_VERSION'].replace('.','_')
-
- env['BOOSTTESTLIB'] = 'boost_unit_test_framework' + env['BOOST_VARIANT']
- env['BOOSTREGEXLIB'] = 'boost_regex' + env['BOOST_VARIANT']
- env['BOOSTFSLIB'] = 'boost_filesystem' + env['BOOST_VARIANT']
- env['BOOSTIOSTREAMSLIB'] = 'boost_iostreams' + env['BOOST_VARIANT']
- env['BOOSTSIGNALSLIB'] = 'boost_signals' + env['BOOST_VARIANT']
-
- if env['BOOST_PREFIX']:
- env['BOOST_LIBDIR'] = os.path.join(env['BOOST_PREFIX'], 'lib')
- env['BOOST_INCLUDES'] = os.path.join(env['BOOST_PREFIX'],
- 'include/boost-%s'
- % env['BOOST_VERSION'].replace('.','_'))
-
- env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
- CPPPATH = [ '$BOOST_INCLUDES' ])
-
- if env['BOOST_LIBDIR']:
- env.Append(ENV = { 'LD_LIBRARY_PATH': env['BOOST_LIBDIR'] })
-
-## \brief Use STLPort as STL replacement if available
-#
-# Use <a href="http://www.stlport.org">STLPort</a> as a replacement
-# for the system STL. STLPort has the added feature of providing fully
-# checked containers and iterators. This can greatly simplify
-# debugging. However, STLPort and Boost interact in a non-trivial way
-# so the configuration is relatively complex. This command does not
-# enforce the use of STLPort, it is only used if available.
-#
-# \par Configuration Parameters:
-# <table class="senf">
-# <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
-# <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
-# <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
-# <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
-# </table>
-#
-# If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
-# STLPORT_LIB with \c _stldebug appended. The STLPort library will
-# only be used, if \c STLPORT_LIB is set in \c SConfig.
-#
-# \ingroup use
-def UseSTLPort():
- global opts
- InitOpts()
- opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
- opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
- opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
- opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
- Finalizer(FinalizeSTLPort)
-
-# \}
-
-## \brief Finalize STLPort environment
-# \internal
-def FinalizeSTLPort(env):
- if env['STLPORT_LIB']:
- if not env['STLPORT_DEBUGLIB']:
- env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
- env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
- CPPPATH = [ '$STLPORT_INCLUDES' ])
- if env['final']:
- env.Append(LIBS = [ '$STLPORT_LIB' ])
- else:
- env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
- CPPDEFINES = [ '_STLP_DEBUG' ])
-
-## \brief Build a configured construction environment
-#
-# This function is called after all frameworks are specified to build
-# a tailored construction environment. You can then use this
-# construction environment just like an ordinary SCons construction
-# environment (which it is ...)
-#
-# This call will set some default compilation parameters depending on
-# the \c final command line option: specifying <tt>final=1</tt> will
-# built a release version of the code.
-def MakeEnvironment():
- global opts, finalizers
- InitOpts()
- env = SCons.Environment.Environment(options=opts)
- env.Replace(**SCons.Script.SConscript.Arguments)
- #for opt in opts.options:
- # if SCons.Script.SConscript.Arguments.get(opt.key):
- # env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
- #if SCons.Script.SConscript.Arguments.get('final'):
- # env['final'] = 1
- env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
- env.Help(opts.GenerateHelpText(env))
-
- # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
- # into other hosts from within SCons rules. I have used rules like
- # this e.g. to automatically install stuff on a remote system ...
- if os.environ.has_key('SSH_AUTH_SOCK'):
- env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
-
- for finalizer in finalizers:
- finalizer(env)
-
- for tool in SCONS_TOOLS:
- env.Tool(tool, [basedir])
-
- # These are the default compilation parameters. We should probably
- # make these configurable
- env.Append(LOCALLIBDIR = [ '#' ],
- LIBPATH = [ '$LOCALLIBDIR' ])
-
- if env['final']:
- env.Append(CXXFLAGS = [ '-O3' ])
- if env['profile']:
- env.Append(CXXFLAGS = [ '-g', '-pg' ],
- LINKFLAGS = [ '-g', '-pg' ])
- else:
- # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails:
- # CPPDEFINES = [ '_GLIBCXX_DEBUG' ],
- env.Append(CXXFLAGS = [ '-O0', '-g' ],
- CPPDEFINES = { 'SENF_DEBUG': ''})
- if env['profile']:
- env.Append(CXXFLAGS = [ '-pg' ],
- LINKFLAGS = [ '-pg' ])
- if env['debug'] or env['profile']:
- env.Append(LINKFLAGS = [ '-g', '-rdynamic' ])
- else:
- env.Append(LINKFLAGS = [ '-Wl,-S', '-rdynamic' ])
-
- env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
- LIBS = [ '$EXTRA_LIBS' ],
- CXXFLAGS = [ '$EXTRA_CCFLAGS' ],
- ALLOBJECTS = [])
-
- return env
-
-## \brief Find normal and test C++ sources
-#
-# GlobSources() will return a list of all C++ source files (named
-# "*.cc") as well as a list of all unit-test files (named "*.test.cc")
-# in the current directory. The sources will be returned as a tuple of
-# sources, test-sources. The target helpers all accept such a tuple as
-# their source argument.
-def GlobSources(env, exclude=[], subdirs=[]):
+def Glob(env, exclude=[], subdirs=[]):
testSources = glob.glob("*.test.cc")
sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
for subdir in subdirs:
testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
if x not in testSources and x not in exclude ]
- return (sources, testSources)
-
-def GlobIncludes(env, exclude=[], subdirs=[]):
includes = []
for d in [ '.' ] + subdirs:
for f in os.listdir(d):
and ext not in env['CPP_EXCLUDE_EXTENSIONS'] \
and p not in exclude:
includes.append(p)
- return includes
-
-def Glob(env, exclude=[], subdirs=[]):
- return ( GlobSources(env, exclude, subdirs),
- GlobIncludes(env, exclude, subdirs) )
-
-## \brief Add generic standard targets for every module
-#
-# This target helper should be called in the top-level \c SConstruct file
-# as well as in every module \c SConscipt file. It adds general
-# targets. Right now, these are
-# \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
-# <tt>scons -c all</tt>
-#
-# \ingroup target
-def StandardTargets(env):
- env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
-
-## \brief Add generic global targets
-#
-# This target helper should be called in the top-level \c SConstruct
-# file. It adds general global targets. Right now theese are
-# \li Make <tt>scons all</tt> build all targets.
-#
-# \ingroup target
-def GlobalTargets(env):
- env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
+ return ( sources, testSources, includes )
-## \brief Return path of a built library within $LOCALLIBDIR
-# \internal
-def LibPath(lib): return '${LOCALLIBDIR}/${LIBPREFIX}%s${LIBADDSUFFIX}${LIBSUFFIX}' % lib
-
-## \brief Add explicit test
-#
-# This target helper will add an explicit test. This is like a unit test but is
-# built directly against the completed library
-#
-# \ingroup target
-def Test(env, sources, LIBS = [], OBJECTS = []):
- test = [ env.BoostUnitTests(
- target = 'test',
- objects = [],
- test_sources = sources,
- LIBS = [ '$LIBSENF$LIBADDSUFFIX' ],
- OBJECTS = OBJECTS,
- DEPENDS = [ env.File(LibPath(env['LIBSENF'])) ]) ]
- compileTestSources = [ src for src in sources
- if 'COMPILE_CHECK' in file(src).read() ]
- if compileTestSources:
- test.extend(env.CompileCheck(source = compileTestSources))
- env.Alias('all_tests', test)
- env.Command(env.File('test'), test, [ 'true' ])
- #env.Alias(env.File('test'), test)
-
-
-## \brief Build object files
-#
-# This target helper will build object files from the given
-# sources.
-#
-# If \a testSources are given, a unit test will be built using the <a
-# href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
-# library. \a LIBS may specify any additional library modules <em>from
-# the same project</em> on which the test depends. Those libraries
-# will be linked into the final test executable. The test will
-# automatically be run if the \c test or \c all_tests targets are
-# given.
-#
-# If \a sources is a 2-tuple as returned by GlobSources(), it will
-# provide both \a sources and \a testSources.
-#
-# \ingroup target
-def Objects(env, sources, testSources = None, OBJECTS = []):
- if type(sources) == type(()):
- testSources = sources[1]
- sources = sources[0]
- if type(sources) is not type([]):
- sources = [ sources ]
-
- objects = None
- if sources:
- obsources = [ source
- for source in sources
- if type(source) is type('') and not source.endswith('.o') ]
- objects = [ source
- for source in sources
- if type(source) is not type('') or source.endswith('.o') ]
- if obsources:
- objects += env.Object(obsources)
-
- if testSources:
- test = [ env.BoostUnitTests(
- target = 'test',
- objects = objects,
- test_sources = testSources,
- LIBS = [ '$LIBSENF$LIBADDSUFFIX' ],
- OBJECTS = OBJECTS,
- DEPENDS = [ env.File(LibPath(env['LIBSENF'])) ]) ]
- compileTestSources = [ src for src in testSources
- if 'COMPILE_CHECK' in file(src).read() ]
- if compileTestSources:
- test.extend(env.CompileCheck(source = compileTestSources))
- env.Alias('all_tests', test)
- # Hmm ... here I'd like to use an Alias instead of a file
- # however the alias does not seem to live in the subdirectory
- # which breaks 'scons -u test'
- env.Command(env.File('test'), test, [ 'true' ])
- #env.Alias(env.File('test'), test)
-
- return objects
-
-def InstallIncludeFiles(env, files):
- # Hrmpf ... why do I need this in 0.97??
- if env.GetOption('clean'):
- return
- target = env.Dir(env['INCLUDEINSTALLDIR'])
- base = env.Dir('#')
- for f in files:
- src = env.File(f)
- env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
-
-## \brief Build documentation with doxygen
-#
-# \ingroup target
def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
# There is one small problem we need to solve with this builder: The Doxygen builder reads
# the Doxyfile and thus depends on the environment variables set by doclib/doxygen.sh. We
# Module name is derived from the doxyfile path
# Utils/Console/Doxyfile -> Utils_Console
- module = doxyfile.dir.abspath[len(env.Dir('#').abspath)+1:].replace('/','_')
- if not module : module = "Main"
+ module = doxyfile.dir.get_path(env.Dir('#')).replace('/','_')
+ if module == '.' : module = "Main"
# Rule to generate tagfile
# (need to exclude the 'clean' case, otherwise we'll have duplicate nodes)
if not env.GetOption('clean'):
- env.Append(ALL_TAGFILES =
- env.Doxygen(doxyfile,
- DOXYOPTS = [ '--tagfile-name', '"${MODULE}.tag"',
- '--tagfile' ],
- DOXYENV = { 'TOPDIR' : env.Dir('#').abspath,
- 'output_dir' : 'doc',
- 'html_dir' : 'html',
- 'html' : 'NO',
- 'generate_tagfile': 'doc/${MODULE}.tag' },
- MODULE = module )[0].abspath)
+ tagfile = env.Doxygen(doxyfile,
+ DOXYOPTS = [ '--tagfile-name', '"${MODULE}.tag"',
+ '--tagfile' ],
+ DOXYENV = { 'TOPDIR' : env.Dir('#').abspath,
+ 'output_dir' : 'doc',
+ 'html_dir' : 'html',
+ 'html' : 'NO',
+ 'generate_tagfile': 'doc/${MODULE}.tag' },
+ MODULE = module )
+ env.Append(ALL_TAGFILES = tagfile[0].abspath)
+ env.Depends(tagfile, env.File('#/doclib/doxygen.sh'))
# Rule to generate HTML documentation
doc = env.Doxygen(doxyfile,
'output_dir' : 'doc',
'html_dir' : 'html',
'html' : 'YES' } )
+ env.Depends(doc, env.File('#/doclib/doxygen.sh'))
# Copy the extra_sources (the images) into the documentation directory
# (need to exclude the 'clean' case otherwise there are multiple ways to clean the copies)
if not env.GetOption('clean'):
if extra_sources:
- env.Depends(doc,
- [ env.CopyToDir( source=source, target=doc[0].dir )
- for source in extra_sources ])
+ env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources))
# Install documentation into DOCINSTALLDIR
l = len(env.Dir('#').abspath)
- env.Alias('install_all',
- env.Command('$DOCINSTALLDIR' + doc[0].dir.abspath[l:], doc[0].dir,
- [ SCons.Defaults.Copy('$TARGET','$SOURCE') ]))
+ env.Install(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.get_path('#')), doc[0].dir)
# Useful aliases
env.Alias('all_docs', doc)
return doc
-## \brief Build library
-#
-# This target helper will build the given library. The library will be
-# called lib<i>library</i>.a as is customary on UNIX systems. \a
-# sources, \a testSources and \a LIBS are directly forwarded to the
-# Objects build helper.
-#
-# The library is added to the list of default targets.
-#
-#\ingroup target
-def Lib(env, sources, testSources = None, OBJECTS = []):
- objects = Objects(env,sources,testSources,OBJECTS=OBJECTS)
- if objects:
- env.Append(ALLOBJECTS = objects)
- return objects
-
-## \brief Build Object from multiple sources
-def Object(env, target, sources, testSources = None, OBJECTS = []):
- objects = Objects(env,sources,testSources,OBJECTS=OBJECTS)
- ob = None
- if objects:
- ob = env.Command(target+"${OBJADDSUFFIX}${OBJSUFFIX}", objects, "ld -r -o $TARGET $SOURCES")
- env.Default(ob)
- env.Alias('default', ob)
- env.Alias('install_all', env.Install("$OBJINSTALLDIR", ob))
- return ob
-
-## \brief Build executable
-#
-# This target helper will build the given binary. The \a sources, \a
-# testSources and \a LIBS arguments are forwarded to the Objects
-# builder. The final program will be linked against all the library
-# modules specified in \a LIBS (those are libraries which are built as
-# part of the same proejct). To specify non-module libraries, use the
-# construction environment parameters or the framework helpers.
-#
-# \ingroup target
-def Binary(env, binary, sources, testSources = None, OBJECTS = []):
- objects = Objects(env,sources,testSources,OBJECTS=OBJECTS)
- program = None
- if objects:
- progEnv = env.Clone()
- progEnv.Prepend(LIBS = [ '$LIBSENF$LIBADDSUFFIX' ])
- program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
- env.Default(program)
- env.Depends(program, [ env.File(LibPath(env['LIBSENF'])) ])
- env.Alias('default', program)
- env.Alias('install_all', env.Install('$BININSTALLDIR', program))
- return program
-
-def AllIncludesHH(env, headers):
+def AllIncludesHH(env, exclude=[]):
+ exclude = exclude[:] + ['all_includes.hh'] # Make a copy !!
+ headers = [ f for f in glob.glob("*.hh")
+ if f not in exclude and not f.endswith('.test.hh') ]
headers.sort()
target = env.File("all_includes.hh")
file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
for f in headers ]))
env.Clean('all', target)
-
-def PhonyTarget(env, target, action, sources=[]):
- env.AlwaysBuild(env.Alias(target, sources, env.Action(action)))
projects / senf.git / blobdiff