ylwrap: preserve subdirectories in "#line" munging

If Automake is used in non-recursive mode and one of the inputs is a
yacc file, for example, "src/grammar.y", ylwrap will remove too many
directories from the output file when it adjusts the paths in it.
This results in #line directives referring to "grammar.y" instead of
"src/grammar.y".

This is a result of $input_rx simply taking all the directory
components of the absolute input path and removing them.

One solution is to store the path passed to ylwrap and replace
$input_rx with it.  This is what we do.

Suggestion and initial patch (without tests) by Nikolai Weibull:
<http://lists.gnu.org/archive/html/automake/2012-05/msg00013.html>
Final patch by Stefano Lattarini.

* lib/ylwrap ($input_sub_rx): New.
When munging the #line directives, substitute '$input_rx' with it,
instead of stripping it altogether.
Adjust comments.
* t/yacc-line.sh, t/lex-line: Adjust and extend.
* NEWS, THANKS: Update.

Copyright-paperwork-exempt: yes
Co-authored-by: Stefano Lattarini <stefano.lattarini@gmail.com>
Signed-off-by: Stefano Lattarini <stefano.lattarini@gmail.com>

diff --git a/NEWS b/NEWS
index d0575e6..944f7f9 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -103,6 +103,15 @@ Bugs fixed in 1.12.1:
   - Several inefficiencies and poor performances in the implementation
     of the parallel-tests 'check' and 'recheck' targets have been fixed.
 
+  - The post-processing of output "#line" directives done the ylwrap
+    script is more faithful w.r.t. files in a subdirectory; for example,
+    if the processed file is "src/grammar.y", ylwrap will correctly
+    produce directives like:
+        #line 7 "src/grammar.y"
+    rather than like
+        #line 7 "grammar.y"
+    as it did before.
+
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 New in 1.12:

diff --git a/THANKS b/THANKS
index b98b2b7..0824c4f 100644 (file)
--- a/THANKS
+++ b/THANKS
@@ -269,6 +269,7 @@ Nicolas Joly                    njoly@pasteur.fr
 Nicolas Thiery                  nthiery@Icare.mines.edu
 NightStrike                     nightstrike@gmail.com
 Nik A. Melchior                 nam1@cse.wustl.edu
+Nikolai Weibull                 now@bitwi.se
 NISHIDA Keisuke                 knishida@nn.iij4u.or.jp
 Noah Friedman                   friedman@gnu.ai.mit.edu
 Norman Gray                     norman@astro.gla.ac.uk

diff --git a/lib/ylwrap b/lib/ylwrap
index 8a20288..6879d8d 100755 (executable)
--- a/lib/ylwrap
+++ b/lib/ylwrap
@@ -79,6 +79,8 @@ quote_for_sed ()
 # The input.
 input="$1"
 shift
+# We'll later need for a correct munging of "#line" directives.
+input_sub_rx=`get_dirname "$input" | quote_for_sed`
 case "$input" in
   [\\/]* | ?:[\\/]*)
     # Absolute path; do nothing.
@@ -170,15 +172,11 @@ if test $ret -eq 0; then
         realtarget="$target"
         target="tmp-`echo $target | sed s/.*[\\/]//g`"
       fi
-      # Edit out '#line' or '#' directives.
-      #
+      # Munge "#line" or "#" directives.
       # We don't want the resulting debug information to point at
-      # an absolute srcdir; it is better for it to just mention the
-      # .y file with no path.
-      #
+      # an absolute srcdir.
       # We want to use the real output file name, not yy.lex.c for
       # instance.
-      #
       # We want the include guards to be adjusted too.
       FROM=`echo "$from" | sed \
             -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'\
@@ -187,7 +185,7 @@ if test $ret -eq 0; then
             -e 'y/abcdefghijklmnopqrstuvwxyz/ABCDEFGHIJKLMNOPQRSTUVWXYZ/'\
             -e 's/[^ABCDEFGHIJKLMNOPQRSTUVWXYZ]/_/g'`
 
-      sed -e "/^#/!b" -e "s,$input_rx,," -e "s,$from,$2," \
+      sed -e "/^#/!b" -e "s,$input_rx,$input_sub_rx," -e "s,$from,$2," \
           -e "s,$FROM,$TARGET," "$from" >"$target" || ret=$?
 
       # Check whether header files must be updated.

diff --git a/t/lex-line.sh b/t/lex-line.sh
index f690e7e..a95faf3 100755 (executable)
--- a/t/lex-line.sh
+++ b/t/lex-line.sh
@@ -104,18 +104,29 @@ for vpath in : false; do
 
   # For debugging,
   ls -l . sub sub/dir
