Add an M4 builder. (Timothee Besset)

8 files changed, 191 insertions, 1 deletions

diff --git a/bin/files b/bin/files
index 4e3a8631..1b42f74c 100644
--- a/bin/files
+++ b/bin/files
@@ -58,6 +58,7 @@
 ./SCons/Tool/latex.py
 ./SCons/Tool/lex.py
 ./SCons/Tool/link.py
+./SCons/Tool/m4.py
 ./SCons/Tool/masm.py
 ./SCons/Tool/midl.py
 ./SCons/Tool/mingw.py
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 054bbd12..e52903e9 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -881,6 +881,7 @@ javah
 latex
 lex
 linkloc
+m4
 masm
 midl
 mingw
@@ -1329,6 +1330,19 @@ env.CXXFile(target = 'foo.cc', source = 'foo.ll')
 env.CXXFile(target = 'bar', source = 'bar.yy')
 .EE
 
+.IP M4
+Builds an output file from an M4 input file.
+This uses a default $M4FLAGS value of
+.BR -E ,
+which considers all warnings to be fatal
+and stops on the first warning
+when using the GNU version of m4.
+Example:
+
+.ES
+env.M4(target = 'foo.c', source = 'foo.c.m4')
+.EE
+
 .IP Jar
 Builds a Java archive (.jar) file
 from a source tree of .class files.
@@ -2690,6 +2704,15 @@ General options passed to the linker.
 .IP LINKCOM
 The command line used to link object files into an executable.
 
+.IP M4
+The M4 macro preprocessor.
+
+.IP M4FLAGS
+General options passed to the M4 macro preprocessor.
+
+.IP M4COM
+The command line used to pass files through the macro preprocessor.
+
 .IP MSVSPROJECTCOM
 The action used to generate Microsoft Visual Studio
 project and solution files.
diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index b04942ea..b4d409c3 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -15,6 +15,10 @@ RELEASE 0.15 - XXX
   - Fix handling of library prefixes when the subdirectory matches
     the prefix.
 
+  From Timothee Bessett:
+
+  - Add an M4 Builder.
+
   From Charles Crain:
 
   - Use '.lnk' as the suffix on the temporary file for linking long
diff --git a/src/engine/MANIFEST.in b/src/engine/MANIFEST.in
index f1987e75..870d4301 100644
--- a/src/engine/MANIFEST.in
+++ b/src/engine/MANIFEST.in
@@ -70,6 +70,7 @@ SCons/Tool/latex.py
 SCons/Tool/lex.py
 SCons/Tool/link.py
 SCons/Tool/linkloc.py
+SCons/Tool/m4.py
 SCons/Tool/masm.py
 SCons/Tool/midl.py
 SCons/Tool/mingw.py
diff --git a/src/engine/SCons/Tool/__init__.py b/src/engine/SCons/Tool/__init__.py
index b0394604..ca730be8 100644
--- a/src/engine/SCons/Tool/__init__.py
+++ b/src/engine/SCons/Tool/__init__.py
@@ -228,7 +228,7 @@ def tool_list(platform, env):
     other_tools = FindAllTools(['BitKeeper', 'CVS',
                                 'dvipdf', 'dvips', 'gs',
                                 'jar', 'javac', 'javah',
-                                'latex', 'lex', 'midl', 'msvs',
+                                'latex', 'lex', 'm4', 'midl', 'msvs',
                                 'pdflatex', 'pdftex', 'Perforce',
                                 'RCS', 'rmic', 'SCCS',
                                 # 'Subversion',
diff --git a/src/engine/SCons/Tool/m4.py b/src/engine/SCons/Tool/m4.py
new file mode 100644
index 00000000..530e7138
--- /dev/null
+++ b/src/engine/SCons/Tool/m4.py
@@ -0,0 +1,54 @@
+"""SCons.Tool.m4
+
+Tool-specific initialization for m4.
+
+There normally shouldn't be any need to import this module directly.
+It will usually be imported through the generic SCons.Tool.Tool()
+selection method.
+
+"""
+
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+import SCons.Builder
+
+def generate(env):
+    """Add Builders and construction variables for m4 to an Environment."""
+    bld = SCons.Builder.Builder(action = '$M4COM', src_suffix = '.m4')
+
+    env['BUILDERS']['M4'] = bld
+
+    # .m4 files might include other files, and it would be pretty hard
+    # to write a scanner for it, so let's just cd to the dir of the m4
+    # file and run from there.
+    # The src_suffix setup is like so: file.c.m4 -> file.c,
+    # file.cpp.m4 -> file.cpp etc.
+    env['M4']      = 'm4'
+    env['M4FLAGS'] = '-E'
+    env['M4COM']   = 'cd ${SOURCE.srcdir} ; $M4 $M4FLAGS < ${SOURCE.file} > ${TARGET.abspath}'
+
+def exists(env):
+    return env.Detect('m4')
diff --git a/test/M4.py b/test/M4.py
new file mode 100644
index 00000000..f268174c
--- /dev/null
+++ b/test/M4.py
@@ -0,0 +1,106 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Test that $M4 and $M4FLAGS work as expected.
+"""
+
+import os
+import os.path
+import string
+import sys
+import TestSCons
+
+python = TestSCons.python
+
+test = TestSCons.TestSCons()
+
+
+
+test.write('mym4.py', """
+import string
+import sys
+contents = sys.stdin.read()
+sys.stdout.write(string.replace(contents, 'M4', 'mym4.py'))
+sys.exit(0)
+""")
+
+test.write('SConstruct', """
+env = Environment(M4 = r'%s mym4.py', tools=['default', 'm4'])
+env.M4(target = 'aaa.x', source = 'aaa.x.m4')
+""" % python)
+
+test.write('aaa.x.m4', """\
+line 1
+M4
+line 3
+""")
+
+test.run()
+
+test.fail_test(test.read(test.workpath('aaa.x')) != "line 1\nmym4.py\nline 3\n")
+
+
+
+m4 = test.where_is('m4')
+
+if m4:
+
+    test.write("wrapper.py",
+"""import os
+import string
+import sys
+open('%s', 'wb').write("wrapper.py\\n")
+os.system(string.join(sys.argv[1:], " "))
+""" % string.replace(test.workpath('wrapper.out'), '\\', '\\\\'))
+
+    test.write('SConstruct', """
+foo = Environment(M4FLAGS='-DFFF=fff')
+m4 = foo.Dictionary('M4')
+bar = Environment(M4 = r'%s wrapper.py ' + m4, M4FLAGS='-DBBB=bbb')
+foo.M4(target = 'foo.x', source = 'foo.x.m4')
+bar.M4(target = 'bar', source = 'bar.m4')
+""" % python)
+
+    test.write('foo.x.m4', "line 1\n"
+                           "FFF\n"
+                           "line 3\n")
+
+    test.write('bar.m4', "line 1\n"
+                         "BBB\n"
+                         "line 3\n")
+
+    test.run(arguments = '.')
+
+    test.up_to_date(arguments = '.')
+
+    test.fail_test(test.read('wrapper.out') != "wrapper.py\n")
+
+    test.fail_test(test.read('foo.x') != "line 1\nfff\nline 3\n")
+
+    test.fail_test(test.read('bar') != "line 1\nbbb\nline 3\n")
+
+test.pass_test()
diff --git a/test/import.py b/test/import.py
index 8dc3682a..c76c47d0 100644
--- a/test/import.py
+++ b/test/import.py
@@ -75,6 +75,7 @@ tools = [
     'lex',
     'link',
     # Can't import 'linkloc' everywhere due to Windows registry dependency...
+    'm4',
     'masm',
     'midl',
     'mingw',