include/xbt/dynar.h

   1 /* dynar - a generic dynamic array                                          */
   2
   3 /* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved.          */
   4
   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. */
   7
   8 #ifndef XBT_DYNAR_H
   9 #define XBT_DYNAR_H
  10
  11 #include <string.h>             /* memcpy */
  12
  13 #include <xbt/base.h> /* SG_BEGIN_DECL */
  14 #include <xbt/function_types.h>
  15
  16 SG_BEGIN_DECL
  17
  18 /** @addtogroup XBT_dynar
  19  * @brief DynArr are dynamically sized vector which may contain any type of variables.
  20  *
  21  * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
  22  *
  23  * For performance concerns, the content of DynArr must be homogeneous (in contrary to dictionaries -- see the
  24  * @ref XBT_dict section). You thus have to provide the function which will be used to free the content at
  25  * structure creation (of type void_f_pvoid_t).
  26  *
  27  * @deprecated If you are using C++, you might want to use `std::vector` instead.
  28  *
  29  * @section XBT_dynar_exscal Example with scalar
  30  * @dontinclude dynar.cpp
  31  *
  32  * @skip Vars_decl
  33  * @skip dyn
  34  * @until iptr
  35  * @skip Populate_ints
  36  * @skip dyn
  37  * @until end_of_traversal
  38  * @skip shifting
  39  * @skip val
  40  * @until xbt_dynar_free
  41  *
  42  * @section XBT_dynar_exptr Example with pointed data
  43  *
  44  * @skip test_dynar_string
  45  * @skip dynar_t
  46  * @until s2
  47  * @skip Populate_str
  48  * @skip dyn
  49  * @until }
  50  * @skip macro
  51  * @until dynar_free
  52  * @skip end_of_doxygen
  53  * @until }
  54  *
  55  * Note that if you use dynars to store pointed data, the xbt_dynar_search(), xbt_dynar_search_or_negative() and
  56  * xbt_dynar_member() won't be for you. Instead of comparing your pointed elements, they compare the pointer to them.
  57  * See the documentation of xbt_dynar_search() for more info.
  58  */
  59 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  60  *  @ingroup XBT_dynar
  61  *
  62  *  @{
  63  */
  64 /** @brief Dynar data type (opaque type) */
  65 typedef struct xbt_dynar_s *xbt_dynar_t;
  66 typedef const struct xbt_dynar_s* const_xbt_dynar_t;
  67
  68 XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t free_f);
  69 XBT_PUBLIC void xbt_dynar_init(xbt_dynar_t dynar, unsigned long elmsize, void_f_pvoid_t free_f);
  70 XBT_PUBLIC void xbt_dynar_free(xbt_dynar_t* dynar);
  71 XBT_PUBLIC void xbt_dynar_free_voidp(void* dynar);
  72 XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar);
  73 XBT_PUBLIC void xbt_dynar_free_data(xbt_dynar_t dynar);
  74 XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
  75 XBT_PUBLIC void xbt_dynar_dump(const_xbt_dynar_t dynar);
  76
  77 /** @} */
  78 /** @defgroup XBT_dynar_array Dynar as a regular array
  79  *  @ingroup XBT_dynar
  80  *
  81  *  @{
  82  */
  83
  84 XBT_PUBLIC void xbt_dynar_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* dst);
  85 XBT_PUBLIC void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void* src);
  86 XBT_PUBLIC void xbt_dynar_replace(xbt_dynar_t dynar, unsigned long idx, const void* object);
  87
  88 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void* src);
  89 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void* dst);
  90 XBT_PUBLIC void xbt_dynar_remove_n_at(xbt_dynar_t dynar, unsigned int n, int idx);
  91
  92 XBT_PUBLIC unsigned int xbt_dynar_search(const_xbt_dynar_t dynar, const void* elem);
  93 XBT_PUBLIC signed int xbt_dynar_search_or_negative(const_xbt_dynar_t dynar, const void* elem);
  94 XBT_PUBLIC int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem);
  95 XBT_PUBLIC void xbt_dynar_sort(const_xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn);
  96 XBT_PUBLIC int xbt_dynar_compare(const_xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*));
  97 XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar);
  98
  99 /** @} */
 100 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
 101  *  @ingroup XBT_dynar
 102  *
 103  *  @{
 104  */
 105
 106 XBT_PUBLIC unsigned long xbt_dynar_length(const_xbt_dynar_t dynar);
 107 XBT_PUBLIC int xbt_dynar_is_empty(const_xbt_dynar_t dynar);
 108 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
 109 XBT_PUBLIC void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2);
 110
 111 /** @} */
 112 /** @defgroup XBT_dynar_perl Perl-like use of dynars
 113  *  @ingroup XBT_dynar
 114  *
 115  *  @{
 116  */
 117
 118 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t dynar, const void* src);
 119 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t dynar, void* dst);
 120 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t dynar, const void* src);
 121 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t dynar, void* dst);
 122 XBT_PUBLIC void xbt_dynar_map(const_xbt_dynar_t dynar, void_f_pvoid_t op);
 123
 124 /** @} */
 125 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 126  *  @ingroup XBT_dynar
 127  *
 128  *  Those functions do not retrieve the content, but only their address.
 129  *
 130  *  @{
 131  */
 132
 133 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, unsigned long idx);
 134 XBT_PUBLIC void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx);
 135 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t dynar, int idx);
 136 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t dynar);
 137 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t dynar);
 138
 139 /** @} */
 140 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 141  *  @ingroup XBT_dynar
 142  *
 143  *  While the other functions use a memcpy to retrieve the content into the user provided area, those ones use a
 144  *  regular affectation. It only works for scalar values, but should be a little faster.
 145  *
 146  *  @{
 147  */
 148
 149   /** @brief Quick retrieval of scalar content
 150    *  @hideinitializer */
 151 #  define xbt_dynar_get_as(dynar,idx,type) \
 152           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 153 /** @brief Quick setting of scalar content
 154  *  @hideinitializer */
 155 #define xbt_dynar_set_as(dynar, idx, type, val) (*(type*)xbt_dynar_set_at_ptr((dynar), (idx))) = (val)
 156 /** @brief Quick retrieval of scalar content
 157  *  @hideinitializer */
 158 #  define xbt_dynar_getlast_as(dynar,type) \
 159           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
 160 /** @brief Quick retrieval of scalar content
 161  *  @hideinitializer */
 162 #  define xbt_dynar_getfirst_as(dynar,type) \
 163           (*(type*)xbt_dynar_get_ptr((dynar),0))
 164 /** @brief Quick insertion of scalar content
 165  *  @hideinitializer */
 166 #define xbt_dynar_insert_at_as(dynar, idx, type, value) *(type*)xbt_dynar_insert_at_ptr((dynar), (idx)) = (value)
 167 /** @brief Quick insertion of scalar content
 168  *  @hideinitializer */
 169 #define xbt_dynar_push_as(dynar, type, value) *(type*)xbt_dynar_push_ptr(dynar) = (value)
 170 /** @brief Quick removal of scalar content
 171  *  @hideinitializer */
 172 #  define xbt_dynar_pop_as(dynar,type) \
 173            (*(type*)xbt_dynar_pop_ptr(dynar))
 174
 175 /** @} */
 176 /** @defgroup XBT_dynar_cursor Cursors on dynar
 177  *  @ingroup XBT_dynar
 178  *
 179  * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal. To remove
 180  * elements, use the xbt_dynar_cursor_rm() function.
 181  *
 182  * Do not call these function directly, but only within the xbt_dynar_foreach macro.
 183  *
 184  *  @{
 185  */
 186
 187 XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* cursor);
 188
 189 /*
 190  * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
 191  *          This was made public to allow:
 192  *           - the inlining of the foreach elements
 193  *           - sending such beasts over the network
 194  *
 195  * @see xbt_dynar_length()
 196  */
 197 typedef struct xbt_dynar_s {
 198   unsigned long size;
 199   unsigned long used;
 200   unsigned long elmsize;
 201   void *data;
 202   void_f_pvoid_t free_f;
 203 } s_xbt_dynar_t;
 204
 205 static inline int _xbt_dynar_cursor_get(const_xbt_dynar_t dynar, unsigned int idx, void* dst)
 206 {
 207   if (!dynar) /* iterating over a NULL dynar is a no-op */
 208     return 0;
 209
 210   if (idx >= dynar->used)
 211     return 0;
 212
 213   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
 214
 215   return 1;
 216 }
 217
 218 /** @brief Iterates over the whole dynar.
 219  *
 220  *  @param _dynar what to iterate over
 221  *  @param _cursor an integer used as cursor
 222  *  @param _data
 223  *  @hideinitializer
 224  *
 225  * Here is an example of usage:
 226  * @code
 227 xbt_dynar_t dyn;
 228 unsigned int cpt;
 229 string *str;
 230 xbt_dynar_foreach (dyn,cpt,str) {
 231   printf("Seen %s\n",str);
 232 }
 233 @endcode
 234  *
 235  * Note that underneath, that's a simple for loop with no real black  magic involved. It's perfectly safe to interrupt
 236  * a foreach with a break or a return statement.
 237  */
 238 #define xbt_dynar_foreach(_dynar, _cursor, _data)                                                                      \
 239   for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++)
 240
 241 #ifndef __cplusplus
 242 #define xbt_dynar_foreach_ptr(_dynar, _cursor, _ptr)                                                                   \
 243   for ((_cursor) = 0; ((_ptr) = (_cursor) < (_dynar)->used ? xbt_dynar_get_ptr((_dynar), (_cursor)) : NULL);           \
 244        (_cursor)++)
 245 #else
 246 #define xbt_dynar_foreach_ptr(_dynar, _cursor, _ptr)                                                                   \
 247   for ((_cursor) = 0;                                                                                                  \
 248        ((_ptr) = (_cursor) < (_dynar)->used ? (decltype(_ptr))xbt_dynar_get_ptr((_dynar), (_cursor)) : NULL);          \
 249        (_cursor)++)
 250 #endif
 251 /** @} */
 252 SG_END_DECL
 253
 254 #endif /* XBT_DYNAR_H */