Stupid me !

[simgrid.git] / include / xbt / fifo.h

diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h
index b59e0b1..8971ab5 100644 (file)
--- a/include/xbt/fifo.h
+++ b/include/xbt/fifo.h
@@ -1,26 +1,37 @@
-/* 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
 
-/* Bucket structure */
+/** \brief  Bucket structure 
+ *  \ingroup XBT_fifo
+*/
 typedef struct xbt_fifo_item *xbt_fifo_item_t;
 
-/* FIFO structure */
+/** \brief  FIFO structure
+ *  \ingroup XBT_fifo
+*/
 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 *);
+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);
 
+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);
 
@@ -36,10 +47,25 @@ void xbt_fifo_freeitem(xbt_fifo_item_t);
 
 int xbt_fifo_size(xbt_fifo_t);
 
-/* #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)) */
+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);
+
+/** 
+ * \brief List iterator
+ * \ingroup XBT_fifo
+ * 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.
+ *
+ * Iterates over the whole list. 
+ */
+#define xbt_fifo_foreach(f,i,n,type)                  \
+   for(i=xbt_fifo_getFirstItem(f);                    \
+     ((i)?(n=(type)(xbt_fifo_get_item_content(i))):(NULL));             \
+       i=xbt_fifo_getNextItem(i))
 
 
 #endif                         /* _XBT_FIFO_H */