Write _templates/SConscript sample file

[senf.git] / site_scons / SENFSCons.py

diff --git a/site_scons/SENFSCons.py b/site_scons/SENFSCons.py
index ba49af5..aed6649 100644 (file)
--- a/site_scons/SENFSCons.py
+++ b/site_scons/SENFSCons.py
@@ -46,8 +46,9 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
                                            'html'            : 'NO',
                                            'generate_tagfile': 'doc/${MODULE}.tag' },
                               MODULE   = module )
-        env.Append(ALL_TAGFILES = tagfile[0].abspath)
-        env.Depends(tagfile, env.File('#/doclib/doxygen.sh'))
+        env.Append(ALL_TAGFILES = [ tagfile[0].abspath ])
+        env.Depends(tagfile, [ env.File('#/doclib/doxygen.sh'), 
+                               env.File('#/doclib/tag-munge.xsl') ])
 
     # Rule to generate HTML documentation
     doc = env.Doxygen(doxyfile,
@@ -60,22 +61,24 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
                                    'output_dir'      : 'doc',
                                    'html_dir'        : 'html',
                                    'html'            : 'YES' } )
-    env.Depends(doc, env.File('#/doclib/doxygen.sh'))
+    env.Depends(doc, [ env.File('#/doclib/doxygen.sh'),
+                       env.File('#/doclib/html-munge.xsl') ])
 
     # Copy the extra_sources (the images) into the documentation directory
     # (need to exclude the 'clean' case otherwise there are multiple ways to clean the copies)
-    if not env.GetOption('clean'):
-        if extra_sources:
+    if extra_sources:
+        if env.GetOption('clean'):
+            env.Depends(doc, extra_sources)
+        else:
             env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources))
 
     # Install documentation into DOCINSTALLDIR
-    l = len(env.Dir('#').abspath)
-    env.Install(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.get_path('#')), doc[0].dir)
+    env.Install(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.dir.get_path(env.Dir('#'))), doc[0].dir)
 
     # Useful aliases
     env.Alias('all_docs', doc)
-    env.Clean('all_docs', doc)
-    env.Clean('all', doc)
+    env.Clean(env.Alias('all_docs'), doc)
+    env.Clean(env.Alias('all'), doc)
 
     return doc
 
@@ -87,4 +90,44 @@ def AllIncludesHH(env, exclude=[]):
     target = env.File("all_includes.hh")
     file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
                                              for f in headers ]))
-    env.Clean('all', target)
+    env.Clean(env.Alias('all'), target)
+
+###########################################################################
+# The following functions serve as simple macros for most SConscript files
+#
+# If you need to customize these rules, copy-and-paste the code into the
+# SConscript file and adjust at will (don't forget to replace the
+# parameters with their actual value. Parameters are marked with ((name)) )
+
+def AutoRules(env, exclude=[], subdirs=[], doc_extra_sources = []):
+    import SENFSCons
+
+    sources, tests, includes = SENFSCons.Glob(env, exclude=((exclude)), subdirs=((subdirs)) )
+    subscripts               = env.Glob("*/SConscript")
+    doxyfile                 = env.Glob("Doxyfile")
+
+    if sources               : env.Append(ALLOBJECTS = env.Object(sources))
+    if tests                 : env.BoostUnitTest('test', tests)
+    if includes              : env.InstallSubdir('$INCLUDEINSTALLDIR', includes)
+    if doxyfile              : SENFSCons.Doxygen(env, extra_sources=((doc_extra_sources)) )
+    if subscripts            : SConscript(subscripts)
+
+
+def AutoPacketBundle(env, name, exclude=[], subdirs=[], doc_extra_sources=[]):
+    import SENFSCons
+
+    sources, tests, includes = SENFSCons.Glob(env, exclude=((exclude)), subdirs=((subdirs)) )
+    subscripts               = env.Glob("*/SConscript")
+    doxyfile                 = env.Glob("Doxyfile")
+
+    objects = env.Object(sources)
+    cobject = env.CombinedObject('${LOCALLIBDIR}/${NAME}${OBJADDSUFFIX}', objects, NAME=((name)))
+
+    env.Default(cobject)
+    env.Append(ALLOBJECTS = objects, PACKET_BUNDLES = cobject)
+    env.Install('$OBJINSTALLDIR', cobject)
+
+    if tests                 : env.BoostUnitTest('test', tests + cobject)
+    if includes              : env.InstallSubdir('$INCLUDEINSTALLDIR', includes)
+    if doxyfile              : SENFSCons.Doxygen(env, extra_sources=((doc_extra_sources)) )
+    if subscripts            : SConscript(subscripts)