Further top-dir cleanup and lcov target
[senf.git] / SConstruct
index 9538c95..cabb4bc 100644 (file)
@@ -8,6 +8,9 @@ import SENFSCons, senfutil
 
 env = Environment()
 
+env.Decider('MD5-timestamp')
+env.EnsureSConsVersion(1,2)
+
 # Load all the local SCons tools
 env.Tool('Doxygen')
 env.Tool('Dia2Png')
@@ -35,32 +38,13 @@ debbin       Build debian binary package
 linklint     Check links of doxygen documentation with 'linklint'
 fixlinks     Fix broken links in doxygen documentation
 valgrind     Run all tests under valgrind/memcheck
-
-Build parameters:
-
-final=1      Build optimized library without debug symbols
-debug=1      Link all binaries with debug symbols (slow!)
-syslayout=1  Install into system layout directories ($$PREFIX/lib, $$PREFIX/include etc)
-
-additionally, any construction environment variable may be set from the scons
-command line (see SConstruct file and SCons documentation for a list of variables).
+lcov         Generate test coverage output in doc/lcov and lcov.info
 """)
 
-class BuildTypeOptions:
-    def __init__(self, var):
-        self._var = var
-
-    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(
-   PKGDRAW                = 'doclib/pkgdraw',
-)
-
 env.Append(
-   ENV                    = { 'PATH' : os.environ.get('PATH') },
-   CLEAN_PATTERNS         = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*', '.sconsign' ],
+   ENV                    = { 'PATH' : os.environ.get('PATH'), 'HOME' : os.environ.get('HOME') },
+   CLEAN_PATTERNS         = [ '*~', '#*#', '*.pyc', 'semantic.cache', '.sconsign*',
+                              '*.gcno', '*.gcda', '*.gcov' ],
 
    CPPPATH                = [ '#' ],
    LOCALLIBDIR            = '#',
@@ -73,9 +57,11 @@ env.Append(
    LIBINSTALLDIR          = '$PREFIX${syslayout and "/lib" or ""}',
    BININSTALLDIR          = '$PREFIX${syslayout and "/bin" or ""}',
    INCLUDEINSTALLDIR      = '$PREFIX${syslayout and "/include" or ""}',
-   OBJINSTALLDIR          = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}',
-   DOCINSTALLDIR          = '$PREFIX/manual',
-   SCONSINSTALLDIR        = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}/site_scons',
+   CONFINSTALLDIR         = '${syslayout and "$LIBINSTALLDIR/senf" or "$PREFIX"}',
+   OBJINSTALLDIR          = '$CONFINSTALLDIR',
+   DOCINSTALLDIR          = '$PREFIX${syslayout and "/share/doc/senf" or "/manual"}',
+   SCONSINSTALLDIR        = '$CONFINSTALLDIR/site_scons',
+
    CPP_INCLUDE_EXTENSIONS = [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti' ],
    CPP_EXCLUDE_EXTENSIONS = [ '.test.hh' ],
 
@@ -89,34 +75,40 @@ env.Append(
    INLINE_OPTS            = [ '$INLINE_OPTS_NORMAL' ],
    CXXFLAGS               = [ '-Wall', '-Woverloaded-virtual', '-Wno-long-long', '$INLINE_OPTS',
                               '$CXXFLAGS_' ],
-   CXXFLAGS_              = BuildTypeOptions('CXXFLAGS'),
+   CXXFLAGS_              = senfutil.BuildTypeOptions('CXXFLAGS'),
    CXXFLAGS_final         = [ '-O3' ],
    CXXFLAGS_normal        = [ '-O0', '-g' ],
    CXXFLAGS_debug         = [ '$CXXFLAGS_normal' ],
 
    CPPDEFINES             = [ '$expandLogOption', '$CPPDEFINES_' ],
    expandLogOption        = senfutil.expandLogOption,
-   CPPDEFINES_            = BuildTypeOptions('CPPDEFINES'),
+   CPPDEFINES_            = senfutil.BuildTypeOptions('CPPDEFINES'),
    CPPDEFINES_final       = [ ],
    CPPDEFINES_normal      = [ 'SENF_DEBUG' ],
    CPPDEFINES_debug       = [ '$CPPDEFINES_normal' ],
 
    LINKFLAGS              = [ '-rdynamic', '$LINKFLAGS_' ],
-   LINKFLAGS_             = BuildTypeOptions('LINKFLAGS'),
+   LINKFLAGS_             = senfutil.BuildTypeOptions('LINKFLAGS'),
    LINKFLAGS_final        = [ ],
    LINKFLAGS_normal       = [ '-Wl,-S' ],
-   LINKFLAGS_debug        = [ ],
+   LINKFLAGS_debug        = [ '-g' ],
 )
 
 env.SetDefault(
-    LIBSENF   = "senf",
-    final     = 0,
-    debug     = 0,
-    syslayout = 0
+    LIBSENF           = "senf",
+    LCOV              = "lcov",
+    GENHTML           = "genhtml",
+    SCONS             = "./tools/scons -j$CONCURRENCY_LEVEL",
+    CONCURRENCY_LEVEL = env.GetOption('num_jobs') or 1,
 )
 
 # Set variables from command line
-env.Replace(**ARGUMENTS)
+senfutil.parseArguments(
+    env,
+    BoolVariable('final', 'Build final (optimized) build', False),
+    BoolVariable('debug', 'Link in debug symbols', False),
+    BoolVariable('syslayout', 'Install in to system layout directories (lib/, include/ etc)', False),
+)
 
 Export('env')
 
@@ -149,11 +141,24 @@ env.Depends(SENFSCons.Doxygen(env), env.Value(env['ENV']['REVISION']))
 #### libsenf.a
 libsenf = env.Library("$LOCALLIBDIR/${LIBSENF}${LIBADDSUFFIX}", env['ALLOBJECTS'])
 env.Default(libsenf)
-
 env.Install('$LIBINSTALLDIR', libsenf)
 
+def create(target, source, env): 
+    file(str(target[0]), 'w').write(source[0].get_contents()+"\n")
+env['BUILDERS']['CreateFile'] = Builder(action = create)
+
+conf = env.CreateFile("${LOCALLIBDIR}/${LIBSENF}${LIBADDSUFFIX}.conf", 
+                      env.Value(env.subst("$_CPPDEFFLAGS")))
+env.Default(conf)
+env.Install('$CONFINSTALLDIR', conf)
+
 #### install_all, default, all_tests, all
-env.Install('${SCONSINSTALLDIR}', 'site_scons/senfutil.py')
+env.Install('${SCONSINSTALLDIR}', [ 'site_scons/__init__.py',
+                                    'site_scons/senfutil.py',
+                                    'site_scons/yaptu.py' ])
+env.InstallDir('${SCONSINSTALLDIR}', [ 'site_scons/site_tools', 'site_scons/lib' ],
+               FILTER_SUFFIXES=[ '','.css','.pl','.py','.sh','.sty','.xml','.xsl','.yap' ])
+env.Install('${INCLUDEINSTALLDIR}', 'boost')
 
 env.Alias('install_all', env.FindInstalledFiles())
 env.Alias('default', DEFAULT_TARGETS)
@@ -170,16 +175,27 @@ env.PhonyTarget('valgrind', [ 'all_tests' ], [ """
             echo;
             echo "Running $$test";
             echo;
