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 */
13 /** @addtogroup XBT_fifo
14 * @brief This section describes the API to generic workqueue.
16 * These functions provide the same kind of functionnality as dynamic arrays but in time O(1).
17 * However these functions use malloc/free way too much often.
19 /** @defgroup XBT_fifo_cons Fifo constructor and destructor
24 /** \brief Bucket structure
26 typedef struct xbt_fifo_item *xbt_fifo_item_t;
28 /** \brief FIFO structure
30 typedef struct xbt_fifo *xbt_fifo_t;
32 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_new(void);
33 XBT_PUBLIC(void) xbt_fifo_free(xbt_fifo_t);
36 /** @defgroup XBT_fifo_perl Fifo perl-like functions
41 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t, void *);
42 XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t);
43 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t, void *);
44 XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t);
45 XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t);
46 XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *);
49 /** @defgroup XBT_fifo_direct Direct access to fifo elements
55 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void);
56 XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
57 XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t);
58 XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t);
60 XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t);
61 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t);
62 XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t);
63 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t);
65 XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t, void *);
66 XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t, void *);
67 XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t);
69 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l);
70 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_last_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 */