list.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-3.0-only
 * This file is part of Lazuli.
 */
 
#ifndef LAZULI_LIST_H
#define LAZULI_LIST_H
 
#include <Lazuli/common.h>
#include <Lazuli/config.h>
 
_EXTERN_C_DECL_BEGIN
 
typedef struct _Lz_LinkedListElement {
  struct _Lz_LinkedListElement *next;
 
  struct _Lz_LinkedListElement *prev;
}Lz_LinkedListElement;
 
typedef struct {
  Lz_LinkedListElement *first;
 
  Lz_LinkedListElement *last;
}Lz_LinkedList;
 
#define LINKED_LIST_INIT { NULL, NULL }
 
#define LINKED_LIST_ELEMENT_INIT { NULL, NULL }
 
void
List_Append(Lz_LinkedList * const linkedList,
            Lz_LinkedListElement * const item);
 
void
List_Prepend(Lz_LinkedList * const linkedList,
             Lz_LinkedListElement * const item);
 
void
List_AppendList(Lz_LinkedList * const linkedListDestination,
                Lz_LinkedList * const linkedListToMove);
 
Lz_LinkedListElement *
List_PickFirst(Lz_LinkedList * const linkedList);
 
Lz_LinkedListElement *
List_PointFirst(const Lz_LinkedList * const linkedList);
 
bool
List_IsEmpty(const Lz_LinkedList * const linkedList);
 
#define List_UntypedForEach(LINKEDLIST, ITEM)                           \
  if ((LZ_CONFIG_CHECK_NULL_PARAMETERS_IN_LISTS && (NULL == (LINKEDLIST))) || \
      (NULL == (LINKEDLIST)->first))                                    \
    {}                                                                  \
  else                                                                  \
    for ((ITEM) = (LINKEDLIST)->first;                                  \
         NULL != (ITEM);                                                \
         (ITEM) = (ITEM)->next)
 
#define List_ForEach(LINKEDLIST, TYPE, ITEM, MEMBER)                    \
  if ((LZ_CONFIG_CHECK_NULL_PARAMETERS_IN_LISTS && (NULL == (LINKEDLIST))) || \
      (NULL == (LINKEDLIST)->first))                                    \
    {}                                                                  \
  else                                                                  \
    for ((ITEM) = CONTAINER_OF((LINKEDLIST)->first, MEMBER, TYPE);      \
         NULL != (ITEM);                                                \
         (ITEM) =                                                       \
           (NULL == ((ITEM)->MEMBER).next)                              \
           ? NULL                                                       \
           : CONTAINER_OF(((ITEM)->MEMBER).next, MEMBER, TYPE))
 
#define List_RemovableForEach(LINKEDLIST, TYPE, ITEM, MEMBER, ITERATOR) \
  if ((LZ_CONFIG_CHECK_NULL_PARAMETERS_IN_LISTS && (NULL == (LINKEDLIST))) || \
      (NULL == (LINKEDLIST)->first))                                    \
    {}                                                                  \
  else                                                                  \
    for (STATIC_CHECK_TYPE((*(ITERATOR)), Lz_LinkedListElement),        \
           (ITERATOR) = (LINKEDLIST)->first,                            \
           (ITEM) = CONTAINER_OF((LINKEDLIST)->first, MEMBER, TYPE);    \
                                                                        \
         NULL != (ITEM);                                                \
                                                                        \
         ((ITERATOR) = (NULL == (ITERATOR)) ?                           \
          (LINKEDLIST)->first : (ITERATOR)->next),                      \
           ((ITEM) = (NULL == (ITERATOR)) ?                             \
            NULL : CONTAINER_OF((ITERATOR), MEMBER, TYPE)))
 
void
List_InsertAfter(Lz_LinkedList * const linkedList,
                 Lz_LinkedListElement * const listItem,
                 Lz_LinkedListElement * const itemToInsert);
 
void
List_InsertBefore(Lz_LinkedList * const linkedList,
                  Lz_LinkedListElement * const listItem,
                  Lz_LinkedListElement * const itemToInsert);
 
Lz_LinkedListElement *
List_Remove(Lz_LinkedList * const linkedList,
            Lz_LinkedListElement * const itemToRemove);
 
Lz_LinkedListElement *
List_PointElementAt(const Lz_LinkedList * const linkedList, const size_t index);
 
void
List_InitLinkedList(Lz_LinkedList * const linkedList);
 
void
List_InitLinkedListElement(Lz_LinkedListElement * const item);
 
_EXTERN_C_DECL_END
 
#endif /* LAZULI_LIST_H */