-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 *
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)
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,
- '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'),
- env.File('#/doclib/tag-munge.xsl') ])
+ 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') ])
+
+ 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'),
- env.File('#/doclib/html-munge.xsl') ])
+ 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:
- env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources))
+ if extra_sources:
+ if env.GetOption('clean'):
+ env.Depends(doc, extra_sources)
+ else:
+ env.Depends(tagfile, 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
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)
+
+
+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
+#
+# 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)
projects / senf.git / blobdiff