3 /* dynar - a generic dynamic array */
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
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. */
13 #include "xbt/misc.h" /* SG_BEGIN_DECL */
14 #include "xbt/function_types.h"
18 /** @addtogroup XBT_dynar
19 * @brief DynArr are dynamically sized vector which may contain any type of variables.
21 * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
23 * For performance concerns, the content of DynArr must be homogeneous (in
24 * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
25 * have to provide the function which will be used to free the content at
26 * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
28 * \section XBT_dynar_exscal Example with scalar
29 * \dontinclude dynar.c
36 * \until end_of_traversal
39 * \until xbt_dynar_free
41 * \section XBT_dynar_exptr Example with pointed data
43 * \skip doxygen_string_cruft
51 * \skip end_of_doxygen
56 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
61 /** \brief Dynar data type (opaque type) */
62 typedef struct xbt_dynar_s *xbt_dynar_t;
65 xbt_dynar_t xbt_dynar_new(unsigned long elm_size,
66 void_f_pvoid_t *free_func);
67 void xbt_dynar_free(xbt_dynar_t *dynar);
68 void xbt_dynar_free_voidp(void *dynar);
69 void xbt_dynar_free_container(xbt_dynar_t *dynar);
71 unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
72 void xbt_dynar_reset(xbt_dynar_t dynar);
74 void xbt_dynar_dump(xbt_dynar_t dynar);
77 /** @defgroup XBT_dynar_array Dynar as a regular array
83 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
85 void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
86 void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
88 void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void *src);
89 void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void * const dst);
92 /** @defgroup XBT_dynar_perl Perl-like use of dynars
98 void xbt_dynar_push (xbt_dynar_t dynar, const void *src);
99 void xbt_dynar_pop (xbt_dynar_t dynar, void *const dst);
100 void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
101 void xbt_dynar_shift (xbt_dynar_t dynar, void *const dst);
102 void xbt_dynar_map (const xbt_dynar_t dynar, void_f_pvoid_t *op);
105 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
108 * Those functions do not retrieve the content, but only their address.
113 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
114 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
115 void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
116 void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
119 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
122 * While the other functions use a memcpy to retrieve the content into the
123 * user provided area, those ones use a regular affectation. It only works
124 * for scalar values, but should be a little faster.
129 /** @brief Quick retrieval of scalar content
130 * @hideinitializer */
131 # define xbt_dynar_get_as(dynar,idx,type) \
132 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
133 /** @brief Quick retrieval of scalar content
134 * @hideinitializer */
135 # define xbt_dynar_getlast_as(dynar,type) \
136 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
137 /** @brief Quick retrieval of scalar content
138 * @hideinitializer */
139 # define xbt_dynar_getfirst_as(dynar,type) \
140 (*(type*)xbt_dynar_get_ptr((dynar),0))
141 /** @brief Quick insertion of scalar content
142 * @hideinitializer */
143 # define xbt_dynar_insert_at_as(dynar,idx,type,value) \
144 *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
145 /** @brief Quick insertion of scalar content
146 * @hideinitializer */
147 # define xbt_dynar_push_as(dynar,type,value) \
148 *(type*)xbt_dynar_push_ptr(dynar)=value
149 /** @brief Quick insertion of scalar content
150 * @hideinitializer */
151 # define xbt_dynar_pop_as(dynar,type) \
152 (*(type*)xbt_dynar_pop_ptr(dynar))
155 /** @defgroup XBT_dynar_cursor Cursors on dynar
158 * Cursors are used to iterate over the structure. Never add elements to the
159 * DynArr during the traversal. To remove elements, use the
160 * xbt_dynar_cursor_rm() function
165 void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
166 void xbt_dynar_cursor_step (const xbt_dynar_t dynar, int *cursor);
167 int xbt_dynar_cursor_get (const xbt_dynar_t dynar, int *cursor,
169 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
173 /** @brief Iterates over the whole dynar.
175 * @param _dynar what to iterate over
176 * @param _cursor an integer used as cursor
180 * \note An example of usage:
185 xbt_dynar_foreach (dyn,cpt,str) {
186 printf("Seen %s\n",str);
190 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
191 for (xbt_dynar_cursor_first(_dynar,&(_cursor)) ; \
192 xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
193 xbt_dynar_cursor_step(_dynar,&(_cursor)) )
199 #endif /* _XBT_DYNAR_H */