Documentation: fixed links to boost.org
[senf.git] / site_scons / senfutil.py
index 46e33d1..7a2eb98 100644 (file)
@@ -1,5 +1,10 @@
-import os.path, glob
+import os.path, glob, site_tools.Yaptu
 from SCons.Script import *
+import SCons.Defaults, SCons.Util
+import senfconf
+import types, re
+
+senfutildir = os.path.dirname(__file__)
 
 # Fix for SCons 0.97 compatibility
 try:
@@ -29,6 +34,69 @@ class BuildTypeOptions:
         type = env['final'] and "final" or env['debug'] and "debug" or "normal"
         return env[self._var + "_" + type]
 
+_DOLLAR_RE = re.compile(r'\$([a-zA-Z_][\.\w]*)|\${([^}]*)}')
+
+def _expandDefines(defs, target, source, env, for_signature):
+    rv = []
+    if SCons.Util.is_Dict(defs):
+        keys = defs.keys()
+        keys.sort()
+        defs = [ (k,defs[k]) for k in keys ]
+    elif not SCons.Util.is_List(defs):
+        defs = [ defs ]
+    for elt in defs:
+        if SCons.Util.is_String(elt):
+            m = _DOLLAR_RE.match(elt)
+            if m:
+                match = m.group(1) or m.group(2)
+                try: rv.extend(_expandDefines(eval(match, env.gvars(), env.lvars()),
+                                              target, source, env, for_signature))
+                except NameError: pass
+                except IndexError: pass
+            else:
+                rv.append(env.subst(elt))
+        elif callable(elt):
+            rv.extend(_expandDefines(elt(target, source, env, for_signature),
+                                     target, source, env, for_signature))
+        elif SCons.Util.is_Sequence(elt):
+            if len(elt)<2 or elt[1] is None:
+                rv.append(env.subst(elt[0]))
+            else:
+                rv.append(env.subst(elt[0]) + "=" + env.subst(elt[1]))
+        else:
+            rv.append(str(elt))
+    return rv
+
+def expandDefines(prefix, defs, suffix, env):
+    """Expand defines in <defs> using <env>. Calls SCons.Defaults._concat_ixes
+to append prefix/suffix before/after each define.
+
+    callable
+        Call the callable and replace it with the call result. If the result
+        is a list, the list is processed recursively. It the result is a
+        dictionary it is converted into a list of typles and processed
+        recursively.
+    '$<variable>' or '${<variable>}'
+        Replace the element with the variable expansion. If the result is a
+        list, the list is processed recursively. It the result is a
+        dictionary it is converted into a list of typles and processed
+        recursively.
+    '<any other string>'
+        Define a symbol with that (expanded!) name
+    iterable
+        The iteratble must have two elments. The first element defines the
+        symbol name, the second the symbol value."""
+
+    defs = _expandDefines(defs, None, None, env, False)
+    return SCons.Defaults._concat_ixes(prefix, defs, suffix, env)
+    
+def loadTools(env):
+    global senfutildir
+    tooldir = os.path.join(senfutildir, 'site_tools')
+    for tool in os.listdir(tooldir):
+        name, ext = os.path.splitext(tool)
+        if ext == '.py' and name != "__init__" : env.Tool(name, [ tooldir ])
+
 def parseArguments(env, *defs):
     vars = Variables(args=ARGUMENTS)
     for d in defs : vars.Add(d)
@@ -57,26 +125,19 @@ Special command line parameters:
 # This looks much more complicated than it is: We do three things here:
 # a) switch between final or debug options
 # b) parse the LOGLEVELS parameter into the correct SENF_LOG_CONF syntax
-# c) check for a local SENF, set options accordingly and update that SENF if needed
+# c) check for a local SENF, set options accordingly
+# d) check, wether the boost extensions are needed
 
-def SetupForSENF(env, senf_paths = []):
-    senfutildir = os.path.dirname(__file__)
-    senf_paths.extend(('senf', '../senf', os.path.dirname(senfutildir), '/usr/local', '/usr'))
-    tooldir = os.path.join(senfutildir, 'site_tools')
+def SetupForSENF(env, senf_path = []):
+    global senfutildir
+    senf_path.extend(('senf', os.path.dirname(senfutildir), '/usr/local', '/usr'))
 
