Fix some compiler warnings in C++ modules.
[asterisk/asterisk.git] / include / asterisk / stringfields.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  *
6  * Kevin P. Fleming <kpfleming@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 fields in structures
21
22   This file contains objects and macros used to manage string
23   fields in structures without requiring them to be allocated
24   as fixed-size buffers or requiring individual allocations for
25   for each field.
26   
27   Using this functionality is quite simple... an example structure
28   with three fields is defined like this:
29   
30   \code
31   struct sample_fields {
32           int x1;
33           AST_DECLARE_STRING_FIELDS(
34                   AST_STRING_FIELD(name);
35                   AST_STRING_FIELD(address);
36                   AST_STRING_FIELD(password);
37           );
38           long x2;
39   };
40   \endcode
41   
42   When an instance of this structure is allocated, the fields
43   (and the pool of storage for them) must be initialized:
44   
45   \code
46   struct sample_fields *sample;
47   
48   sample = calloc(1, sizeof(*sample));
49   if (sample) {
50           if (ast_string_field_init(sample, 256)) {
51                   free(sample);
52                   sample = NULL;
53           }
54   }
55   
56   if (!sample) {
57   ...
58   }
59   \endcode
60   
61   Fields will default to pointing to an empty string, and will
62   revert to that when ast_string_field_free() is called. This means
63   that a string field will \b never contain NULL.
64   
65   Using the fields is much like using regular 'char *' fields
66   in the structure, except that writing into them must be done
67   using wrapper macros defined in this file.
68   
69   Storing simple values into fields can be done using ast_string_field_set();
70   more complex values (using printf-style format strings) can be stored
71   using ast_string_field_build().
72   
73   When the structure instance is no longer needed, the fields
74   and their storage pool must be freed:
75   
76   \code
77   ast_string_field_free_all(sample);
78   free(sample);
79   \endcode
80 */
81
82 #ifndef _ASTERISK_STRINGFIELDS_H
83 #define _ASTERISK_STRINGFIELDS_H
84
85 #include <string.h>
86 #include <stdarg.h>
87 #include <stddef.h>
88
89 #include "asterisk/inline_api.h"
90 #include "asterisk/compiler.h"
91 #include "asterisk/compat.h"
92
93 /*!
94   \internal
95   \brief An opaque type for managed string fields in structures
96
97   Don't declare instances of this type directly; use the AST_STRING_FIELD()
98   macro instead.
99 */
100 typedef const char * ast_string_field;
101
102 /*!
103   \internal
104   \brief A constant empty string used for fields that have no other value
105 */
106 extern const char __ast_string_field_empty[];
107
108 /*!
109   \internal
110   \brief Structure used to hold a pool of space for string fields
111 */
112 struct ast_string_field_pool {
113         struct ast_string_field_pool *prev;     /*!< pointer to the previous pool, if any */
114         char base[0];                           /*!< storage space for the fields */
115 };
116
117 /*!
118   \internal
119   \brief Structure used to manage the storage for a set of string fields
120 */
121 struct ast_string_field_mgr {
122         struct ast_string_field_pool *pool;     /*!< the address of the pool's structure */
123         size_t size;                            /*!< the total size of the current pool */
124         size_t space;                           /*!< the space available in the current pool */
125         size_t used;                            /*!< the space used in the current pool */
126 };
127
128 /*!
129   \internal
130   \brief Initialize a field pool manager and fields
131   \param mgr Pointer to the pool manager structure
132   \param size Amount of storage to allocate
133   \param fields Pointer to the first entry of the field array
134   \param num_fields Number of fields in the array
135   \return 0 on success, non-zero on failure
136 */
137 int __ast_string_field_init(struct ast_string_field_mgr *mgr, size_t size,
138                             ast_string_field *fields, int num_fields);
139
140 /*!
141   \internal
142   \brief Allocate space for a field
143   \param mgr Pointer to the pool manager structure
144   \param needed Amount of space needed for this field
145   \param fields Pointer to the first entry of the field array
146   \param num_fields Number of fields in the array
147   \return NULL on failure, an address for the field on success
148
149   This function will allocate the requested amount of space from
150   the field pool. If the requested amount of space is not available,
151   an additional pool will be allocated.
152 */
153 ast_string_field __ast_string_field_alloc_space(struct ast_string_field_mgr *mgr, size_t needed,
154                                                 ast_string_field *fields, int num_fields);
155
156 /*!
157   \internal
158   \brief Set a field to a complex (built) value
159   \param mgr Pointer to the pool manager structure
160   \param fields Pointer to the first entry of the field array
161   \param num_fields Number of fields in the array
162   \param index Index position of the field within the structure
163   \param format printf-style format string
164   \return nothing
165 */
166 void __ast_string_field_index_build(struct ast_string_field_mgr *mgr,
167                                     ast_string_field *fields, int num_fields,
168                                     int index, const char *format, ...);
169
170 /*!
171   \internal
172   \brief Set a field to a complex (built) value
173   \param mgr Pointer to the pool manager structure
174   \param fields Pointer to the first entry of the field array
175   \param num_fields Number of fields in the array
176   \param index Index position of the field within the structure
177   \param format printf-style format string
178   \param args va_list of the args for the format_string
179   \param args_again a copy of the first va_list for the sake of bsd not having a copy routine
180   \return nothing
181 */
182 void __ast_string_field_index_build_va(struct ast_string_field_mgr *mgr,
183                                     ast_string_field *fields, int num_fields,
184                                     int index, const char *format, va_list a1, va_list a2);
185
186 /*!
187   \brief Declare a string field
188   \param name The field name
189 */
190 #define AST_STRING_FIELD(name) const ast_string_field name
191
192 /*!
193   \brief Declare the fields needed in a structure
194   \param field_list The list of fields to declare, using AST_STRING_FIELD() for each one
195 */
196 #define AST_DECLARE_STRING_FIELDS(field_list) \
197         ast_string_field __begin_field[0]; \
198         field_list \
199         ast_string_field __end_field[0]; \
200         struct ast_string_field_mgr __field_mgr
201
202 /*!
203   \brief Get the number of string fields in a structure
204   \param x Pointer to a structure containing fields
205   \return the number of fields in the structure's definition
206 */
207 #define ast_string_field_count(x) \
208         (offsetof(typeof(*(x)), __end_field) - offsetof(typeof(*(x)), __begin_field)) / sizeof(ast_string_field)
209
210 /*!
211   \brief Get the index of a field in a structure
212   \param x Pointer to a structure containing fields
213   \param field Name of the field to locate
214   \return the position (index) of the field within the structure's
215   array of fields
216 */
217 #define ast_string_field_index(x, field) \
218         (offsetof(typeof(*x), field) - offsetof(typeof(*x), __begin_field)) / sizeof(ast_string_field)
219
220 /*!
221   \brief Initialize a field pool and fields
222   \param x Pointer to a structure containing fields
223   \param size Amount of storage to allocate
224   \return 0 on success, non-zero on failure
225 */
226 #define ast_string_field_init(x, size) \
227         __ast_string_field_init(&(x)->__field_mgr, size, &(x)->__begin_field[0], ast_string_field_count(x))
228
229 /*!
230   \brief Set a field to a simple string value
231   \param x Pointer to a structure containing fields
232   \param index Index position of the field within the structure
233   \param data String value to be copied into the field
234   \return nothing
235 */
236 #define ast_string_field_index_set(x, index, data) do { \
237     char *__zz__ = (char*)(x)->__begin_field[index]; \
238     size_t __dlen__ = strlen(data); \
239     if( __dlen__ == 0 ) { (x)->__begin_field[index] = __ast_string_field_empty; \
240     } else { \
241      if( __zz__[0] != 0 && __dlen__ <= strlen(__zz__) ) { \
242            strcpy(__zz__, data); \
243      } else { \
244        if (((x)->__begin_field[index] = __ast_string_field_alloc_space(&(x)->__field_mgr, __dlen__ + 1, &(x)->__begin_field[0], ast_string_field_count(x)))) \
245                strcpy((char*)(x)->__begin_field[index], data); \
246          } \
247         } \
248    } while (0)
249
250 #ifdef FOR_TEST
251 #define ast_string_field_index_logset(x, index, data, logstr) do { \
252     char *__zz__ = (char*)(x)->__begin_field[index]; \
253     size_t __dlen__ = strlen(data); \
254     if( __dlen__ == 0 ) { (x)->__begin_field[index] = __ast_string_field_empty; \
255     } else { \
256      if( __zz__[0] != 0 && __dlen__ <= strlen(__zz__) ) { \
257        ast_verbose("%s: ======replacing '%s' with '%s'\n", logstr, __zz__, data); \
258            strcpy(__zz__, data); \
259      } else { \
260        ast_verbose("%s: ++++++allocating room for '%s' to replace '%s'\n", logstr, data, __zz__); \
261        if (((x)->__begin_field[index] = __ast_string_field_alloc_space(&(x)->__field_mgr, __dlen__ + 1, &(x)->__begin_field[0], ast_string_field_count(x)))) \
262                strcpy((char*)(x)->__begin_field[index], data); \
263          } \
264         } \
265    } while (0)
266 #endif
267
268 /*!
269   \brief Set a field to a simple string value
270   \param x Pointer to a structure containing fields
271   \param field Name of the field to set
272   \param data String value to be copied into the field
273   \return nothing
274 */
275 #define ast_string_field_set(x, field, data) \
276         ast_string_field_index_set(x, ast_string_field_index(x, field), data)
277
278 #ifdef FOR_TEST
279 #define ast_string_field_logset(x, field, data, logstr) \
280         ast_string_field_index_logset(x, ast_string_field_index(x, field), data, logstr)
281 #endif
282
283 /*!
284   \brief Set a field to a complex (built) value
285   \param x Pointer to a structure containing fields
286   \param index Index position of the field within the structure
287   \param fmt printf-style format string
288   \param args Arguments for format string
289   \return nothing
290 */
291 #define ast_string_field_index_build(x, index, fmt, args...) \
292         __ast_string_field_index_build(&(x)->__field_mgr, &(x)->__begin_field[0], ast_string_field_count(x), index, fmt, args)
293
294 /*!
295   \brief Set a field to a complex (built) value with prebuilt va_lists.
296   \param x Pointer to a structure containing fields
297   \param index Index position of the field within the structure
298   \param fmt printf-style format string
299   \param args1 Arguments for format string in va_list format
300   \param args2 a second copy of the va_list for the sake of bsd, with no va_list copy operation
301   \return nothing
302 */
303 #define ast_string_field_index_build_va(x, index, fmt, args1, args2) \
304         __ast_string_field_index_build_va(&(x)->__field_mgr, &(x)->__begin_field[0], ast_string_field_count(x), index, fmt, args1, args2)
305
306 /*!
307   \brief Set a field to a complex (built) value
308   \param x Pointer to a structure containing fields
309   \param field Name of the field to set
310   \param fmt printf-style format string
311   \param args Arguments for format string
312   \return nothing
313 */
314 #define ast_string_field_build(x, field, fmt, args...) \
315         ast_string_field_index_build(x, ast_string_field_index(x, field), fmt, args)
316
317 /*!
318   \brief Set a field to a complex (built) value
319   \param x Pointer to a structure containing fields
320   \param field Name of the field to set
321   \param fmt printf-style format string
322   \param argslist a va_list of the args
323   \return nothing
324 */
325 #define ast_string_field_build_va(x, field, fmt, args1, args2) \
326         ast_string_field_index_build_va(x, ast_string_field_index(x, field), fmt, args1, args2)
327
328 /*!
329   \brief Free a field's value.
330   \param x Pointer to a structure containing fields
331   \param index Index position of the field within the structure
332   \return nothing
333
334   \note Because of the storage pool used, the memory
335   occupied by the field's value is \b not recovered; the field
336   pointer is just changed to point to an empty string.
337 */
338 #define ast_string_field_index_free(x, index) do { \
339         (x)->__begin_field[index] = __ast_string_field_empty; \
340         } while(0)
341
342 /*!
343   \brief Free a field's value.
344   \param x Pointer to a structure containing fields
345   \param field Name of the field to free
346   \return nothing
347
348   \note Because of the storage pool used, the memory
349   occupied by the field's value is \b not recovered; the field
350   pointer is just changed to point to an empty string.
351 */
352 #define ast_string_field_free(x, field) \
353         ast_string_field_index_free(x, ast_string_field_index(x, field))
354
355 /*!
356   \brief Free the stringfield storage pools attached to a structure
357   \param x Pointer to a structure containing fields
358   \return nothing
359
360   After calling this macro, fields can no longer be accessed in
361   structure; it should only be called immediately before freeing
362   the structure itself.
363 */
364 #define ast_string_field_free_pools(x) do { \
365         struct ast_string_field_pool *this, *prev; \
366         for (this = (x)->__field_mgr.pool; this; this = prev) { \
367                 prev = this->prev; \
368                 free(this); \
369         } \
370         } while(0)
371
372 /*!
373   \brief Free the stringfields in a structure
374   \param x Pointer to a structure containing fields
375   \return nothing
376
377   After calling this macro, the most recently allocated pool
378   attached to the structure will be available for use by
379   stringfields again.
380 */
381 #define ast_string_field_free_all(x) do { \
382         int index; \
383         for (index = 0; index < ast_string_field_count(x); index++) \
384                 ast_string_field_index_free(x, index); \
385         (x)->__field_mgr.used = 0; \
386         (x)->__field_mgr.space = (x)->__field_mgr.size; \
387         } while(0)
388
389 #endif /* _ASTERISK_STRINGFIELDS_H */