1 /* Copyright (c) 2004-2007, 2009-2015. 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 functionality as dynamic arrays
18 * but in time O(1). However these functions use malloc/free way too much often.
20 * @deprecated If you are using C++, you might want to used `std::list`,
21 * `std::deque` or `std::queue instead`.
24 /** @defgroup XBT_fifo_cons Fifo constructor and destructor
29 /** \brief Bucket structure
31 typedef struct xbt_fifo_item *xbt_fifo_item_t;
33 /** \brief FIFO structure
35 typedef struct xbt_fifo *xbt_fifo_t;
37 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_new(void);
38 XBT_PUBLIC(void) xbt_fifo_free(xbt_fifo_t l);
39 XBT_PUBLIC(void) xbt_fifo_reset(xbt_fifo_t l);
42 /** @defgroup XBT_fifo_perl Fifo perl-like functions
47 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t l, void *t);
48 XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t l);
49 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t l, void *t);
50 XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t l);
51 XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t l);
52 XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t l, void *t);
53 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_search_item(xbt_fifo_t f, int_f_pvoid_pvoid_t cmp_fun, void *closure);
56 /** @defgroup XBT_fifo_direct Direct access to fifo elements
62 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void);
63 XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t i, void *v);
64 XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t i);
65 XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t i);
67 XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t l, xbt_fifo_item_t i);
68 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t i);
69 XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t l, xbt_fifo_item_t i);
70 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t l);
72 XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t l, void *t);
73 XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t l, void *t);
74 XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t i);
76 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l);
77 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_last_item(xbt_fifo_t l);
78 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_next_item(xbt_fifo_item_t i);
79 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i);
82 * \brief List iterator
84 * \param f a list (#xbt_fifo_t)
85 * \param i a bucket (#xbt_fifo_item_t)
86 * \param n an object of type \a type.
87 * \param type the type of objects contained in the fifo
90 * Iterates over the whole list.
92 #define xbt_fifo_foreach(f,i,n,type) \
93 for(i=xbt_fifo_get_first_item(f); \
94 ((i)?(n=(type)(xbt_fifo_get_item_content(i)),1):(0)); \
95 i=xbt_fifo_get_next_item(i))
99 /** @defgroup XBT_fifo_misc Misc fifo functions
104 XBT_PUBLIC(void **) xbt_fifo_to_array(xbt_fifo_t l);
105 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t l);
108 /* Deprecated functions: don't use! */
109 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_newitem(void);
110 XBT_PUBLIC(void) xbt_fifo_freeitem(xbt_fifo_item_t l);
112 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getFirstItem(xbt_fifo_t l);
113 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getNextItem(xbt_fifo_item_t i);
114 XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i);
118 #endif /* _XBT_FIFO_H */