senfscons/SENFSCons.py

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