1 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/misc.h" /* SG_BEGIN_DECL */
10 #include "xbt/function_types.h" /* int_f_pvoid_pvoid_t */
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);
35 XBT_PUBLIC(void) xbt_fifo_reset(xbt_fifo_t);
38 /** @defgroup XBT_fifo_perl Fifo perl-like functions
43 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t, void *);
44 XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t);
45 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t, void *);
46 XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t);
47 XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t);
48 XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *);
49 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_search_item(xbt_fifo_t f, int_f_pvoid_pvoid_t cmp_fun, void *closure);
52 /** @defgroup XBT_fifo_direct Direct access to fifo elements
58 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void);
59 XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
60 XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t);
61 XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t);
63 XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t);
64 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t);
65 XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t);
66 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t);
68 XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t, void *);
69 XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t, void *);
70 XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t);
72 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l);
73 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_last_item(xbt_fifo_t l);
74 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_next_item(xbt_fifo_item_t i);
75 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i);
78 * \brief List iterator
80 * \param f a list (#xbt_fifo_t)
81 * \param i a bucket (#xbt_fifo_item_t)
83 * \param n an object of type \a type.
86 * Iterates over the whole list.
88 #define xbt_fifo_foreach(f,i,n,type) \
89 for(i=xbt_fifo_get_first_item(f); \
90 ((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL)); \
91 i=xbt_fifo_get_next_item(i))
95 /** @defgroup XBT_fifo_misc Misc fifo functions
100 XBT_PUBLIC(void **) xbt_fifo_to_array(xbt_fifo_t);
101 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t);
104 /* Deprecated functions: don't use! */
105 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_newitem(void);
106 XBT_PUBLIC(void) xbt_fifo_freeitem(xbt_fifo_item_t);
108 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getFirstItem(xbt_fifo_t l);
109 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getNextItem(xbt_fifo_item_t i);
110 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i);
114 #endif /* _XBT_FIFO_H */