1 /* dynar - a generic dynamic array */
3 /* Copyright (c) 2004-2007, 2009-2015. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include <string.h> /* memcpy */
14 #include "xbt/base.h" /* SG_BEGIN_DECL */
15 #include "xbt/function_types.h"
19 /** @addtogroup XBT_dynar
20 * @brief DynArr are dynamically sized vector which may contain any type of variables.
22 * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
24 * For performance concerns, the content of DynArr must be homogeneous (in contrary to dictionnaries -- see the
25 * \ref XBT_dict section). You thus 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.cpp
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
54 * Note that if you use dynars to store pointed data, the xbt_dynar_search(), xbt_dynar_search_or_negative() and
55 * xbt_dynar_member() won't be for you. Instead of comparing your pointed elements, they compare the pointer to them.
56 * See the documentation of xbt_dynar_search() for more info.
58 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
63 /** \brief Dynar data type (opaque type) */
64 typedef struct xbt_dynar_s *xbt_dynar_t;
66 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t const free_f);
67 XBT_PUBLIC(void) xbt_dynar_free(xbt_dynar_t * dynar);
68 XBT_PUBLIC(void) xbt_dynar_free_voidp(void *dynar);
69 XBT_PUBLIC(void) xbt_dynar_free_container(xbt_dynar_t * dynar);
70 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
71 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
74 /** @defgroup XBT_dynar_array Dynar as a regular array
80 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void *const dst);
81 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void *src);
82 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void *object);
84 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void *src);
85 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void *const dst);
86 XBT_PUBLIC(void) xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx);
88 XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
89 XBT_PUBLIC(signed int) xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem);
90 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
91 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar, int_f_cpvoid_cpvoid_t compar_fn);
92 XBT_PUBLIC(xbt_dynar_t) xbt_dynar_sort_strings(xbt_dynar_t dynar);
93 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar, int_f_pvoid_t color);
94 XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int(*compar)(const void *, const void *));
95 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
98 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
104 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
105 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
106 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
107 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
110 /** @defgroup XBT_dynar_perl Perl-like use of dynars
116 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
117 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
118 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar, const void *src);
119 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
120 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
123 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
126 * Those functions do not retrieve the content, but only their address.
131 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx);
132 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx);
133 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
134 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
135 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
138 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
141 * While the other functions use a memcpy to retrieve the content into the user provided area, those ones use a
142 * regular affectation. It only works for scalar values, but should be a little faster.
147 /** @brief Quick retrieval of scalar content
148 * @hideinitializer */
149 # define xbt_dynar_get_as(dynar,idx,type) \
150 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
151 /** @brief Quick setting of scalar content
152 * @hideinitializer */
153 # define xbt_dynar_set_as(dynar,idx,type,val) \
154 (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
155 /** @brief Quick retrieval of scalar content
156 * @hideinitializer */
157 # define xbt_dynar_getlast_as(dynar,type) \
158 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
159 /** @brief Quick retrieval of scalar content
160 * @hideinitializer */
161 # define xbt_dynar_getfirst_as(dynar,type) \
162 (*(type*)xbt_dynar_get_ptr((dynar),0))
163 /** @brief Quick insertion of scalar content
164 * @hideinitializer */
165 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
166 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
167 /** @brief Quick insertion of scalar content
168 * @hideinitializer */
169 # define xbt_dynar_push_as(dynar,type,value) \
170 *(type*)xbt_dynar_push_ptr(dynar)=value
171 /** @brief Quick removal of scalar content
172 * @hideinitializer */
173 # define xbt_dynar_pop_as(dynar,type) \
174 (*(type*)xbt_dynar_pop_ptr(dynar))
177 /** @defgroup XBT_dynar_cursor Cursors on dynar
180 * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal. To remove
181 * elements, use the xbt_dynar_cursor_rm() function.
183 * Do not call these function directly, but only within the xbt_dynar_foreach macro.
188 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int *const cursor);
191 * \warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
192 * This was made public to allow:
193 * - the inlining of the foreach elements
194 * - sending such beasts over the network
196 * \see xbt_dynar_length()
198 typedef struct xbt_dynar_s {
201 unsigned long elmsize;
203 void_f_pvoid_t free_f;
206 static inline int _xbt_dynar_cursor_get(const xbt_dynar_t dynar, unsigned int idx, void *const dst)
208 if (!dynar) /* iterating over a NULL dynar is a no-op */
211 if (idx >= dynar->used) {
212 //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
215 // XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
217 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
222 /** @brief Iterates over the whole dynar.
224 * @param _dynar what to iterate over
225 * @param _cursor an integer used as cursor
229 * Here is an example of usage:
234 xbt_dynar_foreach (dyn,cpt,str) {
235 printf("Seen %s\n",str);
239 * Note that underneath, that's a simple for loop with no real black magic involved. It's perfectly safe to interrupt
240 * a foreach with a break or a return statement.
242 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
243 for ( (_cursor) = 0 ; \
244 _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
248 #define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \
249 for ((_cursor) = 0 ; \
250 (_ptr = _cursor < _dynar->used ? xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \
253 #define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \
254 for ((_cursor) = 0 ; \
255 (_ptr = _cursor < _dynar->used ? (decltype(_ptr)) xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \
264 inline void destroy(xbt_dynar_t s)
272 #endif /* _XBT_DYNAR_H */