Cleanup: spelling
[blender-staging.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 BLI_strncpy but ensures dst is always padded by given char, on both sides (unless src is empty).
130  *
131  * \param dst Destination for copy
132  * \param src Source string to copy
133  * \param pad the char to use for padding
134  * \param maxncpy Maximum number of characters to copy (generally the size of dst)
135  * \retval Returns dst
136  */
137 char *BLI_strncpy_ensure_pad(char *__restrict dst, const char *__restrict src, const char pad, size_t maxncpy)
138 {
139         BLI_assert(maxncpy != 0);
140
141 #ifdef DEBUG_STRSIZE
142         memset(dst, 0xff, sizeof(*dst) * maxncpy);
143 #endif
144
145         if (src[0] == '\0') {
146                 dst[0] = '\0';
147         }
148         else {
149                 /* Add heading/trailing wildcards if needed. */
150                 size_t idx = 0;
151                 size_t srclen;
152
153                 if (src[idx] != pad) {
154                         dst[idx++] = pad;
155                         maxncpy--;
156                 }
157                 maxncpy--;  /* trailing '\0' */
158
159                 srclen = BLI_strnlen(src, maxncpy);
160                 if ((src[srclen - 1] != pad) && (srclen == maxncpy)) {
161                         srclen--;
162                 }
163
164                 memcpy(&dst[idx], src, srclen);
165                 idx += srclen;
166
167                 if (dst[idx - 1] != pad) {
168                         dst[idx++] = pad;
169                 }
170                 dst[idx] = '\0';
171         }
172
173         return dst;
174 }
175
176 /**
177  * Like strncpy but ensures dst is always
178  * '\0' terminated.
179  *
180  * \note This is a duplicate of #BLI_strncpy that returns bytes copied.
181  * And is a drop in replacement for 'snprintf(str, sizeof(str), "%s", arg);'
182  *
183  * \param dst Destination for copy
184  * \param src Source string to copy
185  * \param maxncpy Maximum number of characters to copy (generally
186  * the size of dst)
187  * \retval The number of bytes copied (The only difference from BLI_strncpy).
188  */
189 size_t BLI_strncpy_rlen(char *__restrict dst, const char *__restrict src, const size_t maxncpy)
190 {
191         size_t srclen = BLI_strnlen(src, maxncpy - 1);
192         BLI_assert(maxncpy != 0);
193
194 #ifdef DEBUG_STRSIZE
195         memset(dst, 0xff, sizeof(*dst) * maxncpy);
196 #endif
197
198         memcpy(dst, src, srclen);
199         dst[srclen] = '\0';
200         return srclen;
201 }
202
203 size_t BLI_strcpy_rlen(char *__restrict dst, const char *__restrict src)
204 {
205         size_t srclen = strlen(src);
206         memcpy(dst, src, srclen + 1);
207         return srclen;
208 }
209
210 /**
211  * Portable replacement for #vsnprintf
212  */
213 size_t BLI_vsnprintf(char *__restrict buffer, size_t maxncpy, const char *__restrict format, va_list arg)
214 {
215         size_t n;
216
217         BLI_assert(buffer != NULL);
218         BLI_assert(maxncpy > 0);
219         BLI_assert(format != NULL);
220
221         n = (size_t)vsnprintf(buffer, maxncpy, format, arg);
222
223         if (n != -1 && n < maxncpy) {
224                 buffer[n] = '\0';
225         }
226         else {
227                 buffer[maxncpy - 1] = '\0';
228         }
229
230         return n;
231 }
232
233 /**
234  * A version of #BLI_vsnprintf that returns ``strlen(buffer)``
235  */
236 size_t BLI_vsnprintf_rlen(char *__restrict buffer, size_t maxncpy, const char *__restrict format, va_list arg)
237 {
238         size_t n;
239
240         BLI_assert(buffer != NULL);
241         BLI_assert(maxncpy > 0);
242         BLI_assert(format != NULL);
243
244         n = (size_t)vsnprintf(buffer, maxncpy, format, arg);
245
246         if (n != -1 && n < maxncpy) {
247                 /* pass */
248         }
249         else {
250                 n = maxncpy - 1;
251         }
252         buffer[n] = '\0';
253
254         return n;
255 }
256
257 /**
258  * Portable replacement for #snprintf
259  */
260 size_t BLI_snprintf(char *__restrict dst, size_t maxncpy, const char *__restrict format, ...)
261 {
262         size_t n;
263         va_list arg;
264
265 #ifdef DEBUG_STRSIZE
266         memset(dst, 0xff, sizeof(*dst) * maxncpy);
267 #endif
268
269         va_start(arg, format);
270         n = BLI_vsnprintf(dst, maxncpy, format, arg);
271         va_end(arg);
272
273         return n;
274 }
275
276 /**
277  * A version of #BLI_snprintf that returns ``strlen(dst)``
278  */
279 size_t BLI_snprintf_rlen(char *__restrict dst, size_t maxncpy, const char *__restrict format, ...)
280 {
281         size_t n;
282         va_list arg;
283
284 #ifdef DEBUG_STRSIZE
285         memset(dst, 0xff, sizeof(*dst) * maxncpy);
286 #endif
287
288         va_start(arg, format);
289         n = BLI_vsnprintf_rlen(dst, maxncpy, format, arg);
290         va_end(arg);
291
292         return n;
293 }
294
295 /**
296  * Print formatted string into a newly #MEM_mallocN'd string
297  * and return it.
298  */
299 char *BLI_sprintfN(const char *__restrict format, ...)
300 {
301         DynStr *ds;
302         va_list arg;
303         char *n;
304
305         BLI_assert(format != NULL);
306
307         va_start(arg, format);
308
309         ds = BLI_dynstr_new();
310         BLI_dynstr_vappendf(ds, format, arg);
311         n = BLI_dynstr_get_cstring(ds);
312         BLI_dynstr_free(ds);
313
314         va_end(arg);
315
316         return n;
317 }
318
319
320 /* match pythons string escaping, assume double quotes - (")
321  * TODO: should be used to create RNA animation paths.
322  * TODO: support more fancy string escaping. current code is primitive
323  *    this basically is an ascii version of PyUnicode_EncodeUnicodeEscape()
324  *    which is a useful reference. */
325 size_t BLI_strescape(char *__restrict dst, const char *__restrict src, const size_t maxncpy)
326 {
327         size_t len = 0;
328
329         BLI_assert(maxncpy != 0);
330
331         while (len < maxncpy) {
332                 switch (*src) {
333                         case '\0':
334                                 goto escape_finish;
335                         case '\\':
336                         case '"':
337                                 /* fall-through */
338
339                         /* less common but should also be support */
340                         case '\t':
341                         case '\n':
342                         case '\r':
343                                 if (len + 1 < maxncpy) {
344                                         *dst++ = '\\';
345                                         len++;
346                                 }
347                                 else {
348                                         /* not enough space to escape */
349                                         break;
350                                 }
351                                 /* fall-through */
352                         default:
353                                 *dst = *src;
354                                 break;
355                 }
356                 dst++;
357                 src++;
358                 len++;
359         }
360
361 escape_finish:
362
363         *dst = '\0';
364
365         return len;
366 }
367
368 /**
369  * Makes a copy of the text within the "" that appear after some text 'blahblah'
370  * i.e. for string 'pose["apples"]' with prefix 'pose[', it should grab "apples"
371  *
372  * - str: is the entire string to chop
373  * - prefix: is the part of the string to leave out
374  *
375  * Assume that the strings returned must be freed afterwards, and that the inputs will contain
376  * data we want...
377  *
378  * \return the offset and a length so as to avoid doing an allocation.
379  */
380 char *BLI_str_quoted_substrN(const char *__restrict str, const char *__restrict prefix)
381 {
382         const char *startMatch, *endMatch;
383
384         /* get the starting point (i.e. where prefix starts, and add prefixLen+1 to it to get be after the first " */
385         startMatch = strstr(str, prefix);
386         if (startMatch) {
387                 const size_t prefixLen = strlen(prefix);
388                 startMatch += prefixLen + 1;
389                 /* get the end point (i.e. where the next occurance of " is after the starting point) */
390
391                 endMatch = startMatch;
392                 while ((endMatch = strchr(endMatch, '"'))) {
393                         if (LIKELY(*(endMatch - 1) != '\\')) {
394                                 break;
395                         }
396                         else {
397                                 endMatch++;
398                         }
399                 }
400
401                 if (endMatch) {
402                         /* return the slice indicated */
403                         return BLI_strdupn(startMatch, (size_t)(endMatch - startMatch));
404                 }
405         }
406         return BLI_strdupn("", 0);
407 }
408
409 /**
410  * string with all instances of substr_old replaced with substr_new,
411  * Returns a copy of the cstring \a str into a newly mallocN'd
412  * and returns it.
413  *
414  * \note A rather wasteful string-replacement utility, though this shall do for now...
415  * Feel free to replace this with an even safe + nicer alternative
416  *
417  * \param str The string to replace occurrences of substr_old in
418  * \param substr_old The text in the string to find and replace
419  * \param substr_new The text in the string to find and replace
420  * \retval Returns the duplicated string
421  */
422 char *BLI_str_replaceN(const char *__restrict str, const char *__restrict substr_old, const char *__restrict substr_new)
423 {
424         DynStr *ds = NULL;
425         size_t len_old = strlen(substr_old);
426         const char *match;
427
428         BLI_assert(substr_old[0] != '\0');
429
430         /* while we can still find a match for the old substring that we're searching for, 
431          * keep dicing and replacing
432          */
433         while ((match = strstr(str, substr_old))) {
434                 /* the assembly buffer only gets created when we actually need to rebuild the string */
435                 if (ds == NULL)
436                         ds = BLI_dynstr_new();
437                         
438                 /* if the match position does not match the current position in the string, 
439                  * copy the text up to this position and advance the current position in the string
440                  */
441                 if (str != match) {
442                         /* add the segment of the string from str to match to the buffer, then restore the value at match
443                          */
444                         BLI_dynstr_nappend(ds, str, (match - str));
445                         
446                         /* now our current position should be set on the start of the match */
447                         str = match;
448                 }
449                 
450                 /* add the replacement text to the accumulation buffer */
451                 BLI_dynstr_append(ds, substr_new);
452                 
453                 /* advance the current position of the string up to the end of the replaced segment */
454                 str += len_old;
455         }
456         
457         /* finish off and return a new string that has had all occurrences of */
458         if (ds) {
459                 char *str_new;
460                 
461                 /* add what's left of the string to the assembly buffer 
462                  * - we've been adjusting str to point at the end of the replaced segments
463                  */
464                 BLI_dynstr_append(ds, str);
465                 
466                 /* convert to new c-string (MEM_malloc'd), and free the buffer */
467                 str_new = BLI_dynstr_get_cstring(ds);
468                 BLI_dynstr_free(ds);
469                 
470                 return str_new;
471         }
472         else {
473                 /* just create a new copy of the entire string - we avoid going through the assembly buffer 
474                  * for what should be a bit more efficiency...
475                  */
476                 return BLI_strdup(str);
477         }
478
479
480 /**
481  * In-place replace every \a src to \a dst in \a str.
482  *
483  * \param str: The string to operate on.
484  * \param src: The character to replace.
485  * \param dst: The character to replace with.
486  */
487 void BLI_str_replace_char(char *str, char src, char dst)
488 {
489         while (*str) {
490                 if (*str == src) {
491                         *str = dst;
492                 }
493                 str++;
494         }
495 }
496
497 /**
498  * Compare two strings without regard to case.
499  *
500  * \retval True if the strings are equal, false otherwise.
501  */
502 int BLI_strcaseeq(const char *a, const char *b) 
503 {
504         return (BLI_strcasecmp(a, b) == 0);
505 }
506
507 /**
508  * Portable replacement for #strcasestr (not available in MSVC)
509  */
510 char *BLI_strcasestr(const char *s, const char *find)
511 {
512         register char c, sc;
513         register size_t len;
514         
515         if ((c = *find++) != 0) {
516                 c = tolower(c);
517                 len = strlen(find);
518                 do {
519                         do {
520                                 if ((sc = *s++) == 0)
521                                         return (NULL);
522                                 sc = tolower(sc);
523                         } while (sc != c);
524                 } while (BLI_strncasecmp(s, find, len) != 0);
525                 s--;
526         }
527         return ((char *) s);
528 }
529
530
531 int BLI_strcasecmp(const char *s1, const char *s2)
532 {
533         register int i;
534         register char c1, c2;
535
536         for (i = 0;; i++) {
537                 c1 = tolower(s1[i]);
538                 c2 = tolower(s2[i]);
539
540                 if (c1 < c2) {
541                         return -1;
542                 }
543                 else if (c1 > c2) {
544                         return 1;
545                 }
546                 else if (c1 == 0) {
547                         break;
548                 }
549         }
550
551         return 0;
552 }
553
554 int BLI_strncasecmp(const char *s1, const char *s2, size_t len)
555 {
556         register size_t i;
557         register char c1, c2;
558
559         for (i = 0; i < len; i++) {
560                 c1 = tolower(s1[i]);
561                 c2 = tolower(s2[i]);
562
563                 if (c1 < c2) {
564                         return -1;
565                 }
566                 else if (c1 > c2) {
567                         return 1;
568                 }
569                 else if (c1 == 0) {
570                         break;
571                 }
572         }
573
574         return 0;
575 }
576
577 /* compare number on the left size of the string */
578 static int left_number_strcmp(const char *s1, const char *s2, int *tiebreaker)
579 {
580         const char *p1 = s1, *p2 = s2;
581         int numdigit, numzero1, numzero2;
582
583         /* count and skip leading zeros */
584         for (numzero1 = 0; *p1 && (*p1 == '0'); numzero1++)
585                 p1++;
586         for (numzero2 = 0; *p2 && (*p2 == '0'); numzero2++)
587                 p2++;
588
589         /* find number of consecutive digits */
590         for (numdigit = 0; ; numdigit++) {
591                 if (isdigit(*(p1 + numdigit)) && isdigit(*(p2 + numdigit)))
592                         continue;
593                 else if (isdigit(*(p1 + numdigit)))
594                         return 1; /* s2 is bigger */
595                 else if (isdigit(*(p2 + numdigit)))
596                         return -1; /* s1 is bigger */
597                 else
598                         break;
599         }
600
601         /* same number of digits, compare size of number */
602         if (numdigit > 0) {
603                 int compare = (int)strncmp(p1, p2, (size_t)numdigit);
604
605                 if (compare != 0)
606                         return compare;
607         }
608
609         /* use number of leading zeros as tie breaker if still equal */
610         if (*tiebreaker == 0) {
611                 if (numzero1 > numzero2)
612                         *tiebreaker = 1;
613                 else if (numzero1 < numzero2)
614                         *tiebreaker = -1;
615         }
616
617         return 0;
618 }
619
620 /* natural string compare, keeping numbers in order */
621 int BLI_natstrcmp(const char *s1, const char *s2)
622 {
623         register int d1 = 0, d2 = 0;
624         register char c1, c2;
625         int tiebreaker = 0;
626
627         /* if both chars are numeric, to a left_number_strcmp().
628          * then increase string deltas as long they are 
629          * numeric, else do a tolower and char compare */
630
631         while (1) {
632                 c1 = tolower(s1[d1]);
633                 c2 = tolower(s2[d2]);
634                 
635                 if (isdigit(c1) && isdigit(c2)) {
636                         int numcompare = left_number_strcmp(s1 + d1, s2 + d2, &tiebreaker);
637                         
638                         if (numcompare != 0)
639                                 return numcompare;
640
641                         d1++;
642                         while (isdigit(s1[d1]))
643                                 d1++;
644                         d2++;
645                         while (isdigit(s2[d2]))
646                                 d2++;
647                         
648                         c1 = tolower(s1[d1]);
649                         c2 = tolower(s2[d2]);
650                 }
651         
652                 /* first check for '.' so "foo.bar" comes before "foo 1.bar" */
653                 if (c1 == '.' && c2 != '.')
654                         return -1;
655                 if (c1 != '.' && c2 == '.')
656                         return 1;
657                 else if (c1 < c2) {
658                         return -1;
659                 }
660                 else if (c1 > c2) {
661                         return 1;
662                 }
663                 else if (c1 == 0) {
664                         break;
665                 }
666                 d1++;
667                 d2++;
668         }
669
670         if (tiebreaker)
671                 return tiebreaker;
672         
673         /* we might still have a different string because of lower/upper case, in
674          * that case fall back to regular string comparison */
675         return strcmp(s1, s2);
676 }
677
678 /**
679  * Like strcmp, but will ignore any heading/trailing pad char for comparison.
680  * So e.g. if pad is '*', '*world' and 'world*' will compare equal.
681  */
682 int BLI_strcmp_ignore_pad(const char *str1, const char *str2, const char pad)
683 {
684         size_t str1_len, str2_len;
685
686         while (*str1 == pad) {
687                 str1++;
688         }
689         while (*str2 == pad) {
690                 str2++;
691         }
692
693         str1_len = strlen(str1);
694         str2_len = strlen(str2);
695
696         while (str1_len && (str1[str1_len - 1] == pad)) {
697                 str1_len--;
698         }
699         while (str2_len && (str2[str2_len - 1] == pad)) {
700                 str2_len--;
701         }
702
703         if (str1_len == str2_len) {
704                 return strncmp(str1, str2, str2_len);
705         }
706         else if (str1_len > str2_len) {
707                 int ret = strncmp(str1, str2, str2_len);
708                 if (ret == 0) {
709                         ret = 1;
710                 }
711                 return ret;
712         }
713         else {
714                 int ret = strncmp(str1, str2, str1_len);
715                 if (ret == 0) {
716                         ret = -1;
717                 }
718                 return ret;
719         }
720 }
721
722 /* determine the length of a fixed-size string */
723 size_t BLI_strnlen(const char *s, const size_t maxlen)
724 {
725         size_t len;
726
727         for (len = 0; len < maxlen; len++, s++) {
728                 if (!*s)
729                         break;
730         }
731         return len;
732 }
733
734 void BLI_str_tolower_ascii(char *str, const size_t len)
735 {
736         size_t i;
737
738         for (i = 0; (i < len) && str[i]; i++)
739                 if (str[i] >= 'A' && str[i] <= 'Z')
740                         str[i] += 'a' - 'A';
741 }
742
743 void BLI_str_toupper_ascii(char *str, const size_t len)
744 {
745         size_t i;
746
747         for (i = 0; (i < len) && str[i]; i++)
748                 if (str[i] >= 'a' && str[i] <= 'z')
749                         str[i] -= 'a' - 'A';
750 }
751
752 /**
753  * Strip trailing zeros from a float, eg:
754  *   0.0000 -> 0.0
755  *   2.0010 -> 2.001
756  *
757  * \param str
758  * \param pad
759  * \return The number of zeros stripped.
760  */
761 int BLI_str_rstrip_float_zero(char *str, const char pad)
762 {
763         char *p = strchr(str, '.');
764         int totstrip = 0;
765         if (p) {
766                 char *end_p;
767                 p++;  /* position at first decimal place */
768                 end_p = p + (strlen(p) - 1);  /* position at last character */
769                 if (end_p > p) {
770                         while (end_p != p && *end_p == '0') {
771                                 *end_p = pad;
772                                 end_p--;
773                         }
774                 }
775         }
776
777         return totstrip;
778 }
779
780 /**
781  * Return index of a string in a string array.
782  *
783  * \param str The string to find.
784  * \param str_array Array of strings.
785  * \param str_array_len The length of the array, or -1 for a NULL-terminated array.
786  * \return The index of str in str_array or -1.
787  */
788 int BLI_str_index_in_array_n(const char *__restrict str, const char **__restrict str_array, const int str_array_len)
789 {
790         int index;
791         const char **str_iter = str_array;
792
793         for (index = 0; index < str_array_len; str_iter++, index++) {
794                 if (STREQ(str, *str_iter)) {
795                         return index;
796                 }
797         }
798         return -1;
799 }
800
801 /**
802  * Return index of a string in a string array.
803  *
804  * \param str The string to find.
805  * \param str_array Array of strings, (must be NULL-terminated).
806  * \return The index of str in str_array or -1.
807  */
808 int BLI_str_index_in_array(const char *__restrict str, const char **__restrict str_array)
809 {
810         int index;
811         const char **str_iter = str_array;
812
813         for (index = 0; *str_iter; str_iter++, index++) {
814                 if (STREQ(str, *str_iter)) {
815                         return index;
816                 }
817         }
818         return -1;
819 }
820
821 bool BLI_strn_endswith(const char *__restrict str, const char *__restrict end, size_t slength)
822 {
823         size_t elength = strlen(end);
824         
825         if (elength < slength) {
826                 const char *iter = &str[slength - elength];
827                 while (*iter) {
828                         if (*iter++ != *end++) {
829                                 return false;
830                         }
831                 }
832                 return true;
833         }
834         return false;
835 }
836
837 /**
838  * Find if a string ends with another string.
839  *
840  * \param str The string to search within.
841  * \param end The string we look for at the end.
842  * \return If str ends with end.
843  */
844 bool BLI_str_endswith(const char *__restrict str, const char *end)
845 {
846         const size_t slength = strlen(str);
847         return BLI_strn_endswith(str, end, slength);
848 }
849
850 /**
851  * Find the first char matching one of the chars in \a delim, from left.
852  *
853  * \param str The string to search within.
854  * \param delim The set of delimiters to search for, as unicode values.
855  * \param sep Return value, set to the first delimiter found (or NULL if none found).
856  * \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
857  * \return The length of the prefix (i.e. *sep - str).
858  */
859 size_t BLI_str_partition(const char *str, const char delim[], const char **sep, const char **suf)
860 {
861         return BLI_str_partition_ex(str, NULL, delim, sep, suf, false);
862 }
863
864 /**
865  * Find the first char matching one of the chars in \a delim, from right.
866  *
867  * \param str The string to search within.
868  * \param delim The set of delimiters to search for, as unicode values.
869  * \param sep Return value, set to the first delimiter found (or NULL if none found).
870  * \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
871  * \return The length of the prefix (i.e. *sep - str).
872  */
873 size_t BLI_str_rpartition(const char *str, const char delim[], const char **sep, const char **suf)
874 {
875         return BLI_str_partition_ex(str, NULL, delim, sep, suf, true);
876 }
877
878 /**
879  * Find the first char matching one of the chars in \a delim, either from left or right.
880  *
881  * \param str The string to search within.
882  * \param end If non-NULL, the right delimiter of the string.
883  * \param delim The set of delimiters to search for, as unicode values.
884  * \param sep Return value, set to the first delimiter found (or NULL if none found).
885  * \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
886  * \param from_right If %true, search from the right of \a str, else, search from its left.
887  * \return The length of the prefix (i.e. *sep - str).
888  */
889 size_t BLI_str_partition_ex(
890         const char *str, const char *end, const char delim[], const char **sep, const char **suf, const bool from_right)
891 {
892         const char *d;
893         char *(*func)(const char *str, int c) = from_right ? strrchr : strchr;
894
895         BLI_assert(end == NULL || end > str);
896
897         *sep = *suf = NULL;
898
899         for (d = delim; *d != '\0'; ++d) {
900                 const char *tmp;
901
902                 if (end) {
903                         if (from_right) {
904                                 for (tmp = end - 1; (tmp >= str) && (*tmp != *d); tmp--);
905                                 if (tmp < str) {
906                                         tmp = NULL;
907                                 }
908                         }
909                         else {
910                                 tmp = func(str, *d);
911                                 if (tmp >= end) {
912                                         tmp = NULL;
913                                 }
914                         }
915                 }
916                 else {
917                         tmp = func(str, *d);
918                 }
919
920                 if (tmp && (from_right ? (*sep < tmp) : (!*sep || *sep > tmp))) {
921                         *sep = tmp;
922                 }
923         }
924
925         if (*sep) {
926                 *suf = *sep + 1;
927                 return (size_t)(*sep - str);
928         }
929
930         return end ? (size_t)(end - str) : strlen(str);
931 }
932
933 /**
934  * Format ints with decimal grouping.
935  * 1000 -> 1,000
936  *
937  * \param dst  The resulting string
938  * \param num  Number to format
939  * \return The length of \a dst
940  */
941 size_t BLI_str_format_int_grouped(char dst[16], int num)
942 {
943         char src[16];
944         char *p_src = src;
945         char *p_dst = dst;
946
947         const char separator = ',';
948         int num_len, commas;
949
950         num_len = sprintf(src, "%d", num);
951
952         if (*p_src == '-') {
953                 *p_dst++ = *p_src++;
954                 num_len--;
955         }
956
957         for (commas = 2 - num_len % 3; *p_src; commas = (commas + 1) % 3) {
958                 *p_dst++ = *p_src++;
959                 if (commas == 1) {
960                         *p_dst++ = separator;
961                 }
962         }
963         *--p_dst = '\0';
964
965         return (size_t)(p_dst - dst);
966 }