Merged changes in the trunk up to revision 46787.
[blender.git] / source / blender / blenlib / intern / string.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  * 
27  */
28
29 /** \file blender/blenlib/intern/string.c
30  *  \ingroup bli
31  */
32
33
34 #include <string.h>
35 #include <stdlib.h>
36 #include <stdarg.h>
37 #include <ctype.h>
38
39 #include "MEM_guardedalloc.h"
40
41 #include "BLI_dynstr.h"
42 #include "BLI_string.h"
43
44 char *BLI_strdupn(const char *str, const size_t len)
45 {
46         char *n = MEM_mallocN(len + 1, "strdup");
47         memcpy(n, str, len);
48         n[len] = '\0';
49         
50         return n;
51 }
52 char *BLI_strdup(const char *str)
53 {
54         return BLI_strdupn(str, strlen(str));
55 }
56
57 char *BLI_strdupcat(const char *str1, const char *str2)
58 {
59         size_t len;
60         char *n;
61         
62         len = strlen(str1) + strlen(str2);
63         n = MEM_mallocN(len + 1, "strdupcat");
64         strcpy(n, str1);
65         strcat(n, str2);
66         
67         return n;
68 }
69
70 char *BLI_strncpy(char *dst, const char *src, const size_t maxncpy)
71 {
72         size_t srclen = strlen(src);
73         size_t cpylen = (srclen > (maxncpy - 1)) ? (maxncpy - 1) : srclen;
74         
75         memcpy(dst, src, cpylen);
76         dst[cpylen] = '\0';
77         
78         return dst;
79 }
80
81 size_t BLI_snprintf(char *buffer, size_t count, const char *format, ...)
82 {
83         size_t n;
84         va_list arg;
85
86         va_start(arg, format);
87         n = vsnprintf(buffer, count, format, arg);
88         
89         if (n != -1 && n < count) {
90                 buffer[n] = '\0';
91         }
92         else {
93                 buffer[count - 1] = '\0';
94         }
95         
96         va_end(arg);
97         return n;
98 }
99
100 char *BLI_sprintfN(const char *format, ...)
101 {
102         DynStr *ds;
103         va_list arg;
104         char *n;
105
106         va_start(arg, format);
107
108         ds = BLI_dynstr_new();
109         BLI_dynstr_vappendf(ds, format, arg);
110         n = BLI_dynstr_get_cstring(ds);
111         BLI_dynstr_free(ds);
112
113         va_end(arg);
114
115         return n;
116 }
117
118
119 /* match pythons string escaping, assume double quotes - (")
120  * TODO: should be used to create RNA animation paths.
121  * TODO: support more fancy string escaping. current code is primitive
122  *    this basically is an ascii version of PyUnicode_EncodeUnicodeEscape()
123  *    which is a useful reference. */
124 size_t BLI_strescape(char *dst, const char *src, const size_t maxlen)
125 {
126         size_t len = 0;
127         while (len < maxlen) {
128                 switch (*src) {
129                         case '\0':
130                                 goto escape_finish;
131                         case '\\':
132                         case '"':
133
134                         /* less common but should also be support */
135                         case '\t':
136                         case '\n':
137                         case '\r':
138                                 if (len + 1 <  maxlen) {
139                                         *dst++ = '\\';
140                                         len++;
141                                 }
142                                 else {
143                                         /* not enough space to escape */
144                                         break;
145                                 }
146                         /* intentionally pass through */
147                         default:
148                                 *dst = *src;
149                 }
150                 dst++;
151                 src++;
152                 len++;
153         }
154
155 escape_finish:
156
157         *dst = '\0';
158
159         return len;
160 }
161
162
163 /* Makes a copy of the text within the "" that appear after some text 'blahblah'
164  * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
165  * 
166  *  - str: is the entire string to chop
167  *      - prefix: is the part of the string to leave out 
168  *
169  * Assume that the strings returned must be freed afterwards, and that the inputs will contain 
170  * data we want...
171  */
172 char *BLI_getQuotedStr(const char *str, const char *prefix)
173 {
174         size_t prefixLen = strlen(prefix);
175         char *startMatch, *endMatch;
176         
177         /* get the starting point (i.e. where prefix starts, and add prefixLen+1 to it to get be after the first " */
178         startMatch = strstr(str, prefix) + prefixLen + 1;
179         
180         /* get the end point (i.e. where the next occurance of " is after the starting point) */
181         endMatch = strchr(startMatch, '"'); // "  NOTE: this comment here is just so that my text editor still shows the functions ok...
182         
183         /* return the slice indicated */
184         return BLI_strdupn(startMatch, (size_t)(endMatch - startMatch));
185 }
186
187 /* Replaces all occurrences of oldText with newText in str, returning a new string that doesn't 
188  * contain the 'replaced' occurrences.
189  */
190 // A rather wasteful string-replacement utility, though this shall do for now...
191 // Feel free to replace this with an even safe + nicer alternative 
192 char *BLI_replacestr(char *str, const char *oldText, const char *newText)
193 {
194         DynStr *ds = NULL;
195         size_t lenOld = strlen(oldText);
196         char *match;
197         
198         /* sanity checks */
199         if ((str == NULL) || (str[0] == 0))
200                 return NULL;
201         else if ((oldText == NULL) || (newText == NULL) || (oldText[0] == 0))
202                 return BLI_strdup(str);
203         
204         /* while we can still find a match for the old substring that we're searching for, 
205          * keep dicing and replacing
206          */
207         while ( (match = strstr(str, oldText)) ) {
208                 /* the assembly buffer only gets created when we actually need to rebuild the string */
209                 if (ds == NULL)
210                         ds = BLI_dynstr_new();
211                         
212                 /* if the match position does not match the current position in the string, 
213                  * copy the text up to this position and advance the current position in the string
214                  */
215                 if (str != match) {
216                         /* replace the token at the 'match' position with \0 so that the copied string will be ok,
217                          * add the segment of the string from str to match to the buffer, then restore the value at match
218                          */
219                         match[0] = 0;
220                         BLI_dynstr_append(ds, str);
221                         match[0] = oldText[0];
222                         
223                         /* now our current position should be set on the start of the match */
224                         str = match;
225                 }
226                 
227                 /* add the replacement text to the accumulation buffer */
228                 BLI_dynstr_append(ds, newText);
229                 
230                 /* advance the current position of the string up to the end of the replaced segment */
231                 str += lenOld;
232         }
233         
234         /* finish off and return a new string that has had all occurrences of */
235         if (ds) {
236                 char *newStr;
237                 
238                 /* add what's left of the string to the assembly buffer 
239                  *      - we've been adjusting str to point at the end of the replaced segments
240                  */
241                 if (str != NULL)
242                         BLI_dynstr_append(ds, str);
243                 
244                 /* convert to new c-string (MEM_malloc'd), and free the buffer */
245                 newStr = BLI_dynstr_get_cstring(ds);
246                 BLI_dynstr_free(ds);
247                 
248                 return newStr;
249         }
250         else {
251                 /* just create a new copy of the entire string - we avoid going through the assembly buffer 
252                  * for what should be a bit more efficiency...
253                  */
254                 return BLI_strdup(str);
255         }
256
257
258 int BLI_strcaseeq(const char *a, const char *b) 
259 {
260         return (BLI_strcasecmp(a, b) == 0);
261 }
262
263 /* strcasestr not available in MSVC */
264 char *BLI_strcasestr(const char *s, const char *find)
265 {
266         register char c, sc;
267         register size_t len;
268         
269         if ((c = *find++) != 0) {
270                 c = tolower(c);
271                 len = strlen(find);
272                 do {
273                         do {
274                                 if ((sc = *s++) == 0)
275                                         return (NULL);
276                                 sc = tolower(sc);
277                         } while (sc != c);
278                 } while (BLI_strncasecmp(s, find, len) != 0);
279                 s--;
280         }
281         return ((char *) s);
282 }
283
284
285 int BLI_strcasecmp(const char *s1, const char *s2)
286 {
287         int i;
288
289         for (i = 0;; i++) {
290                 char c1 = tolower(s1[i]);
291                 char c2 = tolower(s2[i]);
292
293                 if (c1 < c2) {
294                         return -1;
295                 }
296                 else if (c1 > c2) {
297                         return 1;
298                 }
299                 else if (c1 == 0) {
300                         break;
301                 }
302         }
303
304         return 0;
305 }
306
307 int BLI_strncasecmp(const char *s1, const char *s2, size_t len)
308 {
309         int i;
310
311         for (i = 0; i < len; i++) {
312                 char c1 = tolower(s1[i]);
313                 char c2 = tolower(s2[i]);
314
315                 if (c1 < c2) {
316                         return -1;
317                 }
318                 else if (c1 > c2) {
319                         return 1;
320                 }
321                 else if (c1 == 0) {
322                         break;
323                 }
324         }
325
326         return 0;
327 }
328
329 /* natural string compare, keeping numbers in order */
330 int BLI_natstrcmp(const char *s1, const char *s2)
331 {
332         int d1 = 0, d2 = 0;
333
334         /* if both chars are numeric, to a strtol().
335          * then increase string deltas as long they are 
336          * numeric, else do a tolower and char compare */
337
338         while (1) {
339                 char c1 = tolower(s1[d1]);
340                 char c2 = tolower(s2[d2]);
341                 
342                 if (isdigit(c1) && isdigit(c2) ) {
343                         int val1, val2;
344                         
345                         val1 = (int)strtol(s1 + d1, (char **)NULL, 10);
346                         val2 = (int)strtol(s2 + d2, (char **)NULL, 10);
347                         
348                         if (val1 < val2) {
349                                 return -1;
350                         }
351                         else if (val1 > val2) {
352                                 return 1;
353                         }
354                         d1++;
355                         while (isdigit(s1[d1]) )
356                                 d1++;
357                         d2++;
358                         while (isdigit(s2[d2]) )
359                                 d2++;
360                         
361                         c1 = tolower(s1[d1]);
362                         c2 = tolower(s2[d2]);
363                 }
364         
365                 /* first check for '.' so "foo.bar" comes before "foo 1.bar" */ 
366                 if (c1 == '.' && c2 != '.')
367                         return -1;
368                 if (c1 != '.' && c2 == '.')
369                         return 1;
370                 else if (c1 < c2) {
371                         return -1;
372                 }
373                 else if (c1 > c2) {
374                         return 1;
375                 }
376                 else if (c1 == 0) {
377                         break;
378                 }
379                 d1++;
380                 d2++;
381         }
382         return 0;
383 }
384
385 void BLI_timestr(double _time, char *str)
386 {
387         /* format 00:00:00.00 (hr:min:sec) string has to be 12 long */
388         int  hr = ( (int)  _time) / (60*60);
389         int min = (((int)  _time) / 60 ) % 60;
390         int sec = ( (int) (_time)) % 60;
391         int hun = ( (int) (_time   * 100.0)) % 100;
392         
393         if (hr) {
394                 sprintf(str, "%.2d:%.2d:%.2d.%.2d", hr, min, sec, hun);
395         }
396         else {
397                 sprintf(str, "%.2d:%.2d.%.2d", min, sec, hun);
398         }
399         
400         str[11] = 0;
401 }
402
403 /* determine the length of a fixed-size string */
404 size_t BLI_strnlen(const char *str, size_t maxlen)
405 {
406         const char *end = memchr(str, '\0', maxlen);
407         return end ? (size_t) (end - str) : maxlen;
408 }
409
410 void BLI_ascii_strtolower(char *str, int len)
411 {
412         int i;
413
414         for (i = 0; i < len; i++)
415                 if (str[i] >= 'A' && str[i] <= 'Z')
416                         str[i] += 'a' - 'A';
417 }
418
419 void BLI_ascii_strtoupper(char *str, int len)
420 {
421         int i;
422
423         for (i = 0; i < len; i++)
424                 if (str[i] >= 'a' && str[i] <= 'z')
425                         str[i] -= 'a' - 'A';
426 }
427