include/xbt/dynar.h

   1 /* dynar - a generic dynamic array                                          */
   2
   3 /* Copyright (c) 2004-2019. 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 dictionnaries -- 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
  67 XBT_PUBLIC xbt_dynar_t xbt_dynar_new(const unsigned long elm_size, void_f_pvoid_t const free_f);
  68 XBT_PUBLIC void xbt_dynar_init(xbt_dynar_t dynar, const unsigned long elmsize, void_f_pvoid_t const free_f);
  69 XBT_PUBLIC void xbt_dynar_free(xbt_dynar_t* dynar);
  70 XBT_PUBLIC void xbt_dynar_free_voidp(void* dynar);
  71 XBT_PUBLIC void xbt_dynar_free_container(xbt_dynar_t* dynar);
  72 XBT_PUBLIC void xbt_dynar_free_data(xbt_dynar_t dynar);
  73 XBT_PUBLIC void xbt_dynar_shrink(xbt_dynar_t dynar, int empty_slots);
  74 XBT_PUBLIC void xbt_dynar_dump(xbt_dynar_t dynar);
  75
  76 /** @} */
  77 /** @defgroup XBT_dynar_array Dynar as a regular array
  78  *  @ingroup XBT_dynar
  79  *
  80  *  @{
  81  */
  82
  83 XBT_PUBLIC void xbt_dynar_get_cpy(const xbt_dynar_t dynar, const unsigned long idx, void* const dst);
  84 XBT_PUBLIC void xbt_dynar_set(xbt_dynar_t dynar, const int idx, const void* src);
  85 XBT_PUBLIC void xbt_dynar_replace(xbt_dynar_t dynar, const unsigned long idx, const void* object);
  86
  87 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t const dynar, const int idx, const void* src);
  88 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t const dynar, const int idx, void* const dst);
  89 XBT_PUBLIC void xbt_dynar_remove_n_at(xbt_dynar_t const dynar, const unsigned int n, const int idx);
  90
  91 XBT_PUBLIC unsigned int xbt_dynar_search(xbt_dynar_t const dynar, void* elem);
  92 XBT_PUBLIC signed int xbt_dynar_search_or_negative(xbt_dynar_t const dynar, void* const elem);
  93 XBT_PUBLIC int xbt_dynar_member(xbt_dynar_t const dynar, void* elem);
  94 XBT_PUBLIC void xbt_dynar_sort(xbt_dynar_t const dynar, int_f_cpvoid_cpvoid_t compar_fn);
  95 XBT_PUBLIC int xbt_dynar_compare(xbt_dynar_t d1, xbt_dynar_t d2, int (*compar)(const void*, const void*));
  96 XBT_PUBLIC void* xbt_dynar_to_array(xbt_dynar_t dynar);
  97
  98 /** @} */
  99 /** @defgroup XBT_dynar_misc Dynar miscellaneous functions
 100  *  @ingroup XBT_dynar
 101  *
 102  *  @{
 103  */
 104
 105 XBT_PUBLIC unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
 106 XBT_PUBLIC int xbt_dynar_is_empty(const xbt_dynar_t dynar);
 107 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t const dynar);
 108 XBT_PUBLIC void xbt_dynar_merge(xbt_dynar_t* d1, xbt_dynar_t* d2);
 109
 110 /** @} */
 111 /** @defgroup XBT_dynar_perl Perl-like use of dynars
 112  *  @ingroup XBT_dynar
 113  *
 114  *  @{
 115  */
 116
 117 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t const dynar, const void* src);
 118 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t const dynar, void* const dst);
 119 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t const dynar, const void* src);
 120 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t const dynar, void* const dst);
 121 XBT_PUBLIC void xbt_dynar_map(const xbt_dynar_t dynar, void_f_pvoid_t const op);
 122
 123 /** @} */
 124 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 125  *  @ingroup XBT_dynar
 126  *
 127  *  Those functions do not retrieve the content, but only their address.
 128  *
 129  *  @{
 130  */
 131
 132 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, const unsigned long idx);
 133 XBT_PUBLIC void* xbt_dynar_get_ptr(const xbt_dynar_t dynar, const unsigned long idx);
 134 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
 135 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t const dynar);
 136 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t const dynar);
 137
 138 /** @} */
 139 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 140  *  @ingroup XBT_dynar
 141  *
 142  *  While the other functions use a memcpy to retrieve the content into the user provided area, those ones use a
 143  *  regular affectation. It only works for scalar values, but should be a little faster.
 144  *
 145  *  @{
 146  */
 147
 148   /** @brief Quick retrieval of scalar content
 149    *  @hideinitializer */
 150 #  define xbt_dynar_get_as(dynar,idx,type) \
 151           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 152 /** @brief Quick setting of scalar content
 153  *  @hideinitializer */
 154 #  define xbt_dynar_set_as(dynar,idx,type,val) \
 155          (*(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) \
 167           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
 168   /** @brief Quick insertion of scalar content
 169    *  @hideinitializer */
 170 #  define xbt_dynar_push_as(dynar,type,value) \
 171           *(type*)xbt_dynar_push_ptr(dynar)=value
 172   /** @brief Quick removal of scalar content
 173    *  @hideinitializer */
 174 #  define xbt_dynar_pop_as(dynar,type) \
 175            (*(type*)xbt_dynar_pop_ptr(dynar))
 176
 177 /** @} */
 178 /** @defgroup XBT_dynar_cursor Cursors on dynar
 179  *  @ingroup XBT_dynar
 180  *
 181  * Cursors are used to iterate over the structure. Never add elements to the DynArr during the traversal. To remove
 182  * elements, use the xbt_dynar_cursor_rm() function.
 183  *
 184  * Do not call these function directly, but only within the xbt_dynar_foreach macro.
 185  *
 186  *  @{
 187  */
 188
 189 XBT_PUBLIC void xbt_dynar_cursor_rm(xbt_dynar_t dynar, unsigned int* const cursor);
 190
 191 /*
 192  * @warning DO NOT USE THIS STRUCTURE DIRECTLY! Instead, use the public interface:
 193  *          This was made public to allow:
 194  *           - the inlining of the foreach elements
 195  *           - sending such beasts over the network
 196  *
 197  * @see xbt_dynar_length()
 198  */
 199 typedef struct xbt_dynar_s {
 200   unsigned long size;
 201   unsigned long used;
 202   unsigned long elmsize;
 203   void *data;
 204   void_f_pvoid_t free_f;
 205 } s_xbt_dynar_t;
 206
 207 static inline int _xbt_dynar_cursor_get(const xbt_dynar_t dynar, unsigned int idx, void* const dst)
 208 {
 209   if (!dynar) /* iterating over a NULL dynar is a no-op */
 210     return 0;
 211
 212   if (idx >= dynar->used)
 213     return 0;
 214
 215   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
 216
 217   return 1;
 218 }
 219
 220 /** @brief Iterates over the whole dynar.
 221  *
 222  *  @param _dynar what to iterate over
 223  *  @param _cursor an integer used as cursor
 224  *  @param _data
 225  *  @hideinitializer
 226  *
 227  * Here is an example of usage:
 228  * @code
 229 xbt_dynar_t dyn;
 230 unsigned int cpt;
 231 string *str;
 232 xbt_dynar_foreach (dyn,cpt,str) {
 233   printf("Seen %s\n",str);
 234 }
 235 @endcode
 236  *
 237  * Note that underneath, that's a simple for loop with no real black  magic involved. It's perfectly safe to interrupt
 238  * a foreach with a break or a return statement.
 239  */
 240 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
 241        for ( (_cursor) = 0      ; \
 242              _xbt_dynar_cursor_get(_dynar,_cursor,&_data) ; \
 243              (_cursor)++         )
 244
 245 #ifndef __cplusplus
 246 #define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \
 247        for ((_cursor) = 0       ; \
 248             (_ptr = _cursor < _dynar->used ? xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \
 249             (_cursor)++         )
 250 #else
 251 #define xbt_dynar_foreach_ptr(_dynar,_cursor,_ptr) \
 252        for ((_cursor) = 0       ; \
 253             (_ptr = _cursor < _dynar->used ? (decltype(_ptr)) xbt_dynar_get_ptr(_dynar,_cursor) : NULL) ; \
 254             (_cursor)++         )
 255 #endif
 256 /** @} */
 257 SG_END_DECL()
 258
 259 #endif /* XBT_DYNAR_H */