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