X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senfscons%2FSENFSCons.py;h=9d243ce7803bc3e22cd3b08f8494fd4744b2c302;hb=2d51a34f79dd18b23c54172444b2cc7433b8f5f0;hp=771d4fadad223a6172cf51bcedbd21d2061db273;hpb=245bdb920e5f8fc1150794db8d0b42a15fa2cd15;p=senf.git

diff --git a/senfscons/SENFSCons.py b/senfscons/SENFSCons.py
index 771d4fa..9d243ce 100644
--- a/senfscons/SENFSCons.py
+++ b/senfscons/SENFSCons.py
@@ -1,6 +1,50 @@
+## \file
+# \brief SENFSCons package
+
+## \package senfscons.SENFSCons
+# \brief Build helpers and utilities
+#
+# The SENFSCons package contains a number of build helpers and
+# utilities which are used to simplify commmon tasks. 
+#
+# The utitlities of this package are grouped into:
+# <dl><dt>\ref use</dt><dd>help using complex environments and
+# configure the construction environmen correspondingly</dd>
+#
+# <dt>\ref target</dt><dd>simplify building common targest and include
+# enhanced functionality like unit-testing.</dd></dl>
+#
+# Additionally for external use are
+# <dl><dt>MakeEnvironment()</dt><dd>Build construction
+# environment</dd>
+#
+# <dt>GlobSources()</dt><dd>Utility to find source files</dd></dl>
+#
+# All other functions are for internal use only.
+
 import os.path, glob
 import  SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS, SCons.Defaults
 
+## \defgroup use Predefined Framework Configurators
+#
+# The following framework configurators are used in the top level \c
+# SConstruct file to simplify more complex configurations. 
+#
+# Each of the framework configurators introduces additional
+# configuration parameters to \ref sconfig
+
+## \defgroup target Target Helpers
+#
+# To specify standard targets, the following helpers can be used. They
+# automatically integrate several modules (like documentation,
+# unit-testing etc).
+
+## \defgroup builder Builders
+#
+# The SENFSCons framework includes a series of builders. Each builder
+# is defined in it's own package.
+
+# Tools to load in MakeEnvironment
 SCONS_TOOLS = [
     "Doxygen",
     "Dia2Png",
@@ -9,8 +53,11 @@ SCONS_TOOLS = [
 opts = None
 finalizers = []
 
+# This is the directory SENFSCons.py resides
 basedir = os.path.abspath(os.path.split(__file__)[0])
 
+## \brief Initialize configuration options
+# \internal
 def InitOpts():
     global opts
     if opts is not None: return
@@ -20,10 +67,51 @@ def InitOpts():
     opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '')
     opts.Add(SCons.Options.BoolOption('final','Enable optimization',0))
 
+# A finalizer is any callable object. All finalizers will be called
+# in MakeEnvironment. We use them so every finalizer has knowledge of
+# all frameworks in use (e.g.: the boost runtime depends on the use of
+# stlport).
+
+## \brief Register finalizer
+# \internal
 def Finalizer(f):
     global finalizers
     finalizers.append(f)
 
+## \brief Initialize the use of the <a href="http://www.boost.org/">Boost</a> library
+#
+# Configure the use of the <a href="http://www.boost.org">Boost</a>
+# libraries. Most of these libraries are header-only, some however
+# depend on a built library. The library selection is somewhat
+# involved and depends on the threading model and the type of build
+# (debug or final).
+#
+# \par Configuration Parameters:
+#     <table class="senf">
+#     <tr><td>\c BOOST_INCLUDES</td><td>Include directory.</td></tr>
+#     <tr><td>\c BOOST_LIBDIR</td><td>Library directory</td></tr>
+#     <tr><td>\c BOOST_VARIANT</td><td>Complete variant specification</td></tr>
+#     <tr><td>\c BOOST_TOOLSET</td><td>Toolset to use</td></tr>
+#     <tr><td>\c BOOST_RUNTIME</td><td>Runtime to use</td></tr>
+#     <tr><td>\c BOOST_DEBUG_RUNTIME</td><td>Explicit debug runtime</td></tr>
+#     </table>
+#
+# You can either specify \c BOOST_VARIANT explicitly or specify \c
+# BOOST_TOOLSET and \c BOOST_RUNTIME. If you give \c BOOST_TOOLSET, \c
+# BOOST_RUNTIME defaults to empty and \c BOOST_DEBUG_RUNTIME defaults
+# to \c gd, If \c BOOST_TOOLSET is specified and you have included
+# STLPort support (UseSTLPort()), then \c p is appended to both
+# runtimes.
+#
+# The Boost configuration can get realtively complex. If the boost
+# libraries are provided by the distribution, you probably don't need
+# to specify any parameters. If your configuration is more complex,
+# refer to the <a
+# href="http://www.boost.org/tools/build/v1/build_system.htm">Boost.Build</a>
+# documentation for a definition of the terms used above (toolset,
+# variant, runtime ...).
+#
+# \ingroup use
 def UseBoost():
     global opts
     InitOpts()
@@ -35,6 +123,8 @@ def UseBoost():
     opts.Add('BOOST_LIBDIR', 'The directory of the boost libraries', '')
     Finalizer(FinalizeBoost)
 
+## \brief Finalize Boost environment
+# \internal
 def FinalizeBoost(env):
     env.Tool('BoostUnitTests', [basedir])
 
@@ -51,6 +141,28 @@ def FinalizeBoost(env):
     env.Append(LIBPATH = [ '$BOOST_LIBDIR' ],
                CPPPATH = [ '$BOOST_INCLUDES' ])
 
+## \brief Use STLPort as STL replacement if available
+#
+# Use <a href="http://www.stlport.org">STLPort</a> as a replacement
+# for the system STL. STLPort has the added feature of providing fully
+# checked containers and iterators. This can greatly simplify
+# debugging. However, STLPort and Boost interact in a non-trivial way
+# so the configuration is relatively complex. This command does not
+# enforce the use of STLPort, it is only used if available.
+#
+# \par Configuration Parameters:
+#     <table class="senf">
+#     <tr><td>\c STLPORT_INCLUDES</td><td>Include directory.</td></tr>
+#     <tr><td>\c STLPORT_LIBDIR</td><td>Library directory</td></tr>
+#     <tr><td>\c STLPORT_LIB</td><td>Name of STLPort library</td></tr>
+#     <tr><td>\c STLPORT_DEBUGLIB</td><td>Name of STLPort debug library</td></tr>
+#     </table>
+#
+# If \c STLPORT_LIB is specified, \c STLPORT_DEBUGLIB defaults to \c
+# STLPORT_LIB with \c _stldebug appended. The STLPort library will
+# only be used, if \c STLPORT_LIB is set in \c SConfig.
+#
+# \ingroup use
 def UseSTLPort():
     global opts
     InitOpts()
@@ -60,6 +172,10 @@ def UseSTLPort():
     opts.Add('STLPORT_LIBDIR', 'The directory of the stlport libraries','')
     Finalizer(FinalizeSTLPort)
 
+# \}
+
+## \brief Finalize STLPort environment
+# \internal
 def FinalizeSTLPort(env):
     if env['STLPORT_LIB']:
         if not env['STLPORT_DEBUGLIB']:
@@ -72,6 +188,16 @@ def FinalizeSTLPort(env):
             env.Append(LIBS = [ '$STLPORT_DEBUGLIB' ],
                        CPPDEFINES = [ '_STLP_DEBUG' ])
 
+## \brief Build a configured construction environment
+#
+# This function is called after all frameworks are specified to build
+# a tailored construction environment. You can then use this
+# construction environment just like an ordinary SCons construction
+# environment (which it is ...)
+#
+# This call will set some default compilation parameters depending on
+# the \c final command line option: specifying <tt>final=1</tt> will
+# built a release version of the code.
 def MakeEnvironment():
     global opts, finalizers
     InitOpts()
@@ -79,8 +205,10 @@ def MakeEnvironment():
     if SCons.Script.SConscript.Arguments.get('final'):
         env['final'] = 1
     env.Help(opts.GenerateHelpText(env))
-    #conf = env.Configure()
-    #env = conf.env
+
+    # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh
+    # into other hosts from within SCons rules. I have used rules like
+    # this e.g. to automatically install stuff on a remote system ...
     if os.environ.has_key('SSH_AUTH_SOCK'):
         env.Append( ENV = { 'SSH_AUTH_SOCK': os.environ['SSH_AUTH_SOCK'] } )
 
@@ -90,6 +218,8 @@ def MakeEnvironment():
     for tool in SCONS_TOOLS:
         env.Tool(tool, [basedir])
 
+    # These are the default compilation parameters. We should probably
+    # make these configurable
     env.Append(CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ],
                LOCALLIBDIR = [ '#' ],
                LIBPATH = [ '$LOCALLIBDIR' ])
@@ -104,24 +234,63 @@ def MakeEnvironment():
     env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ],
                LIBS = [ '$EXTRA_LIBS' ])
 
-    #return conf.Finish()
     return env
 
+## \brief Find normal and test C++ sources
+#
+# GlobSources() will return a list of all C++ source files (named
+# "*.cc") as well as a list of all unit-test files (named "*.test.cc")
+# in the current directory. The sources will be returned as a tuple of
+# sources, test-sources. The target helpers all accept such a tuple as
+# their source argument.
 def GlobSources(exclude=[]):
     testSources = glob.glob("*.test.cc")
     sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
     return (sources, testSources)
     
+## \brief Add generic standard targets for every module
+#
+# This target helper should be called in the top-level \c SConstruct file
+# as well as in every module \c SConscipt file. It adds general
+# targets. Right now, these are
+# \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
+#   <tt>scons -c all</tt>
+# 
+# \ingroup target
 def StandardTargets(env):
-    all = env.Alias('all')
-    env.Clean(all, [ '.sconsign', '.sconf_temp', 'config.log' ])
-    env.Depends(all, '.')
-
+    env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
+
+## \brief Add generic global targets
+#
+# This target helper should be called in the top-level \c SConstruct
+# file. It adds general global targets. Right now theese are
+# \li Make <tt>scons all</tt> build all targets.
+#
+# \ingroup target
 def GlobalTargets(env):
