Allow configurability of yacc-generated header files suffixes.

6 files changed, 232 insertions, 4 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index dd398c5..cb441ce 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -7127,6 +7127,34 @@ SCons assumes that the call will also create a .h file
 or a .hpp file
 (if the yacc source file ends in a .yy suffix)
 
+.IP YACCHFILESUFFIX
+The suffix of the C
+header file generated by the parser generator
+when the
+.B -d
+option is used.
+Note that setting this variable does not cause
+the parser generator to generate a header
+file with the specified suffix,
+it exists to allow you to specify
+what suffix the parser generator will use of its own accord.
+The default value is
+.BR .h .
+
+.IP YACCHXXFILESUFFIX
+The suffix of the C++
+header file generated by the parser generator
+when the
+.B -d
+option is used.
+Note that setting this variable does not cause
+the parser generator to generate a header
+file with the specified suffix,
+it exists to allow you to specify
+what suffix the parser generator will use of its own accord.
+The default value is
+.BR .hpp .
+
 .IP ZIP
 The zip compression and file packaging utility.
 
diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 00973cf..cfd7097 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -262,6 +262,10 @@ RELEASE 0.97 - XXX
     subdivide the dependency tree arbitrarily by putting an SConstruct
     file in every directory and using content signatures.
 
+  - Add support for $YACCHFILESUFFIX and $YACCHXXFILESUFFIX variables
+    that accomodate parser generators that write header files to a
+    different suffix than the hard-coded .hpp when the -d option is used.
+
   From Wayne Lee:
 
   - Avoid "maximum recursion limit" errors when removing $(-$) pairs
diff --git a/src/engine/SCons/Tool/yacc.py b/src/engine/SCons/Tool/yacc.py
index da88aa2..b8916ae 100644
--- a/src/engine/SCons/Tool/yacc.py
+++ b/src/engine/SCons/Tool/yacc.py
@@ -47,16 +47,16 @@ def _yaccEmitter(target, source, env, ysuf, hsuf):
     # the input file is a .y or .yy, respectively.
     if len(source) and '-d' in SCons.Util.CLVar(env.subst("$YACCFLAGS")):
         base, ext = os.path.splitext(SCons.Util.to_String(source[0]))
-        if ext == ysuf:
+        if ext in ysuf:
             base, ext = os.path.splitext(SCons.Util.to_String(target[0]))
-            target.append(base + hsuf)
+            target.append(base + env.subst(hsuf))
     return (target, source)
 
 def yEmitter(target, source, env):
-    return _yaccEmitter(target, source, env, '.y', '.h')
+    return _yaccEmitter(target, source, env, ['.y', '.yacc'], '$YACCHFILESUFFIX')
 
 def yyEmitter(target, source, env):
-    return _yaccEmitter(target, source, env, '.yy', '.hpp')
+    return _yaccEmitter(target, source, env, ['.yy'], '$YACCHXXFILESUFFIX')
 
 def generate(env):
     """Add Builders and construction variables for yacc to an Environment."""
@@ -72,6 +72,8 @@ def generate(env):
     env['YACC']      = env.Detect('bison') or 'yacc'
     env['YACCFLAGS'] = SCons.Util.CLVar('')
     env['YACCCOM']   = '$YACC $YACCFLAGS -o $TARGET $SOURCES'
+    env['YACCHFILESUFFIX'] = '.h'
+    env['YACCHXXFILESUFFIX'] = '.hpp'
 
 def exists(env):
     return env.Detect(['bison', 'yacc'])
diff --git a/src/engine/SCons/Tool/yacc.xml b/src/engine/SCons/Tool/yacc.xml
index 59735af..97bdf9b 100644
--- a/src/engine/SCons/Tool/yacc.xml
+++ b/src/engine/SCons/Tool/yacc.xml
@@ -40,3 +40,37 @@ or a .hpp file
 (if the yacc source file ends in a .yy suffix)
 </summary>
 </cvar>
