NoBufferingPolicy added
[senf.git] / senfscons / SENFSCons.py
1 ## \file
2 # \brief SENFSCons package
3
4 ## \package senfscons.SENFSCons
5 # \brief Build helpers and utilities
6 #
7 # The SENFSCons package contains a number of build helpers and
8 # utilities which are used to simplify commmon tasks.
9 #
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>
13 #
14 # <dt>\ref target</dt><dd>simplify building common targest and include
15 # enhanced functionality like unit-testing.</dd></dl>
16 #
17 # Additionally for external use are
18 # <dl><dt>MakeEnvironment()</dt><dd>Build construction
19 # environment</dd>
20 #
21 # <dt>GlobSources()</dt><dd>Utility to find source files</dd></dl>
22 #
23 # All other functions are for internal use only.
24
25 import os.path, glob
26 import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS
27 import SCons.Defaults, SCons.Action
28
29 ## \defgroup use Predefined Framework Configurators
30 #
31 # The following framework configurators are used in the top level \c
32 # SConstruct file to simplify more complex configurations.
33 #
34 # Each of the framework configurators introduces additional
35 # configuration parameters to \ref sconfig
36
37 ## \defgroup target Target Helpers
38 #
39 # To specify standard targets, the following helpers can be used. They
40 # automatically integrate several modules (like documentation,
41 # unit-testing etc).
42
43 ## \defgroup builder Builders
44 #
45 # The SENFSCons framework includes a series of builders. Each builder
46 # is defined in it's own package.
47
48 # Tools to load in MakeEnvironment
49 SCONS_TOOLS = [
50     "Doxygen",
51     "Dia2Png",
52 ]
53
54 opts = None
55 finalizers = []
56
57 # This is the directory SENFSCons.py resides
58 basedir = os.path.abspath(os.path.split(__file__)[0])
59
60 ## \brief Initialize configuration options
61 # \internal
62 def InitOpts():
63     global opts
64     if opts is not None: return
65     opts = SCons.Options.Options('SConfig')
66     opts.Add('CXX', 'C++ compiler to use', 'g++')
67     opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '')
68     opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
69     opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
70
71 # A finalizer is any callable object. All finalizers will be called
72 # in MakeEnvironment. We use them so every finalizer has knowledge of
73 # all frameworks in use (e.g.: the boost runtime depends on the use of
74 # stlport).
75
76 ## \brief Register finalizer
77 # \internal
78 def Finalizer(f):
79     global finalizers
80     finalizers.append(f)
81
82 ## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
83 #
84 # Configure the use of the <a href="http://www.boost.org">Boost</a>
85 # libraries. Most of these libraries are header-only, some however
86 # depend on a built library. The library selection is somewhat
87 # involved and depends on the threading model and the type of build
88 # (debug or final).
89 #
90 # \par Configuration Parameters:
91 #     <table class="senf">
92 #     <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
93 #     <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
94 #     <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
95 #     <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
96 #     <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
97 #     <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
98 #     </table>
99 #
100 # You can either specify \c BOOST_VARIANT explicitly or specify \c
101 # BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
102 # BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
103 # to \c gd, If \c BOOST_TOOLSET is specified and you have included
104 # STLPort support (UseSTLPort()), then \c p is appended to both
105 # runtimes.
106 #
107 # The Boost configuration can get realtively complex. If the boost
108 # libraries are provided by the distribution, you probably don't need
109 # to specify any parameters. If your configuration is more complex,
110 # refer to the <a
111 # href="http://www.boost.org/tools/build/v1/build_system.htm">Boost.Build</a>
112 # documentation for a definition of the terms used above (toolset,
113 # variant, runtime ...).
114 #
115 # \ingroup use
116 def UseBoost():
117     global opts
118     InitOpts()
119     opts.Add('BOOST_INCLUDES', 'Boost include directory', '')
120     opts.Add('BOOST_VARIANT', 'The boost variant to use', '')
121     opts.Add('BOOST_TOOLSET', 'The boost toolset to use', '')
122     opts.Add('BOOST_RUNTIME', 'The boost runtime to use', '')
123     opts.Add('BOOST_DEBUG_RUNTIME', 'The boost debug runtime to use', '')
124     opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
125     Finalizer(FinalizeBoost)
126
127 ## \brief Finalize Boost environment
128 # \internal
129 def FinalizeBoost(env):
130     env.Tool('BoostUnitTests', [basedir])
131
132     if env['BOOST_TOOLSET']:
133         runtime = ""
134         if env['final'] : runtime += env.get('BOOST_RUNTIME','')
135         else            : runtime += env.get('BOOST_DEBUG_RUNTIME','gd')
136         if env['STLPORT_LIB'] : runtime += "p"
137         if runtime: runtime = "-" + runtime
138         env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime
139
140     env['BOOSTTESTLIB'] = 'libboost_unit_test_framework' + env['BOOST_VARIANT']
141
142     env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
143                CPPPATH = [ '$BOOST_INCLUDES' ])
144
145 ## \brief Use STLPort as STL replacement if available
146 #
147 # Use <a href="http://www.stlport.org">STLPort</a> as a replacement
148 # for the system STL. STLPort has the added feature of providing fully
149 # checked containers and iterators. This can greatly simplify
150 # debugging. However, STLPort and Boost interact in a non-trivial way
151 # so the configuration is relatively complex. This command does not
152 # enforce the use of STLPort, it is only used if available.
153 #
154 # \par Configuration Parameters:
155 #     <table class="senf">
156 #     <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
157 #     <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
158 #     <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
159 #     <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
160 #     </table>
161 #
162 # If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
163 # STLPORT_LIB with \c _stldebug appended. The STLPort library will
164 # only be used, if \c STLPORT_LIB is set in \c SConfig.
165 #
166 # \ingroup use
167 def UseSTLPort():
168     global opts
169     InitOpts()
170     opts.Add('STLPORT_INCLUDES', 'STLport include directory', '')
171     opts.Add('STLPORT_LIB', 'Name of the stlport library or empty to not use stlport', '')
172     opts.Add('STLPORT_DEBUGLIB', 'Name of the stlport debug library','')
173     opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
174     Finalizer(FinalizeSTLPort)
175
176 # \}
177
178 ## \brief Finalize STLPort environment
179 # \internal
180 def FinalizeSTLPort(env):
181     if env['STLPORT_LIB']:
182         if not env['STLPORT_DEBUGLIB']:
183             env['STLPORT_DEBUGLIB'] = env['STLPORT_LIB'] + '_stldebug'
184         env.Append(LIBPATH = [ '$STLPORT_LIBDIR' ],
185                    CPPPATH = [ '$STLPORT_INCLUDES' ])
186         if env['final']:
187             env.Append(LIBS = [ '$STLPORT_LIB' ])
188         else:
189             env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
190                        CPPDEFINES = [ '_STLP_DEBUG' ])
191
192 ## \brief Build a configured construction environment
193 #
194 # This function is called after all frameworks are specified to build
195 # a tailored construction environment. You can then use this
196 # construction environment just like an ordinary SCons construction
197 # environment (which it is ...)
198 #
199 # This call will set some default compilation parameters depending on
200 # the \c final command line option: specifying <tt>final=1</tt> will
201 # built a release version of the code.
202 def MakeEnvironment():
203     global opts, finalizers
204     InitOpts()
205     env = SCons.Environment.Environment(options=opts)
206     if SCons.Script.SConscript.Arguments.get('final'):
207         env['final'] = 1
208     env.Help(opts.GenerateHelpText(env))
209
210     # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
211     # into other hosts from within SCons rules. I have used rules like
212     # this e.g. to automatically install stuff on a remote system ...
213     if os.environ.has_key('SSH_AUTH_SOCK'):
214         env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
215
216     for finalizer in finalizers:
217         finalizer(env)
218
219     for tool in SCONS_TOOLS:
220         env.Tool(tool, [basedir])
221
222     # These are the default compilation parameters. We should probably
223     # make these configurable
224     env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
225                LOCALLIBDIR = [ '#' ],
226                LIBPATH = [ '$LOCALLIBDIR' ])
227
228     if env['final']:
229         env.Append(CXXFLAGS = [ '-O3' ],
230                    CPPDEFINES = [ 'NDEBUG' ])
231     else:
232         env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
233                    LINKFLAGS = [ '-g' ])
234
235     env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
236                LIBS = [ '$EXTRA_LIBS' ])
237
238     return env
239
240 ## \brief Find normal and test C++ sources
241 #
242 # GlobSources() will return a list of all C++ source files (named
243 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
244 # in the current directory. The sources will be returned as a tuple of
245 # sources, test-sources. The target helpers all accept such a tuple as
246 # their source argument.
247 def GlobSources(exclude=[]):
248     testSources = glob.glob("*.test.cc")
249     sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
250     return (sources, testSources)
251
252 ## \brief Add generic standard targets for every module
253 #
254 # This target helper should be called in the top-level \c SConstruct file
255 # as well as in every module \c SConscipt file. It adds general
256 # targets. Right now, these are
257 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
258 #   <tt>scons -c all</tt>
259 #
260 # \ingroup target
261 def StandardTargets(env):
262     env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
263
264 ## \brief Add generic global targets
265 #
266 # This target helper should be called in the top-level \c SConstruct
267 # file. It adds general global targets. Right now theese are
268 # \li Make <tt>scons all</tt> build all targets.
269 #
270 # \ingroup target
271 def GlobalTargets(env):
272     env.Depends(env.Alias('all'),'#')
273
274 ## \brief Return path of a built library within $LOCALLIBDIR
275 # \internal
276 def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib
277
278 ## \brief Build object files
279 #
280 # This target helper will build object files from the given
281 # sources.
282 #
283 # If \a testSources are given, a unit test will be built using the <a
284 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
285 # library. \a LIBS may specify any additional library modules <em>from
286 # the same project</em> on which the test depends. Those libraries
287 # will be linked into the final test executable. The test will
288 # automatically be run if the \c test or \c all_tests targets are
289 # given.
290 #
291 # If \a sources is a 2-tuple as returned by GlobSources(), it will
292 # provide both \a sources and \a testSources.
293 #
294 # \ingroup target
295 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = []):
296     if type(sources) == type(()):
297         testSources = sources[1]
298         sources = sources[0]
299
300     objects = None
301     if sources:
302         objects = env.Object(sources)
303
304     if testSources:
305         test = env.BoostUnitTests(
306             target = 'test',
307             source = sources,
308             test_source = testSources,
309             LIBS = LIBS,
310             OBJECTS = OBJECTS,
311             DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
312         env.Alias('all_tests', test)
313         # Hmm ... here I'd like to use an Alias instead of a file
314         # however the alias does not seem to live in the subdirectory
315         # which breaks 'scons -u test'
316         env.Alias(env.File('test'), test)
317
318     return objects
319
320 ## \brief Build documentation with doxygen
321 #
322 # The doxygen target helper will build software documentation using
323 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
324 # builder used supports automatic dependency generation (dependencies
325 # are automatically generated from the parameters specified in the \a
326 # doxyfile), automatic target emitters (the exact targets created are
327 # found parsing the \a doxyfile) and lots of other features. See the
328 # Doxygen builder documentation
329 #
330 # If \a extra_sources are given, the generated documentation will
331 # depend on them. This can be used to build images or other
332 # supplementary files.
333 #
334 # The doxygen target helper extends the builder with additional
335 # functionality:
336 #
337 # \li Fix tagfiles by removing namespace entries. These entries only
338 #     work for namespaces completely defined in a single module. As
339 #     soon as another module (which references the tagfile) has it's
340 #     own members in that namespace, the crosslinking will break.
341 # \li If \c DOXY_HTML_XSL is defined as a construction environment
342 #     variable, preprocess all generated html files (if html files are
343 #     generated) by the given XSLT stylesheet. Since the HTML
344 #     generated by doxygen is broken, we first filter the code through
345 #     HTML-\c tidy and filter out some error messages.
346 # \li If xml output is generated we create files \c bug.xmli and \c
347 #     todo.xmli which contain all bugs and todo items specified in the
348 #     sources. The format of these files is much more suited to
349 #     postprocessing and is a more database like format as the doxygen
350 #     generated files (which are more presentation oriented). if \c
351 #     DOXY_XREF_TYPES is given, it will specify the cross reference
352 #     types to support (defaults to \c bug and \c todo). See <a
353 #     href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
354 #     in the doxygen documentation.
355 #
356 # \ingroup target
357 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
358     # ARGHHH !!! without the [:] we are changing the target list
359     #        ||| WITHIN THE DOXYGEN BUILDER
360     docs = env.Doxygen(doxyfile)[:]
361     xmlnode = None
362     htmlnode = None
363     tagnode = None
364     for doc in docs:
365         if isinstance(doc,SCons.Node.FS.Dir): continue
366         if doc.name == 'xml.stamp' : xmlnode = doc
367         if doc.name == 'html.stamp' : htmlnode = doc
368         if doc.name == 'search.idx' : continue
369         if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
370         # otherwise it must be the tag file
371         tagnode = doc
372
373     if tagnode:
374         # Postprocess the tag file to remove the (broken) namespace
375         # references
376         env.AddPostAction(
377             docs,
378             SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
379                        % { 'target': tagnode.abspath,
380                            'template': os.path.join(basedir,"tagmunge.xsl") }))
381
382     if htmlnode and env.get('DOXY_HTML_XSL'):
383         xslfile = env.File(env['DOXY_HTML_XSL'])
384         reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
385         if reltopdir : reltopdir = reltopdir[:-1]
386         else         : reltopdir = '.'
387         env.AddPostAction(
388             docs,
389             SCons.Action.Action(("for html in %s/*.html; do " +
390                         "    echo $$html;" +
391                         "    sed -e 's/id=\"current\"/class=\"current\"/' $${html}" +
392                         "        | tidy -ascii -q --show-warnings no --fix-uri no " +
393                         "        | xsltproc --nonet --html --stringparam topdir %s -o $${html}.new %s - 2>&1" +
394                         "        | grep '^-'" +
395                         "        | grep -v 'ID .* already defined';" +
396                         "    mv $${html}.new $${html}; " +
397                         "done")
398                        % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
399         for doc in docs:
400             env.Depends(doc, xslfile)
401
402     if xmlnode:
403         xrefs = []
404         for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
405             xref = os.path.join(xmlnode.dir.abspath,type+".xml")
406             xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
407                                   [ "test -s $SOURCE && xsltproc -o $TARGET" +
408                                     " --stringparam module $MODULE" +
409                                     " --stringparam type $TYPE" +
410                                     " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
411                                   MODULE = xmlnode.dir.dir.dir.name,
412                                   TYPE = type)
413             env.SideEffect(xref, xmlnode)
414             env.AddPreAction(docs, "rm -f %s" % (xref,))
415             env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
416             xrefs.extend(xref_pp)
417         docs.extend(xrefs)
418
419     env.Depends(docs, extra_sources)
420     for doc in docs :
421         env.Alias('all_docs', doc)
422         env.Clean('all_docs', doc)
423         env.Clean('all', doc)
424
425     return docs
426
427 ## \brief Build combined doxygen cross-reference
428 #
429 # This command will build a complete cross-reference of \c xrefitems
430 # accross all modules.
431 #
432 # Right now, this command is very project specific. It needs to be
433 # generalized.
434 #
435 # \ingroup target
436 def DoxyXRef(env, docs=None,
437              HTML_HEADER = None, HTML_FOOTER = None,
438              TITLE = "Cross-reference of action points"):
439     if docs is None:
440         docs = env.Alias('all_docs')[0].sources
441     xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
442     xref = env.Command("doc/html/xref.xml", xrefs,
443                        [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
444                          "echo '<xref>' >> $TARGET",
445                          "cat $SOURCES >> $TARGET",
446                          "echo '</xref>' >>$TARGET" ])
447
448     # Lastly we create the html file
449     sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
450     if HTML_HEADER : sources.append(HTML_HEADER)
451     if HTML_FOOTER : sources.append(HTML_FOOTER)
452
453     commands = []
454     if HTML_HEADER:
455         commands.append("sed" +
456                         " -e 's/\\$$title/$TITLE/g'" +
457                         " -e 's/\\$$projectname/Overview/g'" +
458                         " ${SOURCES[2]} > $TARGET")
459     commands.append("xsltproc" +
460                     " --stringparam title '$TITLE'" +
461                     " --stringparam types '$DOXY_XREF_TYPES'" +
462                     " ${SOURCES[1]} $SOURCE >> $TARGET")
463     if HTML_FOOTER:
464         commands.append(
465             "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
466             % (HTML_HEADER and 3 or 2))
467
468     if env.get('DOXY_HTML_XSL'):
469         xslfile = env.File(env['DOXY_HTML_XSL'])
470         reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
471         if reltopdir : reltopdir = reltopdir[:-1]
472         else         : reltopdir = '.'
473         commands.append(("xsltproc -o ${TARGET}.tmp" +
474                          " --nonet --html" +
475                          " --stringparam topdir %s" +
476                          " ${SOURCES[-1]} $TARGET 2>/dev/null")
477                         % reltopdir)
478         commands.append("mv ${TARGET}.tmp ${TARGET}")
479         sources.append(xslfile)
480         
481     xref = env.Command("doc/html/xref.html", sources, commands,
482                        TITLE = TITLE)
483
484     env.Alias('all_docs',xref)
485     return xref
486
487
488 ## \brief Build library
489 #
490 # This target helper will build the given library. The library will be
491 # called lib<i>library</i>.a as is customary on UNIX systems. \a
492 # sources, \a testSources and \a LIBS are directly forwarded to the
493 # Objects build helper.
494 #
495 # The library is added to the list of default targets.
496 #
497 #\ingroup target
498 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = []):
499     objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
500     lib = None
501     if objects:
502         lib = env.Library(env.File(LibPath(library)),objects)
503         env.Default(lib)
504         env.Append(ALLLIBS = library)
505     return lib
506
507 ## \brief Build Object from multiple sources
508 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = []):
509     objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
510     ob = None
511     if objects:
512         ob = env.Command(target+".o", objects, "ld -r -o $TARGET $SOURCES")
513         env.Default(ob)
514     return ob
515
516 ## \brief Build executable
517 #
518 # This target helper will build the given binary.  The \a sources, \a
519 # testSources and \a LIBS arguments are forwarded to the Objects
520 # builder. The final program will be linked against all the library
521 # modules specified in \a LIBS (those are libraries which are built as
522 # part of the same proejct). To specify non-module libraries, use the
523 # construction environment parameters or the framework helpers.
524 #
525 # \ingroup target
526 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = []):
527     objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
528     program = None
529     if objects:
530         progEnv = env.Copy()
531         progEnv.Prepend(LIBS = LIBS)
532         program = progEnv.Program(target=binary,source=objects+OBJECTS)
533         env.Default(program)
534         env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
535     return program