Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the old crufty navigation bars
[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   * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
21   *  
22   * For performance concerns, the content of DynArr must be homogeneous (in
23   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
24   * have to provide the function which will be used to free the content at
25   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
26   *
27   * \section XBT_dynar_exscal Example with scalar
28   * \dontinclude dynar.c
29   *
30   * \skip Vars_decl
31   * \skip dyn
32   * \until iptr
33   * \skip Populate_ints
34   * \skip dyn
35   * \until end_of_traversal
36   * \skip shifting
37   * \skip val
38   * \until xbt_dynar_free
39   *
40   * \section XBT_dynar_exptr Example with pointed data
41   * 
42   * \skip doxygen_string_cruft
43   * \skip function
44   * \until s2
45   * \skip Populate_str
46   * \skip dyn
47   * \until }
48   * \skip macro
49   * \until dynar_free
50   * \skip end_of_doxygen
51   * \until }
52   *
53   */
54
55 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
56  *  @ingroup XBT_dynar
57  *
58  *  @{
59  */
60    /** \brief Dynar data type (opaque type) */
61    typedef struct xbt_dynar_s *xbt_dynar_t;
62
63
64   xbt_dynar_t   xbt_dynar_new(unsigned long elm_size, 
65                              void_f_pvoid_t *free_func);
66   void          xbt_dynar_free(xbt_dynar_t *dynar);
67   void          xbt_dynar_free_container(xbt_dynar_t *dynar);
68
69   unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
70   void          xbt_dynar_reset(xbt_dynar_t dynar);
71
72   void          xbt_dynar_dump(xbt_dynar_t dynar);
73
74 /** @} */
75 /** @defgroup XBT_dynar_array Dynar as a regular array
76  *  @ingroup XBT_dynar
77  *
78  *  @{
79  */
80
81   void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
82   
83   void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
84   void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
85
86   void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
87   void xbt_dynar_remove_at(xbt_dynar_t dynar, int  idx, void * const dst);
88
89 /** @} */
90 /** @defgroup XBT_dynar_perl Perl-like use of dynars
91  *  @ingroup XBT_dynar
92  *
93  *  @{
94  */
95
96   void xbt_dynar_push    (xbt_dynar_t dynar, const void *src);
97   void xbt_dynar_pop     (xbt_dynar_t dynar, void *const dst);
98   void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
99   void xbt_dynar_shift   (xbt_dynar_t dynar, void *const dst);
100   void xbt_dynar_map     (const xbt_dynar_t dynar, void_f_pvoid_t *op);
101
102 /** @} */
103 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
104  *  @ingroup XBT_dynar
105  *
106  *  Those functions do not retrive the content, but only their address.
107  *
108  *  @{
109  */
110
111   void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
112   void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
113   void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
114   void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
115
116 /** @} */
117 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
118  *  @ingroup XBT_dynar
119  *
120  *  While the other functions use a memcpy to retrive the content into the
121  *  user provided area, those ones use a regular affectation. It only works
122  *  for scalar values, but should be a little faster.
123  *
124  *  @{
125  */
126
127   /** @brief Quick retrieval of scalar content 
128    *  @hideinitializer */
129 #  define xbt_dynar_get_as(dynar,idx,type) \
130           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
131   /** @brief Quick retrieval of scalar content 
132    *  @hideinitializer */
133 #  define xbt_dynar_getlast_as(dynar,type) \
134           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
135   /** @brief Quick retrieval of scalar content 
136    *  @hideinitializer */
137 #  define xbt_dynar_getfirst_as(dynar,type) \
138           (*(type*)xbt_dynar_get_ptr((dynar),0))
139   /** @brief Quick insertion of scalar content 
140    *  @hideinitializer */
141 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
142           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
143   /** @brief Quick insertion of scalar content 
144    *  @hideinitializer */
145 #  define xbt_dynar_push_as(dynar,type,value) \
146           *(type*)xbt_dynar_push_ptr(dynar)=value
147   /** @brief Quick insertion of scalar content 
148    *  @hideinitializer */
149 #  define xbt_dynar_pop_as(dynar,type) \
150            (*(type*)xbt_dynar_pop_ptr(dynar))
151
152 /** @} */
153 /** @defgroup XBT_dynar_cursor Cursors on dynar
154  *  @ingroup XBT_dynar
155  *
156  * Cursors are used to iterate over the structure. Never add elements to the 
157  * DynArr during the traversal. To remove elements, use the
158  * xbt_dynar_cursor_rm() function
159  *
160  *  @{
161  */
162
163   void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
164   void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
165   int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor, 
166                                void *whereto);
167   void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
168                            int          *const cursor);
169
170
171 /** @brief Iterates over the whole dynar. 
172  * 
173  *  @param _dynar what to iterate over
174  *  @param _cursor an integer used as cursor
175  *  @param _data
176  *  @hideinitializer
177  *
178  * \note An example of usage:
179  * \code
180 xbt_dynar_t dyn;
181 int cpt;
182 string *str;
183 xbt_dynar_foreach (dyn,cpt,str) {
184   printf("Seen %s\n",str);
185 }
186 \endcode
187  */
188 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
189        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
190             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
191             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
192
193 /** @} */
194
195 SG_END_DECL()
196
197 #endif /* _XBT_DYNAR_H */