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