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 _GRAS_DYNAR_H
  12 #define _GRAS_DYNAR_H
  13
  14 typedef struct gras_dynar_s gras_dynar_t;
  15
  16 /* pointer to a function freeing something */
  17 typedef   void (void_f_ppvoid_t)(void**);
  18 typedef   void (void_f_pvoid_t) (void*);
  19
  20 gras_dynar_t *gras_dynar_new(unsigned long elm_size,
  21                              void_f_pvoid_t *free_func);
  22 void          gras_dynar_free(gras_dynar_t *dynar);
  23 void          gras_dynar_free_container(gras_dynar_t *dynar);
  24
  25 unsigned long gras_dynar_length(const gras_dynar_t *dynar);
  26 void          gras_dynar_reset(gras_dynar_t *dynar);
  27
  28
  29 /* regular array functions */
  30 void gras_dynar_get_cpy(const gras_dynar_t *dynar, int idx, void *const dst);
  31 void *gras_dynar_get_ptr(const gras_dynar_t * const dynar,
  32                          const int                  idx);
  33
  34 #define gras_dynar_get_as(dynar,idx,type) *(type*)gras_dynar_get_ptr(dynar,idx)
  35
  36 void gras_dynar_set(gras_dynar_t *dynar, int  idx, const void *src);
  37 void gras_dynar_replace(gras_dynar_t *dynar,
  38                         int idx, const void *object);
  39
  40 /* perl array function */
  41 void gras_dynar_insert_at(gras_dynar_t *dynar,
  42                            int  idx, const void *src);
  43 void gras_dynar_remove_at(gras_dynar_t *dynar,
  44                            int  idx, void *object);
  45 void gras_dynar_push     (gras_dynar_t *dynar, const void *src);
  46 void gras_dynar_pop      (gras_dynar_t *dynar, void *const dst);
  47 void gras_dynar_unshift  (gras_dynar_t *dynar, const void *src);
  48 void gras_dynar_shift    (gras_dynar_t *dynar, void *const dst);
  49 void gras_dynar_map      (const gras_dynar_t *dynar, void_f_pvoid_t *operator);
  50
  51 /* cursor functions */
  52 void gras_dynar_cursor_first (const gras_dynar_t *dynar, int *cursor);
  53 void gras_dynar_cursor_step  (const gras_dynar_t *dynar, int *cursor);
  54 int  gras_dynar_cursor_get   (const gras_dynar_t *dynar, int *cursor, void *whereto);
  55
  56 /**
  57  * gras_dynar_foreach:
  58  * @_dynar: what to iterate over
  59  * @_cursor: an integer used as cursor
  60  * @_data:
  61  *
  62  * Iterates over the whole dynar. Example:
  63  *
  64  * <programlisting>
  65  * gras_dynar_t *dyn;
  66  * int cpt;
  67  * string *str;
  68  * gras_dynar_foreach (dyn,cpt,str) {
  69  *   printf("Seen %s\n",str);
  70  * }</programlisting>
  71  */
  72 #define gras_dynar_foreach(_dynar,_cursor,_data) \
  73        for (gras_dynar_cursor_first(_dynar,&(_cursor))      ; \
  74             gras_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
  75             gras_dynar_cursor_step(_dynar,&(_cursor))         )
  76 /*
  77        for (gras_dynar_length(_dynar) && (_gras_dynar_cursor_first(_dynar,&_cursor),      \
  78                                           1);     \
  79             gras_dynar_length(_dynar) && gras_dynar_cursor_get(_dynar,&_cursor,&_data); \
  80             gras_dynar_cursor_step(_dynar,&_cursor))
  81 */
  82 void gras_dynar_cursor_rm(gras_dynar_t * dynar,
  83                           int          * const cursor);
  84
  85 #endif /* _GRAS_DYNAR_H */