Fix example build
[senf.git] / SConstruct
index a18c65e..5ab04af 100644 (file)
@@ -1,85 +1,27 @@
 # -*- python -*-
 
-import sys, glob, os.path, datetime, pwd, time, fnmatch, string
-sys.path.append(Dir('#/senfscons').abspath)
-sys.path.append(Dir('#/doclib').abspath)
-import SENFSCons
-
-###########################################################################
-
-# This hack is needed for SCons V 0.96.1 compatibility. In current SCons versions
-# we can just use 'env.AlwaysBuild(env.Alias(target), [], action)'
-def PhonyTarget(env, target, action, sources=[]):
-    env.AlwaysBuild(env.Command(target + '.phony', [ 'SConstruct' ] + sources, env.Action(action)))
-    env.Alias(target, target + '.phony')
-
-def updateRevision(target, source, env):
-    rev = env['ENV']['REVISION'][1:]
-    if ':' in rev:
-        print
-        print "Working copy not clean. Run 'svn update'"
-        print
-        return 1
-    if 'm' in rev and not ARGUMENTS.get('force_deb'):
-        print
-        print "Working copy contains local changes. Commit first"
-        print
-        return 1
-    if 's' in rev:
-        rev = rev[:-1]
-    if 'm' in rev:
-        rev = rev[:-1]
-    url = None
-    for line in os.popen("svn info"):
-        elts=line.split(':',1)
-        if elts[0] == 'URL':
-            url = elts[1].strip()
-    version = None
-    if '/tags/' in url:
-        version = url.rsplit('/',1)[-1].split('_',1)[0]
-        if version[0] not in string.digits:
-            version = None
-    if version is None:
-        version = '1:0r%s' % rev
-    changelog = file('debian/changelog.template').read() % {
-        'version': version,
-        'rev': rev,
-        'user': pwd.getpwuid(os.getuid()).pw_gecos.split(',')[0].strip(),
-        'date': time.strftime("%a, %d %b %Y %H:%M:%S +0000", time.gmtime()) }
-    file('debian/changelog','w').write(changelog)
-
-def nonemptyFile(f):
-    try: return os.stat(f).st_size > 0
-    except OSError: return False
-
-def checkLocalConf(target, source, env):
-    if [ True for f in env['LOCAL_CONFIG_FILES'] if nonemptyFile(f) ]:
-        print
-        print "You have made local modifications to one of the following local configuration"
-        print "files:"
-        for f in env['LOCAL_CONFIG_FILES']:
-            print "    ",f
-        print
-        print "Building a debian package would remove those files."
-        print
-        print "To continue, remove the offending file(s) and try again. Alternatively,"
-        print "build a source package using 'scons debsrc' and may then build debian"
-        print "binary packages from this source-package without disrupting your local"
-        print "configuration."
-        print
-        return 1
+import sys, glob, os.path, fnmatch
+import SENFSCons, senfutil
 
 ###########################################################################
 # Load utilities and setup libraries and configure build
 
-SENFSCons.UseBoost()
-SENFSCons.UseSTLPort()
-env = SENFSCons.MakeEnvironment()
+env = Environment()
+
+# Load all the local SCons tools
+env.Tool('Doxygen')
+env.Tool('Dia2Png')
+env.Tool('PkgDraw')
+env.Tool('InstallSubdir')
+env.Tool('CopyToDir')
+env.Tool('Boost')
+env.Tool('CombinedObject')
+env.Tool('PhonyTarget')
 
 env.Help("""
 Additional top-level build targets:
 
-prepare      Create all source files not part of the repository
+prepare      Create all target files not part of the repository
 all_tests    Build and run unit tests for all modules
 all_docs     Build documentation for all modules
 all          Build everything
@@ -92,78 +34,77 @@ fixlinks     Fix broken links in doxygen documentation
 valgrind     Run all tests under valgrind/memcheck
 """)
 
