2 import SCons.Options, SCons.Environment, SCons.Script.SConscript, SCons.Node.FS
3 import SCons.Defaults, SCons.Action
4 from SCons.Script import *
6 def Glob(env, exclude=[], subdirs=[]):
7 testSources = glob.glob("*.test.cc")
8 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
10 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
11 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
12 if x not in testSources and x not in exclude ]
14 for d in [ '.' ] + subdirs:
15 for f in os.listdir(d):
16 ext = '.' + f.split('.',1)[-1]
18 if ext in env['CPP_INCLUDE_EXTENSIONS'] \
19 and ext not in env['CPP_EXCLUDE_EXTENSIONS'] \
22 return ( sources, testSources, includes )
24 def Doxygen(env, doxyfile = "Doxyfile", extra_sources = [], output_directory = "doc"):
25 # There is one small problem we need to solve with this builder: The Doxygen builder reads
26 # the Doxyfile and thus depends on the environment variables set by site_scons/lib/doxygen.sh.
27 # We thus have to provide all necessary definitions here manually via DOXYENV !
29 if type(doxyfile) is type(""):
30 doxyfile = env.File(doxyfile)
32 # Module name is derived from the doxyfile path
33 # Utils/Console/Doxyfile -> Utils_Console
34 module = doxyfile.dir.get_path(env.Dir('#')).replace('/','_')
35 if module == '.' : module = "Main"
37 # Standard doc build vars and opts
38 def vars(env=env, **kw):
39 denv = { 'TOPDIR' : env.Dir('#').abspath,
40 'LIBDIR' : env.Dir('#/site_scons/lib').abspath,
41 'output_dir' : '$OUTPUT_DIRECTORY',
45 return { 'DOXYENV' : denv,
47 'OUTPUT_DIRECTORY': output_directory };
48 opts = [ '--tagfile-name', '"${MODULE}.tag"',
49 '--output-dir', '$OUTPUT_DIRECTORY' ]
51 # Rule to generate tagfile
52 # (need to exclude the 'clean' case, otherwise we'll have duplicate nodes)
53 if not env.GetOption('clean'):
54 tagfile = env.Doxygen(doxyfile, DOXYOPTS = opts + [ '--tagfile' ],
55 **vars(generate_tagfile='doc/${MODULE}.tag'))
56 env.Append(ALL_TAGFILES = [ tagfile[0].abspath ])
57 env.Depends(tagfile, [ env.File('#/site_scons/lib/doxygen.sh'),
58 env.File('#/site_scons/lib/tag-munge.xsl') ])
60 env.Install(env.Dir('$DOCINSTALLDIR').Dir(tagfile[0].dir.get_path(env.Dir('#'))),
63 # Rule to generate HTML documentation
64 doc = env.Doxygen(doxyfile, DOXYOPTS = opts + [ '--tagfiles', '"$ALL_TAGFILES"', '--html' ],
65 **vars(html='YES', tagfiles='$ALL_TAGFILES'))
66 env.Depends(doc, [ env.File('#/site_scons/lib/doxygen.sh'),
67 env.File('#/site_scons/lib/html-munge.xsl') ])
69 # Copy the extra_sources (the images) into the documentation directory
70 # (need to exclude the 'clean' case otherwise there are multiple ways to clean the copies)
72 if env.GetOption('clean'):
73 env.Depends(doc, extra_sources)
75 env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources))
77 # Install documentation into DOCINSTALLDIR
78 env.InstallDir(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.dir.get_path(env.Dir('#'))), doc[0].dir,
79 FILTER_SUFFIXES=['.html','.css','.png','.php','.idx'])
82 env.Alias('all_docs', doc)
83 env.Clean(env.Alias('all_docs'), doc)
84 env.Clean(env.Alias('all'), doc)
88 def AllIncludesHH(env, exclude=[]):
89 exclude = exclude[:] + ['all_includes.hh'] # Make a copy !!
90 headers = [ f for f in glob.glob("*.hh")
91 if f not in exclude and not f.endswith('.test.hh') ]
93 target = env.File("all_includes.hh")
94 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
96 env.Clean(env.Alias('all'), target)
98 ###########################################################################
99 # The following functions serve as simple macros for most SConscript files
101 # If you need to customize these rules, copy-and-paste the code into the
102 # SConscript file and adjust at will (don't forget to replace the
103 # parameters with their actual value. Parameters are marked with ((name)) )
105 def AutoRules(env, exclude=[], subdirs=[], doc_extra_sources = []):
108 sources, tests, includes = SENFSCons.Glob(env, exclude=((exclude)), subdirs=((subdirs)) )
109 subscripts = env.Glob("*/SConscript")
110 doxyfile = env.Glob("Doxyfile")
112 if sources : env.Append(ALLOBJECTS = env.Object(sources))
113 if tests : env.BoostUnitTest('test', tests)
114 if includes : env.InstallSubdir('$INCLUDEINSTALLDIR', includes)
115 if doxyfile : SENFSCons.Doxygen(env, extra_sources=((doc_extra_sources)) )
116 if subscripts : SConscript(subscripts)
119 def AutoPacketBundle(env, name, exclude=[], subdirs=[], doc_extra_sources=[]):
122 sources, tests, includes = SENFSCons.Glob(env, exclude=((exclude)), subdirs=((subdirs)) )
123 subscripts = env.Glob("*/SConscript")
124 doxyfile = env.Glob("Doxyfile")
126 objects = env.Object(sources)
127 cobject = env.CombinedObject('${LOCALLIBDIR}/${NAME}${OBJADDSUFFIX}', objects, NAME=((name)))
130 env.Append(ALLOBJECTS = objects, PACKET_BUNDLES = cobject)
131 env.Install('$OBJINSTALLDIR', cobject)
133 if tests : env.BoostUnitTest('test', tests + cobject)
134 if includes : env.InstallSubdir('$INCLUDEINSTALLDIR', includes)
135 if doxyfile : SENFSCons.Doxygen(env, extra_sources=((doc_extra_sources)) )
136 if subscripts : SConscript(subscripts)