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'''
69 if bld.env.RPATH_ON_INSTALL:
70 return ['%s/lib' % bld.env.PREFIX]
75 '''the rpath value for build'''
76 rpath = os.path.normpath('%s/%s' % (bld.env.BUILD_DIRECTORY, LIB_PATH))
78 if bld.env.RPATH_ON_BUILD:
80 ADD_LD_LIBRARY_PATH(rpath)
85 def LOCAL_CACHE(ctx, name):
86 '''return a named build cache dictionary, used to store
87 state inside other functions'''
95 def LOCAL_CACHE_SET(ctx, cachename, key, value):
96 '''set a value in a local cache'''
97 cache = LOCAL_CACHE(ctx, cachename)
102 def ASSERT(ctx, expression, msg):
103 '''a build assert call'''
105 Logs.error("ERROR: %s\n" % msg)
107 Build.BuildContext.ASSERT = ASSERT
110 def SUBDIR(bld, subdir, list):
111 '''create a list of files by pre-pending each with a subdir name'''
113 for l in TO_LIST(list):
114 ret = ret + os.path.normpath(os.path.join(subdir, l)) + ' '
116 Build.BuildContext.SUBDIR = SUBDIR
119 def dict_concat(d1, d2):
120 '''concatenate two dictionaries d1 += d2'''
126 def exec_command(self, cmd, **kw):
127 '''this overrides the 'waf -v' debug output to be in a nice
128 unix like format instead of a python list.
129 Thanks to ita on #waf for this'''
132 if isinstance(cmd, list):
134 debug('runner: %s' % _cmd)
136 self.log.write('%s\n' % cmd)
139 if not kw.get('cwd', None):
141 except AttributeError:
142 self.cwd = kw['cwd'] = self.bldnode.abspath()
143 return Utils.exec_command(cmd, **kw)
144 Build.BuildContext.exec_command = exec_command
147 def ADD_COMMAND(opt, name, function):
148 '''add a new top level command to waf'''
149 Utils.g_module.__dict__[name] = function
151 Options.Handler.ADD_COMMAND = ADD_COMMAND
154 @feature('cc', 'cshlib', 'cprogram')
155 @before('apply_core','exec_rule')
156 def process_depends_on(self):
157 '''The new depends_on attribute for build rules
158 allow us to specify a dependency on output from
159 a source generation rule'''
160 if getattr(self , 'depends_on', None):
161 lst = self.to_list(self.depends_on)
163 y = self.bld.name_to_obj(x, self.env)
164 self.bld.ASSERT(y is not None, "Failed to find dependency %s of %s" % (x, self.name))
166 if getattr(y, 'more_includes', None):
167 self.includes += " " + y.more_includes
170 os_path_relpath = getattr(os.path, 'relpath', None)
171 if os_path_relpath is None:
172 # Python < 2.6 does not have os.path.relpath, provide a replacement
173 # (imported from Python2.6.5~rc2)
174 def os_path_relpath(path, start):
175 """Return a relative version of a path"""
176 start_list = os.path.abspath(start).split("/")
177 path_list = os.path.abspath(path).split("/")
179 # Work out how much of the filepath is shared by start and path.
180 i = len(os.path.commonprefix([start_list, path_list]))
182 rel_list = ['..'] * (len(start_list)-i) + path_list[i:]
185 return os.path.join(*rel_list)
188 def unique_list(seq):
189 '''return a uniquified list in the same order as the existing list'''
193 if item in seen: continue
199 def TO_LIST(str, delimiter=None):
200 '''Split a list, preserving quoted strings and existing lists'''
203 if isinstance(str, list):
205 lst = str.split(delimiter)
206 # the string may have had quotes in it, now we
207 # check if we did have quotes, and use the slower shlex
211 return shlex.split(str)
215 def subst_vars_error(string, env):
216 '''substitute vars, throw an error if a variable is not defined'''
217 lst = re.split('(\$\{\w+\})', string)
220 if re.match('\$\{\w+\}', v):
223 Logs.error("Failed to find variable %s in %s" % (vname, string))
231 def SUBST_ENV_VAR(ctx, varname):
232 '''Substitute an environment variable for any embedded variables'''
233 return subst_vars_error(ctx.env[varname], ctx.env)
234 Build.BuildContext.SUBST_ENV_VAR = SUBST_ENV_VAR
237 def ENFORCE_GROUP_ORDERING(bld):
238 '''enforce group ordering for the project. This
239 makes the group ordering apply only when you specify
240 a target with --target'''
241 if Options.options.compile_targets:
243 @before('exec_rule', 'apply_core', 'collect')
244 def force_previous_groups(self):
245 if getattr(self.bld, 'enforced_group_ordering', False) == True:
247 self.bld.enforced_group_ordering = True
250 tm = self.bld.task_manager
251 return [x for x in tm.groups_names if id(tm.groups_names[x]) == id(g)][0]
256 for g in bld.task_manager.groups:
257 for t in g.tasks_gen:
260 debug('group: Forcing up to group %s for target %s',
261 group_name(g), self.name or self.target)
268 for i in xrange(len(bld.task_manager.groups)):
269 g = bld.task_manager.groups[i]
270 bld.task_manager.current_group = i
273 debug('group: Forcing group %s', group_name(g))
274 for t in g.tasks_gen:
275 if not getattr(t, 'forced_groups', False):
276 debug('group: Posting %s', t.name or t.target)
277 t.forced_groups = True
279 Build.BuildContext.ENFORCE_GROUP_ORDERING = ENFORCE_GROUP_ORDERING
282 def recursive_dirlist(dir, relbase, pattern=None):
283 '''recursive directory list'''
285 for f in os.listdir(dir):
287 if os.path.isdir(f2):
288 ret.extend(recursive_dirlist(f2, relbase))
290 if pattern and not fnmatch.fnmatch(f, pattern):
292 ret.append(os_path_relpath(f2, relbase))
298 if os.path.isdir(dir):
300 mkdir_p(os.path.dirname(dir))
304 def SUBST_VARS_RECURSIVE(string, env):
305 '''recursively expand variables'''
309 while (string.find('${') != -1 and limit > 0):
310 string = subst_vars_error(string, env)
316 def EXPAND_VARIABLES(ctx, varstr, vars=None):
317 '''expand variables from a user supplied dictionary
319 This is most useful when you pass vars=locals() to expand
320 all your local variables in strings
323 if isinstance(varstr, list):
326 ret.append(EXPAND_VARIABLES(ctx, s, vars=vars))
330 env = Environment.Environment()
332 # substitute on user supplied dict if avaiilable
334 for v in vars.keys():
336 ret = SUBST_VARS_RECURSIVE(ret, env)
338 # if anything left, subst on the environment as well
339 if ret.find('${') != -1:
340 ret = SUBST_VARS_RECURSIVE(ret, ctx.env)
341 # make sure there is nothing left. Also check for the common
342 # typo of $( instead of ${
343 if ret.find('${') != -1 or ret.find('$(') != -1:
344 Logs.error('Failed to substitute all variables in varstr=%s' % ret)
347 Build.BuildContext.EXPAND_VARIABLES = EXPAND_VARIABLES
353 '''run a external command, return exit code or signal'''
355 cmd = SUBST_VARS_RECURSIVE(cmd, env)
357 status = os.system(cmd)
358 if os.WIFEXITED(status):
359 return os.WEXITSTATUS(status)
360 if os.WIFSIGNALED(status):
361 return - os.WTERMSIG(status)
362 Logs.error("Unknown exit reason %d for command: %s" (status, cmd))
366 # make sure we have md5. some systems don't have it
368 from hashlib import md5
374 Constants.SIG_NIL = hash('abcd')
375 class replace_md5(object):
378 def update(self, val):
379 self.val = hash((self.val, val))
383 return self.digest().encode('hex')
384 def replace_h_file(filename):
385 f = open(filename, 'rb')
388 filename = f.read(100000)
392 Utils.md5 = replace_md5
393 Task.md5 = replace_md5
394 Utils.h_file = replace_h_file
397 def LOAD_ENVIRONMENT():
398 '''load the configuration environment, allowing access to env vars
401 env = Environment.Environment()
403 env.load('.lock-wscript')
404 env.load(env.blddir + '/c4che/default.cache.py')
410 def IS_NEWER(bld, file1, file2):
411 '''return True if file1 is newer than file2'''
412 t1 = os.stat(os.path.join(bld.curdir, file1)).st_mtime
413 t2 = os.stat(os.path.join(bld.curdir, file2)).st_mtime
415 Build.BuildContext.IS_NEWER = IS_NEWER
419 def RECURSE(ctx, directory):
420 '''recurse into a directory, relative to the curdir or top level'''
422 visited_dirs = ctx.visited_dirs
424 visited_dirs = ctx.visited_dirs = set()
425 d = os.path.join(ctx.curdir, directory)
426 if os.path.exists(d):
427 abspath = os.path.abspath(d)
429 abspath = os.path.abspath(os.path.join(Utils.g_module.srcdir, directory))
430 ctxclass = ctx.__class__.__name__
431 key = ctxclass + ':' + abspath
432 if key in visited_dirs:
435 visited_dirs.add(key)
436 relpath = os_path_relpath(abspath, ctx.curdir)
437 if ctxclass == 'Handler':
438 return ctx.sub_options(relpath)
439 if ctxclass == 'ConfigurationContext':
440 return ctx.sub_config(relpath)
441 if ctxclass == 'BuildContext':
442 return ctx.add_subdirs(relpath)
443 Logs.error('Unknown RECURSE context class', ctxclass)
445 Options.Handler.RECURSE = RECURSE
446 Build.BuildContext.RECURSE = RECURSE
449 def CHECK_MAKEFLAGS(bld):
450 '''check for MAKEFLAGS environment variable in case we are being
451 called from a Makefile try to honor a few make command line flags'''
452 if not 'WAF_MAKE' in os.environ:
454 makeflags = os.environ.get('MAKEFLAGS')
456 # we need to use shlex.split to cope with the escaping of spaces
458 for opt in shlex.split(makeflags):
459 # options can come either as -x or as x
461 Options.options.verbose = Logs.verbose = int(opt[2:])
463 Logs.zones = ['runner']
466 elif opt[0].isupper() and opt.find('=') != -1:
468 setattr(Options.options, opt[0:loc], opt[loc+1:])
474 Options.options.keep = True
478 Options.options.keep = True
481 Options.options.jobs = 1
483 Build.BuildContext.CHECK_MAKEFLAGS = CHECK_MAKEFLAGS
487 def option_group(opt, name):
488 '''find or create an option group'''
490 if name in option_groups:
491 return option_groups[name]
492 gr = opt.add_option_group(name)
493 option_groups[name] = gr
495 Options.Handler.option_group = option_group
498 def save_file(filename, contents, create_dir=False):
499 '''save data to a file'''
501 mkdir_p(os.path.dirname(filename))
503 f = open(filename, 'w')
511 def load_file(filename):
512 '''return contents of a file'''
514 f = open(filename, 'r')
522 def reconfigure(ctx):
523 '''rerun configure if necessary'''
524 import Configure, samba_wildcard, Scripting
525 if not os.path.exists(".lock-wscript"):
526 raise Utils.WafError('configure has not been run')
527 bld = samba_wildcard.fake_build_environment()
528 Configure.autoconfig = True
529 Scripting.check_configured(bld)