1 import os.path, glob, site_tools.Yaptu
2 from SCons.Script import *
3 import SCons.Defaults, SCons.Util
7 senfutildir = os.path.dirname(__file__)
9 # Fix for SCons 0.97 compatibility
14 BoolVariable = BoolOption
16 def parseLogOption(value):
17 stream, area, level = ( x.strip() for x in value.strip().split('|') )
18 stream = ''.join('(%s)' % x for x in stream.split('::') )
19 if area : area = ''.join( '(%s)' % x for x in area.split('::') )
21 return '((%s,%s,%s))' % (stream,area,level)
23 def expandLogOption(target, source, env, for_signature):
24 if env.get('LOGLEVELS'):
25 return [ 'SENF_LOG_CONF="' + ''.join( parseLogOption(x) for x in env.subst('$LOGLEVELS').split() )+'"']
29 class BuildTypeOptions:
30 def __init__(self, var):
33 def __call__(self, target, source, env, for_signature):
34 type = env['final'] and "final" or env['debug'] and "debug" or "normal"
35 return env[self._var + "_" + type]
37 _DOLLAR_RE = re.compile(r'\$([a-zA-Z_][\.\w]*)|\${([^}]*)}')
39 def _expandDefines(defs, target, source, env, for_signature):
41 if SCons.Util.is_Dict(defs):
44 defs = [ (k,defs[k]) for k in keys ]
45 elif not SCons.Util.is_List(defs):
48 if SCons.Util.is_String(elt):
49 m = _DOLLAR_RE.match(elt)
51 match = m.group(1) or m.group(2)
52 try: rv.extend(_expandDefines(eval(match, env.gvars(), env.lvars()),
53 target, source, env, for_signature))
54 except NameError: pass
55 except IndexError: pass
57 rv.append(env.subst(elt))
59 rv.extend(_expandDefines(elt(target, source, env, for_signature),
60 target, source, env, for_signature))
61 elif SCons.Util.is_Sequence(elt):
62 if len(elt)<2 or elt[1] is None:
63 rv.append(env.subst(elt[0]))
65 rv.append(env.subst(elt[0]) + "=" + env.subst(elt[1]))
70 def expandDefines(prefix, defs, suffix, env):
71 """Expand defines in <defs> using <env>. Calls SCons.Defaults._concat_ixes
72 to append prefix/suffix before/after each define.
75 Call the callable and replace it with the call result. If the result
76 is a list, the list is processed recursively. It the result is a
77 dictionary it is converted into a list of typles and processed
79 '$<variable>' or '${<variable>}'
80 Replace the element with the variable expansion. If the result is a
81 list, the list is processed recursively. It the result is a
82 dictionary it is converted into a list of typles and processed
85 Define a symbol with that (expanded!) name
87 The iteratble must have two elments. The first element defines the
88 symbol name, the second the symbol value."""
90 defs = _expandDefines(defs, None, None, env, False)
91 return SCons.Defaults._concat_ixes(prefix, defs, suffix, env)
95 tooldir = os.path.join(senfutildir, 'site_tools')
96 for tool in os.listdir(tooldir):
97 name, ext = os.path.splitext(tool)
98 if ext == '.py' and name != "__init__" : env.Tool(name, [ tooldir ])
100 def parseArguments(env, *defs):
101 vars = Variables(args=ARGUMENTS)
102 for d in defs : vars.Add(d)
105 Any construction environment variable may be set from the scons
106 command line (see SConstruct file and SCons documentation for a list
109 VARNAME=value Assign new value
110 VARNAME+=value Append value at end
112 Special command line parameters:
114 env.Help(vars.GenerateHelpText(env))
115 try : unknv = vars.UnknownVariables()
116 except AttributeError: unknv = vars.UnknownOptions()
117 env.SetDefault(ARGUMENT_VARIABLES = {})
118 for k,v in unknv.iteritems():
120 env.Append(**{k[:-1]: v})
121 env.Append(ARGUMENT_VARIABLES = {k[:-1]:v})
123 env.Replace(**{k: v})
124 env.Append(ARGUMENT_VARIABLES = {k:v})
127 ###########################################################################
128 # This looks much more complicated than it is: We do three things here:
129 # a) switch between final or debug options
130 # b) parse the LOGLEVELS parameter into the correct SENF_LOG_CONF syntax
131 # c) check for a local SENF, set options accordingly
132 # d) check, wether the boost extensions are needed
134 def SetupForSENF(env, senf_path = []):
136 senf_path.extend(('senf', os.path.dirname(senfutildir), '/usr/local', '/usr'))
143 CXXFLAGS = [ '-Wno-long-long', '$CXXFLAGS_', '-fno-strict-aliasing' ],
144 CXXFLAGS_ = BuildTypeOptions('CXXFLAGS'),
146 CPPDEFINES = [ '$expandLogOption', '$CPPDEFINES_' ],
147 expandLogOption = expandLogOption,
148 CPPDEFINES_ = BuildTypeOptions('CPPDEFINES'),
150 LINKFLAGS = [ '-rdynamic', '$LINKFLAGS_' ],
151 LINKFLAGS_ = BuildTypeOptions('LINKFLAGS'),
153 LOGLEVELS = [ '$LOGLEVELS_' ],
154 LOGLEVELS_ = BuildTypeOptions('LOGLEVELS'),
159 CXXFLAGS_normal = [],
162 CPPDEFINES_final = [],
163 CPPDEFINES_normal = [],
164 CPPDEFINES_debug = [],
166 LINKFLAGS_final = [],
167 LINKFLAGS_normal = [],
168 LINKFLAGS_debug = [],
170 LOGLEVELS_final = [],
171 LOGLEVELS_normal = [],
172 LOGLEVELS_debug = [],
174 PROJECTNAME = "Unnamed project",
176 PROJECTEMAIL = "nobody@nowhere.org",
177 COPYRIGHT = "nobody",
178 REVISION = "unknown",
181 env.Replace( _defines = expandDefines )
183 # Interpret command line options
186 BoolVariable('final', 'Build final (optimized) build', False),
187 BoolVariable('debug', 'Link in debug symbols', False),
190 # If we have a symbolic link (or directory) 'senf', we use it as our
192 for path in senf_path:
193 if not path.startswith('/') : sconspath = '#/%s' % path
194 else : sconspath = path
195 if os.path.exists(os.path.join(path,"senf/config.hh")):
196 if not env.GetOption('no_progress'):
197 print "\nUsing SENF in '%s'\n" \
198 % ('/..' in sconspath and os.path.abspath(path) or sconspath)
199 env.Append( LIBPATH = [ sconspath ],
200 CPPPATH = [ sconspath ],
201 BUNDLEDIR = sconspath,
203 SENFINCDIR = sconspath,
204 SENFSYSLAYOUT = False)
206 env.MergeFlags(file(os.path.join(path,"senf.conf")).read())
208 if not env.GetOption('no_progress'):
209 print "(SENF configuration file 'senf.conf' not found, assuming non-final SENF)"
210 env.Append(CPPDEFINES = [ 'SENF_DEBUG' ])
212 elif os.path.exists(os.path.join(path,"include/senf/config.hh")):
213 if not env.GetOption('no_progress'):
214 print "\nUsing system SENF in '%s/'\n" % sconspath
215 env.Append(BUNDLEDIR = os.path.join(sconspath,"lib/senf"),
217 SENFINCDIR = '%s/include' % sconspath,
218 SENFSYSLAYOUT = True)
221 if not env.GetOption('no_progress'):
222 print "\nSENF library not found .. trying build anyway !!\n"
226 # Only add senf after all configure checks have run
228 CPPPATH = '${NEED_BOOST_EXT and "$SENFINCDIR/boost_ext" or None}',
229 LIBS = [ 'senf', '$BOOSTREGEXLIB', '$BOOSTIOSTREAMSLIB', '$BOOSTSIGNALSLIB',
233 env.Alias('all', '#')
236 def DefaultOptions(env):
238 CXXFLAGS = [ '-Wall', '-Woverloaded-virtual' ],
239 CXXFLAGS_final = [ '-O3' ],
240 CXXFLAGS_normal = [ '-O2', '-g' ],
241 CXXFLAGS_debug = [ '-O0', '-g' ],
243 LINKFLAGS_normal = [ '-Wl,-S' ],
244 LINKFLAGS_debug = [ '-g' ],
248 def Glob(env, exclude=[], subdirs=[]):
249 testSources = env.Glob("*.test.cc", strings=True)
251 for x in env.Glob("*.cc", strings=True)
252 if x not in testSources and x not in exclude ]
253 for subdir in subdirs:
254 testSources += env.Glob(os.path.join(subdir,"*.test.cc"), strings=True)
256 for x in env.Glob(os.path.join(subdir,"*.cc"), strings=True)
257 if x not in testSources and x not in exclude ]
260 return (sources, testSources)
264 def CheckSTLCopyN(context):
265 context.Message("Checking for 'copy_n' implementation... ")
266 versions = [ ('<algorithm>', 'std::copy_n', 'STD'),
267 ('<ext/algorithm>', '__gnu_cxx::copy_n', 'GNUCXX') ]
268 for include, name, define in versions:
269 ret = context.TryCompile("#include %s\n"
270 "int main(int,char**) { int *a,*b; %s(a,0,b); }\n"
275 context.sconf.Define("HAVE_%s_COPYN" % define,
278 + ", ".join(("HAVE_%s_COPYN" % elt[2] for elt in versions)))
281 context.Result(False)
286 def CheckTempBufferStrategy(context):
287 context.Message("Checking for optimal temporary buffer strategy... ")
291 ret = context.TryCompile("void test(int n){int a[n];}",".cc")
292 if ret: return "locals"
295 ret = context.TryCompile("#include <alloca.h>\n"
296 "void test(int a){void *b(alloca(a));}"
298 if ret: return "alloca"
305 context.sconf.Define("SENF_BUFFER_USE_%s" % ret.upper(),
307 "Define one of SENF_BUFFER_USE_LOCALS, SENF_BUFFER_USE_ALLOCA, "
308 "SENF_BUFFER_USE_NEW")
313 SCons.Util.display("scons: *** %s" % msg)
317 def Configure(env, customChecks=None):
318 conf = env.Configure(clean=False,
320 custom_tests=senfconf.Tests(),
321 config_h="#/senf/autoconf.hh")
324 if not conf.CheckBoostVersion():
325 Fail("Boost includes not found")
326 if not conf.env['ARGUMENT_VARIABLES'].has_key('BOOST_VARIANT'): conf.CheckBoostVariants( '', 'mt' )
327 conf.env.Replace(NEED_BOOST_EXT = not conf.CheckCXXHeader("boost/bimap.hpp"))
328 conf.CheckCXXHeader("boost/spirit/include/classic.hpp")
331 conf.CheckTempBufferStrategy()
333 # Standard library stuff
334 if not conf.CheckSTLCopyN():
335 Fail("No 'copy_n' implementation found")
336 conf.CheckFunc("timerfd_create")
346 def Doxygen(env, doxyheader=None, doxyfooter=None, doxycss=None, mydoxyfile=False, senfdoc_path=[],
348 # Additional interesting keyword arguments or environment variables:
349 # PROJECTNAME, DOCLINKS, PROJECTEMAIL, COPYRIGHT, REVISION
353 libdir=os.path.join(senfutildir, 'lib')
357 senfdoc_path.extend(('senfdoc', '$SENFDIR', '$SENFDIR/manual',
358 '$SENFDIR/share/doc/senf', '$SENFDIR/share/doc/libsenf-doc/html'))
359 for path in senfdoc_path:
360 path = env.Dir(path).get_path()
361 if os.path.exists(os.path.join(path, "doc/doclib.tag")):
365 if senfdocdir is None:
366 if not env.GetOption('no_progress'):
367 print "(SENF documentation not found)"
369 for dir, dirs, files in os.walk(senfdocdir):
370 tagfiles.extend([ os.path.join(dir,f) for f in files if f.endswith('.tag') ])
371 if dir.endswith('/doc') :
372 try: dirs.remove('html')
373 except ValueError: pass
375 if d.startswith('.') : dirs.remove(d)
377 if env.GetOption('clean'):
378 env.Clean('doc', env.Dir('doc'))
380 env.Clean('doc', "Doxyfile")
383 # Create Doxyfile NOW
384 site_tools.Yaptu.yaptuAction("Doxyfile",
385 os.path.join(libdir, "Doxyfile.yap"),
388 envvalues = [ env.Value('$PROJECTNAME'),
389 env.Value('$DOCLINKS'),
390 env.Value('$PROJECTEMAIL'),
391 env.Value('$COPYRIGHT'),
392 env.Value('$REVISION') ]
394 # The other files are created using dependencies
396 doxyheader = env.CopyToDir(env.Dir("doc"), doxyheader)
398 doxyheader = env.Yaptu("doc/doxyheader.html", os.path.join(libdir, "doxyheader.yap"), **kw)
399 env.Depends(doxyheader, envvalues)
401 doxyfooter = env.CopyToDir(env.Dir("doc"), doxyfooter)
403 doxyfooter = env.Yaptu("doc/doxyfooter.html", os.path.join(libdir, "doxyfooter.yap"), **kw)
404 env.Depends(doxyfooter, envvalues)
406 doxycss = env.CopyToDir(env.Dir("doc"), doxycss)
408 doxycss = env.CopyToDir(env.Dir("doc"), os.path.join(libdir, "doxy.css"))
410 doc = env.Doxygen("Doxyfile",
411 DOXYOPTS = [ '--html', '--tagfiles', '"$TAGFILES"' ],
412 DOXYENV = { 'TOPDIR' : env.Dir('#').abspath,
414 'REVISION' : '$REVISION',
415 'tagfiles' : '$TAGFILES',
416 'output_dir' : 'doc',
419 'DOXYGEN' : '$DOXYGEN' },
422 DOXYGENCOM = "$DOCLIBDIR/doxygen.sh $DOXYOPTS $SOURCE")
424 env.Depends(doc, [ doxyheader, doxyfooter, doxycss ])