X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=site_scons%2FSENFSCons.py;h=fb3d6c98161a226a03ea4e9a28b84ef5fdcc2c0d;hb=HEAD;hp=fc26296da887c8ebed8ed7e2a1b54d7e8512ec53;hpb=ae081e2733dee85ff8fe024150d41b38ea8d8140;p=senf.git diff --git a/site_scons/SENFSCons.py b/site_scons/SENFSCons.py index fc26296..fb3d6c9 100644 --- a/site_scons/SENFSCons.py +++ b/site_scons/SENFSCons.py @@ -1,30 +1,38 @@ -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 * def Glob(env, 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 ] + testSources = env.Glob("*.test.cc",strings=True) + sources = [ x + for x in env.Glob("*.cc",strings=True) \ + + env.Glob("*.c",strings=True) + 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")) + testSources += env.Glob(os.path.join(subdir,"*.test.cc"),strings=True) + sources += [ x + for x in env.Glob(os.path.join(subdir,"*.cc"),strings=True) \ + + env.Glob(os.path.join(subdir,"*.c"),strings=True) if x not in testSources and x not in exclude ] includes = [] - for d in [ '.' ] + subdirs: - for f in os.listdir(d): - ext = '.' + f.split('.',1)[-1] - p = os.path.join(d,f) + for d in [ '' ] + [ x+'/' for x in subdirs ]: + for p in env.Glob("%s*" % d, strings=True) + env.Glob("%s*" % d, strings=True, ondisk=False): + ext = '.' + p.split('.',1)[-1] if ext in env['CPP_INCLUDE_EXTENSIONS'] \ and ext not in env['CPP_EXCLUDE_EXTENSIONS'] \ and p not in exclude: includes.append(p) + includes = list(set(includes)) + sources.sort() + testSources.sort() + includes.sort() 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) @@ -34,38 +42,40 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []): 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', + 'DOXYGEN' : '$DOXYGEN' } + 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 ) + 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('#/doclib/doxygen.sh'), - env.File('#/doclib/tag-munge.xsl') ]) + 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) @@ -73,7 +83,7 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []): if env.GetOption('clean'): env.Depends(doc, extra_sources) else: - env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources)) + env.Depends(tagfile, env.CopyToDir(doc[0].dir, extra_sources)) # Install documentation into DOCINSTALLDIR env.InstallDir(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.dir.get_path(env.Dir('#'))), doc[0].dir, @@ -87,14 +97,45 @@ def Doxygen(env, doxyfile = "Doxyfile", extra_sources = []): return doc def AllIncludesHH(env, exclude=[]): - exclude = exclude[:] + ['all_includes.hh'] # Make a copy !! - headers = [ f for f in glob.glob("*.hh") - if f not in exclude and not f.endswith('.test.hh') ] - headers.sort() + exclude = exclude + ['all_includes.hh'] + headers = [ f for f in env.Glob("*.hh", source=True) + if f.name not in exclude and not f.name.endswith('.test.hh') ] + headers.sort(key=lambda x:x.name) target = env.File("all_includes.hh") - file(target.abspath,"w").write("".join([ '#include "%s"\n' % f - for f in headers ])) - env.Clean(env.Alias('all'), target) + allinch = env.CreateFile(target, + env.Value("".join([ '#include <%s>\n' % f.srcnode().get_path(env.Dir('#')) + for f in headers ]))) + env.Default(allinch) + env.Depends(allinch, headers) + +INDEXPAGE=""" +/** \mainpage ${TITLE} + + ${TEXT} + + \htmlonly +
+ +{{ for name, title in SUBPAGES: +
${name}
${title}
+}} + +
+ \endhtmlonly + */ +""" + +def IndexPage(env, name, title, text=""): + SUBPAGES = [] + for dox in sorted(env.Glob("*/Mainpage.dox",strings=True)): + 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 @@ -107,7 +148,7 @@ def AutoRules(env, exclude=[], subdirs=[], doc_extra_sources = []): import SENFSCons sources, tests, includes = SENFSCons.Glob(env, exclude=((exclude)), subdirs=((subdirs)) ) - subscripts = env.Glob("*/SConscript") + subscripts = sorted(env.Glob("*/SConscript", strings=True)) doxyfile = env.Glob("Doxyfile") if sources : env.Append(ALLOBJECTS = env.Object(sources)) @@ -121,17 +162,32 @@ 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") + subscripts = sorted(env.Glob("*/SConscript", strings=True)) doxyfile = env.Glob("Doxyfile") - objects = env.Object(sources) - cobject = env.CombinedObject('${LOCALLIBDIR}/${NAME}${OBJADDSUFFIX}', objects, NAME=((name))) + objects = env.Object (sources) + cobject = env.CombinedObject ('${LOCALLIBDIR}/${NAME}${OBJADDSUFFIX}', objects, NAME=((name))) + sobundle = env.SharedLibrary ('${LOCALLIBDIR}/${NAME}${OBJADDSUFFIX}', sources, NAME=((name)), + LIBS=[], SHLIBPREFIX='') env.Default(cobject) + env.Default(sobundle) env.Append(ALLOBJECTS = objects, PACKET_BUNDLES = cobject) env.Install('$OBJINSTALLDIR', cobject) + env.Install('$OBJINSTALLDIR', sobundle) 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) + + +def BuildExample(env, sconstruct): + dir = env.File( ((sconstruct)) ).dir + example = env.Command( dir.File('.example.phony'), env.Alias('default'), + [ '$SCONS -C $EXAMPLEDIR' ], + CONCURRENCY_LEVEL=1, EXAMPLEDIR=dir ) + env.Alias('examples', example) + + if env.GetOption('clean') and ('all' in BUILD_TARGETS or 'examples' in BUILD_TARGETS): + env.Clone(CONCURRENCY_LEVEL=1, EXAMPLEDIR=dir).Execute([ '$SCONS -C $EXAMPLEDIR -c' ])