include/xbt/dynar.h

   1 /* dynar - a generic dynamic array                                          */
   2
   3 /* Copyright (c) 2004-2021. 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, xbt_dynar_member() won't be for you. Instead of comparing your
  56  * pointed elements, it compares the pointer to them.
  57  */
  58 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  59  *  @ingroup XBT_dynar
  60  *
  61  *  @{
  62  */
  63 /** @brief Dynar data type (opaque type) */
  64 typedef struct xbt_dynar_s *xbt_dynar_t;
  65 typedef const struct xbt_dynar_s* const_xbt_dynar_t;
  66
  67 XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t free_f);
  68 XBT_PUBLIC void xbt_dynar_free(xbt_dynar_t* dynar);
  69 XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar);
  70 XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
  71
  72 /** @} */
  73 /** @defgroup XBT_dynar_array Dynar as a regular array
  74  *  @ingroup XBT_dynar
  75  *
  76  *  @{
  77  */
  78
  79 XBT_PUBLIC void xbt_dynar_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* dst);
  80
  81 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void* src);
  82 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void* dst);
  83
  84 XBT_PUBLIC int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem);
  85 XBT_PUBLIC void xbt_dynar_sort(const_xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn);
  86
  87 /** @} */
  88 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
  89  *  @ingroup XBT_dynar
  90  *
  91  *  @{
  92  */
  93
  94 XBT_PUBLIC unsigned long xbt_dynar_length(const_xbt_dynar_t dynar);
  95 XBT_PUBLIC int xbt_dynar_is_empty(const_xbt_dynar_t dynar);
  96 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
  97
  98 /** @} */
  99 /** @defgroup XBT_dynar_perl Perl-like use of dynars
 100  *  @ingroup XBT_dynar
 101  *
 102  *  @{
 103  */
 104
 105 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t dynar, const void* src);
 106 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t dynar, void* dst);
 107 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t dynar, const void* src);
 108 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t dynar, void* dst);
 109 XBT_PUBLIC void xbt_dynar_map(const_xbt_dynar_t dynar, void_f_pvoid_t op);
 110
 111 /** @} */
 112 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 113  *  @ingroup XBT_dynar
 114  *
 115  *  Those functions do not retrieve the content, but only their address.
 116  *
 117  *  @{
 118  */
 119
 120 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, unsigned long idx);
 121 XBT_PUBLIC void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx);
 122 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t dynar, int idx);
 123 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t dynar);
 124 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t dynar);
 125
 126 /** @} */
 127 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 128  *  @ingroup XBT_dynar
 129  *
 130  *  While the other functions use a memcpy to retrieve the content into the user provided area, those ones use a
 131  *  regular affectation. It only works for scalar values, but should be a little faster.
 132  *
 133  *  @{
 134  */
 135
 136   /** @brief Quick retrieval of scalar content
 137    *  @hideinitializer */
 138 #  define xbt_dynar_get_as(dynar,idx,type) \
 139           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 140 /** @brief Quick setting of scalar content
 141  *  @hideinitializer */
 142 #define xbt_dynar_set_as(dynar, idx, type, val) (*(type*)xbt_dynar_set_at_ptr((dynar), (idx))) = (val)
 143 /** @brief Quick retrieval of scalar content
 144  *  @hideinitializer */
 145 #  define xbt_dynar_getlast_as(dynar,type) \
 146           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
 147 /** @brief Quick retrieval of scalar content
 148  *  @hideinitializer */
 149 #  define xbt_dynar_getfirst_as(dynar,type) \
 150           (*(type*)xbt_dynar_get_ptr((dynar),0))
 151 /** @brief Quick insertion of scalar content
 152  *  @hideinitializer */
 153 #define xbt_dynar_push_as(dynar, type, value) *(type*)xbt_dynar_push_ptr(dynar) = (value)
 154 /** @brief Quick removal of scalar content
 155  *  @hideinitializer */
 156 #  define xbt_dynar_pop_as(dynar,type) \
 157            (*(type*)xbt_dynar_pop_ptr(dynar))
 158
 159 /** @} */
 160 /** @defgroup XBT_dynar_cursor Cursors on dynar
 161  *  @ingroup XBT_dynar
 162  *
 163  * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal.
 164  *
 165  *  @{
 166  */
 167
 168 /*
 169  * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
 170  *          This was made public to allow:
 171  *           - the inlining of the foreach elements
 172  *           - sending such beasts over the network
 173  *
 174  * @see xbt_dynar_length()
 175  */
 176 typedef struct xbt_dynar_s {
 177   unsigned long size;
 178   unsigned long used;
 179   unsigned long elmsize;
 180   void *data;
 181   void_f_pvoid_t free_f;
 182 } s_xbt_dynar_t;
 183
 184 static inline int _xbt_dynar_cursor_get(const_xbt_dynar_t dynar, unsigned int idx, void* dst)
 185 {
 186   if (!dynar) /* iterating over a NULL dynar is a no-op */
 187     return 0;
 188
 189   if (idx >= dynar->used)
 190     return 0;
 191
 192   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
 193
 194   return 1;
 195 }
 196
 197 /** @brief Iterates over the whole dynar.
 198  *
 199  *  @param _dynar what to iterate over
 200  *  @param _cursor an integer used as cursor
 201  *  @param _data
 202  *  @hideinitializer
 203  *
 204  * Here is an example of usage:
 205  * @code
 206 xbt_dynar_t dyn;
 207 unsigned int cpt;
 208 string *str;
 209 xbt_dynar_foreach (dyn,cpt,str) {
 210   printf("Seen %s\n",str);
 211 }
 212 @endcode
 213  *
 214  * Note that underneath, that's a simple for loop with no real black  magic involved. It's perfectly safe to interrupt
 215  * a foreach with a break or a return statement.
 216  */
 217 #define xbt_dynar_foreach(_dynar, _cursor, _data)                                                                      \
 218   for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++)
 219
 220 /** @} */
 221 SG_END_DECL
 222
 223 #endif /* XBT_DYNAR_H */