include/xbt/dynar.h

   1 /* $Id$ */
   2
   3 /* dynar - a generic dynamic array                                          */
   4
   5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #ifndef _XBT_DYNAR_H
  11 #define _XBT_DYNAR_H
  12
  13 #include "xbt/misc.h" /* SG_BEGIN_DECL */
  14
  15 SG_BEGIN_DECL()
  16
  17 /** @addtogroup XBT_dynar
  18   * @brief DynArr are dynamically sized vector which may contain any type of variables.
  19   *
  20   * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another.
  21   *
  22   * For performance concerns, the content of DynArr must be homogeneous (in
  23   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
  24   * have to provide the function which will be used to free the content at
  25   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
  26   *
  27   * \section XBT_dynar_exscal Example with scalar
  28   * \dontinclude dynar.c
  29   *
  30   * \skip Vars_decl
  31   * \skip dyn
  32   * \until iptr
  33   * \skip Populate_ints
  34   * \skip dyn
  35   * \until end_of_traversal
  36   * \skip shifting
  37   * \skip val
  38   * \until xbt_dynar_free
  39   *
  40   * \section XBT_dynar_exptr Example with pointed data
  41   *
  42   * \skip doxygen_string_cruft
  43   * \skip function
  44   * \until s2
  45   * \skip Populate_str
  46   * \skip dyn
  47   * \until }
  48   * \skip macro
  49   * \until dynar_free
  50   * \skip end_of_doxygen
  51   * \until }
  52   *
  53   */
  54
  55 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  56  *  @ingroup XBT_dynar
  57  *
  58  *  @{
  59  */
  60    /** \brief Dynar data type (opaque type) */
  61    typedef struct xbt_dynar_s *xbt_dynar_t;
  62
  63
  64   xbt_dynar_t   xbt_dynar_new(unsigned long elm_size,
  65                              void_f_pvoid_t *free_func);
  66   void          xbt_dynar_free(xbt_dynar_t *dynar);
  67   void          xbt_dynar_free_voidp(void *dynar);
  68   void          xbt_dynar_free_container(xbt_dynar_t *dynar);
  69
  70   unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
  71   void          xbt_dynar_reset(xbt_dynar_t dynar);
  72
  73   void          xbt_dynar_dump(xbt_dynar_t dynar);
  74
  75 /** @} */
  76 /** @defgroup XBT_dynar_array Dynar as a regular array
  77  *  @ingroup XBT_dynar
  78  *
  79  *  @{
  80  */
  81
  82   void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
  83
  84   void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
  85   void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
  86
  87   void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
  88   void xbt_dynar_remove_at(xbt_dynar_t dynar, int  idx, void * const dst);
  89
  90 /** @} */
  91 /** @defgroup XBT_dynar_perl Perl-like use of dynars
  92  *  @ingroup XBT_dynar
  93  *
  94  *  @{
  95  */
  96
  97   void xbt_dynar_push    (xbt_dynar_t dynar, const void *src);
  98   void xbt_dynar_pop     (xbt_dynar_t dynar, void *const dst);
  99   void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
 100   void xbt_dynar_shift   (xbt_dynar_t dynar, void *const dst);
 101   void xbt_dynar_map     (const xbt_dynar_t dynar, void_f_pvoid_t *op);
 102
 103 /** @} */
 104 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 105  *  @ingroup XBT_dynar
 106  *
 107  *  Those functions do not retrive the content, but only their address.
 108  *
 109  *  @{
 110  */
 111
 112   void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
 113   void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
 114   void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
 115   void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
 116
 117 /** @} */
 118 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 119  *  @ingroup XBT_dynar
 120  *
 121  *  While the other functions use a memcpy to retrive the content into the
 122  *  user provided area, those ones use a regular affectation. It only works
 123  *  for scalar values, but should be a little faster.
 124  *
 125  *  @{
 126  */
 127
 128   /** @brief Quick retrieval of scalar content
 129    *  @hideinitializer */
 130 #  define xbt_dynar_get_as(dynar,idx,type) \
 131           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 132   /** @brief Quick retrieval of scalar content
 133    *  @hideinitializer */
 134 #  define xbt_dynar_getlast_as(dynar,type) \
 135           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
 136   /** @brief Quick retrieval of scalar content
 137    *  @hideinitializer */
 138 #  define xbt_dynar_getfirst_as(dynar,type) \
 139           (*(type*)xbt_dynar_get_ptr((dynar),0))
 140   /** @brief Quick insertion of scalar content
 141    *  @hideinitializer */
 142 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
 143           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
 144   /** @brief Quick insertion of scalar content
 145    *  @hideinitializer */
 146 #  define xbt_dynar_push_as(dynar,type,value) \
 147           *(type*)xbt_dynar_push_ptr(dynar)=value
 148   /** @brief Quick insertion of scalar content
 149    *  @hideinitializer */
 150 #  define xbt_dynar_pop_as(dynar,type) \
 151            (*(type*)xbt_dynar_pop_ptr(dynar))
 152
 153 /** @} */
 154 /** @defgroup XBT_dynar_cursor Cursors on dynar
 155  *  @ingroup XBT_dynar
 156  *
 157  * Cursors are used to iterate over the structure. Never add elements to the
 158  * DynArr during the traversal. To remove elements, use the
 159  * xbt_dynar_cursor_rm() function
 160  *
 161  *  @{
 162  */
 163
 164   void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
 165   void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
 166   int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor,
 167                                void *whereto);
 168   void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 169                            int          *const cursor);
 170
 171
 172 /** @brief Iterates over the whole dynar.
 173  *
 174  *  @param _dynar what to iterate over
 175  *  @param _cursor an integer used as cursor
 176  *  @param _data
 177  *  @hideinitializer
 178  *
 179  * \note An example of usage:
 180  * \code
 181 xbt_dynar_t dyn;
 182 int cpt;
 183 string *str;
 184 xbt_dynar_foreach (dyn,cpt,str) {
 185   printf("Seen %s\n",str);
 186 }
 187 \endcode
 188  */
 189 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
 190        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
 191             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
 192             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
 193
 194 /** @} */
 195
 196 SG_END_DECL()
 197
 198 #endif /* _XBT_DYNAR_H */