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 Finalizer(FinalizeBoost)
142 ## \brief Finalize Boost environment
144 def FinalizeBoost(env):
145 env.Tool('BoostUnitTests', [basedir])
147 if env['BOOST_TOOLSET']:
149 if env['final'] : runtime += env.get('BOOST_RUNTIME','')
150 else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
151 if env['STLPORT_LIB'] : runtime += "p"
152 if runtime: runtime = "-" + runtime
153 env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
155 env['BOOSTTESTLIB'] = 'boost_unit_test_framework' + env['BOOST_VARIANT']
156 env['BOOSTREGEXLIB'] = 'boost_regex' + env['BOOST_VARIANT']
157 env['BOOSTFSLIB'] = 'boost_filesystem' + env['BOOST_VARIANT']
158 env['BOOSTIOSTREAMSLIB'] = 'boost_iostreams' + env['BOOST_VARIANT']
160 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
161 CPPPATH = [ '$BOOST_INCLUDES' ])
163 ## \brief Use STLPort as STL replacement if available
165 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
166 # for the system STL. STLPort has the added feature of providing fully
167 # checked containers and iterators. This can greatly simplify
168 # debugging. However, STLPort and Boost interact in a non-trivial way
169 # so the configuration is relatively complex. This command does not
170 # enforce the use of STLPort, it is only used if available.
172 # \par Configuration Parameters:
173 # <table class="senf">
174 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
175 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
176 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
177 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
180 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
181 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
182 # only be used, if \c STLPORT_LIB is set in \c SConfig.
188 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
189 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
190 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
191 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
192 Finalizer(FinalizeSTLPort)
196 ## \brief Finalize STLPort environment
198 def FinalizeSTLPort(env):
199 if env['STLPORT_LIB']:
200 if not env['STLPORT_DEBUGLIB']:
201 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
202 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
203 CPPPATH = [ '$STLPORT_INCLUDES' ])
205 env.Append(LIBS = [ '$STLPORT_LIB' ])
207 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
208 CPPDEFINES = [ '_STLP_DEBUG' ])
210 ## \brief Build a configured construction environment
212 # This function is called after all frameworks are specified to build
213 # a tailored construction environment. You can then use this
214 # construction environment just like an ordinary SCons construction
215 # environment (which it is ...)
217 # This call will set some default compilation parameters depending on
218 # the \c final command line option: specifying <tt>final=1</tt> will
219 # built a release version of the code.
220 def MakeEnvironment():
221 global opts, finalizers
223 env = SCons.Environment.Environment(options=opts)
224 env.Replace(**SCons.Script.SConscript.Arguments)
225 #for opt in opts.options:
226 # if SCons.Script.SConscript.Arguments.get(opt.key):
227 # env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
228 #if SCons.Script.SConscript.Arguments.get('final'):
230 env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
231 env.Help(opts.GenerateHelpText(env))
233 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
234 # into other hosts from within SCons rules. I have used rules like
235 # this e.g. to automatically install stuff on a remote system ...
236 if os.environ.has_key('SSH_AUTH_SOCK'):
237 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
239 for finalizer in finalizers:
242 for tool in SCONS_TOOLS:
243 env.Tool(tool, [basedir])
245 # These are the default compilation parameters. We should probably
246 # make these configurable
247 env.Append(LOCALLIBDIR = [ '#' ],
248 LIBPATH = [ '$LOCALLIBDIR' ])
251 env.Append(CXXFLAGS = [ '-O3' ])
253 # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails:
254 # CPPDEFINES = [ '_GLIBCXX_DEBUG' ],
255 env.Append(CXXFLAGS = [ '-O0', '-g' ],
256 CPPDEFINES = [ 'SENF_DEBUG' ],
257 LINKFLAGS = [ '-g', '-rdynamic' ])
259 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
260 LIBS = [ '$EXTRA_LIBS' ],
265 ## \brief Find normal and test C++ sources
267 # GlobSources() will return a list of all C++ source files (named
268 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
269 # in the current directory. The sources will be returned as a tuple of
270 # sources, test-sources. The target helpers all accept such a tuple as
271 # their source argument.
272 def GlobSources(exclude=[], subdirs=[]):
273 testSources = glob.glob("*.test.cc")
274 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
275 for subdir in subdirs:
276 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
277 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
278 if x not in testSources and x not in exclude ]
279 return (sources, testSources)
281 ## \brief Add generic standard targets for every module
283 # This target helper should be called in the top-level \c SConstruct file
284 # as well as in every module \c SConscipt file. It adds general
285 # targets. Right now, these are
286 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
287 # <tt>scons -c all</tt>
290 def StandardTargets(env):
291 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
293 ## \brief Add generic global targets
295 # This target helper should be called in the top-level \c SConstruct
296 # file. It adds general global targets. Right now theese are
297 # \li Make <tt>scons all</tt> build all targets.
300 def GlobalTargets(env):
301 env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
303 ## \brief Return path of a built library within $LOCALLIBDIR
305 def LibPath(lib): return '${LOCALLIBDIR}/${LIBPREFIX}%s${LIBADDSUFFIX}${LIBSUFFIX}' % lib
307 def Test(env, sources, LIBS = [], OBJECTS = []):
308 test = [ env.BoostUnitTests(
311 test_sources = sources,
312 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
314 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ]) ]
315 compileTestSources = [ src for src in sources
316 if 'COMPILE_CHECK' in file(src).read() ]
317 if compileTestSources:
318 test.extend(env.CompileCheck(source = compileTestSources))
319 env.Alias('all_tests', test)
320 env.Alias(env.File('test'), test)
323 ## \brief Build object files
325 # This target helper will build object files from the given
328 # If \a testSources are given, a unit test will be built using the <a
329 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
330 # library. \a LIBS may specify any additional library modules <em>from
331 # the same project</em> on which the test depends. Those libraries
332 # will be linked into the final test executable. The test will
333 # automatically be run if the \c test or \c all_tests targets are
336 # If \a sources is a 2-tuple as returned by GlobSources(), it will
337 # provide both \a sources and \a testSources.
340 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
341 if type(sources) == type(()):
342 testSources = sources[1]
344 if type(sources) is not type([]):
345 sources = [ sources ]
350 for source in sources
351 if not str(source).endswith('.o') ]
353 for source in sources
354 if str(source).endswith('.o') ]
356 objects += env.Object(obsources)
359 test = [ env.BoostUnitTests(
362 test_sources = testSources,
363 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
365 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ]) ]
366 compileTestSources = [ src for src in testSources
367 if 'COMPILE_CHECK' in file(src).read() ]
368 if compileTestSources:
369 test.extend(env.CompileCheck(source = compileTestSources))
370 env.Alias('all_tests', test)
371 # Hmm ... here I'd like to use an Alias instead of a file
372 # however the alias does not seem to live in the subdirectory
373 # which breaks 'scons -u test'
374 env.Alias(env.File('test'), test)
378 def InstallIncludeFiles(env, files):
379 # Hrmpf ... why do I need this in 0.97??
380 if env.GetOption('clean'):
382 target = env.Dir(env['INCLUDEINSTALLDIR'])
383 base = env.Dir(env['INSTALL_BASE'])
386 env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
388 def InstallSourceIncludes(env, sources):
389 target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
390 env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
391 install = env.InstallIncludes( target = target,
392 source = [ type(x) is str and env.File(x) or x
394 INSTALL_BASE = env.Dir('.') )
395 env.Alias( 'install_all', install )
397 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
398 if type(sources) is type(()):
399 sources, testSources = sources
400 if type(sources) is not type([]):
401 sources = [ sources ]
402 if type(testSources) is not type([]):
403 testSources = [ testSources ]
405 installs = [ env.Install(dir, targets) ]
406 env.Alias( 'install_all', installs[:] )
411 sources.append( env.File('.test.bin') )
413 InstallSourceIncludes(env, sources))
417 ## \brief Build documentation with doxygen
419 # The doxygen target helper will build software documentation using
420 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
421 # builder used supports automatic dependency generation (dependencies
422 # are automatically generated from the parameters specified in the \a
423 # doxyfile), automatic target emitters (the exact targets created are
424 # found parsing the \a doxyfile) and lots of other features. See the
425 # Doxygen builder documentation
427 # If \a extra_sources are given, the generated documentation will
428 # depend on them. This can be used to build images or other
429 # supplementary files.
431 # The doxygen target helper extends the builder with additional
434 # \li Fix tagfiles by removing namespace entries. These entries only
435 # work for namespaces completely defined in a single module. As
436 # soon as another module (which references the tagfile) has it's
437 # own members in that namespace, the crosslinking will break.
438 # \li If \c DOXY_HTML_XSL is defined as a construction environment
439 # variable, preprocess all generated html files (if html files are
440 # generated) by the given XSLT stylesheet. Since the HTML
441 # generated by doxygen is broken, we first filter the code through
442 # HTML-\c tidy and filter out some error messages.
443 # \li If xml output is generated we create files \c bug.xmli and \c
444 # todo.xmli which contain all bugs and todo items specified in the
445 # sources. The format of these files is much more suited to
446 # postprocessing and is a more database like format as the doxygen
447 # generated files (which are more presentation oriented). if \c
448 # DOXY_XREF_TYPES is given, it will specify the cross reference
449 # types to support (defaults to \c bug and \c todo). See <a
450 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
451 # in the doxygen documentation.
454 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
455 if not 'all' in BUILD_TARGETS and not 'doc' in BUILD_TARGETS and not 'all_docs' in BUILD_TARGETS:
457 # ARGHHH !!! without the [:] we are changing the target list
458 # ||| WITHIN THE DOXYGEN BUILDER
459 docs = env.Doxygen(doxyfile)[:]
464 if isinstance(doc,SCons.Node.FS.Dir): continue
465 if doc.name == 'xml.stamp' : xmlnode = doc
466 if doc.name == 'html.stamp' : htmlnode = doc
467 if doc.name == 'search.idx' : continue
468 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
469 # otherwise it must be the tag file
473 # Postprocess the tag file to remove the (broken) namespace
477 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
478 % { 'target': tagnode.abspath,
479 'template': os.path.join(basedir,"tagmunge.xsl") }))
481 if htmlnode and env.get('DOXY_HTML_XSL'):
482 xslfile = env.File(env['DOXY_HTML_XSL'])
483 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
484 if reltopdir : reltopdir = reltopdir[:-1]
485 else : reltopdir = '.'
488 SCons.Action.Action(("for html in %s/*.html; do " +
490 " mv $${html} $${html}.orig;" +
491 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}.orig" +
492 " | tidy -ascii -q --wrap 0 --show-warnings no --fix-uri no " +
493 " | sed -e 's/name=\"\([^\"]*\)\"\([^>]*\) id=\"\\1\"/name=\"\\1\"\\2/g'" +
494 " | xsltproc --novalid --nonet --html --stringparam topdir %s -o $${html} %s -;"
496 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
498 env.Depends(doc, xslfile)
502 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
503 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
504 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
505 [ "test -s $SOURCE && xsltproc --nonet -o $TARGET" +
506 " --stringparam module $MODULE" +
507 " --stringparam type $TYPE" +
508 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
509 MODULE = xmlnode.dir.dir.dir.abspath[
510 len(env.Dir('#').abspath)+1:],
512 env.SideEffect(xref, xmlnode)
513 env.AddPreAction(docs, "rm -f %s" % (xref,))
514 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
515 xrefs.extend(xref_pp)
518 if extra_sources and htmlnode:
520 [ env.CopyToDir( source=source, target=htmlnode.dir )
521 for source in extra_sources ])
523 if extra_sources and xmlnode:
525 [ env.CopyToDir( source=source, target=xmlnode.dir )
526 for source in extra_sources ])
528 if not htmlnode and not xmlnode:
529 env.Depends(docs, extra_sources)
532 env.Alias('all_docs', doc)
533 env.Clean('all_docs', doc)
534 env.Clean('all', doc)
536 l = len(env.Dir('#').abspath)
538 env.Alias('install_all',
539 env.Command('$DOCINSTALLDIR' + htmlnode.dir.abspath[l:], htmlnode.dir,
540 [ SCons.Defaults.Copy('$TARGET','$SOURCE') ]))
542 env.Alias('install_all',
543 env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
548 ## \brief Build combined doxygen cross-reference
550 # This command will build a complete cross-reference of \c xrefitems
551 # accross all modules.
553 # Right now, this command is very project specific. It needs to be
557 def DoxyXRef(env, docs=None,
558 HTML_HEADER = None, HTML_FOOTER = None,
559 TITLE = "Cross-reference of action points"):
561 docs = env.Alias('all_docs')[0].sources
562 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
563 xref = env.Command("doc/html/xref.xml", xrefs,
564 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
565 "echo '<xref>' >> $TARGET",
566 "cat $SOURCES >> $TARGET",
567 "echo '</xref>' >>$TARGET" ])
569 # Lastly we create the html file
570 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
571 if HTML_HEADER : sources.append(HTML_HEADER)
572 if HTML_FOOTER : sources.append(HTML_FOOTER)
576 commands.append("sed" +
577 " -e 's/\\$$title/$TITLE/g'" +
578 " -e 's/\\$$projectname/Overview/g'" +
579 " ${SOURCES[2]} > $TARGET")
580 commands.append("xsltproc" +
581 " --stringparam title '$TITLE'" +
582 " --stringparam types '$DOXY_XREF_TYPES'" +
583 " ${SOURCES[1]} $SOURCE >> $TARGET")
586 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
587 % (HTML_HEADER and 3 or 2))
589 if env.get('DOXY_HTML_XSL'):
590 xslfile = env.File(env['DOXY_HTML_XSL'])
591 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
592 if reltopdir : reltopdir = reltopdir[:-1]
593 else : reltopdir = '.'
594 commands.append(("xsltproc -o ${TARGET}.tmp" +
596 " --stringparam topdir %s" +
597 " ${SOURCES[-1]} $TARGET 2>/dev/null")
599 commands.append("mv ${TARGET}.tmp ${TARGET}")
600 sources.append(xslfile)
602 xref = env.Command("doc/html/xref.html", sources, commands,
605 env.Alias('all_docs',xref)
609 ## \brief Build library
611 # This target helper will build the given library. The library will be
612 # called lib<i>library</i>.a as is customary on UNIX systems. \a
613 # sources, \a testSources and \a LIBS are directly forwarded to the
614 # Objects build helper.
616 # The library is added to the list of default targets.
619 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
620 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
623 lib = env.Library(env.File(LibPath(library)),objects)
625 env.Append(ALLLIBS = library)
626 env.Alias('default', lib)
627 InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
630 ## \brief Build Object from multiple sources
631 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
632 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
635 ob = env.Command(target+"${OBJADDSUFFIX}${OBJSUFFIX}", objects, "ld -r -o $TARGET $SOURCES")
637 env.Alias('default', ob)
638 InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
641 ## \brief Build executable
643 # This target helper will build the given binary. The \a sources, \a
644 # testSources and \a LIBS arguments are forwarded to the Objects
645 # builder. The final program will be linked against all the library
646 # modules specified in \a LIBS (those are libraries which are built as
647 # part of the same proejct). To specify non-module libraries, use the
648 # construction environment parameters or the framework helpers.
651 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
652 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
656 progEnv.Prepend(LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ])
657 program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
659 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
660 env.Alias('default', program)
661 InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources, no_includes)
664 def AllIncludesHH(env, headers):
666 target = env.File("all_includes.hh")
667 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
669 env.Clean('all', target)