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     "PkgDraw",
  54     "CopyToDir",
  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                ALLOBJECTS = [])
 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(env, 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 def GlobIncludes(env, exclude=[], subdirs=[]):
 308     includes = []
 309     for d in [ '.' ] + subdirs:
 310         for f in os.listdir(d):
 311             ext = '.' + f.split('.',1)[-1]
 312             p = os.path.join(d,f)
 313             if ext in env['CPP_INCLUDE_EXTENSIONS'] \
 314                and ext not in env['CPP_EXCLUDE_EXTENSIONS'] \
 315                and p not in exclude:
 316                 includes.append(p)
 317     return includes
 318
 319 def Glob(env, exclude=[], subdirs=[]):
 320     return ( GlobSources(env, exclude, subdirs),
 321              GlobIncludes(env, exclude, subdirs) )
 322
 323 ## \brief Add generic standard targets for every module
 324 #
 325 # This target helper should be called in the top-level \c SConstruct file
 326 # as well as in every module \c SConscipt file. It adds general
 327 # targets. Right now, these are
 328 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
 329 #   <tt>scons -c all</tt>
 330 #
 331 # \ingroup target
 332 def StandardTargets(env):
 333     env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
 334
 335 ## \brief Add generic global targets
 336 #
 337 # This target helper should be called in the top-level \c SConstruct
 338 # file. It adds general global targets. Right now theese are
 339 # \li Make <tt>scons all</tt> build all targets.
 340 #
 341 # \ingroup target
 342 def GlobalTargets(env):
 343     env.Alias('all', [ 'default', 'all_tests', 'all_docs' ])
 344
 345 ## \brief Return path of a built library within $LOCALLIBDIR
 346 # \internal
 347 def LibPath(lib): return '${LOCALLIBDIR}/${LIBPREFIX}%s${LIBADDSUFFIX}${LIBSUFFIX}' % lib
 348
 349 ## \brief Add explicit test
 350 #
 351 # This target helper will add an explicit test. This is like a unit test but is
 352 # built directly against the completed library
 353 #
 354 # \ingroup target
 355 def Test(env, sources, LIBS = [], OBJECTS = []):
 356     test = [ env.BoostUnitTests(
 357         target = 'test',
 358         objects = [],
 359         test_sources = sources,
 360         LIBS = [ '$LIBSENF$LIBADDSUFFIX' ],
 361         OBJECTS = OBJECTS,
 362         DEPENDS = [ env.File(LibPath(env['LIBSENF'])) ]) ]
 363     compileTestSources = [ src for src in sources
 364                            if 'COMPILE_CHECK' in file(src).read() ]
 365     if compileTestSources:
 366         test.extend(env.CompileCheck(source = compileTestSources))
 367     env.Alias('all_tests', test)
 368     env.Command(env.File('test'), test, [])
 369     #env.Alias(env.File('test'), test)
 370
 371
 372 ## \brief Build object files
 373 #
 374 # This target helper will build object files from the given
 375 # sources.
 376 #
 377 # If \a testSources are given, a unit test will be built using the <a
 378 # href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
 379 # library. \a LIBS may specify any additional library modules <em>from
 380 # the same project</em> on which the test depends. Those libraries
 381 # will be linked into the final test executable. The test will
 382 # automatically be run if the \c test or \c all_tests targets are
 383 # given.
 384 #
 385 # If \a sources is a 2-tuple as returned by GlobSources(), it will
 386 # provide both \a sources and \a testSources.
 387 #
 388 # \ingroup target
 389 def Objects(env, sources, testSources = None, OBJECTS = []):
 390     if type(sources) == type(()):
 391         testSources = sources[1]
 392         sources = sources[0]
 393     if type(sources) is not type([]):
 394         sources = [ sources ]
 395
 396     objects = None
 397     if sources:
 398         obsources = [ source
 399                       for source in sources
 400                       if type(source) is type('') and not source.endswith('.o') ]
 401         objects = [ source
 402                     for source in sources
 403                     if type(source) is not type('') or source.endswith('.o') ]
 404         if obsources:
 405             objects += env.Object(obsources)
 406
 407     if testSources:
 408         test = [ env.BoostUnitTests(
 409             target = 'test',
 410             objects = objects,
 411             test_sources = testSources,
 412             LIBS = [ '$LIBSENF$LIBADDSUFFIX' ],
 413             OBJECTS = OBJECTS,
 414             DEPENDS = [ env.File(LibPath(env['LIBSENF'])) ]) ]
 415         compileTestSources = [ src for src in testSources
 416                                if 'COMPILE_CHECK' in file(src).read() ]
 417         if compileTestSources:
 418             test.extend(env.CompileCheck(source = compileTestSources))
 419         env.Alias('all_tests', test)
 420         # Hmm ... here I'd like to use an Alias instead of a file
 421         # however the alias does not seem to live in the subdirectory
 422         # which breaks 'scons -u test'
 423         env.Command(env.File('test'), test, [])
 424         #env.Alias(env.File('test'), test)
 425
 426     return objects
 427
 428 def InstallIncludeFiles(env, files):
 429     # Hrmpf ... why do I need this in 0.97??
 430     if env.GetOption('clean'):
 431         return
 432     target = env.Dir(env['INCLUDEINSTALLDIR'])
 433     base = env.Dir('#')
 434     for f in files:
 435         src = env.File(f)
 436         env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src))
 437
 438 ## \brief Build documentation with doxygen
 439 #
 440 # The doxygen target helper will build software documentation using
 441 # the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
 442 # builder used supports automatic dependency generation (dependencies
 443 # are automatically generated from the parameters specified in the \a
 444 # doxyfile), automatic target emitters (the exact targets created are
 445 # found parsing the \a doxyfile) and lots of other features. See the
 446 # Doxygen builder documentation
 447 #
 448 # If \a extra_sources are given, the generated documentation will
 449 # depend on them. This can be used to build images or other
 450 # supplementary files.
 451 #
 452 # The doxygen target helper extends the builder with additional
 453 # functionality:
 454 #
 455 # \li Fix tagfiles by removing namespace entries. These entries only
 456 #     work for namespaces completely defined in a single module. As
 457 #     soon as another module (which references the tagfile) has it's
 458 #     own members in that namespace, the crosslinking will break.
 459 # \li If \c DOXY_HTML_XSL is defined as a construction environment
 460 #     variable, preprocess all generated html files (if html files are
 461 #     generated) by the given XSLT stylesheet. Since the HTML
 462 #     generated by doxygen is broken, we first filter the code through
 463 #     HTML-\c tidy and filter out some error messages.
 464 # \li If xml output is generated we create files \c bug.xmli and \c
 465 #     todo.xmli which contain all bugs and todo items specified in the
 466 #     sources. The format of these files is much more suited to
 467 #     postprocessing and is a more database like format as the doxygen
 468 #     generated files (which are more presentation oriented). if \c
 469 #     DOXY_XREF_TYPES is given, it will specify the cross reference
 470 #     types to support (defaults to \c bug and \c todo). See <a
 471 #     href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
 472 #     in the doxygen documentation.
 473 #
 474 # \ingroup target
 475 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
 476     if not 'all' in BUILD_TARGETS and not 'doc' in BUILD_TARGETS and not 'all_docs' in BUILD_TARGETS:
 477         return []
 478     # ARGHHH !!! without the [:] we are changing the target list
 479     #        ||| WITHIN THE DOXYGEN BUILDER
 480     docs = env.Doxygen(doxyfile)[:]
 481     xmlnode = None
 482     htmlnode = None
 483     tagnode = None
 484     for doc in docs:
 485         if isinstance(doc,SCons.Node.FS.Dir): continue
 486         if doc.name == 'xml.stamp' : xmlnode = doc
 487         if doc.name == 'html.stamp' : htmlnode = doc
 488         if doc.name == 'search.idx' : continue
 489         if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
 490         # otherwise it must be the tag file
 491         tagnode = doc
 492
 493     if tagnode:
 494         # Postprocess the tag file to remove the (broken) namespace
 495         # references
 496         env.AddPostAction(
 497             docs,
 498             SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
 499                        % { 'target': tagnode.abspath,
 500                            'template': os.path.join(basedir,"tagmunge.xsl") }))
 501
 502     if htmlnode and env.get('DOXY_HTML_XSL'):
 503         xslfile = env.File(env['DOXY_HTML_XSL'])
 504         reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
 505         if reltopdir : reltopdir = reltopdir[:-1]
 506         else         : reltopdir = '.'
 507         env.AddPostAction(
 508             docs,
 509             SCons.Action.Action(("for html in %s/*.html; do " +
 510                         "    echo $$html;" +
 511                         "    mv $${html} $${html}.orig;" +
 512                         "    sed -e 's/id=\"current\"/class=\"current\"/' $${html}.orig" +
 513                         "        | tidy -ascii -q --wrap 0 --show-warnings no --fix-uri no " +
 514                         "        | sed -e 's/name=\"\([^\"]*\)\"\([^>]*\) id=\"\\1\"/name=\"\\1\"\\2/g'" +
 515                         "        | xsltproc --novalid --nonet --html --stringparam topdir %s -o $${html} %s -;"
 516                         "done; true")
 517                        % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
 518         for doc in docs:
 519             env.Depends(doc, xslfile)
 520
 521     if xmlnode:
 522         xrefs = []
 523         for type in env.get("DOXY_XREF_TYPES",[ "bug", "todo" ]):
 524             xref = os.path.join(xmlnode.dir.abspath,type+".xml")
 525             xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
 526                                   [ "test -s $SOURCE && xsltproc --nonet -o $TARGET" +
 527                                     " --stringparam module $MODULE" +
 528                                     " --stringparam type $TYPE" +
 529                                     " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
 530                                   MODULE = xmlnode.dir.dir.dir.abspath[
 531                                                len(env.Dir('#').abspath)+1:],
 532                                   TYPE = type)
 533             env.SideEffect(xref, xmlnode)
 534             env.AddPreAction(docs, "rm -f %s" % (xref,))
 535             env.AddPostAction(docs, "test -r %s || touch %s" % (xref,xref))
 536             xrefs.extend(xref_pp)
 537         docs.extend(xrefs)
 538
 539     if extra_sources and htmlnode:
 540         env.Depends(docs,
 541                     [ env.CopyToDir( source=source, target=htmlnode.dir )
 542                       for source in extra_sources ])
 543
 544     if extra_sources and xmlnode:
 545         env.Depends(docs,
 546                     [ env.CopyToDir( source=source, target=xmlnode.dir )
 547                       for source in extra_sources ])
 548
 549     if not htmlnode and not xmlnode:
 550         env.Depends(docs, extra_sources)
 551
 552     for doc in docs :
 553         env.Alias('all_docs', doc)
 554         env.Clean('all_docs', doc)
 555         env.Clean('all', doc)
 556
 557     l = len(env.Dir('#').abspath)
 558     if htmlnode:
 559         env.Alias('install_all',
 560                   env.Command('$DOCINSTALLDIR' + htmlnode.dir.abspath[l:], htmlnode.dir,
 561                               [ SCons.Defaults.Copy('$TARGET','$SOURCE') ]))
 562     if tagnode:
 563         env.Alias('install_all',
 564                   env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:],
 565                                tagnode ))
 566
 567     return docs
 568
 569 ## \brief Build combined doxygen cross-reference
 570 #
 571 # This command will build a complete cross-reference of \c xrefitems
 572 # accross all modules.
 573 #
 574 # Right now, this command is very project specific. It needs to be
 575 # generalized.
 576 #
 577 # \ingroup target
 578 def DoxyXRef(env, docs=None,
 579              HTML_HEADER = None, HTML_FOOTER = None,
 580              TITLE = "Cross-reference of action points"):
 581     if docs is None:
 582         docs = env.Alias('all_docs')[0].sources
 583     xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
 584     xref = env.Command("doc/html/xref.xml", xrefs,
 585                        [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
 586                          "echo '<xref>' >> $TARGET",
 587                          "cat $SOURCES >> $TARGET",
 588                          "echo '</xref>' >>$TARGET" ])
 589
 590     # Lastly we create the html file
 591     sources = [ xref, "%s/xrefhtml.xslt" % basedir ]
 592     if HTML_HEADER : sources.append(HTML_HEADER)
 593     if HTML_FOOTER : sources.append(HTML_FOOTER)
 594
 595     commands = []
 596     if HTML_HEADER:
 597         commands.append("sed" +
 598                         " -e 's/\\$$title/$TITLE/g'" +
 599                         " -e 's/\\$$projectname/Overview/g'" +
 600                         " ${SOURCES[2]} > $TARGET")
 601     commands.append("xsltproc" +
 602                     " --stringparam title '$TITLE'" +
 603                     " --stringparam types '$DOXY_XREF_TYPES'" +
 604                     " ${SOURCES[1]} $SOURCE >> $TARGET")
 605     if HTML_FOOTER:
 606         commands.append(
 607             "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
 608             % (HTML_HEADER and 3 or 2))
 609
 610     if env.get('DOXY_HTML_XSL'):
 611         xslfile = env.File(env['DOXY_HTML_XSL'])
 612         reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
 613         if reltopdir : reltopdir = reltopdir[:-1]
 614         else         : reltopdir = '.'
 615         commands.append(("xsltproc -o ${TARGET}.tmp" +
 616                          " --nonet --html" +
 617                          " --stringparam topdir %s" +
 618                          " ${SOURCES[-1]} $TARGET 2>/dev/null")
 619                         % reltopdir)
 620         commands.append("mv ${TARGET}.tmp ${TARGET}")
 621         sources.append(xslfile)
 622
 623     xref = env.Command("doc/html/xref.html", sources, commands,
 624                        TITLE = TITLE)
 625
 626     env.Alias('all_docs',xref)
 627     return xref
 628
 629
 630 ## \brief Build library
 631 #
 632 # This target helper will build the given library. The library will be
 633 # called lib<i>library</i>.a as is customary on UNIX systems. \a
 634 # sources, \a testSources and \a LIBS are directly forwarded to the
 635 # Objects build helper.
 636 #
 637 # The library is added to the list of default targets.
 638 #
 639 #\ingroup target
 640 def Lib(env, sources, testSources = None, OBJECTS = []):
 641     objects = Objects(env,sources,testSources,OBJECTS=OBJECTS)
 642     if objects:
 643         env.Append(ALLOBJECTS = objects)
 644     return objects
 645
 646 ## \brief Build Object from multiple sources
 647 def Object(env, target, sources, testSources = None, OBJECTS = []):
 648     objects = Objects(env,sources,testSources,OBJECTS=OBJECTS)
 649     ob = None
 650     if objects:
 651         ob = env.Command(target+"${OBJADDSUFFIX}${OBJSUFFIX}", objects, "ld -r -o $TARGET $SOURCES")
 652         env.Default(ob)
 653         env.Alias('default', ob)
 654         env.Alias('install_all', env.Install("$OBJINSTALLDIR", ob))
 655     return ob
 656
 657 ## \brief Build executable
 658 #
 659 # This target helper will build the given binary.  The \a sources, \a
 660 # testSources and \a LIBS arguments are forwarded to the Objects
 661 # builder. The final program will be linked against all the library
 662 # modules specified in \a LIBS (those are libraries which are built as
 663 # part of the same proejct). To specify non-module libraries, use the
 664 # construction environment parameters or the framework helpers.
 665 #
 666 # \ingroup target
 667 def Binary(env, binary, sources, testSources = None, OBJECTS = []):
 668     objects = Objects(env,sources,testSources,OBJECTS=OBJECTS)
 669     program = None
 670     if objects:
 671         progEnv = env.Clone()
 672         progEnv.Prepend(LIBS = [ '$LIBSENF$LIBADDSUFFIX' ])
 673         program = progEnv.ProgramNoScan(target=binary,source=objects+OBJECTS)
 674         env.Default(program)
 675         env.Depends(program, [ env.File(LibPath(env['LIBSENF'])) ])
 676         env.Alias('default', program)
 677         env.Alias('install_all', env.Install('$BININSTALLDIR', program))
 678     return program
 679
 680 def AllIncludesHH(env, headers):
 681     headers.sort()
 682     target = env.File("all_includes.hh")
 683     file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
 684                                              for f in headers ]))
 685     env.Clean('all', target)