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 */
14 #include "xbt/function_types.h"
18 /** @addtogroup XBT_dynar
19 * @brief DynArr are dynamically sized vector which may contain any type of variables.
21 * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
23 * For performance concerns, the content of DynArr must be homogeneous (in
24 * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
25 * have to provide the function which will be used to free the content at
26 * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
28 * \section XBT_dynar_exscal Example with scalar
29 * \dontinclude dynar.c
36 * \until end_of_traversal
39 * \until xbt_dynar_free
41 * \section XBT_dynar_exptr Example with pointed data
43 * \skip test_dynar_string
51 * \skip end_of_doxygen
56 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
61 /** \brief Dynar data type (opaque type) */
62 typedef struct xbt_dynar_s *xbt_dynar_t;
65 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new(const unsigned long elm_size,
66 void_f_pvoid_t const free_f);
67 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new_sync(const unsigned long elm_size,
68 void_f_pvoid_t const free_f);
69 XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t *dynar);
70 XBT_PUBLIC(void) xbt_dynar_free_voidp(void *dynar);
71 XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t *dynar);
73 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
74 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
75 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
77 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
80 /** @defgroup XBT_dynar_array Dynar as a regular array
86 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void * const dst);
88 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *src);
89 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void *object);
91 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void *src);
92 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void * const dst);
94 XBT_PUBLIC(int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
95 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
97 /** @defgroup XBT_dynar_perl Perl-like use of dynars
103 XBT_PUBLIC(void) xbt_dynar_push (xbt_dynar_t const dynar, const void *src);
104 XBT_PUBLIC(void) xbt_dynar_pop (xbt_dynar_t const dynar, void *const dst);
105 XBT_PUBLIC(void) xbt_dynar_unshift (xbt_dynar_t const dynar, const void *src);
106 XBT_PUBLIC(void) xbt_dynar_shift (xbt_dynar_t const dynar, void *const dst);
107 XBT_PUBLIC(void) xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t const op);
110 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
113 * Those functions do not retrieve the content, but only their address.
118 XBT_PUBLIC(void*) xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx);
119 XBT_PUBLIC(void*) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
120 XBT_PUBLIC(void*) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
121 XBT_PUBLIC(void*) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
124 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
127 * While the other functions use a memcpy to retrieve the content into the
128 * user provided area, those ones use a regular affectation. It only works
129 * for scalar values, but should be a little faster.
134 /** @brief Quick retrieval of scalar content
135 * @hideinitializer */
136 # define xbt_dynar_get_as(dynar,idx,type) \
137 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
138 /** @brief Quick retrieval of scalar content
139 * @hideinitializer */
140 # define xbt_dynar_getlast_as(dynar,type) \
141 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
142 /** @brief Quick retrieval of scalar content
143 * @hideinitializer */
144 # define xbt_dynar_getfirst_as(dynar,type) \
145 (*(type*)xbt_dynar_get_ptr((dynar),0))
146 /** @brief Quick insertion of scalar content
147 * @hideinitializer */
148 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
149 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
150 /** @brief Quick insertion of scalar content
151 * @hideinitializer */
152 # define xbt_dynar_push_as(dynar,type,value) \
153 *(type*)xbt_dynar_push_ptr(dynar)=value
154 /** @brief Quick insertion of scalar content
155 * @hideinitializer */
156 # define xbt_dynar_pop_as(dynar,type) \
157 (*(type*)xbt_dynar_pop_ptr(dynar))
160 /** @defgroup XBT_dynar_cursor Cursors on dynar
163 * Cursors are used to iterate over the structure. Never add elements to the
164 * DynArr during the traversal. To remove elements, use the
165 * xbt_dynar_cursor_rm() function.
167 * Do not call these functions directly, but only the xbt_dynar_foreach macro.
169 * For synchronized dynars, the dynar will be locked during the whole
170 * loop and it will get unlocked automatically if you traverse all
171 * elements. If you want to break the loop before the end, make sure
172 * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
177 XBT_PUBLIC(void) _xbt_dynar_cursor_first (const xbt_dynar_t dynar, unsigned int * const cursor);
178 XBT_PUBLIC(void) _xbt_dynar_cursor_step (const xbt_dynar_t dynar, unsigned int * const cursor);
179 XBT_PUBLIC(int) _xbt_dynar_cursor_get (const xbt_dynar_t dynar, unsigned int * const cursor,
181 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
182 unsigned int *const cursor);
183 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
185 /** @brief Iterates over the whole dynar.
187 * @param _dynar what to iterate over
188 * @param _cursor an integer used as cursor
192 * \note An example of usage:
197 xbt_dynar_foreach (dyn,cpt,str) {
198 printf("Seen %s\n",str);
202 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
203 for (_xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
204 _xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
205 _xbt_dynar_cursor_step(_dynar,&(_cursor)) )
211 #endif /* _XBT_DYNAR_H */