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 raise KeyError("Failed to find variable %s in %s" % (vname, string))
243 def SUBST_ENV_VAR(ctx, varname):
244 '''Substitute an environment variable for any embedded variables'''
245 return subst_vars_error(ctx.env[varname], ctx.env)
246 Build.BuildContext.SUBST_ENV_VAR = SUBST_ENV_VAR
249 def ENFORCE_GROUP_ORDERING(bld):
250 '''enforce group ordering for the project. This
251 makes the group ordering apply only when you specify
252 a target with --target'''
253 if Options.options.compile_targets:
255 @before('exec_rule', 'apply_core', 'collect')
256 def force_previous_groups(self):
257 if getattr(self.bld, 'enforced_group_ordering', False) == True:
259 self.bld.enforced_group_ordering = True
262 tm = self.bld.task_manager
263 return [x for x in tm.groups_names if id(tm.groups_names[x]) == id(g)][0]
268 for g in bld.task_manager.groups:
269 for t in g.tasks_gen:
272 debug('group: Forcing up to group %s for target %s',
273 group_name(g), self.name or self.target)
280 for i in xrange(len(bld.task_manager.groups)):
281 g = bld.task_manager.groups[i]
282 bld.task_manager.current_group = i
285 debug('group: Forcing group %s', group_name(g))
286 for t in g.tasks_gen:
287 if not getattr(t, 'forced_groups', False):
288 debug('group: Posting %s', t.name or t.target)
289 t.forced_groups = True
291 Build.BuildContext.ENFORCE_GROUP_ORDERING = ENFORCE_GROUP_ORDERING
294 def recursive_dirlist(dir, relbase, pattern=None):
295 '''recursive directory list'''
297 for f in os.listdir(dir):
299 if os.path.isdir(f2):
300 ret.extend(recursive_dirlist(f2, relbase))
302 if pattern and not fnmatch.fnmatch(f, pattern):
304 ret.append(os_path_relpath(f2, relbase))
312 if dir.endswith("/"):
315 if os.path.isdir(dir):
317 mkdir_p(os.path.dirname(dir))
321 def SUBST_VARS_RECURSIVE(string, env):
322 '''recursively expand variables'''
326 while (string.find('${') != -1 and limit > 0):
327 string = subst_vars_error(string, env)
333 def EXPAND_VARIABLES(ctx, varstr, vars=None):
334 '''expand variables from a user supplied dictionary
336 This is most useful when you pass vars=locals() to expand
337 all your local variables in strings
340 if isinstance(varstr, list):
343 ret.append(EXPAND_VARIABLES(ctx, s, vars=vars))
346 if not isinstance(varstr, str):
350 env = Environment.Environment()
352 # substitute on user supplied dict if avaiilable
354 for v in vars.keys():
356 ret = SUBST_VARS_RECURSIVE(ret, env)
358 # if anything left, subst on the environment as well
359 if ret.find('${') != -1:
360 ret = SUBST_VARS_RECURSIVE(ret, ctx.env)
361 # make sure there is nothing left. Also check for the common
362 # typo of $( instead of ${
363 if ret.find('${') != -1 or ret.find('$(') != -1:
364 Logs.error('Failed to substitute all variables in varstr=%s' % ret)
367 Build.BuildContext.EXPAND_VARIABLES = EXPAND_VARIABLES
373 '''run a external command, return exit code or signal'''
375 cmd = SUBST_VARS_RECURSIVE(cmd, env)
377 status = os.system(cmd)
378 if os.WIFEXITED(status):
379 return os.WEXITSTATUS(status)
380 if os.WIFSIGNALED(status):
381 return - os.WTERMSIG(status)
382 Logs.error("Unknown exit reason %d for command: %s" (status, cmd))
386 # make sure we have md5. some systems don't have it
388 from hashlib import md5
394 Constants.SIG_NIL = hash('abcd')
395 class replace_md5(object):
398 def update(self, val):
399 self.val = hash((self.val, val))
403 return self.digest().encode('hex')
404 def replace_h_file(filename):
405 f = open(filename, 'rb')
408 filename = f.read(100000)
412 Utils.md5 = replace_md5
413 Task.md5 = replace_md5
414 Utils.h_file = replace_h_file
417 def LOAD_ENVIRONMENT():
418 '''load the configuration environment, allowing access to env vars
421 env = Environment.Environment()
423 env.load('.lock-wscript')
424 env.load(env.blddir + '/c4che/default.cache.py')
430 def IS_NEWER(bld, file1, file2):
431 '''return True if file1 is newer than file2'''
432 t1 = os.stat(os.path.join(bld.curdir, file1)).st_mtime
433 t2 = os.stat(os.path.join(bld.curdir, file2)).st_mtime
435 Build.BuildContext.IS_NEWER = IS_NEWER
439 def RECURSE(ctx, directory):
440 '''recurse into a directory, relative to the curdir or top level'''
442 visited_dirs = ctx.visited_dirs
444 visited_dirs = ctx.visited_dirs = set()
445 d = os.path.join(ctx.curdir, directory)
446 if os.path.exists(d):
447 abspath = os.path.abspath(d)
449 abspath = os.path.abspath(os.path.join(Utils.g_module.srcdir, directory))
450 ctxclass = ctx.__class__.__name__
451 key = ctxclass + ':' + abspath
452 if key in visited_dirs:
455 visited_dirs.add(key)
456 relpath = os_path_relpath(abspath, ctx.curdir)
457 if ctxclass == 'Handler':
458 return ctx.sub_options(relpath)
459 if ctxclass == 'ConfigurationContext':
460 return ctx.sub_config(relpath)
461 if ctxclass == 'BuildContext':
462 return ctx.add_subdirs(relpath)
463 Logs.error('Unknown RECURSE context class', ctxclass)
465 Options.Handler.RECURSE = RECURSE
466 Build.BuildContext.RECURSE = RECURSE
469 def CHECK_MAKEFLAGS(bld):
470 '''check for MAKEFLAGS environment variable in case we are being
471 called from a Makefile try to honor a few make command line flags'''
472 if not 'WAF_MAKE' in os.environ:
474 makeflags = os.environ.get('MAKEFLAGS')
475 if makeflags is None:
478 # we need to use shlex.split to cope with the escaping of spaces
480 for opt in shlex.split(makeflags):
481 # options can come either as -x or as x
483 Options.options.verbose = Logs.verbose = int(opt[2:])
485 Logs.zones = ['runner']
488 elif opt[0].isupper() and opt.find('=') != -1:
489 # this allows us to set waf options on the make command line
490 # for example, if you do "make FOO=blah", then we set the
491 # option 'FOO' in Options.options, to blah. If you look in wafsamba/wscript
492 # you will see that the command line accessible options have their dest=
493 # set to uppercase, to allow for passing of options from make in this way
494 # this is also how "make test TESTS=testpattern" works, and
495 # "make VERBOSE=1" as well as things like "make SYMBOLCHECK=1"
497 setattr(Options.options, opt[0:loc], opt[loc+1:])
503 Options.options.keep = True
507 Options.options.keep = True
510 Options.options.jobs = 1
512 Build.BuildContext.CHECK_MAKEFLAGS = CHECK_MAKEFLAGS
516 def option_group(opt, name):
517 '''find or create an option group'''
519 if name in option_groups:
520 return option_groups[name]
521 gr = opt.add_option_group(name)
522 option_groups[name] = gr
524 Options.Handler.option_group = option_group
527 def save_file(filename, contents, create_dir=False):
528 '''save data to a file'''
530 mkdir_p(os.path.dirname(filename))
532 f = open(filename, 'w')
540 def load_file(filename):
541 '''return contents of a file'''
543 f = open(filename, 'r')
551 def reconfigure(ctx):
552 '''rerun configure if necessary'''
553 import Configure, samba_wildcard, Scripting
554 if not os.path.exists(".lock-wscript"):
555 raise Utils.WafError('configure has not been run')
556 bld = samba_wildcard.fake_build_environment()
557 Configure.autoconfig = True
558 Scripting.check_configured(bld)
561 def map_shlib_extension(ctx, name, python=False):
562 '''map a filename with a shared library extension of .so to the real shlib name'''
565 if name[-1:].isdigit():
566 # some libraries have specified versions in the wscript rule
568 (root1, ext1) = os.path.splitext(name)
570 (root2, ext2) = os.path.splitext(ctx.env.pyext_PATTERN)
572 (root2, ext2) = os.path.splitext(ctx.env.shlib_PATTERN)
574 Build.BuildContext.map_shlib_extension = map_shlib_extension
576 def apply_pattern(filename, pattern):
577 '''apply a filename pattern to a filename that may have a directory component'''
578 dirname = os.path.dirname(filename)
580 return pattern % filename
581 basename = os.path.basename(filename)
582 return os.path.join(dirname, pattern % basename)
584 def make_libname(ctx, name, nolibprefix=False, version=None, python=False):
585 """make a library filename
587 nolibprefix: don't include the lib prefix
588 version : add a version number
589 python : if we should use python module name conventions"""
592 libname = apply_pattern(name, ctx.env.pyext_PATTERN)
594 libname = apply_pattern(name, ctx.env.shlib_PATTERN)
595 if nolibprefix and libname[0:3] == 'lib':
596 libname = libname[3:]
598 if version[0] == '.':
599 version = version[1:]
600 (root, ext) = os.path.splitext(libname)
602 # special case - version goes before the prefix
603 libname = "%s.%s%s" % (root, version, ext)
605 libname = "%s%s.%s" % (root, ext, version)
607 Build.BuildContext.make_libname = make_libname
610 def get_tgt_list(bld):
611 '''return a list of build objects for samba'''
613 targets = LOCAL_CACHE(bld, 'TARGET_TYPE')
615 # build a list of task generators we are interested in
619 if not type in ['SUBSYSTEM', 'MODULE', 'BINARY', 'LIBRARY', 'ASN1', 'PYTHON']:
621 t = bld.name_to_obj(tgt, bld.env)
623 Logs.error("Target %s of type %s has no task generator" % (tgt, type))