include/xbt/dynar.h

   1 /* $Id$ */
   2
   3 /* dynar - a generic dynamic array                                         */
   4
   5 /* Authors: Martin Quinson                                                  */
   6 /* Copyright (C) 2003 the OURAGAN project.                                  */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9    under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef _XBT_DYNAR_H
  12 #define _XBT_DYNAR_H
  13
  14 #include "xbt/misc.h" /* BEGIN_DECL */
  15
  16 BEGIN_DECL
  17
  18 typedef struct xbt_dynar_s *xbt_dynar_t;
  19
  20 xbt_dynar_t  xbt_dynar_new(unsigned long elm_size,
  21                              void_f_pvoid_t *free_func);
  22 void          xbt_dynar_free(xbt_dynar_t *dynar);
  23 void          xbt_dynar_free_container(xbt_dynar_t *dynar);
  24
  25 unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
  26 void          xbt_dynar_reset(xbt_dynar_t dynar);
  27
  28
  29 /* regular array functions */
  30 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void *const dst);
  31 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
  32                          const int          idx);
  33
  34 #define xbt_dynar_get_as(dynar,idx,type) *(type*)xbt_dynar_get_ptr(dynar,idx)
  35
  36 void xbt_dynar_set(xbt_dynar_t dynar, int  idx, const void *src);
  37 void xbt_dynar_replace(xbt_dynar_t dynar,
  38                         int idx, const void *object);
  39
  40 /* perl array function */
  41
  42 void xbt_dynar_insert_at(xbt_dynar_t dynar,
  43                           int  idx, const void *src);
  44 void xbt_dynar_remove_at(xbt_dynar_t dynar,
  45                           int  idx, void *object);
  46 void xbt_dynar_push     (xbt_dynar_t dynar, const void *src);
  47 void xbt_dynar_pop      (xbt_dynar_t dynar, void *const dst);
  48 void xbt_dynar_unshift  (xbt_dynar_t dynar, const void *src);
  49 void xbt_dynar_shift    (xbt_dynar_t dynar, void *const dst);
  50 void xbt_dynar_map      (const xbt_dynar_t dynar, void_f_pvoid_t *operator);
  51
  52 /* speed-optimized versions */
  53 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
  54                                const int          idx);
  55 void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
  56 void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
  57
  58 #define xbt_dynar_insert_at_as(dynar,idx,type,value) *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
  59 #define xbt_dynar_push_as(dynar,type,value) *(type*)xbt_dynar_push_ptr(dynar)=value
  60 #define xbt_dynar_pop_as(dynar,type) *(type*)xbt_dynar_pop_ptr(dynar)
  61
  62
  63 /* cursor functions */
  64 void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
  65 void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
  66 int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor, void *whereto);
  67
  68 /**
  69  * xbt_dynar_foreach:
  70  * @_dynar: what to iterate over
  71  * @_cursor: an integer used as cursor
  72  * @_data:
  73  *
  74  * Iterates over the whole dynar. Example:
  75  *
  76  * <programlisting>
  77  * xbt_dynar_t *dyn;
  78  * int cpt;
  79  * string *str;
  80  * xbt_dynar_foreach (dyn,cpt,str) {
  81  *   printf("Seen %s\n",str);
  82  * }</programlisting>
  83  */
  84 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
  85        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
  86             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
  87             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
  88 /*
  89        for (xbt_dynar_length(_dynar) && (_xbt_dynar_cursor_first(_dynar,&_cursor),      \
  90                                           1);     \
  91             xbt_dynar_length(_dynar) && xbt_dynar_cursor_get(_dynar,&_cursor,&_data); \
  92             xbt_dynar_cursor_step(_dynar,&_cursor))
  93 */
  94 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
  95                           int          *const cursor);
  96
  97 END_DECL
  98 #endif /* _XBT_DYNAR_H */