Merge branch 'master' into blender2.8
[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 eStrCursorDelimType {
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 } eStrCursorDelimType;
53
54 static eStrCursorDelimType cursor_delim_type_unicode(const uint 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 eStrCursorDelimType 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         uint 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(
150         const char *str, size_t maxlen,
151         int *pos, eStrCursorJumpDirection direction,
152         eStrCursorJumpType jump, bool use_init_step)
153 {
154         const int pos_orig = *pos;
155
156         if (direction == STRCUR_DIR_NEXT) {
157                 if (use_init_step) {
158                         BLI_str_cursor_step_next_utf8(str, maxlen, pos);
159                 }
160                 else {
161                         BLI_assert(jump == STRCUR_JUMP_DELIM);
162                 }
163
164                 if (jump != STRCUR_JUMP_NONE) {
165                         const eStrCursorDelimType delim_type =
166                                 (*pos) < maxlen ? cursor_delim_type_utf8(&str[*pos]) : STRCUR_DELIM_NONE;
167                         /* jump between special characters (/,\,_,-, etc.),
168                          * look at function cursor_delim_type() for complete
169                          * list of special character, ctr -> */
170                         while ((*pos) < maxlen) {
171                                 if (BLI_str_cursor_step_next_utf8(str, maxlen, pos)) {
172                                         if ((jump != STRCUR_JUMP_ALL) &&
173                                             (delim_type != cursor_delim_type_utf8(&str[*pos])))
174                                         {
175                                                 break;
176                                         }
177                                 }
178                                 else {
179                                         break; /* unlikely but just in case */
180                                 }
181                         }
182                 }
183         }
184         else if (direction == STRCUR_DIR_PREV) {
185                 if (use_init_step) {
186                         BLI_str_cursor_step_prev_utf8(str, maxlen, pos);
187                 }
188                 else {
189                         BLI_assert(jump == STRCUR_JUMP_DELIM);
190                 }
191
192                 if (jump != STRCUR_JUMP_NONE) {
193                         const eStrCursorDelimType delim_type =
194                                 (*pos) > 0 ? cursor_delim_type_utf8(&str[(*pos) - 1]) : STRCUR_DELIM_NONE;
195                         /* jump between special characters (/,\,_,-, etc.),
196                          * look at function cursor_delim_type() for complete
197                          * list of special character, ctr -> */
198                         while ((*pos) > 0) {
199                                 const int pos_prev = *pos;
200                                 if (BLI_str_cursor_step_prev_utf8(str, maxlen, pos)) {
201                                         if ((jump != STRCUR_JUMP_ALL) &&
202                                             (delim_type != cursor_delim_type_utf8(&str[*pos])))
203                                         {
204                                                 /* left only: compensate for index/change in direction */
205                                                 if ((pos_orig - (*pos)) >= 1) {
206                                                         *pos = pos_prev;
207                                                 }
208                                                 break;
209                                         }
210                                 }
211                                 else {
212                                         break;
213                                 }
214                         }
215                 }
216         }
217         else {
218                 BLI_assert(0);
219         }
220 }
221
222 /* wchar_t version of BLI_str_cursor_step_utf8 (keep in sync!)
223  * less complex since it doesn't need to do multi-byte stepping.
224  */
225
226 /* helper funcs so we can match BLI_str_cursor_step_utf8 */
227 static bool wchar_t_step_next(const wchar_t *UNUSED(str), size_t maxlen, int *pos)
228 {
229         if ((*pos) >= (int)maxlen) {
230                 return false;
231         }
232         (*pos)++;
233         return true;
234 }
235
236 static bool wchar_t_step_prev(const wchar_t *UNUSED(str), size_t UNUSED(maxlen), int *pos)
237 {
238         if ((*pos) <= 0) {
239                 return false;
240         }
241         (*pos)--;
242         return true;
243 }
244
245 void BLI_str_cursor_step_wchar(
246         const wchar_t *str, size_t maxlen,
247         int *pos, eStrCursorJumpDirection direction,
248         eStrCursorJumpType jump, bool use_init_step)
249 {
250         const int pos_orig = *pos;
251
252         if (direction == STRCUR_DIR_NEXT) {
253                 if (use_init_step) {
254                         wchar_t_step_next(str, maxlen, pos);
255                 }
256                 else {
257                         BLI_assert(jump == STRCUR_JUMP_DELIM);
258                 }
259
260                 if (jump != STRCUR_JUMP_NONE) {
261                         const eStrCursorDelimType delim_type =
262                                 (*pos) < maxlen ? cursor_delim_type_unicode((uint)str[*pos]) : STRCUR_DELIM_NONE;
263                         /* jump between special characters (/,\,_,-, etc.),
264                          * look at function cursor_delim_type_unicode() for complete
265                          * list of special character, ctr -> */
266                         while ((*pos) < maxlen) {
267                                 if (wchar_t_step_next(str, maxlen, pos)) {
268                                         if ((jump != STRCUR_JUMP_ALL) &&
269                                             (delim_type != cursor_delim_type_unicode((uint)str[*pos])))
270                                         {
271                                                 break;
272                                         }
273                                 }
274                                 else {
275                                         break; /* unlikely but just in case */
276                                 }
277                         }
278                 }
279         }
280         else if (direction == STRCUR_DIR_PREV) {
281                 if (use_init_step) {
282                         wchar_t_step_prev(str, maxlen, pos);
283                 }
284                 else {
285                         BLI_assert(jump == STRCUR_JUMP_DELIM);
286                 }
287
288                 if (jump != STRCUR_JUMP_NONE) {
289                         const eStrCursorDelimType delim_type =
290                                 (*pos) > 0 ? cursor_delim_type_unicode((uint)str[(*pos) - 1]) : STRCUR_DELIM_NONE;
291                         /* jump between special characters (/,\,_,-, etc.),
292                          * look at function cursor_delim_type() for complete
293                          * list of special character, ctr -> */
294                         while ((*pos) > 0) {
295                                 const int pos_prev = *pos;
296                                 if (wchar_t_step_prev(str, maxlen, pos)) {
297                                         if ((jump != STRCUR_JUMP_ALL) &&
298                                             (delim_type != cursor_delim_type_unicode((uint)str[*pos])))
299                                         {
300                                                 /* left only: compensate for index/change in direction */
301                                                 if ((pos_orig - (*pos)) >= 1) {
302                                                         *pos = pos_prev;
303                                                 }
304                                                 break;
305                                         }
306                                 }
307                                 else {
308                                         break;
309                                 }
310                         }
311                 }
312         }
313         else {
314                 BLI_assert(0);
315         }
316 }