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 #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
  24   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
  25   * have to provide the function which will be used to free the content at
  26   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
  27   *
  28   * \section XBT_dynar_exscal Example with scalar
  29   * \dontinclude dynar.c
  30   *
  31   * \skip Vars_decl
  32   * \skip dyn
  33   * \until iptr
  34   * \skip Populate_ints
  35   * \skip dyn
  36   * \until end_of_traversal
  37   * \skip shifting
  38   * \skip val
  39   * \until xbt_dynar_free
  40   *
  41   * \section XBT_dynar_exptr Example with pointed data
  42   *
  43   * \skip doxygen_string_cruft
  44   * \skip function
  45   * \until s2
  46   * \skip Populate_str
  47   * \skip dyn
  48   * \until }
  49   * \skip macro
  50   * \until dynar_free
  51   * \skip end_of_doxygen
  52   * \until }
  53   *
  54   */
  55
  56 /** @defgroup XBT_dynar_cons Dynar constructor and destructor
  57  *  @ingroup XBT_dynar
  58  *
  59  *  @{
  60  */
  61    /** \brief Dynar data type (opaque type) */
  62    typedef struct xbt_dynar_s *xbt_dynar_t;
  63
  64
  65   xbt_dynar_t   xbt_dynar_new(unsigned long elm_size,
  66                              void_f_pvoid_t *free_func);
  67   void          xbt_dynar_free(xbt_dynar_t *dynar);
  68   void          xbt_dynar_free_voidp(void *dynar);
  69   void          xbt_dynar_free_container(xbt_dynar_t *dynar);
  70
  71   unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
  72   void          xbt_dynar_reset(xbt_dynar_t dynar);
  73
  74   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   void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void * const dst);
  84
  85   void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
  86   void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
  87
  88   void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
  89   void xbt_dynar_remove_at(xbt_dynar_t dynar, int  idx, void * const dst);
  90
  91 /** @} */
  92 /** @defgroup XBT_dynar_perl Perl-like use of dynars
  93  *  @ingroup XBT_dynar
  94  *
  95  *  @{
  96  */
  97
  98   void xbt_dynar_push    (xbt_dynar_t dynar, const void *src);
  99   void xbt_dynar_pop     (xbt_dynar_t dynar, void *const dst);
 100   void xbt_dynar_unshift (xbt_dynar_t dynar, const void *src);
 101   void xbt_dynar_shift   (xbt_dynar_t dynar, void *const dst);
 102   void xbt_dynar_map     (const xbt_dynar_t dynar, void_f_pvoid_t *op);
 103
 104 /** @} */
 105 /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content
 106  *  @ingroup XBT_dynar
 107  *
 108  *  Those functions do not retrieve the content, but only their address.
 109  *
 110  *  @{
 111  */
 112
 113   void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
 114   void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
 115   void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
 116   void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
 117
 118 /** @} */
 119 /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars
 120  *  @ingroup XBT_dynar
 121  *
 122  *  While the other functions use a memcpy to retrieve the content into the
 123  *  user provided area, those ones use a regular affectation. It only works
 124  *  for scalar values, but should be a little faster.
 125  *
 126  *  @{
 127  */
 128
 129   /** @brief Quick retrieval of scalar content
 130    *  @hideinitializer */
 131 #  define xbt_dynar_get_as(dynar,idx,type) \
 132           (*(type*)xbt_dynar_get_ptr((dynar),(idx)))
 133   /** @brief Quick retrieval of scalar content
 134    *  @hideinitializer */
 135 #  define xbt_dynar_getlast_as(dynar,type) \
 136           (*(type*)xbt_dynar_get_ptr((dynar),xbt_dynar_length(dynar)-1))
 137   /** @brief Quick retrieval of scalar content
 138    *  @hideinitializer */
 139 #  define xbt_dynar_getfirst_as(dynar,type) \
 140           (*(type*)xbt_dynar_get_ptr((dynar),0))
 141   /** @brief Quick insertion of scalar content
 142    *  @hideinitializer */
 143 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
 144           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
 145   /** @brief Quick insertion of scalar content
 146    *  @hideinitializer */
 147 #  define xbt_dynar_push_as(dynar,type,value) \
 148           *(type*)xbt_dynar_push_ptr(dynar)=value
 149   /** @brief Quick insertion of scalar content
 150    *  @hideinitializer */
 151 #  define xbt_dynar_pop_as(dynar,type) \
 152            (*(type*)xbt_dynar_pop_ptr(dynar))
 153
 154 /** @} */
 155 /** @defgroup XBT_dynar_cursor Cursors on dynar
 156  *  @ingroup XBT_dynar
 157  *
 158  * Cursors are used to iterate over the structure. Never add elements to the
 159  * DynArr during the traversal. To remove elements, use the
 160  * xbt_dynar_cursor_rm() function
 161  *
 162  *  @{
 163  */
 164
 165   void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
 166   void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
 167   int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor,
 168                                void *whereto);
 169   void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 170                            int          *const cursor);
 171
 172
 173 /** @brief Iterates over the whole dynar.
 174  *
 175  *  @param _dynar what to iterate over
 176  *  @param _cursor an integer used as cursor
 177  *  @param _data
 178  *  @hideinitializer
 179  *
 180  * \note An example of usage:
 181  * \code
 182 xbt_dynar_t dyn;
 183 int cpt;
 184 string *str;
 185 xbt_dynar_foreach (dyn,cpt,str) {
 186   printf("Seen %s\n",str);
 187 }
 188 \endcode
 189  */
 190 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
 191        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
 192             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
 193             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
 194
 195 /** @} */
 196
 197 SG_END_DECL()
 198
 199 #endif /* _XBT_DYNAR_H */