-if os.environ.get('debian_build'):
-    rev = os.popen("dpkg-parsechangelog | awk '/^Version:/{print $2}'").read().strip()
-else:
-    rev = 'r' + os.popen("svnversion").read().strip().lower()
-
-logname = os.environ.get('LOGNAME')
-if not logname:
-    logname = pwd.getpwuid(os.getuid()).pw_name
-
-def dpkgIgnoredFilesOpts(target, source, env, for_signature):
-    return [ '-I%s' % (('/' in f) and (os.path.split(os.getcwd())[1])+f or f)
-             for f in env.subst('$DPKG_IGNORED_FILES').split() ]
-
-# Options used to debug inlining:
-#
-# INLINE_OPTS = [ '-finline-limit=20000', '--param','large-function-growth=10000',
-#                 '--param', 'large-function-insns=10000', '--param','inline-unit-growth=10000',
-#                 '-fvisibility-inlines-hidden', '-fno-inline-functions', '-Winline' ]
-#
-# BEWARE: You need lots of ram to compile with these settings (approx 1G)
-#
+class BuildTypeOptions:
+    def __init__(self, var):
+        self._var = var
 
-INLINE_OPTS = [ '-finline-limit=5000' ]
-
-env.Append(
-   CPPPATH = [ '#/include' ],
-   CXXFLAGS = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long' ] + INLINE_OPTS,
-   LIBS = [ 'rt', '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
-            '$BOOSTFSLIB' ],
-   TEST_EXTRA_LIBS = [ ],
-   ENV = { 'TODAY' : str(datetime.date.today()),
-           'REVISION' : rev,
-           'LOGNAME' : logname, # needed by the debian build scripts
-           'CONCURRENCY_LEVEL' : env.GetOption('num_jobs') or "1",
-           'SCONS' : 1,
-           'PATH' : os.environ.get('PATH'),
-          'TEXINPUTS' : os.environ.get('TEXINPUTS',env.Dir('#/doclib').abspath + ':'),
-           'DOXYGEN' : os.environ.get('DOXYGEN', 'doxygen'),
-         },
-   LOCAL_CONFIG_FILES = [ '/Doxyfile.local', '/SConfig', '/local_config.hh' ],
-   DPKG_IGNORED_FILES = [ '$LOCAL_CONFIG_FILES', '.svn', '/_templates' ],
-   DPKG_IGNORED_FILES_OPTS = dpkgIgnoredFilesOpts,
-   CLEAN_PATTERNS = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign', '.sconsign.dblite' ],
-   BUILDPACKAGE_COMMAND = "dpkg-buildpackage -us -uc -rfakeroot $DPKG_IGNORED_FILES_OPTS",
-   TOP_INCLUDES = [ 'Packets', 'PPI', 'Scheduler', 'Socket', 'Utils', 'Console',
-                    'config.hh', 'local_config.hh' ],
-   ALL_TAGFILES = []
-)
+    def __call__(self, target, source, env, for_signature):
+        type = env['final'] and "final" or env['debug'] and "debug" or "normal"
+        return env[self._var + "_" + type]
 
 env.Replace(
-   DOXYGENCOM = "doclib/doxygen.sh $DOXYOPTS $SOURCE",
+   PKGDRAW                = 'doclib/pkgdraw',
 )
 
