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