1 # a waf tool to add autoconf-like macros to the configure section
2 # and for SAMBA_ macros for building libraries, binaries etc
4 import Build, os, sys, Options, Utils, Task, re, fnmatch, Logs
5 from TaskGen import feature, before
6 from Configure import conf
10 # TODO: make this a --option
14 # sigh, python octal constants are a mess
15 MODE_644 = int('644', 8)
16 MODE_755 = int('755', 8)
19 def SET_TARGET_TYPE(ctx, target, value):
20 '''set the target type of a target'''
21 cache = LOCAL_CACHE(ctx, 'TARGET_TYPE')
22 if target in cache and cache[target] != 'EMPTY':
23 Logs.error("ERROR: Target '%s' in directory %s re-defined as %s - was %s" % (target, ctx.curdir, value, cache[target]))
25 LOCAL_CACHE_SET(ctx, 'TARGET_TYPE', target, value)
26 debug("task_gen: Target '%s' created of type '%s' in %s" % (target, value, ctx.curdir))
30 def GET_TARGET_TYPE(ctx, target):
31 '''get target type from cache'''
32 cache = LOCAL_CACHE(ctx, 'TARGET_TYPE')
33 if not target in cache:
38 ######################################################
39 # this is used as a decorator to make functions only
40 # run once. Based on the idea from
41 # http://stackoverflow.com/questions/815110/is-there-a-decorator-to-simply-cache-function-return-values
43 def runonce(function):
44 def runonce_wrapper(*args):
45 if args in runonce_ret:
46 return runonce_ret[args]
49 runonce_ret[args] = ret
51 return runonce_wrapper
54 def ADD_LD_LIBRARY_PATH(path):
55 '''add something to LD_LIBRARY_PATH'''
56 if 'LD_LIBRARY_PATH' in os.environ:
57 oldpath = os.environ['LD_LIBRARY_PATH']
60 newpath = oldpath.split(':')
61 if not path in newpath:
63 os.environ['LD_LIBRARY_PATH'] = ':'.join(newpath)
66 def install_rpath(bld):
67 '''the rpath value for installation'''
70 if bld.env.RPATH_ON_INSTALL:
71 ret.add(bld.EXPAND_VARIABLES(bld.env.LIBDIR))
72 if bld.env.RPATH_ON_INSTALL_PRIVATE:
73 ret.add(bld.EXPAND_VARIABLES(bld.env.PRIVATELIBDIR))
78 '''the rpath value for build'''
79 rpath = os.path.normpath('%s/%s' % (bld.env.BUILD_DIRECTORY, LIB_PATH))
81 if bld.env.RPATH_ON_BUILD:
83 ADD_LD_LIBRARY_PATH(rpath)
88 def LOCAL_CACHE(ctx, name):
89 '''return a named build cache dictionary, used to store
90 state inside other functions'''
98 def LOCAL_CACHE_SET(ctx, cachename, key, value):
99 '''set a value in a local cache'''
100 cache = LOCAL_CACHE(ctx, cachename)
105 def ASSERT(ctx, expression, msg):
106 '''a build assert call'''
108 raise Utils.WafError("ERROR: %s\n" % msg)
109 Build.BuildContext.ASSERT = ASSERT
112 def SUBDIR(bld, subdir, list):
113 '''create a list of files by pre-pending each with a subdir name'''
115 for l in TO_LIST(list):
116 ret = ret + os.path.normpath(os.path.join(subdir, l)) + ' '
118 Build.BuildContext.SUBDIR = SUBDIR
121 def dict_concat(d1, d2):
122 '''concatenate two dictionaries d1 += d2'''
128 def exec_command(self, cmd, **kw):
129 '''this overrides the 'waf -v' debug output to be in a nice
130 unix like format instead of a python list.
131 Thanks to ita on #waf for this'''
134 if isinstance(cmd, list):
136 debug('runner: %s' % _cmd)
138 self.log.write('%s\n' % cmd)
141 if not kw.get('cwd', None):
143 except AttributeError:
144 self.cwd = kw['cwd'] = self.bldnode.abspath()
145 return Utils.exec_command(cmd, **kw)
146 Build.BuildContext.exec_command = exec_command
149 def ADD_COMMAND(opt, name, function):
150 '''add a new top level command to waf'''
151 Utils.g_module.__dict__[name] = function
153 Options.Handler.ADD_COMMAND = ADD_COMMAND
156 @feature('cc', 'cshlib', 'cprogram')
157 @before('apply_core','exec_rule')
158 def process_depends_on(self):
159 '''The new depends_on attribute for build rules
160 allow us to specify a dependency on output from
161 a source generation rule'''
162 if getattr(self , 'depends_on', None):
163 lst = self.to_list(self.depends_on)
165 y = self.bld.name_to_obj(x, self.env)
166 self.bld.ASSERT(y is not None, "Failed to find dependency %s of %s" % (x, self.name))
168 if getattr(y, 'more_includes', None):
169 self.includes += " " + y.more_includes
172 os_path_relpath = getattr(os.path, 'relpath', None)
173 if os_path_relpath is None:
174 # Python < 2.6 does not have os.path.relpath, provide a replacement
175 # (imported from Python2.6.5~rc2)
176 def os_path_relpath(path, start):
177 """Return a relative version of a path"""
178 start_list = os.path.abspath(start).split("/")
179 path_list = os.path.abspath(path).split("/")
181 # Work out how much of the filepath is shared by start and path.
182 i = len(os.path.commonprefix([start_list, path_list]))
184 rel_list = ['..'] * (len(start_list)-i) + path_list[i:]
187 return os.path.join(*rel_list)
190 def unique_list(seq):
191 '''return a uniquified list in the same order as the existing list'''
195 if item in seen: continue
201 def TO_LIST(str, delimiter=None):
202 '''Split a list, preserving quoted strings and existing lists'''
205 if isinstance(str, list):
207 lst = str.split(delimiter)
208 # the string may have had quotes in it, now we
209 # check if we did have quotes, and use the slower shlex
213 return shlex.split(str)
217 def subst_vars_error(string, env):
218 '''substitute vars, throw an error if a variable is not defined'''
219 lst = re.split('(\$\{\w+\})', string)
222 if re.match('\$\{\w+\}', v):
225 Logs.error("Failed to find variable %s in %s" % (vname, string))
233 def SUBST_ENV_VAR(ctx, varname):
234 '''Substitute an environment variable for any embedded variables'''
235 return subst_vars_error(ctx.env[varname], ctx.env)
236 Build.BuildContext.SUBST_ENV_VAR = SUBST_ENV_VAR
239 def ENFORCE_GROUP_ORDERING(bld):
240 '''enforce group ordering for the project. This
241 makes the group ordering apply only when you specify
242 a target with --target'''
243 if Options.options.compile_targets:
245 @before('exec_rule', 'apply_core', 'collect')
246 def force_previous_groups(self):
247 if getattr(self.bld, 'enforced_group_ordering', False) == True:
249 self.bld.enforced_group_ordering = True
252 tm = self.bld.task_manager
253 return [x for x in tm.groups_names if id(tm.groups_names[x]) == id(g)][0]
258 for g in bld.task_manager.groups:
259 for t in g.tasks_gen:
262 debug('group: Forcing up to group %s for target %s',
263 group_name(g), self.name or self.target)
270 for i in xrange(len(bld.task_manager.groups)):
271 g = bld.task_manager.groups[i]
272 bld.task_manager.current_group = i
275 debug('group: Forcing group %s', group_name(g))
276 for t in g.tasks_gen:
277 if not getattr(t, 'forced_groups', False):
278 debug('group: Posting %s', t.name or t.target)
279 t.forced_groups = True
281 Build.BuildContext.ENFORCE_GROUP_ORDERING = ENFORCE_GROUP_ORDERING
284 def recursive_dirlist(dir, relbase, pattern=None):
285 '''recursive directory list'''
287 for f in os.listdir(dir):
289 if os.path.isdir(f2):
290 ret.extend(recursive_dirlist(f2, relbase))
292 if pattern and not fnmatch.fnmatch(f, pattern):
294 ret.append(os_path_relpath(f2, relbase))
300 if os.path.isdir(dir):
302 mkdir_p(os.path.dirname(dir))
306 def SUBST_VARS_RECURSIVE(string, env):
307 '''recursively expand variables'''
311 while (string.find('${') != -1 and limit > 0):
312 string = subst_vars_error(string, env)
318 def EXPAND_VARIABLES(ctx, varstr, vars=None):
319 '''expand variables from a user supplied dictionary
321 This is most useful when you pass vars=locals() to expand
322 all your local variables in strings
325 if isinstance(varstr, list):
328 ret.append(EXPAND_VARIABLES(ctx, s, vars=vars))
332 env = Environment.Environment()
334 # substitute on user supplied dict if avaiilable
336 for v in vars.keys():
338 ret = SUBST_VARS_RECURSIVE(ret, env)
340 # if anything left, subst on the environment as well
341 if ret.find('${') != -1:
342 ret = SUBST_VARS_RECURSIVE(ret, ctx.env)
343 # make sure there is nothing left. Also check for the common
344 # typo of $( instead of ${
345 if ret.find('${') != -1 or ret.find('$(') != -1:
346 Logs.error('Failed to substitute all variables in varstr=%s' % ret)
349 Build.BuildContext.EXPAND_VARIABLES = EXPAND_VARIABLES
355 '''run a external command, return exit code or signal'''
357 cmd = SUBST_VARS_RECURSIVE(cmd, env)
359 status = os.system(cmd)
360 if os.WIFEXITED(status):
361 return os.WEXITSTATUS(status)
362 if os.WIFSIGNALED(status):
363 return - os.WTERMSIG(status)
364 Logs.error("Unknown exit reason %d for command: %s" (status, cmd))
368 # make sure we have md5. some systems don't have it
370 from hashlib import md5
376 Constants.SIG_NIL = hash('abcd')
377 class replace_md5(object):
380 def update(self, val):
381 self.val = hash((self.val, val))
385 return self.digest().encode('hex')
386 def replace_h_file(filename):
387 f = open(filename, 'rb')
390 filename = f.read(100000)
394 Utils.md5 = replace_md5
395 Task.md5 = replace_md5
396 Utils.h_file = replace_h_file
399 def LOAD_ENVIRONMENT():
400 '''load the configuration environment, allowing access to env vars
403 env = Environment.Environment()
405 env.load('.lock-wscript')
406 env.load(env.blddir + '/c4che/default.cache.py')
412 def IS_NEWER(bld, file1, file2):
413 '''return True if file1 is newer than file2'''
414 t1 = os.stat(os.path.join(bld.curdir, file1)).st_mtime
415 t2 = os.stat(os.path.join(bld.curdir, file2)).st_mtime
417 Build.BuildContext.IS_NEWER = IS_NEWER
421 def RECURSE(ctx, directory):
422 '''recurse into a directory, relative to the curdir or top level'''
424 visited_dirs = ctx.visited_dirs
426 visited_dirs = ctx.visited_dirs = set()
427 d = os.path.join(ctx.curdir, directory)
428 if os.path.exists(d):
429 abspath = os.path.abspath(d)
431 abspath = os.path.abspath(os.path.join(Utils.g_module.srcdir, directory))
432 ctxclass = ctx.__class__.__name__
433 key = ctxclass + ':' + abspath
434 if key in visited_dirs:
437 visited_dirs.add(key)
438 relpath = os_path_relpath(abspath, ctx.curdir)
439 if ctxclass == 'Handler':
440 return ctx.sub_options(relpath)
441 if ctxclass == 'ConfigurationContext':
442 return ctx.sub_config(relpath)
443 if ctxclass == 'BuildContext':
444 return ctx.add_subdirs(relpath)
445 Logs.error('Unknown RECURSE context class', ctxclass)
447 Options.Handler.RECURSE = RECURSE
448 Build.BuildContext.RECURSE = RECURSE
451 def CHECK_MAKEFLAGS(bld):
452 '''check for MAKEFLAGS environment variable in case we are being
453 called from a Makefile try to honor a few make command line flags'''
454 if not 'WAF_MAKE' in os.environ:
456 makeflags = os.environ.get('MAKEFLAGS')
458 # we need to use shlex.split to cope with the escaping of spaces
460 for opt in shlex.split(makeflags):
461 # options can come either as -x or as x
463 Options.options.verbose = Logs.verbose = int(opt[2:])
465 Logs.zones = ['runner']
468 elif opt[0].isupper() and opt.find('=') != -1:
470 setattr(Options.options, opt[0:loc], opt[loc+1:])
476 Options.options.keep = True
480 Options.options.keep = True
483 Options.options.jobs = 1
485 Build.BuildContext.CHECK_MAKEFLAGS = CHECK_MAKEFLAGS
489 def option_group(opt, name):
490 '''find or create an option group'''
492 if name in option_groups:
493 return option_groups[name]
494 gr = opt.add_option_group(name)
495 option_groups[name] = gr
497 Options.Handler.option_group = option_group
500 def save_file(filename, contents, create_dir=False):
501 '''save data to a file'''
503 mkdir_p(os.path.dirname(filename))
505 f = open(filename, 'w')
513 def load_file(filename):
514 '''return contents of a file'''
516 f = open(filename, 'r')
524 def reconfigure(ctx):
525 '''rerun configure if necessary'''
526 import Configure, samba_wildcard, Scripting
527 if not os.path.exists(".lock-wscript"):
528 raise Utils.WafError('configure has not been run')
529 bld = samba_wildcard.fake_build_environment()
530 Configure.autoconfig = True
531 Scripting.check_configured(bld)
534 def map_shlib_extension(ctx, name, python=False):
535 '''map a filename with a shared library extension of .so to the real shlib name'''
538 if name[-1:].isdigit():
539 # some libraries have specified versions in the wscript rule
541 (root1, ext1) = os.path.splitext(name)
543 (root2, ext2) = os.path.splitext(ctx.env.pyext_PATTERN)
545 (root2, ext2) = os.path.splitext(ctx.env.shlib_PATTERN)
547 Build.BuildContext.map_shlib_extension = map_shlib_extension
550 def make_libname(ctx, name, nolibprefix=False, version=None, python=False):
551 """make a library filename
553 nolibprefix: don't include the lib prefix
554 version : add a version number
555 python : if we should use python module name conventions"""
558 libname = ctx.env.pyext_PATTERN % name
560 libname = ctx.env.shlib_PATTERN % name
561 if nolibprefix and libname[0:3] == 'lib':
562 libname = libname[3:]
564 if version[0] == '.':
565 version = version[1:]
566 (root, ext) = os.path.splitext(libname)
568 # special case - version goes before the prefix
569 libname = "%s.%s%s" % (root, version, ext)
571 libname = "%s%s.%s" % (root, ext, version)
573 Build.BuildContext.make_libname = make_libname
576 def get_tgt_list(bld):
577 '''return a list of build objects for samba'''
579 targets = LOCAL_CACHE(bld, 'TARGET_TYPE')
581 # build a list of task generators we are interested in
585 if not type in ['SUBSYSTEM', 'MODULE', 'BINARY', 'LIBRARY', 'ASN1', 'PYTHON']:
587 t = bld.name_to_obj(tgt, bld.env)
589 Logs.error("Target %s of type %s has no task generator" % (tgt, type))