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" /* BEGIN_DECL */
  14
  15 BEGIN_DECL()
  16
  17 /** \addtogroup XBT_dynar
  18   *
  19   * For performance concerns, the content of DynArr must be homogeneous (in
  20   * contrary to dictionnaries -- see the \ref XBT_dict section). You thus
  21   * have to provide the function which will be used to free the content at
  22   * structure creation (of type void_f_ppvoid_t or void_f_pvoid_t).
  23   *
  24   * \section XBT_dynar_exscal Example with scalar
  25   * \dontinclude dynar_int.c
  26   *
  27   * \skip Vars_decl
  28   * \skip dyn
  29   * \until iptr
  30   * \skip Populate_ints
  31   * \skip dyn
  32   * \until end_of_traversal
  33   * \skip shifting
  34   * \skip val
  35   * \until xbt_dynar_free
  36   *
  37   * \section XBT_dynar_exptr Example with pointed data
  38   * \dontinclude dynar_string.c
  39   *
  40   * \skip doxygen_first_cruft
  41   * \skip f
  42   * \until xbt_init
  43   * \skip Populate_str
  44   * \skip dyn
  45   * \until }
  46   * \skip macro
  47   * \until dynar_free
  48   * \skip xbt_exit
  49   * \until }
  50   * @{
  51   */
  52
  53 /** @name 1. Constructor/destructor
  54  *  @{
  55  */
  56    /** \brief Dynar data type (opaque type) */
  57    typedef struct xbt_dynar_s *xbt_dynar_t;
  58
  59    /** \brief Pointer to a function freeing a pointed data */
  60    typedef void (void_f_ppvoid_t)(void**);
  61    /** \brief Pointer to a function freeing some data */
  62    typedef   void (void_f_pvoid_t) (void*);
  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_container(xbt_dynar_t *dynar);
  68
  69   unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
  70   void          xbt_dynar_reset(xbt_dynar_t dynar);
  71
  72   void          xbt_dynar_dump(xbt_dynar_t dynar);
  73
  74 /** @} */
  75 /** @name 2. regular array functions
  76  *  @{
  77  */
  78
  79   void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void *const dst);
  80
  81   void xbt_dynar_set(xbt_dynar_t dynar, int idx, const void *src);
  82   void xbt_dynar_replace(xbt_dynar_t dynar, int idx, const void *object);
  83
  84   void xbt_dynar_insert_at(xbt_dynar_t dynar, int  idx, const void *src);
  85   void xbt_dynar_remove_at(xbt_dynar_t dynar, int  idx, void *object);
  86
  87 /** @} */
  88 /** @name 2. Perl-like functions
  89  *  @{
  90  */
  91
  92   void xbt_dynar_push     (xbt_dynar_t dynar, const void *src);
  93   void xbt_dynar_pop      (xbt_dynar_t dynar, void *const dst);
  94   void xbt_dynar_unshift  (xbt_dynar_t dynar, const void *src);
  95   void xbt_dynar_shift    (xbt_dynar_t dynar, void *const dst);
  96   void xbt_dynar_map      (const xbt_dynar_t dynar, void_f_pvoid_t *operator);
  97
  98 /** @} */
  99 /** @name 3. Manipulating pointers to the content
 100  *
 101  *  Those functions do not retrive the content, but only their address.
 102  *
 103  *  @{
 104  */
 105
 106   void *xbt_dynar_get_ptr(const xbt_dynar_t dynar, const int idx);
 107   void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar, const int idx);
 108   void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
 109   void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
 110
 111 /** @} */
 112 /** @name 4. Speed optimized functions for scalars
 113  *
 114  *  While the other functions use a memcpy to retrive the content into the
 115  *  user provided area, those ones use a regular affectation. It only works
 116  *  for scalar values, but should be a little faster.
 117  *
 118  *  @{
 119  */
 120
 121   /** @brief Quick retrieval of scalar content
 122    *  @hideinitializer */
 123 #  define xbt_dynar_get_as(dynar,idx,type) \
 124           *(type*)xbt_dynar_get_ptr(dynar,idx)
 125   /** @brief Quick insertion of scalar content
 126    *  @hideinitializer */
 127 #  define xbt_dynar_insert_at_as(dynar,idx,type,value) \
 128           *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
 129   /** @brief Quick insertion of scalar content
 130    *  @hideinitializer */
 131 #  define xbt_dynar_push_as(dynar,type,value) \
 132           *(type*)xbt_dynar_push_ptr(dynar)=value
 133   /** @brief Quick insertion of scalar content
 134    *  @hideinitializer */
 135 #  define xbt_dynar_pop_as(dynar,type) \
 136            *(type*)xbt_dynar_pop_ptr(dynar)
 137
 138 /** @} */
 139 /** @name 5. Cursors on DynArr
 140  *
 141  * Cursors are used to iterate over the structure. Never add elements to the
 142  * DynArr during the traversal. To remove elements, use the
 143  * xbt_dynar_cursor_rm() function
 144  *
 145  *  @{
 146  */
 147
 148   void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
 149   void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
 150   int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor,
 151                                void *whereto);
 152   void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
 153                            int          *const cursor);
 154
 155
 156 /** @brief Iterates over the whole dynar.
 157  *
 158  *  @param _dynar what to iterate over
 159  *  @param _cursor an integer used as cursor
 160  *  @param _data
 161  *  @hideinitializer
 162  *
 163  * \note An example of usage:
 164  * \code
 165 xbt_dynar_t dyn;
 166 int cpt;
 167 string *str;
 168 xbt_dynar_foreach (dyn,cpt,str) {
 169   printf("Seen %s\n",str);
 170 }
 171 \endcode
 172  */
 173 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
 174        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
 175             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
 176             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
 177
 178
 179 END_DECL()
 180
 181 /* @} */
 182 #endif /* _XBT_DYNAR_H */