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 needs_private_lib(bld, target):
67 '''return True if a target links to a private library'''
68 for lib in getattr(target, "final_libs", []):
69 t = bld.name_to_obj(lib, bld.env)
70 if t and getattr(t, 'private_library', False):
75 def install_rpath(target):
76 '''the rpath value for installation'''
80 if bld.env.RPATH_ON_INSTALL:
81 ret.add(bld.EXPAND_VARIABLES(bld.env.LIBDIR))
82 if bld.env.RPATH_ON_INSTALL_PRIVATE and needs_private_lib(bld, target):
83 ret.add(bld.EXPAND_VARIABLES(bld.env.PRIVATELIBDIR))
88 '''the rpath value for build'''
89 rpaths = [os.path.normpath('%s/%s' % (bld.env.BUILD_DIRECTORY, d)) for d in ("shared", "shared/private")]
91 if bld.env.RPATH_ON_BUILD:
94 ADD_LD_LIBRARY_PATH(rpath)
99 def LOCAL_CACHE(ctx, name):
100 '''return a named build cache dictionary, used to store
101 state inside other functions'''
109 def LOCAL_CACHE_SET(ctx, cachename, key, value):
110 '''set a value in a local cache'''
111 cache = LOCAL_CACHE(ctx, cachename)
116 def ASSERT(ctx, expression, msg):
117 '''a build assert call'''
119 raise Utils.WafError("ERROR: %s\n" % msg)
120 Build.BuildContext.ASSERT = ASSERT
123 def SUBDIR(bld, subdir, list):
124 '''create a list of files by pre-pending each with a subdir name'''
126 for l in TO_LIST(list):
127 ret = ret + os.path.normpath(os.path.join(subdir, l)) + ' '
129 Build.BuildContext.SUBDIR = SUBDIR
132 def dict_concat(d1, d2):
133 '''concatenate two dictionaries d1 += d2'''
139 def exec_command(self, cmd, **kw):
140 '''this overrides the 'waf -v' debug output to be in a nice
141 unix like format instead of a python list.
142 Thanks to ita on #waf for this'''
145 if isinstance(cmd, list):
147 debug('runner: %s' % _cmd)
149 self.log.write('%s\n' % cmd)
152 if not kw.get('cwd', None):
154 except AttributeError:
155 self.cwd = kw['cwd'] = self.bldnode.abspath()
156 return Utils.exec_command(cmd, **kw)
157 Build.BuildContext.exec_command = exec_command
160 def ADD_COMMAND(opt, name, function):
161 '''add a new top level command to waf'''
162 Utils.g_module.__dict__[name] = function
164 Options.Handler.ADD_COMMAND = ADD_COMMAND
167 @feature('cc', 'cshlib', 'cprogram')
168 @before('apply_core','exec_rule')
169 def process_depends_on(self):
170 '''The new depends_on attribute for build rules
171 allow us to specify a dependency on output from
172 a source generation rule'''
173 if getattr(self , 'depends_on', None):
174 lst = self.to_list(self.depends_on)
176 y = self.bld.name_to_obj(x, self.env)
177 self.bld.ASSERT(y is not None, "Failed to find dependency %s of %s" % (x, self.name))
179 if getattr(y, 'more_includes', None):
180 self.includes += " " + y.more_includes
183 os_path_relpath = getattr(os.path, 'relpath', None)
184 if os_path_relpath is None:
185 # Python < 2.6 does not have os.path.relpath, provide a replacement
186 # (imported from Python2.6.5~rc2)
187 def os_path_relpath(path, start):
188 """Return a relative version of a path"""
189 start_list = os.path.abspath(start).split("/")
190 path_list = os.path.abspath(path).split("/")
192 # Work out how much of the filepath is shared by start and path.
193 i = len(os.path.commonprefix([start_list, path_list]))
195 rel_list = ['..'] * (len(start_list)-i) + path_list[i:]
198 return os.path.join(*rel_list)
201 def unique_list(seq):
202 '''return a uniquified list in the same order as the existing list'''
206 if item in seen: continue
212 def TO_LIST(str, delimiter=None):
213 '''Split a list, preserving quoted strings and existing lists'''
216 if isinstance(str, list):
218 lst = str.split(delimiter)
219 # the string may have had quotes in it, now we
220 # check if we did have quotes, and use the slower shlex
224 return shlex.split(str)
228 def subst_vars_error(string, env):
229 '''substitute vars, throw an error if a variable is not defined'''
230 lst = re.split('(\$\{\w+\})', string)
233 if re.match('\$\{\w+\}', v):
236 Logs.error("Failed to find variable %s in %s" % (vname, string))
244 def SUBST_ENV_VAR(ctx, varname):
245 '''Substitute an environment variable for any embedded variables'''
246 return subst_vars_error(ctx.env[varname], ctx.env)
247 Build.BuildContext.SUBST_ENV_VAR = SUBST_ENV_VAR
250 def ENFORCE_GROUP_ORDERING(bld):
251 '''enforce group ordering for the project. This
252 makes the group ordering apply only when you specify
253 a target with --target'''
254 if Options.options.compile_targets:
256 @before('exec_rule', 'apply_core', 'collect')
257 def force_previous_groups(self):
258 if getattr(self.bld, 'enforced_group_ordering', False) == True:
260 self.bld.enforced_group_ordering = True
263 tm = self.bld.task_manager
264 return [x for x in tm.groups_names if id(tm.groups_names[x]) == id(g)][0]
269 for g in bld.task_manager.groups:
270 for t in g.tasks_gen:
273 debug('group: Forcing up to group %s for target %s',
274 group_name(g), self.name or self.target)
281 for i in xrange(len(bld.task_manager.groups)):
282 g = bld.task_manager.groups[i]
283 bld.task_manager.current_group = i
286 debug('group: Forcing group %s', group_name(g))
287 for t in g.tasks_gen:
288 if not getattr(t, 'forced_groups', False):
289 debug('group: Posting %s', t.name or t.target)
290 t.forced_groups = True
292 Build.BuildContext.ENFORCE_GROUP_ORDERING = ENFORCE_GROUP_ORDERING
295 def recursive_dirlist(dir, relbase, pattern=None):
296 '''recursive directory list'''
298 for f in os.listdir(dir):
300 if os.path.isdir(f2):
301 ret.extend(recursive_dirlist(f2, relbase))
303 if pattern and not fnmatch.fnmatch(f, pattern):
305 ret.append(os_path_relpath(f2, relbase))
313 if dir.endswith("/"):
316 if os.path.isdir(dir):
318 mkdir_p(os.path.dirname(dir))
322 def SUBST_VARS_RECURSIVE(string, env):
323 '''recursively expand variables'''
327 while (string.find('${') != -1 and limit > 0):
328 string = subst_vars_error(string, env)
334 def EXPAND_VARIABLES(ctx, varstr, vars=None):
335 '''expand variables from a user supplied dictionary
337 This is most useful when you pass vars=locals() to expand
338 all your local variables in strings
341 if isinstance(varstr, list):
344 ret.append(EXPAND_VARIABLES(ctx, s, vars=vars))
347 if not isinstance(varstr, str):
351 env = Environment.Environment()
353 # substitute on user supplied dict if avaiilable
355 for v in vars.keys():
357 ret = SUBST_VARS_RECURSIVE(ret, env)
359 # if anything left, subst on the environment as well
360 if ret.find('${') != -1:
361 ret = SUBST_VARS_RECURSIVE(ret, ctx.env)
362 # make sure there is nothing left. Also check for the common
363 # typo of $( instead of ${
364 if ret.find('${') != -1 or ret.find('$(') != -1:
365 Logs.error('Failed to substitute all variables in varstr=%s' % ret)
368 Build.BuildContext.EXPAND_VARIABLES = EXPAND_VARIABLES
374 '''run a external command, return exit code or signal'''
376 cmd = SUBST_VARS_RECURSIVE(cmd, env)
378 status = os.system(cmd)
379 if os.WIFEXITED(status):
380 return os.WEXITSTATUS(status)
381 if os.WIFSIGNALED(status):
382 return - os.WTERMSIG(status)
383 Logs.error("Unknown exit reason %d for command: %s" (status, cmd))
387 # make sure we have md5. some systems don't have it
389 from hashlib import md5
395 Constants.SIG_NIL = hash('abcd')
396 class replace_md5(object):
399 def update(self, val):
400 self.val = hash((self.val, val))
404 return self.digest().encode('hex')
405 def replace_h_file(filename):
406 f = open(filename, 'rb')
409 filename = f.read(100000)
413 Utils.md5 = replace_md5
414 Task.md5 = replace_md5
415 Utils.h_file = replace_h_file
418 def LOAD_ENVIRONMENT():
419 '''load the configuration environment, allowing access to env vars
422 env = Environment.Environment()
424 env.load('.lock-wscript')
425 env.load(env.blddir + '/c4che/default.cache.py')
431 def IS_NEWER(bld, file1, file2):
432 '''return True if file1 is newer than file2'''
433 t1 = os.stat(os.path.join(bld.curdir, file1)).st_mtime
434 t2 = os.stat(os.path.join(bld.curdir, file2)).st_mtime
436 Build.BuildContext.IS_NEWER = IS_NEWER
440 def RECURSE(ctx, directory):
441 '''recurse into a directory, relative to the curdir or top level'''
443 visited_dirs = ctx.visited_dirs
445 visited_dirs = ctx.visited_dirs = set()
446 d = os.path.join(ctx.curdir, directory)
447 if os.path.exists(d):
448 abspath = os.path.abspath(d)
450 abspath = os.path.abspath(os.path.join(Utils.g_module.srcdir, directory))
451 ctxclass = ctx.__class__.__name__
452 key = ctxclass + ':' + abspath
453 if key in visited_dirs:
456 visited_dirs.add(key)
457 relpath = os_path_relpath(abspath, ctx.curdir)
458 if ctxclass == 'Handler':
459 return ctx.sub_options(relpath)
460 if ctxclass == 'ConfigurationContext':
461 return ctx.sub_config(relpath)
462 if ctxclass == 'BuildContext':
463 return ctx.add_subdirs(relpath)
464 Logs.error('Unknown RECURSE context class', ctxclass)
466 Options.Handler.RECURSE = RECURSE
467 Build.BuildContext.RECURSE = RECURSE
470 def CHECK_MAKEFLAGS(bld):
471 '''check for MAKEFLAGS environment variable in case we are being
472 called from a Makefile try to honor a few make command line flags'''
473 if not 'WAF_MAKE' in os.environ:
475 makeflags = os.environ.get('MAKEFLAGS')
476 if makeflags is None:
479 # we need to use shlex.split to cope with the escaping of spaces
481 for opt in shlex.split(makeflags):
482 # options can come either as -x or as x
484 Options.options.verbose = Logs.verbose = int(opt[2:])
486 Logs.zones = ['runner']
489 elif opt[0].isupper() and opt.find('=') != -1:
490 # this allows us to set waf options on the make command line
491 # for example, if you do "make FOO=blah", then we set the
492 # option 'FOO' in Options.options, to blah. If you look in wafsamba/wscript
493 # you will see that the command line accessible options have their dest=
494 # set to uppercase, to allow for passing of options from make in this way
495 # this is also how "make test TESTS=testpattern" works, and
496 # "make VERBOSE=1" as well as things like "make SYMBOLCHECK=1"
498 setattr(Options.options, opt[0:loc], opt[loc+1:])
504 Options.options.keep = True
508 Options.options.keep = True
511 Options.options.jobs = 1
513 Build.BuildContext.CHECK_MAKEFLAGS = CHECK_MAKEFLAGS
517 def option_group(opt, name):
518 '''find or create an option group'''
520 if name in option_groups:
521 return option_groups[name]
522 gr = opt.add_option_group(name)
523 option_groups[name] = gr
525 Options.Handler.option_group = option_group
528 def save_file(filename, contents, create_dir=False):
529 '''save data to a file'''
531 mkdir_p(os.path.dirname(filename))
533 f = open(filename, 'w')
541 def load_file(filename):
542 '''return contents of a file'''
544 f = open(filename, 'r')
552 def reconfigure(ctx):
553 '''rerun configure if necessary'''
554 import Configure, samba_wildcard, Scripting
555 if not os.path.exists(".lock-wscript"):
556 raise Utils.WafError('configure has not been run')
557 bld = samba_wildcard.fake_build_environment()
558 Configure.autoconfig = True
559 Scripting.check_configured(bld)
562 def map_shlib_extension(ctx, name, python=False):
563 '''map a filename with a shared library extension of .so to the real shlib name'''
566 if name[-1:].isdigit():
567 # some libraries have specified versions in the wscript rule
569 (root1, ext1) = os.path.splitext(name)
571 (root2, ext2) = os.path.splitext(ctx.env.pyext_PATTERN)
573 (root2, ext2) = os.path.splitext(ctx.env.shlib_PATTERN)
575 Build.BuildContext.map_shlib_extension = map_shlib_extension
577 def apply_pattern(filename, pattern):
578 '''apply a filename pattern to a filename that may have a directory component'''
579 dirname = os.path.dirname(filename)
581 return pattern % filename
582 basename = os.path.basename(filename)
583 return os.path.join(dirname, pattern % basename)
585 def make_libname(ctx, name, nolibprefix=False, version=None, python=False):
586 """make a library filename
588 nolibprefix: don't include the lib prefix
589 version : add a version number
590 python : if we should use python module name conventions"""
593 libname = apply_pattern(name, ctx.env.pyext_PATTERN)
595 libname = apply_pattern(name, ctx.env.shlib_PATTERN)
596 if nolibprefix and libname[0:3] == 'lib':
597 libname = libname[3:]
599 if version[0] == '.':
600 version = version[1:]
601 (root, ext) = os.path.splitext(libname)
603 # special case - version goes before the prefix
604 libname = "%s.%s%s" % (root, version, ext)
606 libname = "%s%s.%s" % (root, ext, version)
608 Build.BuildContext.make_libname = make_libname
611 def get_tgt_list(bld):
612 '''return a list of build objects for samba'''
614 targets = LOCAL_CACHE(bld, 'TARGET_TYPE')
616 # build a list of task generators we are interested in
620 if not type in ['SUBSYSTEM', 'MODULE', 'BINARY', 'LIBRARY', 'ASN1', 'PYTHON']:
622 t = bld.name_to_obj(tgt, bld.env)
624 Logs.error("Target %s of type %s has no task generator" % (tgt, type))