X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senfscons%2FSENFSCons.py;h=753f6921edad2ec4c8376d376ff586b6d398e1c7;hb=7e614ee5d3afb0a2827b18015eb5e713ea75fc75;hp=9d243ce7803bc3e22cd3b08f8494fd4744b2c302;hpb=2d51a34f79dd18b23c54172444b2cc7433b8f5f0;p=senf.git diff --git a/senfscons/SENFSCons.py b/senfscons/SENFSCons.py index 9d243ce..753f692 100644 --- a/senfscons/SENFSCons.py +++ b/senfscons/SENFSCons.py @@ -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: #
\ref use
help using complex environments and @@ -23,12 +23,13 @@ # 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 @@ -48,6 +49,9 @@ import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS SCONS_TOOLS = [ "Doxygen", "Dia2Png", + "CopyToDir", + "InstallIncludes", + "ProgramNoScan", ] opts = None @@ -66,6 +70,14 @@ def InitOpts(): opts.Add('EXTRA_DEFINES', 'Additional preprocessor defines', '') opts.Add('EXTRA_LIBS', 'Additional libraries to link against', '') opts.Add(SCons.Options.BoolOption('final','Enable optimization',0)) + opts.Add('PREFIX', 'Installation prefix', '/usr/local') + opts.Add('LIBINSTALLDIR', 'Library install dir', '$PREFIX/lib') + opts.Add('BININSTALLDIR', 'Executable install dir', '$PREFIX/bin') + opts.Add('INCLUDEINSTALLDIR', 'Include-file install dir', '$PREFIX/include') + opts.Add('OBJINSTALLDIR', 'Static object file install dir', '$LIBINSTALLDIR') + opts.Add('DOCINSTALLDIR', 'Documentation install dir', '$PREFIX/doc') + opts.Add('CPP_INCLUDE_EXTENSIONS', 'File extensions to include in source install', + [ '.h', '.hh', '.ih', '.mpp', '.cci', '.ct', '.cti', '.mpp' ]) # A finalizer is any callable object. All finalizers will be called # in MakeEnvironment. We use them so every finalizer has knowledge of @@ -107,7 +119,7 @@ def Finalizer(f): # libraries are provided by the distribution, you probably don't need # to specify any parameters. If your configuration is more complex, # refer to the Boost.Build +# href="http://www.boost.org/tools/build/v2/index.html">Boost.Build # documentation for a definition of the terms used above (toolset, # variant, runtime ...). # @@ -137,6 +149,7 @@ def FinalizeBoost(env): env['BOOST_VARIANT'] = "-" + env['BOOST_TOOLSET'] + runtime env['BOOSTTESTLIB'] = 'libboost_unit_test_framework' + env['BOOST_VARIANT'] + env['BOOSTREGEXLIB'] = 'libboost_regex' + env['BOOST_VARIANT'] env.Append(LIBPATH = [ '$BOOST_LIBDIR' ], CPPPATH = [ '$BOOST_INCLUDES' ]) @@ -202,8 +215,12 @@ def MakeEnvironment(): global opts, finalizers InitOpts() env = SCons.Environment.Environment(options=opts) + for opt in opts.options: + if SCons.Script.SConscript.Arguments.get(opt.key): + env[opt.key] = SCons.Script.SConscript.Arguments.get(opt.key) if SCons.Script.SConscript.Arguments.get('final'): env['final'] = 1 + env.Help("\nSupported build variables (either in SConfig or on the command line:\n") env.Help(opts.GenerateHelpText(env)) # We want to pass the SSH_AUTH_SOCK system env-var so we can ssh @@ -229,10 +246,13 @@ def MakeEnvironment(): CPPDEFINES = [ 'NDEBUG' ]) else: env.Append(CXXFLAGS = [ '-O0', '-g', '-fno-inline' ], + # The boost-regex library is not compiled with _GLIBCXX_DEBUG so this fails. + # CPPDEFINES = [ '_GLIBCXX_DEBUG' ], LINKFLAGS = [ '-g' ]) env.Append(CPPDEFINES = [ '$EXTRA_DEFINES' ], - LIBS = [ '$EXTRA_LIBS' ]) + LIBS = [ '$EXTRA_LIBS' ], + ALLLIBS = []) return env @@ -243,11 +263,15 @@ def MakeEnvironment(): # in the current directory. The sources will be returned as a tuple of # sources, test-sources. The target helpers all accept such a tuple as # their source argument. -def GlobSources(exclude=[]): +def GlobSources(exclude=[], subdirs=[]): testSources = glob.glob("*.test.cc") sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ] + for subdir in subdirs: + testSources += glob.glob(os.path.join(subdir,"*.test.cc")) + sources += [ x for x in glob.glob(os.path.join(subdir,"*.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 +279,7 @@ def GlobSources(exclude=[]): # targets. Right now, these are # \li clean up \c .sconsign, \c .sconf_temp and \c config.log on # scons -c all -# +# # \ingroup target def StandardTargets(env): env.Clean(env.Alias('all'), [ '.sconsign', '.sconf_temp', 'config.log' ]) @@ -268,7 +292,7 @@ def StandardTargets(env): # # \ingroup target def GlobalTargets(env): - env.Depends(env.Alias('all'),'#') + env.Alias('all', [ 'default', 'all_tests', 'all_docs' ]) ## \brief Return path of a built library within $LOCALLIBDIR # \internal @@ -291,21 +315,31 @@ def LibPath(lib): return '$LOCALLIBDIR/lib%s.a' % lib # 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] + if type(sources) is not type([]): + sources = [ sources ] objects = None if sources: - objects = env.Object(sources) + objects = env.Object([ + source + for source in sources + if not str(source).endswith('.o') ]) + [ + source + for source in sources + if str(source).endswith('.o') ] + if testSources: test = env.BoostUnitTests( target = 'test', - source = sources, - test_source = testSources, + objects = objects, + test_sources = 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 @@ -315,6 +349,39 @@ def Objects(env, sources, testSources = None, LIBS = []): return objects +def InstallIncludeFiles(env, files): + # Hrmpf ... why do I need this in 0.97?? + if env.GetOption('clean'): + return + target = env.Dir(env['INCLUDEINSTALLDIR']) + base = env.Dir(env['INSTALL_BASE']) + for f in files: + src = env.File(f) + env.Alias('install_all', env.Install(target.Dir(src.dir.get_path(base)), src)) + +def InstallWithSources(env, targets, dir, sources, testSources = [], no_includes = False): + if type(sources) is type(()): + sources, testSources = sources + if type(sources) is not type([]): + sources = [ sources ] + if type(testSources) is not type([]): + testSources = [ testSources ] + + installs = [ env.Install(dir, targets) ] + + if not no_includes: + target = env.Dir(env['INCLUDEINSTALLDIR']).Dir( + env.Dir('.').get_path(env.Dir(env['INSTALL_BASE']))) + source = targets + if testSources: + source.append( env.File('.test.bin') ) + installs.append(env.InstallIncludes( + target = target, + source = targets, + INSTALL_BASE = env.Dir('.') )) + + return installs + ## \brief Build documentation with doxygen # # The doxygen target helper will build software documentation using @@ -341,7 +408,7 @@ def Objects(env, sources, testSources = None, LIBS = []): # generated) by the given XSLT stylesheet. Since the HTML # generated by doxygen is broken, we first filter the code through # HTML-\c tidy and filter out some error messages. -# \li If xml output is generatedwe create files \c bug.xmli and \c +# \li If xml output is generated we create files \c bug.xmli and \c # todo.xmli which contain all bugs and todo items specified in the # sources. The format of these files is much more suited to # postprocessing and is a more database like format as the doxygen @@ -363,6 +430,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,26 +440,29 @@ 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" + + " | tidy -ascii -q --show-warnings no --fix-uri no " + + " | 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) + env.Depends(doc, xslfile) if xmlnode: xrefs = [] @@ -399,10 +470,11 @@ 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, + MODULE = xmlnode.dir.dir.dir.abspath[ + len(env.Dir('#').abspath)+1:], TYPE = type) env.SideEffect(xref, xmlnode) env.AddPreAction(docs, "rm -f %s" % (xref,)) @@ -410,12 +482,34 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []): xrefs.extend(xref_pp) docs.extend(xrefs) - env.Depends(docs,extra_sources) + if extra_sources and htmlnode: + env.Depends(docs, + [ env.CopyToDir( source=source, target=htmlnode.dir ) + for source in extra_sources ]) + + if extra_sources and xmlnode: + env.Depends(docs, + [ env.CopyToDir( source=source, target=xmlnode.dir ) + for source in extra_sources ]) + + if not htmlnode and not xmlnode: + env.Depends(docs, extra_sources) + for doc in docs : env.Alias('all_docs', doc) env.Clean('all_docs', doc) env.Clean('all', doc) + l = len(env.Dir('#').abspath) + if htmlnode: + env.Alias('install_all', + env.Command('$DOCINSTALLDIR' + htmlnode.dir.abspath[l:], htmlnode.dir, + [ SCons.Defaults.Copy('$TARGET','$SOURCE') ])) + if tagnode: + env.Alias('install_all', + env.Install( '$DOCINSTALLDIR' + tagnode.dir.abspath[l:], + tagnode )) + return docs ## \brief Build combined doxygen cross-reference @@ -434,7 +528,8 @@ def DoxyXRef(env, docs=None, 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 '\\n' >$TARGET", + [ "echo '' > $TARGET", + "echo '' >> $TARGET", "cat $SOURCES >> $TARGET", "echo '' >>$TARGET" ]) @@ -445,20 +540,39 @@ def DoxyXRef(env, docs=None, 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 @@ -469,15 +583,30 @@ def DoxyXRef(env, docs=None, # 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 = [], no_includes = False): + objects = Objects(env,sources,testSources,LIBS=LIBS,OBJECTS=OBJECTS) lib = None if objects: lib = env.Library(env.File(LibPath(library)),objects) env.Default(lib) env.Append(ALLLIBS = library) + env.Alias('default', lib) + install = InstallWithSources(env, lib, '$LIBINSTALLDIR', sources, testSources, no_includes) + env.Alias('install_all', install) return lib +## \brief Build Object from multiple sources +def Object(env, target, sources, testSources = None, LIBS = [], OBJECTS = [], no_includes = False): + 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) + env.Alias('default', ob) + install = InstallWithSources(env, ob, '$OBJINSTALLDIR', sources, testSources, no_includes) + env.Alias('install_all', install) + return ob + ## \brief Build executable # # This target helper will build the given binary. The \a sources, \a @@ -488,13 +617,24 @@ def Lib(env, library, sources, testSources = None, LIBS = []): # 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 = [], no_includes = False): + 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.ProgramNoScan(target=binary,source=objects+OBJECTS) env.Default(program) env.Depends(program, [ env.File(LibPath(x)) for x in LIBS ]) + env.Alias('default', program) + install = InstallWithSources(env, program, '$BININSTALLDIR', sources, testSources, + no_includes) + env.Alias('install_all', install) return program + +def AllIncludesHH(env, headers): + headers.sort() + target = env.File("all_includes.hh") + file(target.abspath,"w").write("".join([ '#include "%s"\n' % f + for f in headers ])) + env.Clean('all', target)