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