Fix for bug 2558. Handle .output file generated by bison or yacc properly. Make SCons aware that it's a SideEffect, and clean it when SCons cleans

3 files changed, 110 insertions, 0 deletions

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 248938d..4619955 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -7,6 +7,10 @@
 
 RELEASE 2.1.0.alpha.yyyymmdd - NEW DATE WILL BE INSERTED HERE
 
+  From Robert Lehr:
+    - Handle .output file generated by bison/yacc properly. Cleaning it
+      when necessary.
+
   From Antoine Dechaume:
     - Handle SWIG file where there is whitespace after the module name
       properly. Previously the generated files would include 
diff --git a/src/engine/SCons/Tool/yacc.py b/src/engine/SCons/Tool/yacc.py
index ca5e2fc..5896cbe 100644
--- a/src/engine/SCons/Tool/yacc.py
+++ b/src/engine/SCons/Tool/yacc.py
@@ -61,6 +61,16 @@ def _yaccEmitter(target, source, env, ysuf, hsuf):
         base, ext = os.path.splitext(SCons.Util.to_String(source[0]))
         target.append(base + env.subst("$YACCVCGFILESUFFIX"))
 
+    # If -v is specirfied yacc will create the output debug file
+    # which is not really source for any process, but should
+    # be noted and also be cleaned
+    # Bug #2558
+    if "-v" in flags:
+        env.SideEffect(targetBase+'.output',target[0])
+        env.Clean(target[0],targetBase+'.output')
+
+
+
     # With --defines and --graph, the name of the file is totally defined
     # in the options.
     fileGenOptions = ["--defines=", "--graph="]
diff --git a/test/YACC/live-check-output-cleaned.py b/test/YACC/live-check-output-cleaned.py
new file mode 100644
index 0000000..a6240c9
--- /dev/null
+++ b/test/YACC/live-check-output-cleaned.py
@@ -0,0 +1,96 @@
+#!/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 .output file is cleaned
+"""
+
+import TestSCons
+
+_exe = TestSCons._exe
+
+test = TestSCons.TestSCons()
+
+yacc = test.where_is('yacc') or test.where_is('bison')
+
+if not yacc:
+    test.skip_test('No yacc or bison found; skipping test.\n')
+
+test.write('SConstruct', """
+foo = Environment(YACCFLAGS='-v -d')
+foo.CFile(source = 'foo.y')
+""" % locals())
+
+yacc = r"""
+%%{
+#include <stdio.h>
+
+main()
+{
+    yyparse();
+}
+
+yyerror(s)
+char *s;
+{
+    fprintf(stderr, "%%s\n", s);
+    return 0;
+}
+
+yylex()
+{
+    int c;
+
+    c = fgetc(stdin);
+    return (c == EOF) ? 0 : c;
+}
+%%}
+%%%%
+input:  letter newline { printf("%s\n"); };
+letter:  'a' | 'b';
+newline: '\n';
+"""
+
+test.write('foo.y', yacc % 'foo.y')
+
+test.run('.', stderr = None)
+
+test.up_to_date(arguments = 'foo.c')
+
+test.must_exist(test.workpath('foo.output'))
+test.must_exist(test.workpath('foo.c'))
+
+test.run(arguments = '-c .')
+test.must_not_exist(test.workpath('foo.output'))
+test.must_not_exist(test.workpath('foo.c'))
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4: