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 = []):
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 doclib/doxygen.sh. We
27 # 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 # Rule to generate tagfile
38 # (need to exclude the 'clean' case, otherwise we'll have duplicate nodes)
39 if not env.GetOption('clean'):
40 tagfile = env.Doxygen(doxyfile,
41 DOXYOPTS = [ '--tagfile-name', '"${MODULE}.tag"',
43 DOXYENV = { 'TOPDIR' : env.Dir('#').abspath,
47 'generate_tagfile': 'doc/${MODULE}.tag' },
49 env.Append(ALL_TAGFILES = tagfile[0].abspath)
50 env.Depends(tagfile, [ env.File('#/doclib/doxygen.sh'),
51 env.File('#/doclib/tag-munge.xsl') ])
53 # Rule to generate HTML documentation
54 doc = env.Doxygen(doxyfile,
55 DOXYOPTS = [ '--tagfiles', '"$ALL_TAGFILES"',
56 '--tagfile-name', '"${MODULE}.tag"',
59 DOXYENV = { 'TOPDIR' : env.Dir('#').abspath,
60 'tagfiles' : '${ALL_TAGFILES}',
64 env.Depends(doc, [ env.File('#/doclib/doxygen.sh'),
65 env.File('#/doclib/html-munge.xsl') ])
67 # Copy the extra_sources (the images) into the documentation directory
68 # (need to exclude the 'clean' case otherwise there are multiple ways to clean the copies)
69 if not env.GetOption('clean'):
71 env.Depends(doc, env.CopyToDir(doc[0].dir, extra_sources))
73 # Install documentation into DOCINSTALLDIR
74 l = len(env.Dir('#').abspath)
75 env.Install(env.Dir('$DOCINSTALLDIR').Dir(doc[0].dir.get_path('#')), doc[0].dir)
78 env.Alias('all_docs', doc)
79 env.Clean('all_docs', doc)
84 def AllIncludesHH(env, exclude=[]):
85 exclude = exclude[:] + ['all_includes.hh'] # Make a copy !!
86 headers = [ f for f in glob.glob("*.hh")
87 if f not in exclude and not f.endswith('.test.hh') ]
89 target = env.File("all_includes.hh")
90 file(target.abspath,"w").write("".join([ '#include "%s"\n' % f
92 env.Clean('all', target)