mirror of
https://github.com/git/git.git
synced 2024-05-27 12:16:10 +02:00
12fc4ad89e
When unicode filenames (encoded in UTF-8) are used, the visible width on the screen is not the same as strlen(). For example, `git log --stat` may produce an output like this: [snip the header] Arger.txt | 1 + Ärger.txt | 1 + 2 files changed, 2 insertions(+) A side note: the original report was about cyrillic filenames. After some investigations it turned out that a) This is not a problem with "ambiguous characters" in unicode b) The same problem exists for all unicode code points (so we can use Latin based Umlauts for demonstrations below) The 'Ä' takes the same space on the screen as the 'A'. But needs one more byte in memory, so the the `git log --stat` output for "Arger.txt" (!) gets mis-aligned: The maximum length is derived from "Ärger.txt", 10 bytes in memory, 9 positions on the screen. That is why "Arger.txt" gets one extra ' ' for aligment, it needs 9 bytes in memory. If there was a file "Ö", it would be correctly aligned by chance, but "Öhö" would not. The solution is of course, to use utf8_strwidth() instead of strlen() when dealing with the width on screen. And then there is another problem, code like this: strbuf_addf(&out, "%-*s", len, name); (or using the underlying snprintf() function) does not align the buffer to a minimum of len measured in screen-width, but uses the memory count. One could be tempted to wish that snprintf() was UTF-8 aware. That doesn't seem to be the case anywhere (tested on Linux and Mac), probably snprintf() uses the "bytes in memory"/strlen() approach to be compatible with older versions and this will never change. The basic idea is to change code in diff.c like this strbuf_addf(&out, "%-*s", len, name); into something like this: int padding = len - utf8_strwidth(name); if (padding < 0) padding = 0; strbuf_addf(&out, " %s%*s", name, padding, ""); The real change is slighty bigger, as it, as well, integrates two calls of strbuf_addf() into one. Tests: Two things need to be tested: - The calculation of the maximum width - The calculation of padding The name "textfile" is changed into "tëxtfilë", both have a width of 8. If strlen() was used, to get the maximum width, the shorter "binfile" would have been mis-aligned: binfile | [snip] tëxtfilë | [snip] If only "binfile" would be renamed into "binfilë": binfilë | [snip] textfile | [snip] In order to verify that the width is calculated correctly everywhere, "binfile" is renamed into "binfilë", giving 1 bytes more in strlen() "tëxtfile" is renamed into "tëxtfilë", 2 byte more in strlen(). The updated t4012-diff-binary.sh checks the correct aligment: binfilë | [snip] tëxtfilë | [snip] Reported-by: Alexander Meshcheryakov <alexander.s.m@gmail.com> Helped-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Torsten Bögershausen <tboegi@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
135 lines
3.6 KiB
Bash
Executable File
135 lines
3.6 KiB
Bash
Executable File
#!/bin/sh
|
|
#
|
|
# Copyright (c) 2006 Junio C Hamano
|
|
#
|
|
|
|
test_description='Binary diff and apply
|
|
'
|
|
|
|
TEST_PASSES_SANITIZE_LEAK=true
|
|
. ./test-lib.sh
|
|
|
|
cat >expect.binary-numstat <<\EOF
|
|
1 1 a
|
|
- - b
|
|
1 1 c
|
|
- - d
|
|
EOF
|
|
|
|
test_expect_success 'prepare repository' '
|
|
echo AIT >a && echo BIT >b && echo CIT >c && echo DIT >d &&
|
|
git update-index --add a b c d &&
|
|
echo git >a &&
|
|
cat "$TEST_DIRECTORY"/test-binary-1.png >b &&
|
|
echo git >c &&
|
|
cat b b >d
|
|
'
|
|
|
|
cat > expected <<\EOF
|
|
a | 2 +-
|
|
b | Bin
|
|
c | 2 +-
|
|
d | Bin
|
|
4 files changed, 2 insertions(+), 2 deletions(-)
|
|
EOF
|
|
test_expect_success 'apply --stat output for binary file change' '
|
|
git diff >diff &&
|
|
git apply --stat --summary <diff >current &&
|
|
test_cmp expected current
|
|
'
|
|
|
|
test_expect_success 'diff --shortstat output for binary file change' '
|
|
tail -n 1 expected >expect &&
|
|
git diff --shortstat >current &&
|
|
test_cmp expect current
|
|
'
|
|
|
|
test_expect_success 'diff --shortstat output for binary file change only' '
|
|
echo " 1 file changed, 0 insertions(+), 0 deletions(-)" >expected &&
|
|
git diff --shortstat -- b >current &&
|
|
test_cmp expected current
|
|
'
|
|
|
|
test_expect_success 'apply --numstat notices binary file change' '
|
|
git diff >diff &&
|
|
git apply --numstat <diff >current &&
|
|
test_cmp expect.binary-numstat current
|
|
'
|
|
|
|
test_expect_success 'apply --numstat understands diff --binary format' '
|
|
git diff --binary >diff &&
|
|
git apply --numstat <diff >current &&
|
|
test_cmp expect.binary-numstat current
|
|
'
|
|
|
|
# apply needs to be able to skip the binary material correctly
|
|
# in order to report the line number of a corrupt patch.
|
|
test_expect_success 'apply detecting corrupt patch correctly' '
|
|
git diff >output &&
|
|
sed -e "s/-CIT/xCIT/" <output >broken &&
|
|
test_must_fail git apply --stat --summary broken 2>detected &&
|
|
detected=$(cat detected) &&
|
|
detected=$(expr "$detected" : "error.*at line \\([0-9]*\\)\$") &&
|
|
detected=$(sed -ne "${detected}p" broken) &&
|
|
test "$detected" = xCIT
|
|
'
|
|
|
|
test_expect_success 'apply detecting corrupt patch correctly' '
|
|
git diff --binary | sed -e "s/-CIT/xCIT/" >broken &&
|
|
test_must_fail git apply --stat --summary broken 2>detected &&
|
|
detected=$(cat detected) &&
|
|
detected=$(expr "$detected" : "error.*at line \\([0-9]*\\)\$") &&
|
|
detected=$(sed -ne "${detected}p" broken) &&
|
|
test "$detected" = xCIT
|
|
'
|
|
|
|
test_expect_success 'initial commit' 'git commit -a -m initial'
|
|
|
|
# Try removal (b), modification (d), and creation (e).
|
|
test_expect_success 'diff-index with --binary' '
|
|
echo AIT >a && mv b e && echo CIT >c && cat e >d &&
|
|
git update-index --add --remove a b c d e &&
|
|
tree0=$(git write-tree) &&
|
|
git diff --cached --binary >current &&
|
|
git apply --stat --summary current
|
|
'
|
|
|
|
test_expect_success 'apply binary patch' '
|
|
git reset --hard &&
|
|
git apply --binary --index <current &&
|
|
tree1=$(git write-tree) &&
|
|
test "$tree1" = "$tree0"
|
|
'
|
|
|
|
test_expect_success 'diff --no-index with binary creation' '
|
|
echo Q | q_to_nul >binary &&
|
|
# hide error code from diff, which just indicates differences
|
|
test_might_fail git diff --binary --no-index /dev/null binary >current &&
|
|
rm binary &&
|
|
git apply --binary <current &&
|
|
echo Q >expected &&
|
|
nul_to_q <binary >actual &&
|
|
test_cmp expected actual
|
|
'
|
|
|
|
cat >expect <<EOF
|
|
binfilë | Bin 0 -> 1026 bytes
|
|
tëxtfilë | 10000 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
|
EOF
|
|
|
|
test_expect_success 'diff --stat with binary files and big change count' '
|
|
printf "\01\00%1024d" 1 >binfilë &&
|
|
git add binfilë &&
|
|
i=0 &&
|
|
while test $i -lt 10000; do
|
|
echo $i &&
|
|
i=$(($i + 1)) || return 1
|
|
done >tëxtfilë &&
|
|
git add tëxtfilë &&
|
|
git -c core.quotepath=false diff --cached --stat binfilë tëxtfilë >output &&
|
|
grep " | " output >actual &&
|
|
test_cmp expect actual
|
|
'
|
|
|
|
test_done
|