-    env.Tool('Boost',       [ tooldir ])
-    env.Tool('PhonyTarget', [ tooldir ])
+    loadTools(env)
 
     env.Append(
-        LIBS              = [ 'senf', 'rt', '$BOOSTREGEXLIB',
-                              '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
-                              '$BOOSTFSLIB' ],
-        BOOSTREGEXLIB     = 'boost_regex',
-        BOOSTIOSTREAMSLIB = 'boost_iostreams',
-        BOOSTSIGNALSLIB   = 'boost_signals',
-        BOOSTFSLIB        = 'boost_filesystem',
+        LIBS              = [ 'rt' ],
         
-        CXXFLAGS          = [ '-Wno-long-long', '$CXXFLAGS_' ],
+        CXXFLAGS          = [ '-Wno-long-long', '$CXXFLAGS_', '-fno-strict-aliasing' ],
         CXXFLAGS_         = BuildTypeOptions('CXXFLAGS'),
         
         CPPDEFINES        = [ '$expandLogOption', '$CPPDEFINES_' ],
@@ -106,8 +167,16 @@ def SetupForSENF(env, senf_paths = []):
         LOGLEVELS_final   = [],
         LOGLEVELS_normal  = [],
         LOGLEVELS_debug   = [],
+
+        PROJECTNAME       = "Unnamed project",
+        DOCLINKS          = [],
+        PROJECTEMAIL      = "nobody@nowhere.org",
+        COPYRIGHT         = "nobody",
+        REVISION          = "unknown",
         )
 
+    env.Replace( _defines = expandDefines )
+
     # Interpret command line options
     parseArguments(
         env, 
@@ -117,45 +186,172 @@ def SetupForSENF(env, senf_paths = []):
 
     # If we have a symbolic link (or directory) 'senf', we use it as our
     # senf repository
-    for path in senf_paths:
+    for path in senf_path:
         if not path.startswith('/') : sconspath = '#/%s' % path
         else                        : sconspath = path
         if os.path.exists(os.path.join(path,"senf/config.hh")):
-            print "\nUsing SENF in '%s'\n" \
-                % ('/..' in sconspath and os.path.abspath(path) or sconspath)
+            if not env.GetOption('no_progress'):
+                print "\nUsing SENF in '%s'\n" \
+                    % ('/..' in sconspath and os.path.abspath(path) or sconspath)
             env.Append( LIBPATH = [ sconspath ],
                         CPPPATH = [ sconspath ],
-                        BUNDLEDIR = sconspath )
+                        BUNDLEDIR = sconspath,
+                        SENFDIR = sconspath,
+                        SENFINCDIR = sconspath,
+                        SENFSYSLAYOUT = False)
             try:
                 env.MergeFlags(file(os.path.join(path,"senf.conf")).read())
             except IOError:
-                print "(SENF configuration file 'senf.conf' not found, assuming non-final SENF)"
+                if not env.GetOption('no_progress'):
+                    print "(SENF configuration file 'senf.conf' not found, assuming non-final SENF)"
                 env.Append(CPPDEFINES = [ 'SENF_DEBUG' ])
             break
         elif os.path.exists(os.path.join(path,"include/senf/config.hh")):
-            print "\nUsing system SENF in '%s/'\n" % sconspath
-            env.Append(BUNDLEDIR = os.path.join(sconspath,"lib/senf"))
+            if not env.GetOption('no_progress'):
+                print "\nUsing system SENF in '%s/'\n" % sconspath
+            env.Append(BUNDLEDIR = os.path.join(sconspath,"lib/senf"),
+                       SENFDIR = sconspath,
+                       SENFINCDIR = '%s/include' % sconspath,
+                       SENFSYSLAYOUT = True)
             break
     else:
-        print "\nSENF library not found .. trying build anyway !!\n"
+        if not env.GetOption('no_progress'):
+            print "\nSENF library not found .. trying build anyway !!\n"
+
+    Configure(env)
+
+    # Only add senf after all configure checks have run
+    env.Append(
+        CPPPATH = '${NEED_BOOST_EXT and "$SENFINCDIR/boost_ext" or None}',
+        LIBS = [ 'senf', '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
+                 '$BOOSTFSLIB' ],
+        )
+
+    env.Alias('all', '#')
 
 
 def DefaultOptions(env):
     env.Append(
         CXXFLAGS         = [ '-Wall', '-Woverloaded-virtual' ],
-        CXXFLAGS_final   = [ '-O2' ],
-        CXXFLAGS_normal  = [ '-O0', '-g' ],
-        CXXFLAGS_debug   = [ '$CXXFLAGS_normal' ],
+        CXXFLAGS_final   = [ '-O3' ],
+        CXXFLAGS_normal  = [ '-O2', '-g' ],
+        CXXFLAGS_debug   = [ '-O0', '-g' ],
 
         LINKFLAGS_normal = [ '-Wl,-S' ],
         LINKFLAGS_debug  = [ '-g' ],
     )
 
+
 def Glob(env, exclude=[], subdirs=[]):
-    testSources = glob.glob("*.test.cc")
-    sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
+    testSources = env.Glob("*.test.cc", strings=True)
+    sources = [ x 
+                for x in env.Glob("*.cc", strings=True) 
+                if x not in testSources and x not in exclude ]
     for subdir in subdirs:
-        testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
-        sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
+        testSources += env.Glob(os.path.join(subdir,"*.test.cc"), strings=True)
+        sources += [ x 
+                     for x in env.Glob(os.path.join(subdir,"*.cc"), strings=True)
                      if x not in testSources and x not in exclude ]
