diff: fix whitespace-skipping with --color-moved
authorJeff King <peff@peff.net>
Thu, 19 Oct 2017 20:29:26 +0000 (16:29 -0400)
committerJunio C Hamano <gitster@pobox.com>
Sat, 21 Oct 2017 12:12:35 +0000 (21:12 +0900)
The code for handling whitespace with --color-moved
represents partial strings as a pair of pointers. There are
two possible conventions for the end pointer:

  1. It points to the byte right after the end of the
     string.

  2. It points to the final byte of the string.

But we seem to use both conventions in the code:

  a. we assign the initial pointers from the NUL-terminated
     string using (1)

  b. we eat trailing whitespace by checking the second
     pointer for isspace(), which needs (2)

  c. the next_byte() function checks for end-of-string with
     "if (cp > endp)", which is (2)

  d. in next_byte() we skip past internal whitespace with
     "while (cp < end)", which is (1)

This creates fewer bugs than you might think, because there
are some subtle interactions. Because of (a) and (c), we
always return the NUL-terminator from next_byte(). But all
of the callers of next_byte() happen to handle that
gracefully.

Because of the mismatch between (d) and (c), next_byte()
could accidentally return a whitespace character right at
endp. But because of the interaction of (a) and (b), we fail
to actually chomp trailing whitespace, meaning our endp
_always_ points to a NUL, canceling out the problem.

But that does leave (b) as a real bug: when ignoring
whitespace only at the end-of-line, we don't correctly trim
it, and fail to match up lines.

We can fix the whole thing by moving consistently to one
convention. Since convention (1) is idiomatic in our code
base, we'll pick that one.

The existing "-w" and "-b" tests continue to pass, and a new
"--ignore-space-at-eol" shows off the breakage we're fixing.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
diff.c
t/t4015-diff-whitespace.sh

diff --git a/diff.c b/diff.c
index 6fd2884..09081a2 100644 (file)
--- a/diff.c
+++ b/diff.c
@@ -712,7 +712,7 @@ static int next_byte(const char **cp, const char **endp,
 {
        int retval;
 
 {
        int retval;
 
-       if (*cp > *endp)
+       if (*cp >= *endp)
                return -1;
 
        if (isspace(**cp)) {
                return -1;
 
        if (isspace(**cp)) {
@@ -729,7 +729,12 @@ static int next_byte(const char **cp, const char **endp,
                if (DIFF_XDL_TST(diffopt, IGNORE_WHITESPACE)) {
                        while (*cp < *endp && isspace(**cp))
                                (*cp)++;
                if (DIFF_XDL_TST(diffopt, IGNORE_WHITESPACE)) {
                        while (*cp < *endp && isspace(**cp))
                                (*cp)++;
-                       /* return the first non-ws character via the usual below */
+                       /*
+                        * return the first non-ws character via the usual
+                        * below, unless we ate all of the bytes
+                        */
+                       if (*cp >= *endp)
+                               return -1;
                }
        }
 
                }
        }
 
@@ -750,9 +755,9 @@ static int moved_entry_cmp(const struct diff_options *diffopt,
                return a->es->len != b->es->len  || memcmp(ap, bp, a->es->len);
 
        if (DIFF_XDL_TST(diffopt, IGNORE_WHITESPACE_AT_EOL)) {
                return a->es->len != b->es->len  || memcmp(ap, bp, a->es->len);
 
        if (DIFF_XDL_TST(diffopt, IGNORE_WHITESPACE_AT_EOL)) {
-               while (ae > ap && isspace(*ae))
+               while (ae > ap && isspace(ae[-1]))
                        ae--;
                        ae--;
-               while (be > bp && isspace(*be))
+               while (be > bp && isspace(be[-1]))
                        be--;
        }
 
                        be--;
        }
 
@@ -775,7 +780,7 @@ static unsigned get_string_hash(struct emitted_diff_symbol *es, struct diff_opti
                int c;
 
                strbuf_reset(&sb);
                int c;
 
                strbuf_reset(&sb);
-               while (ae > ap && isspace(*ae))
+               while (ae > ap && isspace(ae[-1]))
                        ae--;
                while ((c = next_byte(&ap, &ae, o)) > 0)
                        strbuf_addch(&sb, c);
                        ae--;
                while ((c = next_byte(&ap, &ae, o)) > 0)
                        strbuf_addch(&sb, c);
index 1f54816..6c9a93b 100755 (executable)
@@ -1463,6 +1463,73 @@ test_expect_success 'move detection ignoring whitespace changes' '
        test_cmp expected actual
 '
 
        test_cmp expected actual
 '
 
+test_expect_success 'move detection ignoring whitespace at eol' '
+       git reset --hard &&
+       # Lines 6-9 have new eol whitespace, but 9 also has it in the middle
+       q_to_tab <<-\EOF >lines.txt &&
+       long line 6Q
+       long line 7Q
+       long line 8Q
+       longQline 9Q
+       line 1
+       line 2
+       line 3
+       line 4
+       line 5
+       EOF
+
+       # avoid cluttering the output with complaints about our eol whitespace
+       test_config core.whitespace -blank-at-eol &&
+
+       git diff HEAD --no-renames --color-moved --color |
+               grep -v "index" |
+               test_decode_color >actual &&
+       cat <<-\EOF >expected &&
+       <BOLD>diff --git a/lines.txt b/lines.txt<RESET>
+       <BOLD>--- a/lines.txt<RESET>
+       <BOLD>+++ b/lines.txt<RESET>
+       <CYAN>@@ -1,9 +1,9 @@<RESET>
+       <GREEN>+<RESET><GREEN>long line 6       <RESET>
+       <GREEN>+<RESET><GREEN>long line 7       <RESET>
+       <GREEN>+<RESET><GREEN>long line 8       <RESET>
+       <GREEN>+<RESET><GREEN>long      line 9  <RESET>
+        line 1<RESET>
+        line 2<RESET>
+        line 3<RESET>
+        line 4<RESET>
+        line 5<RESET>
+       <RED>-long line 6<RESET>
+       <RED>-long line 7<RESET>
+       <RED>-long line 8<RESET>
+       <RED>-long line 9<RESET>
+       EOF
+       test_cmp expected actual &&
+
+       git diff HEAD --no-renames --ignore-space-at-eol --color-moved --color |
+               grep -v "index" |
+               test_decode_color >actual &&
+       cat <<-\EOF >expected &&
+       <BOLD>diff --git a/lines.txt b/lines.txt<RESET>
+       <BOLD>--- a/lines.txt<RESET>
+       <BOLD>+++ b/lines.txt<RESET>
+       <CYAN>@@ -1,9 +1,9 @@<RESET>
+       <CYAN>+<RESET><CYAN>long line 6 <RESET>
+       <CYAN>+<RESET><CYAN>long line 7 <RESET>
+       <CYAN>+<RESET><CYAN>long line 8 <RESET>
+       <GREEN>+<RESET><GREEN>long      line 9  <RESET>
+        line 1<RESET>
+        line 2<RESET>
+        line 3<RESET>
+        line 4<RESET>
+        line 5<RESET>
+       <MAGENTA>-long line 6<RESET>
+       <MAGENTA>-long line 7<RESET>
+       <MAGENTA>-long line 8<RESET>
+       <RED>-long line 9<RESET>
+       EOF
+       test_cmp expected actual
+'
+
 test_expect_success 'clean up whitespace-test colors' '
        git config --unset color.diff.oldMoved &&
        git config --unset color.diff.newMoved
 test_expect_success 'clean up whitespace-test colors' '
        git config --unset color.diff.oldMoved &&
        git config --unset color.diff.newMoved