os-k/kaleid/include/extras/list.h

289 lines
6.2 KiB
C
Raw Normal View History

2019-01-21 15:00:04 +01:00
//----------------------------------------------------------------------------//
// GNU GPL OS/K //
// //
// Desc: Doubly linked lists implementation //
2019-02-16 23:36:33 +01:00
// //
// //
// Copyright © 2018-2019 The OS/K Team //
// //
// This file is part of OS/K. //
// //
// OS/K 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 3 of the License, or //
// any later version. //
// //
// OS/K is distributed in the hope that it will be useful, //
// but WITHOUT ANY WARRANTY//without even the implied warranty of //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
// GNU General Public License for more details. //
// //
// You should have received a copy of the GNU General Public License //
// along with OS/K. If not, see <https://www.gnu.org/licenses/>. //
2019-01-21 15:00:04 +01:00
//----------------------------------------------------------------------------//
#ifdef _KALEID_KERNEL
#error "extra/list.h - Not ready for kernel compilation"
#endif
#ifndef _KALBASE_H
#include <kalbase.h>
#endif
2019-02-06 14:07:38 +01:00
#ifndef _KALEXTRAS_MALLOC_H
#include <extras/malloc.h>
#endif
2019-01-21 15:00:04 +01:00
2019-02-16 23:36:33 +01:00
#ifndef _KALEXTRAS_LOCKS_H
#include <extras/locks.h>
#endif
2019-01-21 15:00:04 +01:00
#ifndef _KALEXTRAS_LIST_H
#define _KALEXTRAS_LIST_H
2019-02-16 23:36:33 +01:00
#ifdef __cplusplus
extern "C" {
#endif
typedef struct ListHead_t ListHead_t;
typedef struct ListNode_t ListNode_t;
2019-01-21 15:00:04 +01:00
//------------------------------------------//
2019-02-16 23:36:33 +01:00
struct ListHead_t
{
Lock_t *lock;
ulong length;
ListNode_t *first;
ListNode_t *last;
2019-02-16 23:36:33 +01:00
};
2019-01-21 15:00:04 +01:00
2019-02-16 23:36:33 +01:00
struct ListNode_t
{
void *data;
ListHead_t *head;
ListNode_t *prev;
ListNode_t *next;
2019-02-16 23:36:33 +01:00
};
2019-01-21 15:00:04 +01:00
//------------------------------------------//
//
// Create a list head with an extern lock
//
static inline ListHead_t
*CreateListHeadWithLock(Lock_t *lock)
{
2019-02-16 23:36:33 +01:00
ListHead_t *head = KalAllocMemory(sizeof(ListHead_t));
2019-01-21 15:00:04 +01:00
if (head == NULL) return NULL;
head->first = head->last = NULL;
head->length = 0;
head->lock = lock;
return head;
}
//
2019-02-06 14:07:38 +01:00
// Create a list head
2019-01-21 15:00:04 +01:00
//
static inline ListHead_t
*CreateListHead(void)
{
return CreateListHeadWithLock(NULL);
}
//
// Create a node
//
static inline ListNode_t
*CreateNode(void *data)
{
2019-02-16 23:36:33 +01:00
ListNode_t *node = KalAllocMemory(sizeof(ListNode_t));
2019-01-21 15:00:04 +01:00
if (node == NULL) return NULL;
node->data = data;
node->head = NULL;
node->prev = node->next = NULL;
return node;
}
//
// Prepend node at beginning of list
//
static inline ListHead_t
*PrependNode(ListHead_t *head, ListNode_t *node)
{
KalAssert(head && node);
node->head = head;
node->prev = NULL;
if (head->length > 0) {
node->next = head->first;
head->first->prev = node;
head->first = node;
}
else {
head->first = node;
head->last = node;
node->next = NULL;
}
head->length++;
return head;
}
//
// Append node at end of list
//
static inline ListHead_t
*AppendNode(ListHead_t *head, ListNode_t *node)
{
KalAssert(head && node);
node->head = head;
node->next = NULL;
if (head->length > 0) {
node->prev = head->last;
head->last->next = node;
head->last = node;
}
else {
head->first = node;
head->last = node;
node->prev = NULL;
}
head->length++;
return head;
}
//
// Insert node2 before node1
//
static inline ListHead_t
*AddNodeBefore(ListHead_t *head, ListNode_t *node1, ListNode_t *node2)
{
KalAssert(head && node1 && node2 && node1->head == head);
if (head->first == node1) {
return PrependNode(head, node2);
}
node2->head = head;
node2->next = node1;
node2->prev = node1->prev;
// node1->prev does exist
// or node1 would be first
node1->prev->next = node2;
node1->prev = node2;
head->length++;
return head;
}
//
// Insert node2 after node1
//
static inline ListHead_t
*AddNodeAfter(ListHead_t *head, ListNode_t *node1, ListNode_t *node2)
{
KalAssert(head && node1 && node2 && node1->head == head);
if (head->last == node1) {
return AppendNode(head, node2);
}
node2->head = head;
node2->prev = node1;
node2->next = node1->next;
node1->next->prev = node2;
node1->next = node2;
head->length++;
return head;
}
//
// Remove node of list (and frees it)
//
static inline ListHead_t
*RemoveNode(ListHead_t *head, ListNode_t *node)
{
KalAssert(head && node && head->length > 0 && node->head == head);
if (head->length == 1) {
head->first = head->last = NULL;
goto leave;
}
if (head->first == node) {
head->first = node->next;
node->next->prev = NULL;
}
else if (head->last == node) {
head->last = node->prev;
node->prev->next = NULL;
}
else {
node->prev->next = node->next;
node->next->prev = node->prev;
}
leave:
head->length--;
2019-02-16 23:36:33 +01:00
KalFreeMemory(node);
2019-01-21 15:00:04 +01:00
return head;
}
//
// Free a node
//
static inline void
DestroyNode(ListNode_t *node)
{
KalAssert(node);
2019-02-16 23:36:33 +01:00
KalFreeMemory(node);
2019-01-21 15:00:04 +01:00
}
//
// Free a list head
//
static inline void
DestroyListHead(ListHead_t *head)
{
KalAssert(head);
2019-02-16 23:36:33 +01:00
KalFreeMemory(head);
2019-01-21 15:00:04 +01:00
}
//
// Access a node's data
//
#define GetNodeData(node, type) ((type)(node)->data)
//------------------------------------------//
2019-02-16 23:36:33 +01:00
#ifdef __cplusplus
}
#endif
2019-01-21 15:00:04 +01:00
#endif