s4-waf: automatically remove stale C and header files

this prevents stale .c and .h files in bin/ from causing build
problems

Thanks to Thomas Nagy for the example implementation!

Autobuild-User: Andrew Tridgell <tridge@samba.org>
Autobuild-Date: Thu Oct 14 07:44:13 UTC 2010 on sn-devel-104

1 files changed, 96 insertions, 0 deletions

diff --git a/buildtools/wafsamba/stale_files.py b/buildtools/wafsamba/stale_files.py
new file mode 100644
index 0000000000..dd4270dfde
--- /dev/null
+++ b/buildtools/wafsamba/stale_files.py
@@ -0,0 +1,96 @@
+#! /usr/bin/env python
+# encoding: utf-8
+# Thomas Nagy, 2006-2010 (ita)
+
+"""
+Add a pre-build hook to remove all build files
+which do not have a corresponding target
+
+This can be used for example to remove the targets
+that have changed name without performing
+a full 'waf clean'
+
+Of course, it will only work if there are no dynamically generated
+nodes/tasks, in which case the method will have to be modified
+to exclude some folders for example.
+"""
+
+import Logs, Build, os, samba_utils, Options, Utils
+from Runner import Parallel
+
+old_refill_task_list = Parallel.refill_task_list
+def replace_refill_task_list(self):
+    '''replacement for refill_task_list() that deletes stale files'''
+
+    iit = old_refill_task_list(self)
+    bld = self.bld
+
+    if not getattr(bld, 'new_rules', False):
+        # we only need to check for stale files if the build rules changed
+        return iit
+
+    if Options.options.compile_targets:
+        # not safe when --target is used
+        return iit
+
+    # execute only once
+    if getattr(self, 'cleanup_done', False):
+        return iit
+    self.cleanup_done = True
+
+    def group_name(g):
+        tm = self.bld.task_manager
+        return [x for x in tm.groups_names if id(tm.groups_names[x]) == id(g)][0]
+
+    bin_base = bld.bldnode.abspath()
+    bin_base_len = len(bin_base)
+
+    # paranoia
+    if bin_base[-4:] != '/bin':
+        raise Utils.WafError("Invalid bin base: %s" % bin_base)
+    
+    # obtain the expected list of files
+    expected = []
+    for i in range(len(bld.task_manager.groups)):
+        g = bld.task_manager.groups[i]
+        tasks = g.tasks_gen
+        for x in tasks:
+            try:
+                if getattr(x, 'target'):
+                    tlist = samba_utils.TO_LIST(getattr(x, 'target'))
+                    for t in tlist:
+                        p = os.path.join(x.path.abspath(bld.env), t)
+                        p = os.path.normpath(p)
+                        expected.append(p)
+                for n in x.allnodes:
+                    p = n.abspath(bld.env)
+                    if p[0:bin_base_len] == bin_base:
+                        expected.append(p)
+            except:
+                pass
+
+    for root, dirs, files in os.walk(bin_base):
+        for f in files:
+            p = root + '/' + f
+            if os.path.islink(p):
+                p = os.readlink(p)
+            if f in ['config.h']:
+                continue
+            if f[-2:] not in [ '.c', '.h' ]:
+                continue
+            if f[-7:] == '.inst.h':
+                continue
+            if p.find("/.conf") != -1:
+                continue
+            if not p in expected:
+                Logs.warn("Removing stale file: %s" % p)
+                os.unlink(p)
+    return iit
+
+
+def AUTOCLEANUP_STALE_FILES(bld):
+    """automatically clean up any files in bin that shouldn't be there"""
+    old_refill_task_list = Parallel.refill_task_list
+    Parallel.refill_task_list = replace_refill_task_list
+    Parallel.bld = bld
+Build.BuildContext.AUTOCLEANUP_STALE_FILES = AUTOCLEANUP_STALE_FILES