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