* 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
- */
-/* @{ */
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_fifo,xbt,"FIFO");
/** Constructor
* \return a new fifo
{
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_item_t new;
- new = xbt_fifo_newitem();
+ new = xbt_fifo_new_item();
new->content = t;
xbt_fifo_push_item(l,new);
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_item_t new;
- new = xbt_fifo_newitem();
+ new = xbt_fifo_new_item();
new->content = t;
xbt_fifo_unshift_item(l,new);
return new;
if(!(item = xbt_fifo_shift_item(l))) return NULL;
content = item->content;
- xbt_fifo_freeitem(item);
+ xbt_fifo_free_item(item);
return content;
}
*/
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;
return NULL;
item = l->tail;
-
+
l->tail = item->prev;
if (l->tail == NULL)
l->head = NULL;
l->tail->next = NULL;
(l->count)--;
+
+ item->prev = NULL;
+
return item;
}
*/
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;
l->head->prev = NULL;
(l->count)--;
+
+ item->next = NULL;
+
return item;
}
continue;
/* remove the item */
xbt_fifo_remove_item(l, current);
- xbt_fifo_freeitem(current);
+ xbt_fifo_free_item(current);
/* WILL NOT REMOVE DUPLICATES */
break;
}
* \param l a list
* \param current a bucket
*
- * removes a the bucket \a current from the list \a l
+ * 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;
}
/**
*/
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;
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;
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;
/** 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
*
* 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 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);
+}
+
/* @} */
