X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/24b8008bb424160e633b1374f54dcd89bdcb9749..169edc40a9d6aac50da8647a98df1e2b7cd92727:/src/xbt/fifo.c

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index cb50c60391..2cd4f79d9c 100644
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -1,16 +1,18 @@
-/* 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 "xbt/log.h"
 #include "fifo_private.h"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(fifo,xbt,"FIFO");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_fifo,xbt,"FIFO");
 
-/*
- * xbt_fifo_new()
+/** Constructor
+ * \return a new fifo
  */
 xbt_fifo_t xbt_fifo_new(void)
 {
@@ -19,88 +21,105 @@ xbt_fifo_t xbt_fifo_new(void)
   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)
 {
   xbt_fifo_item_t b, tmp;
 
-  for (b = xbt_fifo_getFirstitem(l); b;
-       tmp = b, b = b->next, xbt_fifo_freeitem(tmp));
+  for (b = xbt_fifo_get_first_item(l); b;
+       tmp = b, b = b->next, xbt_fifo_free_item(tmp));
   free(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
  */
 xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t l, void *t)
 {
   xbt_fifo_item_t new;
 
-  new = xbt_fifo_newitem();
+  new = xbt_fifo_new_item();
   new->content = t;
 
   xbt_fifo_push_item(l,new);
   return new;
 }
 
-/*
- * xbt_fifo_pop()
- * from the tail
+/** 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;
 
-  item = xbt_fifo_pop_item(l);
-  if(item==NULL) return NULL;
+  if(l==NULL) return NULL;
+  if(!(item = xbt_fifo_pop_item(l))) return NULL;
 
   content = item->content;
-  xbt_fifo_freeitem(item);
+  xbt_fifo_free_item(item);
   return content;
 }
 
-/*
- * xbt_fifo_unshift()
- * at the head
+/**
+ * \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;
 
-  new = xbt_fifo_newitem();
+  new = xbt_fifo_new_item();
   new->content = t;
   xbt_fifo_unshift_item(l,new);
   return new;
 }
 
-/*
- * xbt_fifo_shift()
- * from the head
+/** 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;
 
-  item = xbt_fifo_shift_item(l);
   if(l==NULL) return NULL;
-
+  if(!(item = xbt_fifo_shift_item(l))) return NULL;
+  
   content = item->content;
-  xbt_fifo_freeitem(item);
+  xbt_fifo_free_item(item);
   return content;
 }
 
-/*
- * xbt_fifo_push_item()
- * at the tail
+/** 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)
 {
+  xbt_assert0((new->next == NULL)&&(new->prev == NULL),"Invalid item!");
   (l->count)++;
   if (l->head == NULL) {
     l->head = new;
@@ -112,9 +131,11 @@ void xbt_fifo_push_item(xbt_fifo_t l, xbt_fifo_item_t new)
   l->tail = new;
 }
 
-/*
- * xbt_fifo_pop_item()
- * 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.
  */
 xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
 {
@@ -124,7 +145,7 @@ xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
     return NULL;
 
   item = l->tail;
-
+  
   l->tail = item->prev;
   if (l->tail == NULL)
     l->head = NULL;
@@ -132,15 +153,21 @@ xbt_fifo_item_t xbt_fifo_pop_item(xbt_fifo_t l)
     l->tail->next = NULL;
 
   (l->count)--;
+
+  item->prev = NULL;
+
   return item;
 }
 
-/*
- * xbt_fifo_unshift_item()
- * 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_item(xbt_fifo_t l, xbt_fifo_item_t new)
 {
+  xbt_assert0((new->next == NULL)&&(new->prev == NULL),"Invalid item!");
   (l->count)++;
   if (l->head == NULL) {
     l->head = new;
@@ -153,9 +180,11 @@ void xbt_fifo_unshift_item(xbt_fifo_t l, xbt_fifo_item_t new)
   return;
 }
 
-/*
- * xbt_fifo_shift_item()
- * 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.
  */
 xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t l)
 {
@@ -173,12 +202,18 @@ xbt_fifo_item_t xbt_fifo_shift_item(xbt_fifo_t l)
     l->head->prev = NULL;
 
   (l->count)--;
+
+  item->next = NULL;
+
   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)
 {
@@ -191,45 +226,53 @@ void xbt_fifo_remove(xbt_fifo_t l, void *t)
       continue;
     /* remove the item */
     xbt_fifo_remove_item(l, current);
-    xbt_fifo_freeitem(current);
+    xbt_fifo_free_item(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 bucket \a current from the list \a l. This function implicitely 
+ * assumes (and doesn't check!) that this item belongs to this list... 
  */
 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;
-      (l->count)--;
-      return;
-    }
-
-    if (current == l->head) {	/* It's the head */
-      l->head = current->next;
-      l->head->prev = NULL;
-    } else if (current == l->tail) {	/* It's the tail */
-      l->tail = current->prev;
-      l->tail->next = NULL;
-    } else {			/* It's in the middle */
-      current->prev->next = current->next;
-      current->next->prev = current->prev;
-    }
+    xbt_assert0((current==l->head),"This item is not in the list!");
+    l->head = NULL;
+    l->tail = NULL;
     (l->count)--;
+    current->prev = current->next = NULL;
+    return;
+  }
+
+  if (current == l->head) {	/* It's the head */
+    l->head = current->next;
+    l->head->prev = NULL;
+  } else if (current == l->tail) {	/* It's the tail */
+    l->tail = current->prev;
+    l->tail->next = NULL;
+  } else {			/* It's in the middle */
+    current->prev->next = current->next;
+    current->next->prev = current->prev;
+  }
+  (l->count)--;
+  current->prev = current->next = NULL;
 }
 
