X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9361ad5f13f67578120a74bbbfba718292084cdb..fec5fff327fcad427d0a399ebc3dbbb35de2852e:/include/xbt/fifo.h diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h index 6d8feed3a8..c57456bd7e 100644 --- a/include/xbt/fifo.h +++ b/include/xbt/fifo.h @@ -1,13 +1,13 @@ -/* $Id$ */ - -/* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */ +/* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team. + * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ #ifndef _XBT_FIFO_H #define _XBT_FIFO_H -#include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/misc.h" /* SG_BEGIN_DECL */ +#include "xbt/function_types.h" /* int_f_pvoid_pvoid_t */ SG_BEGIN_DECL() @@ -17,13 +17,11 @@ SG_BEGIN_DECL() * These functions provide the same kind of functionnality as dynamic arrays but in time O(1). * However these functions use malloc/free way too much often. */ - /** @defgroup XBT_fifo_cons Fifo constructor and destructor * @ingroup XBT_fifo * * @{ */ - /** \brief Bucket structure */ typedef struct xbt_fifo_item *xbt_fifo_item_t; @@ -32,8 +30,9 @@ typedef struct xbt_fifo_item *xbt_fifo_item_t; */ typedef struct xbt_fifo *xbt_fifo_t; -XBT_PUBLIC xbt_fifo_t xbt_fifo_new(void); -XBT_PUBLIC void xbt_fifo_free(xbt_fifo_t); +XBT_PUBLIC(xbt_fifo_t) xbt_fifo_new(void); +XBT_PUBLIC(void) xbt_fifo_free(xbt_fifo_t); +XBT_PUBLIC(void) xbt_fifo_reset(xbt_fifo_t); /** @} */ /** @defgroup XBT_fifo_perl Fifo perl-like functions @@ -41,12 +40,13 @@ XBT_PUBLIC void xbt_fifo_free(xbt_fifo_t); * * @{ */ -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t, void *); -XBT_PUBLIC void *xbt_fifo_pop(xbt_fifo_t); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_unshift(xbt_fifo_t, void *); -XBT_PUBLIC void *xbt_fifo_shift(xbt_fifo_t); -XBT_PUBLIC int xbt_fifo_size(xbt_fifo_t); -XBT_PUBLIC int xbt_fifo_is_in(xbt_fifo_t, void *); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_push(xbt_fifo_t, void *); +XBT_PUBLIC(void *) xbt_fifo_pop(xbt_fifo_t); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_unshift(xbt_fifo_t, void *); +XBT_PUBLIC(void *) xbt_fifo_shift(xbt_fifo_t); +XBT_PUBLIC(int) xbt_fifo_size(xbt_fifo_t); +XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_search_item(xbt_fifo_t f, int_f_pvoid_pvoid_t cmp_fun, void *closure); /** @} */ /** @defgroup XBT_fifo_direct Direct access to fifo elements @@ -55,22 +55,24 @@ XBT_PUBLIC int xbt_fifo_is_in(xbt_fifo_t, void *); * @{ */ -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_new_item(void); -XBT_PUBLIC void xbt_fifo_set_item_content(xbt_fifo_item_t, void *); -XBT_PUBLIC void *xbt_fifo_get_item_content(xbt_fifo_item_t); -XBT_PUBLIC void xbt_fifo_free_item(xbt_fifo_item_t); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_new_item(void); +XBT_PUBLIC(void) xbt_fifo_set_item_content(xbt_fifo_item_t, void *); +XBT_PUBLIC(void *) xbt_fifo_get_item_content(xbt_fifo_item_t); +XBT_PUBLIC(void) xbt_fifo_free_item(xbt_fifo_item_t); -XBT_PUBLIC void xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t); -XBT_PUBLIC void xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t); +XBT_PUBLIC(void) xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_pop_item(xbt_fifo_t); +XBT_PUBLIC(void) xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_shift_item(xbt_fifo_t); -XBT_PUBLIC void xbt_fifo_remove(xbt_fifo_t, void *); -XBT_PUBLIC void xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t); +XBT_PUBLIC(int) xbt_fifo_remove(xbt_fifo_t, void *); +XBT_PUBLIC(int) xbt_fifo_remove_all(xbt_fifo_t, void *); +XBT_PUBLIC(void) xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_first_item(xbt_fifo_t l); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_last_item(xbt_fifo_t l); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_next_item(xbt_fifo_item_t i); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i); /** * \brief List iterator @@ -95,20 +97,18 @@ XBT_PUBLIC xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i); * * @{ */ -XBT_PUBLIC void **xbt_fifo_to_array(xbt_fifo_t); -XBT_PUBLIC xbt_fifo_t xbt_fifo_copy(xbt_fifo_t); +XBT_PUBLIC(void **) xbt_fifo_to_array(xbt_fifo_t); +XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t); /** @} */ /* Deprecated functions: don't use! */ -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_newitem(void); -XBT_PUBLIC void xbt_fifo_freeitem(xbt_fifo_item_t); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_newitem(void); +XBT_PUBLIC(void) xbt_fifo_freeitem(xbt_fifo_item_t); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i); -XBT_PUBLIC xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getFirstItem(xbt_fifo_t l); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getNextItem(xbt_fifo_item_t i); +XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i); SG_END_DECL() - - -#endif /* _XBT_FIFO_H */ +#endif /* _XBT_FIFO_H */