Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Added xbt_dynar_remove_n_at to remove an n-sized slice from a dynar
[simgrid.git] / include / xbt / dynar.h
1 /* dynar - a generic dynamic array                                          */
2
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9 #ifndef _XBT_DYNAR_H
10 #define _XBT_DYNAR_H
11
12 #include <string.h>             /* memcpy */
13
14 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
15 #include "xbt/function_types.h"
16
17 SG_BEGIN_DECL()
18
19 /** @addtogroup XBT_dynar
20   * @brief DynArr are dynamically sized vector which may contain any type of variables.
21   *
22   * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
23   *  
24   * For performance concerns, the content of DynArr must be homogeneous (in
25   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
26   * have to provide the function which will be used to free the content at
27   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
28   *
29   * \section XBT_dynar_exscal Example with scalar
30   * \dontinclude dynar.c
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   */
56 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
57  *  @ingroup XBT_dynar
58  *
59  *  @{
60  */
61    /** \brief Dynar data type (opaque type) */
62 typedef struct xbt_dynar_s *xbt_dynar_t;
63
64
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);
72 XBT_PUBLIC(void) xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
73 XBT_PUBLIC(void) xbt_dynar_dump(xbt_dynar_t dynar);
74
75 /** @} */
76 /** @defgroup XBT_dynar_array Dynar as a regular array
77  *  @ingroup XBT_dynar
78  *
79  *  @{
80  */
81
82 XBT_PUBLIC(void) xbt_dynar_get_cpy(const xbt_dynar_t dynar,
83                                    const unsigned long idx,
84                                    void *const dst);
85 XBT_PUBLIC(void) xbt_dynar_set(xbt_dynar_t dynar, const int idx,
86                                const void *src);
87 XBT_PUBLIC(void) xbt_dynar_replace(xbt_dynar_t dynar,
88                                    const unsigned long idx,
89                                    const void *object);
90
91 XBT_PUBLIC(void) xbt_dynar_insert_at(xbt_dynar_t const dynar,
92                                      const int idx, const void *src);
93 XBT_PUBLIC(void) xbt_dynar_remove_at(xbt_dynar_t const dynar,
94                                      const int idx, void *const dst);
95 XBT_PUBLIC(void) xbt_dynar_remove_n_at(xbt_dynar_t const dynar,
96                                      const unsigned int n, const int idx);
97
98
99 XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
100 XBT_PUBLIC(signed int) xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem);
101 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
102 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar,
103                                 int_f_cpvoid_cpvoid_t compar_fn);
104 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
105     int_f_pvoid_t color);
106 XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
107                                   int(*compar)(const void *, const void *));
108 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
109
110 /** @} */
111 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
112  *  @ingroup XBT_dynar
113  *
114  *  @{
115  */
116
117 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
118 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
119 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
120 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
121
122 /** @} */
123 /** @defgroup XBT_dynar_perl Perl-like use of dynars
124  *  @ingroup XBT_dynar
125  *
126  *  @{
127  */
128
129 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
130 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
131 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
132                                    const void *src);
133 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
134 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
135                                void_f_pvoid_t const op);
136
137 /** @} */
138 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
139  *  @ingroup XBT_dynar
140  *
141  *  Those functions do not retrieve the content, but only their address.
142  *
143  *  @{
144  */
145
146 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
147                                         const unsigned long idx);
148 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
149                                      const unsigned long idx);
150 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
151                                            const int idx);
152 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
153 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
154
155 /** @} */
156 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
157  *  @ingroup XBT_dynar
158  *
159  *  While the other functions use a memcpy to retrieve the content into the
160  *  user provided area, those ones use a regular affectation. It only works
161  *  for scalar values, but should be a little faster.
162  *
163  *  @{
164  */
165
166   /** @brief Quick retrieval of scalar content 
167    *  @hideinitializer */
168 #  define xbt_dynar_get_as(dynar,idx,type) \
169           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
170 /** @brief Quick setting of scalar content
171  *  @hideinitializer */
172 #  define xbt_dynar_set_as(dynar,idx,type,val) \
173          (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
174   /** @brief Quick retrieval of scalar content 
175    *  @hideinitializer */
176 #  define xbt_dynar_getlast_as(dynar,type) \
177           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
178   /** @brief Quick retrieval of scalar content 
179    *  @hideinitializer */
180 #  define xbt_dynar_getfirst_as(dynar,type) \
181           (*(type*)xbt_dynar_get_ptr((dynar),0))
182   /** @brief Quick insertion of scalar content 
183    *  @hideinitializer */
184 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
185           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
186   /** @brief Quick insertion of scalar content 
187    *  @hideinitializer */
188 #  define xbt_dynar_push_as(dynar,type,value) \
189           *(type*)xbt_dynar_push_ptr(dynar)=value
190   /** @brief Quick removal of scalar content
191    *  @hideinitializer */
192 #  define xbt_dynar_pop_as(dynar,type) \
193            (*(type*)xbt_dynar_pop_ptr(dynar))
194
195 /** @} */
196 /** @defgroup XBT_dynar_cursor Cursors on dynar
197  *  @ingroup XBT_dynar
198  *
199  * Cursors are used to iterate over the structure. Never add elements to the 
200  * DynArr during the traversal. To remove elements, use the
201  * xbt_dynar_cursor_rm() function.
202  *
203  * Do not call these functions directly, but only the xbt_dynar_foreach macro.
204  * 
205  * For synchronized dynars, the dynar will be locked during the whole
206  * loop and it will get unlocked automatically if you traverse all
207  * elements. If you want to break the loop before the end, make sure
208  * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
209  *
210  *  @{
211  */
212
213 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
214                                      unsigned int *const cursor);
215 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
216
217 /* do not use this structure internals directly, but use the public interface
218  * This was made public to allow:
219  *  - the inlining of the foreach elements
220  *  - sending such beasts over the network
221  */
222
223 #include "xbt/synchro_core.h"
224 typedef struct xbt_dynar_s {
225   unsigned long size;
226   unsigned long used;
227   unsigned long elmsize;
228   void *data;
229   void_f_pvoid_t free_f;
230 } s_xbt_dynar_t;
231
232 static XBT_INLINE void
233 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
234                         unsigned int *const cursor)
235 {
236   /* iterating over a NULL dynar is a no-op (but we don't want to have uninitialized counters) */
237
238   //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar);
239   *cursor = 0;
240 }
241
242 static XBT_INLINE int
243 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
244                       unsigned int idx, void *const dst)
245 {
246   if (!dynar) /* iterating over a NULL dynar is a no-op */
247     return FALSE;
248
249   if (idx >= dynar->used) {
250     //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
251     return FALSE;
252   }
253   //  XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
254
255   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
256          dynar->elmsize);
257
258   return TRUE;
259 }
260
261
262
263 /** @brief Iterates over the whole dynar. 
264  * 
265  *  @param _dynar what to iterate over
266  *  @param _cursor an integer used as cursor
267  *  @param _data
268  *  @hideinitializer
269  *
270  * \note An example of usage:
271  * \code
272 xbt_dynar_t dyn;
273 unsigned int cpt;
274 string *str;
275 xbt_dynar_foreach (dyn,cpt,str) {
276   printf("Seen %s\n",str);
277 }
278 \endcode
279  */
280 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
281        for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
282       _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
283             (_cursor)++         )
284
285 /** @} */
286
287 SG_END_DECL()
288 #endif                          /* _XBT_DYNAR_H */