Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
79b590d6d053fda42c50133bf12254c99cfddd48
[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
96 XBT_PUBLIC(unsigned int) xbt_dynar_search(xbt_dynar_t const dynar, void *elem);
97 XBT_PUBLIC(signed int) xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void *const elem);
98 XBT_PUBLIC(int) xbt_dynar_member(xbt_dynar_t const dynar, void *elem);
99 XBT_PUBLIC(void) xbt_dynar_sort(xbt_dynar_t const dynar,
100                                 int_f_cpvoid_cpvoid_t compar_fn);
101 XBT_PUBLIC(void) xbt_dynar_three_way_partition(xbt_dynar_t const dynar,
102     int_f_pvoid_t color);
103 XBT_PUBLIC(int) xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2,
104                                   int(*compar)(const void *, const void *));
105 XBT_PUBLIC(void *) xbt_dynar_to_array (xbt_dynar_t dynar);
106
107 /** @} */
108 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
109  *  @ingroup XBT_dynar
110  *
111  *  @{
112  */
113
114 XBT_PUBLIC(unsigned long) xbt_dynar_length(const xbt_dynar_t dynar);
115 XBT_PUBLIC(int) xbt_dynar_is_empty(const xbt_dynar_t dynar);
116 XBT_PUBLIC(void) xbt_dynar_reset(xbt_dynar_t const dynar);
117 XBT_PUBLIC(void) xbt_dynar_merge(xbt_dynar_t *d1, xbt_dynar_t *d2);
118
119 /** @} */
120 /** @defgroup XBT_dynar_perl Perl-like use of dynars
121  *  @ingroup XBT_dynar
122  *
123  *  @{
124  */
125
126 XBT_PUBLIC(void) xbt_dynar_push(xbt_dynar_t const dynar, const void *src);
127 XBT_PUBLIC(void) xbt_dynar_pop(xbt_dynar_t const dynar, void *const dst);
128 XBT_PUBLIC(void) xbt_dynar_unshift(xbt_dynar_t const dynar,
129                                    const void *src);
130 XBT_PUBLIC(void) xbt_dynar_shift(xbt_dynar_t const dynar, void *const dst);
131 XBT_PUBLIC(void) xbt_dynar_map(const xbt_dynar_t dynar,
132                                void_f_pvoid_t const op);
133
134 /** @} */
135 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
136  *  @ingroup XBT_dynar
137  *
138  *  Those functions do not retrieve the content, but only their address.
139  *
140  *  @{
141  */
142
143 XBT_PUBLIC(void *) xbt_dynar_set_at_ptr(const xbt_dynar_t dynar,
144                                         const unsigned long idx);
145 XBT_PUBLIC(void *) xbt_dynar_get_ptr(const xbt_dynar_t dynar,
146                                      const unsigned long idx);
147 XBT_PUBLIC(void *) xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
148                                            const int idx);
149 XBT_PUBLIC(void *) xbt_dynar_push_ptr(xbt_dynar_t const dynar);
150 XBT_PUBLIC(void *) xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
151
152 /** @} */
153 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
154  *  @ingroup XBT_dynar
155  *
156  *  While the other functions use a memcpy to retrieve the content into the
157  *  user provided area, those ones use a regular affectation. It only works
158  *  for scalar values, but should be a little faster.
159  *
160  *  @{
161  */
162
163   /** @brief Quick retrieval of scalar content 
164    *  @hideinitializer */
165 #  define xbt_dynar_get_as(dynar,idx,type) \
166           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
167 /** @brief Quick setting of scalar content
168  *  @hideinitializer */
169 #  define xbt_dynar_set_as(dynar,idx,type,val) \
170          (*(type*)xbt_dynar_set_at_ptr((dynar),(idx))) = val
171   /** @brief Quick retrieval of scalar content 
172    *  @hideinitializer */
173 #  define xbt_dynar_getlast_as(dynar,type) \
174           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
175   /** @brief Quick retrieval of scalar content 
176    *  @hideinitializer */
177 #  define xbt_dynar_getfirst_as(dynar,type) \
178           (*(type*)xbt_dynar_get_ptr((dynar),0))
179   /** @brief Quick insertion of scalar content 
180    *  @hideinitializer */
181 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
182           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
183   /** @brief Quick insertion of scalar content 
184    *  @hideinitializer */
185 #  define xbt_dynar_push_as(dynar,type,value) \
186           *(type*)xbt_dynar_push_ptr(dynar)=value
187   /** @brief Quick removal of scalar content
188    *  @hideinitializer */
189 #  define xbt_dynar_pop_as(dynar,type) \
190            (*(type*)xbt_dynar_pop_ptr(dynar))
191
192 /** @} */
193 /** @defgroup XBT_dynar_cursor Cursors on dynar
194  *  @ingroup XBT_dynar
195  *
196  * Cursors are used to iterate over the structure. Never add elements to the 
197  * DynArr during the traversal. To remove elements, use the
198  * xbt_dynar_cursor_rm() function.
199  *
200  * Do not call these functions directly, but only the xbt_dynar_foreach macro.
201  * 
202  * For synchronized dynars, the dynar will be locked during the whole
203  * loop and it will get unlocked automatically if you traverse all
204  * elements. If you want to break the loop before the end, make sure
205  * to call xbt_dynar_cursor_unlock() before the <tt>break;</tt>
206  *
207  *  @{
208  */
209
210 XBT_PUBLIC(void) xbt_dynar_cursor_rm(xbt_dynar_t dynar,
211                                      unsigned int *const cursor);
212 XBT_PUBLIC(void) xbt_dynar_cursor_unlock(xbt_dynar_t dynar);
213
214 /* do not use this structure internals directly, but use the public interface
215  * This was made public to allow:
216  *  - the inlining of the foreach elements
217  *  - sending such beasts over the network
218  */
219
220 #include "xbt/synchro_core.h"
221 typedef struct xbt_dynar_s {
222   unsigned long size;
223   unsigned long used;
224   unsigned long elmsize;
225   void *data;
226   void_f_pvoid_t free_f;
227 } s_xbt_dynar_t;
228
229 static XBT_INLINE void
230 _xbt_dynar_cursor_first(const xbt_dynar_t dynar,
231                         unsigned int *const cursor)
232 {
233   /* iterating over a NULL dynar is a no-op (but we don't want to have uninitialized counters) */
234
235   //XBT_DEBUG("Set cursor on %p to the first position", (void *) dynar);
236   *cursor = 0;
237 }
238
239 static XBT_INLINE int
240 _xbt_dynar_cursor_get(const xbt_dynar_t dynar,
241                       unsigned int idx, void *const dst)
242 {
243   if (!dynar) /* iterating over a NULL dynar is a no-op */
244     return FALSE;
245
246   if (idx >= dynar->used) {
247     //XBT_DEBUG("Cursor on %p already on last elem", (void *) dynar);
248     return FALSE;
249   }
250   //  XBT_DEBUG("Cash out cursor on %p at %u", (void *) dynar, *idx);
251
252   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize,
253          dynar->elmsize);
254
255   return TRUE;
256 }
257
258
259
260 /** @brief Iterates over the whole dynar. 
261  * 
262  *  @param _dynar what to iterate over
263  *  @param _cursor an integer used as cursor
264  *  @param _data
265  *  @hideinitializer
266  *
267  * \note An example of usage:
268  * \code
269 xbt_dynar_t dyn;
270 unsigned int cpt;
271 string *str;
272 xbt_dynar_foreach (dyn,cpt,str) {
273   printf("Seen %s\n",str);
274 }
275 \endcode
276  */
277 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
278        for (_xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
279       _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
280             (_cursor)++         )
281
282 /** @} */
283
284 SG_END_DECL()
285 #endif                          /* _XBT_DYNAR_H */