+
+<cvar name="YACCHFILESUFFIX">
+<summary>
+The suffix of the C
+header file generated by the parser generator
+when the
+<option>-d</option>
+option is used.
+Note that setting this variable does not cause
+the parser generator to generate a header
+file with the specified suffix,
+it exists to allow you to specify
+what suffix the parser generator will use of its own accord.
+The default value is
+<filename>.h</filename>.
+</summary>
+</cvar>
+
+<cvar name="YACCHXXFILESUFFIX">
+<summary>
+The suffix of the C++
+header file generated by the parser generator
+when the
+<option>-d</option>
+option is used.
+Note that setting this variable does not cause
+the parser generator to generate a header
+file with the specified suffix,
+it exists to allow you to specify
+what suffix the parser generator will use of its own accord.
+The default value is
+<filename>.hpp</filename>.
+</summary>
+</cvar>
diff --git a/test/YACC/YACCHFILESUFFIX.py b/test/YACC/YACCHFILESUFFIX.py
new file mode 100644
index 0000000..389018f
--- /dev/null
+++ b/test/YACC/YACCHFILESUFFIX.py
@@ -0,0 +1,82 @@
+#!/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 setting the YACCHFILESUFFIX variable can reflect a yacc
+utility that writes to an odd
+"""
+
+import TestSCons
+
+python = TestSCons.python
+
+test = TestSCons.TestSCons()
+
+
+
+test.write('myyacc.py', """\
+import getopt
+import os.path
+import string
+import sys
+opts, args = getopt.getopt(sys.argv[1:], 'do:')
+for o, a in opts:
+    if o == '-o':
+        outfile = open(a, 'wb')
+for f in args:
+    infile = open(f, 'rb')
+    for l in filter(lambda l: l != '/*yacc*/\\n', infile.readlines()):
+        outfile.write(l)
+outfile.close()
+base, ext = os.path.splitext(args[0])
+open(base+'.hsuffix', 'wb').write(string.join(sys.argv)+'\\n')
+sys.exit(0)
+""")
+
+test.write('SConstruct', """
+env = Environment(tools=['default', 'yacc'],
+                  YACC = r'%s myyacc.py',
+                  YACCFLAGS = '-d',
+                  YACCHFILESUFFIX = '.hsuffix')
+env.CFile(target = 'aaa', source = 'aaa.y')
+env.CFile(target = 'bbb', source = 'bbb.yacc')
+""" % python)
+
+test.write('aaa.y', "aaa.y\n/*yacc*/\n")
+test.write('bbb.yacc', "bbb.yacc\n/*yacc*/\n")
+
+test.run(arguments = '.')
+
+test.must_match('aaa.c', "aaa.y\n")
+test.must_match('aaa.hsuffix', "myyacc.py -d -o aaa.c aaa.y\n")
+test.must_match('bbb.c', "bbb.yacc\n")
+test.must_match('bbb.hsuffix', "myyacc.py -d -o bbb.c bbb.yacc\n")
+
+test.up_to_date(arguments = '.')
+
+
+
+test.pass_test()
diff --git a/test/YACC/YACCHXXFILESUFFIX.py b/test/YACC/YACCHXXFILESUFFIX.py
new file mode 100644
index 0000000..b564d5e
--- /dev/null
+++ b/test/YACC/YACCHXXFILESUFFIX.py
@@ -0,0 +1,78 @@
+#!/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 setting the YACCHXXFILESUFFIX variable can reflect a yacc
+utility that writes to an odd
+"""
+
+import TestSCons
+
+python = TestSCons.python
+
+test = TestSCons.TestSCons()
+
+
+
+test.write('myyacc.py', """\
+import getopt
+import os.path
+import string
+import sys
+opts, args = getopt.getopt(sys.argv[1:], 'do:')
+for o, a in opts:
+    if o == '-o':
+        outfile = open(a, 'wb')
+for f in args:
+    infile = open(f, 'rb')
+    for l in filter(lambda l: l != '/*yacc*/\\n', infile.readlines()):
+        outfile.write(l)
+outfile.close()
+base, ext = os.path.splitext(args[0])
+open(base+'.hxxsuffix', 'wb').write(string.join(sys.argv)+'\\n')
+sys.exit(0)
+""")
+
+test.write('SConstruct', """
+env = Environment(tools=['default', 'yacc'],
+                  YACC = r'%s myyacc.py',
+                  YACCFLAGS = '-d',
+                  YACCHXXFILESUFFIX = '.hxxsuffix')
+env.CXXFile(target = 'aaa', source = 'aaa.yy')
+""" % python)
+
+test.write('aaa.yy', "aaa.yy\n/*yacc*/\n")
+
+test.run(arguments = '.')
+
+test.must_match('aaa.cc', "aaa.yy\n")
+test.must_match('aaa.hxxsuffix', "myyacc.py -d -o aaa.cc aaa.yy\n")
+
+test.up_to_date(arguments = '.')
+
+
+
+test.pass_test()