# 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