Merge branch 'rs/use-copy-array-in-mingw-shell-command-preparation'
[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 static const char utf16_be_bom[] = {'\xFE', '\xFF'};
8 static const char utf16_le_bom[] = {'\xFF', '\xFE'};
9 static const char utf32_be_bom[] = {'\0', '\0', '\xFE', '\xFF'};
10 static const char utf32_le_bom[] = {'\xFF', '\xFE', '\0', '\0'};
11
12 struct interval {
13         ucs_char_t first;
14         ucs_char_t last;
15 };
16
17 size_t display_mode_esc_sequence_len(const char *s)
18 {
19         const char *p = s;
20         if (*p++ != '\033')
21                 return 0;
22         if (*p++ != '[')
23                 return 0;
24         while (isdigit(*p) || *p == ';')
25                 p++;
26         if (*p++ != 'm')
27                 return 0;
28         return p - s;
29 }
30
31 /* auxiliary function for binary search in interval table */
32 static int bisearch(ucs_char_t ucs, const struct interval *table, int max)
33 {
34         int min = 0;
35         int mid;
36
37         if (ucs < table[0].first || ucs > table[max].last)
38                 return 0;
39         while (max >= min) {
40                 mid = min + (max - min) / 2;
41                 if (ucs > table[mid].last)
42                         min = mid + 1;
43                 else if (ucs < table[mid].first)
44                         max = mid - 1;
45                 else
46                         return 1;
47         }
48
49         return 0;
50 }
51
52 /* The following two functions define the column width of an ISO 10646
53  * character as follows:
54  *
55  *    - The null character (U+0000) has a column width of 0.
56  *
57  *    - Other C0/C1 control characters and DEL will lead to a return
58  *      value of -1.
59  *
60  *    - Non-spacing and enclosing combining characters (general
61  *      category code Mn or Me in the Unicode database) have a
62  *      column width of 0.
63  *
64  *    - SOFT HYPHEN (U+00AD) has a column width of 1.
65  *
66  *    - Other format characters (general category code Cf in the Unicode
67  *      database) and ZERO WIDTH SPACE (U+200B) have a column width of 0.
68  *
69  *    - Hangul Jamo medial vowels and final consonants (U+1160-U+11FF)
70  *      have a column width of 0.
71  *
72  *    - Spacing characters in the East Asian Wide (W) or East Asian
73  *      Full-width (F) category as defined in Unicode Technical
74  *      Report #11 have a column width of 2.
75  *
76  *    - All remaining characters (including all printable
77  *      ISO 8859-1 and WGL4 characters, Unicode control characters,
78  *      etc.) have a column width of 1.
79  *
80  * This implementation assumes that ucs_char_t characters are encoded
81  * in ISO 10646.
82  */
83
84 static int git_wcwidth(ucs_char_t ch)
85 {
86         /*
87          * Sorted list of non-overlapping intervals of non-spacing characters,
88          */
89 #include "unicode-width.h"
90
91         /* test for 8-bit control characters */
92         if (ch == 0)
93                 return 0;
94         if (ch < 32 || (ch >= 0x7f && ch < 0xa0))
95                 return -1;
96
97         /* binary search in table of non-spacing characters */
98         if (bisearch(ch, zero_width, ARRAY_SIZE(zero_width) - 1))
99                 return 0;
100
101         /* binary search in table of double width characters */
102         if (bisearch(ch, double_width, ARRAY_SIZE(double_width) - 1))
103                 return 2;
104
105         return 1;
106 }
107
108 /*
109  * Pick one ucs character starting from the location *start points at,
110  * and return it, while updating the *start pointer to point at the
111  * end of that character.  When remainder_p is not NULL, the location
112  * holds the number of bytes remaining in the string that we are allowed
113  * to pick from.  Otherwise we are allowed to pick up to the NUL that
114  * would eventually appear in the string.  *remainder_p is also reduced
115  * by the number of bytes we have consumed.
116  *
117  * If the string was not a valid UTF-8, *start pointer is set to NULL
118  * and the return value is undefined.
119  */
120 static ucs_char_t pick_one_utf8_char(const char **start, size_t *remainder_p)
121 {
122         unsigned char *s = (unsigned char *)*start;
123         ucs_char_t ch;
124         size_t remainder, incr;
125
126         /*
127          * A caller that assumes NUL terminated text can choose
128          * not to bother with the remainder length.  We will
129          * stop at the first NUL.
130          */
131         remainder = (remainder_p ? *remainder_p : 999);
132
133         if (remainder < 1) {
134                 goto invalid;
135         } else if (*s < 0x80) {
136                 /* 0xxxxxxx */
137                 ch = *s;
138                 incr = 1;
139         } else if ((s[0] & 0xe0) == 0xc0) {
140                 /* 110XXXXx 10xxxxxx */
141                 if (remainder < 2 ||
142                     (s[1] & 0xc0) != 0x80 ||
143                     (s[0] & 0xfe) == 0xc0)
144                         goto invalid;
145                 ch = ((s[0] & 0x1f) << 6) | (s[1] & 0x3f);
146                 incr = 2;
147         } else if ((s[0] & 0xf0) == 0xe0) {
148                 /* 1110XXXX 10Xxxxxx 10xxxxxx */
149                 if (remainder < 3 ||
150                     (s[1] & 0xc0) != 0x80 ||
151                     (s[2] & 0xc0) != 0x80 ||
152                     /* overlong? */
153                     (s[0] == 0xe0 && (s[1] & 0xe0) == 0x80) ||
154                     /* surrogate? */
155                     (s[0] == 0xed && (s[1] & 0xe0) == 0xa0) ||
156                     /* U+FFFE or U+FFFF? */
157                     (s[0] == 0xef && s[1] == 0xbf &&
158                      (s[2] & 0xfe) == 0xbe))
159                         goto invalid;
160                 ch = ((s[0] & 0x0f) << 12) |
161                         ((s[1] & 0x3f) << 6) | (s[2] & 0x3f);
162                 incr = 3;
163         } else if ((s[0] & 0xf8) == 0xf0) {
164                 /* 11110XXX 10XXxxxx 10xxxxxx 10xxxxxx */
165                 if (remainder < 4 ||
166                     (s[1] & 0xc0) != 0x80 ||
167                     (s[2] & 0xc0) != 0x80 ||
168                     (s[3] & 0xc0) != 0x80 ||
169                     /* overlong? */
170                     (s[0] == 0xf0 && (s[1] & 0xf0) == 0x80) ||
171                     /* > U+10FFFF? */
172                     (s[0] == 0xf4 && s[1] > 0x8f) || s[0] > 0xf4)
173                         goto invalid;
174                 ch = ((s[0] & 0x07) << 18) | ((s[1] & 0x3f) << 12) |
175                         ((s[2] & 0x3f) << 6) | (s[3] & 0x3f);
176                 incr = 4;
177         } else {
178 invalid:
179                 *start = NULL;
180                 return 0;
181         }
182
183         *start += incr;
184         if (remainder_p)
185                 *remainder_p = remainder - incr;
186         return ch;
187 }
188
189 /*
190  * This function returns the number of columns occupied by the character
191  * pointed to by the variable start. The pointer is updated to point at
192  * the next character. When remainder_p is not NULL, it points at the
193  * location that stores the number of remaining bytes we can use to pick
194  * a character (see pick_one_utf8_char() above).
195  */
196 int utf8_width(const char **start, size_t *remainder_p)
197 {
198         ucs_char_t ch = pick_one_utf8_char(start, remainder_p);
199         if (!*start)
200                 return 0;
201         return git_wcwidth(ch);
202 }
203
204 /*
205  * Returns the total number of columns required by a null-terminated
206  * string, assuming that the string is utf8.  Returns strlen() instead
207  * if the string does not look like a valid utf8 string.
208  */
209 int utf8_strnwidth(const char *string, int len, int skip_ansi)
210 {
211         int width = 0;
212         const char *orig = string;
213
214         if (len == -1)
215                 len = strlen(string);
216         while (string && string < orig + len) {
217                 int skip;
218                 while (skip_ansi &&
219                        (skip = display_mode_esc_sequence_len(string)) != 0)
220                         string += skip;
221                 width += utf8_width(&string, NULL);
222         }
223         return string ? width : len;
224 }
225
226 int utf8_strwidth(const char *string)
227 {
228         return utf8_strnwidth(string, -1, 0);
229 }
230
231 int is_utf8(const char *text)
232 {
233         while (*text) {
234                 if (*text == '\n' || *text == '\t' || *text == '\r') {
235                         text++;
236                         continue;
237                 }
238                 utf8_width(&text, NULL);
239                 if (!text)
240                         return 0;
241         }
242         return 1;
243 }
244
245 static void strbuf_add_indented_text(struct strbuf *buf, const char *text,
246                                      int indent, int indent2)
247 {
248         if (indent < 0)
249                 indent = 0;
250         while (*text) {
251                 const char *eol = strchrnul(text, '\n');
252                 if (*eol == '\n')
253                         eol++;
254                 strbuf_addchars(buf, ' ', indent);
255                 strbuf_add(buf, text, eol - text);
256                 text = eol;
257                 indent = indent2;
258         }
259 }
260
261 /*
262  * Wrap the text, if necessary. The variable indent is the indent for the
263  * first line, indent2 is the indent for all other lines.
264  * If indent is negative, assume that already -indent columns have been
265  * consumed (and no extra indent is necessary for the first line).
266  */
267 void strbuf_add_wrapped_text(struct strbuf *buf,
268                 const char *text, int indent1, int indent2, int width)
269 {
270         int indent, w, assume_utf8 = 1;
271         const char *bol, *space, *start = text;
272         size_t orig_len = buf->len;
273
274         if (width <= 0) {
275                 strbuf_add_indented_text(buf, text, indent1, indent2);
276                 return;
277         }
278
279 retry:
280         bol = text;
281         w = indent = indent1;
282         space = NULL;
283         if (indent < 0) {
284                 w = -indent;
285                 space = text;
286         }
287
288         for (;;) {
289                 char c;
290                 size_t skip;
291
292                 while ((skip = display_mode_esc_sequence_len(text)))
293                         text += skip;
294
295                 c = *text;
296                 if (!c || isspace(c)) {
297                         if (w <= width || !space) {
298                                 const char *start = bol;
299                                 if (!c && text == start)
300                                         return;
301                                 if (space)
302                                         start = space;
303                                 else
304                                         strbuf_addchars(buf, ' ', indent);
305                                 strbuf_add(buf, start, text - start);
306                                 if (!c)
307                                         return;
308                                 space = text;
309                                 if (c == '\t')
310                                         w |= 0x07;
311                                 else if (c == '\n') {
312                                         space++;
313                                         if (*space == '\n') {
314                                                 strbuf_addch(buf, '\n');
315                                                 goto new_line;
316                                         }
317                                         else if (!isalnum(*space))
318                                                 goto new_line;
319                                         else
320                                                 strbuf_addch(buf, ' ');
321                                 }
322                                 w++;
323                                 text++;
324                         }
325                         else {
326 new_line:
327                                 strbuf_addch(buf, '\n');
328                                 text = bol = space + isspace(*space);
329                                 space = NULL;
330                                 w = indent = indent2;
331                         }
332                         continue;
333                 }
334                 if (assume_utf8) {
335                         w += utf8_width(&text, NULL);
336                         if (!text) {
337                                 assume_utf8 = 0;
338                                 text = start;
339                                 strbuf_setlen(buf, orig_len);
340                                 goto retry;
341                         }
342                 } else {
343                         w++;
344                         text++;
345                 }
346         }
347 }
348
349 void strbuf_add_wrapped_bytes(struct strbuf *buf, const char *data, int len,
350                              int indent, int indent2, int width)
351 {
352         char *tmp = xstrndup(data, len);
353         strbuf_add_wrapped_text(buf, tmp, indent, indent2, width);
354         free(tmp);
355 }
356
357 void strbuf_utf8_replace(struct strbuf *sb_src, int pos, int width,
358                          const char *subst)
359 {
360         struct strbuf sb_dst = STRBUF_INIT;
361         char *src = sb_src->buf;
362         char *end = src + sb_src->len;
363         char *dst;
364         int w = 0, subst_len = 0;
365
366         if (subst)
367                 subst_len = strlen(subst);
368         strbuf_grow(&sb_dst, sb_src->len + subst_len);
369         dst = sb_dst.buf;
370
371         while (src < end) {
372                 char *old;
373                 size_t n;
374
375                 while ((n = display_mode_esc_sequence_len(src))) {
376                         memcpy(dst, src, n);
377                         src += n;
378                         dst += n;
379                 }
380
381                 if (src >= end)
382                         break;
383
384                 old = src;
385                 n = utf8_width((const char**)&src, NULL);
386                 if (!src)       /* broken utf-8, do nothing */
387                         goto out;
388                 if (n && w >= pos && w < pos + width) {
389                         if (subst) {
390                                 memcpy(dst, subst, subst_len);
391                                 dst += subst_len;
392                                 subst = NULL;
393                         }
394                         w += n;
395                         continue;
396                 }
397                 memcpy(dst, old, src - old);
398                 dst += src - old;
399                 w += n;
400         }
401         strbuf_setlen(&sb_dst, dst - sb_dst.buf);
402         strbuf_swap(sb_src, &sb_dst);
403 out:
404         strbuf_release(&sb_dst);
405 }
406
407 /*
408  * Returns true (1) if the src encoding name matches the dst encoding
409  * name directly or one of its alternative names. E.g. UTF-16BE is the
410  * same as UTF16BE.
411  */
412 static int same_utf_encoding(const char *src, const char *dst)
413 {
414         if (skip_iprefix(src, "utf", &src) && skip_iprefix(dst, "utf", &dst)) {
415                 skip_prefix(src, "-", &src);
416                 skip_prefix(dst, "-", &dst);
417                 return !strcasecmp(src, dst);
418         }
419         return 0;
420 }
421
422 int is_encoding_utf8(const char *name)
423 {
424         if (!name)
425                 return 1;
426         if (same_utf_encoding("utf-8", name))
427                 return 1;
428         return 0;
429 }
430
431 int same_encoding(const char *src, const char *dst)
432 {
433         static const char utf8[] = "UTF-8";
434
435         if (!src)
436                 src = utf8;
437         if (!dst)
438                 dst = utf8;
439         if (same_utf_encoding(src, dst))
440                 return 1;
441         return !strcasecmp(src, dst);
442 }
443
444 /*
445  * Wrapper for fprintf and returns the total number of columns required
446  * for the printed string, assuming that the string is utf8.
447  */
448 int utf8_fprintf(FILE *stream, const char *format, ...)
449 {
450         struct strbuf buf = STRBUF_INIT;
451         va_list arg;
452         int columns;
453
454         va_start(arg, format);
455         strbuf_vaddf(&buf, format, arg);
456         va_end(arg);
457
458         columns = fputs(buf.buf, stream);
459         if (0 <= columns) /* keep the error from the I/O */
460                 columns = utf8_strwidth(buf.buf);
461         strbuf_release(&buf);
462         return columns;
463 }
464
465 /*
466  * Given a buffer and its encoding, return it re-encoded
467  * with iconv.  If the conversion fails, returns NULL.
468  */
469 #ifndef NO_ICONV
470 #if defined(OLD_ICONV) || (defined(__sun__) && !defined(_XPG6))
471         typedef const char * iconv_ibp;
472 #else
473         typedef char * iconv_ibp;
474 #endif
475 char *reencode_string_iconv(const char *in, size_t insz, iconv_t conv,
476                             size_t bom_len, size_t *outsz_p)
477 {
478         size_t outsz, outalloc;
479         char *out, *outpos;
480         iconv_ibp cp;
481
482         outsz = insz;
483         outalloc = st_add(outsz, 1 + bom_len); /* for terminating NUL */
484         out = xmalloc(outalloc);
485         outpos = out + bom_len;
486         cp = (iconv_ibp)in;
487
488         while (1) {
489                 size_t cnt = iconv(conv, &cp, &insz, &outpos, &outsz);
490
491                 if (cnt == (size_t) -1) {
492                         size_t sofar;
493                         if (errno != E2BIG) {
494                                 free(out);
495                                 return NULL;
496                         }
497                         /* insz has remaining number of bytes.
498                          * since we started outsz the same as insz,
499                          * it is likely that insz is not enough for
500                          * converting the rest.
501                          */
502                         sofar = outpos - out;
503                         outalloc = st_add3(sofar, st_mult(insz, 2), 32);
504                         out = xrealloc(out, outalloc);
505                         outpos = out + sofar;
506                         outsz = outalloc - sofar - 1;
507                 }
508                 else {
509                         *outpos = '\0';
510                         if (outsz_p)
511                                 *outsz_p = outpos - out;
512                         break;
513                 }
514         }
515         return out;
516 }
517
518 static const char *fallback_encoding(const char *name)
519 {
520         /*
521          * Some platforms do not have the variously spelled variants of
522          * UTF-8, so let's fall back to trying the most official
523          * spelling. We do so only as a fallback in case the platform
524          * does understand the user's spelling, but not our official
525          * one.
526          */
527         if (is_encoding_utf8(name))
528                 return "UTF-8";
529
530         /*
531          * Even though latin-1 is still seen in e-mail
532          * headers, some platforms only install ISO-8859-1.
533          */
534         if (!strcasecmp(name, "latin-1"))
535                 return "ISO-8859-1";
536
537         return name;
538 }
539
540 char *reencode_string_len(const char *in, size_t insz,
541                           const char *out_encoding, const char *in_encoding,
542                           size_t *outsz)
543 {
544         iconv_t conv;
545         char *out;
546         const char *bom_str = NULL;
547         size_t bom_len = 0;
548
549         if (!in_encoding)
550                 return NULL;
551
552         /* UTF-16LE-BOM is the same as UTF-16 for reading */
553         if (same_utf_encoding("UTF-16LE-BOM", in_encoding))
554                 in_encoding = "UTF-16";
555
556         /*
557          * For writing, UTF-16 iconv typically creates "UTF-16BE-BOM"
558          * Some users under Windows want the little endian version
559          *
560          * We handle UTF-16 and UTF-32 ourselves only if the platform does not
561          * provide a BOM (which we require), since we want to match the behavior
562          * of the system tools and libc as much as possible.
563          */
564         if (same_utf_encoding("UTF-16LE-BOM", out_encoding)) {
565                 bom_str = utf16_le_bom;
566                 bom_len = sizeof(utf16_le_bom);
567                 out_encoding = "UTF-16LE";
568         } else if (same_utf_encoding("UTF-16BE-BOM", out_encoding)) {
569                 bom_str = utf16_be_bom;
570                 bom_len = sizeof(utf16_be_bom);
571                 out_encoding = "UTF-16BE";
572 #ifdef ICONV_OMITS_BOM
573         } else if (same_utf_encoding("UTF-16", out_encoding)) {
574                 bom_str = utf16_be_bom;
575                 bom_len = sizeof(utf16_be_bom);
576                 out_encoding = "UTF-16BE";
577         } else if (same_utf_encoding("UTF-32", out_encoding)) {
578                 bom_str = utf32_be_bom;
579                 bom_len = sizeof(utf32_be_bom);
580                 out_encoding = "UTF-32BE";
581 #endif
582         }
583
584         conv = iconv_open(out_encoding, in_encoding);
585         if (conv == (iconv_t) -1) {
586                 in_encoding = fallback_encoding(in_encoding);
587                 out_encoding = fallback_encoding(out_encoding);
588
589                 conv = iconv_open(out_encoding, in_encoding);
590                 if (conv == (iconv_t) -1)
591                         return NULL;
592         }
593         out = reencode_string_iconv(in, insz, conv, bom_len, outsz);
594         iconv_close(conv);
595         if (out && bom_str && bom_len)
596                 memcpy(out, bom_str, bom_len);
597         return out;
598 }
599 #endif
600
601 static int has_bom_prefix(const char *data, size_t len,
602                           const char *bom, size_t bom_len)
603 {
604         return data && bom && (len >= bom_len) && !memcmp(data, bom, bom_len);
605 }
606
607 int has_prohibited_utf_bom(const char *enc, const char *data, size_t len)
608 {
609         return (
610           (same_utf_encoding("UTF-16BE", enc) ||
611            same_utf_encoding("UTF-16LE", enc)) &&
612           (has_bom_prefix(data, len, utf16_be_bom, sizeof(utf16_be_bom)) ||
613            has_bom_prefix(data, len, utf16_le_bom, sizeof(utf16_le_bom)))
614         ) || (
615           (same_utf_encoding("UTF-32BE",  enc) ||
616            same_utf_encoding("UTF-32LE", enc)) &&
617           (has_bom_prefix(data, len, utf32_be_bom, sizeof(utf32_be_bom)) ||
618            has_bom_prefix(data, len, utf32_le_bom, sizeof(utf32_le_bom)))
619         );
620 }
621
622 int is_missing_required_utf_bom(const char *enc, const char *data, size_t len)
623 {
624         return (
625            (same_utf_encoding(enc, "UTF-16")) &&
626            !(has_bom_prefix(data, len, utf16_be_bom, sizeof(utf16_be_bom)) ||
627              has_bom_prefix(data, len, utf16_le_bom, sizeof(utf16_le_bom)))
628         ) || (
629            (same_utf_encoding(enc, "UTF-32")) &&
630            !(has_bom_prefix(data, len, utf32_be_bom, sizeof(utf32_be_bom)) ||
631              has_bom_prefix(data, len, utf32_le_bom, sizeof(utf32_le_bom)))
632         );
633 }
634
635 /*
636  * Returns first character length in bytes for multi-byte `text` according to
637  * `encoding`.
638  *
639  * - The `text` pointer is updated to point at the next character.
640  * - When `remainder_p` is not NULL, on entry `*remainder_p` is how much bytes
641  *   we can consume from text, and on exit `*remainder_p` is reduced by returned
642  *   character length. Otherwise `text` is treated as limited by NUL.
643  */
644 int mbs_chrlen(const char **text, size_t *remainder_p, const char *encoding)
645 {
646         int chrlen;
647         const char *p = *text;
648         size_t r = (remainder_p ? *remainder_p : SIZE_MAX);
649
650         if (r < 1)
651                 return 0;
652
653         if (is_encoding_utf8(encoding)) {
654                 pick_one_utf8_char(&p, &r);
655
656                 chrlen = p ? (p - *text)
657                            : 1 /* not valid UTF-8 -> raw byte sequence */;
658         }
659         else {
660                 /*
661                  * TODO use iconv to decode one char and obtain its chrlen
662                  * for now, let's treat encodings != UTF-8 as one-byte
663                  */
664                 chrlen = 1;
665         }
666
667         *text += chrlen;
668         if (remainder_p)
669                 *remainder_p -= chrlen;
670
671         return chrlen;
672 }
673
674 /*
675  * Pick the next char from the stream, ignoring codepoints an HFS+ would.
676  * Note that this is _not_ complete by any means. It's just enough
677  * to make is_hfs_dotgit() work, and should not be used otherwise.
678  */
679 static ucs_char_t next_hfs_char(const char **in)
680 {
681         while (1) {
682                 ucs_char_t out = pick_one_utf8_char(in, NULL);
683                 /*
684                  * check for malformed utf8. Technically this
685                  * gets converted to a percent-sequence, but
686                  * returning 0 is good enough for is_hfs_dotgit
687                  * to realize it cannot be .git
688                  */
689                 if (!*in)
690                         return 0;
691
692                 /* these code points are ignored completely */
693                 switch (out) {
694                 case 0x200c: /* ZERO WIDTH NON-JOINER */
695                 case 0x200d: /* ZERO WIDTH JOINER */
696                 case 0x200e: /* LEFT-TO-RIGHT MARK */
697                 case 0x200f: /* RIGHT-TO-LEFT MARK */
698                 case 0x202a: /* LEFT-TO-RIGHT EMBEDDING */
699                 case 0x202b: /* RIGHT-TO-LEFT EMBEDDING */
700                 case 0x202c: /* POP DIRECTIONAL FORMATTING */
701                 case 0x202d: /* LEFT-TO-RIGHT OVERRIDE */
702                 case 0x202e: /* RIGHT-TO-LEFT OVERRIDE */
703                 case 0x206a: /* INHIBIT SYMMETRIC SWAPPING */
704                 case 0x206b: /* ACTIVATE SYMMETRIC SWAPPING */
705                 case 0x206c: /* INHIBIT ARABIC FORM SHAPING */
706                 case 0x206d: /* ACTIVATE ARABIC FORM SHAPING */
707                 case 0x206e: /* NATIONAL DIGIT SHAPES */
708                 case 0x206f: /* NOMINAL DIGIT SHAPES */
709                 case 0xfeff: /* ZERO WIDTH NO-BREAK SPACE */
710                         continue;
711                 }
712
713                 return out;
714         }
715 }
716
717 static int is_hfs_dot_generic(const char *path,
718                               const char *needle, size_t needle_len)
719 {
720         ucs_char_t c;
721
722         c = next_hfs_char(&path);
723         if (c != '.')
724                 return 0;
725
726         /*
727          * there's a great deal of other case-folding that occurs
728          * in HFS+, but this is enough to catch our fairly vanilla
729          * hard-coded needles.
730          */
731         for (; needle_len > 0; needle++, needle_len--) {
732                 c = next_hfs_char(&path);
733
734                 /*
735                  * We know our needles contain only ASCII, so we clamp here to
736                  * make the results of tolower() sane.
737                  */
738                 if (c > 127)
739                         return 0;
740                 if (tolower(c) != *needle)
741                         return 0;
742         }
743
744         c = next_hfs_char(&path);
745         if (c && !is_dir_sep(c))
746                 return 0;
747
748         return 1;
749 }
750
751 /*
752  * Inline wrapper to make sure the compiler resolves strlen() on literals at
753  * compile time.
754  */
755 static inline int is_hfs_dot_str(const char *path, const char *needle)
756 {
757         return is_hfs_dot_generic(path, needle, strlen(needle));
758 }
759
760 int is_hfs_dotgit(const char *path)
761 {
762         return is_hfs_dot_str(path, "git");
763 }
764
765 int is_hfs_dotgitmodules(const char *path)
766 {
767         return is_hfs_dot_str(path, "gitmodules");
768 }
769
770 int is_hfs_dotgitignore(const char *path)
771 {
772         return is_hfs_dot_str(path, "gitignore");
773 }
774
775 int is_hfs_dotgitattributes(const char *path)
776 {
777         return is_hfs_dot_str(path, "gitattributes");
778 }
779
780 const char utf8_bom[] = "\357\273\277";
781
782 int skip_utf8_bom(char **text, size_t len)
783 {
784         if (len < strlen(utf8_bom) ||
785             memcmp(*text, utf8_bom, strlen(utf8_bom)))
786                 return 0;
787         *text += strlen(utf8_bom);
788         return 1;
789 }
790
791 void strbuf_utf8_align(struct strbuf *buf, align_type position, unsigned int width,
792                        const char *s)
793 {
794         int slen = strlen(s);
795         int display_len = utf8_strnwidth(s, slen, 0);
796         int utf8_compensation = slen - display_len;
797
798         if (display_len >= width) {
799                 strbuf_addstr(buf, s);
800                 return;
801         }
802
803         if (position == ALIGN_LEFT)
804                 strbuf_addf(buf, "%-*s", width + utf8_compensation, s);
805         else if (position == ALIGN_MIDDLE) {
806                 int left = (width - display_len) / 2;
807                 strbuf_addf(buf, "%*s%-*s", left, "", width - left + utf8_compensation, s);
808         } else if (position == ALIGN_RIGHT)
809                 strbuf_addf(buf, "%*s", width + utf8_compensation, s);
810 }