X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=site_scons%2FSENFSCons.py;h=7b1f8433a2da1e77debe2249744ea63b2be6d3ce;hb=ad287a6e1241649e73188edf5b8902e4e65f615d;hp=ba49af59335b3c5232610f377f2c39eaf204710c;hpb=d33cd468d4ece7c0c98270b4d1a9858e5a94510d;p=senf.git

diff --git a/site_scons/SENFSCons.py b/site_scons/SENFSCons.py
index ba49af5..7b1f843 100644
--- a/site_scons/SENFSCons.py
+++ b/site_scons/SENFSCons.py
@@ -21,10 +21,10 @@ 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 doclib/doxygen.sh. We
-    # thus have to provide all necessary definitions here manually via DOXYENV !
+    # 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 !
 
     if type(doxyfile) is type(""):
         doxyfile = env.File(doxyfile)
@@ -34,48 +34,54 @@ 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 };
+    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,
-                                           'output_dir'      : 'doc',
-                                           'html_dir'        : 'html',
-                                           'html'            : 'NO',
-                                           'generate_tagfile': 'doc/${MODULE}.tag' },
-                              MODULE   = module )
-        env.Append(ALL_TAGFILES = tagfile[0].abspath)
-        env.Depends(tagfile, env.File('#/doclib/doxygen.sh'))
+        tagfile = env.Doxygen(doxyfile, DOXYOPTS = opts + [ '--tagfile' ],
+                              **vars(generate_tagfile='doc/${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') ])
+
+        env.Install(env.Dir('$DOCINSTALLDIR').Dir(tagfile[0].dir.get_path(env.Dir('#'))),
+                    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,
-                                   'tagfiles'        : '${ALL_TAGFILES}',
-                                   'output_dir'      : 'doc',
-                                   'html_dir'        : 'html',
-                                   'html'            : 'YES' } )
-    env.Depends(doc, env.File('#/doclib/doxygen.sh'))
+    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') ])
 
     # 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.InstallDir(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.dir.get_path(env.Dir('#'))), doc[0].dir,
+                   FILTER_SUFFIXES=['.html','.css','.png','.php','.idx'])
 
     # 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 +93,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)