Cycles / HSV Separator and Combine node:
[blender.git] / source / blender / blenlib / BLI_string_utf8.h
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  * Contributor(s): none yet.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 #ifndef __BLI_STRING_UTF8_H__
24 #define __BLI_STRING_UTF8_H__
25
26 /** \file BLI_string_utf8.h
27  *  \ingroup bli
28  */
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #ifdef __GNUC__
35 #  define ATTR_NONULL __attribute__((nonnull))
36 #  define ATTR_NONULL_FIRST  __attribute__((nonnull(1)))
37 #  define ATTR_UNUSED_RESULT __attribute__((warn_unused_result))
38 #else
39 #  define ATTR_NONULL
40 #  define ATTR_NONULL_FIRST
41 #  define ATTR_UNUSED_RESULT
42 #endif
43
44 char        *BLI_strncpy_utf8(char *__restrict dst, const char *__restrict src, size_t maxncpy)  ATTR_NONULL;
45 char        *BLI_strncat_utf8(char *__restrict dst, const char *__restrict src, size_t maxncpy)  ATTR_NONULL;
46 int          BLI_utf8_invalid_byte(const char *str, int length)  ATTR_NONULL;
47 int          BLI_utf8_invalid_strip(char *str, int length)  ATTR_NONULL;
48
49 int          BLI_str_utf8_size(const char *p)  ATTR_NONULL; /* warning, can return -1 on bad chars */
50 int          BLI_str_utf8_size_safe(const char *p)  ATTR_NONULL;
51 /* copied from glib */
52 unsigned int BLI_str_utf8_as_unicode(const char *p)  ATTR_NONULL;
53 unsigned int BLI_str_utf8_as_unicode_and_size(const char *__restrict p, size_t *__restrict index)  ATTR_NONULL;
54 unsigned int BLI_str_utf8_as_unicode_and_size_safe(const char *__restrict p, size_t *__restrict index)  ATTR_NONULL;
55 unsigned int BLI_str_utf8_as_unicode_step(const char *__restrict p, size_t *__restrict index)  ATTR_NONULL;
56 size_t       BLI_str_utf8_from_unicode(unsigned int c, char *outbuf);
57
58 char        *BLI_str_find_prev_char_utf8(const char *str, const char *p)  ATTR_NONULL;
59 char        *BLI_str_find_next_char_utf8(const char *p, const char *end)  ATTR_NONULL_FIRST;
60 char        *BLI_str_prev_char_utf8(const char *p)  ATTR_NONULL;
61
62 /* wchar_t functions, copied from blenders own font.c originally */
63 size_t       BLI_wstrlen_utf8(const wchar_t *src)  ATTR_NONULL;
64 size_t       BLI_strlen_utf8_ex(const char *strc, size_t *r_len_bytes)  ATTR_NONULL;
65 size_t       BLI_strlen_utf8(const char *strc)  ATTR_NONULL;
66 size_t       BLI_strnlen_utf8_ex(const char *strc, const size_t maxlen, size_t *r_len_bytes)  ATTR_NONULL;
67 size_t       BLI_strnlen_utf8(const char *strc, const size_t maxlen)  ATTR_NONULL;
68 size_t       BLI_strncpy_wchar_as_utf8(char *__restrict dst, const wchar_t *__restrict src, const size_t maxcpy)  ATTR_NONULL;
69 size_t       BLI_strncpy_wchar_from_utf8(wchar_t *__restrict dst, const char *__restrict src, const size_t maxcpy)  ATTR_NONULL;
70
71 /* count columns that character/string occupies, based on wcwidth.c */
72 int          BLI_wcwidth(wchar_t ucs);
73 int          BLI_wcswidth(const wchar_t *pwcs, size_t n)  ATTR_NONULL;
74 int          BLI_str_utf8_char_width(const char *p)  ATTR_NONULL; /* warning, can return -1 on bad chars */
75 int          BLI_str_utf8_char_width_safe(const char *p)  ATTR_NONULL;
76
77 #define      BLI_UTF8_MAX 6        /* mem */
78 #define      BLI_UTF8_WIDTH_MAX 2  /* columns */
79 #define      BLI_UTF8_ERR ((unsigned int)-1)
80
81 #undef ATTR_NONULL
82 #undef ATTR_NONULL_FIRST
83 #undef ATTR_UNUSED_RESULT
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif