This commit folds in changes to both stringfields (some enhancements to the ...field_...
[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   \brief Declare a string field
172   \param name The field name
173 */
174 #define AST_STRING_FIELD(name) const ast_string_field name
175
176 /*!
177   \brief Declare the fields needed in a structure
178   \param field_list The list of fields to declare, using AST_STRING_FIELD() for each one
179 */
180 #define AST_DECLARE_STRING_FIELDS(field_list) \
181         ast_string_field __begin_field[0]; \
182         field_list \
183         ast_string_field __end_field[0]; \
184         struct ast_string_field_mgr __field_mgr
185
186 /*!
187   \brief Get the number of string fields in a structure
188   \param x Pointer to a structure containing fields
189   \return the number of fields in the structure's definition
190 */
191 #define ast_string_field_count(x) \
192         (offsetof(typeof(*(x)), __end_field) - offsetof(typeof(*(x)), __begin_field)) / sizeof(ast_string_field)
193
194 /*!
195   \brief Get the index of a field in a structure
196   \param x Pointer to a structure containing fields
197   \param field Name of the field to locate
198   \return the position (index) of the field within the structure's
199   array of fields
200 */
201 #define ast_string_field_index(x, field) \
202         (offsetof(typeof(*x), field) - offsetof(typeof(*x), __begin_field)) / sizeof(ast_string_field)
203
204 /*!
205   \brief Initialize a field pool and fields
206   \param x Pointer to a structure containing fields
207   \param size Amount of storage to allocate
208   \return 0 on success, non-zero on failure
209 */
210 #define ast_string_field_init(x, size) \
211         __ast_string_field_init(&(x)->__field_mgr, size, &(x)->__begin_field[0], ast_string_field_count(x))
212
213 /*!
214   \brief Set a field to a simple string value
215   \param x Pointer to a structure containing fields
216   \param index Index position of the field within the structure
217   \param data String value to be copied into the field
218   \return nothing
219 */
220 #define ast_string_field_index_set(x, index, data) do { \
221     char *__zz__ = (char*)(x)->__begin_field[index]; \
222     int __dlen__ = strlen(data); \
223     if( __dlen__ == 0 ) { (x)->__begin_field[index] = __ast_string_field_empty; \
224     } else { \
225      if( __zz__[0] != 0 && __dlen__ <= strlen(__zz__) ) { \
226            strcpy(__zz__, data); \
227      } else { \
228        if (((x)->__begin_field[index] = __ast_string_field_alloc_space(&(x)->__field_mgr, __dlen__ + 1, &(x)->__begin_field[0], ast_string_field_count(x)))) \
229                strcpy((char*)(x)->__begin_field[index], data); \
230          } \
231         } \
232    } while (0)
233
234 #ifdef FOR_TEST
235 #define ast_string_field_index_logset(x, index, data, logstr) do { \
236     char *__zz__ = (char*)(x)->__begin_field[index]; \
237     int __dlen__ = strlen(data); \
238     if( __dlen__ == 0 ) { (x)->__begin_field[index] = __ast_string_field_empty; \
239     } else { \
240      if( __zz__[0] != 0 && __dlen__ <= strlen(__zz__) ) { \
241        ast_verbose("%s: ======replacing '%s' with '%s'\n", logstr, __zz__, data); \
242            strcpy(__zz__, data); \
243      } else { \
244        ast_verbose("%s: ++++++allocating room for '%s' to replace '%s'\n", logstr, data, __zz__); \
245        if (((x)->__begin_field[index] = __ast_string_field_alloc_space(&(x)->__field_mgr, __dlen__ + 1, &(x)->__begin_field[0], ast_string_field_count(x)))) \
246                strcpy((char*)(x)->__begin_field[index], data); \
247          } \
248         } \
249    } while (0)
250 #endif
251 /*!
252   \brief Set a field to a simple string value
253   \param x Pointer to a structure containing fields
254   \param field Name of the field to set
255   \param data String value to be copied into the field
256   \return nothing
257 */
258 #define ast_string_field_set(x, field, data) \
259         ast_string_field_index_set(x, ast_string_field_index(x, field), data)
260
261 #ifdef FOR_TEST
262 #define ast_string_field_logset(x, field, data, logstr) \
263         ast_string_field_index_logset(x, ast_string_field_index(x, field), data, logstr)
264 #endif
265 /*!
266   \brief Set a field to a complex (built) value
267   \param x Pointer to a structure containing fields
268   \param index Index position of the field within the structure
269   \param fmt printf-style format string
270   \param args Arguments for format string
271   \return nothing
272 */
273 #define ast_string_field_index_build(x, index, fmt, args...) \
274         __ast_string_field_index_build(&(x)->__field_mgr, &(x)->__begin_field[0], ast_string_field_count(x), index, fmt, args)
275
276 /*!
277   \brief Set a field to a complex (built) value
278   \param x Pointer to a structure containing fields
279   \param field Name of the field to set
280   \param fmt printf-style format string
281   \param args Arguments for format string
282   \return nothing
283 */
284 #define ast_string_field_build(x, field, fmt, args...) \
285         ast_string_field_index_build(x, ast_string_field_index(x, field), fmt, args)
286
287 /*!
288   \brief Free a field's value.
289   \param x Pointer to a structure containing fields
290   \param index Index position of the field within the structure
291   \return nothing
292
293   \note Because of the storage pool used, the memory
294   occupied by the field's value is \b not recovered; the field
295   pointer is just changed to point to an empty string.
296 */
297 #define ast_string_field_index_free(x, index) do { \
298         (x)->__begin_field[index] = __ast_string_field_empty; \
299         } while(0)
300
301 /*!
302   \brief Free a field's value.
303   \param x Pointer to a structure containing fields
304   \param field Name of the field to free
305   \return nothing
306
307   \note Because of the storage pool used, the memory
308   occupied by the field's value is \b not recovered; the field
309   pointer is just changed to point to an empty string.
310 */
311 #define ast_string_field_free(x, field) \
312         ast_string_field_index_free(x, ast_string_field_index(x, field))
313
314 /*!
315   \brief Free all fields (and the storage pool) in a structure
316   \param x Pointer to a structure containing fields
317   \return nothing
318
319   After calling this macro, fields can no longer be accessed in
320   structure; it should only be called immediately before freeing
321   the structure itself.
322 */
323 #define ast_string_field_free_all(x) do { \
324         int index; \
325         struct ast_string_field_pool *this, *prev; \
326         for (index = 0; index < ast_string_field_count(x); index ++) \
327                 ast_string_field_index_free(x, index); \
328         for (this = (x)->__field_mgr.pool; this; this = prev) { \
329                 prev = this->prev; \
330                 free(this); \
331         } \
332         } while(0)
333
334 #endif /* _ASTERISK_STRINGFIELDS_H */