doclib/SConscript

   1 # -*- python -*-
   2
   3 Import('env')
   4 import SENFSCons
   5
   6 ###########################################################################
   7
   8 import yaptu
   9
  10 def modules():
  11     # Naja ... etwas rumgehackt aber was solls ...
  12     global EXTRA_MODULES
  13     mods = {}
  14     ix = len(env.Dir('#').abspath)+1
  15     ex = dict((env.Dir(p).abspath,True) for n,p in EXTRA_MODULES)
  16     for module in env.Alias('all_docs')[0].sources:
  17         if module.name != 'html.stamp' : continue
  18         if not ex.get(module.dir.abspath):
  19             mods[module.dir.dir.dir.abspath] = [ module.dir.dir.dir.name, module.dir.abspath[ix:], 0 ]
  20     rv = []
  21     keys = mods.keys()
  22     keys.sort()
  23     for mod in keys:
  24         i = 0
  25         while i < len(rv):
  26             if mod.startswith(rv[i] + '/'):
  27                 level = mods[rv[i]][2] + 1
  28                 i += 1
  29                 while i < len(rv) and mods[rv[i]][2] >= level:
  30                     i += 1
  31                 rv[i:i] = [ mod ]
  32                 mods[mod][2] = level
  33                 break
  34             i += 1
  35         if i == len(rv):
  36             rv.append(mod)
  37     return [ (name, env.Dir(path).abspath[ix:], 0) for name,path in EXTRA_MODULES
  38              ] + [ ( (((not mods[mod][2]) and 'lib') or '') + mods[mod][0],
  39                      mods[mod][1],
  40                      mods[mod][2])
  41                    for mod in rv ]
  42
  43 def indices():
  44     ix = len(env.Dir('#').abspath)+1
  45     return [ doc.dir.abspath[ix:]
  46              for doc in env.Alias('all_docs')[0].sources
  47              if doc.name == "search.idx" ]
  48
  49 def writeTemplate(target = None, source = None, env = None):
  50     file(target[0].abspath,"w").write(yaptu.process(str(env['TEMPLATE']), globals(), env.Dictionary()))
  51
  52 writeTemplate = env.Action(writeTemplate, varlist = [ 'TEMPLATE' ])
  53
  54 ###########################################################################
  55
  56 # Extra documentation modules which are handled (named) different from
  57 # library modules
  58 EXTRA_MODULES = [
  59     ('Overview', '#/doc/html'),
  60     ('Examples', '#/Examples/doc/html'),
  61     ('SENFSCons', '#/senfscons/doc/html') ]
  62
  63 HEADER = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  64 <html>
  65 <head>
  66 <title>$title</title>
  67 <link href="@TOPDIR@/doc/html/doxygen.css" rel="stylesheet" type="text/css">
  68 <link href="@TOPDIR@/doclib/senf.css" rel="stylesheet" type="text/css">
  69 <link rel="shortcut icon" href="@TOPDIR@/doclib/favicon.ico">
  70 <style type="text/css">
  71 div.tabs ul li.$projectname a { background-color: #EDE497; }
  72 </style>
  73 </head>
  74 <body>
  75
  76 <div id="head">
  77   <div id="title">
  78     <div id="title2">
  79       <div id="search">
  80         <form action="@TOPDIR@/doclib/search.php" method="get">
  81           Search: <input type="text" name="query" size="20" accesskey="s"/>
  82         </form>
  83       </div>
  84       <h1>SENF Extensible Network Framework</h1>
  85     </div>
  86   </div>
  87   <div id="subtitle">
  88     <ul>
  89       <li><a href="@TOPDIR@/doc/html/xref.html">Open Issues</a></li>
  90       <li><a class="ext" href="http://svn.berlios.de/wsvn/senf/?op=log&rev=0&sc=0&isdir=1">SVN ChangeLog</a></li>
  91       <li><a class="ext" href="http://developer.berlios.de/projects/senf">SENF @ BerliOS</a></li>
  92       <li><a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">Wiki</a></li>
  93       <li><a href="@TOPDIR@/doc/html/index.html">Home</a></li>
  94     </ul>
  95     <h2>${TITLE}</h2>
  96   </div>
  97 </div>
  98
  99 <div id="content1">
 100   <div id="content2">
 101     <div class="tabs menu">
 102       <ul>
 103 {{      for name, path, level in modules():
 104           <li class="${name} level${level}"><a href="@TOPDIR@/${path}/index.html">${name}</a></li>
 105 }}
 106       </ul>
 107     </div>"""
 108
 109 OVERVIEW_EXTRA_HEADER=""
 110
 111 FOOTER = """<hr style="width:0px;border:none;clear:both;margin:0;padding:0" />
 112   </div>
 113 </div>
 114 <div id="footer">
 115   <span>
 116     <a href="mailto:senf-dev@lists.berlios.de">Contact: senf-dev@lists.berlios.de</a> |
 117     Copyright &copy; 2006 Fraunhofer Gesellschaft, SatCom, Stefan Bund
 118   </span>
 119 </div>
 120 </body></html>"""
 121
 122 SEARCH_PHP="""
 123 <?php include 'search_functions.php'; ?>
 124 <?php search(); ?>"""
 125
 126 SEARCH_PATHS_PHP="""<?php
 127 function paths() {
 128   return array(
 129 {{  for index in indices():
 130       "../${index}/",
 131 }}
 132   );
 133 }
 134 ?>"""
 135
 136 env.Command('doxy-header.html', 'SConscript', writeTemplate,
 137             TEMPLATE = Literal(HEADER),
 138             TITLE = "Documentation and API reference")
 139 env.Command('doxy-header-overview.html', 'SConscript', writeTemplate,
 140             TEMPLATE = Literal(HEADER+OVERVIEW_EXTRA_HEADER),
 141             TITLE = "Introduction and Overview")
 142 env.Command('doxy-footer.html', 'SConscript', writeTemplate,
 143             TEMPLATE = Literal(FOOTER))
 144 env.Alias('all_docs',
 145           env.Command('search.php', [ 'html-munge.xsl', 'SConscript' ],
 146                       [ writeTemplate,
 147                         'xsltproc --nonet --html --stringparam topdir .. -o - $SOURCE $TARGET 2>/dev/null'
 148                             + "| sed"
 149                             +   r" -e 's/\[\[/<?/g' -e 's/\]\]/?>/g'"
 150                             +   r" -e 's/\$$projectname/Overview/g'"
 151                             +   r" -e 's/\$$title/Search results/g'"
 152                             +       "> ${TARGETS[0]}.tmp",
 153                         'mv ${TARGET}.tmp ${TARGET}' ],
 154                       TEMPLATE = Literal(HEADER
 155                                          + OVERVIEW_EXTRA_HEADER
 156                                          + SEARCH_PHP.replace('<?','[[').replace('?>',']]')
 157                                          + FOOTER),
 158                       TITLE = "Search results"))
 159 env.Alias('all_docs',
 160           env.Command('search_paths.php', 'SConscript', writeTemplate,
 161                       TEMPLATE = Literal(SEARCH_PATHS_PHP)))