Code cleanup: remove TRUE/FALSE & WITH_BOOL_COMPAT define
[blender.git] / source / blender / blenlib / intern / string_cursor_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  * All rights reserved.
20  *
21  * Contributor(s): Campbell Barton.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  */
26
27 /** \file blender/blenlib/intern/string_cursor_utf8.c
28  *  \ingroup bli
29  */
30
31 #include <stdio.h>
32 #include <stdlib.h>
33
34 #include "BLI_utildefines.h"
35 #include "BLI_string_utf8.h"
36
37 #include "BLI_string_cursor_utf8.h" /* own include */
38
39 #ifdef __GNUC__
40 #  pragma GCC diagnostic error "-Wsign-conversion"
41 #endif
42
43 typedef enum strCursorDelimType {
44         STRCUR_DELIM_NONE,
45         STRCUR_DELIM_ALPHANUMERIC,
46         STRCUR_DELIM_PUNCT,
47         STRCUR_DELIM_BRACE,
48         STRCUR_DELIM_OPERATOR,
49         STRCUR_DELIM_QUOTE,
50         STRCUR_DELIM_WHITESPACE,
51         STRCUR_DELIM_OTHER
52 } strCursorDelimType;
53
54 static strCursorDelimType cursor_delim_type_unicode(const unsigned int uch)
55 {
56         switch (uch) {
57                 case ',':
58                 case '.':
59                         return STRCUR_DELIM_PUNCT;
60
61                 case '{':
62                 case '}':
63                 case '[':
64                 case ']':
65                 case '(':
66                 case ')':
67                         return STRCUR_DELIM_BRACE;
68
69                 case '+':
70                 case '-':
71                 case '=':
72                 case '~':
73                 case '%':
74                 case '/':
75                 case '<':
76                 case '>':
77                 case '^':
78                 case '*':
79                 case '&':
80                 case '|':
81                         return STRCUR_DELIM_OPERATOR;
82
83                 case '\'':
84                 case '\"':
85                         return STRCUR_DELIM_QUOTE;
86
87                 case ' ':
88                 case '\t':
89                 case '\n':
90                         return STRCUR_DELIM_WHITESPACE;
91
92                 case '\\':
93                 case '@':
94                 case '#':
95                 case '$':
96                 case ':':
97                 case ';':
98                 case '?':
99                 case '!':
100                 case 0xA3:  /* pound */
101                 case 0x80:  /* euro */
102                         /* case '_': *//* special case, for python */
103                         return STRCUR_DELIM_OTHER;
104
105                 default:
106                         break;
107         }
108         return STRCUR_DELIM_ALPHANUMERIC; /* Not quite true, but ok for now */
109 }
110
111 static strCursorDelimType cursor_delim_type_utf8(const char *ch_utf8)
112 {
113         /* for full unicode support we really need to have large lookup tables to figure
114          * out whats what in every possible char set - and python, glib both have these. */
115         unsigned int uch = BLI_str_utf8_as_unicode(ch_utf8);
116         return cursor_delim_type_unicode(uch);
117 }
118
119 bool BLI_str_cursor_step_next_utf8(const char *str, size_t maxlen, int *pos)
120 {
121         const char *str_end = str + (maxlen + 1);
122         const char *str_pos = str + (*pos);
123         const char *str_next = BLI_str_find_next_char_utf8(str_pos, str_end);
124         if (str_next) {
125                 (*pos) += (str_next - str_pos);
126                 if ((*pos) > (int)maxlen) {
127                         (*pos) = (int)maxlen;
128                 }
129                 return true;
130         }
131
132         return false;
133 }
134
135 bool BLI_str_cursor_step_prev_utf8(const char *str, size_t UNUSED(maxlen), int *pos)
136 {
137         if ((*pos) > 0) {
138                 const char *str_pos = str + (*pos);
139                 const char *str_prev = BLI_str_find_prev_char_utf8(str, str_pos);
140                 if (str_prev) {
141                         (*pos) -= (str_pos - str_prev);
142                         return true;
143                 }
144         }
145
146         return false;
147 }
148
149 void BLI_str_cursor_step_utf8(const char *str, size_t maxlen,
150                               int *pos, strCursorJumpDirection direction,
151                               strCursorJumpType jump, bool use_init_step)
152 {
153         const int pos_orig = *pos;
154
155         if (direction == STRCUR_DIR_NEXT) {
156                 if (use_init_step) {
157                         BLI_str_cursor_step_next_utf8(str, maxlen, pos);
158                 }
159                 else {
160                         BLI_assert(jump == STRCUR_JUMP_DELIM);
161                 }
162
163                 if (jump != STRCUR_JUMP_NONE) {
164                         const strCursorDelimType delim_type = (*pos) < maxlen ? cursor_delim_type_utf8(&str[*pos]) : STRCUR_DELIM_NONE;
165                         /* jump between special characters (/,\,_,-, etc.),
166                          * look at function cursor_delim_type() for complete
167                          * list of special character, ctr -> */
168                         while ((*pos) < maxlen) {
169                                 if (BLI_str_cursor_step_next_utf8(str, maxlen, pos)) {
170                                         if ((jump != STRCUR_JUMP_ALL) && (delim_type != cursor_delim_type_utf8(&str[*pos]))) {
171                                                 break;
172                                         }
173                                 }
174                                 else {
175                                         break; /* unlikely but just in case */
176                                 }
177                         }
178                 }
179         }
180         else if (direction == STRCUR_DIR_PREV) {
181                 if (use_init_step) {
182                         BLI_str_cursor_step_prev_utf8(str, maxlen, pos);
183                 }
184                 else {
185                         BLI_assert(jump == STRCUR_JUMP_DELIM);
186                 }
187
188                 if (jump != STRCUR_JUMP_NONE) {
189                         const strCursorDelimType delim_type = (*pos) > 0 ? cursor_delim_type_utf8(&str[(*pos) - 1]) : STRCUR_DELIM_NONE;
190                         /* jump between special characters (/,\,_,-, etc.),
191                          * look at function cursor_delim_type() for complete
192                          * list of special character, ctr -> */
193                         while ((*pos) > 0) {
194                                 const int pos_prev = *pos;
195                                 if (BLI_str_cursor_step_prev_utf8(str, maxlen, pos)) {
196                                         if ((jump != STRCUR_JUMP_ALL) && (delim_type != cursor_delim_type_utf8(&str[*pos]))) {
197                                                 /* left only: compensate for index/change in direction */
198                                                 if ((pos_orig - (*pos)) >= 1) {
199                                                         *pos = pos_prev;
200                                                 }
201                                                 break;
202                                         }
203                                 }
204                                 else {
205                                         break;
206                                 }
207                         }
208                 }
209         }
210         else {
211                 BLI_assert(0);
212         }
213 }
214
215 /* wchar_t version of BLI_str_cursor_step_utf8 (keep in sync!)
216  * less complex since it doesn't need to do multi-byte stepping.
217  */
218
219 /* helper funcs so we can match BLI_str_cursor_step_utf8 */
220 static bool wchar_t_step_next(const wchar_t *UNUSED(str), size_t maxlen, int *pos)
221 {
222         if ((*pos) >= (int)maxlen) {
223                 return false;
224         }
225         (*pos)++;
226         return true;
227 }
228
229 static bool wchar_t_step_prev(const wchar_t *UNUSED(str), size_t UNUSED(maxlen), int *pos)
230 {
231         if ((*pos) <= 0) {
232                 return false;
233         }
234         (*pos)--;
235         return true;
236 }
237
238 void BLI_str_cursor_step_wchar(const wchar_t *str, size_t maxlen,
239                                int *pos, strCursorJumpDirection direction,
240                                strCursorJumpType jump, bool use_init_step)
241 {
242         const int pos_orig = *pos;
243
244         if (direction == STRCUR_DIR_NEXT) {
245                 if (use_init_step) {
246                         wchar_t_step_next(str, maxlen, pos);
247                 }
248                 else {
249                         BLI_assert(jump == STRCUR_JUMP_DELIM);
250                 }
251
252                 if (jump != STRCUR_JUMP_NONE) {
253                         const strCursorDelimType delim_type = (*pos) < maxlen ? cursor_delim_type_unicode((unsigned int)str[*pos]) : STRCUR_DELIM_NONE;
254                         /* jump between special characters (/,\,_,-, etc.),
255                          * look at function cursor_delim_type_unicode() for complete
256                          * list of special character, ctr -> */
257                         while ((*pos) < maxlen) {
258                                 if (wchar_t_step_next(str, maxlen, pos)) {
259                                         if ((jump != STRCUR_JUMP_ALL) && (delim_type != cursor_delim_type_unicode((unsigned int)str[*pos]))) {
260                                                 break;
261                                         }
262                                 }
263                                 else {
264                                         break; /* unlikely but just in case */
265                                 }
266                         }
267                 }
268         }
269         else if (direction == STRCUR_DIR_PREV) {
270                 if (use_init_step) {
271                         wchar_t_step_prev(str, maxlen, pos);
272                 }
273                 else {
274                         BLI_assert(jump == STRCUR_JUMP_DELIM);
275                 }
276
277                 if (jump != STRCUR_JUMP_NONE) {
278                         const strCursorDelimType delim_type = (*pos) > 0 ? cursor_delim_type_unicode((unsigned int)str[(*pos) - 1]) : STRCUR_DELIM_NONE;
279                         /* jump between special characters (/,\,_,-, etc.),
280                          * look at function cursor_delim_type() for complete
281                          * list of special character, ctr -> */
282                         while ((*pos) > 0) {
283                                 const int pos_prev = *pos;
284                                 if (wchar_t_step_prev(str, maxlen, pos)) {
285                                         if ((jump != STRCUR_JUMP_ALL) && (delim_type != cursor_delim_type_unicode((unsigned int)str[*pos]))) {
286                                                 /* left only: compensate for index/change in direction */
287                                                 if ((pos_orig - (*pos)) >= 1) {
288                                                         *pos = pos_prev;
289                                                 }
290                                                 break;
291                                         }
292                                 }
293                                 else {
294                                         break;
295                                 }
296                         }
297                 }
298         }
299         else {
300                 BLI_assert(0);
301         }
302 }
303