include/xbt/dynar.h

   1 /* dynar - a generic dynamic array                                          */
   2
   3 /* Copyright (c) 2004-2022. 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 /** @brief Dynar data type (opaque type)
  19  *
  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).
  25  */
  26 typedef struct xbt_dynar_s *xbt_dynar_t;
  27 /** constant dynar */
  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 {
  31   unsigned long size;
  32   unsigned long used;
  33   unsigned long elmsize;
  34   void* data;
  35   void_f_pvoid_t free_f;
  36 } s_xbt_dynar_t;
  37
  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
  42 /* Dynar as a regular array */
  43 XBT_PUBLIC void xbt_dynar_get_cpy(const_xbt_dynar_t dynar, unsigned long idx, void* dst);
  44
  45 XBT_PUBLIC void xbt_dynar_insert_at(xbt_dynar_t dynar, int idx, const void* src);
  46 XBT_PUBLIC void xbt_dynar_remove_at(xbt_dynar_t dynar, int idx, void* dst);
  47
  48 XBT_PUBLIC int xbt_dynar_member(const_xbt_dynar_t dynar, const void* elem);
  49 XBT_PUBLIC void xbt_dynar_sort(const_xbt_dynar_t dynar, int_f_cpvoid_cpvoid_t compar_fn);
  50
  51 /* Dynar size */
  52 XBT_PUBLIC void xbt_dynar_reset(xbt_dynar_t dynar);
  53 XBT_PUBLIC unsigned long xbt_dynar_length(const_xbt_dynar_t dynar);
  54 XBT_PUBLIC int xbt_dynar_is_empty(const_xbt_dynar_t dynar);
  55
  56 /* Perl-like interface */
  57 XBT_PUBLIC void xbt_dynar_push(xbt_dynar_t dynar, const void* src);
  58 XBT_PUBLIC void xbt_dynar_pop(xbt_dynar_t dynar, void* dst);
  59 XBT_PUBLIC void xbt_dynar_unshift(xbt_dynar_t dynar, const void* src);
  60 XBT_PUBLIC void xbt_dynar_shift(xbt_dynar_t dynar, void* dst);
  61 XBT_PUBLIC void xbt_dynar_map(const_xbt_dynar_t dynar, void_f_pvoid_t op);
  62
  63 /* Direct content manipulation*/
  64 XBT_PUBLIC void* xbt_dynar_set_at_ptr(const xbt_dynar_t dynar, unsigned long idx);
  65 XBT_PUBLIC void* xbt_dynar_get_ptr(const_xbt_dynar_t dynar, unsigned long idx);
  66 XBT_PUBLIC void* xbt_dynar_insert_at_ptr(xbt_dynar_t dynar, int idx);
  67 XBT_PUBLIC void* xbt_dynar_push_ptr(xbt_dynar_t dynar);
  68 XBT_PUBLIC void* xbt_dynar_pop_ptr(xbt_dynar_t dynar);
  69
  70 /* Dynars of scalar */
  71 /** @brief Quick retrieval of scalar content
  72  *  @hideinitializer */
  73 #  define xbt_dynar_get_as(dynar,idx,type) \
  74           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
  75 /** @brief Quick setting of scalar content
  76  *  @hideinitializer */
  77 #define xbt_dynar_set_as(dynar, idx, type, val) (*(type*)xbt_dynar_set_at_ptr((dynar), (idx))) = (val)
  78 /** @brief Quick retrieval of scalar content
  79  *  @hideinitializer */
  80 #  define xbt_dynar_getlast_as(dynar,type) \
  81           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
  82 /** @brief Quick retrieval of scalar content
  83  *  @hideinitializer */
  84 #  define xbt_dynar_getfirst_as(dynar,type) \
  85           (*(type*)xbt_dynar_get_ptr((dynar),0))
  86 /** @brief Quick insertion of scalar content
  87  *  @hideinitializer */
  88 #define xbt_dynar_push_as(dynar, type, value) *(type*)xbt_dynar_push_ptr(dynar) = (value)
  89 /** @brief Quick removal of scalar content
  90  *  @hideinitializer */
  91 #  define xbt_dynar_pop_as(dynar,type) \
  92            (*(type*)xbt_dynar_pop_ptr(dynar))
  93
  94 /* Iterating over dynars */
  95 static inline int _xbt_dynar_cursor_get(const_xbt_dynar_t dynar, unsigned int idx, void* dst)
  96 {
  97   if (!dynar) /* iterating over a NULL dynar is a no-op */
  98     return 0;
  99
 100   if (idx >= dynar->used)
 101     return 0;
 102
 103   memcpy(dst, ((char *) dynar->data) + idx * dynar->elmsize, dynar->elmsize);
 104
 105   return 1;
 106 }
 107
 108 /** @brief Iterates over the whole dynar.
 109  *
 110  *  @param _dynar what to iterate over
 111  *  @param _cursor an unsigned integer used as cursor
 112  *  @hideinitializer
 113  *
 114  * Here is an example of usage:
 115  * @code
 116 xbt_dynar_t dyn;
 117 unsigned int cpt;
 118 char* str;
 119 xbt_dynar_foreach (dyn,cpt,str) {
 120   printf("Seen %s\n",str);
 121 }
 122 @endcode
 123  *
 124  * Note that underneath, that's a simple for loop with no real black  magic involved. It's perfectly safe to interrupt
 125  * a foreach with a break or a return statement, but inserting or removing elements during the traversal is probably a
 126  * bad idea (even if you can fix side effects by manually changing the counter).
 127  */
 128 #define xbt_dynar_foreach(_dynar, _cursor, _data)                                                                      \
 129   for ((_cursor) = 0; _xbt_dynar_cursor_get((_dynar), (_cursor), &(_data)); (_cursor)++)
 130 SG_END_DECL
 131
 132 #endif /* XBT_DYNAR_H */