Python API: assume that a crashed Python operator returned FINISHED.
[blender.git] / source / blender / blenlib / BLI_string_utf8.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BLI_STRING_UTF8_H__
18 #define __BLI_STRING_UTF8_H__
19
20 /** \file
21  * \ingroup bli
22  */
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 #include "BLI_compiler_attrs.h"
29
30 char *BLI_strncpy_utf8(char *__restrict dst, const char *__restrict src, size_t maxncpy)
31     ATTR_NONNULL();
32 size_t BLI_strncpy_utf8_rlen(char *__restrict dst, const char *__restrict src, size_t maxncpy)
33     ATTR_NONNULL();
34 char *BLI_strncat_utf8(char *__restrict dst, const char *__restrict src, size_t maxncpy)
35     ATTR_NONNULL();
36 ptrdiff_t BLI_utf8_invalid_byte(const char *str, size_t length) ATTR_NONNULL();
37 int BLI_utf8_invalid_strip(char *str, size_t length) ATTR_NONNULL();
38
39 /* warning, can return -1 on bad chars */
40 int BLI_str_utf8_size(const char *p) ATTR_NONNULL();
41 int BLI_str_utf8_size_safe(const char *p) ATTR_NONNULL();
42 /* copied from glib */
43 unsigned int BLI_str_utf8_as_unicode(const char *p) ATTR_NONNULL();
44 unsigned int BLI_str_utf8_as_unicode_and_size(const char *__restrict p, size_t *__restrict index)
45     ATTR_NONNULL();
46 unsigned int BLI_str_utf8_as_unicode_and_size_safe(const char *__restrict p,
47                                                    size_t *__restrict index) ATTR_NONNULL();
48 unsigned int BLI_str_utf8_as_unicode_step(const char *__restrict p, size_t *__restrict index)
49     ATTR_NONNULL();
50 size_t BLI_str_utf8_from_unicode(unsigned int c, char *outbuf);
51
52 char *BLI_str_find_prev_char_utf8(const char *str, const char *p) ATTR_NONNULL();
53 char *BLI_str_find_next_char_utf8(const char *p, const char *end) ATTR_NONNULL(1);
54 char *BLI_str_prev_char_utf8(const char *p) ATTR_NONNULL();
55
56 /* wchar_t functions, copied from blenders own font.c originally */
57 size_t BLI_wstrlen_utf8(const wchar_t *src) ATTR_NONNULL();
58 size_t BLI_strlen_utf8_ex(const char *strc, size_t *r_len_bytes) ATTR_NONNULL();
59 size_t BLI_strlen_utf8(const char *strc) ATTR_NONNULL();
60 size_t BLI_strnlen_utf8_ex(const char *strc, const size_t maxlen, size_t *r_len_bytes)
61     ATTR_NONNULL();
62 size_t BLI_strnlen_utf8(const char *strc, const size_t maxlen) ATTR_NONNULL();
63 size_t BLI_strncpy_wchar_as_utf8(char *__restrict dst,
64                                  const wchar_t *__restrict src,
65                                  const size_t maxcpy) ATTR_NONNULL();
66 size_t BLI_strncpy_wchar_from_utf8(wchar_t *__restrict dst,
67                                    const char *__restrict src,
68                                    const size_t maxcpy) ATTR_NONNULL();
69
70 /* count columns that character/string occupies, based on wcwidth.c */
71 int BLI_wcwidth(wchar_t ucs);
72 int BLI_wcswidth(const wchar_t *pwcs, size_t n) ATTR_NONNULL();
73 /* warning, can return -1 on bad chars */
74 int BLI_str_utf8_char_width(const char *p) ATTR_NONNULL();
75 int BLI_str_utf8_char_width_safe(const char *p) ATTR_NONNULL();
76
77 size_t BLI_str_partition_utf8(const char *str,
78                               const unsigned int delim[],
79                               const char **sep,
80                               const char **suf) ATTR_NONNULL();
81 size_t BLI_str_rpartition_utf8(const char *str,
82                                const unsigned int delim[],
83                                const char **sep,
84                                const char **suf) ATTR_NONNULL();
85 size_t BLI_str_partition_ex_utf8(const char *str,
86                                  const char *end,
87                                  const unsigned int delim[],
88                                  const char **sep,
89                                  const char **suf,
90                                  const bool from_right) ATTR_NONNULL(1, 3, 4, 5);
91
92 int BLI_str_utf8_offset_to_index(const char *str, int offset);
93 int BLI_str_utf8_offset_from_index(const char *str, int index);
94 int BLI_str_utf8_offset_to_column(const char *str, int offset);
95 int BLI_str_utf8_offset_from_column(const char *str, int column);
96
97 #define BLI_UTF8_MAX 6       /* mem */
98 #define BLI_UTF8_WIDTH_MAX 2 /* columns */
99 #define BLI_UTF8_ERR ((unsigned int)-1)
100
101 /** \name String Copy/Format Macros
102  * Avoid repeating destination with `sizeof(..)`.
103  * \note `ARRAY_SIZE` allows pointers on some platforms.
104  * \{ */
105 #define STRNCPY_UTF8(dst, src) BLI_strncpy_utf8(dst, src, ARRAY_SIZE(dst))
106 #define STRNCPY_UTF8_RLEN(dst, src) BLI_strncpy_utf8_rlen(dst, src, ARRAY_SIZE(dst))
107 /** \} */
108
109 #ifdef __cplusplus
110 }
111 #endif
112
113 #endif