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