Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / include / xbt / dynar.h
1 /* dynar - a generic dynamic array                                          */
2
3 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
4
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. */
7
8 #ifndef XBT_DYNAR_H
9 #define XBT_DYNAR_H
10
11 #include <string.h>             /* memcpy */
12
13 #include <xbt/base.h> /* SG_BEGIN_DECL */
14 #include <xbt/function_types.h>
15
16 SG_BEGIN_DECL()
17
18 /** @addtogroup XBT_dynar
19  * @brief DynArr are dynamically sized vector which may contain any type of variables.
20  *
21  * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
22  *
23  * For performance concerns, the content of DynArr must be homogeneous (in contrary to dictionnaries -- 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).
26  *
27  * @deprecated If you are using C++, you might want to use `std::vector` instead.
28  *
29  * @section XBT_dynar_exscal Example with scalar
30  * @dontinclude dynar.cpp
31  *
32  * @skip Vars_decl
33  * @skip dyn
34  * @until iptr
35  * @skip Populate_ints
36  * @skip dyn
37  * @until end_of_traversal
38  * @skip shifting
39  * @skip val
40  * @until xbt_dynar_free
41  *
42  * @section XBT_dynar_exptr Example with pointed data
43  *
44  * @skip test_dynar_string
45  * @skip dynar_t
46  * @until s2
47  * @skip Populate_str
48  * @skip dyn
49  * @until }
50  * @skip macro
51  * @until dynar_free
52  * @skip end_of_doxygen
53  * @until }
54  *
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.
58  */
59 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
60  *  @ingroup XBT_dynar
61  *
62  *  @{
63  */
64 /** @brief Dynar data type (opaque type) */
65 typedef struct xbt_dynar_s *xbt_dynar_t;
66
67 XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t const free_f);
68 XBT_PUBLIC void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, 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);
72 XBT_PUBLIC void xbt_dynar_free_data(xbt_dynar_t dynar);
73 XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
74 XBT_PUBLIC void xbt_dynar_dump(xbt_dynar_t dynar);
75
76 /** @} */
77 /** @defgroup XBT_dynar_array Dynar as a regular array
78  *  @ingroup XBT_dynar
79  *
80  *  @{
81  */
82
83 XBT_PUBLIC void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void* const dst);
84 XBT_PUBLIC void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void* src);
85 XBT_PUBLIC void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void* object);
86
87 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void* src);
88 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void* const dst);
89 XBT_PUBLIC void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx);
90
91 XBT_PUBLIC unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* elem);
92 XBT_PUBLIC signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem);
93 XBT_PUBLIC int xbt_dynar_member(xbt_dynar_t const dynar, void* elem);
94 XBT_PUBLIC void xbt_dynar_sort(xbt_dynar_t const dynar, int_f_cpvoid_cpvoid_t compar_fn);
95 XBT_PUBLIC xbt_dynar_t xbt_dynar_sort_strings(xbt_dynar_t dynar);
96 XBT_PUBLIC int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*));
97 XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar);
98
99 /** @} */
100 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
101  *  @ingroup XBT_dynar
102  *
103  *  @{
104  */
105
106 XBT_PUBLIC unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
107 XBT_PUBLIC int xbt_dynar_is_empty(const xbt_dynar_t dynar);
108 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t const dynar);
109 XBT_PUBLIC void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2);
110
111 /** @} */
112 /** @defgroup XBT_dynar_perl Perl-like use of dynars
113  *  @ingroup XBT_dynar
114  *
115  *  @{
116  */
117
118 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t const dynar, const void* src);
119 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst);
120 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* src);
121 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst);
122 XBT_PUBLIC void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
123
124 /** @} */
125 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
126  *  @ingroup XBT_dynar
127  *
128  *  Those functions do not retrieve the content, but only their address.
129  *
130  *  @{
131  */
132
133 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx);
134 XBT_PUBLIC void* xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx);
135 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
136 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t const dynar);
137 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
138
139 /** @} */
140 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
141  *  @ingroup XBT_dynar
142  *
143  *  While the other functions use a memcpy to retrieve the content into the user provided area, those ones use a
144  *  regular affectation. It only works for scalar values, but should be a little faster.
145  *
146  *  @{
147  */
148
149   /** @brief Quick retrieval of scalar content
150    *  @hideinitializer */
151 #  define xbt_dynar_get_as(dynar,idx,type) \
152           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
153 /** @brief Quick setting of scalar content
154  *  @hideinitializer */
155 #  define xbt_dynar_set_as(dynar,idx,type,val) \
156          (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
157   /** @brief Quick retrieval of scalar content
158    *  @hideinitializer */
159 #  define xbt_dynar_getlast_as(dynar,type) \
160           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
161   /** @brief Quick retrieval of scalar content
162    *  @hideinitializer */
163 #  define xbt_dynar_getfirst_as(dynar,type) \
164           (*(type*)xbt_dynar_get_ptr((dynar),0))
165   /** @brief Quick insertion of scalar content
166    *  @hideinitializer */
167 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
168           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
169   /** @brief Quick insertion of scalar content
170    *  @hideinitializer */
171 #  define xbt_dynar_push_as(dynar,type,value) \
172           *(type*)xbt_dynar_push_ptr(dynar)=value
173   /** @brief Quick removal of scalar content
174    *  @hideinitializer */
175 #  define xbt_dynar_pop_as(dynar,type) \
176            (*(type*)xbt_dynar_pop_ptr(dynar))
177
178 /** @} */
179 /** @defgroup XBT_dynar_cursor Cursors on dynar
180  *  @ingroup XBT_dynar
181  *
182  * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal. To remove
183  * elements, use the xbt_dynar_cursor_rm() function.
184  *
185  * Do not call these function directly, but only within the xbt_dynar_foreach macro.
186  *
187  *  @{
188  */
189
190 XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor);
191
192 /*
193  * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
194  *          This was made public to allow:
195  *           - the inlining of the foreach elements
196  *           - sending such beasts over the network
197  *
198  * @see xbt_dynar_length()
199  */
200 typedef struct xbt_dynar_s {
201   unsigned long size;
202   unsigned long used;
203   unsigned long elmsize;
204   void *data;
205   void_f_pvoid_t free_f;
206 } s_xbt_dynar_t;
207
208 static inline int _xbt_dynar_cursor_get(const xbt_dynar_t dynar, unsigned int idx, void* const dst)
209 {
210   if (!dynar) /* iterating over a NULL dynar is a no-op */
211     return 0;
212
213   if (idx >= dynar->used) {
214     //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
215     return 0;
216   }
217   //  XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
218
219   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
220
221   return 1;
222 }
223
224 /** @brief Iterates over the whole dynar.
225  *
226  *  @param _dynar what to iterate over
227  *  @param _cursor an integer used as cursor
228  *  @param _data
229  *  @hideinitializer
230  *
231  * Here is an example of usage:
232  * @code
233 xbt_dynar_t dyn;
234 unsigned int cpt;
235 string *str;
236 xbt_dynar_foreach (dyn,cpt,str) {
237   printf("Seen %s\n",str);
238 }
239 @endcode
240  *
241  * Note that underneath, that's a simple for loop with no real black  magic involved. It's perfectly safe to interrupt
242  * a foreach with a break or a return statement.
243  */
244 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
245        for ( (_cursor) = 0      ; \
246              _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
247              (_cursor)++         )
248
249 #ifndef __cplusplus
250 #define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \
251        for ((_cursor) = 0       ; \
252             (_ptr = _cursor < _dynar->used ? xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \
253             (_cursor)++         )
254 #else
255 #define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \
256        for ((_cursor) = 0       ; \
257             (_ptr = _cursor < _dynar->used ? (decltype(_ptr)) xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \
258             (_cursor)++         )
259 #endif
260 /** @} */
261 SG_END_DECL()
262
263 #ifdef __cplusplus
264 namespace simgrid {
265 namespace xbt {
266 /** Dynar of `T*` which `delete` its values */
267 template <class T> inline xbt_dynar_t newDeleteDynar()
268 {
269   return xbt_dynar_new(sizeof(T*), [](void* p) { delete *(T**)p; });
270 }
271 }
272 }
273 #endif
274
275 #endif /* XBT_DYNAR_H */