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
60 # This is the directory SENFSCons.py resides
61 basedir = os.path.abspath(os.path.split(__file__)[0])
63 ## \brief Initialize configuration options
67 if opts is not None: return
68 opts = SCons.Options.Options('SConfig')
69 opts.Add('CXX', 'C++ compiler to use', 'g++')
70 opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '')
71 opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
72 opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
73 opts.Add('PREFIX', 'Installation prefix', '/usr/local')
74 opts.Add('LIBINSTALLDIR', 'Library install dir', '$PREFIX/lib')
75 opts.Add('BININSTALLDIR', 'Executable install dir', '$PREFIX/bin')
76 opts.Add('INCLUDEINSTALLDIR', 'Include-file install dir', '$PREFIX/include')
77 opts.Add('OBJINSTALLDIR', 'Static object file install dir', '$LIBINSTALLDIR')
78 opts.Add('DOCINSTALLDIR', 'Documentation install dir', '$PREFIX/doc')
79 opts.Add('CPP_INCLUDE_EXTENSIONS', 'File extensions to include in source install',
80 [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti', '.mpp' ])
82 # A finalizer is any callable object. All finalizers will be called
83 # in MakeEnvironment. We use them so every finalizer has knowledge of
84 # all frameworks in use (e.g.: the boost runtime depends on the use of
87 ## \brief Register finalizer
93 ## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
95 # Configure the use of the <a href="http://www.boost.org">Boost</a>
96 # libraries. Most of these libraries are header-only, some however
97 # depend on a built library. The library selection is somewhat
98 # involved and depends on the threading model and the type of build
101 # \par Configuration Parameters:
102 # <table class="senf">
103 # <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
104 # <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
105 # <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
106 # <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
107 # <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
108 # <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
111 # You can either specify \c BOOST_VARIANT explicitly or specify \c
112 # BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
113 # BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
114 # to \c gd, If \c BOOST_TOOLSET is specified and you have included
115 # STLPort support (UseSTLPort()), then \c p is appended to both
118 # The Boost configuration can get realtively complex. If the boost
119 # libraries are provided by the distribution, you probably don't need
120 # to specify any parameters. If your configuration is more complex,
122 # href="http://www.boost.org/tools/build/v2/index.html">Boost.Build</a>
123 # documentation for a definition of the terms used above (toolset,
124 # variant, runtime ...).
130 opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
131 opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
132 opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
133 opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
134 opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
135 opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
136 Finalizer(FinalizeBoost)
138 ## \brief Finalize Boost environment
140 def FinalizeBoost(env):
141 env.Tool('BoostUnitTests', [basedir])
143 if env['BOOST_TOOLSET']:
145 if env['final'] : runtime += env.get('BOOST_RUNTIME','')
146 else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
147 if env['STLPORT_LIB'] : runtime += "p"
148 if runtime: runtime = "-" + runtime
149 env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
151 env['BOOSTTESTLIB'] = 'libboost_unit_test_framework' + env['BOOST_VARIANT']
152 env['BOOSTREGEXLIB'] = 'libboost_regex' + env['BOOST_VARIANT']
154 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
155 CPPPATH = [ '$BOOST_INCLUDES' ])
157 ## \brief Use STLPort as STL replacement if available
159 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
160 # for the system STL. STLPort has the added feature of providing fully
161 # checked containers and iterators. This can greatly simplify
162 # debugging. However, STLPort and Boost interact in a non-trivial way
163 # so the configuration is relatively complex. This command does not
164 # enforce the use of STLPort, it is only used if available.
166 # \par Configuration Parameters:
167 # <table class="senf">
168 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
169 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
170 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
171 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
174 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
175 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
176 # only be used, if \c STLPORT_LIB is set in \c SConfig.
182 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
183 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
184 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
185 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
186 Finalizer(FinalizeSTLPort)
190 ## \brief Finalize STLPort environment
192 def FinalizeSTLPort(env):
193 if env['STLPORT_LIB']:
194 if not env['STLPORT_DEBUGLIB']:
195 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
196 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
197 CPPPATH = [ '$STLPORT_INCLUDES' ])
199 env.Append(LIBS = [ '$STLPORT_LIB' ])
201 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
202 CPPDEFINES = [ '_STLP_DEBUG' ])
204 ## \brief Build a configured construction environment
206 # This function is called after all frameworks are specified to build
207 # a tailored construction environment. You can then use this
208 # construction environment just like an ordinary SCons construction
209 # environment (which it is ...)
211 # This call will set some default compilation parameters depending on
212 # the \c final command line option: specifying <tt>final=1</tt> will
213 # built a release version of the code.
214 def MakeEnvironment():
215 global opts, finalizers
217 env = SCons.Environment.Environment(options=opts)
218 for opt in opts.options:
219 if SCons.Script.SConscript.Arguments.get(opt.key):
220 env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
221 if SCons.Script.SConscript.Arguments.get('final'):
223 env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
224 env.Help(opts.GenerateHelpText(env))
226 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
227 # into other hosts from within SCons rules. I have used rules like
228 # this e.g. to automatically install stuff on a remote system ...
229 if os.environ.has_key('SSH_AUTH_SOCK'):
230 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
232 for finalizer in finalizers:
235 for tool in SCONS_TOOLS:
236 env.Tool(tool, [basedir])
238 # These are the default compilation parameters. We should probably
239 # make these configurable
240 env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
241 LOCALLIBDIR = [ '#' ],
242 LIBPATH = [ '$LOCALLIBDIR' ])
245 env.Append(CXXFLAGS = [ '-O3' ],
246 CPPDEFINES = [ 'NDEBUG' ])
248 env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
249 # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails.
250 # CPPDEFINES = [ '_GLIBCXX_DEBUG' ],
251 LINKFLAGS = [ '-g' ])
253 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
254 LIBS = [ '$EXTRA_LIBS' ],
259 ## \brief Find normal and test C++ sources
261 # GlobSources() will return a list of all C++ source files (named
262 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
263 # in the current directory. The sources will be returned as a tuple of
264 # sources, test-sources. The target helpers all accept such a tuple as
265 # their source argument.
266 def GlobSources(exclude=[], subdirs=[]):
267 testSources = glob.glob("*.test.cc")
268 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
269 for subdir in subdirs:
270 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
271 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
272 if x not in testSources and x not in exclude ]
273 return (sources, testSources)
275 ## \brief Add generic standard targets for every module
277 # This target helper should be called in the top-level \c SConstruct file
278 # as well as in every module \c SConscipt file. It adds general
279 # targets. Right now, these are
280 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
281 # <tt>scons -c all</tt>
284 def StandardTargets(env):
285 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
287 ## \brief Add generic global targets
289 # This target helper should be called in the top-level \c SConstruct
290 # file. It adds general global targets. Right now theese are
291 # \li Make <tt>scons all</tt> build all targets.
294 def GlobalTargets(env):
295 env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
297 ## \brief Return path of a built library within $LOCALLIBDIR
299 def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib
301 ## \brief Build object files
303 # This target helper will build object files from the given
306 # If \a testSources are given, a unit test will be built using the <a
307 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
308 # library. \a LIBS may specify any additional library modules <em>from
309 # the same project</em> on which the test depends. Those libraries
310 # will be linked into the final test executable. The test will
311 # automatically be run if the \c test or \c all_tests targets are
314 # If \a sources is a 2-tuple as returned by GlobSources(), it will
315 # provide both \a sources and \a testSources.
318 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = []):
319 if type(sources) == type(()):
320 testSources = sources[1]
322 if type(sources) is not type([]):
323 sources = [ sources ]
327 objects = env.Object([
329 for source in sources
330 if not str(source).endswith('.o') ]) + [
332 for source in sources
333 if str(source).endswith('.o') ]
337 test = env.BoostUnitTests(
340 test_sources = testSources,
343 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
344 env.Alias('all_tests', test)
345 # Hmm ... here I'd like to use an Alias instead of a file
346 # however the alias does not seem to live in the subdirectory
347 # which breaks 'scons -u test'
348 env.Alias(env.File('test'), test)
352 def InstallIncludeFiles(env, files):
353 target = env.Dir(env['INCLUDEINSTALLDIR'])
354 base = env.Dir(env['INSTALL_BASE'])
357 env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
359 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
360 if type(sources) is type(()):
361 sources, testSources = sources
362 if type(sources) is not type([]):
363 sources = [ sources ]
364 if type(testSources) is not type([]):
365 testSources = [ testSources ]
367 installs = [ env.Install(dir, targets) ]
370 target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
371 env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
374 source.append( env.File('.test.bin') )
375 installs.append(env.InstallIncludes(
378 INSTALL_BASE = env.Dir('.') ))
382 ## \brief Build documentation with doxygen
384 # The doxygen target helper will build software documentation using
385 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
386 # builder used supports automatic dependency generation (dependencies
387 # are automatically generated from the parameters specified in the \a
388 # doxyfile), automatic target emitters (the exact targets created are
389 # found parsing the \a doxyfile) and lots of other features. See the
390 # Doxygen builder documentation
392 # If \a extra_sources are given, the generated documentation will
393 # depend on them. This can be used to build images or other
394 # supplementary files.
396 # The doxygen target helper extends the builder with additional
399 # \li Fix tagfiles by removing namespace entries. These entries only
400 # work for namespaces completely defined in a single module. As
401 # soon as another module (which references the tagfile) has it's
402 # own members in that namespace, the crosslinking will break.
403 # \li If \c DOXY_HTML_XSL is defined as a construction environment
404 # variable, preprocess all generated html files (if html files are
405 # generated) by the given XSLT stylesheet. Since the HTML
406 # generated by doxygen is broken, we first filter the code through
407 # HTML-\c tidy and filter out some error messages.
408 # \li If xml output is generated we create files \c bug.xmli and \c
409 # todo.xmli which contain all bugs and todo items specified in the
410 # sources. The format of these files is much more suited to
411 # postprocessing and is a more database like format as the doxygen
412 # generated files (which are more presentation oriented). if \c
413 # DOXY_XREF_TYPES is given, it will specify the cross reference
414 # types to support (defaults to \c bug and \c todo). See <a
415 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
416 # in the doxygen documentation.
419 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
420 # ARGHHH !!! without the [:] we are changing the target list
421 # ||| WITHIN THE DOXYGEN BUILDER
422 docs = env.Doxygen(doxyfile)[:]
427 if isinstance(doc,SCons.Node.FS.Dir): continue
428 if doc.name == 'xml.stamp' : xmlnode = doc
429 if doc.name == 'html.stamp' : htmlnode = doc
430 if doc.name == 'search.idx' : continue
431 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
432 # otherwise it must be the tag file
436 # Postprocess the tag file to remove the (broken) namespace
440 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
441 % { 'target': tagnode.abspath,
442 'template': os.path.join(basedir,"tagmunge.xsl") }))
444 if htmlnode and env.get('DOXY_HTML_XSL'):
445 xslfile = env.File(env['DOXY_HTML_XSL'])
446 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
447 if reltopdir : reltopdir = reltopdir[:-1]
448 else : reltopdir = '.'
451 SCons.Action.Action(("for html in %s/*.html; do " +
453 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}" +
454 " | tidy -ascii -q --show-warnings no --fix-uri no " +
455 " | xsltproc --nonet --html --stringparam topdir %s -o $${html}.new %s - 2>&1" +
457 " | grep -v 'ID .* already defined';" +
458 " mv $${html}.new $${html}; " +
460 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
462 env.Depends(doc, xslfile)
466 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
467 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
468 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
469 [ "test -s $SOURCE && xsltproc -o $TARGET" +
470 " --stringparam module $MODULE" +
471 " --stringparam type $TYPE" +
472 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
473 MODULE = xmlnode.dir.dir.dir.abspath[
474 len(env.Dir('#').abspath)+1:],
476 env.SideEffect(xref, xmlnode)
477 env.AddPreAction(docs, "rm -f %s" % (xref,))
478 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
479 xrefs.extend(xref_pp)
482 if extra_sources and htmlnode:
484 [ env.CopyToDir( source=source, target=htmlnode.dir )
485 for source in extra_sources ])
487 if extra_sources and xmlnode:
489 [ env.CopyToDir( source=source, target=xmlnode.dir )
490 for source in extra_sources ])
492 if not htmlnode and not xmlnode:
493 env.Depends(docs, extra_sources)
496 env.Alias('all_docs', doc)
497 env.Clean('all_docs', doc)
498 env.Clean('all', doc)
500 l = len(env.Dir('#').abspath)
502 env.Alias('install_all',
503 env.Install( '$DOCINSTALLDIR' + htmlnode.dir.dir.abspath[l:],
506 env.Alias('install_all',
507 env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
512 ## \brief Build combined doxygen cross-reference
514 # This command will build a complete cross-reference of \c xrefitems
515 # accross all modules.
517 # Right now, this command is very project specific. It needs to be
521 def DoxyXRef(env, docs=None,
522 HTML_HEADER = None, HTML_FOOTER = None,
523 TITLE = "Cross-reference of action points"):
525 docs = env.Alias('all_docs')[0].sources
526 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
527 xref = env.Command("doc/html/xref.xml", xrefs,
528 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
529 "echo '<xref>' >> $TARGET",
530 "cat $SOURCES >> $TARGET",
531 "echo '</xref>' >>$TARGET" ])
533 # Lastly we create the html file
534 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
535 if HTML_HEADER : sources.append(HTML_HEADER)
536 if HTML_FOOTER : sources.append(HTML_FOOTER)
540 commands.append("sed" +
541 " -e 's/\\$$title/$TITLE/g'" +
542 " -e 's/\\$$projectname/Overview/g'" +
543 " ${SOURCES[2]} > $TARGET")
544 commands.append("xsltproc" +
545 " --stringparam title '$TITLE'" +
546 " --stringparam types '$DOXY_XREF_TYPES'" +
547 " ${SOURCES[1]} $SOURCE >> $TARGET")
550 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
551 % (HTML_HEADER and 3 or 2))
553 if env.get('DOXY_HTML_XSL'):
554 xslfile = env.File(env['DOXY_HTML_XSL'])
555 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
556 if reltopdir : reltopdir = reltopdir[:-1]
557 else : reltopdir = '.'
558 commands.append(("xsltproc -o ${TARGET}.tmp" +
560 " --stringparam topdir %s" +
561 " ${SOURCES[-1]} $TARGET 2>/dev/null")
563 commands.append("mv ${TARGET}.tmp ${TARGET}")
564 sources.append(xslfile)
566 xref = env.Command("doc/html/xref.html", sources, commands,
569 env.Alias('all_docs',xref)
573 ## \brief Build library
575 # This target helper will build the given library. The library will be
576 # called lib<i>library</i>.a as is customary on UNIX systems. \a
577 # sources, \a testSources and \a LIBS are directly forwarded to the
578 # Objects build helper.
580 # The library is added to the list of default targets.
583 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
584 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
587 lib = env.Library(env.File(LibPath(library)),objects)
589 env.Append(ALLLIBS = library)
590 env.Alias('default', lib)
591 install = InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
592 env.Alias('install_all', install)
595 ## \brief Build Object from multiple sources
596 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
597 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
600 ob = env.Command(target+".o", objects, "ld -r -o $TARGET $SOURCES")
602 env.Alias('default', ob)
603 install = InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
604 env.Alias('install_all', install)
607 ## \brief Build executable
609 # This target helper will build the given binary. The \a sources, \a
610 # testSources and \a LIBS arguments are forwarded to the Objects
611 # builder. The final program will be linked against all the library
612 # modules specified in \a LIBS (those are libraries which are built as
613 # part of the same proejct). To specify non-module libraries, use the
614 # construction environment parameters or the framework helpers.
617 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
618 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
622 progEnv.Prepend(LIBS = LIBS)
623 program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
625 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
626 env.Alias('default', program)
627 install = InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources,
629 env.Alias('install_all', install)
632 def AllIncludesHH(env, headers):
634 target = env.File("all_includes.hh")
635 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
637 env.Clean('all', target)