-            valgrind --tool=memcheck --error-exitcode=99 --suppressions=valgrind.sup 
+            valgrind --tool=memcheck --error-exitcode=99 --suppressions=tools/valgrind.sup 
                 $$test $BOOSTTESTARGS;
             [ $$? -ne 99 ] || exit 1;
         done
 """.replace("\n"," ") ])
 
+### lcov
+env.Alias('lcov', env.AlwaysBuild(
+    env.Command( [ env.Dir('doc/lcov'), 'lcov.info' ], [], [
+        '$SCONS debug=1 CCFLAGS+="-fprofile-arcs -ftest-coverage" LIBS+="gcov" all_tests',
+        '$LCOV --directory . --capture --output-file /tmp/senf_lcov.info --base-directory .',
+        '$LCOV --output-file ${TARGETS[1]} --remove /tmp/senf_lcov.info \\*/include/\\*',
+        '$GENHTML --output-directory ${TARGETS[0]} --title all_tests ${TARGETS[1]}',
+        'rm /tmp/senf_lcov.info' ])))
+
 #### clean
 env.Clean('all', '.prepare-stamp')
 env.Clean('all', libsenf)
 env.Clean('all', env.Dir('linklint')) # env.Dir to disambiguate from linklint PhonyTarget
+env.Clean('all', env.Dir('dist'))
+env.Clean('all', 'lcov.info')
 
 if env.GetOption('clean'):
     env.Clean('all', [ os.path.join(path,f)