code cleanup: remove redundant NULL checks and avoid writing to the source string.
[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 #ifdef __GNUC__
47 #  pragma GCC diagnostic error "-Wsign-conversion"
48 #endif
49
50 // #define DEBUG_STRSIZE
51
52 /**
53  * Duplicates the first \a len bytes of cstring \a str
54  * into a newly mallocN'd string and returns it. \a str
55  * is assumed to be at least len bytes long.
56  *
57  * \param str The string to be duplicated
58  * \param len The number of bytes to duplicate
59  * \retval Returns the duplicated string
60  */
61 char *BLI_strdupn(const char *str, const size_t len)
62 {
63         char *n = MEM_mallocN(len + 1, "strdup");
64         memcpy(n, str, len);
65         n[len] = '\0';
66         
67         return n;
68 }
69
70 /**
71  * Duplicates the cstring \a str into a newly mallocN'd
72  * string and returns it.
73  *
74  * \param str The string to be duplicated
75  * \retval Returns the duplicated string
76  */
77 char *BLI_strdup(const char *str)
78 {
79         return BLI_strdupn(str, strlen(str));
80 }
81
82 /**
83  * Appends the two strings, and returns new mallocN'ed string
84  * \param str1 first string for copy
85  * \param str2 second string for append
86  * \retval Returns dst
87  */
88 char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2)
89 {
90         /* include the NULL terminator of str2 only */
91         const size_t str1_len = strlen(str1);
92         const size_t str2_len = strlen(str2) + 1;
93         char *str, *s;
94         
95         str = MEM_mallocN(str1_len + str2_len, "strdupcat");
96         s = str;
97
98         memcpy(s, str1, str1_len); s += str1_len;
99         memcpy(s, str2, str2_len);
100
101         return str;
102 }
103
104 /**
105  * Like strncpy but ensures dst is always
106  * '\0' terminated.
107  *
108  * \param dst Destination for copy
109  * \param src Source string to copy
110  * \param maxncpy Maximum number of characters to copy (generally
111  * the size of dst)
112  * \retval Returns dst
113  */
114 char *BLI_strncpy(char *__restrict dst, const char *__restrict src, const size_t maxncpy)
115 {
116         size_t srclen = BLI_strnlen(src, maxncpy - 1);
117         BLI_assert(maxncpy != 0);
118
119 #ifdef DEBUG_STRSIZE
120         memset(dst, 0xff, sizeof(*dst) * maxncpy);
121 #endif
122
123         memcpy(dst, src, srclen);
124         dst[srclen] = '\0';
125         return dst;
126 }
127
128 /**
129  * Like strncpy but ensures dst is always
130  * '\0' terminated.
131  *
132  * \note This is a duplicate of #BLI_strncpy that returns bytes copied.
133  * And is a drop in replacement for 'snprintf(str, sizeof(str), "%s", arg);'
134  *
135  * \param dst Destination for copy
136  * \param src Source string to copy
137  * \param maxncpy Maximum number of characters to copy (generally
138  * the size of dst)
139  * \retval The number of bytes copied (The only difference from BLI_strncpy).
140  */
141 size_t BLI_strncpy_rlen(char *__restrict dst, const char *__restrict src, const size_t maxncpy)
142 {
143         size_t srclen = BLI_strnlen(src, maxncpy - 1);
144         BLI_assert(maxncpy != 0);
145
146 #ifdef DEBUG_STRSIZE
147         memset(dst, 0xff, sizeof(*dst) * maxncpy);
148 #endif
149
150         memcpy(dst, src, srclen);
151         dst[srclen] = '\0';
152         return srclen;
153 }
154
155 size_t BLI_strcpy_rlen(char *__restrict dst, const char *__restrict src)
156 {
157         size_t srclen = strlen(src);
158         memcpy(dst, src, srclen + 1);
159         return srclen;
160 }
161
162 /**
163  * Portable replacement for #vsnprintf
164  */
165 size_t BLI_vsnprintf(char *__restrict buffer, size_t maxncpy, const char *__restrict format, va_list arg)
166 {
167         size_t n;
168
169         BLI_assert(buffer != NULL);
170         BLI_assert(maxncpy > 0);
171         BLI_assert(format != NULL);
172
173         n = (size_t)vsnprintf(buffer, maxncpy, format, arg);
174
175         if (n != -1 && n < maxncpy) {
176                 buffer[n] = '\0';
177         }
178         else {
179                 buffer[maxncpy - 1] = '\0';
180         }
181
182         return n;
183 }
184
185 /**
186  * Portable replacement for #snprintf
187  */
188 size_t BLI_snprintf(char *__restrict dst, size_t maxncpy, const char *__restrict format, ...)
189 {
190         size_t n;
191         va_list arg;
192
193 #ifdef DEBUG_STRSIZE
194         memset(dst, 0xff, sizeof(*dst) * maxncpy);
195 #endif
196
197         va_start(arg, format);
198         n = BLI_vsnprintf(dst, maxncpy, format, arg);
199         va_end(arg);
200
201         return n;
202 }
203
204 /**
205  * Print formatted string into a newly #MEM_mallocN'd string
206  * and return it.
207  */
208 char *BLI_sprintfN(const char *__restrict format, ...)
209 {
210         DynStr *ds;
211         va_list arg;
212         char *n;
213
214         BLI_assert(format != NULL);
215
216         va_start(arg, format);
217
218         ds = BLI_dynstr_new();
219         BLI_dynstr_vappendf(ds, format, arg);
220         n = BLI_dynstr_get_cstring(ds);
221         BLI_dynstr_free(ds);
222
223         va_end(arg);
224
225         return n;
226 }
227
228
229 /* match pythons string escaping, assume double quotes - (")
230  * TODO: should be used to create RNA animation paths.
231  * TODO: support more fancy string escaping. current code is primitive
232  *    this basically is an ascii version of PyUnicode_EncodeUnicodeEscape()
233  *    which is a useful reference. */
234 size_t BLI_strescape(char *__restrict dst, const char *__restrict src, const size_t maxncpy)
235 {
236         size_t len = 0;
237
238         BLI_assert(maxncpy != 0);
239
240         while (len < maxncpy) {
241                 switch (*src) {
242                         case '\0':
243                                 goto escape_finish;
244                         case '\\':
245                         case '"':
246                                 /* fall-through */
247
248                         /* less common but should also be support */
249                         case '\t':
250                         case '\n':
251                         case '\r':
252                                 if (len + 1 < maxncpy) {
253                                         *dst++ = '\\';
254                                         len++;
255                                 }
256                                 else {
257                                         /* not enough space to escape */
258                                         break;
259                                 }
260                                 /* fall-through */
261                         default:
262                                 *dst = *src;
263                                 break;
264                 }
265                 dst++;
266                 src++;
267                 len++;
268         }
269
270 escape_finish:
271
272         *dst = '\0';
273
274         return len;
275 }
276
277 /**
278  * Makes a copy of the text within the "" that appear after some text 'blahblah'
279  * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
280  *
281  * - str: is the entire string to chop
282  * - prefix: is the part of the string to leave out
283  *
284  * Assume that the strings returned must be freed afterwards, and that the inputs will contain
285  * data we want...
286  *
287  * \return the offset and a length so as to avoid doing an allocation.
288  */
289 char *BLI_str_quoted_substrN(const char *__restrict str, const char *__restrict prefix)
290 {
291         size_t prefixLen = strlen(prefix);
292         char *startMatch, *endMatch;
293         
294         /* get the starting point (i.e. where prefix starts, and add prefixLen+1 to it to get be after the first " */
295         startMatch = strstr(str, prefix) + prefixLen + 1;
296         if (startMatch) {
297                 /* get the end point (i.e. where the next occurance of " is after the starting point) */
298                 endMatch = strchr(startMatch, '"'); /* "  NOTE: this comment here is just so that my text editor still shows the functions ok... */
299                 
300                 if (endMatch)
301                         /* return the slice indicated */
302                         return BLI_strdupn(startMatch, (size_t)(endMatch - startMatch));
303         }
304         return BLI_strdupn("", 0);
305 }
306
307 /**
308  * string with all instances of substr_old replaced with substr_new,
309  * Returns a copy of the cstring \a str into a newly mallocN'd
310  * and returns it.
311  *
312  * \note A rather wasteful string-replacement utility, though this shall do for now...
313  * Feel free to replace this with an even safe + nicer alternative
314  *
315  * \param str The string to replace occurrences of substr_old in
316  * \param substr_old The text in the string to find and replace
317  * \param substr_new The text in the string to find and replace
318  * \retval Returns the duplicated string
319  */
320 char *BLI_replacestrN(const char *__restrict str, const char *__restrict substr_old, const char *__restrict substr_new)
321 {
322         DynStr *ds = NULL;
323         size_t len_old = strlen(substr_old);
324         const char *match;
325
326         BLI_assert(substr_old[0] != '\0');
327
328         /* while we can still find a match for the old substring that we're searching for, 
329          * keep dicing and replacing
330          */
331         while ((match = strstr(str, substr_old))) {
332                 /* the assembly buffer only gets created when we actually need to rebuild the string */
333                 if (ds == NULL)
334                         ds = BLI_dynstr_new();
335                         
336                 /* if the match position does not match the current position in the string, 
337                  * copy the text up to this position and advance the current position in the string
338                  */
339                 if (str != match) {
340                         /* add the segment of the string from str to match to the buffer, then restore the value at match
341                          */
342                         BLI_dynstr_nappend(ds, str, (match - str));
343                         
344                         /* now our current position should be set on the start of the match */
345                         str = match;
346                 }
347                 
348                 /* add the replacement text to the accumulation buffer */
349                 BLI_dynstr_append(ds, substr_new);
350                 
351                 /* advance the current position of the string up to the end of the replaced segment */
352                 str += len_old;
353         }
354         
355         /* finish off and return a new string that has had all occurrences of */
356         if (ds) {
357                 char *str_new;
358                 
359                 /* add what's left of the string to the assembly buffer 
360                  *      - we've been adjusting str to point at the end of the replaced segments
361                  */
362                 if (str != NULL)
363                         BLI_dynstr_append(ds, str);
364                 
365                 /* convert to new c-string (MEM_malloc'd), and free the buffer */
366                 str_new = BLI_dynstr_get_cstring(ds);
367                 BLI_dynstr_free(ds);
368                 
369                 return str_new;
370         }
371         else {
372                 /* just create a new copy of the entire string - we avoid going through the assembly buffer 
373                  * for what should be a bit more efficiency...
374                  */
375                 return BLI_strdup(str);
376         }
377
378
379 /**
380  * Compare two strings without regard to case.
381  *
382  * \retval True if the strings are equal, false otherwise.
383  */
384 int BLI_strcaseeq(const char *a, const char *b) 
385 {
386         return (BLI_strcasecmp(a, b) == 0);
387 }
388
389 /**
390  * Portable replacement for #strcasestr (not available in MSVC)
391  */
392 char *BLI_strcasestr(const char *s, const char *find)
393 {
394         register char c, sc;
395         register size_t len;
396         
397         if ((c = *find++) != 0) {
398                 c = tolower(c);
399                 len = strlen(find);
400                 do {
401                         do {
402                                 if ((sc = *s++) == 0)
403                                         return (NULL);
404                                 sc = tolower(sc);
405                         } while (sc != c);
406                 } while (BLI_strncasecmp(s, find, len) != 0);
407                 s--;
408         }
409         return ((char *) s);
410 }
411
412
413 int BLI_strcasecmp(const char *s1, const char *s2)
414 {
415         register int i;
416         register char c1, c2;
417
418         for (i = 0;; i++) {
419                 c1 = tolower(s1[i]);
420                 c2 = tolower(s2[i]);
421
422                 if (c1 < c2) {
423                         return -1;
424                 }
425                 else if (c1 > c2) {
426                         return 1;
427                 }
428                 else if (c1 == 0) {
429                         break;
430                 }
431         }
432
433         return 0;
434 }
435
436 int BLI_strncasecmp(const char *s1, const char *s2, size_t len)
437 {
438         register size_t i;
439         register char c1, c2;
440
441         for (i = 0; i < len; i++) {
442                 c1 = tolower(s1[i]);
443                 c2 = tolower(s2[i]);
444
445                 if (c1 < c2) {
446                         return -1;
447                 }
448                 else if (c1 > c2) {
449                         return 1;
450                 }
451                 else if (c1 == 0) {
452                         break;
453                 }
454         }
455
456         return 0;
457 }
458
459 /* compare number on the left size of the string */
460 static int left_number_strcmp(const char *s1, const char *s2, int *tiebreaker)
461 {
462         const char *p1 = s1, *p2 = s2;
463         int numdigit, numzero1, numzero2;
464
465         /* count and skip leading zeros */
466         for (numzero1 = 0; *p1 && (*p1 == '0'); numzero1++)
467                 p1++;
468         for (numzero2 = 0; *p2 && (*p2 == '0'); numzero2++)
469                 p2++;
470
471         /* find number of consecutive digits */
472         for (numdigit = 0; ; numdigit++) {
473                 if (isdigit(*(p1 + numdigit)) && isdigit(*(p2 + numdigit)))
474                         continue;
475                 else if (isdigit(*(p1 + numdigit)))
476                         return 1; /* s2 is bigger */
477                 else if (isdigit(*(p2 + numdigit)))
478                         return -1; /* s1 is bigger */
479                 else
480                         break;
481         }
482
483         /* same number of digits, compare size of number */
484         if (numdigit > 0) {
485                 int compare = (int)strncmp(p1, p2, (size_t)numdigit);
486
487                 if (compare != 0)
488                         return compare;
489         }
490
491         /* use number of leading zeros as tie breaker if still equal */
492         if (*tiebreaker == 0) {
493                 if (numzero1 > numzero2)
494                         *tiebreaker = 1;
495                 else if (numzero1 < numzero2)
496                         *tiebreaker = -1;
497         }
498
499         return 0;
500 }
501
502 /* natural string compare, keeping numbers in order */
503 int BLI_natstrcmp(const char *s1, const char *s2)
504 {
505         register int d1 = 0, d2 = 0;
506         register char c1, c2;
507         int tiebreaker = 0;
508
509         /* if both chars are numeric, to a left_number_strcmp().
510          * then increase string deltas as long they are 
511          * numeric, else do a tolower and char compare */
512
513         while (1) {
514                 c1 = tolower(s1[d1]);
515                 c2 = tolower(s2[d2]);
516                 
517                 if (isdigit(c1) && isdigit(c2) ) {
518                         int numcompare = left_number_strcmp(s1 + d1, s2 + d2, &tiebreaker);
519                         
520                         if (numcompare != 0)
521                                 return numcompare;
522
523                         d1++;
524                         while (isdigit(s1[d1]) )
525                                 d1++;
526                         d2++;
527                         while (isdigit(s2[d2]) )
528                                 d2++;
529                         
530                         c1 = tolower(s1[d1]);
531                         c2 = tolower(s2[d2]);
532                 }
533         
534                 /* first check for '.' so "foo.bar" comes before "foo 1.bar" */
535                 if (c1 == '.' && c2 != '.')
536                         return -1;
537                 if (c1 != '.' && c2 == '.')
538                         return 1;
539                 else if (c1 < c2) {
540                         return -1;
541                 }
542                 else if (c1 > c2) {
543                         return 1;
544                 }
545                 else if (c1 == 0) {
546                         break;
547                 }
548                 d1++;
549                 d2++;
550         }
551         return tiebreaker;
552 }
553
554 void BLI_timestr(double _time, char *str, size_t maxlen)
555 {
556         /* format 00:00:00.00 (hr:min:sec) string has to be 12 long */
557         int  hr = ( (int)  _time) / (60 * 60);
558         int min = (((int)  _time) / 60 ) % 60;
559         int sec = ( (int)  _time) % 60;
560         int hun = ( (int) (_time   * 100.0)) % 100;
561
562         if (hr) {
563                 BLI_snprintf(str, maxlen, "%.2d:%.2d:%.2d.%.2d", hr, min, sec, hun);
564         }
565         else {
566                 BLI_snprintf(str, maxlen, "%.2d:%.2d.%.2d", min, sec, hun);
567         }
568 }
569
570 /* determine the length of a fixed-size string */
571 size_t BLI_strnlen(const char *s, const size_t maxlen)
572 {
573         size_t len;
574
575         for (len = 0; len < maxlen; len++, s++) {
576                 if (!*s)
577                         break;
578         }
579         return len;
580 }
581
582 void BLI_ascii_strtolower(char *str, const size_t len)
583 {
584         size_t i;
585
586         for (i = 0; i < len; i++)
587                 if (str[i] >= 'A' && str[i] <= 'Z')
588                         str[i] += 'a' - 'A';
589 }
590
591 void BLI_ascii_strtoupper(char *str, const size_t len)
592 {
593         size_t i;
594
595         for (i = 0; i < len; i++)
596                 if (str[i] >= 'a' && str[i] <= 'z')
597                         str[i] -= 'a' - 'A';
598 }
599
600 /**
601  * Strip trailing zeros from a float, eg:
602  *   0.0000 -> 0.0
603  *   2.0010 -> 2.001
604  *
605  * \param str
606  * \param pad
607  * \return The number of zeto's stripped.
608  */
609 int BLI_str_rstrip_float_zero(char *str, const char pad)
610 {
611         char *p = strchr(str, '.');
612         int totstrip = 0;
613         if (p) {
614                 char *end_p;
615                 p++;  /* position at first decimal place */
616                 end_p = p + (strlen(p) - 1);  /* position at last character */
617                 if (end_p > p) {
618                         while (end_p != p && *end_p == '0') {
619                                 *end_p = pad;
620                                 end_p--;
621                         }
622                 }
623         }
624
625         return totstrip;
626 }