simplify the ast_dynamic_str_*.... routines by
[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 <string.h>
27 #include <stdarg.h>
28
29 #include "asterisk/inline_api.h"
30 #include "asterisk/compiler.h"
31 #include "asterisk/compat.h"
32 #include "asterisk/utils.h"
33 #include "asterisk/threadstorage.h"
34
35 static force_inline int ast_strlen_zero(const char *s)
36 {
37         return (!s || (*s == '\0'));
38 }
39
40 /*! \brief returns the equivalent of logic or for strings:
41  * first one if not empty, otherwise second one.
42  */
43 #define S_OR(a, b)      (!ast_strlen_zero(a) ? (a) : (b))
44
45 /*!
46   \brief Gets a pointer to the first non-whitespace character in a string.
47   \param ast_skip_blanks function being used
48   \param str the input string
49   \return a pointer to the first non-whitespace character
50  */
51 AST_INLINE_API(
52 char *ast_skip_blanks(const char *str),
53 {
54         while (*str && *str < 33)
55                 str++;
56         return (char *)str;
57 }
58 )
59
60 /*!
61   \brief Trims trailing whitespace characters from a string.
62   \param ast_trim_blanks function being used
63   \param str the input string
64   \return a pointer to the modified string
65  */
66 AST_INLINE_API(
67 char *ast_trim_blanks(char *str),
68 {
69         char *work = str;
70
71         if (work) {
72                 work += strlen(work) - 1;
73                 /* It's tempting to only want to erase after we exit this loop, 
74                    but since ast_trim_blanks *could* receive a constant string
75                    (which we presumably wouldn't have to touch), we shouldn't
76                    actually set anything unless we must, and it's easier just
77                    to set each position to \0 than to keep track of a variable
78                    for it */
79                 while ((work >= str) && *work < 33)
80                         *(work--) = '\0';
81         }
82         return str;
83 }
84 )
85
86 /*!
87   \brief Gets a pointer to first whitespace character in a string.
88   \param ast_skip_noblanks function being used
89   \param str the input string
90   \return a pointer to the first whitespace character
91  */
92 AST_INLINE_API(
93 char *ast_skip_nonblanks(char *str),
94 {
95         while (*str && *str > 32)
96                 str++;
97         return str;
98 }
99 )
100   
101 /*!
102   \brief Strip leading/trailing whitespace from a string.
103   \param s The string to be stripped (will be modified).
104   \return The stripped string.
105
106   This functions strips all leading and trailing whitespace
107   characters from the input string, and returns a pointer to
108   the resulting string. The string is modified in place.
109 */
110 AST_INLINE_API(
111 char *ast_strip(char *s),
112 {
113         s = ast_skip_blanks(s);
114         if (s)
115                 ast_trim_blanks(s);
116         return s;
117
118 )
119
120 /*!
121   \brief Strip leading/trailing whitespace and quotes from a string.
122   \param s The string to be stripped (will be modified).
123   \param beg_quotes The list of possible beginning quote characters.
124   \param end_quotes The list of matching ending quote characters.
125   \return The stripped string.
126
127   This functions strips all leading and trailing whitespace
128   characters from the input string, and returns a pointer to
129   the resulting string. The string is modified in place.
130
131   It can also remove beginning and ending quote (or quote-like)
132   characters, in matching pairs. If the first character of the
133   string matches any character in beg_quotes, and the last
134   character of the string is the matching character in
135   end_quotes, then they are removed from the string.
136
137   Examples:
138   \code
139   ast_strip_quoted(buf, "\"", "\"");
140   ast_strip_quoted(buf, "'", "'");
141   ast_strip_quoted(buf, "[{(", "]})");
142   \endcode
143  */
144 char *ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes);
145
146 /*!
147   \brief Size-limited null-terminating string copy.
148   \param ast_copy_string function being used
149   \param dst The destination buffer.
150   \param src The source string
151   \param size The size of the destination buffer
152   \return Nothing.
153
154   This is similar to \a strncpy, with two important differences:
155     - the destination buffer will \b always be null-terminated
156     - the destination buffer is not filled with zeros past the copied string length
157   These differences make it slightly more efficient, and safer to use since it will
158   not leave the destination buffer unterminated. There is no need to pass an artificially
159   reduced buffer size to this function (unlike \a strncpy), and the buffer does not need
160   to be initialized to zeroes prior to calling this function.
161 */
162 AST_INLINE_API(
163 void ast_copy_string(char *dst, const char *src, size_t size),
164 {
165         while (*src && size) {
166                 *dst++ = *src++;
167                 size--;
168         }
169         if (__builtin_expect(!size, 0))
170                 dst--;
171         *dst = '\0';
172 }
173 )
174
175
176 /*!
177   \brief Build a string in a buffer, designed to be called repeatedly
178   
179   This is a wrapper for snprintf, that properly handles the buffer pointer
180   and buffer space available.
181
182   \param buffer current position in buffer to place string into (will be updated on return)
183   \param space remaining space in buffer (will be updated on return)
184   \param fmt printf-style format string
185   \return 0 on success, non-zero on failure.
186 */
187 int ast_build_string(char **buffer, size_t *space, const char *fmt, ...) __attribute__ ((format (printf, 3, 4)));
188
189 /*!
190   \brief Build a string in a buffer, designed to be called repeatedly
191   
192   This is a wrapper for snprintf, that properly handles the buffer pointer
193   and buffer space available.
194
195   \return 0 on success, non-zero on failure.
196   \param buffer current position in buffer to place string into (will be updated on return)
197   \param space remaining space in buffer (will be updated on return)
198   \param fmt printf-style format string
199   \param ap varargs list of arguments for format
200 */
201 int ast_build_string_va(char **buffer, size_t *space, const char *fmt, va_list ap);
202
203 /*! Make sure something is true */
204 /*!
205  * Determine if a string containing a boolean value is "true".
206  * This function checks to see whether a string passed to it is an indication of an "true" value.  It checks to see if the string is "yes", "true", "y", "t", "on" or "1".  
207  *
208  * Returns 0 if val is a NULL pointer, -1 if "true", and 0 otherwise.
209  */
210 int ast_true(const char *val);
211
212 /*! Make sure something is false */
213 /*!
214  * Determine if a string containing a boolean value is "false".
215  * This function checks to see whether a string passed to it is an indication of an "false" value.  It checks to see if the string is "no", "false", "n", "f", "off" or "0".  
216  *
217  * Returns 0 if val is a NULL pointer, -1 if "false", and 0 otherwise.
218  */
219 int ast_false(const char *val);
220
221 /*
222   \brief Join an array of strings into a single string.
223   \param s the resulting string buffer
224   \param len the length of the result buffer, s
225   \param w an array of strings to join
226
227   This function will join all of the strings in the array 'w' into a single
228   string.  It will also place a space in the result buffer in between each
229   string from 'w'.
230 */
231 void ast_join(char *s, size_t len, char * const w[]);
232
233 /*
234   \brief Parse a time (integer) string.
235   \param src String to parse
236   \param dst Destination
237   \param _default Value to use if the string does not contain a valid time
238   \param consumed The number of characters 'consumed' in the string by the parse (see 'man sscanf' for details)
239   \return zero on success, non-zero on failure
240 */
241 int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed);
242
243 /* The realloca lets us ast_restrdupa(), but you can't mix any other ast_strdup calls! */
244
245 struct ast_realloca {
246         char *ptr;
247         int alloclen;
248 };
249
250 #define ast_restrdupa(ra, s) \
251         ({ \
252                 if ((ra)->ptr && strlen(s) + 1 < (ra)->alloclen) { \
253                         strcpy((ra)->ptr, s); \
254                 } else { \
255                         (ra)->ptr = alloca(strlen(s) + 1 - (ra)->alloclen); \
256                         if ((ra)->ptr) (ra)->alloclen = strlen(s) + 1; \
257                 } \
258                 (ra)->ptr; \
259         })
260
261 /*!
262  * Support for dynamic strings.
263  *
264  * A dynamic string is just a C string prefixed by a few control fields
265  * that help setting/appending/extending it using a printf-like syntax.
266  *
267  * One should never declare a variable with this type, but only a pointer
268  * to it, e.g.
269  *
270  *      struct ast_str *ds;
271  *
272  * The pointer can be initialized with the following:
273  *
274  *      ds = ast_str_create(init_len);
275  *              creates a malloc()'ed dynamic string;
276  *
277  *      ds = ast_str_alloca(init_len);
278  *              creates a string on the stack (not very dynamic!).
279  *
280  *      ds = ast_str_thread_get(ts, init_len)
281  *              creates a malloc()'ed dynamic string associated to
282  *              the thread-local storage key ts
283  *
284  * Finally, the string can be manipulated with the following:
285  *
286  *      ast_str_set(&buf, max_len, ts, fmt, ...)
287  *      ast_str_append(&buf, max_len, ts, fmt, ...)
288  *
289  * and their varargs format.
290  *
291  * \arg max_len The maximum allowed length, reallocating if needed.
292  *      0 means unlimited, -1 means "at most the available space"
293  */
294
295 /*! \brief The descriptor of a dynamic string
296  *  XXX storage will be optimized later if needed
297  * We use the ts field to indicate the type of storage.
298  * Three special constants indicate malloc, alloca() or static
299  * variables, all other values indicate a
300  * struct ast_threadstorage pointer.
301  */
302 struct ast_str {
303         size_t len;     /*!< The current maximum length of the string */
304         size_t used;    /*!< Amount of space used */
305         struct ast_threadstorage *ts;   /*!< What kind of storage is this ? */
306 #define DS_MALLOC       ((struct ast_threadstorage *)1)
307 #define DS_ALLOCA       ((struct ast_threadstorage *)2)
308 #define DS_STATIC       ((struct ast_threadstorage *)3) /* not supported yet */
309         char str[0];    /*!< The string buffer */
310 };
311
312 /*!
313  * \brief Create a malloc'ed dynamic length string
314  *
315  * \arg init_len This is the initial length of the string buffer
316  *
317  * \return This function returns a pointer to the dynamic string length.  The
318  *         result will be NULL in the case of a memory allocation error.
319  *
320  * \note The result of this function is dynamically allocated memory, and must
321  *       be free()'d after it is no longer needed.
322  */
323 AST_INLINE_API(
324 struct ast_str * attribute_malloc ast_str_create(size_t init_len),
325 {
326         struct ast_str *buf;
327
328         if (!(buf = ast_calloc(1, sizeof(*buf) + init_len)))
329                 return NULL;
330         
331         buf->len = init_len;
332         buf->used = 0;
333         buf->ts = DS_MALLOC;
334
335         return buf;
336 }
337 )
338
339 #define ast_str_alloca(init_len)                        \
340         ({                                              \
341                 struct ast_str *buf;                    \
342                 buf = alloca(sizeof(*buf) + init_len);  \
343                 buf->len = init_len;                    \
344                 buf->used = 0;                          \
345                 buf->ts = DS_ALLOCA;                    \
346                 buf->str[0] = '\0';                     \
347                 (buf);                                  \
348         })
349
350
351 /*!
352  * \brief Retrieve a thread locally stored dynamic string
353  *
354  * \arg ts This is a pointer to the thread storage structure declared by using
355  *      the AST_THREADSTORAGE macro.  If declared with 
356  *      AST_THREADSTORAGE(my_buf, my_buf_init), then this argument would be 
357  *      (&my_buf).
358  * \arg init_len This is the initial length of the thread's dynamic string. The
359  *      current length may be bigger if previous operations in this thread have
360  *      caused it to increase.
361  *
362  * \return This function will return the thread locally stored dynamic string
363  *         associated with the thread storage management variable passed as the
364  *         first argument.
365  *         The result will be NULL in the case of a memory allocation error.
366  *
367  * Example usage:
368  * \code
369  * AST_THREADSTORAGE(my_str, my_str_init);
370  * #define MY_STR_INIT_SIZE   128
371  * ...
372  * void my_func(const char *fmt, ...)
373  * {
374  *      struct ast_str *buf;
375  *
376  *      if (!(buf = ast_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
377  *           return;
378  *      ...
379  * }
380  * \endcode
381  */
382 AST_INLINE_API(
383 struct ast_str *ast_str_thread_get(struct ast_threadstorage *ts,
384         size_t init_len),
385 {
386         struct ast_str *buf;
387
388         if (!(buf = ast_threadstorage_get(ts, sizeof(*buf) + init_len)))
389                 return NULL;
390         
391         if (!buf->len) {
392                 buf->len = init_len;
393                 buf->used = 0;
394                 buf->ts = ts;
395         }
396
397         return buf;
398 }
399 )
400
401 /*!
402  * \brief Error codes from __ast_str_helper()
403  * The undelying processing to manipulate dynamic string is done
404  * by __ast_str_helper(), which can return a success, a
405  * permanent failure (e.g. no memory), or a temporary one (when
406  * the string needs to be reallocated, and we must run va_start()
407  * again; XXX this convoluted interface is only here because
408  * FreeBSD 4 lacks va_copy, but this will be fixed and the
409  * interface simplified).
410  */
411 enum {
412         /*! An error has occured and the contents of the dynamic string
413          *  are undefined */
414         AST_DYNSTR_BUILD_FAILED = -1,
415         /*! The buffer size for the dynamic string had to be increased, and
416          *  __ast_str_helper() needs to be called again after
417          *  a va_end() and va_start().
418          */
419         AST_DYNSTR_BUILD_RETRY = -2
420 };
421
422 /*!
423  * \brief Set a dynamic string from a va_list
424  *
425  * \arg buf This is the address of a pointer to a struct ast_str.
426  *      If it is retrieved using ast_str_thread_get, the
427         struct ast_threadstorage pointer will need to
428  *      be updated in the case that the buffer has to be reallocated to
429  *      accommodate a longer string than what it currently has space for.
430  * \arg max_len This is the maximum length to allow the string buffer to grow
431  *      to.  If this is set to 0, then there is no maximum length.
432  * \arg fmt This is the format string (printf style)
433  * \arg ap This is the va_list
434  *
435  * \return The return value of this function is the same as that of the printf
436  *         family of functions.
437  *
438  * Example usage (the first part is only for thread-local storage)
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  *      va_list ap;
447  *
448  *      if (!(buf = ast_str_thread_get(&my_str, MY_STR_INIT_SIZE)))
449  *           return;
450  *      ...
451  *      va_start(fmt, ap);
452  *      ast_str_set_va(&buf, 0, fmt, ap);
453  *      va_end(ap);
454  * 
455  *      printf("This is the string we just built: %s\n", buf->str);
456  *      ...
457  * }
458  * \endcode
459  *
460  * \note: the following two functions must be implemented as macros
461  *      because we must do va_end()/va_start() on the original arguments.
462  */
463 #define ast_str_set_va(buf, max_len, fmt, ap)                   \
464         ({                                                              \
465                 int __res;                                              \
466                 while ((__res = __ast_str_helper(buf, max_len,          \
467                         0, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {       \
468                         va_end(ap);                                     \
469                         va_start(ap, fmt);                              \
470                 }                                                       \
471                 (__res);                                                \
472         })
473
474 /*!
475  * \brief Append to a dynamic string using a va_list
476  *
477  * Same as ast_str_set_va(), but append to the current content.
478  */
479 #define ast_str_append_va(buf, max_len, fmt, ap)                \
480         ({                                                              \
481                 int __res;                                              \
482                 while ((__res = __ast_str_helper(buf, max_len,          \
483                         1, fmt, ap)) == AST_DYNSTR_BUILD_RETRY) {       \
484                         va_end(ap);                                     \
485                         va_start(ap, fmt);                              \
486                 }                                                       \
487                 (__res);                                                \
488         })
489
490 /*!
491  * \brief Core functionality of ast_str_(set|append)_va
492  *
493  * The arguments to this function are the same as those described for
494  * ast_str_set_va except for an addition argument, append.
495  * If append is non-zero, this will append to the current string instead of
496  * writing over it.
497  *
498  * In the case that this function is called and the buffer was not large enough
499  * to hold the result, the partial write will be truncated, and the result
500  * AST_DYNSTR_BUILD_RETRY will be returned to indicate that the buffer size
501  * was increased, and the function should be called a second time.
502  *
503  * A return of AST_DYNSTR_BUILD_FAILED indicates a memory allocation error.
504  *
505  * A return value greater than or equal to zero indicates the number of
506  * characters that have been written, not including the terminating '\0'.
507  * In the append case, this only includes the number of characters appended.
508  *
509  * \note This function should never need to be called directly.  It should
510  *       through calling one of the other functions or macros defined in this
511  *       file.
512  */
513 int __ast_str_helper(struct ast_str **buf, size_t max_len,
514         int append, const char *fmt, va_list ap);
515
516 /*!
517  * \brief Set a dynamic string using variable arguments
518  *
519  * \arg buf This is the address of a pointer to a struct ast_str which should
520  *      have been retrieved using ast_str_thread_get.  It will need to
521  *      be updated in the case that the buffer has to be reallocated to
522  *      accomodate a longer string than what it currently has space for.
523  * \arg max_len This is the maximum length to allow the string buffer to grow
524  *      to.  If this is set to 0, then there is no maximum length.
525  *      If set to -1, we are bound to the current maximum length.
526  * \arg fmt This is the format string (printf style)
527  *
528  * \return The return value of this function is the same as that of the printf
529  *         family of functions.
530  *
531  * All the rest is the same as ast_str_set_va()
532  */
533 AST_INLINE_API(
534 int __attribute__ ((format (printf, 3, 4))) ast_str_set(
535         struct ast_str **buf, size_t max_len, const char *fmt, ...),
536 {
537         int res;
538         va_list ap;
539
540         va_start(ap, fmt);
541         res = ast_str_set_va(buf, max_len, fmt, ap);
542         va_end(ap);
543
544         return res;
545 }
546 )
547
548 /*!
549  * \brief Append to a thread local dynamic string
550  *
551  * The arguments, return values, and usage of this function are the same as
552  * ast_str_set(), but the new data is appended to the current value.
553  */
554 AST_INLINE_API(
555 int __attribute__ ((format (printf, 3, 4))) ast_str_append(
556         struct ast_str **buf, size_t max_len, const char *fmt, ...),
557 {
558         int res;
559         va_list ap;
560
561         va_start(ap, fmt);
562         res = ast_str_append_va(buf, max_len, fmt, ap);
563         va_end(ap);
564
565         return res;
566 }
567 )
568
569 #endif /* _ASTERISK_STRINGS_H */