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
28 from SCons.Script import *
30 ## \defgroup use Predefined Framework Configurators
32 # The following framework configurators are used in the top level \c
33 # SConstruct file to simplify more complex configurations.
35 # Each of the framework configurators introduces additional
36 # configuration parameters to \ref sconfig
38 ## \defgroup target Target Helpers
40 # To specify standard targets, the following helpers can be used. They
41 # automatically integrate several modules (like documentation,
44 ## \defgroup builder Builders
46 # The SENFSCons framework includes a series of builders. Each builder
47 # is defined in it's own package.
49 # Tools to load in MakeEnvironment
62 # This is the directory SENFSCons.py resides
63 basedir = os.path.abspath(os.path.split(__file__)[0])
65 ## \brief Initialize configuration options
69 if opts is not None: return
70 opts = SCons.Options.Options('SConfig')
71 opts.Add('CXX', 'C++ compiler to use', 'g++')
72 opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '')
73 opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
74 opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
75 opts.Add('PREFIX', 'Installation prefix', '/usr/local')
76 opts.Add('LIBINSTALLDIR', 'Library install dir', '$PREFIX/lib')
77 opts.Add('BININSTALLDIR', 'Executable install dir', '$PREFIX/bin')
78 opts.Add('INCLUDEINSTALLDIR', 'Include-file install dir', '$PREFIX/include')
79 opts.Add('OBJINSTALLDIR', 'Static object file install dir', '$LIBINSTALLDIR')
80 opts.Add('DOCINSTALLDIR', 'Documentation install dir', '$PREFIX/doc')
81 opts.Add('CPP_INCLUDE_EXTENSIONS', 'File extensions to include in source install',
82 [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti', '.mpp' ])
83 opts.Add('CPP_EXCLUDE_EXTENSIONS', 'File extensions to exclude from source install',
86 # A finalizer is any callable object. All finalizers will be called
87 # in MakeEnvironment. We use them so every finalizer has knowledge of
88 # all frameworks in use (e.g.: the boost runtime depends on the use of
91 ## \brief Register finalizer
97 ## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
99 # Configure the use of the <a href="http://www.boost.org">Boost</a>
100 # libraries. Most of these libraries are header-only, some however
101 # depend on a built library. The library selection is somewhat
102 # involved and depends on the threading model and the type of build
105 # \par Configuration Parameters:
106 # <table class="senf">
107 # <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
108 # <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
109 # <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
110 # <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
111 # <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
112 # <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
115 # You can either specify \c BOOST_VARIANT explicitly or specify \c
116 # BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
117 # BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
118 # to \c gd, If \c BOOST_TOOLSET is specified and you have included
119 # STLPort support (UseSTLPort()), then \c p is appended to both
122 # The Boost configuration can get realtively complex. If the boost
123 # libraries are provided by the distribution, you probably don't need
124 # to specify any parameters. If your configuration is more complex,
126 # href="http://www.boost.org/tools/build/v2/index.html">Boost.Build</a>
127 # documentation for a definition of the terms used above (toolset,
128 # variant, runtime ...).
134 opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
135 opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
136 opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
137 opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
138 opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
139 opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
140 opts.Add('BOOST_PREFIX', 'The prefix into which boost is installed', '')
141 opts.Add('BOOST_VERSION', 'The version of boost to use', '')
142 Finalizer(FinalizeBoost)
144 ## \brief Finalize Boost environment
146 def FinalizeBoost(env):
147 env.Tool('BoostUnitTests', [basedir])
149 if env['BOOST_TOOLSET']:
151 if env['final'] : runtime += env.get('BOOST_RUNTIME','')
152 else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
153 if env['STLPORT_LIB'] : runtime += "p"
154 if runtime: runtime = "-" + runtime
155 env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
157 if env['BOOST_VARIANT'] and env['BOOST_VERSION']:
158 env['BOOST_VARIANT'] = env['BOOST_VARIANT'] + '-%s' % env['BOOST_VERSION'].replace('.','_')
160 env['BOOSTTESTLIB'] = 'boost_unit_test_framework' + env['BOOST_VARIANT']
161 env['BOOSTREGEXLIB'] = 'boost_regex' + env['BOOST_VARIANT']
162 env['BOOSTFSLIB'] = 'boost_filesystem' + env['BOOST_VARIANT']
163 env['BOOSTIOSTREAMSLIB'] = 'boost_iostreams' + env['BOOST_VARIANT']
165 if env['BOOST_PREFIX']:
166 env['BOOST_LIBDIR'] = os.path.join(env['BOOST_PREFIX'], 'lib')
167 env['BOOST_INCLUDES'] = os.path.join(env['BOOST_PREFIX'],
169 % env['BOOST_VERSION'].replace('.','_'))
171 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
172 CPPPATH = [ '$BOOST_INCLUDES' ])
174 if env['BOOST_LIBDIR']:
175 env.Append(ENV = { 'LD_LIBRARY_PATH': env['BOOST_LIBDIR'] })
177 ## \brief Use STLPort as STL replacement if available
179 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
180 # for the system STL. STLPort has the added feature of providing fully
181 # checked containers and iterators. This can greatly simplify
182 # debugging. However, STLPort and Boost interact in a non-trivial way
183 # so the configuration is relatively complex. This command does not
184 # enforce the use of STLPort, it is only used if available.
186 # \par Configuration Parameters:
187 # <table class="senf">
188 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
189 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
190 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
191 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
194 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
195 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
196 # only be used, if \c STLPORT_LIB is set in \c SConfig.
202 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
203 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
204 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
205 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
206 Finalizer(FinalizeSTLPort)
210 ## \brief Finalize STLPort environment
212 def FinalizeSTLPort(env):
213 if env['STLPORT_LIB']:
214 if not env['STLPORT_DEBUGLIB']:
215 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
216 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
217 CPPPATH = [ '$STLPORT_INCLUDES' ])
219 env.Append(LIBS = [ '$STLPORT_LIB' ])
221 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
222 CPPDEFINES = [ '_STLP_DEBUG' ])
224 ## \brief Build a configured construction environment
226 # This function is called after all frameworks are specified to build
227 # a tailored construction environment. You can then use this
228 # construction environment just like an ordinary SCons construction
229 # environment (which it is ...)
231 # This call will set some default compilation parameters depending on
232 # the \c final command line option: specifying <tt>final=1</tt> will
233 # built a release version of the code.
234 def MakeEnvironment():
235 global opts, finalizers
237 env = SCons.Environment.Environment(options=opts)
238 env.Replace(**SCons.Script.SConscript.Arguments)
239 #for opt in opts.options:
240 # if SCons.Script.SConscript.Arguments.get(opt.key):
241 # env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
242 #if SCons.Script.SConscript.Arguments.get('final'):
244 env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
245 env.Help(opts.GenerateHelpText(env))
247 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
248 # into other hosts from within SCons rules. I have used rules like
249 # this e.g. to automatically install stuff on a remote system ...
250 if os.environ.has_key('SSH_AUTH_SOCK'):
251 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
253 for finalizer in finalizers:
256 for tool in SCONS_TOOLS:
257 env.Tool(tool, [basedir])
259 # These are the default compilation parameters. We should probably
260 # make these configurable
261 env.Append(LOCALLIBDIR = [ '#' ],
262 LIBPATH = [ '$LOCALLIBDIR' ])
265 env.Append(CXXFLAGS = [ '-O3' ])
267 # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails:
268 # CPPDEFINES = [ '_GLIBCXX_DEBUG' ],
269 env.Append(CXXFLAGS = [ '-O0', '-g' ],
270 CPPDEFINES = { 'SENF_DEBUG': ''},
271 LINKFLAGS = [ '-g', '-rdynamic' ])
273 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
274 LIBS = [ '$EXTRA_LIBS' ],
279 ## \brief Find normal and test C++ sources
281 # GlobSources() will return a list of all C++ source files (named
282 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
283 # in the current directory. The sources will be returned as a tuple of
284 # sources, test-sources. The target helpers all accept such a tuple as
285 # their source argument.
286 def GlobSources(exclude=[], subdirs=[]):
287 testSources = glob.glob("*.test.cc")
288 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
289 for subdir in subdirs:
290 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
291 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
292 if x not in testSources and x not in exclude ]
293 return (sources, testSources)
295 ## \brief Add generic standard targets for every module
297 # This target helper should be called in the top-level \c SConstruct file
298 # as well as in every module \c SConscipt file. It adds general
299 # targets. Right now, these are
300 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
301 # <tt>scons -c all</tt>
304 def StandardTargets(env):
305 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
307 ## \brief Add generic global targets
309 # This target helper should be called in the top-level \c SConstruct
310 # file. It adds general global targets. Right now theese are
311 # \li Make <tt>scons all</tt> build all targets.
314 def GlobalTargets(env):
315 env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
317 ## \brief Return path of a built library within $LOCALLIBDIR
319 def LibPath(lib): return '${LOCALLIBDIR}/${LIBPREFIX}%s${LIBADDSUFFIX}${LIBSUFFIX}' % lib
321 def Test(env, sources, LIBS = [], OBJECTS = []):
322 test = [ env.BoostUnitTests(
325 test_sources = sources,
326 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
328 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ]) ]
329 compileTestSources = [ src for src in sources
330 if 'COMPILE_CHECK' in file(src).read() ]
331 if compileTestSources:
332 test.extend(env.CompileCheck(source = compileTestSources))
333 env.Alias('all_tests', test)
334 env.Command(env.File('test'), test, [])
335 #env.Alias(env.File('test'), test)
338 ## \brief Build object files
340 # This target helper will build object files from the given
343 # If \a testSources are given, a unit test will be built using the <a
344 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
345 # library. \a LIBS may specify any additional library modules <em>from
346 # the same project</em> on which the test depends. Those libraries
347 # will be linked into the final test executable. The test will
348 # automatically be run if the \c test or \c all_tests targets are
351 # If \a sources is a 2-tuple as returned by GlobSources(), it will
352 # provide both \a sources and \a testSources.
355 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
356 if type(sources) == type(()):
357 testSources = sources[1]
359 if type(sources) is not type([]):
360 sources = [ sources ]
365 for source in sources
366 if type(source) is type('') and not source.endswith('.o') ]
368 for source in sources
369 if type(source) is not type('') or source.endswith('.o') ]
371 objects += env.Object(obsources)
374 test = [ env.BoostUnitTests(
377 test_sources = testSources,
378 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
380 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ]) ]
381 compileTestSources = [ src for src in testSources
382 if 'COMPILE_CHECK' in file(src).read() ]
383 if compileTestSources:
384 test.extend(env.CompileCheck(source = compileTestSources))
385 env.Alias('all_tests', test)
386 # Hmm ... here I'd like to use an Alias instead of a file
387 # however the alias does not seem to live in the subdirectory
388 # which breaks 'scons -u test'
389 env.Command(env.File('test'), test, [])
390 #env.Alias(env.File('test'), test)
394 def InstallIncludeFiles(env, files):
395 # Hrmpf ... why do I need this in 0.97??
396 if env.GetOption('clean'):
398 target = env.Dir(env['INCLUDEINSTALLDIR'])
399 base = env.Dir(env['INSTALL_BASE'])
402 env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
404 def InstallSourceIncludes(env, sources):
405 target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
406 env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
407 install = env.InstallIncludes( target = target,
408 source = [ type(x) is str and env.File(x) or x
410 INSTALL_BASE = env.Dir('.') )
411 env.Alias( 'install_all', install )
413 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
414 if type(sources) is type(()):
415 sources, testSources = sources
416 if type(sources) is not type([]):
417 sources = [ sources ]
418 if type(testSources) is not type([]):
419 testSources = [ testSources ]
421 installs = [ env.Install(dir, targets) ]
422 env.Alias( 'install_all', installs[:] )
427 sources.append( env.File('.test.bin') )
429 InstallSourceIncludes(env, sources))
433 ## \brief Build documentation with doxygen
435 # The doxygen target helper will build software documentation using
436 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
437 # builder used supports automatic dependency generation (dependencies
438 # are automatically generated from the parameters specified in the \a
439 # doxyfile), automatic target emitters (the exact targets created are
440 # found parsing the \a doxyfile) and lots of other features. See the
441 # Doxygen builder documentation
443 # If \a extra_sources are given, the generated documentation will
444 # depend on them. This can be used to build images or other
445 # supplementary files.
447 # The doxygen target helper extends the builder with additional
450 # \li Fix tagfiles by removing namespace entries. These entries only
451 # work for namespaces completely defined in a single module. As
452 # soon as another module (which references the tagfile) has it's
453 # own members in that namespace, the crosslinking will break.
454 # \li If \c DOXY_HTML_XSL is defined as a construction environment
455 # variable, preprocess all generated html files (if html files are
456 # generated) by the given XSLT stylesheet. Since the HTML
457 # generated by doxygen is broken, we first filter the code through
458 # HTML-\c tidy and filter out some error messages.
459 # \li If xml output is generated we create files \c bug.xmli and \c
460 # todo.xmli which contain all bugs and todo items specified in the
461 # sources. The format of these files is much more suited to
462 # postprocessing and is a more database like format as the doxygen
463 # generated files (which are more presentation oriented). if \c
464 # DOXY_XREF_TYPES is given, it will specify the cross reference
465 # types to support (defaults to \c bug and \c todo). See <a
466 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
467 # in the doxygen documentation.
470 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
471 if not 'all' in BUILD_TARGETS and not 'doc' in BUILD_TARGETS and not 'all_docs' in BUILD_TARGETS:
473 # ARGHHH !!! without the [:] we are changing the target list
474 # ||| WITHIN THE DOXYGEN BUILDER
475 docs = env.Doxygen(doxyfile)[:]
480 if isinstance(doc,SCons.Node.FS.Dir): continue
481 if doc.name == 'xml.stamp' : xmlnode = doc
482 if doc.name == 'html.stamp' : htmlnode = doc
483 if doc.name == 'search.idx' : continue
484 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
485 # otherwise it must be the tag file
489 # Postprocess the tag file to remove the (broken) namespace
493 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
494 % { 'target': tagnode.abspath,
495 'template': os.path.join(basedir,"tagmunge.xsl") }))
497 if htmlnode and env.get('DOXY_HTML_XSL'):
498 xslfile = env.File(env['DOXY_HTML_XSL'])
499 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
500 if reltopdir : reltopdir = reltopdir[:-1]
501 else : reltopdir = '.'
504 SCons.Action.Action(("for html in %s/*.html; do " +
506 " mv $${html} $${html}.orig;" +
507 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}.orig" +
508 " | tidy -ascii -q --wrap 0 --show-warnings no --fix-uri no " +
509 " | sed -e 's/name=\"\([^\"]*\)\"\([^>]*\) id=\"\\1\"/name=\"\\1\"\\2/g'" +
510 " | xsltproc --novalid --nonet --html --stringparam topdir %s -o $${html} %s -;"
512 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
514 env.Depends(doc, xslfile)
518 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
519 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
520 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
521 [ "test -s $SOURCE && xsltproc --nonet -o $TARGET" +
522 " --stringparam module $MODULE" +
523 " --stringparam type $TYPE" +
524 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
525 MODULE = xmlnode.dir.dir.dir.abspath[
526 len(env.Dir('#').abspath)+1:],
528 env.SideEffect(xref, xmlnode)
529 env.AddPreAction(docs, "rm -f %s" % (xref,))
530 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
531 xrefs.extend(xref_pp)
534 if extra_sources and htmlnode:
536 [ env.CopyToDir( source=source, target=htmlnode.dir )
537 for source in extra_sources ])
539 if extra_sources and xmlnode:
541 [ env.CopyToDir( source=source, target=xmlnode.dir )
542 for source in extra_sources ])
544 if not htmlnode and not xmlnode:
545 env.Depends(docs, extra_sources)
548 env.Alias('all_docs', doc)
549 env.Clean('all_docs', doc)
550 env.Clean('all', doc)
552 l = len(env.Dir('#').abspath)
554 env.Alias('install_all',
555 env.Command('$DOCINSTALLDIR' + htmlnode.dir.abspath[l:], htmlnode.dir,
556 [ SCons.Defaults.Copy('$TARGET','$SOURCE') ]))
558 env.Alias('install_all',
559 env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
564 ## \brief Build combined doxygen cross-reference
566 # This command will build a complete cross-reference of \c xrefitems
567 # accross all modules.
569 # Right now, this command is very project specific. It needs to be
573 def DoxyXRef(env, docs=None,
574 HTML_HEADER = None, HTML_FOOTER = None,
575 TITLE = "Cross-reference of action points"):
577 docs = env.Alias('all_docs')[0].sources
578 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
579 xref = env.Command("doc/html/xref.xml", xrefs,
580 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
581 "echo '<xref>' >> $TARGET",
582 "cat $SOURCES >> $TARGET",
583 "echo '</xref>' >>$TARGET" ])
585 # Lastly we create the html file
586 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
587 if HTML_HEADER : sources.append(HTML_HEADER)
588 if HTML_FOOTER : sources.append(HTML_FOOTER)
592 commands.append("sed" +
593 " -e 's/\\$$title/$TITLE/g'" +
594 " -e 's/\\$$projectname/Overview/g'" +
595 " ${SOURCES[2]} > $TARGET")
596 commands.append("xsltproc" +
597 " --stringparam title '$TITLE'" +
598 " --stringparam types '$DOXY_XREF_TYPES'" +
599 " ${SOURCES[1]} $SOURCE >> $TARGET")
602 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
603 % (HTML_HEADER and 3 or 2))
605 if env.get('DOXY_HTML_XSL'):
606 xslfile = env.File(env['DOXY_HTML_XSL'])
607 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
608 if reltopdir : reltopdir = reltopdir[:-1]
609 else : reltopdir = '.'
610 commands.append(("xsltproc -o ${TARGET}.tmp" +
612 " --stringparam topdir %s" +
613 " ${SOURCES[-1]} $TARGET 2>/dev/null")
615 commands.append("mv ${TARGET}.tmp ${TARGET}")
616 sources.append(xslfile)
618 xref = env.Command("doc/html/xref.html", sources, commands,
621 env.Alias('all_docs',xref)
625 ## \brief Build library
627 # This target helper will build the given library. The library will be
628 # called lib<i>library</i>.a as is customary on UNIX systems. \a
629 # sources, \a testSources and \a LIBS are directly forwarded to the
630 # Objects build helper.
632 # The library is added to the list of default targets.
635 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
636 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
639 lib = env.Library(env.File(LibPath(library)),objects)
641 env.Append(ALLLIBS = library)
642 env.Alias('default', lib)
643 InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
646 ## \brief Build Object from multiple sources
647 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
648 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
651 ob = env.Command(target+"${OBJADDSUFFIX}${OBJSUFFIX}", objects, "ld -r -o $TARGET $SOURCES")
653 env.Alias('default', ob)
654 InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
657 ## \brief Build executable
659 # This target helper will build the given binary. The \a sources, \a
660 # testSources and \a LIBS arguments are forwarded to the Objects
661 # builder. The final program will be linked against all the library
662 # modules specified in \a LIBS (those are libraries which are built as
663 # part of the same proejct). To specify non-module libraries, use the
664 # construction environment parameters or the framework helpers.
667 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
668 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
671 progEnv = env.Clone()
672 progEnv.Prepend(LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ])
673 program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
675 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
676 env.Alias('default', program)
677 InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources, no_includes)
680 def AllIncludesHH(env, headers):
682 target = env.File("all_includes.hh")
683 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
685 env.Clean('all', target)