avutil/avstring: add av_strreplace API into avstring
[ffmpeg.git] / libavutil / avstring.c
1 /*
2  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard
3  * Copyright (c) 2007 Mans Rullgard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #include <stdarg.h>
23 #include <stdint.h>
24 #include <stdio.h>
25 #include <string.h>
26
27 #include "config.h"
28 #include "common.h"
29 #include "mem.h"
30 #include "avassert.h"
31 #include "avstring.h"
32 #include "bprint.h"
33
34 int av_strstart(const char *str, const char *pfx, const char **ptr)
35 {
36     while (*pfx && *pfx == *str) {
37         pfx++;
38         str++;
39     }
40     if (!*pfx && ptr)
41         *ptr = str;
42     return !*pfx;
43 }
44
45 int av_stristart(const char *str, const char *pfx, const char **ptr)
46 {
47     while (*pfx && av_toupper((unsigned)*pfx) == av_toupper((unsigned)*str)) {
48         pfx++;
49         str++;
50     }
51     if (!*pfx && ptr)
52         *ptr = str;
53     return !*pfx;
54 }
55
56 char *av_stristr(const char *s1, const char *s2)
57 {
58     if (!*s2)
59         return (char*)(intptr_t)s1;
60
61     do
62         if (av_stristart(s1, s2, NULL))
63             return (char*)(intptr_t)s1;
64     while (*s1++);
65
66     return NULL;
67 }
68
69 char *av_strnstr(const char *haystack, const char *needle, size_t hay_length)
70 {
71     size_t needle_len = strlen(needle);
72     if (!needle_len)
73         return (char*)haystack;
74     while (hay_length >= needle_len) {
75         hay_length--;
76         if (!memcmp(haystack, needle, needle_len))
77             return (char*)haystack;
78         haystack++;
79     }
80     return NULL;
81 }
82
83 size_t av_strlcpy(char *dst, const char *src, size_t size)
84 {
85     size_t len = 0;
86     while (++len < size && *src)
87         *dst++ = *src++;
88     if (len <= size)
89         *dst = 0;
90     return len + strlen(src) - 1;
91 }
92
93 size_t av_strlcat(char *dst, const char *src, size_t size)
94 {
95     size_t len = strlen(dst);
96     if (size <= len + 1)
97         return len + strlen(src);
98     return len + av_strlcpy(dst + len, src, size - len);
99 }
100
101 size_t av_strlcatf(char *dst, size_t size, const char *fmt, ...)
102 {
103     size_t len = strlen(dst);
104     va_list vl;
105
106     va_start(vl, fmt);
107     len += vsnprintf(dst + len, size > len ? size - len : 0, fmt, vl);
108     va_end(vl);
109
110     return len;
111 }
112
113 char *av_asprintf(const char *fmt, ...)
114 {
115     char *p = NULL;
116     va_list va;
117     int len;
118
119     va_start(va, fmt);
120     len = vsnprintf(NULL, 0, fmt, va);
121     va_end(va);
122     if (len < 0)
123         goto end;
124
125     p = av_malloc(len + 1);
126     if (!p)
127         goto end;
128
129     va_start(va, fmt);
130     len = vsnprintf(p, len + 1, fmt, va);
131     va_end(va);
132     if (len < 0)
133         av_freep(&p);
134
135 end:
136     return p;
137 }
138
139 char *av_d2str(double d)
140 {
141     char *str = av_malloc(16);
142     if (str)
143         snprintf(str, 16, "%f", d);
144     return str;
145 }
146
147 #define WHITESPACES " \n\t\r"
148
149 char *av_get_token(const char **buf, const char *term)
150 {
151     char *out     = av_malloc(strlen(*buf) + 1);
152     char *ret     = out, *end = out;
153     const char *p = *buf;
154     if (!out)
155         return NULL;
156     p += strspn(p, WHITESPACES);
157
158     while (*p && !strspn(p, term)) {
159         char c = *p++;
160         if (c == '\\' && *p) {
161             *out++ = *p++;
162             end    = out;
163         } else if (c == '\'') {
164             while (*p && *p != '\'')
165                 *out++ = *p++;
166             if (*p) {
167                 p++;
168                 end = out;
169             }
170         } else {
171             *out++ = c;
172         }
173     }
174
175     do
176         *out-- = 0;
177     while (out >= end && strspn(out, WHITESPACES));
178
179     *buf = p;
180
181     return ret;
182 }
183
184 char *av_strtok(char *s, const char *delim, char **saveptr)
185 {
186     char *tok;
187
188     if (!s && !(s = *saveptr))
189         return NULL;
190
191     /* skip leading delimiters */
192     s += strspn(s, delim);
193
194     /* s now points to the first non delimiter char, or to the end of the string */
195     if (!*s) {
196         *saveptr = NULL;
197         return NULL;
198     }
199     tok = s++;
200
201     /* skip non delimiters */
202     s += strcspn(s, delim);
203     if (*s) {
204         *s = 0;
205         *saveptr = s+1;
206     } else {
207         *saveptr = NULL;
208     }
209
210     return tok;
211 }
212
213 int av_strcasecmp(const char *a, const char *b)
214 {
215     uint8_t c1, c2;
216     do {
217         c1 = av_tolower(*a++);
218         c2 = av_tolower(*b++);
219     } while (c1 && c1 == c2);
220     return c1 - c2;
221 }
222
223 int av_strncasecmp(const char *a, const char *b, size_t n)
224 {
225     const char *end = a + n;
226     uint8_t c1, c2;
227     do {
228         c1 = av_tolower(*a++);
229         c2 = av_tolower(*b++);
230     } while (a < end && c1 && c1 == c2);
231     return c1 - c2;
232 }
233
234 char *av_strreplace(const char *str, const char *from, const char *to)
235 {
236     /* Adjust each of the below values to suit your needs. */
237     /* Increment positions cache size initially by this number. */
238     size_t cache_sz_inc = 16;
239     /* Thereafter, each time capacity needs to be increased,
240      * multiply the increment by this factor. */
241     const size_t cache_sz_inc_factor = 3;
242     /* But never increment capacity by more than this number. */
243     const size_t cache_sz_inc_max = 1048576;
244
245     char *pret, *ret = NULL;
246     const char *pstr2, *pstr = str;
247     size_t i, count = 0;
248     uintptr_t *pos_cache_tmp, *pos_cache = NULL;
249     size_t cache_sz = 0;
250     size_t cpylen, orglen, retlen, tolen, fromlen = strlen(from);
251
252     /* Find all matches and cache their positions. */
253     while ((pstr2 = av_stristr(pstr, from))) {
254         count++;
255         /* Increase the cache size when necessary. */
256         if (cache_sz < count) {
257             cache_sz += cache_sz_inc;
258             pos_cache_tmp = av_realloc(pos_cache, sizeof(*pos_cache) * cache_sz);
259             if (!pos_cache_tmp) {
260                 goto end_strreplace;
261             } else pos_cache = pos_cache_tmp;
262             cache_sz_inc *= cache_sz_inc_factor;
263             if (cache_sz_inc > cache_sz_inc_max) {
264                 cache_sz_inc = cache_sz_inc_max;
265             }
266         }
267
268         pos_cache[count-1] = pstr2 - str;
269         pstr = pstr2 + fromlen;
270     }
271     orglen = pstr - str + strlen(pstr);
272     /* Allocate memory for the post-replacement string. */
273     if (count > 0) {
274         tolen = strlen(to);
275         retlen = orglen + (tolen - fromlen) * count;
276     } else {
277         retlen = orglen;
278     }
279     ret = av_malloc(retlen + 1);
280     if (!ret) {
281         goto end_strreplace;
282     }
283
284     if (!count) {
285         /* If no matches, then just duplicate the string. */
286         av_strlcpy(ret, str, retlen + 1);
287     } else {
288         /* Otherwise, duplicate the string whilst performing
289          * the replacements using the position cache. */
290         pret = ret;
291         memcpy(pret, str, pos_cache[0]);
292         pret += pos_cache[0];
293         for (i = 0; i < count; i++) {
294             memcpy(pret, to, tolen);
295             pret += tolen;
296             pstr = str + pos_cache[i] + fromlen;
297             cpylen = (i == count-1 ? orglen : pos_cache[i+1]) - pos_cache[i] - fromlen;
298             memcpy(pret, pstr, cpylen);
299             pret += cpylen;
300         }
301         ret[retlen] = '\0';
302     }
303
304 end_strreplace:
305     /* Free the cache and return the post-replacement string,
306      * which will be NULL in the event of an error. */
307     av_free(pos_cache);
308     return ret;
309 }
310
311 const char *av_basename(const char *path)
312 {
313     char *p = strrchr(path, '/');
314
315 #if HAVE_DOS_PATHS
316     char *q = strrchr(path, '\\');
317     char *d = strchr(path, ':');
318
319     p = FFMAX3(p, q, d);
320 #endif
321
322     if (!p)
323         return path;
324
325     return p + 1;
326 }
327
328 const char *av_dirname(char *path)
329 {
330     char *p = strrchr(path, '/');
331
332 #if HAVE_DOS_PATHS
333     char *q = strrchr(path, '\\');
334     char *d = strchr(path, ':');
335
336     d = d ? d + 1 : d;
337
338     p = FFMAX3(p, q, d);
339 #endif
340
341     if (!p)
342         return ".";
343
344     *p = '\0';
345
346     return path;
347 }
348
349 char *av_append_path_component(const char *path, const char *component)
350 {
351     size_t p_len, c_len;
352     char *fullpath;
353
354     if (!path)
355         return av_strdup(component);
356     if (!component)
357         return av_strdup(path);
358
359     p_len = strlen(path);
360     c_len = strlen(component);
361     if (p_len > SIZE_MAX - c_len || p_len + c_len > SIZE_MAX - 2)
362         return NULL;
363     fullpath = av_malloc(p_len + c_len + 2);
364     if (fullpath) {
365         if (p_len) {
366             av_strlcpy(fullpath, path, p_len + 1);
367             if (c_len) {
368                 if (fullpath[p_len - 1] != '/' && component[0] != '/')
369                     fullpath[p_len++] = '/';
370                 else if (fullpath[p_len - 1] == '/' && component[0] == '/')
371                     p_len--;
372             }
373         }
374         av_strlcpy(&fullpath[p_len], component, c_len + 1);
375         fullpath[p_len + c_len] = 0;
376     }
377     return fullpath;
378 }
379
380 int av_escape(char **dst, const char *src, const char *special_chars,
381               enum AVEscapeMode mode, int flags)
382 {
383     AVBPrint dstbuf;
384
385     av_bprint_init(&dstbuf, 1, AV_BPRINT_SIZE_UNLIMITED);
386     av_bprint_escape(&dstbuf, src, special_chars, mode, flags);
387
388     if (!av_bprint_is_complete(&dstbuf)) {
389         av_bprint_finalize(&dstbuf, NULL);
390         return AVERROR(ENOMEM);
391     } else {
392         av_bprint_finalize(&dstbuf, dst);
393         return dstbuf.len;
394     }
395 }
396
397 int av_match_name(const char *name, const char *names)
398 {
399     const char *p;
400     int len, namelen;
401
402     if (!name || !names)
403         return 0;
404
405     namelen = strlen(name);
406     while (*names) {
407         int negate = '-' == *names;
408         p = strchr(names, ',');
409         if (!p)
410             p = names + strlen(names);
411         names += negate;
412         len = FFMAX(p - names, namelen);
413         if (!av_strncasecmp(name, names, len) || !strncmp("ALL", names, FFMAX(3, p - names)))
414             return !negate;
415         names = p + (*p == ',');
416     }
417     return 0;
418 }
419
420 int av_utf8_decode(int32_t *codep, const uint8_t **bufp, const uint8_t *buf_end,
421                    unsigned int flags)
422 {
423     const uint8_t *p = *bufp;
424     uint32_t top;
425     uint64_t code;
426     int ret = 0, tail_len;
427     uint32_t overlong_encoding_mins[6] = {
428         0x00000000, 0x00000080, 0x00000800, 0x00010000, 0x00200000, 0x04000000,
429     };
430
431     if (p >= buf_end)
432         return 0;
433
434     code = *p++;
435
436     /* first sequence byte starts with 10, or is 1111-1110 or 1111-1111,
437        which is not admitted */
438     if ((code & 0xc0) == 0x80 || code >= 0xFE) {
439         ret = AVERROR(EILSEQ);
440         goto end;
441     }
442     top = (code & 128) >> 1;
443
444     tail_len = 0;
445     while (code & top) {
446         int tmp;
447         tail_len++;
448         if (p >= buf_end) {
449             (*bufp) ++;
450             return AVERROR(EILSEQ); /* incomplete sequence */
451         }
452
453         /* we assume the byte to be in the form 10xx-xxxx */
454         tmp = *p++ - 128;   /* strip leading 1 */
455         if (tmp>>6) {
456             (*bufp) ++;
457             return AVERROR(EILSEQ);
458         }
459         code = (code<<6) + tmp;
460         top <<= 5;
461     }
462     code &= (top << 1) - 1;
463
464     /* check for overlong encodings */
465     av_assert0(tail_len <= 5);
466     if (code < overlong_encoding_mins[tail_len]) {
467         ret = AVERROR(EILSEQ);
468         goto end;
469     }
470
471     if (code >= 1U<<31) {
472         ret = AVERROR(EILSEQ);  /* out-of-range value */
473         goto end;
474     }
475
476     *codep = code;
477
478     if (code > 0x10FFFF &&
479         !(flags & AV_UTF8_FLAG_ACCEPT_INVALID_BIG_CODES))
480         ret = AVERROR(EILSEQ);
481     if (code < 0x20 && code != 0x9 && code != 0xA && code != 0xD &&
482         flags & AV_UTF8_FLAG_EXCLUDE_XML_INVALID_CONTROL_CODES)
483         ret = AVERROR(EILSEQ);
484     if (code >= 0xD800 && code <= 0xDFFF &&
485         !(flags & AV_UTF8_FLAG_ACCEPT_SURROGATES))
486         ret = AVERROR(EILSEQ);
487     if ((code == 0xFFFE || code == 0xFFFF) &&
488         !(flags & AV_UTF8_FLAG_ACCEPT_NON_CHARACTERS))
489         ret = AVERROR(EILSEQ);
490
491 end:
492     *bufp = p;
493     return ret;
494 }
495
496 int av_match_list(const char *name, const char *list, char separator)
497 {
498     const char *p, *q;
499
500     for (p = name; p && *p; ) {
501         for (q = list; q && *q; ) {
502             int k;
503             for (k = 0; p[k] == q[k] || (p[k]*q[k] == 0 && p[k]+q[k] == separator); k++)
504                 if (k && (!p[k] || p[k] == separator))
505                     return 1;
506             q = strchr(q, separator);
507             q += !!q;
508         }
509         p = strchr(p, separator);
510         p += !!p;
511     }
512
513     return 0;
514 }