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" /* SG_BEGIN_DECL */
17 /** @addtogroup XBT_dynar
18 * @brief DynArr are dynamically sized vector which may contain any type of variables.
20 * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
22 * For performance concerns, the content of DynArr must be homogeneous (in
23 * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
24 * have to provide the function which will be used to free the content at
25 * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
27 * \section XBT_dynar_exscal Example with scalar
28 * \dontinclude dynar.c
35 * \until end_of_traversal
38 * \until xbt_dynar_free
40 * \section XBT_dynar_exptr Example with pointed data
42 * \skip doxygen_string_cruft
50 * \skip end_of_doxygen
55 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
60 /** \brief Dynar data type (opaque type) */
61 typedef struct xbt_dynar_s *xbt_dynar_t;
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 /** @defgroup XBT_dynar_array Dynar as a regular array
81 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
83 void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
84 void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
86 void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void *src);
87 void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void * const dst);
90 /** @defgroup XBT_dynar_perl Perl-like use of dynars
96 void xbt_dynar_push (xbt_dynar_t dynar, const void *src);
97 void xbt_dynar_pop (xbt_dynar_t dynar, void *const dst);
98 void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
99 void xbt_dynar_shift (xbt_dynar_t dynar, void *const dst);
100 void xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t *op);
103 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
106 * Those functions do not retrive the content, but only their address.
111 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
112 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
113 void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
114 void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
117 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
120 * While the other functions use a memcpy to retrive the content into the
121 * user provided area, those ones use a regular affectation. It only works
122 * for scalar values, but should be a little faster.
127 /** @brief Quick retrieval of scalar content
128 * @hideinitializer */
129 # define xbt_dynar_get_as(dynar,idx,type) \
130 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
131 /** @brief Quick retrieval of scalar content
132 * @hideinitializer */
133 # define xbt_dynar_getlast_as(dynar,type) \
134 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
135 /** @brief Quick retrieval of scalar content
136 * @hideinitializer */
137 # define xbt_dynar_getfirst_as(dynar,type) \
138 (*(type*)xbt_dynar_get_ptr((dynar),0))
139 /** @brief Quick insertion of scalar content
140 * @hideinitializer */
141 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
142 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
143 /** @brief Quick insertion of scalar content
144 * @hideinitializer */
145 # define xbt_dynar_push_as(dynar,type,value) \
146 *(type*)xbt_dynar_push_ptr(dynar)=value
147 /** @brief Quick insertion of scalar content
148 * @hideinitializer */
149 # define xbt_dynar_pop_as(dynar,type) \
150 (*(type*)xbt_dynar_pop_ptr(dynar))
153 /** @defgroup XBT_dynar_cursor Cursors on dynar
156 * Cursors are used to iterate over the structure. Never add elements to the
157 * DynArr during the traversal. To remove elements, use the
158 * xbt_dynar_cursor_rm() function
163 void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
164 void xbt_dynar_cursor_step (const xbt_dynar_t dynar, int *cursor);
165 int xbt_dynar_cursor_get (const xbt_dynar_t dynar, int *cursor,
167 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
171 /** @brief Iterates over the whole dynar.
173 * @param _dynar what to iterate over
174 * @param _cursor an integer used as cursor
178 * \note An example of usage:
183 xbt_dynar_foreach (dyn,cpt,str) {
184 printf("Seen %s\n",str);
188 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
189 for (xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
190 xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
191 xbt_dynar_cursor_step(_dynar,&(_cursor)) )
197 #endif /* _XBT_DYNAR_H */