3 /* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "xbt/misc.h" /* SG_BEGIN_DECL */
14 /** @addtogroup XBT_fifo
15 * @brief This section describes the API to generic workqueue.
17 * These functions provide the same kind of functionnality as dynamic arrays but in time O(1).
18 * However these functions use malloc/free way too much often.
20 /** @defgroup XBT_fifo_cons Fifo constructor and destructor
25 /** \brief Bucket structure
27 typedef struct xbt_fifo_item *xbt_fifo_item_t;
29 /** \brief FIFO structure
31 typedef struct xbt_fifo *xbt_fifo_t;
33 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_new(void);
34 XBT_PUBLIC(void) xbt_fifo_free(xbt_fifo_t);
37 /** @defgroup XBT_fifo_perl Fifo perl-like functions
42 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t, void *);
43 XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t);
44 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t, void *);
45 XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t);
46 XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t);
47 XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *);
50 /** @defgroup XBT_fifo_direct Direct access to fifo elements
56 XBT_INLINE XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void);
57 XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
58 XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t);
59 XBT_INLINE XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t);
61 XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t);
62 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t);
63 XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t);
64 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t);
66 XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t, void *);
67 XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t, void *);
68 XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t);
70 XBT_INLINE XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l);
71 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_next_item(xbt_fifo_item_t i);
72 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i);
75 * \brief List iterator
77 * \param f a list (#xbt_fifo_t)
78 * \param i a bucket (#xbt_fifo_item_t)
80 * \param n an object of type \a type.
83 * Iterates over the whole list.
85 #define xbt_fifo_foreach(f,i,n,type) \
86 for(i=xbt_fifo_get_first_item(f); \
87 ((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL)); \
88 i=xbt_fifo_get_next_item(i))
92 /** @defgroup XBT_fifo_misc Misc fifo functions
97 XBT_PUBLIC(void **) xbt_fifo_to_array(xbt_fifo_t);
98 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t);
101 /* Deprecated functions: don't use! */
102 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_newitem(void);
103 XBT_PUBLIC(void) xbt_fifo_freeitem(xbt_fifo_item_t);
105 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getFirstItem(xbt_fifo_t l);
106 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getNextItem(xbt_fifo_item_t i);
107 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i);
111 #endif /* _XBT_FIFO_H */