X-Git-Url: https://git.xonotic.org/?a=blobdiff_plain;f=com_list.h;h=9fe42a312711fe136bbd0052bfc7246a0fe86c38;hb=a9a1be539dba0e3df8ff02e816a925436713ea2f;hp=8ba08dc55a5d07aa02c81e19950d5fc97e9429cb;hpb=5cfa54f9eccab3ceabe2c3fb1b96bcd714f6c129;p=xonotic%2Fdarkplaces.git diff --git a/com_list.h b/com_list.h index 8ba08dc5..9fe42a31 100644 --- a/com_list.h +++ b/com_list.h @@ -18,9 +18,14 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ -// com_list.c - generic doubly linked list interface, inspired by Linux list.h +// com_list.h - generic doubly linked list interface, adapted from Linux list.h + +#ifndef LIST_H +#define LIST_H #include +#include "qtypes.h" +#include "qdefs.h" typedef struct llist_s { @@ -28,21 +33,186 @@ typedef struct llist_s struct llist_s *next; } llist_t; -#define List_Head_Reset(name) { &(name), &(name) } +#define LIST_HEAD_INIT(name) { &(name), &(name) } + +#define LIST_HEAD(name) \ + struct llist_s name = LIST_HEAD_INIT(name) + +/* + * Get the struct for this entry + */ +#define List_Entry(ptr, type, member) ContainerOf(ptr, type, member) + +/* + * Get the first element from a list + * The list is expected to not be empty + */ +#define List_First_Entry(ptr, type, member) List_Entry((ptr)->next, type, member) + +/* + * Get the last element from the list + * The list is expected to not be empty + */ +#define List_Last_Entry(ptr, type, member) List_Entry((ptr)->prev, type, member) + +/* + * Get the first element from the list, but return NULL if it's empty + */ +#define List_First_Entry_Or_Null(ptr, type, member) ({ \ + struct llist_s *head__ = (ptr); \ + struct llist_s *pos__ = head__->next; \ + pos__ != head__ ? List_Entry(pos__, type, member) : NULL; \ +}) -#define List_Container(ptr, type, member) ContainerOf(ptr, type, member) +/* + * Get the next element in the list + */ +#define List_Next_Entry(pos, member) \ + List_Entry((pos)->member.next, Q_typeof(*(pos)), member) -#define List_ForEach(pos, head) \ +/* + * Get the prev element in the list + */ +#define List_Prev_Entry(pos, member) \ + List_Entry((pos)->member.prev, Q_typeof(*(pos)), member) + +/* + * Iterate over a list + */ +#define List_For_Each(pos, head) \ for (pos = (head)->next; pos != (head); pos = pos->next) -#define List_ForEach_Prev(pos, head) \ +/* + * Continue iteration over a list, after the current position + */ +#define List_For_Each_Continue(pos, head) \ + for (pos = pos->next; pos != (head); pos = pos->next) + +/* + * Iterate over a list backwards + */ +#define List_For_Each_Prev(pos, head) \ for (pos = (head)->prev; pos != (head); pos = pos->prev) +/* + * Iterate over a list, safe against removal of list entry + */ +#define List_For_Each_Safe(pos, n, head) \ + for (pos = (head)->next, n = pos->next; pos != (head); \ + pos = n, n = pos->next) +/* + * Iterate over a list backwards, safe against removal of list entry + */ +#define List_For_Each_Prev_Safe(pos, n, head) \ + for (pos = (head)->prev, n = pos->prev; \ + pos != (head); \ + pos = n, n = pos->prev) +/* + * Test if the entry points to the head of the list + */ +#define List_Entry_Is_Head(pos, head, member) \ + (&pos->member == (head)) + +/* + * Iterate over a list of a given type + */ +#define List_For_Each_Entry(pos, head, member) \ + for (pos = List_Last_Entry(head, Q_typeof(*pos), member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = List_Prev_Entry(pos, member)) + +/* + * Iterate over a list of a given type backwards + */ +#define List_For_Each_Prev_Entry(pos, head, member) \ + for (pos = List_Last_Entry(head, Q_typeof(*pos), member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = List_Prev_Entry(pos, member)) + +/* + * Prepares a pos entry for use as a start point in List_For_Each_Entry_Continue() + */ +#define List_Prepare_Entry(pos, head, member) \ + ((pos) ? : List_Entry(head, Q_typeof(*pos), member)) + +/* + * Continue iteration over a list of a given type, after the current position + */ +#define List_For_Each_Entry_Continue(pos, head, member) \ + for (pos = List_Next_Entry(pos, member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = List_Next_Entry(pos, member)) + +/* + * Continue iteration over a list of a given type backwards, after the current position + */ +#define List_For_Each_Prev_Entry_Continue(pos, head, member) \ + for (pos = List_Prev_Entry(pos, member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = List_Prev_Entry(pos, member)) + +/* + * Continue iteration over a list of a given type, from the current position + */ +#define List_For_Each_Entry_From(pos, head, member) \ + for (; !List_Entry_Is_Head(pos, head, member); \ + pos = List_Next_Entry(pos, member)) + +/* + * Continue iteration over a list of a given type backwards, from the current position + */ +#define List_For_Each_Prev_Entry_From(pos, head, member) \ + for (; !List_Entry_Is_Head(pos, head, member); \ + pos = List_Prev_Entry(pos, member)) + +/* + * Iterate over a list of a given type, safe against removal of list entry + */ +#define List_For_Each_Entry_Safe(pos, n, head, member) \ + for (pos = List_First_Entry(head, Q_typeof(*pos), member), \ + n = List_Next_Entry(pos, member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = n, n = List_Next_Entry(n, member)) +/* + * Continue iteration over a list of a given type, after the current position, safe against removal of list entry + */ +#define List_For_Each_Entry_Safe_Continue(pos, n, head, member) \ + for (pos = List_Next_Entry(pos, member), \ + n = List_Next_Entry(pos, member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = n, n = List_Next_Entry(n, member)) + +/* + * Continue iteration over a list of a given type, from the current position, safe against removal of list entry + */ +#define List_For_Each_Entry_Safe_From(pos, n, head, member) \ + for (n = List_Next_Entry(pos, member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = n, n = List_Next_Entry(n, member)) + + +/* + * Iterate over a list of a given type backwards, safe against removal of list entry + */ +#define List_For_Each_Prev_Entry_Safe(pos, n, head, member) \ + for (pos = List_Last_Entry(head, Q_typeof(*pos), member), \ + n = List_Prev_Entry(pos, member); \ + !List_Entry_Is_Head(pos, head, member); \ + pos = n, n = List_Prev_Entry(n, member)) + +/* + * Reset a stale List_For_Each_Entry_Safe loop + */ +#define List_Safe_Reset_Next(pos, n, member) \ + n = List_Next_Entry(pos, member) + +void List_Create(llist_t *list); void List_Add(llist_t *node, llist_t *start); void List_Add_Tail(llist_t *node, llist_t *start); void List_Delete(llist_t *node); void List_Delete_Init(llist_t *node); void List_Replace(llist_t *old, llist_t *_new); +void List_Replace_Init(llist_t *old, llist_t *_new); void List_Swap(llist_t *node1, llist_t *node2); void List_Move(llist_t *list, llist_t *start); void List_Move_Tail(llist_t *list, llist_t *start); @@ -51,6 +221,8 @@ void List_Rotate_Left(llist_t *head); void List_Rotate_To_Front(llist_t *list, llist_t *head); void List_Splice(const llist_t *list, llist_t *head); void List_Splice_Tail(const llist_t *list, llist_t *head); -qboolean List_IsFirst(llist_t *list, llist_t *start); -qboolean List_IsLast(llist_t *list, llist_t *start); -qboolean List_IsEmpty(const llist_t *list); \ No newline at end of file +qbool List_Is_First(llist_t *list, llist_t *start); +qbool List_Is_Last(llist_t *list, llist_t *start); +qbool List_Is_Empty(const llist_t *list); + +#endif