Deprecating stupidly named functions...

[simgrid.git] / src / xbt / fifo.c

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index d596daa..3ea147b 100644 (file)
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -6,22 +6,11 @@
  * 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");
 
-/** \defgroup XBT_fifo A generic workqueue
-  *  \brief This section describes the API to generic workqueue. These functions
-  *   provide the same kind of functionnality as dynamic arrays but in time O(1). 
-  *   However these functions use malloc/free a way too much often.
-  */
-
-/** \name Functions 
- *  \ingroup XBT_fifo
- */
-/*@{*/
-
 /** Constructor
  * \return a new fifo
  */
@@ -41,8 +30,8 @@ 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;
 }
@@ -58,7 +47,7 @@ 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);
@@ -81,7 +70,7 @@ void *xbt_fifo_pop(xbt_fifo_t l)
   if(!(item = xbt_fifo_pop_item(l))) return NULL;
 
   content = item->content;
-  xbt_fifo_freeitem(item);
+  xbt_fifo_free_item(item);
   return content;
 }
 
@@ -96,7 +85,7 @@ 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;
@@ -118,7 +107,7 @@ void *xbt_fifo_shift(xbt_fifo_t l)
   if(!(item = xbt_fifo_shift_item(l))) return NULL;
   
   content = item->content;
-  xbt_fifo_freeitem(item);
+  xbt_fifo_free_item(item);
   return content;
 }
 
@@ -229,7 +218,7 @@ 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;
   }
@@ -271,7 +260,7 @@ void xbt_fifo_remove_item(xbt_fifo_t l, xbt_fifo_item_t current)
  */
 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;
@@ -295,7 +284,7 @@ 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;
@@ -312,7 +301,7 @@ 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;
@@ -321,11 +310,19 @@ xbt_fifo_t xbt_fifo_copy(xbt_fifo_t f)
 /** 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
@@ -351,8 +348,18 @@ void *xbt_fifo_get_item_content(xbt_fifo_item_t i)
  *
  * 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;
 }
@@ -370,30 +377,55 @@ int xbt_fifo_size(xbt_fifo_t f)
  * \param l a list
  * \return the head of \a l.
  */
-xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t 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_getNextItem(xbt_fifo_item_t i)
+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_getPrevItem(xbt_fifo_item_t 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);
+}
+
+/* @} */