# \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
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
# 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' ])
# provide both \a sources and \a testSources.
#
# \ingroup target
-def Objects(env, sources, testSources = None, LIBS = []):
+def Objects(env, sources, testSources = None, LIBS = [], OBJECTS = []):
if type(sources) == type(()):
testSources = sources[1]
sources = sources[0]
source = sources,
test_source = testSources,
LIBS = LIBS,
+ OBJECTS = OBJECTS,
DEPENDS = [ env.File(LibPath(x)) for x in LIBS ])
env.Alias('all_tests', test)
# Hmm ... here I'd like to use an Alias instead of a file
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
# 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)
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,
docs = env.Alias('all_docs')[0].sources
xrefs = [ doc for doc in docs if os.path.splitext(doc.name)[1] == ".xmli" ]
xref = env.Command("doc/html/xref.xml", xrefs,
- [ "echo -e '<?xml version=\"1.0\"?>\\n<xref>' >$TARGET",
+ [ "echo '<?xml version=\"1.0\"?>' > $TARGET",
+ "echo '<xref>' >> $TARGET",
"cat $SOURCES >> $TARGET",
"echo '</xref>' >>$TARGET" ])
commands = []
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("sed" +
+ " -e 's/\\$$title/$TITLE/g'" +
+ " -e 's/\\$$projectname/Overview/g'" +
+ " ${SOURCES[2]} > $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))
-
+
+ if env.get('DOXY_HTML_XSL'):
+ xslfile = env.File(env['DOXY_HTML_XSL'])
+ reltopdir = '../' * len(xref[0].dir.abspath[len(env.Dir('#').abspath)+1:].split('/'))
+ if reltopdir : reltopdir = reltopdir[:-1]
+ else : reltopdir = '.'
+ commands.append(("xsltproc -o ${TARGET}.tmp" +
+ " --nonet --html" +
+ " --stringparam topdir %s" +
+ " ${SOURCES[-1]} $TARGET 2>/dev/null")
+ % reltopdir)
+ commands.append("mv ${TARGET}.tmp ${TARGET}")
+ sources.append(xslfile)
+
xref = env.Command("doc/html/xref.html", sources, commands,
TITLE = TITLE)
env.Alias('all_docs',xref)
return xref
+
## \brief Build library
#
# This target helper will build the given library. The library will be
# The library is added to the list of default targets.
#
#\ingroup target
-def Lib(env, library, sources, testSources = None, LIBS = []):
- objects = Objects(env,sources,testSources,LIBS=LIBS)
+def Lib(env, library, sources, testSources = None, LIBS = [], OBJECTS = []):
+ objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
lib = None
if objects:
lib = env.Library(env.File(LibPath(library)),objects)
env.Append(ALLLIBS = library)
return lib
+## \brief Build Object from multiple sources
+def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = []):
+ objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
+ ob = None
+ if objects:
+ ob = env.Command(target+".o", objects, "ld -r -o $TARGET $SOURCES")
+ env.Default(ob)
+ return ob
+
## \brief Build executable
#
# This target helper will build the given binary. The \a sources, \a
# construction environment parameters or the framework helpers.
#
# \ingroup target
-def Binary(env, binary, sources, testSources = None, LIBS = []):
- objects = Objects(env,sources,testSources,LIBS=LIBS)
+def Binary(env, binary, sources, testSources = None, LIBS = [], OBJECTS = []):
+ objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS)
program = None
if objects:
progEnv = env.Copy()
progEnv.Prepend(LIBS = LIBS)
- program = progEnv.Program(target=binary,source=objects)
+ program = progEnv.Program(target=binary,source=objects+OBJECTS)
env.Default(program)
env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ])
return program