X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ad5365a072943b2b0bacc486fa504e93a99ea940..da03a3c837531ecf267b31e63f5a9cedb3d298ca:/include/xbt/fifo.h

diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h
index 15d9c951d9..1f152d5392 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-2015. 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;
@@ -34,6 +32,7 @@ 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(void) xbt_fifo_reset(xbt_fifo_t);
 /** @} */
 
 /** @defgroup XBT_fifo_perl Fifo perl-like functions
@@ -42,11 +41,12 @@ 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(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(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,9 +55,9 @@ XBT_PUBLIC(int) xbt_fifo_is_in(xbt_fifo_t, void *);
  *  @{
  */
 
-XBT_PUBLIC xbt_fifo_item_t xbt_fifo_new_item(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_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);
@@ -65,10 +65,12 @@ 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(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_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);
 
@@ -77,15 +79,15 @@ XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_get_prev_item(xbt_fifo_item_t i);
  * asserts and stuff
  * \param f a list (#xbt_fifo_t)
  * \param i a bucket (#xbt_fifo_item_t)
- * \param type a type
  * \param n an object of type \a type.
+ * \param type the type of objects contained in the fifo
  * @hideinitializer
  *
  * Iterates over the whole list. 
  */
 #define xbt_fifo_foreach(f,i,n,type)                  \
    for(i=xbt_fifo_get_first_item(f);                    \
-     ((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL));             \
+     ((i)?(n=(type)(xbt_fifo_get_item_content(i)),1):(0));             \
        i=xbt_fifo_get_next_item(i))
 
 /** @} */
@@ -95,7 +97,7 @@ 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(void **) xbt_fifo_to_array(xbt_fifo_t);
 XBT_PUBLIC(xbt_fifo_t) xbt_fifo_copy(xbt_fifo_t);
 /** @} */
 
@@ -110,5 +112,15 @@ XBT_PUBLIC(xbt_fifo_item_t) xbt_fifo_getPrevItem(xbt_fifo_item_t i);
 
 SG_END_DECL()
 
-
-#endif				/* _XBT_FIFO_H */
+#ifdef __cplusplus
+namespace simgrid {
+namespace xbt {
+  inline void destroy(xbt_fifo_t f)
+  {
+    xbt_fifo_free(f);
+  }
+}
+}
+#endif
+
+#endif                          /* _XBT_FIFO_H */