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' ])
81 opts.Add('CPP_EXCLUDE_EXTENSIONS', 'File extensions to exclude from source install',
84 # A finalizer is any callable object. All finalizers will be called
85 # in MakeEnvironment. We use them so every finalizer has knowledge of
86 # all frameworks in use (e.g.: the boost runtime depends on the use of
89 ## \brief Register finalizer
95 ## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
97 # Configure the use of the <a href="http://www.boost.org">Boost</a>
98 # libraries. Most of these libraries are header-only, some however
99 # depend on a built library. The library selection is somewhat
100 # involved and depends on the threading model and the type of build
103 # \par Configuration Parameters:
104 # <table class="senf">
105 # <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
106 # <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
107 # <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
108 # <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
109 # <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
110 # <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
113 # You can either specify \c BOOST_VARIANT explicitly or specify \c
114 # BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
115 # BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
116 # to \c gd, If \c BOOST_TOOLSET is specified and you have included
117 # STLPort support (UseSTLPort()), then \c p is appended to both
120 # The Boost configuration can get realtively complex. If the boost
121 # libraries are provided by the distribution, you probably don't need
122 # to specify any parameters. If your configuration is more complex,
124 # href="http://www.boost.org/tools/build/v2/index.html">Boost.Build</a>
125 # documentation for a definition of the terms used above (toolset,
126 # variant, runtime ...).
132 opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
133 opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
134 opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
135 opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
136 opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
137 opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
138 Finalizer(FinalizeBoost)
140 ## \brief Finalize Boost environment
142 def FinalizeBoost(env):
143 env.Tool('BoostUnitTests', [basedir])
145 if env['BOOST_TOOLSET']:
147 if env['final'] : runtime += env.get('BOOST_RUNTIME','')
148 else : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
149 if env['STLPORT_LIB'] : runtime += "p"
150 if runtime: runtime = "-" + runtime
151 env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
153 env['BOOSTTESTLIB'] = 'boost_unit_test_framework' + env['BOOST_VARIANT']
154 env['BOOSTREGEXLIB'] = 'boost_regex' + env['BOOST_VARIANT']
155 env['BOOSTFSLIB'] = 'boost_filesystem' + env['BOOST_VARIANT']
157 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
158 CPPPATH = [ '$BOOST_INCLUDES' ])
160 ## \brief Use STLPort as STL replacement if available
162 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
163 # for the system STL. STLPort has the added feature of providing fully
164 # checked containers and iterators. This can greatly simplify
165 # debugging. However, STLPort and Boost interact in a non-trivial way
166 # so the configuration is relatively complex. This command does not
167 # enforce the use of STLPort, it is only used if available.
169 # \par Configuration Parameters:
170 # <table class="senf">
171 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
172 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
173 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
174 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
177 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
178 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
179 # only be used, if \c STLPORT_LIB is set in \c SConfig.
185 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
186 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
187 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
188 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
189 Finalizer(FinalizeSTLPort)
193 ## \brief Finalize STLPort environment
195 def FinalizeSTLPort(env):
196 if env['STLPORT_LIB']:
197 if not env['STLPORT_DEBUGLIB']:
198 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
199 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
200 CPPPATH = [ '$STLPORT_INCLUDES' ])
202 env.Append(LIBS = [ '$STLPORT_LIB' ])
204 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
205 CPPDEFINES = [ '_STLP_DEBUG' ])
207 ## \brief Build a configured construction environment
209 # This function is called after all frameworks are specified to build
210 # a tailored construction environment. You can then use this
211 # construction environment just like an ordinary SCons construction
212 # environment (which it is ...)
214 # This call will set some default compilation parameters depending on
215 # the \c final command line option: specifying <tt>final=1</tt> will
216 # built a release version of the code.
217 def MakeEnvironment():
218 global opts, finalizers
220 env = SCons.Environment.Environment(options=opts)
221 env.Replace(**SCons.Script.SConscript.Arguments)
222 #for opt in opts.options:
223 # if SCons.Script.SConscript.Arguments.get(opt.key):
224 # env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
225 #if SCons.Script.SConscript.Arguments.get('final'):
227 env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
228 env.Help(opts.GenerateHelpText(env))
230 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
231 # into other hosts from within SCons rules. I have used rules like
232 # this e.g. to automatically install stuff on a remote system ...
233 if os.environ.has_key('SSH_AUTH_SOCK'):
234 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
236 for finalizer in finalizers:
239 for tool in SCONS_TOOLS:
240 env.Tool(tool, [basedir])
242 # These are the default compilation parameters. We should probably
243 # make these configurable
244 env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
245 LOCALLIBDIR = [ '#' ],
246 LIBPATH = [ '$LOCALLIBDIR' ])
249 env.Append(CXXFLAGS = [ '-O3' ],
250 CPPDEFINES = [ 'SENF_NO_DEBUG' ])
252 env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
253 # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails.
254 # CPPDEFINES = [ '_GLIBCXX_DEBUG' ],
255 LINKFLAGS = [ '-g' ])
257 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
258 LIBS = [ '$EXTRA_LIBS' ],
263 ## \brief Find normal and test C++ sources
265 # GlobSources() will return a list of all C++ source files (named
266 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
267 # in the current directory. The sources will be returned as a tuple of
268 # sources, test-sources. The target helpers all accept such a tuple as
269 # their source argument.
270 def GlobSources(exclude=[], subdirs=[]):
271 testSources = glob.glob("*.test.cc")
272 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
273 for subdir in subdirs:
274 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
275 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
276 if x not in testSources and x not in exclude ]
277 return (sources, testSources)
279 ## \brief Add generic standard targets for every module
281 # This target helper should be called in the top-level \c SConstruct file
282 # as well as in every module \c SConscipt file. It adds general
283 # targets. Right now, these are
284 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
285 # <tt>scons -c all</tt>
288 def StandardTargets(env):
289 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
291 ## \brief Add generic global targets
293 # This target helper should be called in the top-level \c SConstruct
294 # file. It adds general global targets. Right now theese are
295 # \li Make <tt>scons all</tt> build all targets.
298 def GlobalTargets(env):
299 env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
301 ## \brief Return path of a built library within $LOCALLIBDIR
303 def LibPath(lib): return '${LOCALLIBDIR}/${LIBPREFIX}%s${LIBADDSUFFIX}${LIBSUFFIX}' % lib
305 def Test(env, sources, LIBS = [], OBJECTS = []):
306 test = env.BoostUnitTests(
309 test_sources = sources,
310 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
312 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
313 env.Alias('all_tests', test)
314 env.Alias(env.File('test'), test)
317 ## \brief Build object files
319 # This target helper will build object files from the given
322 # If \a testSources are given, a unit test will be built using the <a
323 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
324 # library. \a LIBS may specify any additional library modules <em>from
325 # the same project</em> on which the test depends. Those libraries
326 # will be linked into the final test executable. The test will
327 # automatically be run if the \c test or \c all_tests targets are
330 # If \a sources is a 2-tuple as returned by GlobSources(), it will
331 # provide both \a sources and \a testSources.
334 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
335 if type(sources) == type(()):
336 testSources = sources[1]
338 if type(sources) is not type([]):
339 sources = [ sources ]
344 for source in sources
345 if not str(source).endswith('.o') ]
347 for source in sources
348 if str(source).endswith('.o') ]
350 objects += env.Object(obsources)
353 test = env.BoostUnitTests(
356 test_sources = testSources,
357 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
359 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
360 env.Alias('all_tests', test)
361 # Hmm ... here I'd like to use an Alias instead of a file
362 # however the alias does not seem to live in the subdirectory
363 # which breaks 'scons -u test'
364 env.Alias(env.File('test'), test)
368 def InstallIncludeFiles(env, files):
369 # Hrmpf ... why do I need this in 0.97??
370 if env.GetOption('clean'):
372 target = env.Dir(env['INCLUDEINSTALLDIR'])
373 base = env.Dir(env['INSTALL_BASE'])
376 env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
378 def InstallSourceIncludes(env, sources):
379 target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
380 env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
381 install = env.InstallIncludes( target = target,
382 source = [ type(x) is str and env.File(x) or x
384 INSTALL_BASE = env.Dir('.') )
385 env.Alias( 'install_all', install )
387 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
388 if type(sources) is type(()):
389 sources, testSources = sources
390 if type(sources) is not type([]):
391 sources = [ sources ]
392 if type(testSources) is not type([]):
393 testSources = [ testSources ]
395 installs = [ env.Install(dir, targets) ]
396 env.Alias( 'install_all', installs[:] )
401 sources.append( env.File('.test.bin') )
403 InstallSourceIncludes(env, sources))
407 ## \brief Build documentation with doxygen
409 # The doxygen target helper will build software documentation using
410 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
411 # builder used supports automatic dependency generation (dependencies
412 # are automatically generated from the parameters specified in the \a
413 # doxyfile), automatic target emitters (the exact targets created are
414 # found parsing the \a doxyfile) and lots of other features. See the
415 # Doxygen builder documentation
417 # If \a extra_sources are given, the generated documentation will
418 # depend on them. This can be used to build images or other
419 # supplementary files.
421 # The doxygen target helper extends the builder with additional
424 # \li Fix tagfiles by removing namespace entries. These entries only
425 # work for namespaces completely defined in a single module. As
426 # soon as another module (which references the tagfile) has it's
427 # own members in that namespace, the crosslinking will break.
428 # \li If \c DOXY_HTML_XSL is defined as a construction environment
429 # variable, preprocess all generated html files (if html files are
430 # generated) by the given XSLT stylesheet. Since the HTML
431 # generated by doxygen is broken, we first filter the code through
432 # HTML-\c tidy and filter out some error messages.
433 # \li If xml output is generated we create files \c bug.xmli and \c
434 # todo.xmli which contain all bugs and todo items specified in the
435 # sources. The format of these files is much more suited to
436 # postprocessing and is a more database like format as the doxygen
437 # generated files (which are more presentation oriented). if \c
438 # DOXY_XREF_TYPES is given, it will specify the cross reference
439 # types to support (defaults to \c bug and \c todo). See <a
440 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
441 # in the doxygen documentation.
444 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
445 # ARGHHH !!! without the [:] we are changing the target list
446 # ||| WITHIN THE DOXYGEN BUILDER
447 docs = env.Doxygen(doxyfile)[:]
452 if isinstance(doc,SCons.Node.FS.Dir): continue
453 if doc.name == 'xml.stamp' : xmlnode = doc
454 if doc.name == 'html.stamp' : htmlnode = doc
455 if doc.name == 'search.idx' : continue
456 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
457 # otherwise it must be the tag file
461 # Postprocess the tag file to remove the (broken) namespace
465 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
466 % { 'target': tagnode.abspath,
467 'template': os.path.join(basedir,"tagmunge.xsl") }))
469 if htmlnode and env.get('DOXY_HTML_XSL'):
470 xslfile = env.File(env['DOXY_HTML_XSL'])
471 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
472 if reltopdir : reltopdir = reltopdir[:-1]
473 else : reltopdir = '.'
476 SCons.Action.Action(("for html in %s/*.html; do " +
478 " mv $${html} $${html}.orig;" +
479 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}.orig" +
480 " | tidy -ascii -q --wrap 0 --show-warnings no --fix-uri no " +
481 " | sed -e 's/name=\"\([^\"]*\)\"\([^>]*\) id=\"\\1\"/name=\"\\1\"\\2/g'" +
482 " | xsltproc --novalid --nonet --html --stringparam topdir %s -o $${html} %s -;"
484 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
486 env.Depends(doc, xslfile)
490 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
491 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
492 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
493 [ "test -s $SOURCE && xsltproc --nonet -o $TARGET" +
494 " --stringparam module $MODULE" +
495 " --stringparam type $TYPE" +
496 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
497 MODULE = xmlnode.dir.dir.dir.abspath[
498 len(env.Dir('#').abspath)+1:],
500 env.SideEffect(xref, xmlnode)
501 env.AddPreAction(docs, "rm -f %s" % (xref,))
502 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
503 xrefs.extend(xref_pp)
506 if extra_sources and htmlnode:
508 [ env.CopyToDir( source=source, target=htmlnode.dir )
509 for source in extra_sources ])
511 if extra_sources and xmlnode:
513 [ env.CopyToDir( source=source, target=xmlnode.dir )
514 for source in extra_sources ])
516 if not htmlnode and not xmlnode:
517 env.Depends(docs, extra_sources)
520 env.Alias('all_docs', doc)
521 env.Clean('all_docs', doc)
522 env.Clean('all', doc)
524 l = len(env.Dir('#').abspath)
526 env.Alias('install_all',
527 env.Command('$DOCINSTALLDIR' + htmlnode.dir.abspath[l:], htmlnode.dir,
528 [ SCons.Defaults.Copy('$TARGET','$SOURCE') ]))
530 env.Alias('install_all',
531 env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
536 ## \brief Build combined doxygen cross-reference
538 # This command will build a complete cross-reference of \c xrefitems
539 # accross all modules.
541 # Right now, this command is very project specific. It needs to be
545 def DoxyXRef(env, docs=None,
546 HTML_HEADER = None, HTML_FOOTER = None,
547 TITLE = "Cross-reference of action points"):
549 docs = env.Alias('all_docs')[0].sources
550 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
551 xref = env.Command("doc/html/xref.xml", xrefs,
552 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
553 "echo '<xref>' >> $TARGET",
554 "cat $SOURCES >> $TARGET",
555 "echo '</xref>' >>$TARGET" ])
557 # Lastly we create the html file
558 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
559 if HTML_HEADER : sources.append(HTML_HEADER)
560 if HTML_FOOTER : sources.append(HTML_FOOTER)
564 commands.append("sed" +
565 " -e 's/\\$$title/$TITLE/g'" +
566 " -e 's/\\$$projectname/Overview/g'" +
567 " ${SOURCES[2]} > $TARGET")
568 commands.append("xsltproc" +
569 " --stringparam title '$TITLE'" +
570 " --stringparam types '$DOXY_XREF_TYPES'" +
571 " ${SOURCES[1]} $SOURCE >> $TARGET")
574 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
575 % (HTML_HEADER and 3 or 2))
577 if env.get('DOXY_HTML_XSL'):
578 xslfile = env.File(env['DOXY_HTML_XSL'])
579 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
580 if reltopdir : reltopdir = reltopdir[:-1]
581 else : reltopdir = '.'
582 commands.append(("xsltproc -o ${TARGET}.tmp" +
584 " --stringparam topdir %s" +
585 " ${SOURCES[-1]} $TARGET 2>/dev/null")
587 commands.append("mv ${TARGET}.tmp ${TARGET}")
588 sources.append(xslfile)
590 xref = env.Command("doc/html/xref.html", sources, commands,
593 env.Alias('all_docs',xref)
597 ## \brief Build library
599 # This target helper will build the given library. The library will be
600 # called lib<i>library</i>.a as is customary on UNIX systems. \a
601 # sources, \a testSources and \a LIBS are directly forwarded to the
602 # Objects build helper.
604 # The library is added to the list of default targets.
607 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
608 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
611 lib = env.Library(env.File(LibPath(library)),objects)
613 env.Append(ALLLIBS = library)
614 env.Alias('default', lib)
615 InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
618 ## \brief Build Object from multiple sources
619 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
620 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
623 ob = env.Command(target+"${OBJADDSUFFIX}${OBJSUFFIX}", objects, "ld -r -o $TARGET $SOURCES")
625 env.Alias('default', ob)
626 InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
629 ## \brief Build executable
631 # This target helper will build the given binary. The \a sources, \a
632 # testSources and \a LIBS arguments are forwarded to the Objects
633 # builder. The final program will be linked against all the library
634 # modules specified in \a LIBS (those are libraries which are built as
635 # part of the same proejct). To specify non-module libraries, use the
636 # construction environment parameters or the framework helpers.
639 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
640 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
644 progEnv.Prepend(LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ])
645 program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
647 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
648 env.Alias('default', program)
649 InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources, no_includes)
652 def AllIncludesHH(env, headers):
654 target = env.File("all_includes.hh")
655 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
657 env.Clean('all', target)