senfscons/SENFSCons.py

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