1ba62ede3f7d4704bbd41820dc789ca73b50f6b7
[asterisk/asterisk.git] / include / asterisk / strings.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief String manipulation functions
21  */
22
23 #ifndef _ASTERISK_STRINGS_H
24 #define _ASTERISK_STRINGS_H
25
26 #include "asterisk/inline_api.h"
27 #include "asterisk/utils.h"
28 #include "asterisk/threadstorage.h"
29
30 /* You may see casts in this header that may seem useless but they ensure this file is C++ clean */
31
32 static force_inline int ast_strlen_zero(const char *s)
33 {
34         return (!s || (*s == '\0'));
35 }
36
37 /*! \brief returns the equivalent of logic or for strings:
38  * first one if not empty, otherwise second one.
39  */
40 #define S_OR(a, b)           (!ast_strlen_zero(a) ? (a) : (b))
41
42 /*! \brief returns the equivalent of logic or for strings, with an additional boolean check:
43  * second one if not empty and first one is true, otherwise third one.
44  * example: S_COR(usewidget, widget, "<no widget>")
45  */
46 #define S_COR(a, b, c)   ((a && !ast_strlen_zero(b)) ? (b) : (c))
47
48 /*!
49   \brief Gets a pointer to the first non-whitespace character in a string.
50   \param ast_skip_blanks function being used
51   \arg str the input string
52   \return a pointer to the first non-whitespace character
53  */
54 AST_INLINE_API(
55 char *ast_skip_blanks(const char *str),
56 {
57         while (*str && ((unsigned char) *str) < 33)
58                 str++;
59         return (char *)str;
60 }
61 )
62
63 /*!
64   \brief Trims trailing whitespace characters from a string.
65   \param ast_skip_blanks function being used
66   \arg str the input string
67   \return a pointer to the modified string
68  */
69 AST_INLINE_API(
70 char *ast_trim_blanks(char *str),
71 {
72         char *work = str;
73
74         if (work) {
75                 work += strlen(work) - 1;
76                 /* It's tempting to only want to erase after we exit this loop, 
77                    but since ast_trim_blanks *could* receive a constant string
78                    (which we presumably wouldn't have to touch), we shouldn't
79                    actually set anything unless we must, and it's easier just
80                    to set each position to \0 than to keep track of a variable
81                    for it */
82                 while ((work >= str) && ((unsigned char) *work) < 33)
83                         *(work--) = '\0';
84         }
85         return str;
86 }
87 )
88
89 /*!
90   \brief Gets a pointer to first whitespace character in a string.
91   \param ast_skip_noblanks function being used
92   \arg str the input string
93   \return a pointer to the first whitespace character
94  */
95 AST_INLINE_API(
96 char *ast_skip_nonblanks(char *str),
97 {
98         while (*str && ((unsigned char) *str) > 32)
99                 str++;
100         return str;
101 }
102 )
103   
104 /*!
105   \brief Strip leading/trailing whitespace from a string.
106   \param ast_strip function ast_strip being used.
107   \arg s The string to be stripped (will be modified).
108   \return The stripped string.
109
110   This functions strips all leading and trailing whitespace
111   characters from the input string, and returns a pointer to
112   the resulting string. The string is modified in place.
113 */
114 AST_INLINE_API(
115 char *ast_strip(char *s),
116 {
117         s = ast_skip_blanks(s);
118         if (s)
119                 ast_trim_blanks(s);
120         return s;
121
122 )
123
124 /*!
125   \brief Strip leading/trailing whitespace and quotes from a string.
126   \param s The string to be stripped (will be modified).
127   \param beg_quotes The list of possible beginning quote characters.
128   \param end_quotes The list of matching ending quote characters.
129   \return The stripped string.
130
131   This functions strips all leading and trailing whitespace
132   characters from the input string, and returns a pointer to
133   the resulting string. The string is modified in place.
134
135   It can also remove beginning and ending quote (or quote-like)
136   characters, in matching pairs. If the first character of the
137   string matches any character in beg_quotes, and the last
138   character of the string is the matching character in
139   end_quotes, then they are removed from the string.
140
141   Examples:
142   \code
143   ast_strip_quoted(buf, "\"", "\"");
144   ast_strip_quoted(buf, "'", "'");
145   ast_strip_quoted(buf, "[{(", "]})");
146   \endcode
147  */
148 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
149
150 /*!
151   \brief Strip backslash for "escaped" semicolons.
152   \brief s The string to be stripped (will be modified).
153   \return The stripped string.
154  */
155 char *ast_unescape_semicolon(char *s);
156
157 /*!
158   \brief Size-limited null-terminating string copy.
159   \arg dst The destination buffer.
160   \arg src The source string
161   \arg size The size of the destination buffer
162   \return Nothing.
163
164   This is similar to \a strncpy, with two important differences:
165     - the destination buffer will \b always be null-terminated
166     - the destination buffer is not filled with zeros past the copied string length
167   These differences make it slightly more efficient, and safer to use since it will
168   not leave the destination buffer unterminated. There is no need to pass an artificially
169   reduced buffer size to this function (unlike \a strncpy), and the buffer does not need
170   to be initialized to zeroes prior to calling this function.
171 */
172 AST_INLINE_API(
173 void ast_copy_string(char *dst, const char *src, size_t size),
174 {
175         while (*src && size) {
176                 *dst++ = *src++;
177                 size--;
178         }
179         if (__builtin_expect(!size, 0))
180                 dst--;
181         *dst = '\0';
182 }
183 )
184
185
186 /*!
187   \brief Build a string in a buffer, designed to be called repeatedly
188   
189   \note This method is not recommended. New code should use ast_str_*() instead.
190
191   This is a wrapper for snprintf, that properly handles the buffer pointer
192   and buffer space available.
193
194   \arg buffer current position in buffer to place string into (will be updated on return)
195   \arg space remaining space in buffer (will be updated on return)
196   \arg fmt printf-style format string
197   \retval 0 on success
198   \retval non-zero on failure.
199 */
200 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__ ((format (printf, 3, 4)));
201
202 /*!
203   \brief Build a string in a buffer, designed to be called repeatedly
204   
205   This is a wrapper for snprintf, that properly handles the buffer pointer
206   and buffer space available.
207
208   \return 0 on success, non-zero on failure.
209   \param buffer current position in buffer to place string into (will be updated on return)
210   \param space remaining space in buffer (will be updated on return)
211   \param fmt printf-style format string
212   \param ap varargs list of arguments for format
213 */
214 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap);
215
216 /*! 
217  * \brief Make sure something is true.
218  * Determine if a string containing a boolean value is "true".
219  * This function checks to see whether a string passed to it is an indication of an "true" value.  
220  * It checks to see if the string is "yes", "true", "y", "t", "on" or "1".  
221  *
222  * \retval 0 if val is a NULL pointer.
223  * \retval -1 if "true".
224  * \retval 0 otherwise.
225  */
226 int ast_true(const char *val);
227
228 /*! 
229  * \brief Make sure something is false.
230  * Determine if a string containing a boolean value is "false".
231  * This function checks to see whether a string passed to it is an indication of an "false" value.  
232  * It checks to see if the string is "no", "false", "n", "f", "off" or "0".  
233  *
234  * \retval 0 if val is a NULL pointer.
235  * \retval -1 if "true".
236  * \retval 0 otherwise.
237  */
238 int ast_false(const char *val);
239
240 /*
241  *  \brief Join an array of strings into a single string.
242  * \param s the resulting string buffer
243  * \param len the length of the result buffer, s
244  * \param w an array of strings to join.
245  *
246  * This function will join all of the strings in the array 'w' into a single
247  * string.  It will also place a space in the result buffer in between each
248  * string from 'w'.
249 */
250 void ast_join(char *s, size_t len, char * const w[]);
251
252 /*
253   \brief Parse a time (integer) string.
254   \param src String to parse
255   \param dst Destination
256   \param _default Value to use if the string does not contain a valid time
257   \param consumed The number of characters 'consumed' in the string by the parse (see 'man sscanf' for details)
258   \retval 0 on success
259   \retval non-zero on failure.
260 */
261 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed);
262
263 /*
264   \brief Parse a time (float) string.
265   \param src String to parse
266   \param dst Destination
267   \param _default Value to use if the string does not contain a valid time
268   \param consumed The number of characters 'consumed' in the string by the parse (see 'man sscanf' for details)
269   \return zero on success, non-zero on failure
270 */
271 int ast_get_timeval(const char *src, struct timeval *tv, struct timeval _default, int *consumed);
272
273 /*!
274  * Support for dynamic strings.
275  *
276  * A dynamic string is just a C string prefixed by a few control fields
277  * that help setting/appending/extending it using a printf-like syntax.
278  *
279  * One should never declare a variable with this type, but only a pointer
280  * to it, e.g.
281  *
282  *      struct ast_str *ds;
283  *
284  * The pointer can be initialized with the following:
285  *
286  *      ds = ast_str_create(init_len);
287  *              creates a malloc()'ed dynamic string;
288  *
289  *      ds = ast_str_alloca(init_len);
290  *              creates a string on the stack (not very dynamic!).
291  *
292  *      ds = ast_str_thread_get(ts, init_len)
293  *              creates a malloc()'ed dynamic string associated to
294  *              the thread-local storage key ts
295  *
296  * Finally, the string can be manipulated with the following:
297  *
298  *      ast_str_set(&buf, max_len, fmt, ...)
299  *      ast_str_append(&buf, max_len, fmt, ...)
300  *
301  * and their varargs variant
302  *
303  *      ast_str_set_va(&buf, max_len, ap)
304  *      ast_str_append_va(&buf, max_len, ap)
305  *
306  * \arg max_len The maximum allowed length, reallocating if needed.
307  *      0 means unlimited, -1 means "at most the available space"
308  *
309  * \return All the functions return <0 in case of error, or the
310  *      length of the string added to the buffer otherwise.
311  */
312
313 /*! \brief The descriptor of a dynamic string
314  *  XXX storage will be optimized later if needed
315  * We use the ts field to indicate the type of storage.
316  * Three special constants indicate malloc, alloca() or static
317  * variables, all other values indicate a
318  * struct ast_threadstorage pointer.
319  */
320 struct ast_str {
321         size_t len;     /*!< The current maximum length of the string */
322         size_t used;    /*!< Amount of space used */
323         struct ast_threadstorage *ts;   /*!< What kind of storage is this ? */
324 #define DS_MALLOC       ((struct ast_threadstorage *)1)
325 #define DS_ALLOCA       ((struct ast_threadstorage *)2)
326 #define DS_STATIC       ((struct ast_threadstorage *)3) /* not supported yet */
327         char str[0];    /*!< The string buffer */
328 };
329
330 /*!
331  * \brief Create a malloc'ed dynamic length string
332  *
333  * \arg init_len This is the initial length of the string buffer
334  *
335  * \return This function returns a pointer to the dynamic string length.  The
336  *         result will be NULL in the case of a memory allocation error.
337  *
338  * \note The result of this function is dynamically allocated memory, and must
339  *       be free()'d after it is no longer needed.
340  */
341 AST_INLINE_API(
342 struct ast_str * attribute_malloc ast_str_create(size_t init_len),
343 {
344         struct ast_str *buf;
345
346         buf = (struct ast_str *)ast_calloc(1, sizeof(*buf) + init_len);
347         if (buf == NULL)
348                 return NULL;
349         
350         buf->len = init_len;
351         buf->used = 0;
352         buf->ts = DS_MALLOC;
353
354         return buf;
355 }
356 )
357
358 /*! \brief Reset the content of a dynamic string.
359  * Useful before a series of ast_str_append.
360  */
361 AST_INLINE_API(
362 void ast_str_reset(struct ast_str *buf),
363 {
364         if (buf) {
365                 buf->used = 0;
366                 if (buf->len)
367                         buf->str[0] = '\0';
368         }
369 }
370 )
371
372 /*
373  * AST_INLINE_API() is a macro that takes a block of code as an argument.
374  * Using preprocessor #directives in the argument is not supported by all
375  * compilers, and it is a bit of an obfuscation anyways, so avoid it.
376  * As a workaround, define a macro that produces either its argument
377  * or nothing, and use that instead of #ifdef/#endif within the
378  * argument to AST_INLINE_API().
379  */
380 #if defined(DEBUG_THREADLOCALS)
381 #define _DB1(x) x
382 #else
383 #define _DB1(x)
384 #endif
385
386 /*!
387  * Make space in a new string (e.g. to read in data from a file)
388  */
389 AST_INLINE_API(
390 int ast_str_make_space(struct ast_str **buf, size_t new_len),
391 {
392         _DB1(struct ast_str *old_buf = *buf;)
393
394         if (new_len <= (*buf)->len) 
395                 return 0;       /* success */
396         if ((*buf)->ts == DS_ALLOCA || (*buf)->ts == DS_STATIC)
397                 return -1;      /* cannot extend */
398         *buf = (struct ast_str *)ast_realloc(*buf, new_len + sizeof(struct ast_str));
399         if (*buf == NULL) /* XXX watch out, we leak memory here */
400                 return -1;
401         if ((*buf)->ts != DS_MALLOC) {
402                 pthread_setspecific((*buf)->ts->key, *buf);
403                 _DB1(__ast_threadstorage_object_replace(old_buf, *buf, new_len + sizeof(struct ast_str));)
404         }
405
406         (*buf)->len = new_len;
407         return 0;
408 }
409 )
410
411 #define ast_str_alloca(init_len)                        \
412         ({                                              \
413                 struct ast_str *buf;                    \
414                 buf = alloca(sizeof(*buf) + init_len);  \
415                 buf->len = init_len;                    \
416                 buf->used = 0;                          \
417                 buf->ts = DS_ALLOCA;                    \
418                 buf->str[0] = '\0';                     \
419                 (buf);                                  \
420         })
421
422 /*!
423  * \brief Retrieve a thread locally stored dynamic string
424  *
425  * \arg ts This is a pointer to the thread storage structure declared by using
426  *      the AST_THREADSTORAGE macro.  If declared with 
427  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
428  *      (&my_buf).
429  * \arg init_len This is the initial length of the thread's dynamic string. The
430  *      current length may be bigger if previous operations in this thread have
431  *      caused it to increase.
432  *
433  * \return This function will return the thread locally stored dynamic string
434  *         associated with the thread storage management variable passed as the
435  *         first argument.
436  *         The result will be NULL in the case of a memory allocation error.
437  *
438  * Example usage:
439  * \code
440  * AST_THREADSTORAGE(my_str, my_str_init);
441  * #define MY_STR_INIT_SIZE   128
442  * ...
443  * void my_func(const char *fmt, ...)
444  * {
445  *      struct ast_str *buf;
446  *
447  *      if (!(buf = ast_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
448  *           return;
449  *      ...
450  * }
451  * \endcode
452  */
453 #if !defined(DEBUG_THREADLOCALS)
454 AST_INLINE_API(
455 struct ast_str *ast_str_thread_get(struct ast_threadstorage *ts,
456         size_t init_len),
457 {
458         struct ast_str *buf;
459
460         buf = (struct ast_str *)ast_threadstorage_get(ts, sizeof(*buf) + init_len);
461         if (buf == NULL)
462                 return NULL;
463         
464         if (!buf->len) {
465                 buf->len = init_len;
466                 buf->used = 0;
467                 buf->ts = ts;
468         }
469
470         return buf;
471 }
472 )
473 #else /* defined(DEBUG_THREADLOCALS) */
474 AST_INLINE_API(
475 struct ast_str *__ast_str_thread_get(struct ast_threadstorage *ts,
476         size_t init_len, const char *file, const char *function, unsigned int line),
477 {
478         struct ast_str *buf;
479
480         buf = (struct ast_str *)__ast_threadstorage_get(ts, sizeof(*buf) + init_len, file, function, line);
481         if (buf == NULL)
482                 return NULL;
483         
484         if (!buf->len) {
485                 buf->len = init_len;
486                 buf->used = 0;
487                 buf->ts = ts;
488         }
489
490         return buf;
491 }
492 )
493
494 #define ast_str_thread_get(ts, init_len) __ast_str_thread_get(ts, init_len, __FILE__, __PRETTY_FUNCTION__, __LINE__)
495 #endif /* defined(DEBUG_THREADLOCALS) */
496
497 /*!
498  * \brief Error codes from __ast_str_helper()
499  * The undelying processing to manipulate dynamic string is done
500  * by __ast_str_helper(), which can return a success, a
501  * permanent failure (e.g. no memory), or a temporary one (when
502  * the string needs to be reallocated, and we must run va_start()
503  * again; XXX this convoluted interface is only here because
504  * FreeBSD 4 lacks va_copy, but this will be fixed and the
505  * interface simplified).
506  */
507 enum {
508         /*! An error has occured and the contents of the dynamic string
509          *  are undefined */
510         AST_DYNSTR_BUILD_FAILED = -1,
511         /*! The buffer size for the dynamic string had to be increased, and
512          *  __ast_str_helper() needs to be called again after
513          *  a va_end() and va_start().
514          */
515         AST_DYNSTR_BUILD_RETRY = -2
516 };
517
518 /*!
519  * \brief Set a dynamic string from a va_list
520  *
521  * \arg buf This is the address of a pointer to a struct ast_str.
522  *      If it is retrieved using ast_str_thread_get, the
523         struct ast_threadstorage pointer will need to
524  *      be updated in the case that the buffer has to be reallocated to
525  *      accommodate a longer string than what it currently has space for.
526  * \arg max_len This is the maximum length to allow the string buffer to grow
527  *      to.  If this is set to 0, then there is no maximum length.
528  * \arg fmt This is the format string (printf style)
529  * \arg ap This is the va_list
530  *
531  * \return The return value of this function is the same as that of the printf
532  *         family of functions.
533  *
534  * Example usage (the first part is only for thread-local storage)
535  * \code
536  * AST_THREADSTORAGE(my_str, my_str_init);
537  * #define MY_STR_INIT_SIZE   128
538  * ...
539  * void my_func(const char *fmt, ...)
540  * {
541  *      struct ast_str *buf;
542  *      va_list ap;
543  *
544  *      if (!(buf = ast_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
545  *           return;
546  *      ...
547  *      va_start(fmt, ap);
548  *      ast_str_set_va(&buf, 0, fmt, ap);
549  *      va_end(ap);
550  * 
551  *      printf("This is the string we just built: %s\n", buf->str);
552  *      ...
553  * }
554  * \endcode
555  *
556  * \note: the following two functions must be implemented as macros
557  *      because we must do va_end()/va_start() on the original arguments.
558  */
559 #define ast_str_set_va(buf, max_len, fmt, ap)                   \
560         ({                                                              \
561                 int __res;                                              \
562                 while ((__res = __ast_str_helper(buf, max_len,          \
563                         0, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {       \
564                         va_end(ap);                                     \
565                         va_start(ap, fmt);                              \
566                 }                                                       \
567                 (__res);                                                \
568         })
569
570 /*!
571  * \brief Append to a dynamic string using a va_list
572  *
573  * Same as ast_str_set_va(), but append to the current content.
574  */
575 #define ast_str_append_va(buf, max_len, fmt, ap)                \
576         ({                                                              \
577                 int __res;                                              \
578                 while ((__res = __ast_str_helper(buf, max_len,          \
579                         1, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {       \
580                         va_end(ap);                                     \
581                         va_start(ap, fmt);                              \
582                 }                                                       \
583                 (__res);                                                \
584         })
585
586 /*!
587  * \brief Core functionality of ast_str_(set|append)_va
588  *
589  * The arguments to this function are the same as those described for
590  * ast_str_set_va except for an addition argument, append.
591  * If append is non-zero, this will append to the current string instead of
592  * writing over it.
593  *
594  * In the case that this function is called and the buffer was not large enough
595  * to hold the result, the partial write will be truncated, and the result
596  * AST_DYNSTR_BUILD_RETRY will be returned to indicate that the buffer size
597  * was increased, and the function should be called a second time.
598  *
599  * A return of AST_DYNSTR_BUILD_FAILED indicates a memory allocation error.
600  *
601  * A return value greater than or equal to zero indicates the number of
602  * characters that have been written, not including the terminating '\0'.
603  * In the append case, this only includes the number of characters appended.
604  *
605  * \note This function should never need to be called directly.  It should
606  *       through calling one of the other functions or macros defined in this
607  *       file.
608  */
609 int __ast_str_helper(struct ast_str **buf, size_t max_len,
610         int append, const char *fmt, va_list ap);
611
612 /*!
613  * \brief Set a dynamic string using variable arguments
614  *
615  * \arg buf This is the address of a pointer to a struct ast_str which should
616  *      have been retrieved using ast_str_thread_get.  It will need to
617  *      be updated in the case that the buffer has to be reallocated to
618  *      accomodate a longer string than what it currently has space for.
619  * \arg max_len This is the maximum length to allow the string buffer to grow
620  *      to.  If this is set to 0, then there is no maximum length.
621  *      If set to -1, we are bound to the current maximum length.
622  * \arg fmt This is the format string (printf style)
623  *
624  * \return The return value of this function is the same as that of the printf
625  *         family of functions.
626  *
627  * All the rest is the same as ast_str_set_va()
628  */
629 AST_INLINE_API(
630 int __attribute__ ((format (printf, 3, 4))) ast_str_set(
631         struct ast_str **buf, size_t max_len, const char *fmt, ...),
632 {
633         int res;
634         va_list ap;
635
636         va_start(ap, fmt);
637         res = ast_str_set_va(buf, max_len, fmt, ap);
638         va_end(ap);
639
640         return res;
641 }
642 )
643
644 /*!
645  * \brief Append to a thread local dynamic string
646  *
647  * The arguments, return values, and usage of this function are the same as
648  * ast_str_set(), but the new data is appended to the current value.
649  */
650 AST_INLINE_API(
651 int __attribute__ ((format (printf, 3, 4))) ast_str_append(
652         struct ast_str **buf, size_t max_len, const char *fmt, ...),
653 {
654         int res;
655         va_list ap;
656
657         va_start(ap, fmt);
658         res = ast_str_append_va(buf, max_len, fmt, ap);
659         va_end(ap);
660
661         return res;
662 }
663 )
664
665 /*!
666  * \brief Compute a hash value on a string
667  *
668  * This famous hash algorithm was written by Dan Bernstein and is
669  * commonly used.
670  *
671  * http://www.cse.yorku.ca/~oz/hash.html
672  */
673 static force_inline int ast_str_hash(const char *str)
674 {
675         int hash = 5381;
676
677         while (*str)
678                 hash = hash * 33 ^ *str++;
679
680         return abs(hash);
681 }
682
683 #endif /* _ASTERISK_STRINGS_H */