-/*
- * 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)
 {
-  xbt_fifo_item_t item = xbt_fifo_getFirstitem(f);
+  xbt_fifo_item_t item = xbt_fifo_get_first_item(f);
   while (item) {
     if (item->content == content)
       return 1;
@@ -238,8 +281,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)
 {
@@ -252,14 +296,15 @@ void **xbt_fifo_to_array(xbt_fifo_t f)
   else
     array = xbt_new0(void *, f->count);
 
-  for (i = 0, b = xbt_fifo_getFirstitem(f); b; i++, b = b->next) {
+  for (i = 0, b = xbt_fifo_get_first_item(f); b; i++, b = b->next) {
     array[i] = b->content;
   }
   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)
 {
@@ -268,42 +313,131 @@ xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
 
   copy = xbt_fifo_new();
 
-  for (b = xbt_fifo_getFirstitem(f); b; b = b->next) {
+  for (b = xbt_fifo_get_first_item(f); b; b = b->next) {
     xbt_fifo_push(copy, b->content);
   }
   return copy;
 }
 
-/*
- * xbt_fifo_newitem()
+/** Constructor
+ * \return a new bucket
  */
-xbt_fifo_item_t xbt_fifo_newitem(void)
+xbt_fifo_item_t xbt_fifo_new_item(void)
 {
   return xbt_new0(struct xbt_fifo_item,1);
 }
 
+/** \deprecated Use #xbt_fifo_new_item instead.
+ */
+xbt_fifo_item_t xbt_fifo_newitem(void)
+{
+  WARN0("This function is deprecated. Use xbt_fifo_new_item.");
+  return xbt_fifo_new_item();
+}
+
+/**
+ * \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_free_item(xbt_fifo_item_t b)
+{
+  free(b);
+  return;
+}
+
+/** Destructor
+ * \deprecated Use #xbt_fifo_free_item instead.
  */
 void xbt_fifo_freeitem(xbt_fifo_item_t b)
 {
+  WARN0("This function is deprecated. Use xbt_fifo_free_item.");
   free(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_get_first_item(xbt_fifo_t l)
+{
+  return l->head;
+}
+
+/** \deprecated Use #xbt_fifo_get_first_item instead.
+ */
+xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l)
+{
+  WARN0("This function is deprecated. Use xbt_fifo_get_first_item.");
+  return xbt_fifo_get_first_item(l);
+}
+
+/**
+ * \param i a bucket
+ * \return the bucket that comes next
+ */
+xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i)
+{
+  if(i) return i->next;
+  return NULL;
+}
+
+/** \deprecated Use #xbt_fifo_get_next_item instead.
+ */
+xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i)
+{
+  WARN0("This function is deprecated. Use xbt_fifo_get_next_item.");
+  return xbt_fifo_get_next_item(i);
+}
+
+/**
+ * \param i a bucket
+ * \return the bucket that is just before \a i.
+ */
+xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i)
+{
+  if(i) return i->prev;
+  return NULL;
+}
+
+/** \deprecated Use #xbt_fifo_get_prev_item instead.
+ */
+xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i)
+{
+  WARN0("This function is deprecated. Use xbt_fifo_get_prev_item.");
+  return xbt_fifo_get_prev_item(i);
+}
+
+/* @} */
+