utf8.c: use a table for double_width
[git] / utf8.c
1 #include "git-compat-util.h"
2 #include "strbuf.h"
3 #include "utf8.h"
4
5 /* This code is originally from http://www.cl.cam.ac.uk/~mgk25/ucs/ */
6
7 struct interval {
8   int first;
9   int last;
10 };
11
12 size_t display_mode_esc_sequence_len(const char *s)
13 {
14         const char *p = s;
15         if (*p++ != '\033')
16                 return 0;
17         if (*p++ != '[')
18                 return 0;
19         while (isdigit(*p) || *p == ';')
20                 p++;
21         if (*p++ != 'm')
22                 return 0;
23         return p - s;
24 }
25
26 /* auxiliary function for binary search in interval table */
27 static int bisearch(ucs_char_t ucs, const struct interval *table, int max)
28 {
29         int min = 0;
30         int mid;
31
32         if (ucs < table[0].first || ucs > table[max].last)
33                 return 0;
34         while (max >= min) {
35                 mid = (min + max) / 2;
36                 if (ucs > table[mid].last)
37                         min = mid + 1;
38                 else if (ucs < table[mid].first)
39                         max = mid - 1;
40                 else
41                         return 1;
42         }
43
44         return 0;
45 }
46
47 /* The following two functions define the column width of an ISO 10646
48  * character as follows:
49  *
50  *    - The null character (U+0000) has a column width of 0.
51  *
52  *    - Other C0/C1 control characters and DEL will lead to a return
53  *      value of -1.
54  *
55  *    - Non-spacing and enclosing combining characters (general
56  *      category code Mn or Me in the Unicode database) have a
57  *      column width of 0.
58  *
59  *    - SOFT HYPHEN (U+00AD) has a column width of 1.
60  *
61  *    - Other format characters (general category code Cf in the Unicode
62  *      database) and ZERO WIDTH SPACE (U+200B) have a column width of 0.
63  *
64  *    - Hangul Jamo medial vowels and final consonants (U+1160-U+11FF)
65  *      have a column width of 0.
66  *
67  *    - Spacing characters in the East Asian Wide (W) or East Asian
68  *      Full-width (F) category as defined in Unicode Technical
69  *      Report #11 have a column width of 2.
70  *
71  *    - All remaining characters (including all printable
72  *      ISO 8859-1 and WGL4 characters, Unicode control characters,
73  *      etc.) have a column width of 1.
74  *
75  * This implementation assumes that ucs_char_t characters are encoded
76  * in ISO 10646.
77  */
78
79 static int git_wcwidth(ucs_char_t ch)
80 {
81         /*
82          * Sorted list of non-overlapping intervals of non-spacing characters,
83          * generated by
84          *   "uniset +cat=Me +cat=Mn +cat=Cf -00AD +1160-11FF +200B c".
85          */
86         static const struct interval combining[] = {
87                 { 0x0300, 0x036F }, { 0x0483, 0x0489 }, { 0x0591, 0x05BD },
88                 { 0x05BF, 0x05BF }, { 0x05C1, 0x05C2 }, { 0x05C4, 0x05C5 },
89                 { 0x05C7, 0x05C7 }, { 0x0600, 0x0604 }, { 0x0610, 0x061A },
90                 { 0x064B, 0x065F }, { 0x0670, 0x0670 }, { 0x06D6, 0x06E4 },
91                 { 0x06E7, 0x06E8 }, { 0x06EA, 0x06ED }, { 0x070F, 0x070F },
92                 { 0x0711, 0x0711 }, { 0x0730, 0x074A }, { 0x07A6, 0x07B0 },
93                 { 0x0901, 0x0902 }, { 0x093C, 0x093C }, { 0x0941, 0x0948 },
94                 { 0x094D, 0x094D }, { 0x0951, 0x0954 }, { 0x0962, 0x0963 },
95                 { 0x0981, 0x0981 }, { 0x09BC, 0x09BC }, { 0x09C1, 0x09C4 },
96                 { 0x09CD, 0x09CD }, { 0x09E2, 0x09E3 }, { 0x0A01, 0x0A02 },
97                 { 0x0A3C, 0x0A3C }, { 0x0A41, 0x0A42 }, { 0x0A47, 0x0A48 },
98                 { 0x0A4B, 0x0A4D }, { 0x0A70, 0x0A71 }, { 0x0A81, 0x0A82 },
99                 { 0x0ABC, 0x0ABC }, { 0x0AC1, 0x0AC5 }, { 0x0AC7, 0x0AC8 },
100                 { 0x0ACD, 0x0ACD }, { 0x0AE2, 0x0AE3 }, { 0x0B01, 0x0B01 },
101                 { 0x0B3C, 0x0B3C }, { 0x0B3F, 0x0B3F }, { 0x0B41, 0x0B43 },
102                 { 0x0B4D, 0x0B4D }, { 0x0B56, 0x0B56 }, { 0x0B82, 0x0B82 },
103                 { 0x0BC0, 0x0BC0 }, { 0x0BCD, 0x0BCD }, { 0x0C3E, 0x0C40 },
104                 { 0x0C46, 0x0C48 }, { 0x0C4A, 0x0C4D }, { 0x0C55, 0x0C56 },
105                 { 0x0CBC, 0x0CBC }, { 0x0CBF, 0x0CBF }, { 0x0CC6, 0x0CC6 },
106                 { 0x0CCC, 0x0CCD }, { 0x0D41, 0x0D43 }, { 0x0D4D, 0x0D4D },
107                 { 0x0DCA, 0x0DCA }, { 0x0DD2, 0x0DD4 }, { 0x0DD6, 0x0DD6 },
108                 { 0x0E31, 0x0E31 }, { 0x0E34, 0x0E3A }, { 0x0E47, 0x0E4E },
109                 { 0x0EB1, 0x0EB1 }, { 0x0EB4, 0x0EB9 }, { 0x0EBB, 0x0EBC },
110                 { 0x0EC8, 0x0ECD }, { 0x0F18, 0x0F19 }, { 0x0F35, 0x0F35 },
111                 { 0x0F37, 0x0F37 }, { 0x0F39, 0x0F39 }, { 0x0F71, 0x0F7E },
112                 { 0x0F80, 0x0F84 }, { 0x0F86, 0x0F87 }, { 0x0F90, 0x0F97 },
113                 { 0x0F99, 0x0FBC }, { 0x0FC6, 0x0FC6 }, { 0x102D, 0x1030 },
114                 { 0x1032, 0x1032 }, { 0x1036, 0x1037 }, { 0x1039, 0x1039 },
115                 { 0x1058, 0x1059 }, { 0x1160, 0x11FF }, { 0x1712, 0x1714 },
116                 { 0x1732, 0x1734 }, { 0x1752, 0x1753 }, { 0x1772, 0x1773 },
117                 { 0x17B4, 0x17B5 }, { 0x17B7, 0x17BD }, { 0x17C6, 0x17C6 },
118                 { 0x17C9, 0x17D3 }, { 0x17DD, 0x17DD }, { 0x180B, 0x180D },
119                 { 0x18A9, 0x18A9 }, { 0x1920, 0x1922 }, { 0x1927, 0x1928 },
120                 { 0x1932, 0x1932 }, { 0x1939, 0x193B }, { 0x200B, 0x200F },
121                 { 0x202A, 0x202E }, { 0x2060, 0x2063 }, { 0x206A, 0x206F },
122                 { 0x20D0, 0x20EA }, { 0x302A, 0x302F }, { 0x3099, 0x309A },
123                 { 0xFB1E, 0xFB1E }, { 0xFE00, 0xFE0F }, { 0xFE20, 0xFE23 },
124                 { 0xFEFF, 0xFEFF }, { 0xFFF9, 0xFFFB }, { 0x1D167, 0x1D169 },
125                 { 0x1D173, 0x1D182 }, { 0x1D185, 0x1D18B },
126                 { 0x1D1AA, 0x1D1AD }, { 0xE0001, 0xE0001 },
127                 { 0xE0020, 0xE007F }, { 0xE0100, 0xE01EF }
128         };
129         static const struct interval double_width[] = {
130                 { 0x1100, 0x115F },
131                 { 0x2329, 0x232A },
132                 { 0x2E80, 0x303E },
133                 { 0x3040, 0xA4CF },
134                 { 0xAC00, 0xD7A3 },
135                 { 0xF900, 0xFAFF },
136                 { 0xFE30, 0xFE6F },
137                 { 0xFF00, 0xFF60 },
138                 { 0xFFE0, 0xFFE6 },
139                 { 0x20000, 0x2FFFD },
140                 { 0x30000, 0x3FFFD }
141         };
142
143         /* test for 8-bit control characters */
144         if (ch == 0)
145                 return 0;
146         if (ch < 32 || (ch >= 0x7f && ch < 0xa0))
147                 return -1;
148
149         /* binary search in table of non-spacing characters */
150         if (bisearch(ch, combining, sizeof(combining)
151                                 / sizeof(struct interval) - 1))
152                 return 0;
153
154         /* binary search in table of double width characters */
155         if (bisearch(ch, double_width, sizeof(double_width)
156                                 / sizeof(struct interval) - 1))
157                 return 2;
158
159         return 1;
160 }
161
162 /*
163  * Pick one ucs character starting from the location *start points at,
164  * and return it, while updating the *start pointer to point at the
165  * end of that character.  When remainder_p is not NULL, the location
166  * holds the number of bytes remaining in the string that we are allowed
167  * to pick from.  Otherwise we are allowed to pick up to the NUL that
168  * would eventually appear in the string.  *remainder_p is also reduced
169  * by the number of bytes we have consumed.
170  *
171  * If the string was not a valid UTF-8, *start pointer is set to NULL
172  * and the return value is undefined.
173  */
174 static ucs_char_t pick_one_utf8_char(const char **start, size_t *remainder_p)
175 {
176         unsigned char *s = (unsigned char *)*start;
177         ucs_char_t ch;
178         size_t remainder, incr;
179
180         /*
181          * A caller that assumes NUL terminated text can choose
182          * not to bother with the remainder length.  We will
183          * stop at the first NUL.
184          */
185         remainder = (remainder_p ? *remainder_p : 999);
186
187         if (remainder < 1) {
188                 goto invalid;
189         } else if (*s < 0x80) {
190                 /* 0xxxxxxx */
191                 ch = *s;
192                 incr = 1;
193         } else if ((s[0] & 0xe0) == 0xc0) {
194                 /* 110XXXXx 10xxxxxx */
195                 if (remainder < 2 ||
196                     (s[1] & 0xc0) != 0x80 ||
197                     (s[0] & 0xfe) == 0xc0)
198                         goto invalid;
199                 ch = ((s[0] & 0x1f) << 6) | (s[1] & 0x3f);
200                 incr = 2;
201         } else if ((s[0] & 0xf0) == 0xe0) {
202                 /* 1110XXXX 10Xxxxxx 10xxxxxx */
203                 if (remainder < 3 ||
204                     (s[1] & 0xc0) != 0x80 ||
205                     (s[2] & 0xc0) != 0x80 ||
206                     /* overlong? */
207                     (s[0] == 0xe0 && (s[1] & 0xe0) == 0x80) ||
208                     /* surrogate? */
209                     (s[0] == 0xed && (s[1] & 0xe0) == 0xa0) ||
210                     /* U+FFFE or U+FFFF? */
211                     (s[0] == 0xef && s[1] == 0xbf &&
212                      (s[2] & 0xfe) == 0xbe))
213                         goto invalid;
214                 ch = ((s[0] & 0x0f) << 12) |
215                         ((s[1] & 0x3f) << 6) | (s[2] & 0x3f);
216                 incr = 3;
217         } else if ((s[0] & 0xf8) == 0xf0) {
218                 /* 11110XXX 10XXxxxx 10xxxxxx 10xxxxxx */
219                 if (remainder < 4 ||
220                     (s[1] & 0xc0) != 0x80 ||
221                     (s[2] & 0xc0) != 0x80 ||
222                     (s[3] & 0xc0) != 0x80 ||
223                     /* overlong? */
224                     (s[0] == 0xf0 && (s[1] & 0xf0) == 0x80) ||
225                     /* > U+10FFFF? */
226                     (s[0] == 0xf4 && s[1] > 0x8f) || s[0] > 0xf4)
227                         goto invalid;
228                 ch = ((s[0] & 0x07) << 18) | ((s[1] & 0x3f) << 12) |
229                         ((s[2] & 0x3f) << 6) | (s[3] & 0x3f);
230                 incr = 4;
231         } else {
232 invalid:
233                 *start = NULL;
234                 return 0;
235         }
236
237         *start += incr;
238         if (remainder_p)
239                 *remainder_p = remainder - incr;
240         return ch;
241 }
242
243 /*
244  * This function returns the number of columns occupied by the character
245  * pointed to by the variable start. The pointer is updated to point at
246  * the next character. When remainder_p is not NULL, it points at the
247  * location that stores the number of remaining bytes we can use to pick
248  * a character (see pick_one_utf8_char() above).
249  */
250 int utf8_width(const char **start, size_t *remainder_p)
251 {
252         ucs_char_t ch = pick_one_utf8_char(start, remainder_p);
253         if (!*start)
254                 return 0;
255         return git_wcwidth(ch);
256 }
257
258 /*
259  * Returns the total number of columns required by a null-terminated
260  * string, assuming that the string is utf8.  Returns strlen() instead
261  * if the string does not look like a valid utf8 string.
262  */
263 int utf8_strnwidth(const char *string, int len, int skip_ansi)
264 {
265         int width = 0;
266         const char *orig = string;
267
268         if (len == -1)
269                 len = strlen(string);
270         while (string && string < orig + len) {
271                 int skip;
272                 while (skip_ansi &&
273                        (skip = display_mode_esc_sequence_len(string)) != 0)
274                         string += skip;
275                 width += utf8_width(&string, NULL);
276         }
277         return string ? width : len;
278 }
279
280 int utf8_strwidth(const char *string)
281 {
282         return utf8_strnwidth(string, -1, 0);
283 }
284
285 int is_utf8(const char *text)
286 {
287         while (*text) {
288                 if (*text == '\n' || *text == '\t' || *text == '\r') {
289                         text++;
290                         continue;
291                 }
292                 utf8_width(&text, NULL);
293                 if (!text)
294                         return 0;
295         }
296         return 1;
297 }
298
299 static void strbuf_addchars(struct strbuf *sb, int c, size_t n)
300 {
301         strbuf_grow(sb, n);
302         memset(sb->buf + sb->len, c, n);
303         strbuf_setlen(sb, sb->len + n);
304 }
305
306 static void strbuf_add_indented_text(struct strbuf *buf, const char *text,
307                                      int indent, int indent2)
308 {
309         if (indent < 0)
310                 indent = 0;
311         while (*text) {
312                 const char *eol = strchrnul(text, '\n');
313                 if (*eol == '\n')
314                         eol++;
315                 strbuf_addchars(buf, ' ', indent);
316                 strbuf_add(buf, text, eol - text);
317                 text = eol;
318                 indent = indent2;
319         }
320 }
321
322 /*
323  * Wrap the text, if necessary. The variable indent is the indent for the
324  * first line, indent2 is the indent for all other lines.
325  * If indent is negative, assume that already -indent columns have been
326  * consumed (and no extra indent is necessary for the first line).
327  */
328 void strbuf_add_wrapped_text(struct strbuf *buf,
329                 const char *text, int indent1, int indent2, int width)
330 {
331         int indent, w, assume_utf8 = 1;
332         const char *bol, *space, *start = text;
333         size_t orig_len = buf->len;
334
335         if (width <= 0) {
336                 strbuf_add_indented_text(buf, text, indent1, indent2);
337                 return;
338         }
339
340 retry:
341         bol = text;
342         w = indent = indent1;
343         space = NULL;
344         if (indent < 0) {
345                 w = -indent;
346                 space = text;
347         }
348
349         for (;;) {
350                 char c;
351                 size_t skip;
352
353                 while ((skip = display_mode_esc_sequence_len(text)))
354                         text += skip;
355
356                 c = *text;
357                 if (!c || isspace(c)) {
358                         if (w <= width || !space) {
359                                 const char *start = bol;
360                                 if (!c && text == start)
361                                         return;
362                                 if (space)
363                                         start = space;
364                                 else
365                                         strbuf_addchars(buf, ' ', indent);
366                                 strbuf_add(buf, start, text - start);
367                                 if (!c)
368                                         return;
369                                 space = text;
370                                 if (c == '\t')
371                                         w |= 0x07;
372                                 else if (c == '\n') {
373                                         space++;
374                                         if (*space == '\n') {
375                                                 strbuf_addch(buf, '\n');
376                                                 goto new_line;
377                                         }
378                                         else if (!isalnum(*space))
379                                                 goto new_line;
380                                         else
381                                                 strbuf_addch(buf, ' ');
382                                 }
383                                 w++;
384                                 text++;
385                         }
386                         else {
387 new_line:
388                                 strbuf_addch(buf, '\n');
389                                 text = bol = space + isspace(*space);
390                                 space = NULL;
391                                 w = indent = indent2;
392                         }
393                         continue;
394                 }
395                 if (assume_utf8) {
396                         w += utf8_width(&text, NULL);
397                         if (!text) {
398                                 assume_utf8 = 0;
399                                 text = start;
400                                 strbuf_setlen(buf, orig_len);
401                                 goto retry;
402                         }
403                 } else {
404                         w++;
405                         text++;
406                 }
407         }
408 }
409
410 void strbuf_add_wrapped_bytes(struct strbuf *buf, const char *data, int len,
411                              int indent, int indent2, int width)
412 {
413         char *tmp = xstrndup(data, len);
414         strbuf_add_wrapped_text(buf, tmp, indent, indent2, width);
415         free(tmp);
416 }
417
418 void strbuf_utf8_replace(struct strbuf *sb_src, int pos, int width,
419                          const char *subst)
420 {
421         struct strbuf sb_dst = STRBUF_INIT;
422         char *src = sb_src->buf;
423         char *end = src + sb_src->len;
424         char *dst;
425         int w = 0, subst_len = 0;
426
427         if (subst)
428                 subst_len = strlen(subst);
429         strbuf_grow(&sb_dst, sb_src->len + subst_len);
430         dst = sb_dst.buf;
431
432         while (src < end) {
433                 char *old;
434                 size_t n;
435
436                 while ((n = display_mode_esc_sequence_len(src))) {
437                         memcpy(dst, src, n);
438                         src += n;
439                         dst += n;
440                 }
441
442                 old = src;
443                 n = utf8_width((const char**)&src, NULL);
444                 if (!src)       /* broken utf-8, do nothing */
445                         return;
446                 if (n && w >= pos && w < pos + width) {
447                         if (subst) {
448                                 memcpy(dst, subst, subst_len);
449                                 dst += subst_len;
450                                 subst = NULL;
451                         }
452                         w += n;
453                         continue;
454                 }
455                 memcpy(dst, old, src - old);
456                 dst += src - old;
457                 w += n;
458         }
459         strbuf_setlen(&sb_dst, dst - sb_dst.buf);
460         strbuf_swap(sb_src, &sb_dst);
461         strbuf_release(&sb_dst);
462 }
463
464 int is_encoding_utf8(const char *name)
465 {
466         if (!name)
467                 return 1;
468         if (!strcasecmp(name, "utf-8") || !strcasecmp(name, "utf8"))
469                 return 1;
470         return 0;
471 }
472
473 int same_encoding(const char *src, const char *dst)
474 {
475         if (is_encoding_utf8(src) && is_encoding_utf8(dst))
476                 return 1;
477         return !strcasecmp(src, dst);
478 }
479
480 /*
481  * Wrapper for fprintf and returns the total number of columns required
482  * for the printed string, assuming that the string is utf8.
483  */
484 int utf8_fprintf(FILE *stream, const char *format, ...)
485 {
486         struct strbuf buf = STRBUF_INIT;
487         va_list arg;
488         int columns;
489
490         va_start(arg, format);
491         strbuf_vaddf(&buf, format, arg);
492         va_end(arg);
493
494         columns = fputs(buf.buf, stream);
495         if (0 <= columns) /* keep the error from the I/O */
496                 columns = utf8_strwidth(buf.buf);
497         strbuf_release(&buf);
498         return columns;
499 }
500
501 /*
502  * Given a buffer and its encoding, return it re-encoded
503  * with iconv.  If the conversion fails, returns NULL.
504  */
505 #ifndef NO_ICONV
506 #if defined(OLD_ICONV) || (defined(__sun__) && !defined(_XPG6))
507         typedef const char * iconv_ibp;
508 #else
509         typedef char * iconv_ibp;
510 #endif
511 char *reencode_string_iconv(const char *in, size_t insz, iconv_t conv, int *outsz_p)
512 {
513         size_t outsz, outalloc;
514         char *out, *outpos;
515         iconv_ibp cp;
516
517         outsz = insz;
518         outalloc = outsz + 1; /* for terminating NUL */
519         out = xmalloc(outalloc);
520         outpos = out;
521         cp = (iconv_ibp)in;
522
523         while (1) {
524                 size_t cnt = iconv(conv, &cp, &insz, &outpos, &outsz);
525
526                 if (cnt == -1) {
527                         size_t sofar;
528                         if (errno != E2BIG) {
529                                 free(out);
530                                 return NULL;
531                         }
532                         /* insz has remaining number of bytes.
533                          * since we started outsz the same as insz,
534                          * it is likely that insz is not enough for
535                          * converting the rest.
536                          */
537                         sofar = outpos - out;
538                         outalloc = sofar + insz * 2 + 32;
539                         out = xrealloc(out, outalloc);
540                         outpos = out + sofar;
541                         outsz = outalloc - sofar - 1;
542                 }
543                 else {
544                         *outpos = '\0';
545                         if (outsz_p)
546                                 *outsz_p = outpos - out;
547                         break;
548                 }
549         }
550         return out;
551 }
552
553 char *reencode_string_len(const char *in, int insz,
554                           const char *out_encoding, const char *in_encoding,
555                           int *outsz)
556 {
557         iconv_t conv;
558         char *out;
559
560         if (!in_encoding)
561                 return NULL;
562
563         conv = iconv_open(out_encoding, in_encoding);
564         if (conv == (iconv_t) -1) {
565                 /*
566                  * Some platforms do not have the variously spelled variants of
567                  * UTF-8, so let's fall back to trying the most official
568                  * spelling. We do so only as a fallback in case the platform
569                  * does understand the user's spelling, but not our official
570                  * one.
571                  */
572                 if (is_encoding_utf8(in_encoding))
573                         in_encoding = "UTF-8";
574                 if (is_encoding_utf8(out_encoding))
575                         out_encoding = "UTF-8";
576                 conv = iconv_open(out_encoding, in_encoding);
577                 if (conv == (iconv_t) -1)
578                         return NULL;
579         }
580
581         out = reencode_string_iconv(in, insz, conv, outsz);
582         iconv_close(conv);
583         return out;
584 }
585 #endif
586
587 /*
588  * Returns first character length in bytes for multi-byte `text` according to
589  * `encoding`.
590  *
591  * - The `text` pointer is updated to point at the next character.
592  * - When `remainder_p` is not NULL, on entry `*remainder_p` is how much bytes
593  *   we can consume from text, and on exit `*remainder_p` is reduced by returned
594  *   character length. Otherwise `text` is treated as limited by NUL.
595  */
596 int mbs_chrlen(const char **text, size_t *remainder_p, const char *encoding)
597 {
598         int chrlen;
599         const char *p = *text;
600         size_t r = (remainder_p ? *remainder_p : SIZE_MAX);
601
602         if (r < 1)
603                 return 0;
604
605         if (is_encoding_utf8(encoding)) {
606                 pick_one_utf8_char(&p, &r);
607
608                 chrlen = p ? (p - *text)
609                            : 1 /* not valid UTF-8 -> raw byte sequence */;
610         }
611         else {
612                 /*
613                  * TODO use iconv to decode one char and obtain its chrlen
614                  * for now, let's treat encodings != UTF-8 as one-byte
615                  */
616                 chrlen = 1;
617         }
618
619         *text += chrlen;
620         if (remainder_p)
621                 *remainder_p -= chrlen;
622
623         return chrlen;
624 }