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']
156 env['BOOSTIOSTREAMSLIB'] = 'boost_iostreams' + env['BOOST_VARIANT']
158 env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
159 CPPPATH = [ '$BOOST_INCLUDES' ])
161 ## \brief Use STLPort as STL replacement if available
163 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
164 # for the system STL. STLPort has the added feature of providing fully
165 # checked containers and iterators. This can greatly simplify
166 # debugging. However, STLPort and Boost interact in a non-trivial way
167 # so the configuration is relatively complex. This command does not
168 # enforce the use of STLPort, it is only used if available.
170 # \par Configuration Parameters:
171 # <table class="senf">
172 # <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
173 # <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
174 # <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
175 # <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
178 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
179 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
180 # only be used, if \c STLPORT_LIB is set in \c SConfig.
186 opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
187 opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
188 opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
189 opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
190 Finalizer(FinalizeSTLPort)
194 ## \brief Finalize STLPort environment
196 def FinalizeSTLPort(env):
197 if env['STLPORT_LIB']:
198 if not env['STLPORT_DEBUGLIB']:
199 env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
200 env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
201 CPPPATH = [ '$STLPORT_INCLUDES' ])
203 env.Append(LIBS = [ '$STLPORT_LIB' ])
205 env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
206 CPPDEFINES = [ '_STLP_DEBUG' ])
208 ## \brief Build a configured construction environment
210 # This function is called after all frameworks are specified to build
211 # a tailored construction environment. You can then use this
212 # construction environment just like an ordinary SCons construction
213 # environment (which it is ...)
215 # This call will set some default compilation parameters depending on
216 # the \c final command line option: specifying <tt>final=1</tt> will
217 # built a release version of the code.
218 def MakeEnvironment():
219 global opts, finalizers
221 env = SCons.Environment.Environment(options=opts)
222 env.Replace(**SCons.Script.SConscript.Arguments)
223 #for opt in opts.options:
224 # if SCons.Script.SConscript.Arguments.get(opt.key):
225 # env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key)
226 #if SCons.Script.SConscript.Arguments.get('final'):
228 env.Help("\nSupported build variables (either in SConfig or on the command line:\n")
229 env.Help(opts.GenerateHelpText(env))
231 # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
232 # into other hosts from within SCons rules. I have used rules like
233 # this e.g. to automatically install stuff on a remote system ...
234 if os.environ.has_key('SSH_AUTH_SOCK'):
235 env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
237 for finalizer in finalizers:
240 for tool in SCONS_TOOLS:
241 env.Tool(tool, [basedir])
243 # These are the default compilation parameters. We should probably
244 # make these configurable
245 env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
246 LOCALLIBDIR = [ '#' ],
247 LIBPATH = [ '$LOCALLIBDIR' ])
250 env.Append(CXXFLAGS = [ '-O3' ])
252 # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails:
253 # CPPDEFINES = [ '_GLIBCXX_DEBUG' ],
254 env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
255 CPPDEFINES = [ 'SENF_DEBUG' ],
256 LINKFLAGS = [ '-g', '-rdynamic' ])
258 env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
259 LIBS = [ '$EXTRA_LIBS' ],
264 ## \brief Find normal and test C++ sources
266 # GlobSources() will return a list of all C++ source files (named
267 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
268 # in the current directory. The sources will be returned as a tuple of
269 # sources, test-sources. The target helpers all accept such a tuple as
270 # their source argument.
271 def GlobSources(exclude=[], subdirs=[]):
272 testSources = glob.glob("*.test.cc")
273 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
274 for subdir in subdirs:
275 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
276 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
277 if x not in testSources and x not in exclude ]
278 return (sources, testSources)
280 ## \brief Add generic standard targets for every module
282 # This target helper should be called in the top-level \c SConstruct file
283 # as well as in every module \c SConscipt file. It adds general
284 # targets. Right now, these are
285 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
286 # <tt>scons -c all</tt>
289 def StandardTargets(env):
290 env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
292 ## \brief Add generic global targets
294 # This target helper should be called in the top-level \c SConstruct
295 # file. It adds general global targets. Right now theese are
296 # \li Make <tt>scons all</tt> build all targets.
299 def GlobalTargets(env):
300 env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
302 ## \brief Return path of a built library within $LOCALLIBDIR
304 def LibPath(lib): return '${LOCALLIBDIR}/${LIBPREFIX}%s${LIBADDSUFFIX}${LIBSUFFIX}' % lib
306 def Test(env, sources, LIBS = [], OBJECTS = []):
307 test = env.BoostUnitTests(
310 test_sources = sources,
311 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
313 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
314 env.Alias('all_tests', test)
315 env.Alias(env.File('test'), test)
318 ## \brief Build object files
320 # This target helper will build object files from the given
323 # If \a testSources are given, a unit test will be built using the <a
324 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
325 # library. \a LIBS may specify any additional library modules <em>from
326 # the same project</em> on which the test depends. Those libraries
327 # will be linked into the final test executable. The test will
328 # automatically be run if the \c test or \c all_tests targets are
331 # If \a sources is a 2-tuple as returned by GlobSources(), it will
332 # provide both \a sources and \a testSources.
335 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
336 if type(sources) == type(()):
337 testSources = sources[1]
339 if type(sources) is not type([]):
340 sources = [ sources ]
345 for source in sources
346 if not str(source).endswith('.o') ]
348 for source in sources
349 if str(source).endswith('.o') ]
351 objects += env.Object(obsources)
354 test = env.BoostUnitTests(
357 test_sources = testSources,
358 LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ],
360 DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
361 env.Alias('all_tests', test)
362 # Hmm ... here I'd like to use an Alias instead of a file
363 # however the alias does not seem to live in the subdirectory
364 # which breaks 'scons -u test'
365 env.Alias(env.File('test'), test)
369 def InstallIncludeFiles(env, files):
370 # Hrmpf ... why do I need this in 0.97??
371 if env.GetOption('clean'):
373 target = env.Dir(env['INCLUDEINSTALLDIR'])
374 base = env.Dir(env['INSTALL_BASE'])
377 env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
379 def InstallSourceIncludes(env, sources):
380 target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
381 env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
382 install = env.InstallIncludes( target = target,
383 source = [ type(x) is str and env.File(x) or x
385 INSTALL_BASE = env.Dir('.') )
386 env.Alias( 'install_all', install )
388 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
389 if type(sources) is type(()):
390 sources, testSources = sources
391 if type(sources) is not type([]):
392 sources = [ sources ]
393 if type(testSources) is not type([]):
394 testSources = [ testSources ]
396 installs = [ env.Install(dir, targets) ]
397 env.Alias( 'install_all', installs[:] )
402 sources.append( env.File('.test.bin') )
404 InstallSourceIncludes(env, sources))
408 ## \brief Build documentation with doxygen
410 # The doxygen target helper will build software documentation using
411 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
412 # builder used supports automatic dependency generation (dependencies
413 # are automatically generated from the parameters specified in the \a
414 # doxyfile), automatic target emitters (the exact targets created are
415 # found parsing the \a doxyfile) and lots of other features. See the
416 # Doxygen builder documentation
418 # If \a extra_sources are given, the generated documentation will
419 # depend on them. This can be used to build images or other
420 # supplementary files.
422 # The doxygen target helper extends the builder with additional
425 # \li Fix tagfiles by removing namespace entries. These entries only
426 # work for namespaces completely defined in a single module. As
427 # soon as another module (which references the tagfile) has it's
428 # own members in that namespace, the crosslinking will break.
429 # \li If \c DOXY_HTML_XSL is defined as a construction environment
430 # variable, preprocess all generated html files (if html files are
431 # generated) by the given XSLT stylesheet. Since the HTML
432 # generated by doxygen is broken, we first filter the code through
433 # HTML-\c tidy and filter out some error messages.
434 # \li If xml output is generated we create files \c bug.xmli and \c
435 # todo.xmli which contain all bugs and todo items specified in the
436 # sources. The format of these files is much more suited to
437 # postprocessing and is a more database like format as the doxygen
438 # generated files (which are more presentation oriented). if \c
439 # DOXY_XREF_TYPES is given, it will specify the cross reference
440 # types to support (defaults to \c bug and \c todo). See <a
441 # href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
442 # in the doxygen documentation.
445 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
446 # ARGHHH !!! without the [:] we are changing the target list
447 # ||| WITHIN THE DOXYGEN BUILDER
448 docs = env.Doxygen(doxyfile)[:]
453 if isinstance(doc,SCons.Node.FS.Dir): continue
454 if doc.name == 'xml.stamp' : xmlnode = doc
455 if doc.name == 'html.stamp' : htmlnode = doc
456 if doc.name == 'search.idx' : continue
457 if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
458 # otherwise it must be the tag file
462 # Postprocess the tag file to remove the (broken) namespace
466 SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
467 % { 'target': tagnode.abspath,
468 'template': os.path.join(basedir,"tagmunge.xsl") }))
470 if htmlnode and env.get('DOXY_HTML_XSL'):
471 xslfile = env.File(env['DOXY_HTML_XSL'])
472 reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
473 if reltopdir : reltopdir = reltopdir[:-1]
474 else : reltopdir = '.'
477 SCons.Action.Action(("for html in %s/*.html; do " +
479 " mv $${html} $${html}.orig;" +
480 " sed -e 's/id=\"current\"/class=\"current\"/' $${html}.orig" +
481 " | tidy -ascii -q --wrap 0 --show-warnings no --fix-uri no " +
482 " | sed -e 's/name=\"\([^\"]*\)\"\([^>]*\) id=\"\\1\"/name=\"\\1\"\\2/g'" +
483 " | xsltproc --novalid --nonet --html --stringparam topdir %s -o $${html} %s -;"
485 % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
487 env.Depends(doc, xslfile)
491 for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
492 xref = os.path.join(xmlnode.dir.abspath,type+".xml")
493 xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
494 [ "test -s $SOURCE && xsltproc --nonet -o $TARGET" +
495 " --stringparam module $MODULE" +
496 " --stringparam type $TYPE" +
497 " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
498 MODULE = xmlnode.dir.dir.dir.abspath[
499 len(env.Dir('#').abspath)+1:],
501 env.SideEffect(xref, xmlnode)
502 env.AddPreAction(docs, "rm -f %s" % (xref,))
503 env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
504 xrefs.extend(xref_pp)
507 if extra_sources and htmlnode:
509 [ env.CopyToDir( source=source, target=htmlnode.dir )
510 for source in extra_sources ])
512 if extra_sources and xmlnode:
514 [ env.CopyToDir( source=source, target=xmlnode.dir )
515 for source in extra_sources ])
517 if not htmlnode and not xmlnode:
518 env.Depends(docs, extra_sources)
521 env.Alias('all_docs', doc)
522 env.Clean('all_docs', doc)
523 env.Clean('all', doc)
525 l = len(env.Dir('#').abspath)
527 env.Alias('install_all',
528 env.Command('$DOCINSTALLDIR' + htmlnode.dir.abspath[l:], htmlnode.dir,
529 [ SCons.Defaults.Copy('$TARGET','$SOURCE') ]))
531 env.Alias('install_all',
532 env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
537 ## \brief Build combined doxygen cross-reference
539 # This command will build a complete cross-reference of \c xrefitems
540 # accross all modules.
542 # Right now, this command is very project specific. It needs to be
546 def DoxyXRef(env, docs=None,
547 HTML_HEADER = None, HTML_FOOTER = None,
548 TITLE = "Cross-reference of action points"):
550 docs = env.Alias('all_docs')[0].sources
551 xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
552 xref = env.Command("doc/html/xref.xml", xrefs,
553 [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
554 "echo '<xref>' >> $TARGET",
555 "cat $SOURCES >> $TARGET",
556 "echo '</xref>' >>$TARGET" ])
558 # Lastly we create the html file
559 sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
560 if HTML_HEADER : sources.append(HTML_HEADER)
561 if HTML_FOOTER : sources.append(HTML_FOOTER)
565 commands.append("sed" +
566 " -e 's/\\$$title/$TITLE/g'" +
567 " -e 's/\\$$projectname/Overview/g'" +
568 " ${SOURCES[2]} > $TARGET")
569 commands.append("xsltproc" +
570 " --stringparam title '$TITLE'" +
571 " --stringparam types '$DOXY_XREF_TYPES'" +
572 " ${SOURCES[1]} $SOURCE >> $TARGET")
575 "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
576 % (HTML_HEADER and 3 or 2))
578 if env.get('DOXY_HTML_XSL'):
579 xslfile = env.File(env['DOXY_HTML_XSL'])
580 reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
581 if reltopdir : reltopdir = reltopdir[:-1]
582 else : reltopdir = '.'
583 commands.append(("xsltproc -o ${TARGET}.tmp" +
585 " --stringparam topdir %s" +
586 " ${SOURCES[-1]} $TARGET 2>/dev/null")
588 commands.append("mv ${TARGET}.tmp ${TARGET}")
589 sources.append(xslfile)
591 xref = env.Command("doc/html/xref.html", sources, commands,
594 env.Alias('all_docs',xref)
598 ## \brief Build library
600 # This target helper will build the given library. The library will be
601 # called lib<i>library</i>.a as is customary on UNIX systems. \a
602 # sources, \a testSources and \a LIBS are directly forwarded to the
603 # Objects build helper.
605 # The library is added to the list of default targets.
608 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
609 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
612 lib = env.Library(env.File(LibPath(library)),objects)
614 env.Append(ALLLIBS = library)
615 env.Alias('default', lib)
616 InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
619 ## \brief Build Object from multiple sources
620 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
621 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
624 ob = env.Command(target+"${OBJADDSUFFIX}${OBJSUFFIX}", objects, "ld -r -o $TARGET $SOURCES")
626 env.Alias('default', ob)
627 InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
630 ## \brief Build executable
632 # This target helper will build the given binary. The \a sources, \a
633 # testSources and \a LIBS arguments are forwarded to the Objects
634 # builder. The final program will be linked against all the library
635 # modules specified in \a LIBS (those are libraries which are built as
636 # part of the same proejct). To specify non-module libraries, use the
637 # construction environment parameters or the framework helpers.
640 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
641 objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
645 progEnv.Prepend(LIBS = [ x + '$LIBADDSUFFIX' for x in LIBS ])
646 program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
648 env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
649 env.Alias('default', program)
650 InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources, no_includes)
653 def AllIncludesHH(env, headers):
655 target = env.File("all_includes.hh")
656 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
658 env.Clean('all', target)