1 import os.path, glob, site_tools.Yaptu
2 from SCons.Script import *
4 senfutildir = os.path.dirname(__file__)
6 # Fix for SCons 0.97 compatibility
11 BoolVariable = BoolOption
13 def parseLogOption(value):
14 stream, area, level = ( x.strip() for x in value.strip().split('|') )
15 stream = ''.join('(%s)' % x for x in stream.split('::') )
16 if area : area = ''.join( '(%s)' % x for x in area.split('::') )
18 return '((%s,%s,%s))' % (stream,area,level)
20 def expandLogOption(target, source, env, for_signature):
21 if env.get('LOGLEVELS'):
22 return [ 'SENF_LOG_CONF="' + ''.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() )+'"']
26 class BuildTypeOptions:
27 def __init__(self, var):
30 def __call__(self, target, source, env, for_signature):
31 type = env['final'] and "final" or env['debug'] and "debug" or "normal"
32 return env[self._var + "_" + type]
34 def parseArguments(env, *defs):
35 vars = Variables(args=ARGUMENTS)
36 for d in defs : vars.Add(d)
39 Any construction environment variable may be set from the scons
40 command line (see SConstruct file and SCons documentation for a list
43 VARNAME=value Assign new value
44 VARNAME+=value Append value at end
46 Special command line parameters:
48 env.Help(vars.GenerateHelpText(env))
49 try : unknv = vars.UnknownVariables()
50 except AttributeError: unknv = vars.UnknownOptions()
51 for k,v in unknv.iteritems():
53 env.Append(**{k[:-1]: v})
58 ###########################################################################
59 # This looks much more complicated than it is: We do three things here:
60 # a) switch between final or debug options
61 # b) parse the LOGLEVELS parameter into the correct SENF_LOG_CONF syntax
62 # c) check for a local SENF, set options accordingly and update that SENF if needed
64 def SetupForSENF(env, senf_path = []):
66 senf_path.extend(('senf', '../senf', os.path.dirname(senfutildir), '/usr/local', '/usr'))
67 tooldir = os.path.join(senfutildir, 'site_tools')
69 env.Tool('Boost', [ tooldir ])
70 env.Tool('PhonyTarget', [ tooldir ])
71 env.Tool('Yaptu', [ tooldir ])
72 env.Tool('CopyToDir', [ tooldir ])
73 env.Tool('Doxygen', [ tooldir ])
76 LIBS = [ 'senf', 'rt', '$BOOSTREGEXLIB',
77 '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
79 BOOSTREGEXLIB = 'boost_regex',
80 BOOSTIOSTREAMSLIB = 'boost_iostreams',
81 BOOSTSIGNALSLIB = 'boost_signals',
82 BOOSTFSLIB = 'boost_filesystem',
84 CXXFLAGS = [ '-Wno-long-long', '$CXXFLAGS_' ],
85 CXXFLAGS_ = BuildTypeOptions('CXXFLAGS'),
87 CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
88 expandLogOption = expandLogOption,
89 CPPDEFINES_ = BuildTypeOptions('CPPDEFINES'),
91 LINKFLAGS = [ '-rdynamic', '$LINKFLAGS_' ],
92 LINKFLAGS_ = BuildTypeOptions('LINKFLAGS'),
94 LOGLEVELS = [ '$LOGLEVELS_' ],
95 LOGLEVELS_ = BuildTypeOptions('LOGLEVELS'),
100 CXXFLAGS_normal = [],
103 CPPDEFINES_final = [],
104 CPPDEFINES_normal = [],
105 CPPDEFINES_debug = [],
107 LINKFLAGS_final = [],
108 LINKFLAGS_normal = [],
109 LINKFLAGS_debug = [],
111 LOGLEVELS_final = [],
112 LOGLEVELS_normal = [],
113 LOGLEVELS_debug = [],
115 PROJECTNAME = "Unnamed project",
117 PROJECTEMAIL = "nobody@nowhere.org",
118 COPYRIGHT = "nobody",
119 REVISION = "unknown",
122 # Interpret command line options
125 BoolVariable('final', 'Build final (optimized) build', False),
126 BoolVariable('debug', 'Link in debug symbols', False),
129 # If we have a symbolic link (or directory) 'senf', we use it as our
131 for path in senf_path:
132 if not path.startswith('/') : sconspath = '#/%s' % path
133 else : sconspath = path
134 if os.path.exists(os.path.join(path,"senf/config.hh")):
135 print "\nUsing SENF in '%s'\n" \
136 % ('/..' in sconspath and os.path.abspath(path) or sconspath)
137 env.Append( LIBPATH = [ sconspath ],
138 CPPPATH = [ sconspath ],
139 BUNDLEDIR = sconspath )
141 env.MergeFlags(file(os.path.join(path,"senf.conf")).read())
143 print "(SENF configuration file 'senf.conf' not found, assuming non-final SENF)"
144 env.Append(CPPDEFINES = [ 'SENF_DEBUG' ])
146 elif os.path.exists(os.path.join(path,"include/senf/config.hh")):
147 print "\nUsing system SENF in '%s/'\n" % sconspath
148 env.Append(BUNDLEDIR = os.path.join(sconspath,"lib/senf"))
151 print "\nSENF library not found .. trying build anyway !!\n"
153 env.Alias('all', '#')
156 def DefaultOptions(env):
158 CXXFLAGS = [ '-Wall', '-Woverloaded-virtual' ],
159 CXXFLAGS_final = [ '-O2' ],
160 CXXFLAGS_normal = [ '-O0', '-g' ],
161 CXXFLAGS_debug = [ '$CXXFLAGS_normal' ],
163 LINKFLAGS_normal = [ '-Wl,-S' ],
164 LINKFLAGS_debug = [ '-g' ],
167 def Glob(env, exclude=[], subdirs=[]):
168 testSources = glob.glob("*.test.cc")
169 sources = [ x for x in glob.glob("*.cc") if x not in testSources and x not in exclude ]
170 for subdir in subdirs:
171 testSources += glob.glob(os.path.join(subdir,"*.test.cc"))
172 sources += [ x for x in glob.glob(os.path.join(subdir,"*.cc"))
173 if x not in testSources and x not in exclude ]
174 return (sources, testSources)
178 def Doxygen(env, doxyheader=None, doxyfooter=None, doxycss=None, mydoxyfile=False, senfdoc_path=[],
180 # Additional interesting keyword arguments or environment variables:
181 # PROJECTNAME, DOCLINKS, PROJECTEMAIL, COPYRIGHT, REVISION
185 libdir=os.path.join(senfutildir, 'lib')
189 senfdoc_path.extend(('senfdoc', 'senf/manual', 'senf', '../senf/manual', '../senf',
190 os.path.join(os.path.dirname(senfutildir), 'manual'),
191 os.path.dirname(senfutildir),
192 '/usr/share/doc/senf', '/usr/local/share/doc/senf',
193 '/usr/share/doc/libsenf-doc/html'))
194 for path in senfdoc_path:
195 if os.path.exists(os.path.join(path, "doc/Main.tag")):
199 if senfdocdir is None:
200 print "(SENF documentation not found)"
202 for dir, dirs, files in os.walk(senfdocdir):
203 tagfiles.extend([ os.path.join(dir,f) for f in files if f.endswith('.tag') ])
204 if dir.endswith('/doc') : dirs.remove('html')
206 if d.startswith('.') : dirs.remove(d)
208 if env.GetOption('clean'):
209 env.Clean('doc', env.Dir('doc'))
211 env.Clean('doc', "Doxyfile")
214 # Create Doxyfile NOW
215 site_tools.Yaptu.yaptuAction("Doxyfile",
216 os.path.join(libdir, "Doxyfile.yap"),
219 envvalues = [ env.Value('$PROJECTNAME'),
220 env.Value('$DOCLINKS'),
221 env.Value('$PROJECTEMAIL'),
222 env.Value('$COPYRIGHT'),
223 env.Value('$REVISION') ]
225 # The other files are created using dependencies
227 doxyheader = env.CopyToDir(env.Dir("doc"), doxyheader)
229 doxyheader = env.Yaptu("doc/doxyheader.html", os.path.join(libdir, "doxyheader.yap"), **kw)
230 env.Depends(doxyheader, envvalues)
232 doxyfooter = env.CopyToDir(env.Dir("doc"), doxyfooter)
234 doxyfooter = env.Yaptu("doc/doxyfooter.html", os.path.join(libdir, "doxyfooter.yap"), **kw)
235 env.Depends(doxyfooter, envvalues)
237 doxycss = env.CopyToDir(env.Dir("doc"), doxycss)
239 doxycss = env.CopyToDir(env.Dir("doc"), os.path.join(libdir, "doxy.css"))
241 doc = env.Doxygen("Doxyfile",
242 DOXYOPTS = [ '--html', '--tagfiles', '"$TAGFILES"' ],
243 DOXYENV = { 'TOPDIR' : env.Dir('#').abspath,
245 'REVISION' : '$REVISION',
246 'tagfiles' : '$TAGFILES',
247 'output_dir' : 'doc',
252 DOXYGENCOM = "$DOCLIBDIR/doxygen.sh $DOXYOPTS $SOURCE")
254 env.Depends(doc, [ doxyheader, doxyfooter, doxycss ])