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

diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h
index a06a7e85e2..46becae17e 100644
--- a/include/xbt/fifo.h
+++ b/include/xbt/fifo.h
@@ -7,14 +7,28 @@
 
 #ifndef _XBT_FIFO_H
 #define _XBT_FIFO_H
-#include "xbt/misc.h" /* BEGIN_DECL */
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
 
-BEGIN_DECL()
+SG_BEGIN_DECL()
 
-/** \addtogroup XBT_fifo
- *  @{ */
+/** @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.            
+ */
 
-/** @name 1. Constructor/destructor
+/** @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>
  *  @{
  */
 
@@ -30,7 +44,12 @@ xbt_fifo_t xbt_fifo_new(void);
 void xbt_fifo_free(xbt_fifo_t);
 /** @} */
 
-/** @name 2. Perl-like functions
+/** @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 *);
@@ -41,15 +60,20 @@ int xbt_fifo_size(xbt_fifo_t);
 int xbt_fifo_is_in(xbt_fifo_t, void *);
 /** @} */
 
-/** @name 3. Manipulating directly items
+/** @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_newitem(void);
+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_freeitem(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);
@@ -59,9 +83,9 @@ 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);
 
-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);
+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
@@ -70,17 +94,23 @@ xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i);
  * \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_getFirstItem(f);                    \
+   for(i=xbt_fifo_get_first_item(f);                    \
      ((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL));             \
-       i=xbt_fifo_getNextItem(i))
+       i=xbt_fifo_get_next_item(i))
 
 /** @} */
 
-/** @name 4. Miscanaleous
+/** @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>
  *
  *  @{
  */
@@ -88,7 +118,16 @@ void **xbt_fifo_to_array(xbt_fifo_t);
 xbt_fifo_t xbt_fifo_copy(xbt_fifo_t);
 /** @} */
 
-END_DECL()
+/* Deprecated functions: don't use! */
+xbt_fifo_item_t xbt_fifo_newitem(void);
+void xbt_fifo_freeitem(xbt_fifo_item_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);
+
+
+SG_END_DECL()
+
 
-/** @} */
 #endif				/* _XBT_FIFO_H */