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

diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h
index b59e0b1af2..46becae17e 100644
--- a/include/xbt/fifo.h
+++ b/include/xbt/fifo.h
@@ -1,45 +1,133 @@
-/* Authors: Arnaud Legrand                                                  */
+/* 	$Id$	 */
+
+/* Copyright (c) 2004 Arnaud Legrand. 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. */
+ * 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 */
+
+SG_BEGIN_DECL()
+
+/** @addtogroup XBT_fifo
+ *  @brief This section describes the API to generic workqueue.
+ *
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
+ *                <tr><td><b>Prev</b>   <td> [\ref XBT_set]
+ *                <tr><td><b>Next</b>   <td> [\ref XBT_swag]       
+ *                <tr><td><b>Down</b>   <td> [\ref XBT_fifo_cons]        </table></center>
+ *
+ * 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.            
+ */
 
-/* Bucket structure */
+/** @defgroup XBT_fifo_cons Fifo constructor and destructor
+ *  @ingroup XBT_fifo
+ *
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ *                <tr><td>   Prev       <td> 
+ *                <tr><td><b>Next</b>   <td> [\ref XBT_fifo_perl]        </table></center>
+ *  @{
+ */
+
+/** \brief  Bucket structure 
+*/
 typedef struct xbt_fifo_item *xbt_fifo_item_t;
 
-/* FIFO structure */
+/** \brief  FIFO structure
+*/
 typedef struct xbt_fifo *xbt_fifo_t;
 
-/* API */
 xbt_fifo_t xbt_fifo_new(void);
 void xbt_fifo_free(xbt_fifo_t);
+/** @} */
 
-void xbt_fifo_push(xbt_fifo_t, void *);
+/** @defgroup XBT_fifo_perl Fifo perl-like functions
+ *  @ingroup XBT_fifo
+ *
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ *                <tr><td><b>Prev</b>   <td> [\ref XBT_fifo_cons]
+ *                <tr><td><b>Next</b>   <td> [\ref XBT_fifo_direct]        </table></center>
+ *  @{
+ */
+xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t, void *);
 void *xbt_fifo_pop(xbt_fifo_t);
-void xbt_fifo_unshift(xbt_fifo_t, void *);
+xbt_fifo_item_t xbt_fifo_unshift(xbt_fifo_t, void *);
 void *xbt_fifo_shift(xbt_fifo_t);
+int xbt_fifo_size(xbt_fifo_t);
+int xbt_fifo_is_in(xbt_fifo_t, void *);
+/** @} */
+
+/** @defgroup XBT_fifo_direct Direct access to fifo elements
+ *  @ingroup XBT_fifo
+ *
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ *                <tr><td><b>Prev</b>   <td> [\ref XBT_fifo_perl]
+ *                <tr><td><b>Next</b>   <td> [\ref XBT_fifo_misc]        </table></center>
+ *
+ *  @{
+ */
+
+xbt_fifo_item_t xbt_fifo_new_item(void);
+void xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
+void *xbt_fifo_get_item_content(xbt_fifo_item_t);
+void xbt_fifo_free_item(xbt_fifo_item_t);
+
+void xbt_fifo_push_item(xbt_fifo_t, xbt_fifo_item_t);
+xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t);
+void xbt_fifo_unshift_item(xbt_fifo_t, xbt_fifo_item_t);
+xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t);
 
 void xbt_fifo_remove(xbt_fifo_t, void *);
 void xbt_fifo_remove_item(xbt_fifo_t, xbt_fifo_item_t);
 
-int xbt_fifo_is_in(xbt_fifo_t, void *);
+xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l);
+xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i);
+xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i);
+
+/** 
+ * \brief List iterator
+ * 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.
+ * @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=xbt_fifo_get_next_item(i))
+
+/** @} */
 
+/** @defgroup XBT_fifo_misc Misc fifo functions
+ *  @ingroup XBT_fifo
+ *
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ *                <tr><td><b>Prev</b>   <td> [\ref XBT_fifo_direct]
+ *                <tr><td>   Next       <td>                     </table></center>
+ *
+ *  @{
+ */
 void **xbt_fifo_to_array(xbt_fifo_t);
 xbt_fifo_t xbt_fifo_copy(xbt_fifo_t);
+/** @} */
 
+/* Deprecated functions: don't use! */
 xbt_fifo_item_t xbt_fifo_newitem(void);
-void xbt_fifo_set_item_content(xbt_fifo_item_t, void *);
-void *xbt_fifo_get_item_content(xbt_fifo_item_t);
 void xbt_fifo_freeitem(xbt_fifo_item_t);
 
-int xbt_fifo_size(xbt_fifo_t);
+xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l);
+xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i);
+xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i);
+
 
-/* #define xbt_fifo_foreach(f,i,n,type)                  \ */
-/*    for(i=xbt_fifo_getFirstitem(f);                    \ */
-/*      ((i)?(n=(type)(i->content)):(NULL));             \ */
-/*        i=xbt_fifo_getNextitem(i)) */
+SG_END_DECL()
 
 
 #endif				/* _XBT_FIFO_H */