-def parseLogOption(value):
-    stream, area, level = ( x.strip() for x in value.strip().split('|') )
-    if stream  : stream = ''.join('(%s)' % x for x in stream.split('::') )
-    else       : stream = '(_)'
-    if area : area = ''.join( '(%s)' % x for x in area.split('::') )
-    else    : area = '(_)'
-    return '(( %s,%s,%s ))' % (stream,area,level)
-
-def expandLogOption(target, source, env, for_signature):
-    return ' '.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() )
-
-if env.subst('$LOGLEVELS'):
-    env.Append( expandLogOption=expandLogOption )
-    env.Append( CPPDEFINES = { 'SENF_LOG_CONF': '$expandLogOption' } )
+env.Append(
+   ENV                    = { 'PATH' : os.environ.get('PATH') },
+   CLEAN_PATTERNS         = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*', '.sconsign' ],
+
+   CPPPATH                = [ '#' ],
+   LOCALLIBDIR            = '#',
+   LIBPATH                = [ '$LOCALLIBDIR' ],
+   LIBS                   = [ '$LIBSENF$LIBADDSUFFIX', 'rt', '$BOOSTREGEXLIB', 
+                              '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB', '$BOOSTFSLIB' ], 
+   TEST_EXTRA_LIBS        = [  ],
+
+   PREFIX                 = '#/dist',
+   LIBINSTALLDIR          = '$PREFIX${syslayout and "/lib" or ""}',
+   BININSTALLDIR          = '$PREFIX${syslayout and "/bin" or ""',
+   INCLUDEINSTALLDIR      = '$PREFIX${syslayout and "/include" or ""}',
+   OBJINSTALLDIR          = '$LIBINSTALLDIR${syslayout and "/$LIBINSTALLDIR/senf" or ""',
+   DOCINSTALLDIR          = '$PREFIX/docs',
+   CPP_INCLUDE_EXTENSIONS = [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti' ],
+   CPP_EXCLUDE_EXTENSIONS = [ '.test.hh' ],
+
+   # These options are insane. Only useful for inline debugging. Need at least 1G free RAM
+   INLINE_OPTS_DEBUG      = [ '-finline-limit=20000', '-fvisibility-inlines-hidden', 
+                              '-fno-inline-functions', '-Winline' 
+                              '--param','large-function-growth=10000',
+                              '--param', 'large-function-insns=10000', 
+                              '--param','inline-unit-growth=10000' ],
+   INLINE_OPTS_NORMAL     = [ '-finline-limit=5000' ],
+   INLINE_OPTS            = [ '$INLINE_OPTS_NORMAL' ],
+   CXXFLAGS               = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long', '$INLINE_OPTS',
+                              '$CXXFLAGS_' ],
+   CXXFLAGS_              = BuildTypeOptions('CXXFLAGS'),
+   CXXFLAGS_final         = [ '-O3' ],
+   CXXFLAGS_normal        = [ '-O0', '-g' ],
+   CXXFLAGS_debug         = [ '$CXXFLAGS_normal' ],
+
+   CPPDEFINES             = [ '$expandLogOption', '$CPPDEFINES_' ],
+   expandLogOption        = senfutil.expandLogOption,
+   CPPDEFINES_            = BuildTypeOptions('CPPDEFINES'),
+   CPPDEFINES_final       = [ ],
+   CPPDEFINES_normal      = [ 'SENF_DEBUG' ],
+   CPPDEFINES_debug       = [ '$CPPDEFINES_normal' ],
+
+   LINKFLAGS              = [ '-rdynamic', '$LINKFLAGS_' ],
+   LINKFLAGS_             = BuildTypeOptions('LINKFLAGS'),
+   LINKFLAGS_final        = [ ],
+   LINKFLAGS_normal       = [ '-Wl,-S' ],
+   LINKFLAGS_debug        = [ ],
+)
 
 env.SetDefault(
-       LIBSENF = "senf"
+    LIBSENF   = "senf",
+    final     = 0,
+    debug     = 0,
+    syslayout = 0
 )
 
+# Set variables from command line
+env.Replace(**ARGUMENTS)
+
 Export('env')
 
 # Create Doxyfile.local otherwise doxygen will barf on this non-existent file
@@ -171,38 +112,59 @@ Export('env')
 if not os.path.exists("Doxyfile.local"):
     Execute(Touch("Doxyfile.local"))
 
-# Create local_config.h
-if not env.GetOption('clean') and not os.path.exists("local_config.hh"):
-    Execute(Touch("local_config.hh"))
-
-###########################################################################
-# Define build targets
-
-# Before defining any targets, check wether this is the first build in
-# pristine directory tree. If so, call 'scons prepare' so the dependencies
-# created later are correct
-
 if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \
    and not os.environ.get("SCONS") and COMMAND_LINE_TARGETS != [ 'prepare' ]:
     env.Execute([ "scons prepare" ])
 
-env.Clean('all', '.prepare-stamp')
+# Load SConscripts
 
-SConscript(glob.glob("*/SConscript"))
+SConscriptChdir(0)
+SConscript("debian/SConscript")
+SConscriptChdir(1)
+if os.path.exists('SConscript.local') : SConscript('SConscript.local')
+SConscript("senf/SConscript")
+SConscript("Examples/SConscript")
+SConscript("HowTos/SConscript")
+SConscript("doclib/SConscript")
 
-SENFSCons.StandardTargets(env)
-SENFSCons.GlobalTargets(env)
-env.Depends( SENFSCons.Doxygen(env), env.Value(rev) )
+###########################################################################
+# Define build targets
 
