X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/102ef4964f88946b246ed7bfb81b57ec2156de1d..7392b17f0fee990af059ca94a2141236aa24d0c1:/src/xbt/fifo.c

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index fc0bb912fc..e0c41218d5 100644
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -1,23 +1,35 @@
-/* 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. */
+
+#include "xbt/sysdep.h"
+#include "xbt/error.h"
+#include "fifo_private.h"
 
-#include <stdlib.h>
-#include "xbt_fifo_private.h"
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(fifo,xbt,"FIFO");
 
-/*
- * xbt_fifo_new()
+/** \name Functions 
+ *  \ingroup XBT_fifo
+ */
+/*@{*/
+
+/** Constructor
+ * \return a new fifo
  */
 xbt_fifo_t xbt_fifo_new(void)
 {
   xbt_fifo_t fifo;
-  fifo = (xbt_fifo_t) calloc(1, sizeof(struct xbt_fifo));
+  fifo = xbt_new0(struct xbt_fifo,1);
   return fifo;
 }
 
-/*
- * xbt_fifo_free()
+/** Destructor
+ * \param l poor victim
+ *
+ * Free the fifo structure. None of the objects that was in the fifo is however modified.
  */
 void xbt_fifo_free(xbt_fifo_t l)
 {
@@ -29,17 +41,90 @@ void xbt_fifo_free(xbt_fifo_t l)
   return;
 }
 
-/*
- * xbt_fifo_push()
- * at the tail
+/* Push
+ * \param l list
+ * \param t element
+ * \return the bucket that was just added
+ *
+ * Add an object at the tail of the list
  */
-void xbt_fifo_push(xbt_fifo_t l, void *t)
+xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t l, void *t)
+{
+  xbt_fifo_item_t new;
+
+  new = xbt_fifo_newitem();
+  new->content = t;
+
+  xbt_fifo_push_item(l,new);
+  return new;
+}
+
+/** Pop
+ * \param l list
+ * \returns the object stored at the tail of the list.
+ *
+ * Removes and returns the object stored at the tail of the list. 
+ * Returns NULL if the list is empty.
+ */
+void *xbt_fifo_pop(xbt_fifo_t l)
+{
+  xbt_fifo_item_t item;
+  void *content;
+
+  if(l==NULL) return NULL;
+  if(!(item = xbt_fifo_pop_item(l))) return NULL;
+
+  content = item->content;
+  xbt_fifo_freeitem(item);
+  return content;
+}
+
+/**
+ * \param l list
+ * \param t element
+ * \return the bucket that was just added
+ *
+ * Add an object at the head of the list
+ */
+xbt_fifo_item_t xbt_fifo_unshift(xbt_fifo_t l, void *t)
 {
   xbt_fifo_item_t new;
 
-  (l->count)++;
   new = xbt_fifo_newitem();
   new->content = t;
+  xbt_fifo_unshift_item(l,new);
+  return new;
+}
+
+/** Shift
+ * \param l list
+ * \returns the object stored at the head of the list.
+ *
+ * Removes and returns the object stored at the head of the list. 
+ * Returns NULL if the list is empty.
+ */
+void *xbt_fifo_shift(xbt_fifo_t l)
+{
+  xbt_fifo_item_t item;
+  void *content;
+
+  if(l==NULL) return NULL;
+  if(!(item = xbt_fifo_shift_item(l))) return NULL;
+  
+  content = item->content;
+  xbt_fifo_freeitem(item);
+  return content;
+}
+
+/** Push a bucket
+ * \param l list
+ * \param new bucket
+ *
+ * Hook up this bucket at the tail of the list
+ */
+void xbt_fifo_push_item(xbt_fifo_t l, xbt_fifo_item_t new)
+{
+  (l->count)++;
   if (l->head == NULL) {
     l->head = new;
     l->tail = new;
@@ -48,23 +133,22 @@ void xbt_fifo_push(xbt_fifo_t l, void *t)
   new->prev = l->tail;
   new->prev->next = new;
   l->tail = new;
-  return;
 }
 
-/*
- * xbt_fifo_pop()
- * from the tail
+/** Pop bucket
+ * \param l
+ * \returns the bucket that was at the tail of the list.
+ *
+ * Returns NULL if the list was empty.
  */
-void *xbt_fifo_pop(xbt_fifo_t l)
+xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
 {
   xbt_fifo_item_t item;
-  void *content;
 
   if (l->tail == NULL)
     return NULL;
 
   item = l->tail;
-  content = item->content;
 
   l->tail = item->prev;
   if (l->tail == NULL)
@@ -72,22 +156,19 @@ void *xbt_fifo_pop(xbt_fifo_t l)
   else
     l->tail->next = NULL;
 
-  xbt_fifo_freeitem(item);
   (l->count)--;
-  return content;
+  return item;
 }
 
-/*
- * xbt_fifo_unshift()
- * at the head
+/** Push a bucket
+ * \param l list
+ * \param new bucket
+ *
+ * Hook up this bucket at the head of the list
  */
-void xbt_fifo_unshift(xbt_fifo_t l, void *t)
+void xbt_fifo_unshift_item(xbt_fifo_t l, xbt_fifo_item_t new)
 {
-  xbt_fifo_item_t new;
-
   (l->count)++;
-  new = xbt_fifo_newitem();
-  new->content = t;
   if (l->head == NULL) {
     l->head = new;
     l->tail = new;
@@ -99,20 +180,20 @@ void xbt_fifo_unshift(xbt_fifo_t l, void *t)
   return;
 }
 
-/*
- * xbt_fifo_shift()
- * from the head
+/** Shift bucket
+ * \param l
+ * \returns the bucket that was at the head of the list.
+ *
+ * Returns NULL if the list was empty.
  */
-void *xbt_fifo_shift(xbt_fifo_t l)
+xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t l)
 {
   xbt_fifo_item_t item;
-  void *content;
 
   if (l->head == NULL)
     return NULL;
 
   item = l->head;
-  content = item->content;
 
   l->head = item->next;
   if (l->head == NULL)
@@ -120,14 +201,16 @@ void *xbt_fifo_shift(xbt_fifo_t l)
   else
     l->head->prev = NULL;
 
-  xbt_fifo_freeitem(item);
   (l->count)--;
-  return content;
+  return item;
 }
 
-/*
- * xbt_fifo_remove()
- *   removes an xbt_fifo_item_t using its content from the xbt_fifo 
+/**
+ * \param l 
+ * \param t an objet
+ *
+ * removes the first occurence of \a t from \a l. 
+ * \warning it will not remove duplicates
  */
 void xbt_fifo_remove(xbt_fifo_t l, void *t)
 {
@@ -140,22 +223,24 @@ void xbt_fifo_remove(xbt_fifo_t l, void *t)
       continue;
     /* remove the item */
     xbt_fifo_remove_item(l, current);
+    xbt_fifo_freeitem(current);
     /* WILL NOT REMOVE DUPLICATES */
     break;
   }
   return;
 }
 
