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