list.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <mos/types.h>
 
typedef struct list_node list_node_t;
 
typedef list_node_t list_head;
 
struct list_node
{
    list_node_t *prev;
    list_node_t *next;
};
 
#define as_linked_list list_node_t list_node
 
// clang-format off
#define LIST_HEAD_INIT(container) { .prev = &(container), .next = &(container) }
// clang-format on
 
#define LIST_NODE_INIT(container) LIST_HEAD_INIT(container.list_node)
 
#define list_entry(node, type) container_of((node), type, list_node)
 
#define list_prev_entry(item, type) list_entry(list_node(item)->prev, type)
 
#define list_next_entry(item, type) list_entry(list_node(item)->next, type)
 
#define list_node_next_entry(node, type) container_of((node)->next, type, list_node)
 
#define list_node(element) (&((element)->list_node))
 
#define list_prepend(element, item)       list_node_prepend(list_node(element), list_node(item))
#define list_append(element, item)        list_node_append(list_node(element), list_node(item))
#define list_insert_before(element, item) list_node_insert_before(list_node(element), list_node(item))
#define list_insert_after(element, item)  list_node_insert_after(list_node(element), list_node(item))
#define list_remove(element)              list_node_remove(list_node(element))
 
#define list_foreach(t, v, h)                                                                                                                                            \
    for (__typeof(list_entry(&(h), t)) v = list_entry((h).next, t), __next = list_next_entry(v, t); list_node(v) != &(h); v = __next, __next = list_next_entry(v, t))
 
#define list_foreach_reverse(t, v, h)                                                                                                                                    \
    for (__typeof(list_entry(&(h), t)) v = list_entry((h).prev, t), __next = list_prev_entry(v, t); list_node(v) != &(h); v = __next, __next = list_prev_entry(v, t))
 
#define list_node_foreach(v, h)         for (list_node_t *v = (h)->next, *__next = v->next; v != (h); v = __next, __next = v->next)
#define list_node_foreach_reverse(v, h) for (list_node_t *v = (h)->prev, *__next = v->prev; v != (h); v = __next, __next = v->prev)
 
#define list_headless_foreach(t, v, h)                                                                                                                                   \
    for (__typeof(&(h)) v = &(h), __next = list_next_entry(v, t), __head = NULL; (v) != __head;                                                                          \
         v = __next, __next = list_next_entry(v, t), __head = __head == NULL ? &(h) : __head)
 
#define list_headless_foreach_reverse(t, v, h)                                                                                                                           \
    for (__typeof(h) v = (h), __next = list_prev_entry(v, t), __head = NULL; (v) != __head;                                                                              \
         v = __next, __next = list_prev_entry(v, t), __head = __head == NULL ? (h) : __head)
 
MOSAPI void linked_list_init(list_node_t *head_node);
MOSAPI bool list_is_empty(const list_node_t *head);
MOSAPI void list_node_remove(list_node_t *link);
 
MOSAPI list_node_t *list_node_pop(list_node_t *head);
MOSAPI void list_node_prepend(list_node_t *head, list_node_t *item);
MOSAPI void list_node_append(list_node_t *head, list_node_t *item);
MOSAPI void list_node_insert_before(list_node_t *element, list_node_t *item);
MOSAPI void list_node_insert_after(list_node_t *element, list_node_t *item);