1 /* dynar - a generic dynamic array */
3 /* Copyright (c) 2004-2022. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include <string.h> /* memcpy */
13 #include <xbt/base.h> /* SG_BEGIN_DECL */
14 #include <xbt/function_types.h>
18 /** @brief Dynar data type (opaque type)
20 * These are the SimGrid version of the DYNamically sized ARays, which all C programmer recode one day or another.
21 * For performance concerns, the content of dynars must be homogeneous (in contrary to
22 * @verbatim embed:rst:inline :cpp:type:`xbt_dict_t` @endverbatim ).
23 * You thus have to provide the function which will be used to free the content at
24 * structure creation (of type void_f_pvoid_t).
26 typedef struct xbt_dynar_s *xbt_dynar_t;
28 typedef const struct xbt_dynar_s* const_xbt_dynar_t;
29 /* @warning DO NOT USE THIS STRUCTURE DIRECTLY! Use the public interface, even if it's public for sake of inlining */
30 typedef struct xbt_dynar_s {
33 unsigned long elmsize;
35 void_f_pvoid_t free_f;
38 XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t free_f);
39 XBT_PUBLIC void xbt_dynar_free(xbt_dynar_t* dynar);
40 XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar);
41 XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
43 /* Dynar as a regular array */
44 XBT_PUBLIC void xbt_dynar_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* dst);
46 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void* src);
47 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void* dst);
49 XBT_PUBLIC int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem);
50 XBT_PUBLIC void xbt_dynar_sort(const_xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn);
51 XBT_ATTRIB_DEPRECATED_v331("This function will be removed") XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar);
54 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
55 XBT_PUBLIC unsigned long xbt_dynar_length(const_xbt_dynar_t dynar);
56 XBT_PUBLIC int xbt_dynar_is_empty(const_xbt_dynar_t dynar);
58 /* Perl-like interface */
59 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t dynar, const void* src);
60 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t dynar, void* dst);
61 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t dynar, const void* src);
62 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t dynar, void* dst);
63 XBT_PUBLIC void xbt_dynar_map(const_xbt_dynar_t dynar, void_f_pvoid_t op);
65 /* Direct content manipulation*/
66 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, unsigned long idx);
67 XBT_PUBLIC void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx);
68 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t dynar, int idx);
69 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t dynar);
70 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t dynar);
72 /* Dynars of scalar */
73 /** @brief Quick retrieval of scalar content
75 # define xbt_dynar_get_as(dynar,idx,type) \
76 (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
77 /** @brief Quick setting of scalar content
79 #define xbt_dynar_set_as(dynar, idx, type, val) (*(type*)xbt_dynar_set_at_ptr((dynar), (idx))) = (val)
80 /** @brief Quick retrieval of scalar content
82 # define xbt_dynar_getlast_as(dynar,type) \
83 (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
84 /** @brief Quick retrieval of scalar content
86 # define xbt_dynar_getfirst_as(dynar,type) \
87 (*(type*)xbt_dynar_get_ptr((dynar),0))
88 /** @brief Quick insertion of scalar content
90 #define xbt_dynar_push_as(dynar, type, value) *(type*)xbt_dynar_push_ptr(dynar) = (value)
91 /** @brief Quick removal of scalar content
93 # define xbt_dynar_pop_as(dynar,type) \
94 (*(type*)xbt_dynar_pop_ptr(dynar))
96 /* Iterating over dynars */
97 static inline int _xbt_dynar_cursor_get(const_xbt_dynar_t dynar, unsigned int idx, void* dst)
99 if (!dynar) /* iterating over a NULL dynar is a no-op */
102 if (idx >= dynar->used)
105 memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
110 /** @brief Iterates over the whole dynar.
112 * @param _dynar what to iterate over
113 * @param _cursor an unsigned integer used as cursor
116 * Here is an example of usage:
121 xbt_dynar_foreach (dyn,cpt,str) {
122 printf("Seen %s\n",str);
126 * Note that underneath, that's a simple for loop with no real black magic involved. It's perfectly safe to interrupt
127 * a foreach with a break or a return statement, but inserting or removing elements during the traversal is probably a
128 * bad idea (even if you can fix side effects by manually changing the counter).
130 #define xbt_dynar_foreach(_dynar, _cursor, _data) \
131 for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++)
134 #endif /* XBT_DYNAR_H */