Add support for GROUP_MATCH_COUNT regex matching on category
[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 /* #define DEBUG_OPAQUE */
27
28 #include <ctype.h>
29
30 #include "asterisk/utils.h"
31 #include "asterisk/threadstorage.h"
32
33 #if defined(DEBUG_OPAQUE)
34 #define __AST_STR_USED used2
35 #define __AST_STR_LEN len2
36 #define __AST_STR_STR str2
37 #define __AST_STR_TS ts2
38 #else
39 #define __AST_STR_USED used
40 #define __AST_STR_LEN len
41 #define __AST_STR_STR str
42 #define __AST_STR_TS ts
43 #endif
44
45 /* You may see casts in this header that may seem useless but they ensure this file is C++ clean */
46
47 #define AS_OR(a,b)      (a && ast_str_strlen(a)) ? ast_str_buffer(a) : (b)
48
49 #ifdef AST_DEVMODE
50 #define ast_strlen_zero(foo)    _ast_strlen_zero(foo, __FILE__, __PRETTY_FUNCTION__, __LINE__)
51 static force_inline int _ast_strlen_zero(const char *s, const char *file, const char *function, int line)
52 {
53         if (!s || (*s == '\0')) {
54                 return 1;
55         }
56         if (!strcmp(s, "(null)")) {
57                 ast_log(__LOG_WARNING, file, line, function, "Possible programming error: \"(null)\" is not NULL!\n");
58         }
59         return 0;
60 }
61
62 #else
63 static force_inline int attribute_pure ast_strlen_zero(const char *s)
64 {
65         return (!s || (*s == '\0'));
66 }
67 #endif
68
69 #ifdef SENSE_OF_HUMOR
70 #define ast_strlen_real(a)      (a) ? strlen(a) : 0
71 #define ast_strlen_imaginary(a) ast_random()
72 #endif
73
74 /*! \brief returns the equivalent of logic or for strings:
75  * first one if not empty, otherwise second one.
76  */
77 #define S_OR(a, b) ({typeof(&((a)[0])) __x = (a); ast_strlen_zero(__x) ? (b) : __x;})
78
79 /*! \brief returns the equivalent of logic or for strings, with an additional boolean check:
80  * second one if not empty and first one is true, otherwise third one.
81  * example: S_COR(usewidget, widget, "<no widget>")
82  */
83 #define S_COR(a, b, c) ({typeof(&((b)[0])) __x = (b); (a) && !ast_strlen_zero(__x) ? (__x) : (c);})
84
85 /*!
86   \brief Gets a pointer to the first non-whitespace character in a string.
87   \param str the input string
88   \return a pointer to the first non-whitespace character
89  */
90 AST_INLINE_API(
91 char * attribute_pure ast_skip_blanks(const char *str),
92 {
93         while (*str && ((unsigned char) *str) < 33)
94                 str++;
95         return (char *) str;
96 }
97 )
98
99 /*!
100   \brief Trims trailing whitespace characters from a string.
101   \param str the input string
102   \return a pointer to the modified string
103  */
104 AST_INLINE_API(
105 char *ast_trim_blanks(char *str),
106 {
107         char *work = str;
108
109         if (work) {
110                 work += strlen(work) - 1;
111                 /* It's tempting to only want to erase after we exit this loop, 
112                    but since ast_trim_blanks *could* receive a constant string
113                    (which we presumably wouldn't have to touch), we shouldn't
114                    actually set anything unless we must, and it's easier just
115                    to set each position to \0 than to keep track of a variable
116                    for it */
117                 while ((work >= str) && ((unsigned char) *work) < 33)
118                         *(work--) = '\0';
119         }
120         return str;
121 }
122 )
123
124 /*!
125   \brief Gets a pointer to first whitespace character in a string.
126   \param str the input string
127   \return a pointer to the first whitespace character
128  */
129 AST_INLINE_API(
130 char * attribute_pure ast_skip_nonblanks(const char *str),
131 {
132         while (*str && ((unsigned char) *str) > 32)
133                 str++;
134         return (char *) str;
135 }
136 )
137   
138 /*!
139   \brief Strip leading/trailing whitespace from a string.
140   \param s The string to be stripped (will be modified).
141   \return The stripped string.
142
143   This functions strips all leading and trailing whitespace
144   characters from the input string, and returns a pointer to
145   the resulting string. The string is modified in place.
146 */
147 AST_INLINE_API(
148 char *ast_strip(char *s),
149 {
150         if ((s = ast_skip_blanks(s))) {
151                 ast_trim_blanks(s);
152         }
153         return s;
154
155 )
156
157 /*!
158   \brief Strip leading/trailing whitespace and quotes from a string.
159   \param s The string to be stripped (will be modified).
160   \param beg_quotes The list of possible beginning quote characters.
161   \param end_quotes The list of matching ending quote characters.
162   \return The stripped string.
163
164   This functions strips all leading and trailing whitespace
165   characters from the input string, and returns a pointer to
166   the resulting string. The string is modified in place.
167
168   It can also remove beginning and ending quote (or quote-like)
169   characters, in matching pairs. If the first character of the
170   string matches any character in beg_quotes, and the last
171   character of the string is the matching character in
172   end_quotes, then they are removed from the string.
173
174   Examples:
175   \code
176   ast_strip_quoted(buf, "\"", "\"");
177   ast_strip_quoted(buf, "'", "'");
178   ast_strip_quoted(buf, "[{(", "]})");
179   \endcode
180  */
181 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
182
183 /*!
184   \brief Strip backslash for "escaped" semicolons, 
185         the string to be stripped (will be modified).
186   \return The stripped string.
187  */
188 char *ast_unescape_semicolon(char *s);
189
190 /*!
191   \brief Convert some C escape sequences  \verbatim (\b\f\n\r\t) \endverbatim into the
192         equivalent characters. The string to be converted (will be modified).
193   \return The converted string.
194  */
195 char *ast_unescape_c(char *s);
196
197 /*!
198   \brief Size-limited null-terminating string copy.
199   \param dst The destination buffer.
200   \param src The source string
201   \param size The size of the destination buffer
202   \return Nothing.
203
204   This is similar to \a strncpy, with two important differences:
205     - the destination buffer will \b always be null-terminated
206     - the destination buffer is not filled with zeros past the copied string length
207   These differences make it slightly more efficient, and safer to use since it will
208   not leave the destination buffer unterminated. There is no need to pass an artificially
209   reduced buffer size to this function (unlike \a strncpy), and the buffer does not need
210   to be initialized to zeroes prior to calling this function.
211 */
212 AST_INLINE_API(
213 void ast_copy_string(char *dst, const char *src, size_t size),
214 {
215         while (*src && size) {
216                 *dst++ = *src++;
217                 size--;
218         }
219         if (__builtin_expect(!size, 0))
220                 dst--;
221         *dst = '\0';
222 }
223 )
224
225 /*!
226   \brief Build a string in a buffer, designed to be called repeatedly
227   
228   \note This method is not recommended. New code should use ast_str_*() instead.
229
230   This is a wrapper for snprintf, that properly handles the buffer pointer
231   and buffer space available.
232
233   \param buffer current position in buffer to place string into (will be updated on return)
234   \param space remaining space in buffer (will be updated on return)
235   \param fmt printf-style format string
236   \retval 0 on success
237   \retval non-zero on failure.
238 */
239 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__((format(printf, 3, 4)));
240
241 /*!
242   \brief Build a string in a buffer, designed to be called repeatedly
243   
244   This is a wrapper for snprintf, that properly handles the buffer pointer
245   and buffer space available.
246
247   \return 0 on success, non-zero on failure.
248   \param buffer current position in buffer to place string into (will be updated on return)
249   \param space remaining space in buffer (will be updated on return)
250   \param fmt printf-style format string
251   \param ap varargs list of arguments for format
252 */
253 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap) __attribute__((format(printf, 3, 0)));
254
255 /*! 
256  * \brief Make sure something is true.
257  * Determine if a string containing a boolean value is "true".
258  * This function checks to see whether a string passed to it is an indication of an "true" value.  
259  * It checks to see if the string is "yes", "true", "y", "t", "on" or "1".  
260  *
261  * \retval 0 if val is a NULL pointer.
262  * \retval -1 if "true".
263  * \retval 0 otherwise.
264  */
265 int attribute_pure ast_true(const char *val);
266
267 /*! 
268  * \brief Make sure something is false.
269  * Determine if a string containing a boolean value is "false".
270  * This function checks to see whether a string passed to it is an indication of an "false" value.  
271  * It checks to see if the string is "no", "false", "n", "f", "off" or "0".  
272  *
273  * \retval 0 if val is a NULL pointer.
274  * \retval -1 if "true".
275  * \retval 0 otherwise.
276  */
277 int attribute_pure ast_false(const char *val);
278
279 /*
280  *  \brief Join an array of strings into a single string.
281  * \param s the resulting string buffer
282  * \param len the length of the result buffer, s
283  * \param w an array of strings to join.
284  *
285  * This function will join all of the strings in the array 'w' into a single
286  * string.  It will also place a space in the result buffer in between each
287  * string from 'w'.
288 */
289 void ast_join(char *s, size_t len, const char * const w[]);
290
291 /*
292   \brief Parse a time (integer) string.
293   \param src String to parse
294   \param dst Destination
295   \param _default Value to use if the string does not contain a valid time
296   \param consumed The number of characters 'consumed' in the string by the parse (see 'man sscanf' for details)
297   \retval 0 on success
298   \retval non-zero on failure.
299 */
300 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed);
301
302 /*
303   \brief Parse a time (float) string.
304   \param src String to parse
305   \param dst Destination
306   \param _default Value to use if the string does not contain a valid time
307   \param consumed The number of characters 'consumed' in the string by the parse (see 'man sscanf' for details)
308   \return zero on success, non-zero on failure
309 */
310 int ast_get_timeval(const char *src, struct timeval *tv, struct timeval _default, int *consumed);
311
312 /*!
313  * Support for dynamic strings.
314  *
315  * A dynamic string is just a C string prefixed by a few control fields
316  * that help setting/appending/extending it using a printf-like syntax.
317  *
318  * One should never declare a variable with this type, but only a pointer
319  * to it, e.g.
320  *
321  *      struct ast_str *ds;
322  *
323  * The pointer can be initialized with the following:
324  *
325  *      ds = ast_str_create(init_len);
326  *              creates a malloc()'ed dynamic string;
327  *
328  *      ds = ast_str_alloca(init_len);
329  *              creates a string on the stack (not very dynamic!).
330  *
331  *      ds = ast_str_thread_get(ts, init_len)
332  *              creates a malloc()'ed dynamic string associated to
333  *              the thread-local storage key ts
334  *
335  * Finally, the string can be manipulated with the following:
336  *
337  *      ast_str_set(&buf, max_len, fmt, ...)
338  *      ast_str_append(&buf, max_len, fmt, ...)
339  *
340  * and their varargs variant
341  *
342  *      ast_str_set_va(&buf, max_len, ap)
343  *      ast_str_append_va(&buf, max_len, ap)
344  *
345  * \param max_len The maximum allowed capacity of the ast_str. Note that
346  *  if the value of max_len is less than the current capacity of the
347  *  ast_str (as returned by ast_str_size), then the parameter is effectively
348  *  ignored.
349  *      0 means unlimited, -1 means "at most the available space"
350  *
351  * \return All the functions return <0 in case of error, or the
352  *      length of the string added to the buffer otherwise. Note that
353  *      in most cases where an error is returned, characters ARE written
354  *      to the ast_str.
355  */
356
357 /*! \brief The descriptor of a dynamic string
358  *  XXX storage will be optimized later if needed
359  * We use the ts field to indicate the type of storage.
360  * Three special constants indicate malloc, alloca() or static
361  * variables, all other values indicate a
362  * struct ast_threadstorage pointer.
363  */
364 struct ast_str {
365         size_t __AST_STR_LEN;                   /*!< The current maximum length of the string */
366         size_t __AST_STR_USED;                  /*!< Amount of space used */
367         struct ast_threadstorage *__AST_STR_TS; /*!< What kind of storage is this ? */
368 #define DS_MALLOC       ((struct ast_threadstorage *)1)
369 #define DS_ALLOCA       ((struct ast_threadstorage *)2)
370 #define DS_STATIC       ((struct ast_threadstorage *)3) /* not supported yet */
371         char __AST_STR_STR[0];                  /*!< The string buffer */
372 };
373
374 /*!
375  * \brief Create a malloc'ed dynamic length string
376  *
377  * \param init_len This is the initial length of the string buffer
378  *
379  * \return This function returns a pointer to the dynamic string length.  The
380  *         result will be NULL in the case of a memory allocation error.
381  *
382  * \note The result of this function is dynamically allocated memory, and must
383  *       be free()'d after it is no longer needed.
384  */
385 #if (defined(MALLOC_DEBUG) && !defined(STANDALONE))
386 #define ast_str_create(a)       _ast_str_create(a,__FILE__,__LINE__,__PRETTY_FUNCTION__)
387 AST_INLINE_API(
388 struct ast_str * attribute_malloc _ast_str_create(size_t init_len,
389                 const char *file, int lineno, const char *func),
390 {
391         struct ast_str *buf;
392
393         buf = (struct ast_str *)__ast_calloc(1, sizeof(*buf) + init_len, file, lineno, func);
394         if (buf == NULL)
395                 return NULL;
396
397         buf->__AST_STR_LEN = init_len;
398         buf->__AST_STR_USED = 0;
399         buf->__AST_STR_TS = DS_MALLOC;
400
401         return buf;
402 }
403 )
404 #else
405 AST_INLINE_API(
406 struct ast_str * attribute_malloc ast_str_create(size_t init_len),
407 {
408         struct ast_str *buf;
409
410         buf = (struct ast_str *)ast_calloc(1, sizeof(*buf) + init_len);
411         if (buf == NULL)
412                 return NULL;
413
414         buf->__AST_STR_LEN = init_len;
415         buf->__AST_STR_USED = 0;
416         buf->__AST_STR_TS = DS_MALLOC;
417
418         return buf;
419 }
420 )
421 #endif
422
423 /*! \brief Reset the content of a dynamic string.
424  * Useful before a series of ast_str_append.
425  */
426 AST_INLINE_API(
427 void ast_str_reset(struct ast_str *buf),
428 {
429         if (buf) {
430                 buf->__AST_STR_USED = 0;
431                 if (buf->__AST_STR_LEN) {
432                         buf->__AST_STR_STR[0] = '\0';
433                 }
434         }
435 }
436 )
437
438 /*! \brief Update the length of the buffer, after using ast_str merely as a buffer.
439  *  \param buf A pointer to the ast_str string.
440  */
441 AST_INLINE_API(
442 void ast_str_update(struct ast_str *buf),
443 {
444         buf->__AST_STR_USED = strlen(buf->__AST_STR_STR);
445 }
446 )
447
448 /*! \brief Trims trailing whitespace characters from an ast_str string.
449  *  \param buf A pointer to the ast_str string.
450  */
451 AST_INLINE_API(
452 void ast_str_trim_blanks(struct ast_str *buf),
453 {
454         if (!buf) {
455                 return;
456         }
457         while (buf->__AST_STR_USED && buf->__AST_STR_STR[buf->__AST_STR_USED - 1] < 33) {
458                 buf->__AST_STR_STR[--(buf->__AST_STR_USED)] = '\0';
459         }
460 }
461 )
462
463 /*!\brief Returns the current length of the string stored within buf.
464  * \param buf A pointer to the ast_str structure.
465  */
466 AST_INLINE_API(
467 size_t attribute_pure ast_str_strlen(const struct ast_str *buf),
468 {
469         return buf->__AST_STR_USED;
470 }
471 )
472
473 /*!\brief Returns the current maximum length (without reallocation) of the current buffer.
474  * \param buf A pointer to the ast_str structure.
475  * \retval Current maximum length of the buffer.
476  */
477 AST_INLINE_API(
478 size_t attribute_pure ast_str_size(const struct ast_str *buf),
479 {
480         return buf->__AST_STR_LEN;
481 }
482 )
483
484 /*!\brief Returns the string buffer within the ast_str buf.
485  * \param buf A pointer to the ast_str structure.
486  * \retval A pointer to the enclosed string.
487  */
488 AST_INLINE_API(
489 char * attribute_pure ast_str_buffer(const struct ast_str *buf),
490 {
491         /* for now, cast away the const qualifier on the pointer
492          * being returned; eventually, it should become truly const
493          * and only be modified via accessor functions
494          */
495         return (char *) buf->__AST_STR_STR;
496 }
497 )
498
499 /*!\brief Truncates the enclosed string to the given length.
500  * \param buf A pointer to the ast_str structure.
501  * \param len Maximum length of the string.
502  * \retval A pointer to the resulting string.
503  */
504 AST_INLINE_API(
505 char *ast_str_truncate(struct ast_str *buf, ssize_t len),
506 {
507         if (len < 0) {
508                 buf->__AST_STR_USED += ((ssize_t) abs(len)) > (ssize_t) buf->__AST_STR_USED ? -buf->__AST_STR_USED : len;
509         } else {
510                 buf->__AST_STR_USED = len;
511         }
512         buf->__AST_STR_STR[buf->__AST_STR_USED] = '\0';
513         return buf->__AST_STR_STR;
514 }
515 )
516         
517 /*
518  * AST_INLINE_API() is a macro that takes a block of code as an argument.
519  * Using preprocessor #directives in the argument is not supported by all
520  * compilers, and it is a bit of an obfuscation anyways, so avoid it.
521  * As a workaround, define a macro that produces either its argument
522  * or nothing, and use that instead of #ifdef/#endif within the
523  * argument to AST_INLINE_API().
524  */
525 #if defined(DEBUG_THREADLOCALS)
526 #define _DB1(x) x
527 #else
528 #define _DB1(x)
529 #endif
530
531 /*!
532  * Make space in a new string (e.g. to read in data from a file)
533  */
534 #if (defined(MALLOC_DEBUG) && !defined(STANDALONE))
535 AST_INLINE_API(
536 int _ast_str_make_space(struct ast_str **buf, size_t new_len, const char *file, int lineno, const char *function),
537 {
538         struct ast_str *old_buf = *buf;
539
540         if (new_len <= (*buf)->__AST_STR_LEN) 
541                 return 0;       /* success */
542         if ((*buf)->__AST_STR_TS == DS_ALLOCA || (*buf)->__AST_STR_TS == DS_STATIC)
543                 return -1;      /* cannot extend */
544         *buf = (struct ast_str *)__ast_realloc(*buf, new_len + sizeof(struct ast_str), file, lineno, function);
545         if (*buf == NULL) {
546                 *buf = old_buf;
547                 return -1;
548         }
549         if ((*buf)->__AST_STR_TS != DS_MALLOC) {
550                 pthread_setspecific((*buf)->__AST_STR_TS->key, *buf);
551                 _DB1(__ast_threadstorage_object_replace(old_buf, *buf, new_len + sizeof(struct ast_str));)
552         }
553
554         (*buf)->__AST_STR_LEN = new_len;
555         return 0;
556 }
557 )
558 #define ast_str_make_space(a,b) _ast_str_make_space(a,b,__FILE__,__LINE__,__PRETTY_FUNCTION__)
559 #else
560 AST_INLINE_API(
561 int ast_str_make_space(struct ast_str **buf, size_t new_len),
562 {
563         struct ast_str *old_buf = *buf;
564
565         if (new_len <= (*buf)->__AST_STR_LEN) 
566                 return 0;       /* success */
567         if ((*buf)->__AST_STR_TS == DS_ALLOCA || (*buf)->__AST_STR_TS == DS_STATIC)
568                 return -1;      /* cannot extend */
569         *buf = (struct ast_str *)ast_realloc(*buf, new_len + sizeof(struct ast_str));
570         if (*buf == NULL) {
571                 *buf = old_buf;
572                 return -1;
573         }
574         if ((*buf)->__AST_STR_TS != DS_MALLOC) {
575                 pthread_setspecific((*buf)->__AST_STR_TS->key, *buf);
576                 _DB1(__ast_threadstorage_object_replace(old_buf, *buf, new_len + sizeof(struct ast_str));)
577         }
578
579         (*buf)->__AST_STR_LEN = new_len;
580         return 0;
581 }
582 )
583 #endif
584
585 #define ast_str_alloca(init_len)                        \
586         ({                                              \
587                 struct ast_str *__ast_str_buf;                  \
588                 __ast_str_buf = alloca(sizeof(*__ast_str_buf) + init_len);      \
589                 __ast_str_buf->__AST_STR_LEN = init_len;                        \
590                 __ast_str_buf->__AST_STR_USED = 0;                              \
591                 __ast_str_buf->__AST_STR_TS = DS_ALLOCA;                        \
592                 __ast_str_buf->__AST_STR_STR[0] = '\0';                 \
593                 (__ast_str_buf);                                        \
594         })
595
596 /*!
597  * \brief Retrieve a thread locally stored dynamic string
598  *
599  * \param ts This is a pointer to the thread storage structure declared by using
600  *      the AST_THREADSTORAGE macro.  If declared with 
601  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
602  *      (&my_buf).
603  * \param init_len This is the initial length of the thread's dynamic string. The
604  *      current length may be bigger if previous operations in this thread have
605  *      caused it to increase.
606  *
607  * \return This function will return the thread locally stored dynamic string
608  *         associated with the thread storage management variable passed as the
609  *         first argument.
610  *         The result will be NULL in the case of a memory allocation error.
611  *
612  * Example usage:
613  * \code
614  * AST_THREADSTORAGE(my_str, my_str_init);
615  * #define MY_STR_INIT_SIZE   128
616  * ...
617  * void my_func(const char *fmt, ...)
618  * {
619  *      struct ast_str *buf;
620  *
621  *      if (!(buf = ast_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
622  *           return;
623  *      ...
624  * }
625  * \endcode
626  */
627 #if !defined(DEBUG_THREADLOCALS)
628 AST_INLINE_API(
629 struct ast_str *ast_str_thread_get(struct ast_threadstorage *ts,
630         size_t init_len),
631 {
632         struct ast_str *buf;
633
634         buf = (struct ast_str *)ast_threadstorage_get(ts, sizeof(*buf) + init_len);
635         if (buf == NULL)
636                 return NULL;
637
638         if (!buf->__AST_STR_LEN) {
639                 buf->__AST_STR_LEN = init_len;
640                 buf->__AST_STR_USED = 0;
641                 buf->__AST_STR_TS = ts;
642         }
643
644         return buf;
645 }
646 )
647 #else /* defined(DEBUG_THREADLOCALS) */
648 AST_INLINE_API(
649 struct ast_str *__ast_str_thread_get(struct ast_threadstorage *ts,
650         size_t init_len, const char *file, const char *function, unsigned int line),
651 {
652         struct ast_str *buf;
653
654         buf = (struct ast_str *)__ast_threadstorage_get(ts, sizeof(*buf) + init_len, file, function, line);
655         if (buf == NULL)
656                 return NULL;
657
658         if (!buf->__AST_STR_LEN) {
659                 buf->__AST_STR_LEN = init_len;
660                 buf->__AST_STR_USED = 0;
661                 buf->__AST_STR_TS = ts;
662         }
663
664         return buf;
665 }
666 )
667
668 #define ast_str_thread_get(ts, init_len) __ast_str_thread_get(ts, init_len, __FILE__, __PRETTY_FUNCTION__, __LINE__)
669 #endif /* defined(DEBUG_THREADLOCALS) */
670
671 /*!
672  * \brief Error codes from __ast_str_helper()
673  * The undelying processing to manipulate dynamic string is done
674  * by __ast_str_helper(), which can return a success or a
675  * permanent failure (e.g. no memory).
676  */
677 enum {
678         /*! An error has occurred and the contents of the dynamic string
679          *  are undefined */
680         AST_DYNSTR_BUILD_FAILED = -1,
681         /*! The buffer size for the dynamic string had to be increased, and
682          *  __ast_str_helper() needs to be called again after
683          *  a va_end() and va_start().  This return value is legacy and will
684          *  no longer be used.
685          */
686         AST_DYNSTR_BUILD_RETRY = -2
687 };
688
689 /*!
690  * \brief Core functionality of ast_str_(set|append)_va
691  *
692  * The arguments to this function are the same as those described for
693  * ast_str_set_va except for an addition argument, append.
694  * If append is non-zero, this will append to the current string instead of
695  * writing over it.
696  *
697  * AST_DYNSTR_BUILD_RETRY is a legacy define.  It should probably never
698  * again be used.
699  *
700  * A return of AST_DYNSTR_BUILD_FAILED indicates a memory allocation error.
701  *
702  * A return value greater than or equal to zero indicates the number of
703  * characters that have been written, not including the terminating '\0'.
704  * In the append case, this only includes the number of characters appended.
705  *
706  * \note This function should never need to be called directly.  It should
707  *       through calling one of the other functions or macros defined in this
708  *       file.
709  */
710 #if (defined(MALLOC_DEBUG) && !defined(STANDALONE))
711 int __attribute__((format(printf, 4, 0))) __ast_debug_str_helper(struct ast_str **buf, size_t max_len,
712                                                            int append, const char *fmt, va_list ap, const char *file, int lineno, const char *func);
713 #define __ast_str_helper(a,b,c,d,e)     __ast_debug_str_helper(a,b,c,d,e,__FILE__,__LINE__,__PRETTY_FUNCTION__)
714 #else
715 int __attribute__((format(printf, 4, 0))) __ast_str_helper(struct ast_str **buf, size_t max_len,
716                                                            int append, const char *fmt, va_list ap);
717 #endif
718 char *__ast_str_helper2(struct ast_str **buf, size_t max_len,
719         const char *src, size_t maxsrc, int append, int escapecommas);
720
721 /*!
722  * \brief Set a dynamic string from a va_list
723  *
724  * \param buf This is the address of a pointer to a struct ast_str.
725  *      If it is retrieved using ast_str_thread_get, the
726         struct ast_threadstorage pointer will need to
727  *      be updated in the case that the buffer has to be reallocated to
728  *      accommodate a longer string than what it currently has space for.
729  * \param max_len This is the maximum length to allow the string buffer to grow
730  *      to.  If this is set to 0, then there is no maximum length.
731  * \param fmt This is the format string (printf style)
732  * \param ap This is the va_list
733  *
734  * \return The return value of this function is the same as that of the printf
735  *         family of functions.
736  *
737  * Example usage (the first part is only for thread-local storage)
738  * \code
739  * AST_THREADSTORAGE(my_str, my_str_init);
740  * #define MY_STR_INIT_SIZE   128
741  * ...
742  * void my_func(const char *fmt, ...)
743  * {
744  *      struct ast_str *buf;
745  *      va_list ap;
746  *
747  *      if (!(buf = ast_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
748  *           return;
749  *      ...
750  *      va_start(fmt, ap);
751  *      ast_str_set_va(&buf, 0, fmt, ap);
752  *      va_end(ap);
753  * 
754  *      printf("This is the string we just built: %s\n", buf->str);
755  *      ...
756  * }
757  * \endcode
758  */
759 AST_INLINE_API(int __attribute__((format(printf, 3, 0))) ast_str_set_va(struct ast_str **buf, size_t max_len, const char *fmt, va_list ap),
760 {
761         return __ast_str_helper(buf, max_len, 0, fmt, ap);
762 }
763 )
764
765 /*!
766  * \brief Append to a dynamic string using a va_list
767  *
768  * Same as ast_str_set_va(), but append to the current content.
769  */
770 AST_INLINE_API(int __attribute__((format(printf, 3, 0))) ast_str_append_va(struct ast_str **buf, size_t max_len, const char *fmt, va_list ap),
771 {
772         return __ast_str_helper(buf, max_len, 1, fmt, ap);
773 }
774 )
775
776 /*!\brief Set a dynamic string to a non-NULL terminated substring. */
777 AST_INLINE_API(char *ast_str_set_substr(struct ast_str **buf, size_t maxlen, const char *src, size_t maxsrc),
778 {
779         return __ast_str_helper2(buf, maxlen, src, maxsrc, 0, 0);
780 }
781 )
782
783 /*!\brief Append a non-NULL terminated substring to the end of a dynamic string. */
784 AST_INLINE_API(char *ast_str_append_substr(struct ast_str **buf, size_t maxlen, const char *src, size_t maxsrc),
785 {
786         return __ast_str_helper2(buf, maxlen, src, maxsrc, 1, 0);
787 }
788 )
789
790 /*!\brief Set a dynamic string to a non-NULL terminated substring, with escaping of commas. */
791 AST_INLINE_API(char *ast_str_set_escapecommas(struct ast_str **buf, size_t maxlen, const char *src, size_t maxsrc),
792 {
793         return __ast_str_helper2(buf, maxlen, src, maxsrc, 0, 1);
794 }
795 )
796
797 /*!\brief Append a non-NULL terminated substring to the end of a dynamic string, with escaping of commas. */
798 AST_INLINE_API(char *ast_str_append_escapecommas(struct ast_str **buf, size_t maxlen, const char *src, size_t maxsrc),
799 {
800         return __ast_str_helper2(buf, maxlen, src, maxsrc, 1, 1);
801 }
802 )
803
804 /*!
805  * \brief Set a dynamic string using variable arguments
806  *
807  * \param buf This is the address of a pointer to a struct ast_str which should
808  *      have been retrieved using ast_str_thread_get.  It will need to
809  *      be updated in the case that the buffer has to be reallocated to
810  *      accomodate a longer string than what it currently has space for.
811  * \param max_len This is the maximum length to allow the string buffer to grow
812  *      to.  If this is set to 0, then there is no maximum length.
813  *      If set to -1, we are bound to the current maximum length.
814  * \param fmt This is the format string (printf style)
815  *
816  * \return The return value of this function is the same as that of the printf
817  *         family of functions.
818  *
819  * All the rest is the same as ast_str_set_va()
820  */
821 AST_INLINE_API(
822 int __attribute__((format(printf, 3, 4))) ast_str_set(
823         struct ast_str **buf, size_t max_len, const char *fmt, ...),
824 {
825         int res;
826         va_list ap;
827
828         va_start(ap, fmt);
829         res = ast_str_set_va(buf, max_len, fmt, ap);
830         va_end(ap);
831
832         return res;
833 }
834 )
835
836 /*!
837  * \brief Append to a thread local dynamic string
838  *
839  * The arguments, return values, and usage of this function are the same as
840  * ast_str_set(), but the new data is appended to the current value.
841  */
842 AST_INLINE_API(
843 int __attribute__((format(printf, 3, 4))) ast_str_append(
844         struct ast_str **buf, size_t max_len, const char *fmt, ...),
845 {
846         int res;
847         va_list ap;
848
849         va_start(ap, fmt);
850         res = ast_str_append_va(buf, max_len, fmt, ap);
851         va_end(ap);
852
853         return res;
854 }
855 )
856
857 /*!
858  * \brief Compute a hash value on a string
859  *
860  * This famous hash algorithm was written by Dan Bernstein and is
861  * commonly used.
862  *
863  * http://www.cse.yorku.ca/~oz/hash.html
864  */
865 static force_inline int attribute_pure ast_str_hash(const char *str)
866 {
867         int hash = 5381;
868
869         while (*str)
870                 hash = hash * 33 ^ *str++;
871
872         return abs(hash);
873 }
874
875 /*!
876  * \brief Compute a hash value on a string
877  *
878  * \param[in] str The string to add to the hash
879  * \param[in] hash The hash value to add to
880  * 
881  * \details
882  * This version of the function is for when you need to compute a
883  * string hash of more than one string.
884  *
885  * This famous hash algorithm was written by Dan Bernstein and is
886  * commonly used.
887  *
888  * \sa http://www.cse.yorku.ca/~oz/hash.html
889  */
890 static force_inline int ast_str_hash_add(const char *str, int hash)
891 {
892         while (*str)
893                 hash = hash * 33 ^ *str++;
894
895         return abs(hash);
896 }
897
898 /*!
899  * \brief Compute a hash value on a case-insensitive string
900  *
901  * Uses the same hash algorithm as ast_str_hash, but converts
902  * all characters to lowercase prior to computing a hash. This
903  * allows for easy case-insensitive lookups in a hash table.
904  */
905 static force_inline int attribute_pure ast_str_case_hash(const char *str)
906 {
907         int hash = 5381;
908
909         while (*str) {
910                 hash = hash * 33 ^ tolower(*str++);
911         }
912
913         return abs(hash);
914 }
915
916 #endif /* _ASTERISK_STRINGS_H */