3 /* dynar - a generic dynamic array */
5 /* Authors: Martin Quinson */
6 /* Copyright (C) 2003 the OURAGAN project. */
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. */
14 typedef struct gras_dynar_s gras_dynar_t;
16 /* pointer to a function freeing something */
17 typedef void (void_f_ppvoid_t)(void**);
18 typedef void (void_f_pvoid_t) (void*);
20 gras_error_t gras_dynar_new(gras_dynar_t **whereto,
22 void_f_pvoid_t *free_func);
23 void gras_dynar_free(gras_dynar_t *dynar);
24 void gras_dynar_free_container(gras_dynar_t *dynar);
26 unsigned long gras_dynar_length(const gras_dynar_t *dynar);
27 void gras_dynar_reset(gras_dynar_t *dynar);
30 /* regular array functions */
31 void gras_dynar_get(const gras_dynar_t *dynar,
33 gras_error_t gras_dynar_set(gras_dynar_t *dynar,
34 int idx, const void *src);
35 gras_error_t gras_dynar_remplace(gras_dynar_t *dynar,
36 int idx, const void *object);
38 /* perl array function */
39 gras_error_t gras_dynar_insert_at(gras_dynar_t *dynar,
40 int idx, const void *src);
41 void gras_dynar_remove_at(gras_dynar_t *dynar,
42 int idx, void *object);
43 gras_error_t gras_dynar_push (gras_dynar_t *dynar, const void *src);
44 void gras_dynar_pop (gras_dynar_t *dynar, void *dst);
45 gras_error_t gras_dynar_unshift (gras_dynar_t *dynar, const void *src);
46 void gras_dynar_shift (gras_dynar_t *dynar, void *dst);
47 void gras_dynar_map(const gras_dynar_t *dynar, void_f_pvoid_t *operator);
49 /* cursor functions */
50 void gras_dynar_cursor_first (const gras_dynar_t *dynar, int *cursor);
51 void gras_dynar_cursor_step (const gras_dynar_t *dynar,
53 int gras_dynar_cursor_get (const gras_dynar_t *dynar,
54 int *cursor, void *whereto);
58 * @_dynar: what to iterate over
59 * @_cursor: an integer used as cursor
62 * Iterates over the whole dynar. Example:
68 * gras_dynar_foreach (dyn,cpt,str) {
69 * printf("Seen %s\n",str);
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)) )
77 for (gras_dynar_length(_dynar) && (_gras_dynar_cursor_first(_dynar,&_cursor), \
79 gras_dynar_length(_dynar) && gras_dynar_cursor_get(_dynar,&_cursor,&_data); \
80 gras_dynar_cursor_step(_dynar,&_cursor))
82 void gras_dynar_cursor_rm(gras_dynar_t * dynar,
85 #endif /* _GRAS_DYNAR_H */