+#ifndef FIRM_ADT_LIST_H
+#define FIRM_ADT_LIST_H
+
+#include <stdlib.h>
+
+#include "../begin.h"
+
/**
- * @file
+ * @ingroup adt
+ * @defgroup lists Linked Lists
* @brief Doubly linked lists.
- * @version $Id$
*
* Simple doubly linked list implementation.
*
* sometimes we already know the next/prev entries and we can
* generate better code by using them directly rather than
* using the generic single-entry routines.
- */
-#ifndef FIRM_ADT_LIST_H
-#define FIRM_ADT_LIST_H
-
-#include <stdlib.h>
+ * @{
+ */
+/**
+ * List Header.
+ * Put this into all list elements and at the place where you want to keep
+ * references to the list. */
typedef struct list_head list_head;
-struct list_head {
- struct list_head *next, *prev;
-};
+/** Static initializer for a list header */
#define LIST_HEAD_INIT(name) { &(name), &(name) }
+/** Defines a (static) list reference */
#define LIST_HEAD(name) \
struct list_head name = LIST_HEAD_INIT(name)
+/** Initializes a list header */
#define INIT_LIST_HEAD(ptr) do { \
(ptr)->next = (ptr); (ptr)->prev = (ptr); \
} while (0)
+/** @cond PRIVATE */
+struct list_head {
+ struct list_head *next, *prev;
+};
+
#define _list_offsetof(type,member) \
((char *) &(((type *) 0)->member) - (char *) 0)
#define _list_container_of(ptr, type, member) \
((type *) ((char *) (ptr) - _list_offsetof(type, member)))
+/** @endcond */
-/*
- * Insert a new entry between two known consecutive entries.
+/**
+ * Inserts a new entry between two known consecutive entries.
*
* This is only for internal list manipulation where we know
* the prev/next entries already!
*/
static inline void __list_add(struct list_head *new_node,
- struct list_head *prev,
- struct list_head *next)
+ struct list_head *prev,
+ struct list_head *next)
{
next->prev = new_node;
new_node->next = next;
}
/**
- * list_add - add a new entry
+ * Adds a new entry
* @param new_node new entry to be added
* @param head list head to add it after
*
}
/**
- * list_add_tail - add a new entry
+ * Adds a new entry
* @param new_node new entry to be added
* @param head list head to add it before
*
__list_add(new_node, head->prev, head);
}
-/*
- * Delete a list entry by making the prev/next entries
+/**
+ * Deletes a list entry by making the prev/next entries
* point to each other.
*
* This is only for internal list manipulation where we know
}
/**
- * list_del - deletes entry from list.
+ * Deletes entry from list.
* @param entry the element to delete from the list.
*
* @note
/**
- * list_del_init - deletes entry from list and reinitialize it.
+ * Deletes entry from list and reinitialize it.
* @param entry the element to delete from the list.
*/
static inline void list_del_init(struct list_head *entry)
}
/**
- * list_move - delete from one list and add as another's head
+ * Deletes from one list and add as another's head
* @param list the entry to move
* @param head the head that will precede our entry
*/
}
/**
- * list_move_tail - delete from one list and add as another's tail
+ * Deletes from one list and add as another's tail
* @param list the entry to move
* @param head the head that will follow our entry
*/
static inline void list_move_tail(struct list_head *list,
- struct list_head *head)
+ struct list_head *head)
{
__list_del(list->prev, list->next);
list_add_tail(list, head);
}
/**
- * list_empty - tests whether a list is empty
+ * Tests whether a list is empty
* @param head the list to test.
*/
static inline int list_empty(const struct list_head *head)
return head->next == head;
}
+/**
+ * Join two nonempty lists.
+ *
+ * @note Use list_splice() if @p list is possibly empty.
+ * @param list the new list to add.
+ * @param head the place to add it in the first list.
+ */
static inline void __list_splice(struct list_head *list,
- struct list_head *head)
+ struct list_head *head)
{
struct list_head *first = list->next;
struct list_head *last = list->prev;
_list_container_of(ptr, type, member)
/**
- * list_for_each - iterate over a list
- * @param pos the &struct list_head to use as a loop counter.
- * @param head the head for your list.
+ * list_for_each - iterate over a list
+ * @param pos the &struct list_head to use as a loop counter.
+ * @param head the head for your list.
*/
#define list_for_each(pos, head) \
for (pos = (head)->next; pos != (head); pos = pos->next)
/**
- * __list_for_each - iterate over a list
- * @param pos the &struct list_head to use as a loop counter.
- * @param head the head for your list.
- *
- * This variant differs from list_for_each() in that it's the
- * simplest possible list iteration code, no ing is done.
- * Use this for code that knows the list to be very short (empty
- * or 1 entry) most of the time.
- */
-#define __list_for_each(pos, head) \
- for (pos = (head)->next; pos != (head); pos = pos->next)
-
-/**
- * list_for_each_prev - iterate over a list backwards
- * @param pos the &struct list_head to use as a loop counter.
- * @param head the head for your list.
+ * list_for_each_prev - iterate over a list backwards
+ * @param pos the &struct list_head to use as a loop counter.
+ * @param head the head for your list.
*/
#define list_for_each_prev(pos, head) \
for (pos = (head)->prev; pos != (head); pos = pos->prev)
/**
- * list_for_each_safe - iterate over a list safe against removal of list entry
- * @param pos the &struct list_head to use as a loop counter.
- * @param n another &struct list_head to use as temporary storage
- * @param head the head for your list.
+ * list_for_each_safe - iterate over a list safe against removal of list entry
+ * @param pos the &struct list_head to use as a loop counter.
+ * @param n another &struct list_head to use as temporary storage
+ * @param head the head for your list.
*/
#define list_for_each_safe(pos, n, head) \
for (pos = (head)->next, n = pos->next; pos != (head); \
pos = n, n = pos->next)
/**
- * list_for_each_entry - iterate over list of given type
+ * list_for_each_entry - iterate over list of given type
* @param type the type of the struct where the listhead is embedded in
* @param pos the type * to use as a loop counter.
* @param head the head for your list.
* @param member the name of the list_struct within the struct.
*/
-#define list_for_each_entry(type, pos, head, member) \
- for (pos = list_entry((head)->next, type, member); \
- &pos->member != (head); \
+#define list_for_each_entry(type, pos, head, member) \
+ for (type *pos = list_entry((head)->next, type, member); \
+ &pos->member != (head); \
pos = list_entry(pos->member.next, type, member))
/**
* @param head the head for your list.
* @param member the name of the list_struct within the struct.
*/
-#define list_for_each_entry_reverse(type, pos, head, member) \
- for (pos = list_entry((head)->prev, type, member); \
- &pos->member != (head); \
+#define list_for_each_entry_reverse(type, pos, head, member) \
+ for (type *pos = list_entry((head)->prev, type, member); \
+ &pos->member != (head); \
pos = list_entry(pos->member.prev, type, member))
* @param head the head for your list.
* @param member the name of the list_struct within the struct.
*/
-#define list_for_each_entry_safe(type, pos, n, head, member) \
- for (pos = list_entry((head)->next, type, member), \
- n = list_entry(pos->member.next, type, member); \
- &pos->member != (head); \
+#define list_for_each_entry_safe(type, pos, n, head, member) \
+ for (type *pos = list_entry((head)->next, type, member), \
+ *n = list_entry(pos->member.next, type, member); \
+ &pos->member != (head); \
pos = n, n = list_entry(n->member.next, type, member))
+/** @} */
+
+#include "../end.h"
#endif
projects / libfirm / blobdiff