style cleanup
[blender.git] / source / blender / blenlib / intern / string_utf8.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2011 Blender Foundation.
19  * Code from gutf8.c Copyright (C) 1999 Tom Tromey
20  *                   Copyright (C) 2000 Red Hat, Inc.
21  * All rights reserved.
22  *
23  * Contributor(s): Campbell Barton.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  *
27  */
28
29  /** \file blender/blenlib/intern/string_utf8.c
30   *  \ingroup bli
31   */
32
33 #include <string.h>
34 #include <wchar.h>
35 #include <wctype.h>
36
37 #include "BLI_string_utf8.h"
38
39 /* from libswish3, originally called u8_isvalid(),
40  * modified to return the index of the bad character (byte index not utf).
41  * http://svn.swish-e.org/libswish3/trunk/src/libswish3/utf8.c r3044 - campbell */
42
43 /* based on the valid_utf8 routine from the PCRE library by Philip Hazel
44  *
45  * length is in bytes, since without knowing whether the string is valid
46  * it's hard to know how many characters there are! */
47
48 static const char trailingBytesForUTF8[256] = {
49         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
50         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
51         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
52         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
53         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
54         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
55         1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
56         2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5
57 };
58
59 int BLI_utf8_invalid_byte(const char *str, int length)
60 {
61         const unsigned char *p, *pend = (unsigned char *)str + length;
62         unsigned char c;
63         int ab;
64
65         for (p = (unsigned char *)str; p < pend; p++) {
66                 c = *p;
67                 if (c < 128)
68                         continue;
69                 if ((c & 0xc0) != 0xc0)
70                         goto utf8_error;
71                 ab = trailingBytesForUTF8[c];
72                 if (length < ab)
73                         goto utf8_error;
74                 length -= ab;
75
76                 p++;
77                 /* Check top bits in the second byte */
78                 if ((*p & 0xc0) != 0x80)
79                         goto utf8_error;
80
81                 /* Check for overlong sequences for each different length */
82                 switch (ab) {
83                         /* Check for xx00 000x */
84                 case 1:
85                         if ((c & 0x3e) == 0) goto utf8_error;
86                         continue;   /* We know there aren't any more bytes to check */
87
88                         /* Check for 1110 0000, xx0x xxxx */
89                 case 2:
90                         if (c == 0xe0 && (*p & 0x20) == 0) goto utf8_error;
91                         break;
92
93                         /* Check for 1111 0000, xx00 xxxx */
94                 case 3:
95                         if (c == 0xf0 && (*p & 0x30) == 0) goto utf8_error;
96                         break;
97
98                         /* Check for 1111 1000, xx00 0xxx */
99                 case 4:
100                         if (c == 0xf8 && (*p & 0x38) == 0) goto utf8_error;
101                         break;
102
103                         /* Check for leading 0xfe or 0xff,
104                          * and then for 1111 1100, xx00 00xx */
105                 case 5:
106                         if (c == 0xfe || c == 0xff ||
107                                 (c == 0xfc && (*p & 0x3c) == 0)) goto utf8_error;
108                         break;
109                 }
110
111                 /* Check for valid bytes after the 2nd, if any; all must start 10 */
112                 while (--ab > 0) {
113                         if ((*(p+1) & 0xc0) != 0x80) goto utf8_error;
114                         p++; /* do this after so we get usable offset - campbell */
115                 }
116         }
117
118         return -1;
119
120 utf8_error:
121
122         return (int)((char *)p - (char *)str) - 1;
123 }
124
125 int BLI_utf8_invalid_strip(char *str, int length)
126 {
127         int bad_char, tot = 0;
128
129         while ((bad_char = BLI_utf8_invalid_byte(str, length)) != -1) {
130                 str += bad_char;
131                 length -= bad_char;
132
133                 if (length == 0) {
134                         /* last character bad, strip it */
135                         *str = '\0';
136                         tot++;
137                         break;
138                 }
139                 else {
140                         /* strip, keep looking */
141                         memmove(str, str + 1, length);
142                         tot++;
143                 }
144         }
145
146         return tot;
147 }
148
149
150 /* compatible with BLI_strncpy, but esnure no partial utf8 chars */
151
152 /* array copied from glib's gutf8.c,
153  * note: this looks to be at odd's with 'trailingBytesForUTF8',
154  * need to find out what gives here! - campbell */
155 static const size_t utf8_skip_data[256] = {
156     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
157     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
158     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
159     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
160     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
161     1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
162     2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
163     3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 1, 1
164 };
165
166 #define BLI_STR_UTF8_CPY(dst, src, maxncpy)                                   \
167         {                                                                         \
168                 size_t utf8_size;                                                     \
169                 while (*src != '\0' && (utf8_size = utf8_skip_data[*src]) < maxncpy) {\
170                         maxncpy -= utf8_size;                                             \
171                         switch (utf8_size) {                                              \
172                                 case 6: *dst ++ = *src ++;                                    \
173                                 case 5: *dst ++ = *src ++;                                    \
174                                 case 4: *dst ++ = *src ++;                                    \
175                                 case 3: *dst ++ = *src ++;                                    \
176                                 case 2: *dst ++ = *src ++;                                    \
177                                 case 1: *dst ++ = *src ++;                                    \
178                         }                                                                 \
179                 }                                                                     \
180                 *dst = '\0';                                                          \
181         } (void)0
182
183 char *BLI_strncpy_utf8(char *dst, const char *src, size_t maxncpy)
184 {
185         char *dst_r = dst;
186
187         /* note: currently we don't attempt to deal with invalid utf8 chars */
188         BLI_STR_UTF8_CPY(dst, src, maxncpy);
189
190         return dst_r;
191 }
192
193 char *BLI_strncat_utf8(char *dst, const char *src, size_t maxncpy)
194 {
195         while (*dst && maxncpy > 0) {
196                 dst++;
197                 maxncpy--;
198         }
199
200         BLI_STR_UTF8_CPY(dst, src, maxncpy);
201
202         return dst;
203 }
204
205 #undef BLI_STR_UTF8_CPY
206
207 /* --------------------------------------------------------------------------*/
208 /* wchar_t / utf8 functions  */
209
210 size_t BLI_strncpy_wchar_as_utf8(char *dst, const wchar_t *src, const size_t maxcpy)
211 {
212         size_t len = 0;
213         while (*src && len < maxcpy) { /* XXX can still run over the buffer because utf8 size isn't known :| */
214                 len += BLI_str_utf8_from_unicode(*src++, dst + len);
215         }
216
217         dst[len] = '\0';
218
219         return len;
220 }
221
222 /* wchar len in utf8 */
223 size_t BLI_wstrlen_utf8(const wchar_t *src)
224 {
225         size_t len = 0;
226
227         while (*src) {
228                 len += BLI_str_utf8_from_unicode(*src++, NULL);
229         }
230
231         return len;
232 }
233
234 /* this is very close to 'BLI_str_utf8_size' functionality, perhaps we should de-duplicate */
235 /* size of UTF-8 character in bytes */
236 static size_t strlen_utf8_char(const char *strc)
237 {
238         if ((*strc & 0xe0) == 0xc0) {
239                 if ((strc[1] & 0x80) && (strc[1] & 0x40) == 0x00)
240                         return 2;
241         }
242         else if ((*strc & 0xf0) == 0xe0) {
243                 if ((strc[1] & strc[2] & 0x80) && ((strc[1] | strc[2]) & 0x40) == 0x00)
244                         return 3;
245         }
246         else if ((*strc & 0xf8) == 0xf0) {
247                 if ((strc[1] & strc[2] & strc[3] & 0x80) && ((strc[1] | strc[2] | strc[3]) & 0x40) == 0x00)
248                         return 4;
249         }
250
251         return 1;
252 }
253
254 size_t BLI_strlen_utf8(const char *strc)
255 {
256         int len;
257
258         for (len = 0; *strc; len++)
259                 strc += strlen_utf8_char(strc);
260
261         return len;
262 }
263
264 size_t BLI_strlen_range_utf8(const char *start, const char *end)
265 {
266         const char *strc = start;
267         int len;
268
269         for (len = 0; strc < end; len++)
270                 strc += strlen_utf8_char(strc);
271
272         return len;
273 }
274
275 size_t BLI_strncpy_wchar_from_utf8(wchar_t *dst_w, const char *src_c, const size_t maxcpy)
276 {
277         int len = 0;
278
279         if (dst_w == NULL || src_c == NULL) {
280                 return 0;
281         }
282
283         while (*src_c && len < maxcpy) {
284                 size_t step = 0;
285                 unsigned int unicode = BLI_str_utf8_as_unicode_and_size(src_c, &step);
286                 if (unicode != BLI_UTF8_ERR) {
287                         *dst_w = (wchar_t)unicode;
288                         src_c += step;
289                 }
290                 else {
291                         *dst_w = '?';
292                         src_c = BLI_str_find_next_char_utf8(src_c, NULL);
293                 }
294                 dst_w++;
295                 len++;
296         }
297         return len;
298 }
299
300 /* end wchar_t / utf8 functions  */
301 /* --------------------------------------------------------------------------*/
302
303 /* copied from glib's gutf8.c */
304
305 /* note, glib uses unsigned int for unicode, best we do the same,
306  * though we don't typedef it - campbell */
307
308 #define UTF8_COMPUTE(Char, Mask, Len)                                         \
309         if (Char < 128) {                                                         \
310                 Len = 1;                                                              \
311                 Mask = 0x7f;                                                          \
312         }                                                                         \
313         else if ((Char & 0xe0) == 0xc0) {                                         \
314                 Len = 2;                                                              \
315                 Mask = 0x1f;                                                          \
316         }                                                                         \
317         else if ((Char & 0xf0) == 0xe0) {                                         \
318                 Len = 3;                                                              \
319                 Mask = 0x0f;                                                          \
320         }                                                                         \
321         else if ((Char & 0xf8) == 0xf0) {                                         \
322                 Len = 4;                                                              \
323                 Mask = 0x07;                                                          \
324         }                                                                         \
325         else if ((Char & 0xfc) == 0xf8) {                                         \
326                 Len = 5;                                                              \
327                 Mask = 0x03;                                                          \
328         }                                                                         \
329         else if ((Char & 0xfe) == 0xfc) {                                         \
330                 Len = 6;                                                              \
331                 Mask = 0x01;                                                          \
332         }                                                                         \
333         else {                                                                    \
334                 Len = -1;                                                             \
335         } (void)0
336
337 /* same as glib define but added an 'Err' arg */
338 #define UTF8_GET(Result, Chars, Count, Mask, Len, Err)                        \
339         (Result) = (Chars)[0] & (Mask);                                           \
340         for ((Count) = 1; (Count) < (Len); ++(Count)) {                           \
341                 if (((Chars)[(Count)] & 0xc0) != 0x80) {                              \
342                         (Result) = Err;                                                   \
343                         break;                                                            \
344                 }                                                                     \
345                 (Result) <<= 6;                                                       \
346                 (Result) |= ((Chars)[(Count)] & 0x3f);                                \
347         } (void)0
348
349
350 /* uses glib functions but not from glib */
351 /* gets the size of a single utf8 char */
352 int BLI_str_utf8_size(const char *p)
353 {
354         int mask = 0, len;
355         unsigned char c = (unsigned char) *p;
356
357         UTF8_COMPUTE (c, mask, len);
358
359         (void)mask; /* quiet warning */
360
361         return len;
362 }
363
364 /* was g_utf8_get_char */
365 /**
366  * BLI_str_utf8_as_unicode:
367  * @p a pointer to Unicode character encoded as UTF-8
368  *
369  * Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
370  * If @p does not point to a valid UTF-8 encoded character, results are
371  * undefined. If you are not sure that the bytes are complete
372  * valid Unicode characters, you should use g_utf8_get_char_validated()
373  * instead.
374  *
375  * Return value: the resulting character
376  **/
377 unsigned int BLI_str_utf8_as_unicode(const char *p)
378 {
379         int i, mask = 0, len;
380         unsigned int result;
381         unsigned char c = (unsigned char) *p;
382
383         UTF8_COMPUTE (c, mask, len);
384         if (len == -1)
385                 return BLI_UTF8_ERR;
386         UTF8_GET (result, p, i, mask, len, BLI_UTF8_ERR);
387
388         return result;
389 }
390
391 /* variant that increments the length */
392 unsigned int BLI_str_utf8_as_unicode_and_size(const char *p, size_t *index)
393 {
394         int i, mask = 0, len;
395         unsigned int result;
396         unsigned char c = (unsigned char) *p;
397
398         UTF8_COMPUTE (c, mask, len);
399         if (len == -1)
400                 return BLI_UTF8_ERR;
401         UTF8_GET (result, p, i, mask, len, BLI_UTF8_ERR);
402         *index += len;
403         return result;
404 }
405
406 /* another variant that steps over the index,
407  * note, currently this also falls back to latin1 for text drawing. */
408 unsigned int BLI_str_utf8_as_unicode_step(const char *p, size_t *index)
409 {
410         int i, mask = 0, len;
411         unsigned int result;
412         unsigned char c;
413
414         p += *index;
415         c = (unsigned char) *p;
416
417         UTF8_COMPUTE (c, mask, len);
418         if (len == -1) {
419                 /* when called with NULL end, result will never be NULL,
420                  * checks for a NULL character */
421                 char *p_next = BLI_str_find_next_char_utf8(p, NULL);
422                 /* will never return the same pointer unless '\0',
423                  * eternal loop is prevented */
424                 *index += (size_t)(p_next - p);
425                 return BLI_UTF8_ERR;
426         }
427
428         /* this is tricky since there are a few ways we can bail out of bad unicode
429          * values, 3 possible solutions. */
430 #if 0
431         UTF8_GET (result, p, i, mask, len, BLI_UTF8_ERR);
432 #elif 1
433         /* WARNING: this is NOT part of glib, or supported by similar functions.
434          * this is added for text drawing because some filepaths can have latin1
435          * characters */
436         UTF8_GET (result, p, i, mask, len, BLI_UTF8_ERR);
437         if (result == BLI_UTF8_ERR) {
438                 len = 1;
439                 result = *p;
440         }
441         /* end warning! */
442 #else
443         /* without a fallback like '?', text drawing will stop on this value */
444         UTF8_GET (result, p, i, mask, len, '?');
445 #endif
446
447         *index += len;
448         return result;
449 }
450
451 /* was g_unichar_to_utf8 */
452 /**
453  * BLI_str_utf8_from_unicode:
454  * @c a Unicode character code
455  * \param outbuf output buffer, must have at least 6 bytes of space.
456  *       If %NULL, the length will be computed and returned
457  *       and nothing will be written to outbuf.
458  *
459  * Converts a single character to UTF-8.
460  *
461  * Return value: number of bytes written
462  **/
463 size_t BLI_str_utf8_from_unicode(unsigned int c, char *outbuf)
464 {
465         /* If this gets modified, also update the copy in g_string_insert_unichar() */
466         unsigned int len = 0;
467         int first;
468         int i;
469
470         if (c < 0x80) {
471                 first = 0;
472                 len = 1;
473         }
474         else if (c < 0x800) {
475                 first = 0xc0;
476                 len = 2;
477         }
478         else if (c < 0x10000) {
479                 first = 0xe0;
480                 len = 3;
481         }
482         else if (c < 0x200000) {
483                 first = 0xf0;
484                 len = 4;
485         }
486         else if (c < 0x4000000) {
487                 first = 0xf8;
488                 len = 5;
489         }
490         else {
491                 first = 0xfc;
492                 len = 6;
493         }
494
495         if (outbuf) {
496                 for (i = len - 1; i > 0; --i) {
497                         outbuf[i] = (c & 0x3f) | 0x80;
498                         c >>= 6;
499                 }
500                 outbuf[0] = c | first;
501         }
502
503         return len;
504 }
505
506 /* was g_utf8_find_prev_char */
507 /**
508  * BLI_str_find_prev_char_utf8:
509  * @str: pointer to the beginning of a UTF-8 encoded string
510  * @p pointer to some position within @str
511  *
512  * Given a position @p with a UTF-8 encoded string @str, find the start
513  * of the previous UTF-8 character starting before. @p Returns %NULL if no
514  * UTF-8 characters are present in @str before @p
515  *
516  * @p does not have to be at the beginning of a UTF-8 character. No check
517  * is made to see if the character found is actually valid other than
518  * it starts with an appropriate byte.
519  *
520  * Return value: a pointer to the found character or %NULL.
521  **/
522 char * BLI_str_find_prev_char_utf8(const char *str, const char *p)
523 {
524         for (--p; p >= str; --p) {
525                 if ((*p & 0xc0) != 0x80) {
526                         return (char *)p;
527                 }
528         }
529         return NULL;
530 }
531
532 /* was g_utf8_find_next_char */
533 /**
534  * BLI_str_find_next_char_utf8:
535  * @p a pointer to a position within a UTF-8 encoded string
536  * @end a pointer to the byte following the end of the string,
537  * or %NULL to indicate that the string is nul-terminated.
538  *
539  * Finds the start of the next UTF-8 character in the string after @p
540  *
541  * @p does not have to be at the beginning of a UTF-8 character. No check
542  * is made to see if the character found is actually valid other than
543  * it starts with an appropriate byte.
544  *
545  * Return value: a pointer to the found character or %NULL
546  **/
547 char *BLI_str_find_next_char_utf8(const char *p, const char *end)
548 {
549         if (*p) {
550                 if (end) {
551                         for (++p; p < end && (*p & 0xc0) == 0x80; ++p) {
552                                 /* do nothing */
553                         }
554                 }
555                 else {
556                         for (++p; (*p & 0xc0) == 0x80; ++p) {
557                                 /* do nothing */
558                         }
559                 }
560         }
561         return (p == end) ? NULL : (char *)p;
562 }
563
564 /* was g_utf8_prev_char */
565 /**
566  * BLI_str_prev_char_utf8:
567  * @p a pointer to a position within a UTF-8 encoded string
568  *
569  * Finds the previous UTF-8 character in the string before @p
570  *
571  * @p does not have to be at the beginning of a UTF-8 character. No check
572  * is made to see if the character found is actually valid other than
573  * it starts with an appropriate byte. If @p might be the first
574  * character of the string, you must use g_utf8_find_prev_char() instead.
575  *
576  * Return value: a pointer to the found character.
577  **/
578 char *BLI_str_prev_char_utf8(const char *p)
579 {
580         while (1) {
581                 p--;
582                 if ((*p & 0xc0) != 0x80) {
583                         return (char *)p;
584                 }
585         }
586 }
587 /* end glib copy */