-/*
- * xbt_fifo_remove_item()
- *   removes a given xbt_fifo_item_t from the xbt_fifo
+/**
+ * \param l a list
+ * \param current a bucket
+ *
+ * removes a the bucket \a current from the list \a l
  */
 void xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t current)
 {
   if (l->head == l->tail) {	/* special case */
       l->head = NULL;
       l->tail = NULL;
-      xbt_fifo_freeitem(current);
       (l->count)--;
       return;
     }
@@ -163,21 +248,20 @@ void xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t current)
     if (current == l->head) {	/* It's the head */
       l->head = current->next;
       l->head->prev = NULL;
-      xbt_fifo_freeitem(current);
     } else if (current == l->tail) {	/* It's the tail */
       l->tail = current->prev;
       l->tail->next = NULL;
-      xbt_fifo_freeitem(current);
     } else {			/* It's in the middle */
       current->prev->next = current->next;
       current->next->prev = current->prev;
-      xbt_fifo_freeitem(current);
     }
     (l->count)--;
 }
 
-/*
- * xbt_fifo_is_in()
+/**
+ * \param f a list
+ * \param content an object
+ * \return 1 if \a content is in \a f.
  */
 int xbt_fifo_is_in(xbt_fifo_t f, void *content)
 {
@@ -190,8 +274,9 @@ int xbt_fifo_is_in(xbt_fifo_t f, void *content)
   return 0;
 }
 
-/*
- * xbt_fifo_to_array()
+/**
+ * \param f a list
+ * \return a table with the objects stored in \a f.
  */
 void **xbt_fifo_to_array(xbt_fifo_t f)
 {
@@ -202,7 +287,7 @@ void **xbt_fifo_to_array(xbt_fifo_t f)
   if (f->count == 0)
     return NULL;
   else
-    array = (void **) calloc(f->count, sizeof(void *));
+    array = xbt_new0(void *, f->count);
 
   for (i = 0, b = xbt_fifo_getFirstitem(f); b; i++, b = b->next) {
     array[i] = b->content;
@@ -210,8 +295,9 @@ void **xbt_fifo_to_array(xbt_fifo_t f)
   return array;
 }
 
-/*
- * xbt_fifo_Copy()
+/**
+ * \param f a list
+ * \return a copy of \a f.
  */
 xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
 {
@@ -226,26 +312,38 @@ xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
   return copy;
 }
 
-/*
- * xbt_fifo_newitem()
+/** Constructor
+ * \return a new bucket
  */
 xbt_fifo_item_t xbt_fifo_newitem(void)
 {
-  return (xbt_fifo_item_t) calloc(1, sizeof(struct xbt_fifo_item));
+  return xbt_new0(struct xbt_fifo_item,1);
 }
 
+/**
+ * \param i a bucket
+ * \param v an object
+ *
+ * stores \a v in \a i.
+ */
 void xbt_fifo_set_item_content(xbt_fifo_item_t i , void *v)
 {
   xbt_fifo_setItemcontent(i,v);
 }
 
+/**
+ * \param i a bucket
+ * \return the object stored \a i.
+ */
 void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
 {
   return xbt_fifo_getItemcontent(i);
 }
 
-/*
- * xbt_fifo_freeitem()
+/** Destructor
+ * \param b poor victim
+ *
+ * Free the bucket but does not modifies the object (if any) that was stored in it.
  */
 void xbt_fifo_freeitem(xbt_fifo_item_t b)
 {
@@ -253,9 +351,43 @@ void xbt_fifo_freeitem(xbt_fifo_item_t b)
   return;
 }
 
+/**
+ * \param f a list
+ * \return the number of buckets in \a f.
+ */
 int xbt_fifo_size(xbt_fifo_t f)
 {
   return f->count;
 }
 
+/**
+ * \param l a list
+ * \return the head of \a l.
+ */
+xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l)
+{
+  return l->head;
+}
+
+/**
+ * \param i a bucket
+ * \return the bucket that comes next
+ */
+xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i)
+{
+  if(i) return i->next;
+  return NULL;
+}
+
+/**
+ * \param i a bucket
+ * \return the bucket that is just before \a i.
+ */
+xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i)
+{
+  if(i) return i->prev;
+  return NULL;
+}
+/*@}*/
+