3 /* dynar - a generic dynamic array */
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "xbt/misc.h" /* BEGIN_DECL */
17 /** \addtogroup XBT_dynar
19 * For performance concerns, the content of DynArr must be homogeneous (in
20 * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
21 * have to provide the function which will be used to free the content at
22 * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
24 * \section XBT_dynar_exscal Example with scalar
25 * \dontinclude dynar_int.c
32 * \until end_of_traversal
35 * \until xbt_dynar_free
37 * \section XBT_dynar_exptr Example with pointed data
38 * \dontinclude dynar_string.c
40 * \skip doxygen_first_cruft
53 /** @name 1. Constructor/destructor
56 /** \brief Dynar data type (opaque type) */
57 typedef struct xbt_dynar_s *xbt_dynar_t;
59 /** \brief Pointer to a function freeing a pointed data */
60 typedef void (void_f_ppvoid_t)(void**);
61 /** \brief Pointer to a function freeing some data */
62 typedef void (void_f_pvoid_t) (void*);
64 xbt_dynar_t xbt_dynar_new(unsigned long elm_size,
65 void_f_pvoid_t *free_func);
66 void xbt_dynar_free(xbt_dynar_t *dynar);
67 void xbt_dynar_free_container(xbt_dynar_t *dynar);
69 unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
70 void xbt_dynar_reset(xbt_dynar_t dynar);
72 void xbt_dynar_dump(xbt_dynar_t dynar);
75 /** @name 2. regular array functions
79 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
81 void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
82 void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
84 void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void *src);
85 void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void * const dst);
88 /** @name 2. Perl-like functions
92 void xbt_dynar_push (xbt_dynar_t dynar, const void *src);
93 void xbt_dynar_pop (xbt_dynar_t dynar, void *const dst);
94 void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
95 void xbt_dynar_shift (xbt_dynar_t dynar, void *const dst);
96 void xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t *operator);
99 /** @name 3. Manipulating pointers to the content
101 * Those functions do not retrive the content, but only their address.
106 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
107 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
108 void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
109 void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
112 /** @name 4. Speed optimized functions for scalars
114 * While the other functions use a memcpy to retrive the content into the
115 * user provided area, those ones use a regular affectation. It only works
116 * for scalar values, but should be a little faster.
121 /** @brief Quick retrieval of scalar content
122 * @hideinitializer */
123 # define xbt_dynar_get_as(dynar,idx,type) \
124 *(type*)xbt_dynar_get_ptr(dynar,idx)
125 /** @brief Quick insertion of scalar content
126 * @hideinitializer */
127 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
128 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
129 /** @brief Quick insertion of scalar content
130 * @hideinitializer */
131 # define xbt_dynar_push_as(dynar,type,value) \
132 *(type*)xbt_dynar_push_ptr(dynar)=value
133 /** @brief Quick insertion of scalar content
134 * @hideinitializer */
135 # define xbt_dynar_pop_as(dynar,type) \
136 *(type*)xbt_dynar_pop_ptr(dynar)
139 /** @name 5. Cursors on DynArr
141 * Cursors are used to iterate over the structure. Never add elements to the
142 * DynArr during the traversal. To remove elements, use the
143 * xbt_dynar_cursor_rm() function
148 void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
149 void xbt_dynar_cursor_step (const xbt_dynar_t dynar, int *cursor);
150 int xbt_dynar_cursor_get (const xbt_dynar_t dynar, int *cursor,
152 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
156 /** @brief Iterates over the whole dynar.
158 * @param _dynar what to iterate over
159 * @param _cursor an integer used as cursor
163 * \note An example of usage:
168 xbt_dynar_foreach (dyn,cpt,str) {
169 printf("Seen %s\n",str);
173 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
174 for (xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
175 xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
176 xbt_dynar_cursor_step(_dynar,&(_cursor)) )
182 #endif /* _XBT_DYNAR_H */