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