Buildsystem updates

[senf.git] / site_scons / SENFSCons.py

diff --git a/site_scons/SENFSCons.py b/site_scons/SENFSCons.py
index 1f082b9..7ff6272 100644 (file)
--- a/site_scons/SENFSCons.py
+++ b/site_scons/SENFSCons.py
@@ -1,4 +1,4 @@
-import os.path, glob
+import os.path, glob, yaptu
 import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS
 import SCons.Defaults, SCons.Action
 from SCons.Script import *
@@ -21,7 +21,7 @@ def Glob(env, exclude=[], subdirs=[]):
                 includes.append(p)
     return ( sources, testSources, includes )
 
-def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
+def Doxygen(env, doxyfile = "Doxyfile", extra_sources = [], output_directory = "doc"):
     # There is one small problem we need to solve with this builder: The Doxygen builder reads
     # the Doxyfile and thus depends on the environment variables set by site_scons/lib/doxygen.sh.
     # We thus have to provide all necessary definitions here manually via DOXYENV !
@@ -34,19 +34,27 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
     module = doxyfile.dir.get_path(env.Dir('#')).replace('/','_')
     if module == '.' : module = "Main"
 
+    # Standard doc build vars and opts
+    def vars(env=env, **kw):
+        denv = { 'TOPDIR'          : env.Dir('#').abspath,
+                 'LIBDIR'          : env.Dir('#/site_scons/lib').abspath,
+                 'output_dir'      : '$OUTPUT_DIRECTORY',
+                 'html_dir'        : 'html',
+                 'html'            : 'NO' }
+        denv.update(kw)
+        return { 'DOXYENV'         : denv,
+                 'MODULE'          : module,
+                 'OUTPUT_DIRECTORY': output_directory,
+                 'DOXYGENCOM'      : "site_scons/lib/doxygen.sh $DOXYOPTS $SOURCE",
+                 };
+    opts = [ '--tagfile-name', '"${MODULE}.tag"',
+             '--output-dir', '$OUTPUT_DIRECTORY' ]
+
     # Rule to generate tagfile
     # (need to exclude the 'clean' case, otherwise we'll have duplicate nodes)
     if not env.GetOption('clean'):
-        tagfile = env.Doxygen(doxyfile,
-                              DOXYOPTS = [ '--tagfile-name', '"${MODULE}.tag"',
-                                           '--tagfile' ],
-                              DOXYENV  = { 'TOPDIR'          : env.Dir('#').abspath,
-                                           'LIBDIR'          : env.Dir('#/site_scons/lib').abspath,
-                                           'output_dir'      : 'doc',
-                                           'html_dir'        : 'html',
-                                           'html'            : 'NO',
-                                           'generate_tagfile': 'doc/${MODULE}.tag' },
-                              MODULE   = module )
+        tagfile = env.Doxygen(doxyfile, DOXYOPTS = opts + [ '--tagfile' ],
+                              **vars(generate_tagfile='${OUTPUT_DIRECTORY}/${MODULE}.tag'))
         env.Append(ALL_TAGFILES = [ tagfile[0].abspath ])
         env.Depends(tagfile, [ env.File('#/site_scons/lib/doxygen.sh'), 
                                env.File('#/site_scons/lib/tag-munge.xsl') ])
@@ -55,17 +63,8 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
                     tagfile[0])
 
     # Rule to generate HTML documentation
-    doc = env.Doxygen(doxyfile,
-                      DOXYOPTS = [ '--tagfiles', '"$ALL_TAGFILES"',
-                                   '--tagfile-name', '"${MODULE}.tag"',
-                                   '--html' ],
-                      MODULE   = module,
-                      DOXYENV  = { 'TOPDIR'          : env.Dir('#').abspath,
-                                   'LIBDIR'          : env.Dir('#/site_scons/lib').abspath,
-                                   'tagfiles'        : '${ALL_TAGFILES}',
-                                   'output_dir'      : 'doc',
-                                   'html_dir'        : 'html',
-                                   'html'            : 'YES' } )
+    doc = env.Doxygen(doxyfile, DOXYOPTS = opts + [ '--tagfiles', '"$ALL_TAGFILES"', '--html' ],
+                      **vars(html='YES', tagfiles='$ALL_TAGFILES'))
     env.Depends(doc, [ env.File('#/site_scons/lib/doxygen.sh'),
                        env.File('#/site_scons/lib/html-munge.xsl') ])
 
@@ -75,7 +74,7 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
         if env.GetOption('clean'):
             env.Depends(doc, extra_sources)
         else:
-            env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources))
+            env.Depends(tagfile, env.CopyToDir(doc[0].dir, extra_sources))
 
     # Install documentation into DOCINSTALLDIR
     env.InstallDir(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.dir.get_path(env.Dir('#'))), doc[0].dir,
@@ -98,6 +97,37 @@ def AllIncludesHH(env, exclude=[]):
                                              for f in headers ]))
     env.Clean(env.Alias('all'), target)
 
+
+INDEXPAGE="""
+/** \mainpage ${TITLE}
+
+    ${TEXT}
+
+    \htmlonly
+    <dl>
+
+{{  for name, title in SUBPAGES:
+      <dt><a href="../../${name}/doc/html/index.html">${name}</a></dt><dd>${title}</a></dd>
+}}
+
+    </dl>
+    \endhtmlonly
+ */
+"""
+
+def IndexPage(env, name, title, text=""):
+    SUBPAGES = []
+    for dox in sorted(glob.glob("*/Mainpage.dox")):
+        subtitle = ([None] + [ line.split('\\mainpage',1)[-1].strip() for line in file(dox)
+                               if '\\mainpage' in line ])[-1]
+        if subtitle:
+            SUBPAGES.append( (dox.split('/',1)[0], subtitle) )
+    file(name,"w").write(yaptu.process(
+            INDEXPAGE, globals(), { 'TITLE': title, 'TEXT': text, 'SUBPAGES': SUBPAGES }))
+    env.Clean('all',name)
+    env.Clean('all_docs',name)
+
+
 ###########################################################################
 # The following functions serve as simple macros for most SConscript files
 #