0740b574c1a5ab3e369306a0b39704814653b709
[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 #include "BLI_compiler_attrs.h"
35
36 char        *BLI_strncpy_utf8(char *__restrict dst, const char *__restrict src, size_t maxncpy) ATTR_NONNULL();
37 size_t       BLI_strncpy_utf8_rlen(char *__restrict dst, const char *__restrict src, size_t maxncpy) ATTR_NONNULL();
38 char        *BLI_strncat_utf8(char *__restrict dst, const char *__restrict src, size_t maxncpy) ATTR_NONNULL();
39 int          BLI_utf8_invalid_byte(const char *str, int length) ATTR_NONNULL();
40 int          BLI_utf8_invalid_strip(char *str, int length) ATTR_NONNULL();
41
42 int          BLI_str_utf8_size(const char *p) ATTR_NONNULL(); /* warning, can return -1 on bad chars */
43 int          BLI_str_utf8_size_safe(const char *p) ATTR_NONNULL();
44 /* copied from glib */
45 unsigned int BLI_str_utf8_as_unicode(const char *p) ATTR_NONNULL();
46 unsigned int BLI_str_utf8_as_unicode_and_size(const char *__restrict p, size_t *__restrict index) ATTR_NONNULL();
47 unsigned int BLI_str_utf8_as_unicode_and_size_safe(const char *__restrict p, size_t *__restrict index) ATTR_NONNULL();
48 unsigned int BLI_str_utf8_as_unicode_step(const char *__restrict p, size_t *__restrict index) ATTR_NONNULL();
49 size_t       BLI_str_utf8_from_unicode(unsigned int c, char *outbuf);
50
51 char        *BLI_str_find_prev_char_utf8(const char *str, const char *p) ATTR_NONNULL();
52 char        *BLI_str_find_next_char_utf8(const char *p, const char *end) ATTR_NONNULL(1);
53 char        *BLI_str_prev_char_utf8(const char *p)  ATTR_NONNULL();
54
55 /* wchar_t functions, copied from blenders own font.c originally */
56 size_t       BLI_wstrlen_utf8(const wchar_t *src)  ATTR_NONNULL();
57 size_t       BLI_strlen_utf8_ex(const char *strc, size_t *r_len_bytes) ATTR_NONNULL();
58 size_t       BLI_strlen_utf8(const char *strc)  ATTR_NONNULL();
59 size_t       BLI_strnlen_utf8_ex(const char *strc, const size_t maxlen, size_t *r_len_bytes) ATTR_NONNULL();
60 size_t       BLI_strnlen_utf8(const char *strc, const size_t maxlen)  ATTR_NONNULL();
61 size_t       BLI_strncpy_wchar_as_utf8(char *__restrict dst, const wchar_t *__restrict src, const size_t maxcpy) ATTR_NONNULL();
62 size_t       BLI_strncpy_wchar_from_utf8(wchar_t *__restrict dst, const char *__restrict src, const size_t maxcpy) ATTR_NONNULL();
63
64 /* count columns that character/string occupies, based on wcwidth.c */
65 int          BLI_wcwidth(wchar_t ucs);
66 int          BLI_wcswidth(const wchar_t *pwcs, size_t n) ATTR_NONNULL();
67 int          BLI_str_utf8_char_width(const char *p) ATTR_NONNULL(); /* warning, can return -1 on bad chars */
68 int          BLI_str_utf8_char_width_safe(const char *p) ATTR_NONNULL();
69
70 size_t       BLI_str_partition_utf8(const char *str, const unsigned int delim[], const char **sep, const char **suf) ATTR_NONNULL();
71 size_t       BLI_str_rpartition_utf8(const char *str, const unsigned int delim[], const char **sep, const char **suf) ATTR_NONNULL();
72 size_t       BLI_str_partition_ex_utf8(
73         const char *str, const char *end, const unsigned int delim[], const char **sep, const char **suf, const bool from_right)
74         ATTR_NONNULL(1, 3, 4, 5);
75
76 #define      BLI_UTF8_MAX 6        /* mem */
77 #define      BLI_UTF8_WIDTH_MAX 2  /* columns */
78 #define      BLI_UTF8_ERR ((unsigned int)-1)
79
80 #ifdef __cplusplus
81 }
82 #endif
83
84 #endif