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