Logo AND Algorithmique Numérique Distribuée

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