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 #include <stdlib.h> /* malloc() */
15 #include <string.h> /* strlen() */
17 typedef struct gras_dynar_s gras_dynar_t;
19 /* pointer to a function freeing something */
20 typedef void (void_f_ppvoid_t)(void**);
21 typedef void (void_f_pvoid_t) (void*);
23 gras_error_t gras_dynar_new(gras_dynar_t **whereto,
25 void_f_pvoid_t *free_func);
26 void gras_dynar_free(gras_dynar_t *dynar);
27 void gras_dynar_free_container(gras_dynar_t *dynar);
29 size_t gras_dynar_length(const gras_dynar_t *dynar);
30 void gras_dynar_reset(gras_dynar_t *dynar);
33 /* regular array functions */
34 void gras_dynar_get(const gras_dynar_t *dynar,
36 gras_error_t gras_dynar_set(gras_dynar_t *dynar,
37 int idx, const void *src);
38 gras_error_t gras_dynar_remplace(gras_dynar_t *dynar,
39 int idx, const void *object);
41 /* perl array function */
42 gras_error_t gras_dynar_insert_at(gras_dynar_t *dynar,
43 int idx, const void *src);
44 void gras_dynar_remove_at(gras_dynar_t *dynar,
45 int idx, void *object);
46 gras_error_t gras_dynar_push (gras_dynar_t *dynar, const void *src);
47 void gras_dynar_pop (gras_dynar_t *dynar, void *dst);
48 gras_error_t gras_dynar_unshift (gras_dynar_t *dynar, const void *src);
49 void gras_dynar_shift (gras_dynar_t *dynar, void *dst);
50 void gras_dynar_map(const gras_dynar_t *dynar, void_f_pvoid_t *operator);
52 /* cursor functions */
53 void gras_dynar_cursor_first (const gras_dynar_t *dynar, int *cursor);
54 void gras_dynar_cursor_step (const gras_dynar_t *dynar,
56 int gras_dynar_cursor_get (const gras_dynar_t *dynar,
57 int *cursor, void *whereto);
61 * @_dynar: what to iterate over
62 * @_cursor: an integer used as cursor
65 * Iterates over the whole dynar. Example:
71 * gras_dynar_foreach (dyn,cpt,str) {
72 * printf("Seen %s\n",str);
75 #define gras_dynar_foreach(_dynar,_cursor,_data) \
76 for (gras_dynar_cursor_first(_dynar,&_cursor) ; \
77 gras_dynar_cursor_get(_dynar,&_cursor,&_data) ; \
78 gras_dynar_cursor_step(_dynar,&_cursor) )
80 for (gras_dynar_length(_dynar) && (_gras_dynar_cursor_first(_dynar,&_cursor), \
82 gras_dynar_length(_dynar) && gras_dynar_cursor_get(_dynar,&_cursor,&_data); \
83 gras_dynar_cursor_step(_dynar,&_cursor))
85 void gras_dynar_cursor_rm(gras_dynar_t * dynar,
88 #endif /* _GRAS_DYNAR_H */