Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2cc56aa135b16684c57df8777f6d36aa8af31862
[simgrid.git] / include / xbt / dynar.h
1 /* $Id$ */
2
3 /* dynar - a generic dynamic array                                          */
4
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 #ifndef _XBT_DYNAR_H
11 #define _XBT_DYNAR_H
12
13 #include "xbt/misc.h" /* SG_BEGIN_DECL */
14
15 SG_BEGIN_DECL()
16
17 /** @addtogroup XBT_dynar
18   * @brief DynArr are dynamically sized vector which may contain any type of variables.
19   *
20   * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
21   *                <tr><td><b>Prev</b>   <td> [\ref XBT_config]
22   *                <tr><td><b>Next</b>   <td> [\ref XBT_dict]
23   *                <tr><td><b>Down</b>   <td> [\ref XBT_dynar_cons]        </table></center>
24   *
25   * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
26   *  
27   * For performance concerns, the content of DynArr must be homogeneous (in
28   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
29   * have to provide the function which will be used to free the content at
30   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
31   *
32   * \section XBT_dynar_exscal Example with scalar
33   * \dontinclude dynar_int.c
34   *
35   * \skip Vars_decl
36   * \skip dyn
37   * \until iptr
38   * \skip Populate_ints
39   * \skip dyn
40   * \until end_of_traversal
41   * \skip shifting
42   * \skip val
43   * \until xbt_dynar_free
44   *
45   * \section XBT_dynar_exptr Example with pointed data
46   * \dontinclude dynar_string.c
47   * 
48   * \skip doxygen_first_cruft
49   * \skip f
50   * \until xbt_init
51   * \skip Populate_str
52   * \skip dyn
53   * \until }
54   * \skip macro
55   * \until dynar_free
56   * \skip xbt_exit
57   * \until }
58   *
59   */
60
61 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
62  *  @ingroup XBT_dynar
63  *
64  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
65  *                <tr><td>   Prev       <td> 
66  *                <tr><td><b>Next</b>   <td> [\ref XBT_dynar_array]        </table></center>
67  *
68  *  @{
69  */
70    /** \brief Dynar data type (opaque type) */
71    typedef struct xbt_dynar_s *xbt_dynar_t;
72
73
74   xbt_dynar_t   xbt_dynar_new(unsigned long elm_size, 
75                              void_f_pvoid_t *free_func);
76   void          xbt_dynar_free(xbt_dynar_t *dynar);
77   void          xbt_dynar_free_container(xbt_dynar_t *dynar);
78
79   unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
80   void          xbt_dynar_reset(xbt_dynar_t dynar);
81
82   void          xbt_dynar_dump(xbt_dynar_t dynar);
83
84 /** @} */
85 /** @defgroup XBT_dynar_array Dynar as a regular array
86  *  @ingroup XBT_dynar
87  *
88  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
89  *                <tr><td><b>Prev</b>   <td> [\ref XBT_dynar_cons]
90  *                <tr><td><b>Next</b>   <td> [\ref XBT_dynar_perl]        </table></center>
91  *
92  *  @{
93  */
94
95   void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
96   
97   void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
98   void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
99
100   void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
101   void xbt_dynar_remove_at(xbt_dynar_t dynar, int  idx, void * const dst);
102
103 /** @} */
104 /** @defgroup XBT_dynar_perl Perl-like use of dynars
105  *  @ingroup XBT_dynar
106  *
107  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
108  *                <tr><td><b>Prev</b>   <td> [\ref XBT_dynar_array]
109  *                <tr><td><b>Next</b>   <td> [\ref XBT_dynar_ctn]        </table></center>
110  *
111  *  @{
112  */
113
114   void xbt_dynar_push    (xbt_dynar_t dynar, const void *src);
115   void xbt_dynar_pop     (xbt_dynar_t dynar, void *const dst);
116   void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
117   void xbt_dynar_shift   (xbt_dynar_t dynar, void *const dst);
118   void xbt_dynar_map     (const xbt_dynar_t dynar, void_f_pvoid_t *op);
119
120 /** @} */
121 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
122  *  @ingroup XBT_dynar
123  *
124  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
125  *                <tr><td><b>Prev</b>   <td> [\ref XBT_dynar_perl]
126  *                <tr><td><b>Next</b>   <td> [\ref XBT_dynar_speed]        </table></center>
127  *
128  *  Those functions do not retrive the content, but only their address.
129  *
130  *  @{
131  */
132
133   void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
134   void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
135   void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
136   void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
137
138 /** @} */
139 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
140  *  @ingroup XBT_dynar
141  *
142  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
143  *                <tr><td><b>Prev</b>   <td> [\ref XBT_dynar_ctn]
144  *                <tr><td><b>Next</b>   <td> [\ref XBT_dynar_cursor]        </table></center>
145  *
146  *  While the other functions use a memcpy to retrive the content into the
147  *  user provided area, those ones use a regular affectation. It only works
148  *  for scalar values, but should be a little faster.
149  *
150  *  @{
151  */
152
153   /** @brief Quick retrieval of scalar content 
154    *  @hideinitializer */
155 #  define xbt_dynar_get_as(dynar,idx,type) \
156           *(type*)xbt_dynar_get_ptr(dynar,idx)
157   /** @brief Quick insertion of scalar content 
158    *  @hideinitializer */
159 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
160           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
161   /** @brief Quick insertion of scalar content 
162    *  @hideinitializer */
163 #  define xbt_dynar_push_as(dynar,type,value) \
164           *(type*)xbt_dynar_push_ptr(dynar)=value
165   /** @brief Quick insertion of scalar content 
166    *  @hideinitializer */
167 #  define xbt_dynar_pop_as(dynar,type) \
168            *(type*)xbt_dynar_pop_ptr(dynar)
169
170 /** @} */
171 /** @defgroup XBT_dynar_cursor Cursors on dynar
172  *  @ingroup XBT_dynar
173  *
174  * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_dynar]
175  *                <tr><td><b>Prev</b>   <td> [\ref XBT_dynar_speed]
176  *                <tr><td>   Next       <td>                          </table></center>
177  *
178  * Cursors are used to iterate over the structure. Never add elements to the 
179  * DynArr during the traversal. To remove elements, use the
180  * xbt_dynar_cursor_rm() function
181  *
182  *  @{
183  */
184
185   void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
186   void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
187   int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor, 
188                                void *whereto);
189   void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
190                            int          *const cursor);
191
192
193 /** @brief Iterates over the whole dynar. 
194  * 
195  *  @param _dynar what to iterate over
196  *  @param _cursor an integer used as cursor
197  *  @param _data
198  *  @hideinitializer
199  *
200  * \note An example of usage:
201  * \code
202 xbt_dynar_t dyn;
203 int cpt;
204 string *str;
205 xbt_dynar_foreach (dyn,cpt,str) {
206   printf("Seen %s\n",str);
207 }
208 \endcode
209  */
210 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
211        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
212             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
213             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
214
215 /** @} */
216
217 SG_END_DECL()
218
219 #endif /* _XBT_DYNAR_H */