1 /* dynar - a generic dynamic array */
3 /* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include <string.h> /* memcpy */
13 #include <xbt/base.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 contrary to dictionaries -- see the
24 * @ref XBT_dict section). You thus have to provide the function which will be used to free the content at
25 * structure creation (of type void_f_pvoid_t).
27 * @deprecated If you are using C++, you might want to use `std::vector` instead.
29 * @section XBT_dynar_exscal Example with scalar
30 * @dontinclude dynar.cpp
37 * @until end_of_traversal
40 * @until xbt_dynar_free
42 * @section XBT_dynar_exptr Example with pointed data
44 * @skip test_dynar_string
52 * @skip end_of_doxygen
55 * Note that if you use dynars to store pointed data, the xbt_dynar_search(), xbt_dynar_search_or_negative() and
56 * xbt_dynar_member() won't be for you. Instead of comparing your pointed elements, they compare the pointer to them.
57 * See the documentation of xbt_dynar_search() for more info.
59 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
64 /** @brief Dynar data type (opaque type) */
65 typedef struct xbt_dynar_s *xbt_dynar_t;
66 typedef const struct xbt_dynar_s* const_xbt_dynar_t;
68 XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t free_f);
69 XBT_PUBLIC void xbt_dynar_free(xbt_dynar_t* dynar);
70 XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar);
71 XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
74 /** @defgroup XBT_dynar_array Dynar as a regular array
80 XBT_PUBLIC void xbt_dynar_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* dst);
82 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void* src);
83 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void* dst);
85 XBT_PUBLIC signed int xbt_dynar_search_or_negative(const_xbt_dynar_t dynar, const void* elem);
86 XBT_PUBLIC int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem);
87 XBT_PUBLIC void xbt_dynar_sort(const_xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn);
88 XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar);
91 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
97 XBT_PUBLIC unsigned long xbt_dynar_length(const_xbt_dynar_t dynar);
98 XBT_PUBLIC int xbt_dynar_is_empty(const_xbt_dynar_t dynar);
99 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
102 /** @defgroup XBT_dynar_perl Perl-like use of dynars
108 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t dynar, const void* src);
109 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t dynar, void* dst);
110 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t dynar, const void* src);
111 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t dynar, void* dst);
112 XBT_PUBLIC void xbt_dynar_map(const_xbt_dynar_t dynar, void_f_pvoid_t op);
115 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
118 * Those functions do not retrieve the content, but only their address.
123 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, unsigned long idx);
124 XBT_PUBLIC void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx);
125 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t dynar, int idx);
126 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t dynar);
127 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t dynar);
130 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
133 * While the other functions use a memcpy to retrieve the content into the user provided area, those ones use a
134 * regular affectation. It only works for scalar values, but should be a little faster.
139 /** @brief Quick retrieval of scalar content
140 * @hideinitializer */
141 # define xbt_dynar_get_as(dynar,idx,type) \
142 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
143 /** @brief Quick setting of scalar content
144 * @hideinitializer */
145 #define xbt_dynar_set_as(dynar, idx, type, val) (*(type*)xbt_dynar_set_at_ptr((dynar), (idx))) = (val)
146 /** @brief Quick retrieval of scalar content
147 * @hideinitializer */
148 # define xbt_dynar_getlast_as(dynar,type) \
149 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
150 /** @brief Quick retrieval of scalar content
151 * @hideinitializer */
152 # define xbt_dynar_getfirst_as(dynar,type) \
153 (*(type*)xbt_dynar_get_ptr((dynar),0))
154 /** @brief Quick insertion of scalar content
155 * @hideinitializer */
156 #define xbt_dynar_push_as(dynar, type, value) *(type*)xbt_dynar_push_ptr(dynar) = (value)
157 /** @brief Quick removal of scalar content
158 * @hideinitializer */
159 # define xbt_dynar_pop_as(dynar,type) \
160 (*(type*)xbt_dynar_pop_ptr(dynar))
163 /** @defgroup XBT_dynar_cursor Cursors on dynar
166 * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal. To remove
167 * elements, use the xbt_dynar_cursor_rm() function.
169 * Do not call these function directly, but only within the xbt_dynar_foreach macro.
174 XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* cursor);
177 * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
178 * This was made public to allow:
179 * - the inlining of the foreach elements
180 * - sending such beasts over the network
182 * @see xbt_dynar_length()
184 typedef struct xbt_dynar_s {
187 unsigned long elmsize;
189 void_f_pvoid_t free_f;
192 static inline int _xbt_dynar_cursor_get(const_xbt_dynar_t dynar, unsigned int idx, void* dst)
194 if (!dynar) /* iterating over a NULL dynar is a no-op */
197 if (idx >= dynar->used)
200 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
205 /** @brief Iterates over the whole dynar.
207 * @param _dynar what to iterate over
208 * @param _cursor an integer used as cursor
212 * Here is an example of usage:
217 xbt_dynar_foreach (dyn,cpt,str) {
218 printf("Seen %s\n",str);
222 * Note that underneath, that's a simple for loop with no real black magic involved. It's perfectly safe to interrupt
223 * a foreach with a break or a return statement.
225 #define xbt_dynar_foreach(_dynar, _cursor, _data) \
226 for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++)
231 #endif /* XBT_DYNAR_H */