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
57 # This is the directory SENFSCons.py resides
58 basedir = os.path.abspath(os.path.split(__file__)[0])
60 ## \brief Initialize configuration options
64 if opts is not None: return
65 opts = SCons.Options.Options('SConfig')
66 opts.Add('CXX', 'C++ compiler to use', 'g++')
67 opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '')
68 opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
69 opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
71 # A finalizer is any callable object. All finalizers will be called
72 # in MakeEnvironment. We use them so every finalizer has knowledge of
73 # all frameworks in use (e.g.: the boost runtime depends on the use of
76 ## \brief Register finalizer
82 ## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
84 # Configure the use of the <a href="http://www.boost.org">Boost</a>
85 # libraries. Most of these libraries are header-only, some however
86 # depend on a built library. The library selection is somewhat
87 # involved and depends on the threading model and the type of build
90 # \par Configuration Parameters:
91 # <table class="senf">
92 # <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
93 # <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
94 # <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
95 # <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
96 # <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
97 # <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
100 # You can either specify \c BOOST_VARIANT explicitly or specify \c
101 # BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
102 # BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
103 # to \c gd, If \c BOOST_TOOLSET is specified and you have included
104 # STLPort support (UseSTLPort()), then \c p is appended to both
107 # The Boost configuration can get realtively complex. If the boost
108 # libraries are provided by the distribution, you probably don't need
109 # to specify any parameters. If your configuration is more complex,
111 # href="http://www.boost.org/tools/build/v1/build_system.htm">Boost.Build</a>
112 # documentation for a definition of the terms used above (toolset,
113 # variant, runtime ...).
119 opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
120 opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
121 opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
122 opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
123 opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
124 opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
125 Finalizer(FinalizeBoost)
127 ## \brief Finalize Boost environment
129 def FinalizeBoost(env):
130 env.Tool('BoostUnitTests', [basedir])
132 if env['BOOST_TOOLSET']:
134 if env['final'] : runtime += env.get('BOOST_RUNTIME','')
135 else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
136 if env['STLPORT_LIB'] : runtime += "p"
137 if runtime: runtime = "-" + runtime
138 env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
140 env['BOOSTTESTLIB'] = 'libboost_unit_test_framework' + env['BOOST_VARIANT']
142 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
143 CPPPATH = [ '$BOOST_INCLUDES' ])
145 ## \brief Use STLPort as STL replacement if available
147 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
148 # for the system STL. STLPort has the added feature of providing fully
149 # checked containers and iterators. This can greatly simplify
150 # debugging. However, STLPort and Boost interact in a non-trivial way
151 # so the configuration is relatively complex. This command does not
152 # enforce the use of STLPort, it is only used if available.
154 # \par Configuration Parameters:
155 # <table class="senf">
156 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
157 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
158 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
159 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
162 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
163 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
164 # only be used, if \c STLPORT_LIB is set in \c SConfig.
170 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
171 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
172 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
173 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
174 Finalizer(FinalizeSTLPort)
178 ## \brief Finalize STLPort environment
180 def FinalizeSTLPort(env):
181 if env['STLPORT_LIB']:
182 if not env['STLPORT_DEBUGLIB']:
183 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
184 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
185 CPPPATH = [ '$STLPORT_INCLUDES' ])
187 env.Append(LIBS = [ '$STLPORT_LIB' ])
189 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
190 CPPDEFINES = [ '_STLP_DEBUG' ])
192 ## \brief Build a configured construction environment
194 # This function is called after all frameworks are specified to build
195 # a tailored construction environment. You can then use this
196 # construction environment just like an ordinary SCons construction
197 # environment (which it is ...)
199 # This call will set some default compilation parameters depending on
200 # the \c final command line option: specifying <tt>final=1</tt> will
201 # built a release version of the code.
202 def MakeEnvironment():
203 global opts, finalizers
205 env = SCons.Environment.Environment(options=opts)
206 if SCons.Script.SConscript.Arguments.get('final'):
208 env.Help(opts.GenerateHelpText(env))
210 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
211 # into other hosts from within SCons rules. I have used rules like
212 # this e.g. to automatically install stuff on a remote system ...
213 if os.environ.has_key('SSH_AUTH_SOCK'):
214 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
216 for finalizer in finalizers:
219 for tool in SCONS_TOOLS:
220 env.Tool(tool, [basedir])
222 # These are the default compilation parameters. We should probably
223 # make these configurable
224 env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
225 LOCALLIBDIR = [ '#' ],
226 LIBPATH = [ '$LOCALLIBDIR' ])
229 env.Append(CXXFLAGS = [ '-O3' ],
230 CPPDEFINES = [ 'NDEBUG' ])
232 env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
233 LINKFLAGS = [ '-g' ])
235 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
236 LIBS = [ '$EXTRA_LIBS' ])
240 ## \brief Find normal and test C++ sources
242 # GlobSources() will return a list of all C++ source files (named
243 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
244 # in the current directory. The sources will be returned as a tuple of
245 # sources, test-sources. The target helpers all accept such a tuple as
246 # their source argument.
247 def GlobSources(exclude=[]):
248 testSources = glob.glob("*.test.cc")
249 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
250 return (sources, testSources)
252 ## \brief Add generic standard targets for every module
254 # This target helper should be called in the top-level \c SConstruct file
255 # as well as in every module \c SConscipt file. It adds general
256 # targets. Right now, these are
257 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
258 # <tt>scons -c all</tt>
261 def StandardTargets(env):
262 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
264 ## \brief Add generic global targets
266 # This target helper should be called in the top-level \c SConstruct
267 # file. It adds general global targets. Right now theese are
268 # \li Make <tt>scons all</tt> build all targets.
271 def GlobalTargets(env):
272 env.Depends(env.Alias('all'),'#')
274 ## \brief Return path of a built library within $LOCALLIBDIR
276 def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib
278 ## \brief Build object files
280 # This target helper will build object files from the given
283 # If \a testSources are given, a unit test will be built using the <a
284 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
285 # library. \a LIBS may specify any additional library modules <em>from
286 # the same project</em> on which the test depends. Those libraries
287 # will be linked into the final test executable. The test will
288 # automatically be run if the \c test or \c all_tests targets are
291 # If \a sources is a 2-tuple as returned by GlobSources(), it will
292 # provide both \a sources and \a testSources.
295 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = []):
296 if type(sources) == type(()):
297 testSources = sources[1]
299 if type(sources) is not type([]):
300 sources = [ sources ]
304 objects = env.Object([
306 for source in sources
307 if not str(source).endswith('.o') ]) + [
309 for source in sources
310 if str(source).endswith('.o') ]
314 test = env.BoostUnitTests(
317 test_sources = testSources,
320 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
321 env.Alias('all_tests', test)
322 # Hmm ... here I'd like to use an Alias instead of a file
323 # however the alias does not seem to live in the subdirectory
324 # which breaks 'scons -u test'
325 env.Alias(env.File('test'), test)
329 ## \brief Build documentation with doxygen
331 # The doxygen target helper will build software documentation using
332 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
333 # builder used supports automatic dependency generation (dependencies
334 # are automatically generated from the parameters specified in the \a
335 # doxyfile), automatic target emitters (the exact targets created are
336 # found parsing the \a doxyfile) and lots of other features. See the
337 # Doxygen builder documentation
339 # If \a extra_sources are given, the generated documentation will
340 # depend on them. This can be used to build images or other
341 # supplementary files.
343 # The doxygen target helper extends the builder with additional
346 # \li Fix tagfiles by removing namespace entries. These entries only
347 # work for namespaces completely defined in a single module. As
348 # soon as another module (which references the tagfile) has it's
349 # own members in that namespace, the crosslinking will break.
350 # \li If \c DOXY_HTML_XSL is defined as a construction environment
351 # variable, preprocess all generated html files (if html files are
352 # generated) by the given XSLT stylesheet. Since the HTML
353 # generated by doxygen is broken, we first filter the code through
354 # HTML-\c tidy and filter out some error messages.
355 # \li If xml output is generated we create files \c bug.xmli and \c
356 # todo.xmli which contain all bugs and todo items specified in the
357 # sources. The format of these files is much more suited to
358 # postprocessing and is a more database like format as the doxygen
359 # generated files (which are more presentation oriented). if \c
360 # DOXY_XREF_TYPES is given, it will specify the cross reference
361 # types to support (defaults to \c bug and \c todo). See <a
362 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
363 # in the doxygen documentation.
366 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
367 # ARGHHH !!! without the [:] we are changing the target list
368 # ||| WITHIN THE DOXYGEN BUILDER
369 docs = env.Doxygen(doxyfile)[:]
374 if isinstance(doc,SCons.Node.FS.Dir): continue
375 if doc.name == 'xml.stamp' : xmlnode = doc
376 if doc.name == 'html.stamp' : htmlnode = doc
377 if doc.name == 'search.idx' : continue
378 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
379 # otherwise it must be the tag file
383 # Postprocess the tag file to remove the (broken) namespace
387 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
388 % { 'target': tagnode.abspath,
389 'template': os.path.join(basedir,"tagmunge.xsl") }))
391 if htmlnode and env.get('DOXY_HTML_XSL'):
392 xslfile = env.File(env['DOXY_HTML_XSL'])
393 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
394 if reltopdir : reltopdir = reltopdir[:-1]
395 else : reltopdir = '.'
398 SCons.Action.Action(("for html in %s/*.html; do " +
400 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}" +
401 " | tidy -ascii -q --show-warnings no --fix-uri no " +
402 " | xsltproc --nonet --html --stringparam topdir %s -o $${html}.new %s - 2>&1" +
404 " | grep -v 'ID .* already defined';" +
405 " mv $${html}.new $${html}; " +
407 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
409 env.Depends(doc, xslfile)
413 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
414 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
415 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
416 [ "test -s $SOURCE && xsltproc -o $TARGET" +
417 " --stringparam module $MODULE" +
418 " --stringparam type $TYPE" +
419 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
420 MODULE = xmlnode.dir.dir.dir.abspath[
421 len(env.Dir('#').abspath)+1:],
423 env.SideEffect(xref, xmlnode)
424 env.AddPreAction(docs, "rm -f %s" % (xref,))
425 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
426 xrefs.extend(xref_pp)
429 env.Depends(docs, extra_sources)
431 env.Alias('all_docs', doc)
432 env.Clean('all_docs', doc)
433 env.Clean('all', doc)
437 ## \brief Build combined doxygen cross-reference
439 # This command will build a complete cross-reference of \c xrefitems
440 # accross all modules.
442 # Right now, this command is very project specific. It needs to be
446 def DoxyXRef(env, docs=None,
447 HTML_HEADER = None, HTML_FOOTER = None,
448 TITLE = "Cross-reference of action points"):
450 docs = env.Alias('all_docs')[0].sources
451 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
452 xref = env.Command("doc/html/xref.xml", xrefs,
453 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
454 "echo '<xref>' >> $TARGET",
455 "cat $SOURCES >> $TARGET",
456 "echo '</xref>' >>$TARGET" ])
458 # Lastly we create the html file
459 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
460 if HTML_HEADER : sources.append(HTML_HEADER)
461 if HTML_FOOTER : sources.append(HTML_FOOTER)
465 commands.append("sed" +
466 " -e 's/\\$$title/$TITLE/g'" +
467 " -e 's/\\$$projectname/Overview/g'" +
468 " ${SOURCES[2]} > $TARGET")
469 commands.append("xsltproc" +
470 " --stringparam title '$TITLE'" +
471 " --stringparam types '$DOXY_XREF_TYPES'" +
472 " ${SOURCES[1]} $SOURCE >> $TARGET")
475 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
476 % (HTML_HEADER and 3 or 2))
478 if env.get('DOXY_HTML_XSL'):
479 xslfile = env.File(env['DOXY_HTML_XSL'])
480 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
481 if reltopdir : reltopdir = reltopdir[:-1]
482 else : reltopdir = '.'
483 commands.append(("xsltproc -o ${TARGET}.tmp" +
485 " --stringparam topdir %s" +
486 " ${SOURCES[-1]} $TARGET 2>/dev/null")
488 commands.append("mv ${TARGET}.tmp ${TARGET}")
489 sources.append(xslfile)
491 xref = env.Command("doc/html/xref.html", sources, commands,
494 env.Alias('all_docs',xref)
498 ## \brief Build library
500 # This target helper will build the given library. The library will be
501 # called lib<i>library</i>.a as is customary on UNIX systems. \a
502 # sources, \a testSources and \a LIBS are directly forwarded to the
503 # Objects build helper.
505 # The library is added to the list of default targets.
508 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = []):
509 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
512 lib = env.Library(env.File(LibPath(library)),objects)
514 env.Append(ALLLIBS = library)
517 ## \brief Build Object from multiple sources
518 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = []):
519 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
522 ob = env.Command(target+".o", objects, "ld -r -o $TARGET $SOURCES")
526 ## \brief Build executable
528 # This target helper will build the given binary. The \a sources, \a
529 # testSources and \a LIBS arguments are forwarded to the Objects
530 # builder. The final program will be linked against all the library
531 # modules specified in \a LIBS (those are libraries which are built as
532 # part of the same proejct). To specify non-module libraries, use the
533 # construction environment parameters or the framework helpers.
536 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = []):
537 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
541 progEnv.Prepend(LIBS = LIBS)
542 program = progEnv.Program(target=binary,source=objects+OBJECTS)
544 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])