Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
c95e61920c95f8ae9643e2bbf11223786de4faf7
[simgrid.git] / 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 /* pointer to a function freeing something */
21 typedef   void (void_f_ppvoid_t)(void**);
22 typedef   void (void_f_pvoid_t) (void*);
23
24 xbt_dynar_t  xbt_dynar_new(unsigned long elm_size, 
25                              void_f_pvoid_t *free_func);
26 void          xbt_dynar_free(xbt_dynar_t *dynar);
27 void          xbt_dynar_free_container(xbt_dynar_t *dynar);
28
29 unsigned long xbt_dynar_length(const xbt_dynar_t dynar);
30 void          xbt_dynar_reset(xbt_dynar_t dynar);
31
32
33 /* regular array functions */
34 void xbt_dynar_get_cpy(const xbt_dynar_t dynar, int idx, void *const dst);
35 void *xbt_dynar_get_ptr(const xbt_dynar_t dynar,
36                          const int          idx);
37
38 #define xbt_dynar_get_as(dynar,idx,type) *(type*)xbt_dynar_get_ptr(dynar,idx)
39   
40 void xbt_dynar_set(xbt_dynar_t dynar, int  idx, const void *src);
41 void xbt_dynar_replace(xbt_dynar_t dynar,
42                         int idx, const void *object);
43
44 /* perl array function */
45
46 void xbt_dynar_insert_at(xbt_dynar_t dynar,
47                           int  idx, const void *src);
48 void xbt_dynar_remove_at(xbt_dynar_t dynar,
49                           int  idx, void *object);
50 void xbt_dynar_push     (xbt_dynar_t dynar, const void *src);
51 void xbt_dynar_pop      (xbt_dynar_t dynar, void *const dst);
52 void xbt_dynar_unshift  (xbt_dynar_t dynar, const void *src);
53 void xbt_dynar_shift    (xbt_dynar_t dynar, void *const dst);
54 void xbt_dynar_map      (const xbt_dynar_t dynar, void_f_pvoid_t *operator);
55
56 /* speed-optimized versions */
57 void *xbt_dynar_insert_at_ptr(xbt_dynar_t const dynar,
58                                const int          idx);
59 void *xbt_dynar_push_ptr(xbt_dynar_t dynar);
60 void *xbt_dynar_pop_ptr(xbt_dynar_t dynar);
61
62 #define xbt_dynar_insert_at_as(dynar,idx,type,value) *(type*)xbt_dynar_insert_at_ptr(dynar,idx)=value
63 #define xbt_dynar_push_as(dynar,type,value) *(type*)xbt_dynar_push_ptr(dynar)=value
64 #define xbt_dynar_pop_as(dynar,type) *(type*)xbt_dynar_pop_ptr(dynar)
65
66
67 /* cursor functions */
68 void xbt_dynar_cursor_first (const xbt_dynar_t dynar, int *cursor);
69 void xbt_dynar_cursor_step  (const xbt_dynar_t dynar, int *cursor);
70 int  xbt_dynar_cursor_get   (const xbt_dynar_t dynar, int *cursor, void *whereto);
71
72 /**
73  * xbt_dynar_foreach:
74  * @_dynar: what to iterate over
75  * @_cursor: an integer used as cursor
76  * @_data:
77  *
78  * Iterates over the whole dynar. Example:
79  *
80  * <programlisting>
81  * xbt_dynar_t *dyn;
82  * int cpt;
83  * string *str;
84  * xbt_dynar_foreach (dyn,cpt,str) {
85  *   printf("Seen %s\n",str);
86  * }</programlisting>
87  */
88 #define xbt_dynar_foreach(_dynar,_cursor,_data) \
89        for (xbt_dynar_cursor_first(_dynar,&(_cursor))      ; \
90             xbt_dynar_cursor_get(_dynar,&(_cursor),&_data) ; \
91             xbt_dynar_cursor_step(_dynar,&(_cursor))         )
92 /*
93        for (xbt_dynar_length(_dynar) && (_xbt_dynar_cursor_first(_dynar,&_cursor),      \
94                                           1);     \
95             xbt_dynar_length(_dynar) && xbt_dynar_cursor_get(_dynar,&_cursor,&_data); \
96             xbt_dynar_cursor_step(_dynar,&_cursor))
97 */
98 void xbt_dynar_cursor_rm(xbt_dynar_t dynar,
99                           int          *const cursor);
100
101 END_DECL
102 #endif /* _XBT_DYNAR_H */