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