-  $FGREP '.l' $c_outputs
+  $EGREP 'line|\.l' $c_outputs
 
-  # Adjusted "#line" should not contain reference to the builddir.
-  $EGREP '#.*line.*(build|\.\.).*\.l' $c_outputs && Exit 1
+  grep '#.*line.*build.*\.l' $c_outputs && Exit 1
+  # Adjusted "#line" should not contain reference to the absolute
+  # srcdir.
+  $EGREP '#.*line *"?/.*\.l' $c_outputs && Exit 1
   # Adjusted "#line" should not contain reference to the default
   # output file names, e.g., 'lex.yy.c'.
-  $EGREP '#.*line.*lex\.yy' $c_outputs && Exit 1
-  # Don't be excessively strict in grepping, to avoid spurious failures.
-  grep '#.*line.*zardoz\.l' zardoz.c
-  grep '#.*line.*quux\.l' bar-quux.c
-  grep '#.*line.*zardoz\.l' sub/foo-zardoz.c
-  grep '#.*line.*quux\.l' sub/dir/quux.c
+  grep '#.*line.*lex\.yy' $c_outputs && Exit 1
+  # Look out for a silly regression.
+  grep "#.*\.l.*\.l" $c_outputs && Exit 1
+  if $vpath; then
+    grep '#.*line.*"\.\./zardoz\.l"' zardoz.c
+    grep '#.*line.*"\.\./dir/quux\.l"' bar-quux.c
+    grep '#.*line.*"\.\./\.\./sub/zardoz\.l"' sub/foo-zardoz.c
+    grep '#.*line.*"\.\./\.\./sub/dir/quux\.l"' sub/dir/quux.c
+  else
+    grep '#.*line.*"zardoz\.l"' zardoz.c
+    grep '#.*line.*"dir/quux\.l"' bar-quux.c
+    grep '#.*line.*"zardoz\.l"' sub/foo-zardoz.c
+    grep '#.*line.*"dir/quux\.l"' sub/dir/quux.c
+  fi
+
   cd $srcdir
 
 done

diff --git a/t/yacc-line.sh b/t/yacc-line.sh
index 090b72b..d122157 100755 (executable)
--- a/t/yacc-line.sh
+++ b/t/yacc-line.sh
@@ -94,18 +94,30 @@ for vpath in : false; do
 
   # For debugging,
   ls -l . sub sub/dir
-  $FGREP '.y' $c_outputs
+  $EGREP 'line|\.y' $c_outputs
 
   # Adjusted "#line" should not contain reference to the builddir.
-  $EGREP '#.*line.*(build|\.\.).*\.y' $c_outputs && Exit 1
+  grep '#.*line.*build.*\.y' $c_outputs && Exit 1
+  # Adjusted "#line" should not contain reference to the absolute
+  # srcdir.
+  $EGREP '#.*line *"?/.*\.y' $c_outputs && Exit 1
   # Adjusted "#line" should not contain reference to the default
   # output file names, e.g., 'y.tab.c' and 'y.tab.h'.
-  $EGREP '#.*line.*y\.tab\.' $c_outputs && Exit 1
-  # Don't be excessively strict in grepping, to avoid spurious failures.
-  grep '#.*line.*zardoz\.y' zardoz.c
-  grep '#.*line.*quux\.y' bar-quux.c
-  grep '#.*line.*zardoz\.y' sub/foo-zardoz.c
-  grep '#.*line.*quux\.y' sub/dir/quux.c
+  grep '#.*line.*y\.tab\.' $c_outputs && Exit 1
+  # Look out for a silly regression.
+  grep "#.*\.y.*\.y" $c_outputs && Exit 1
+  if $vpath; then
+    grep '#.*line.*"\.\./zardoz\.y"' zardoz.c
+    grep '#.*line.*"\.\./dir/quux\.y"' bar-quux.c
+    grep '#.*line.*"\.\./\.\./sub/zardoz\.y"' sub/foo-zardoz.c
+    grep '#.*line.*"\.\./\.\./sub/dir/quux\.y"' sub/dir/quux.c
+  else
+    grep '#.*line.*"zardoz\.y"' zardoz.c
+    grep '#.*line.*"dir/quux\.y"' bar-quux.c
+    grep '#.*line.*"zardoz\.y"' sub/foo-zardoz.c
+    grep '#.*line.*"dir/quux\.y"' sub/dir/quux.c
+  fi
+
   cd $srcdir
 
 done