+    sources.sort()
+    testSources.sort()
     return (sources, testSources)
+
+
+def Configure(env):
+    conf = env.Configure(clean=False, 
+                         help=False, 
+                         custom_tests=senfconf.Tests(), 
+                         config_h="#/senf/autoconf.hh")
+    env.SetDefault(
+        BOOST_VERSION  = conf.CheckBoostVersion(),
+        BOOST_VARIANT  = conf.CheckBoostVariants( '', 'mt' ),
+        NEED_BOOST_EXT = not conf.CheckCXXHeader("boost/bimap.hpp"),
+        HAVE_BOOST_SPIRIT_INCLUDE_CLASSIC_HPP = conf.CheckCXXHeader(
+            "boost/spirit/include/classic.hpp"),
+    )
+    conf.Finish()
+
+
+tagfiles = None
+
+def Doxygen(env, doxyheader=None, doxyfooter=None, doxycss=None, mydoxyfile=False, senfdoc_path=[],
+            **kw):
+    # Additional interesting keyword arguments or environment variables:
+    #    PROJECTNAME, DOCLINKS, PROJECTEMAIL, COPYRIGHT, REVISION
+
+    global senfutildir
+    global tagfiles
+    libdir=os.path.join(senfutildir, 'lib')
+    
+    if tagfiles is None:
+        senfdocdir = None
+        senfdoc_path.extend(('senfdoc', '$SENFDIR', '$SENFDIR/manual',
+                             '$SENFDIR/share/doc/senf', '$SENFDIR/share/doc/libsenf-doc/html'))
+        for path in senfdoc_path:
+            path = env.Dir(path).get_path()
+            if os.path.exists(os.path.join(path, "doc/doclib.tag")):
+                senfdocdir = path
+                break
+        tagfiles = []
+        if senfdocdir is None:
+            if not env.GetOption('no_progress'):
+                print "(SENF documentation not found)"
+        else:
+            for dir, dirs, files in os.walk(senfdocdir):
+                tagfiles.extend([ os.path.join(dir,f) for f in files if f.endswith('.tag') ])
+                if dir.endswith('/doc') : 
+                    try: dirs.remove('html')
+                    except ValueError: pass
+                for d in dirs: 
+                    if d.startswith('.') : dirs.remove(d)
+    
+    if env.GetOption('clean'):
+        env.Clean('doc', env.Dir('doc'))
+        if not mydoxyfile:
+            env.Clean('doc', "Doxyfile")
+
+    if not mydoxyfile:
+        # Create Doxyfile NOW
+        site_tools.Yaptu.yaptuAction("Doxyfile", 
+                                     os.path.join(libdir, "Doxyfile.yap"),
+                                     env)
+
+    envvalues = [ env.Value('$PROJECTNAME'),
+                  env.Value('$DOCLINKS'),
+                  env.Value('$PROJECTEMAIL'),
+                  env.Value('$COPYRIGHT'),
+                  env.Value('$REVISION') ]
+
+    # The other files are created using dependencies
+    if doxyheader: 
+        doxyheader = env.CopyToDir(env.Dir("doc"), doxyheader)
+    else:
+        doxyheader = env.Yaptu("doc/doxyheader.html", os.path.join(libdir, "doxyheader.yap"), **kw)
+        env.Depends(doxyheader, envvalues)
+    if doxyfooter:
+        doxyfooter = env.CopyToDir(env.Dir("doc"), doxyfooter)
+    else:
+        doxyfooter = env.Yaptu("doc/doxyfooter.html", os.path.join(libdir, "doxyfooter.yap"), **kw)
+        env.Depends(doxyfooter, envvalues)
+    if doxycss:
+        doxycss = env.CopyToDir(env.Dir("doc"), doxycss)
+    else:
+        doxycss    = env.CopyToDir(env.Dir("doc"), os.path.join(libdir, "doxy.css"))
+
+    doc = env.Doxygen("Doxyfile",
+                      DOXYOPTS   = [ '--html', '--tagfiles', '"$TAGFILES"' ],
+                      DOXYENV    = { 'TOPDIR'     : env.Dir('#').abspath,
+                                     'LIBDIR'     : libdir,
+                                     'REVISION'   : '$REVISION',
+                                     'tagfiles'   : '$TAGFILES',
+                                     'output_dir' : 'doc',
+                                     'html_dir'   : 'html',
+                                     'html'       : 'YES',
+                                     'DOXYGEN'    : '$DOXYGEN' },
+                      TAGFILES   = tagfiles, 
+                      DOCLIBDIR  = libdir,
+                      DOXYGENCOM = "$DOCLIBDIR/doxygen.sh $DOXYOPTS $SOURCE")
+
+    env.Depends(doc, [ doxyheader, doxyfooter, doxycss ])
+
+    return doc