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(opts.GenerateHelpText(env))
 223
 224     # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
 225     # into other hosts from within SCons rules. I have used rules like
 226     # this e.g. to automatically install stuff on a remote system ...
 227     if os.environ.has_key('SSH_AUTH_SOCK'):
 228         env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
 229
 230     for finalizer in finalizers:
 231         finalizer(env)
 232
 233     for tool in SCONS_TOOLS:
 234         env.Tool(tool, [basedir])
 235
 236     # These are the default compilation parameters. We should probably
 237     # make these configurable
 238     env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
 239                LOCALLIBDIR = [ '#' ],
 240                LIBPATH = [ '$LOCALLIBDIR' ])
 241
 242     if env['final']:
 243         env.Append(CXXFLAGS = [ '-O3' ],
 244                    CPPDEFINES = [ 'NDEBUG' ])
 245     else:
 246         env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ],
 247                    LINKFLAGS = [ '-g' ])
 248
 249     env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
 250                LIBS = [ '$EXTRA_LIBS' ])
 251
 252     return env
 253
 254 ## \brief Find normal and test C++ sources
 255 #
 256 # GlobSources() will return a list of all C++ source files (named
 257 # "*.cc") as well as a list of all unit-test files (named "*.test.cc")
 258 # in the current directory. The sources will be returned as a tuple of
 259 # sources, test-sources. The target helpers all accept such a tuple as
 260 # their source argument.
 261 def GlobSources(exclude=[], subdirs=[]):
 262     testSources = glob.glob("*.test.cc")
 263     sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
 264     for subdir in subdirs:
 265         testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
 266         sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
 267                      if x not in testSources and x not in exclude ]
 268     return (sources, testSources)
 269
 270 ## \brief Add generic standard targets for every module
 271 #
 272 # This target helper should be called in the top-level \c SConstruct file
 273 # as well as in every module \c SConscipt file. It adds general
 274 # targets. Right now, these are
 275 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
 276 #   <tt>scons -c all</tt>
 277 #
 278 # \ingroup target
 279 def StandardTargets(env):
 280     env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
 281
 282 ## \brief Add generic global targets
 283 #
 284 # This target helper should be called in the top-level \c SConstruct
 285 # file. It adds general global targets. Right now theese are
 286 # \li Make <tt>scons all</tt> build all targets.
 287 #
 288 # \ingroup target
 289 def GlobalTargets(env):
 290     env.Depends(env.Alias('all'),'#')
 291
 292 ## \brief Return path of a built library within $LOCALLIBDIR
 293 # \internal
 294 def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib
 295
 296 ## \brief Build object files
 297 #
 298 # This target helper will build object files from the given
 299 # sources.
 300 #
 301 # If \a testSources are given, a unit test will be built using the <a
 302 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
 303 # library. \a LIBS may specify any additional library modules <em>from
 304 # the same project</em> on which the test depends. Those libraries
 305 # will be linked into the final test executable. The test will
 306 # automatically be run if the \c test or \c all_tests targets are
 307 # given.
 308 #
 309 # If \a sources is a 2-tuple as returned by GlobSources(), it will
 310 # provide both \a sources and \a testSources.
 311 #
 312 # \ingroup target
 313 def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = []):
 314     if type(sources) == type(()):
 315         testSources = sources[1]
 316         sources = sources[0]
 317     if type(sources) is not type([]):
 318         sources = [ sources ]
 319
 320     objects = None
 321     if sources:
 322         objects = env.Object([
 323             source
 324             for source in sources
 325             if not str(source).endswith('.o') ]) + [
 326             source
 327             for source in sources
 328             if str(source).endswith('.o') ]
 329
 330
 331     if testSources:
 332         test = env.BoostUnitTests(
 333             target = 'test',
 334             objects = objects,
 335             test_sources = testSources,
 336             LIBS = LIBS,
 337             OBJECTS = OBJECTS,
 338             DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
 339         env.Alias('all_tests', test)
 340         # Hmm ... here I'd like to use an Alias instead of a file
 341         # however the alias does not seem to live in the subdirectory
 342         # which breaks 'scons -u test'
 343         env.Alias(env.File('test'), test)
 344
 345     return objects
 346
 347 def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False):
 348     if type(sources) is type(()):
 349         sources, testSources = sources
 350     if type(sources) is not type([]):
 351         sources = [ sources ]
 352     if type(testSources) is not type([]):
 353         testSources = [ testSources ]
 354
 355     installs = []
 356     installs.append( env.Install(dir, targets) )
 357
 358     if not no_includes:
 359         target = env.Dir(env['INCLUDEINSTALLDIR']).Dir(
 360             env.Dir('.').get_path(env.Dir(env['INSTALL_BASE'])))
 361         source = targets
 362         if testSources:
 363             source.append( env.File('.test.bin') )
 364
 365             installs.append(env.InstallIncludes(
 366                 target = target,
 367                 source = targets,
 368                 INSTALL_BASE = env.Dir('.') ))
 369
 370     return installs
 371
 372 ## \brief Build documentation with doxygen
 373 #
 374 # The doxygen target helper will build software documentation using
 375 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
 376 # builder used supports automatic dependency generation (dependencies
 377 # are automatically generated from the parameters specified in the \a
 378 # doxyfile), automatic target emitters (the exact targets created are
 379 # found parsing the \a doxyfile) and lots of other features. See the
 380 # Doxygen builder documentation
 381 #
 382 # If \a extra_sources are given, the generated documentation will
 383 # depend on them. This can be used to build images or other
 384 # supplementary files.
 385 #
 386 # The doxygen target helper extends the builder with additional
 387 # functionality:
 388 #
 389 # \li Fix tagfiles by removing namespace entries. These entries only
 390 #     work for namespaces completely defined in a single module. As
 391 #     soon as another module (which references the tagfile) has it's
 392 #     own members in that namespace, the crosslinking will break.
 393 # \li If \c DOXY_HTML_XSL is defined as a construction environment
 394 #     variable, preprocess all generated html files (if html files are
 395 #     generated) by the given XSLT stylesheet. Since the HTML
 396 #     generated by doxygen is broken, we first filter the code through
 397 #     HTML-\c tidy and filter out some error messages.
 398 # \li If xml output is generated we create files \c bug.xmli and \c
 399 #     todo.xmli which contain all bugs and todo items specified in the
 400 #     sources. The format of these files is much more suited to
 401 #     postprocessing and is a more database like format as the doxygen
 402 #     generated files (which are more presentation oriented). if \c
 403 #     DOXY_XREF_TYPES is given, it will specify the cross reference
 404 #     types to support (defaults to \c bug and \c todo). See <a
 405 #     href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
 406 #     in the doxygen documentation.
 407 #
 408 # \ingroup target
 409 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
 410     # ARGHHH !!! without the [:] we are changing the target list
 411     #        ||| WITHIN THE DOXYGEN BUILDER
 412     docs = env.Doxygen(doxyfile)[:]
 413     xmlnode = None
 414     htmlnode = None
 415     tagnode = None
 416     for doc in docs:
 417         if isinstance(doc,SCons.Node.FS.Dir): continue
 418         if doc.name == 'xml.stamp' : xmlnode = doc
 419         if doc.name == 'html.stamp' : htmlnode = doc
 420         if doc.name == 'search.idx' : continue
 421         if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
 422         # otherwise it must be the tag file
 423         tagnode = doc
 424
 425     if tagnode:
 426         # Postprocess the tag file to remove the (broken) namespace
 427         # references
 428         env.AddPostAction(
 429             docs,
 430             SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
 431                        % { 'target': tagnode.abspath,
 432                            'template': os.path.join(basedir,"tagmunge.xsl") }))
 433
 434     if htmlnode and env.get('DOXY_HTML_XSL'):
 435         xslfile = env.File(env['DOXY_HTML_XSL'])
 436         reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
 437         if reltopdir : reltopdir = reltopdir[:-1]
 438         else         : reltopdir = '.'
 439         env.AddPostAction(
 440             docs,
 441             SCons.Action.Action(("for html in %s/*.html; do " +
 442                         "    echo $$html;" +
 443                         "    sed -e 's/id=\"current\"/class=\"current\"/' $${html}" +
 444                         "        | tidy -ascii -q --show-warnings no --fix-uri no " +
 445                         "        | xsltproc --nonet --html --stringparam topdir %s -o $${html}.new %s - 2>&1" +
 446                         "        | grep '^-'" +
 447                         "        | grep -v 'ID .* already defined';" +
 448                         "    mv $${html}.new $${html}; " +
 449                         "done")
 450                        % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
 451         for doc in docs:
 452             env.Depends(doc, xslfile)
 453
 454     if xmlnode:
 455         xrefs = []
 456         for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
 457             xref = os.path.join(xmlnode.dir.abspath,type+".xml")
 458             xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
 459                                   [ "test -s $SOURCE && xsltproc -o $TARGET" +
 460                                     " --stringparam module $MODULE" +
 461                                     " --stringparam type $TYPE" +
 462                                     " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
 463                                   MODULE = xmlnode.dir.dir.dir.abspath[
 464                                                len(env.Dir('#').abspath)+1:],
 465                                   TYPE = type)
 466             env.SideEffect(xref, xmlnode)
 467             env.AddPreAction(docs, "rm -f %s" % (xref,))
 468             env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
 469             xrefs.extend(xref_pp)
 470         docs.extend(xrefs)
 471
 472     if extra_sources and htmlnode:
 473         env.Depends(docs,
 474                     [ env.CopyToDir( source=source, target=htmlnode.dir )
 475                       for source in extra_sources ])
 476
 477     if extra_sources and xmlnode:
 478         env.Depends(docs,
 479                     [ env.CopyToDir( source=source, target=xmlnode.dir )
 480                       for source in extra_sources ])
 481
 482     if not htmlnode and not xmlnode:
 483         env.Depends(docs, extra_sources)
 484
 485     for doc in docs :
 486         env.Alias('all_docs', doc)
 487         env.Clean('all_docs', doc)
 488         env.Clean('all', doc)
 489
 490     l = len(env.Dir('#').abspath)
 491     if htmlnode:
 492         env.Alias('install_all',
 493                   env.Install( '$DOCINSTALLDIR' + htmlnode.dir.dir.abspath[l:],
 494                                htmlnode.dir ))
 495     if tagnode:
 496         env.Alias('install_all',
 497                   env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
 498                                tagnode ))
 499
 500     return docs
 501
 502 ## \brief Build combined doxygen cross-reference
 503 #
 504 # This command will build a complete cross-reference of \c xrefitems
 505 # accross all modules.
 506 #
 507 # Right now, this command is very project specific. It needs to be
 508 # generalized.
 509 #
 510 # \ingroup target
 511 def DoxyXRef(env, docs=None,
 512              HTML_HEADER = None, HTML_FOOTER = None,
 513              TITLE = "Cross-reference of action points"):
 514     if docs is None:
 515         docs = env.Alias('all_docs')[0].sources
 516     xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
 517     xref = env.Command("doc/html/xref.xml", xrefs,
 518                        [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
 519                          "echo '<xref>' >> $TARGET",
 520                          "cat $SOURCES >> $TARGET",
 521                          "echo '</xref>' >>$TARGET" ])
 522
 523     # Lastly we create the html file
 524     sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
 525     if HTML_HEADER : sources.append(HTML_HEADER)
 526     if HTML_FOOTER : sources.append(HTML_FOOTER)
 527
 528     commands = []
 529     if HTML_HEADER:
 530         commands.append("sed" +
 531                         " -e 's/\\$$title/$TITLE/g'" +
 532                         " -e 's/\\$$projectname/Overview/g'" +
 533                         " ${SOURCES[2]} > $TARGET")
 534     commands.append("xsltproc" +
 535                     " --stringparam title '$TITLE'" +
 536                     " --stringparam types '$DOXY_XREF_TYPES'" +
 537                     " ${SOURCES[1]} $SOURCE >> $TARGET")
 538     if HTML_FOOTER:
 539         commands.append(
 540             "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
 541             % (HTML_HEADER and 3 or 2))
 542
 543     if env.get('DOXY_HTML_XSL'):
 544         xslfile = env.File(env['DOXY_HTML_XSL'])
 545         reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
 546         if reltopdir : reltopdir = reltopdir[:-1]
 547         else         : reltopdir = '.'
 548         commands.append(("xsltproc -o ${TARGET}.tmp" +
 549                          " --nonet --html" +
 550                          " --stringparam topdir %s" +
 551                          " ${SOURCES[-1]} $TARGET 2>/dev/null")
 552                         % reltopdir)
 553         commands.append("mv ${TARGET}.tmp ${TARGET}")
 554         sources.append(xslfile)
 555
 556     xref = env.Command("doc/html/xref.html", sources, commands,
 557                        TITLE = TITLE)
 558
 559     env.Alias('all_docs',xref)
 560     return xref
 561
 562
 563 ## \brief Build library
 564 #
 565 # This target helper will build the given library. The library will be
 566 # called lib<i>library</i>.a as is customary on UNIX systems. \a
 567 # sources, \a testSources and \a LIBS are directly forwarded to the
 568 # Objects build helper.
 569 #
 570 # The library is added to the list of default targets.
 571 #
 572 #\ingroup target
 573 def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
 574     objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
 575     lib = None
 576     if objects:
 577         lib = env.Library(env.File(LibPath(library)),objects)
 578         env.Default(lib)
 579         env.Append(ALLLIBS = library)
 580         install = InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes)
 581         env.Alias('install_all', install)
 582     return lib
 583
 584 ## \brief Build Object from multiple sources
 585 def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
 586     objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
 587     ob = None
 588     if objects:
 589         ob = env.Command(target+".o", objects, "ld -r -o $TARGET $SOURCES")
 590         env.Default(ob)
 591         install = InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes)
 592         env.Alias('install_all', install)
 593     return ob
 594
 595 ## \brief Build executable
 596 #
 597 # This target helper will build the given binary.  The \a sources, \a
 598 # testSources and \a LIBS arguments are forwarded to the Objects
 599 # builder. The final program will be linked against all the library
 600 # modules specified in \a LIBS (those are libraries which are built as
 601 # part of the same proejct). To specify non-module libraries, use the
 602 # construction environment parameters or the framework helpers.
 603 #
 604 # \ingroup target
 605 def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False):
 606     objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
 607     program = None
 608     if objects:
 609         progEnv = env.Copy()
 610         progEnv.Prepend(LIBS = LIBS)
 611         program = progEnv.Program(target=binary,source=objects+OBJECTS)
 612         env.Default(program)
 613         env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
 614         install = InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources,
 615                                      no_includes)
 616         env.Alias('install_all', install)
 617     return program