-    pass
+    env.Depends(env.Alias('all'),'#')
 
+## \brief Return path of a built library within $LOCALLIBDIR
+# \internal
 def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib
-    
+
+## \brief Build object files
+#
+# This target helper will build object files from the given
+# sources.
+#
+# If \a testSources are given, a unit test will be built using the <a
+# href="http://www.boost.org/libs/test/doc/index.html">Boost.Test</a>
+# library. \a LIBS may specify any additional library modules <em>from
+# the same project</em> on which the test depends. Those libraries
+# will be linked into the final test executable. The test will
+# automatically be run if the \c test or \c all_tests targets are
+# given.
+#
+# If \a sources is a 2-tuple as returned by GlobSources(), it will
+# provide both \a sources and \a testSources.
+#
+# \ingroup target
 def Objects(env, sources, testSources = None, LIBS = []):
     if type(sources) == type(()):
         testSources = sources[1]
@@ -146,6 +315,43 @@ def Objects(env, sources, testSources = None, LIBS = []):
 
     return objects
 
+## \brief Build documentation with doxygen
+#
+# The doxygen target helper will build software documentation using
+# the given \a doxyfile (which defaults to \c Doxyfile). The Doxygen
+# builder used supports automatic dependency generation (dependencies
+# are automatically generated from the parameters specified in the \a
+# doxyfile), automatic target emitters (the exact targets created are
+# found parsing the \a doxyfile) and lots of other features. See the
+# Doxygen builder documentation
+#
+# If \a extra_sources are given, the generated documentation will
+# depend on them. This can be used to build images or other
+# supplementary files.
+#
+# The doxygen target helper extends the builder with additional
+# functionality:
+#
+# \li Fix tagfiles by removing namespace entries. These entries only
+#     work for namespaces completely defined in a single module. As
+#     soon as another module (which references the tagfile) has it's
+#     own members in that namespace, the crosslinking will break.
+# \li If \c DOXY_HTML_XSL is defined as a construction environment
+#     variable, preprocess all generated html files (if html files are
+#     generated) by the given XSLT stylesheet. Since the HTML
+#     generated by doxygen is broken, we first filter the code through
+#     HTML-\c tidy and filter out some error messages.
+# \li If xml output is generatedwe create files \c bug.xmli and \c
+#     todo.xmli which contain all bugs and todo items specified in the
+#     sources. The format of these files is much more suited to
+#     postprocessing and is a more database like format as the doxygen
+#     generated files (which are more presentation oriented). if \c
+#     DOXY_XREF_TYPES is given, it will specify the cross reference
+#     types to support (defaults to \c bug and \c todo). See <a
+#     href="http://www.stack.nl/~dimitri/doxygen/commands.html#cmdxrefitem">\xrefitem</a>
+#     in the doxygen documentation.
+#
+# \ingroup target
 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
     # ARGHHH !!! without the [:] we are changing the target list
     #        ||| WITHIN THE DOXYGEN BUILDER
@@ -209,8 +415,18 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
         env.Alias('all_docs', doc)
         env.Clean('all_docs', doc)
         env.Clean('all', doc)
+
     return docs
 
+## \brief Build combined doxygen cross-reference
+#
+# This command will build a complete cross-reference of \c xrefitems
+# accross all modules.
+#
+# Right now, this command is very project specific. It needs to be
+# generalized.
+#
+# \ingroup target
 def DoxyXRef(env, docs=None,
              HTML_HEADER = None, HTML_FOOTER = None,
              TITLE = "Cross-reference of action points"):
@@ -243,6 +459,16 @@ def DoxyXRef(env, docs=None,
     env.Alias('all_docs',xref)
     return xref
 
+## \brief Build library
+#
+# This target helper will build the given library. The library will be
+# called lib<i>library</i>.a as is customary on UNIX systems. \a
+# sources, \a testSources and \a LIBS are directly forwarded to the
+# Objects build helper.
+#
+# The library is added to the list of default targets.
+#
+#\ingroup target
 def Lib(env, library, sources, testSources = None, LIBS = []):
     objects = Objects(env,sources,testSources,LIBS=LIBS)
     lib = None
@@ -252,6 +478,16 @@ def Lib(env, library, sources, testSources = None, LIBS = []):
         env.Append(ALLLIBS = library)
     return lib
 
+## \brief Build executable
+#
+# This target helper will build the given binary.  The \a sources, \a
+# testSources and \a LIBS arguments are forwarded to the Objects
+# builder. The final program will be linked against all the library
+# modules specified in \a LIBS (those are libraries which are built as
+# part of the same proejct). To specify non-module libraries, use the
+# construction environment parameters or the framework helpers.
+#
+# \ingroup target
 def Binary(env, binary, sources, testSources = None, LIBS = []):
     objects = Objects(env,sources,testSources,LIBS=LIBS)
     program = None