doclib: Clean up documentation generation
[senf.git] / SConstruct
index 5fd8c88..cc4dc67 100644 (file)
@@ -8,8 +8,8 @@ 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):
-    env.AlwaysBuild(env.Command(target + '.phony', 'SConstruct', env.Action(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):
@@ -41,16 +41,57 @@ def nonemptyFile(f):
 def checkLocalConf(target, source, env):
     if [ True for f in env['CONFIG_FILES'] if nonemptyFile(f) ]:
         print
-        print "You have made local modifications to 'SConfig' and/or 'Doxyfile.local'."
+        print "You have made local modifications to one of the following local configuration"
+        print "files:"
+        for f in env['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 print local"
+        print "binary packages from this source-package without disrupting your local"
         print "configuration."
         print
         return 1
 
+def getLibDepends(script):
+    # OUCH ...
+    return os.popen("perl -0777 -n -e '$,=\" \"; print $1=~m/'\"'\"'([^'\"'\"']*)'\"'\"'/g if /LIBS\s*=\s*\[([^\]]*)\]/' %s" % script).read().split()
+
+# Original topological sort code written by Ofer Faigon
+# (www.bitformation.com) and used with permission
+def topological_sort(items, partial_order):
+    """Perform topological sort.
+       items is a list of items to be sorted.
+       partial_order is a list of pairs. If pair (a,b) is in it, it means
+       that item a should appear before item b.
+       Returns a list of the items in one of the possible orders, or None
+       if partial_order contains a loop.
+    """
+    def add_node(graph, node):
+        if not graph.has_key(node):
+            graph[node] = [0] 
+    def add_arc(graph, fromnode, tonode):
+        graph[fromnode].append(tonode)
+        graph[tonode][0] = graph[tonode][0] + 1
+    graph = {}
+    for v in items:
+        add_node(graph, v)
+    for a,b in partial_order:
+        add_arc(graph, a, b)
+    roots = [node for (node,nodeinfo) in graph.items() if nodeinfo[0] == 0]
+    while len(roots) != 0:
+        root = roots.pop()
+        yield root
+        for child in graph[root][1:]:
+            graph[child][0] = graph[child][0] - 1
+            if graph[child][0] == 0:
+                roots.append(child)
+        del graph[root]
+    if len(graph.items()) != 0:
+        raise RuntimeError, "Loop detected in partial_order"
+
 ###########################################################################
 # Load utilities and setup libraries and configure build
 
@@ -71,6 +112,7 @@ debsrc       Build debian source package
 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
 """)
 
 if os.environ.get('debian_build'):
@@ -94,8 +136,8 @@ env.Append(
            'REVISION' : rev,
            'LOGNAME' : logname, # needed by the debian build scripts
            'CONCURRENCY_LEVEL' : env.GetOption('num_jobs') or "1",
-           'SCONS' : 1
-           },
+           'SCONS' : 1,
+         },
    CONFIG_FILES = [ 'Doxyfile.local', 'SConfig', 'local_config.hh' ],
    CONFIG_FILES_OPTS = configFilesOpts,
    CLEAN_PATTERNS = [ '*.pyc', 'semantic.cache', '.sconsign', '.sconsign.dblite' ],
@@ -122,13 +164,25 @@ if not env.GetOption('clean') and not os.path.exists("local_config.hh"):
 # created later are correct
 
 if not env.GetOption('clean') and not os.path.exists(".prepare-stamp") \
-   and not os.environ.get("SCONS"):
+   and not os.environ.get("SCONS") and COMMAND_LINE_TARGETS != [ 'prepare' ]:
     env.Execute([ "scons prepare" ])
 
 env.Clean('all', '.prepare-stamp')
 
-SConscript(glob.glob("*/SConscript"))
+# Not nice, but until we get to fixing the dependency jungle
+# concerning generated sources ...
+scripts = []
+dependencies = []
 
+for script in glob.glob("*/SConscript"):
+    depends = getLibDepends(script)
+    script = script.split('/',1)[0]
+    scripts.append(script)
+    dependencies += [ (dep, script) for dep in depends ]
+
+for subdir in topological_sort(scripts, dependencies):
+    SConscript(os.path.join(subdir, "SConscript"))
+    
 SENFSCons.StandardTargets(env)
 SENFSCons.GlobalTargets(env)
 SENFSCons.Doxygen(env)
@@ -172,10 +226,10 @@ PhonyTarget(env, 'debbin', [
 
 PhonyTarget(env, 'linklint', [
     'rm -rf linklint',
-    'linklint -doc linklint -net -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
-    '[ ! -r linklint/errorX.html ] || python linklint_addnames.py <linklint/errorX.html >linklint/errorX.html.new',
+    '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 linklint_addnames.py <linklint/errorAX.html >linklint/errorAX.html.new',
+    '[ ! -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"',
 ])
@@ -186,6 +240,10 @@ PhonyTarget(env, 'fixlinks', [
 
 PhonyTarget(env, 'prepare', [])
 
+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')