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