-SENFSCons.InstallIncludeFiles(env, [ 'config.hh' ])
+#### doc
+env.Depends(SENFSCons.Doxygen(env), env.Value(env['ENV']['REVISION']))
 
-# Build combined library 'libsenf'
-libsenf = env.Library(env.subst("$LIBSENF$LIBADDSUFFIX"), env['ALLOBJECTS'])
+#### libsenf.a
+libsenf = env.Library("$LOCALLIBDIR/${LIBSENF}${LIBADDSUFFIX}", env['ALLOBJECTS'])
 env.Default(libsenf)
-env.Clean('all', libsenf)
-env.Alias('default', libsenf)
 
-env.Alias('install_all', env.Install('$LIBINSTALLDIR', libsenf))
+env.Install('$LIBINSTALLDIR', libsenf)
+
+#### install_all, default, all_tests, all
+env.Alias('install_all', env.FindInstalledFiles())
+env.Alias('default', DEFAULT_TARGETS)
+env.Alias('all_tests', env.FindAllBoostUnitTests())
+env.Alias('all', [ 'default', 'all_tests', 'examples', 'all_docs' ])
+
+#### prepare
+env.PhonyTarget('prepare', [], [])
+
+#### valgrind
+env.PhonyTarget('valgrind', [ 'all_tests' ], [ """
+    find -name .test.bin 
+        | while read test; do
+            echo;
+            echo "Running $$test";
+            echo;
+            valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup 
+                $$test $BOOSTTESTARGS;
+            [ $$? -ne 99 ] || exit 1;
+        done
+""".replace("\n"," ") ])
+
+#### clean
+env.Clean('all', '.prepare-stamp')
+env.Clean('all', libsenf)
+env.Clean('all', env.Dir('linklint')) # env.Dir to disambiguate from linklint PhonyTarget
 
 if env.GetOption('clean'):
     env.Clean('all', [ os.path.join(path,f)
@@ -210,47 +172,5 @@ if env.GetOption('clean'):
                        for pattern in env['CLEAN_PATTERNS']
                        for f in fnmatch.filter(files,pattern) ])
 
-PhonyTarget(env, 'deb', [
-    checkLocalConf,
-    updateRevision,
-    "$BUILDPACKAGE_COMMAND",
-    "fakeroot ./debian/rules debclean"
-])
-
-PhonyTarget(env, 'debsrc', [
-    updateRevision,
-    "$BUILDPACKAGE_COMMAND -S",
-])
-
-PhonyTarget(env, 'debbin', [
-    checkLocalConf,
-    updateRevision,
-    "$BUILDPACKAGE_COMMAND -b",
-    "fakeroot ./debian/rules debclean"
-])
-
-PhonyTarget(env, 'linklint', [
-    'rm -rf linklint',
-    'linklint -doc linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
-    '[ ! -r linklint/errorX.html ] || python doclib/linklint_addnames.py <linklint/errorX.html >linklint/errorX.html.new',
-    '[ ! -r linklint/errorX.html.new ] || mv linklint/errorX.html.new linklint/errorX.html',
-    '[ ! -r linklint/errorAX.html ] || python doclib/linklint_addnames.py <linklint/errorAX.html >linklint/errorAX.html.new',
-    '[ ! -r linklint/errorAX.html.new ] || mv linklint/errorAX.html.new linklint/errorAX.html',
-    'echo -e "\\nLokal link check results: linklint/index.html\\nRemote link check results: linklint/urlindex.html\\n"',
-])
-
-PhonyTarget(env, 'fixlinks', [
-    'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt',
-])
-
-PhonyTarget(env, 'prepare', [ 'true' ])
-
-PhonyTarget(env, 'valgrind', [
-    'find -name .test.bin | while read test; do echo; echo "Running $$test"; echo; valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup $$test $BOOSTTESTARGS; [ $$? -ne 99 ] || exit 1; done'
-    ], [ 'all_tests' ])
-
-env.Clean('all', env.Dir('linklint'))
-
-env.Clean('all','.prepare-stamp')
 if not env.GetOption('clean') and not os.path.exists(".prepare-stamp"):
     Execute(Touch(".prepare-stamp"))