Autogenerate search.php from the html templates
[senf.git] / senfscons / SENFSCons.py
index 9d243ce..623bbc7 100644 (file)
@@ -5,7 +5,7 @@
 # \brief Build helpers and utilities
 #
 # The SENFSCons package contains a number of build helpers and
-# utilities which are used to simplify commmon tasks. 
+# utilities which are used to simplify commmon tasks.
 #
 # The utitlities of this package are grouped into:
 # <dl><dt>\ref use</dt><dd>help using complex environments and
 # All other functions are for internal use only.
 
 import os.path, glob
-import  SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS, SCons.Defaults
+import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS
+import SCons.Defaults, SCons.Action
 
 ## \defgroup use Predefined Framework Configurators
 #
 # The following framework configurators are used in the top level \c
-# SConstruct file to simplify more complex configurations. 
+# SConstruct file to simplify more complex configurations.
 #
 # Each of the framework configurators introduces additional
 # configuration parameters to \ref sconfig
@@ -247,7 +248,7 @@ def GlobSources(exclude=[]):
     testSources = glob.glob("*.test.cc")
     sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
     return (sources, testSources)
-    
+
 ## \brief Add generic standard targets for every module
 #
 # This target helper should be called in the top-level \c SConstruct file
@@ -255,7 +256,7 @@ def GlobSources(exclude=[]):
 # targets. Right now, these are
 # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on
 #   <tt>scons -c all</tt>
-# 
+#
 # \ingroup target
 def StandardTargets(env):
     env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ])
@@ -363,6 +364,7 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
         if isinstance(doc,SCons.Node.FS.Dir): continue
         if doc.name == 'xml.stamp' : xmlnode = doc
         if doc.name == 'html.stamp' : htmlnode = doc
+        if doc.name == 'search.idx' : continue
         if os.path.splitext(doc.name)[1] == '.stamp' : continue # ignore other file stamps
         # otherwise it must be the tag file
         tagnode = doc
@@ -372,24 +374,27 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
         # references
         env.AddPostAction(
             docs,
-            env.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
+            SCons.Action.Action("xsltproc --nonet -o %(target)s.temp %(template)s %(target)s && mv %(target)s.temp %(target)s"
                        % { 'target': tagnode.abspath,
                            'template': os.path.join(basedir,"tagmunge.xsl") }))
 
     if htmlnode and env.get('DOXY_HTML_XSL'):
         xslfile = env.File(env['DOXY_HTML_XSL'])
+        reltopdir = '../' * len(htmlnode.dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
+        if reltopdir : reltopdir = reltopdir[:-1]
+        else         : reltopdir = '.'
         env.AddPostAction(
             docs,
-            env.Action(("for html in %s/*.html; do " +
+            SCons.Action.Action(("for html in %s/*.html; do " +
                         "    echo $$html;" +
                         "    sed -e 's/id=\"current\"/class=\"current\"/' $${html}" +
                         "        | tidy -ascii -q --show-warnings no --fix-uri no" +
-                        "        | xsltproc --nonet --html -o $${html}.new %s - 2>&1" +
+                        "        | xsltproc --nonet --html --stringparam topdir %s -o $${html}.new %s - 2>&1" +
                         "        | grep '^-'" +
                         "        | grep -v 'ID .* already defined';" +
                         "    mv $${html}.new $${html}; " +
                         "done")
-                       % (htmlnode.dir.abspath, xslfile.abspath)))
+                       % (htmlnode.dir.abspath, reltopdir, xslfile.abspath)))
         for doc in docs:
             env.Depends(doc,xslfile)
 
@@ -399,7 +404,7 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []):
             xref = os.path.join(xmlnode.dir.abspath,type+".xml")
             xref_pp = env.Command(xref+'i', [ xref, os.path.join(basedir,'xrefxtract.xslt'), xmlnode ],
                                   [ "test -s $SOURCE && xsltproc -o $TARGET" +
-                                    " --stringparam module $MODULE" + 
+                                    " --stringparam module $MODULE" +
                                     " --stringparam type $TYPE" +
                                     " ${SOURCES[1]} $SOURCE || touch $TARGET" ],
                                   MODULE = xmlnode.dir.dir.dir.name,
@@ -447,18 +452,33 @@ def DoxyXRef(env, docs=None,
     if HTML_HEADER:
         commands.append(
             "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[2]} > $TARGET")
-    commands.append("xsltproc --stringparam title '$TITLE' ${SOURCES[1]} $SOURCE >> $TARGET")
+    commands.append("xsltproc --stringparam title '$TITLE' --stringparam types '$DOXY_XREF_TYPES' ${SOURCES[1]} $SOURCE >> $TARGET")
     if HTML_FOOTER:
         commands.append(
             "sed -e 's/\\$$title/$TITLE/g' -e 's/\\$$projectname/Overview/g' ${SOURCES[%d]} >> $TARGET"
             % (HTML_HEADER and 3 or 2))
-    
+
     xref = env.Command("doc/html/xref.html", sources, commands,
                        TITLE = TITLE)
 
     env.Alias('all_docs',xref)
     return xref
 
+
+def DoxySearch(env, docs=None):
+    if docs is None:
+        docs = env.Alias('all_docs')[0].sources
+    indices = [ doc for doc in docs if doc.name == "search.idx" ]
+    commands = [ "echo '<?php function paths() { return array(' >$TARGET" ]
+    root = env.Dir('#').abspath
+    commands.extend([ "echo '\"..%s/\",' >>$TARGET" % index.dir.abspath[len(root):]
+                      for index in indices  ])
+    commands.append("echo '); } ?>' >>$TARGET" )
+    target = env.Command("doc/html/search_paths.php", indices, commands)
+    env.Alias('all_docs', target)
+    return target
+
+
 ## \brief Build library
 #
 # This target helper will build the given library. The library will be