diff.c: use utf8_strwidth() to count display width

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>

Torsten Bögershausen committed Sep 14, 2022 at 17:13 UTC 12fc4ad89e23af642a8614371ff80bc67cb3315d
2 files changed +23 -18
diff.c
+16 -11
@@ -2622,7 +2622,7 @@ static void show_stats(struct diffstat_t *data, struct diff_options *options)
2622 continue;
2623 }
2624 fill_print_name(file);
2625 - len = strlen(file->print_name);
2625 + len = utf8_strwidth(file->print_name);
2626 if (max_len < len)
2627 max_len = len;
2628
@@ -2736,7 +2736,7 @@ static void show_stats(struct diffstat_t *data, struct diff_options *options)
2736 char *name = file->print_name;
2737 uintmax_t added = file->added;
2738 uintmax_t deleted = file->deleted;
2739 - int name_len;
2739 + int name_len, padding;
2740
2741 if (!file->is_interesting && (added + deleted == 0))
2742 continue;
@@ -2745,7 +2745,7 @@ static void show_stats(struct diffstat_t *data, struct diff_options *options)
2745 * "scale" the filename
2746 */
2747 len = name_width;
2748 - name_len = strlen(name);
2748 + name_len = utf8_strwidth(name);
2749 if (name_width < name_len) {
2750 char *slash;
2751 prefix = "...";
@@ -2755,10 +2755,14 @@ static void show_stats(struct diffstat_t *data, struct diff_options *options)
2755 if (slash)
2756 name = slash;
2757 }
2758 + padding = len - utf8_strwidth(name);
2759 + if (padding < 0)
2760 + padding = 0;
2761
2762 if (file->is_binary) {
2760 - strbuf_addf(&out, " %s%-*s |", prefix, len, name);
2761 - strbuf_addf(&out, " %*s", number_width, "Bin");
2763 + strbuf_addf(&out, " %s%s%*s | %*s",
2764 + prefix, name, padding, "",
2765 + number_width, "Bin");
2766 if (!added && !deleted) {
2767 strbuf_addch(&out, '\n');
2768 emit_diff_symbol(options, DIFF_SYMBOL_STATS_LINE,
@@ -2778,8 +2782,9 @@ static void show_stats(struct diffstat_t *data, struct diff_options *options)
2782 continue;
2783 }
2784 else if (file->is_unmerged) {
2781 - strbuf_addf(&out, " %s%-*s |", prefix, len, name);
2782 - strbuf_addstr(&out, " Unmerged\n");
2785 + strbuf_addf(&out, " %s%s%*s | %*s",
2786 + prefix, name, padding, "",
2787 + number_width, "Unmerged");
2788 emit_diff_symbol(options, DIFF_SYMBOL_STATS_LINE,
2789 out.buf, out.len, 0);
2790 strbuf_reset(&out);
@@ -2805,10 +2810,10 @@ static void show_stats(struct diffstat_t *data, struct diff_options *options)
2810 add = total - del;
2811 }
2812 }
2808 - strbuf_addf(&out, " %s%-*s |", prefix, len, name);
2809 - strbuf_addf(&out, " %*"PRIuMAX"%s",
2810 - number_width, added + deleted,
2811 - added + deleted ? " " : "");
2813 + strbuf_addf(&out, " %s%s%*s | %*"PRIuMAX"%s",
2814 + prefix, name, padding, "",
2815 + number_width, added + deleted,
2816 + added + deleted ? " " : "");
2817 show_graph(&out, '+', add, add_c, reset);
2818 show_graph(&out, '-', del, del_c, reset);
2819 strbuf_addch(&out, '\n');
t/t4012-diff-binary.sh
+7 -7
@@ -113,20 +113,20 @@ test_expect_success 'diff --no-index with binary creation' '
113 '
114
115 cat >expect <<EOF
116 - binfile | Bin 0 -> 1026 bytes
117 - textfile | 10000 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
116 + binfilë | Bin 0 -> 1026 bytes
117 + tëxtfilë | 10000 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
118 EOF
119
120 test_expect_success 'diff --stat with binary files and big change count' '
121 - printf "\01\00%1024d" 1 >binfile &&
122 - git add binfile &&
121 + printf "\01\00%1024d" 1 >binfilë &&
122 + git add binfilë &&
123 i=0 &&
124 while test $i -lt 10000; do
125 echo $i &&
126 i=$(($i + 1)) || return 1
127 - done >textfile &&
128 - git add textfile &&
129 - git diff --cached --stat binfile textfile >output &&
127 + done >tëxtfilë &&
128 + git add tëxtfilë &&
129 + git -c core.quotepath=false diff --cached --stat binfilë tëxtfilë >output &&
130 grep " | " output >actual &&
131 test_cmp expect actual
132 '