rockbox/firmware/include/linked_list.h
Aidan MacDonald 5e864ecde9 linked list: add lld_insert_prev/next()
Change-Id: I55ff061ccc0e6e2dad3125a8150c082c163db329
2022-10-16 16:10:24 +01:00

146 lines
3.9 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2014 by Michael Sevakis
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef LINKED_LIST_H
#define LINKED_LIST_H
#include <stddef.h>
/***
** NOTES:
** Node field order chosen so that one type can alias the other for forward
** list traveral by the same code.
**
** Structures are separate, even if logically equivalent, to perform compile-
** time type checking.
**
*/
/* (L)inked (L)ist
*
* Format:
*
* XX->YY->ZZ->0
* head--^ ^
* tail----------+
*/
struct ll_head
{
struct ll_node *head; /* First list item */
struct ll_node *tail; /* Last list item (to make insert_last O(1)) */
};
struct ll_node
{
struct ll_node *next; /* Next list item */
};
/**
* Initializes the singly-linked list
*/
static inline void ll_init(struct ll_head *list)
{
list->head = NULL;
list->tail = NULL;
}
void ll_insert_next(struct ll_head *list, struct ll_node *node,
struct ll_node *newnode);
void ll_insert_last(struct ll_head *list, struct ll_node *node);
void ll_remove_next(struct ll_head *list, struct ll_node *node);
void ll_remove(struct ll_head *list, struct ll_node *node);
void ll_insert_first(struct ll_head *list, struct ll_node *node);
void ll_remove_first(struct ll_head *list);
/* (L)inked (L)ist (D)double
*
* Format:
*
* 0<-XX<->YY<->ZZ->0
* head----^ ^
* tail--------------+
*/
struct lld_head
{
struct lld_node *head; /* First list item */
struct lld_node *tail; /* Last list item (to make insert_last O(1)) */
};
struct lld_node
{
struct lld_node *next; /* Next list item */
struct lld_node *prev; /* Previous list item */
};
/**
* Initializes the doubly-linked list
*/
static inline void lld_init(struct lld_head *list)
{
list->head = NULL;
list->tail = NULL;
/* tail could be stored in first item's prev pointer but this simplifies
the routines and maintains the non-circularity */
}
void lld_insert_next(struct lld_head *list, struct lld_node *node,
struct lld_node *newnode);
void lld_insert_prev(struct lld_head *list, struct lld_node *node,
struct lld_node *newnode);
void lld_insert_first(struct lld_head *list, struct lld_node *node);
void lld_insert_last(struct lld_head *list, struct lld_node *node);
void lld_remove(struct lld_head *list, struct lld_node *node);
/* (L)inked (L)ist (D)ouble (C)ircular
*
* Format:
* +----------------+
* | |
* +->XX<->YY<->ZZ<-+
* head------^
*/
struct lldc_head
{
struct lldc_node *head; /* First list item */
};
struct lldc_node
{
struct lldc_node *next; /* Next list item */
struct lldc_node *prev; /* Previous list item */
};
/**
* Initializes the doubly-linked circular list
*/
static inline void lldc_init(struct lldc_head *list)
{
list->head = NULL;
}
void lldc_insert_first(struct lldc_head *list, struct lldc_node *node);
void lldc_insert_last(struct lldc_head *list, struct lldc_node *node);
void lldc_remove(struct lldc_head *list, struct lldc_node *node);
#endif /* LINKED_LIST_H */