2 # \brief SENFSCons package
4 ## \package senfscons.SENFSCons
5 # \brief Build helpers and utilities
7 # The SENFSCons package contains a number of build helpers and
8 # utilities which are used to simplify commmon tasks.
10 # The utitlities of this package are grouped into:
11 # <dl><dt>\ref use</dt><dd>help using complex environments and
12 # configure the construction environmen correspondingly</dd>
14 # <dt>\ref target</dt><dd>simplify building common targest and include
15 # enhanced functionality like unit-testing.</dd></dl>
17 # Additionally for external use are
18 # <dl><dt>MakeEnvironment()</dt><dd>Build construction
21 # <dt>GlobSources()</dt><dd>Utility to find source files</dd></dl>
23 # All other functions are for internal use only.
26 import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS
27 import SCons.Defaults, SCons.Action
29 ## \defgroup use Predefined Framework Configurators
31 # The following framework configurators are used in the top level \c
32 # SConstruct file to simplify more complex configurations.
34 # Each of the framework configurators introduces additional
35 # configuration parameters to \ref sconfig
37 ## \defgroup target Target Helpers
39 # To specify standard targets, the following helpers can be used. They
40 # automatically integrate several modules (like documentation,
43 ## \defgroup builder Builders
45 # The SENFSCons framework includes a series of builders. Each builder
46 # is defined in it's own package.
48 # Tools to load in MakeEnvironment
59 # This is the directory SENFSCons.py resides
60 basedir = os.path.abspath(os.path.split(__file__)[0])
62 ## \brief Initialize configuration options
66 if opts is not None: return
67 opts = SCons.Options.Options('SConfig')
68 opts.Add('CXX', 'C++ compiler to use', 'g++')
69 opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '')
70 opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
71 opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
72 opts.Add('PREFIX', 'Installation prefix', '/usr/local')
73 opts.Add('LIBINSTALLDIR', 'Library install dir', '$PREFIX/lib')
74 opts.Add('BININSTALLDIR', 'Executable install dir', '$PREFIX/bin')
75 opts.Add('INCLUDEINSTALLDIR', 'Include-file install dir', '$PREFIX/include')
76 opts.Add('OBJINSTALLDIR', 'Static object file install dir', '$LIBINSTALLDIR')
77 opts.Add('DOCINSTALLDIR', 'Documentation install dir', '$PREFIX/doc')
78 opts.Add('CPP_INCLUDE_EXTENSIONS', 'File extensions to include in source install',
79 [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti', '.mpp' ])
81 # A finalizer is any callable object. All finalizers will be called
82 # in MakeEnvironment. We use them so every finalizer has knowledge of
83 # all frameworks in use (e.g.: the boost runtime depends on the use of
86 ## \brief Register finalizer
92 ## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
94 # Configure the use of the <a href="http://www.boost.org">Boost</a>
95 # libraries. Most of these libraries are header-only, some however
96 # depend on a built library. The library selection is somewhat
97 # involved and depends on the threading model and the type of build
100 # \par Configuration Parameters:
101 # <table class="senf">
102 # <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
103 # <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
104 # <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
105 # <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
106 # <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
107 # <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
110 # You can either specify \c BOOST_VARIANT explicitly or specify \c
111 # BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
112 # BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
113 # to \c gd, If \c BOOST_TOOLSET is specified and you have included
114 # STLPort support (UseSTLPort()), then \c p is appended to both
117 # The Boost configuration can get realtively complex. If the boost
118 # libraries are provided by the distribution, you probably don't need
119 # to specify any parameters. If your configuration is more complex,
121 # href="http://www.boost.org/tools/build/v1/build_system.htm">Boost.Build</a>
122 # documentation for a definition of the terms used above (toolset,
123 # variant, runtime ...).
129 opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
130 opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
131 opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
132 opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
133 opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
134 opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
135 Finalizer(FinalizeBoost)
137 ## \brief Finalize Boost environment
139 def FinalizeBoost(env):
140 env.Tool('BoostUnitTests', [basedir])
142 if env['BOOST_TOOLSET']:
144 if env['final'] : runtime += env.get('BOOST_RUNTIME','')
145 else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
146 if env['STLPORT_LIB'] : runtime += "p"
147 if runtime: runtime = "-" + runtime
148 env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
150 env['BOOSTTESTLIB'] = 'libboost_unit_test_framework' + env['BOOST_VARIANT']
151 env['BOOSTREGEXLIB'] = 'libboost_regex' + env['BOOST_VARIANT']
153 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
154 CPPPATH = [ '$BOOST_INCLUDES' ])
156 ## \brief Use STLPort as STL replacement if available
158 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
159 # for the system STL. STLPort has the added feature of providing fully
160 # checked containers and iterators. This can greatly simplify
161 # debugging. However, STLPort and Boost interact in a non-trivial way
162 # so the configuration is relatively complex. This command does not
163 # enforce the use of STLPort, it is only used if available.
165 # \par Configuration Parameters:
166 # <table class="senf">
167 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
168 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
169 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
170 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
173 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
174 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
175 # only be used, if \c STLPORT_LIB is set in \c SConfig.
181 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
182 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
183 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
184 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
185 Finalizer(FinalizeSTLPort)
189 ## \brief Finalize STLPort environment
191 def FinalizeSTLPort(env):
192 if env['STLPORT_LIB']:
193 if not env['STLPORT_DEBUGLIB']:
194 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
195 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
196 CPPPATH = [ '$STLPORT_INCLUDES' ])
198 env.Append(LIBS = [ '$STLPORT_LIB' ])
200 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
201 CPPDEFINES = [ '_STLP_DEBUG' ])
203 ## \brief Build a configured construction environment
205 # This function is called after all frameworks are specified to build
206 # a tailored construction environment. You can then use this
207 # construction environment just like an ordinary SCons construction
208 # environment (which it is ...)
210 # This call will set some default compilation parameters depending on
211 # the \c final command line option: specifying <tt>final=1</tt> will
212 # built a release version of the code.
213 def MakeEnvironment():
214 global opts, finalizers
216 env = SCons.Environment.Environment(options=opts)
217 for opt in opts.options:
218 if SCons.Script.SConscript.Arguments.get(opt.key):
219 env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
220 if SCons.Script.SConscript.Arguments.get('final'):
222 env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
223 env.Help(opts.GenerateHelpText(env))
225 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
226 # into other hosts from within SCons rules. I have used rules like
227 # this e.g. to automatically install stuff on a remote system ...
228 if os.environ.has_key('SSH_AUTH_SOCK'):
229 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
231 for finalizer in finalizers:
234 for tool in SCONS_TOOLS:
235 env.Tool(tool, [basedir])
237 # These are the default compilation parameters. We should probably
238 # make these configurable
239 env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
240 LOCALLIBDIR = [ '#' ],
241 LIBPATH = [ '$LOCALLIBDIR' ])
244 env.Append(CXXFLAGS = [ '-O3' ],
245 CPPDEFINES = [ 'NDEBUG' ])
247 env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
248 LINKFLAGS = [ '-g' ])
250 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
251 LIBS = [ '$EXTRA_LIBS' ])
255 ## \brief Find normal and test C++ sources
257 # GlobSources() will return a list of all C++ source files (named
258 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
259 # in the current directory. The sources will be returned as a tuple of
260 # sources, test-sources. The target helpers all accept such a tuple as
261 # their source argument.
262 def GlobSources(exclude=[], subdirs=[]):
263 testSources = glob.glob("*.test.cc")
264 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
265 for subdir in subdirs:
266 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
267 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
268 if x not in testSources and x not in exclude ]
269 return (sources, testSources)
271 ## \brief Add generic standard targets for every module
273 # This target helper should be called in the top-level \c SConstruct file
274 # as well as in every module \c SConscipt file. It adds general
275 # targets. Right now, these are
276 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
277 # <tt>scons -c all</tt>
280 def StandardTargets(env):
281 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
283 ## \brief Add generic global targets
285 # This target helper should be called in the top-level \c SConstruct
286 # file. It adds general global targets. Right now theese are
287 # \li Make <tt>scons all</tt> build all targets.
290 def GlobalTargets(env):
291 env.Depends(env.Alias('all'),'#')
293 ## \brief Return path of a built library within $LOCALLIBDIR
295 def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib
297 ## \brief Build object files
299 # This target helper will build object files from the given
302 # If \a testSources are given, a unit test will be built using the <a
303 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
304 # library. \a LIBS may specify any additional library modules <em>from
305 # the same project</em> on which the test depends. Those libraries
306 # will be linked into the final test executable. The test will
307 # automatically be run if the \c test or \c all_tests targets are
310 # If \a sources is a 2-tuple as returned by GlobSources(), it will
311 # provide both \a sources and \a testSources.
314 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = []):
315 if type(sources) == type(()):
316 testSources = sources[1]
318 if type(sources) is not type([]):
319 sources = [ sources ]
323 objects = env.Object([
325 for source in sources
326 if not str(source).endswith('.o') ]) + [
328 for source in sources
329 if str(source).endswith('.o') ]
333 test = env.BoostUnitTests(
336 test_sources = testSources,
339 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
340 env.Alias('all_tests', test)
341 # Hmm ... here I'd like to use an Alias instead of a file
342 # however the alias does not seem to live in the subdirectory
343 # which breaks 'scons -u test'
344 env.Alias(env.File('test'), test)
348 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
349 if type(sources) is type(()):
350 sources, testSources = sources
351 if type(sources) is not type([]):
352 sources = [ sources ]
353 if type(testSources) is not type([]):
354 testSources = [ testSources ]
357 installs.append( env.Install(dir, targets) )
360 target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
361 env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
364 source.append( env.File('.test.bin') )
366 installs.append(env.InstallIncludes(
369 INSTALL_BASE = env.Dir('.') ))
373 ## \brief Build documentation with doxygen
375 # The doxygen target helper will build software documentation using
376 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
377 # builder used supports automatic dependency generation (dependencies
378 # are automatically generated from the parameters specified in the \a
379 # doxyfile), automatic target emitters (the exact targets created are
380 # found parsing the \a doxyfile) and lots of other features. See the
381 # Doxygen builder documentation
383 # If \a extra_sources are given, the generated documentation will
384 # depend on them. This can be used to build images or other
385 # supplementary files.
387 # The doxygen target helper extends the builder with additional
390 # \li Fix tagfiles by removing namespace entries. These entries only
391 # work for namespaces completely defined in a single module. As
392 # soon as another module (which references the tagfile) has it's
393 # own members in that namespace, the crosslinking will break.
394 # \li If \c DOXY_HTML_XSL is defined as a construction environment
395 # variable, preprocess all generated html files (if html files are
396 # generated) by the given XSLT stylesheet. Since the HTML
397 # generated by doxygen is broken, we first filter the code through
398 # HTML-\c tidy and filter out some error messages.
399 # \li If xml output is generated we create files \c bug.xmli and \c
400 # todo.xmli which contain all bugs and todo items specified in the
401 # sources. The format of these files is much more suited to
402 # postprocessing and is a more database like format as the doxygen
403 # generated files (which are more presentation oriented). if \c
404 # DOXY_XREF_TYPES is given, it will specify the cross reference
405 # types to support (defaults to \c bug and \c todo). See <a
406 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
407 # in the doxygen documentation.
410 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
411 # ARGHHH !!! without the [:] we are changing the target list
412 # ||| WITHIN THE DOXYGEN BUILDER
413 docs = env.Doxygen(doxyfile)[:]
418 if isinstance(doc,SCons.Node.FS.Dir): continue
419 if doc.name == 'xml.stamp' : xmlnode = doc
420 if doc.name == 'html.stamp' : htmlnode = doc
421 if doc.name == 'search.idx' : continue
422 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
423 # otherwise it must be the tag file
427 # Postprocess the tag file to remove the (broken) namespace
431 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
432 % { 'target': tagnode.abspath,
433 'template': os.path.join(basedir,"tagmunge.xsl") }))
435 if htmlnode and env.get('DOXY_HTML_XSL'):
436 xslfile = env.File(env['DOXY_HTML_XSL'])
437 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
438 if reltopdir : reltopdir = reltopdir[:-1]
439 else : reltopdir = '.'
442 SCons.Action.Action(("for html in %s/*.html; do " +
444 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}" +
445 " | tidy -ascii -q --show-warnings no --fix-uri no " +
446 " | xsltproc --nonet --html --stringparam topdir %s -o $${html}.new %s - 2>&1" +
448 " | grep -v 'ID .* already defined';" +
449 " mv $${html}.new $${html}; " +
451 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
453 env.Depends(doc, xslfile)
457 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
458 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
459 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
460 [ "test -s $SOURCE && xsltproc -o $TARGET" +
461 " --stringparam module $MODULE" +
462 " --stringparam type $TYPE" +
463 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
464 MODULE = xmlnode.dir.dir.dir.abspath[
465 len(env.Dir('#').abspath)+1:],
467 env.SideEffect(xref, xmlnode)
468 env.AddPreAction(docs, "rm -f %s" % (xref,))
469 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
470 xrefs.extend(xref_pp)
473 if extra_sources and htmlnode:
475 [ env.CopyToDir( source=source, target=htmlnode.dir )
476 for source in extra_sources ])
478 if extra_sources and xmlnode:
480 [ env.CopyToDir( source=source, target=xmlnode.dir )
481 for source in extra_sources ])
483 if not htmlnode and not xmlnode:
484 env.Depends(docs, extra_sources)
487 env.Alias('all_docs', doc)
488 env.Clean('all_docs', doc)
489 env.Clean('all', doc)
491 l = len(env.Dir('#').abspath)
493 env.Alias('install_all',
494 env.Install( '$DOCINSTALLDIR' + htmlnode.dir.dir.abspath[l:],
497 env.Alias('install_all',
498 env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
503 ## \brief Build combined doxygen cross-reference
505 # This command will build a complete cross-reference of \c xrefitems
506 # accross all modules.
508 # Right now, this command is very project specific. It needs to be
512 def DoxyXRef(env, docs=None,
513 HTML_HEADER = None, HTML_FOOTER = None,
514 TITLE = "Cross-reference of action points"):
516 docs = env.Alias('all_docs')[0].sources
517 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
518 xref = env.Command("doc/html/xref.xml", xrefs,
519 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
520 "echo '<xref>' >> $TARGET",
521 "cat $SOURCES >> $TARGET",
522 "echo '</xref>' >>$TARGET" ])
524 # Lastly we create the html file
525 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
526 if HTML_HEADER : sources.append(HTML_HEADER)
527 if HTML_FOOTER : sources.append(HTML_FOOTER)
531 commands.append("sed" +
532 " -e 's/\\$$title/$TITLE/g'" +
533 " -e 's/\\$$projectname/Overview/g'" +
534 " ${SOURCES[2]} > $TARGET")
535 commands.append("xsltproc" +
536 " --stringparam title '$TITLE'" +
537 " --stringparam types '$DOXY_XREF_TYPES'" +
538 " ${SOURCES[1]} $SOURCE >> $TARGET")
541 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
542 % (HTML_HEADER and 3 or 2))
544 if env.get('DOXY_HTML_XSL'):
545 xslfile = env.File(env['DOXY_HTML_XSL'])
546 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
547 if reltopdir : reltopdir = reltopdir[:-1]
548 else : reltopdir = '.'
549 commands.append(("xsltproc -o ${TARGET}.tmp" +
551 " --stringparam topdir %s" +
552 " ${SOURCES[-1]} $TARGET 2>/dev/null")
554 commands.append("mv ${TARGET}.tmp ${TARGET}")
555 sources.append(xslfile)
557 xref = env.Command("doc/html/xref.html", sources, commands,
560 env.Alias('all_docs',xref)
564 ## \brief Build library
566 # This target helper will build the given library. The library will be
567 # called lib<i>library</i>.a as is customary on UNIX systems. \a
568 # sources, \a testSources and \a LIBS are directly forwarded to the
569 # Objects build helper.
571 # The library is added to the list of default targets.
574 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
575 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
578 lib = env.Library(env.File(LibPath(library)),objects)
580 env.Append(ALLLIBS = library)
581 install = InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
582 env.Alias('install_all', install)
585 ## \brief Build Object from multiple sources
586 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
587 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
590 ob = env.Command(target+".o", objects, "ld -r -o $TARGET $SOURCES")
592 install = InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
593 env.Alias('install_all', install)
596 ## \brief Build executable
598 # This target helper will build the given binary. The \a sources, \a
599 # testSources and \a LIBS arguments are forwarded to the Objects
600 # builder. The final program will be linked against all the library
601 # modules specified in \a LIBS (those are libraries which are built as
602 # part of the same proejct). To specify non-module libraries, use the
603 # construction environment parameters or the framework helpers.
606 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
607 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
611 progEnv.Prepend(LIBS = LIBS)
612 program = progEnv.Program(target=binary,source=objects+OBJECTS)
614 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
615 install = InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources,
617 env.Alias('install_all', install)