src/linked_list.c

Tue, 28 Sep 2021 18:33:42 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 28 Sep 2021 18:33:42 +0200
changeset 447
87b2cdd668ed
parent 446
668757098b73
child 448
37c5d2fdb36b
permissions
-rw-r--r--

implement cx_ll_remove()

universe@398 1 /*
universe@398 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@398 3 *
universe@398 4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
universe@398 5 *
universe@398 6 * Redistribution and use in source and binary forms, with or without
universe@398 7 * modification, are permitted provided that the following conditions are met:
universe@398 8 *
universe@398 9 * 1. Redistributions of source code must retain the above copyright
universe@398 10 * notice, this list of conditions and the following disclaimer.
universe@398 11 *
universe@398 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@398 13 * notice, this list of conditions and the following disclaimer in the
universe@398 14 * documentation and/or other materials provided with the distribution.
universe@398 15 *
universe@398 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@398 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@398 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@398 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@398 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@398 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@398 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@398 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@398 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@398 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@398 26 * POSSIBILITY OF SUCH DAMAGE.
universe@398 27 */
universe@398 28
universe@398 29 #include "cx/linked_list.h"
universe@401 30 #include <stdint.h>
universe@401 31 #include <string.h>
universe@398 32
universe@398 33 /* LOW LEVEL LINKED LIST FUNCTIONS */
universe@398 34
universe@398 35 #define CX_LL_PTR(cur, off) ((void**)(((char*)cur)+off))
universe@398 36
universe@438 37 void *cx_linked_list_at(void *start, size_t start_index, ptrdiff_t loc_advance, size_t index) {
universe@438 38 size_t i = start_index;
universe@446 39 void *cur = start;
universe@438 40 while (i != index && cur != NULL) {
universe@438 41 cur = *CX_LL_PTR(cur, loc_advance);
universe@438 42 i < index ? i++ : i--;
universe@438 43 }
universe@438 44 return cur;
universe@438 45 }
universe@438 46
universe@400 47 void *cx_linked_list_last(void **begin, void **end, ptrdiff_t loc_next) {
universe@398 48 if (end != NULL) {
universe@398 49 return *end;
universe@398 50 } else {
universe@398 51 if (begin == NULL || *begin == NULL)
universe@398 52 return NULL;
universe@398 53
universe@398 54 void *cur = *begin;
universe@398 55 void *last;
universe@398 56 do {
universe@398 57 last = cur;
universe@398 58 } while ((cur = *CX_LL_PTR(cur, loc_next)) != NULL);
universe@398 59
universe@398 60 return last;
universe@398 61 }
universe@398 62 }
universe@398 63
universe@406 64 int cx_linked_list_add(void **begin, void **end, ptrdiff_t loc_prev, ptrdiff_t loc_next, void *new_node) {
universe@398 65 void *last = cx_linked_list_last(begin, end, loc_next);
universe@398 66 if (last == NULL) {
universe@398 67 if (begin == NULL) {
universe@428 68 // no current list and no begin ptr to write to - we don't find something to append to
universe@398 69 return 1;
universe@398 70 } else {
universe@428 71 // start fresh list
universe@406 72 *begin = new_node;
universe@398 73 }
universe@428 74 } else {
universe@428 75 // if there is a last node, update its next pointer
universe@428 76 void **next = CX_LL_PTR(last, loc_next);
universe@428 77 *next = new_node;
universe@398 78 }
universe@398 79
universe@428 80 // if there is an end pointer, update it
universe@408 81 if (end != NULL) {
universe@408 82 *end = cx_linked_list_last(&new_node, NULL, loc_next);
universe@408 83 }
universe@428 84
universe@428 85 // if the nodes use a prev pointer, update it
universe@398 86 if (loc_prev >= 0) {
universe@406 87 void **prev = CX_LL_PTR(new_node, loc_prev);
universe@398 88 *prev = last;
universe@398 89 }
universe@398 90
universe@398 91 return 0;
universe@398 92 }
universe@398 93
universe@398 94 /* HIGH LEVEL LINKED LIST IMPLEMENTATION */
universe@398 95
universe@447 96 typedef struct cx_linked_list_node cx_linked_list_node;
universe@447 97 struct cx_linked_list_node {
universe@447 98 cx_linked_list_node *prev;
universe@447 99 cx_linked_list_node *next;
universe@403 100 char payload[];
universe@447 101 };
universe@402 102
universe@446 103 #define CX_LL_LOC_PREV offsetof(cx_linked_list_node, prev)
universe@446 104 #define CX_LL_LOC_NEXT offsetof(cx_linked_list_node, next)
universe@439 105
universe@398 106 typedef struct {
universe@435 107 cx_list_s base;
universe@446 108 cx_linked_list_node *begin;
universe@446 109 cx_linked_list_node *end;
universe@398 110 } cx_linked_list;
universe@398 111
universe@438 112 static int cx_ll_add(cx_list_s *list, void *elem) {
universe@437 113 cx_linked_list *ll = (cx_linked_list *) list;
universe@398 114
universe@446 115 cx_linked_list_node *node = cxMalloc(list->allocator,
universe@446 116 sizeof(cx_linked_list_node) + list->itemsize);
universe@398 117 if (node == NULL)
universe@398 118 return 1;
universe@398 119
universe@406 120 memcpy(node->payload, elem, list->itemsize);
universe@446 121 node->next = NULL;
universe@399 122
universe@446 123 if (ll->begin == NULL) {
universe@446 124 ll->begin = ll->end = node;
universe@398 125 } else {
universe@446 126 // per contract of this linked list we know that end must be non-null
universe@446 127 ll->end->next = node;
universe@446 128 ll->end = node;
universe@398 129 }
universe@446 130 list->size++;
universe@446 131
universe@446 132 return 0;
universe@398 133 }
universe@398 134
universe@447 135 static cx_linked_list_node *cx_ll_node_at(cx_linked_list* list, size_t index) {
universe@447 136 if (index >= list->base.size) {
universe@447 137 return NULL;
universe@447 138 } else if (index > list->base.size / 2) {
universe@447 139 return cx_linked_list_at(list->end, list->base.size, CX_LL_LOC_PREV, index);
universe@447 140 } else {
universe@447 141 return cx_linked_list_at(list->begin, 0, CX_LL_LOC_NEXT, index);
universe@447 142 }
universe@447 143 }
universe@447 144
universe@438 145 static int cx_ll_insert(cx_list_s *list, size_t index, void *elem) {
universe@437 146 cx_linked_list *ll = (cx_linked_list *) list;
universe@398 147 // TODO: implement using low level API
universe@398 148 return 1;
universe@398 149 }
universe@398 150
universe@438 151 static int cx_ll_remove(cx_list_s *list, size_t index) {
universe@447 152 cx_linked_list *ll = (cx_linked_list *) list;
universe@447 153 cx_linked_list_node *node = cx_ll_node_at(ll, index);
universe@447 154
universe@447 155 // out-of-bounds check
universe@447 156 if (node == NULL) return 1;
universe@447 157
universe@447 158 // change left side connection
universe@447 159 if (node->prev == NULL) {
universe@447 160 ll->begin = node->next;
universe@447 161 } else {
universe@447 162 node->prev->next = node->next;
universe@438 163 }
universe@447 164
universe@447 165 // change right side connection
universe@447 166 if (node->next == NULL) {
universe@447 167 ll->end = node->prev;
universe@447 168 } else {
universe@447 169 node->next->prev = node->prev;
universe@447 170 }
universe@447 171
universe@447 172 // adjust size
universe@447 173 list->size--;
universe@447 174
universe@447 175 // free and return
universe@447 176 cxFree(list->allocator, node);
universe@447 177
universe@438 178 return 0;
universe@398 179 }
universe@398 180
universe@439 181 static void *cx_ll_at(cx_list_s *list, size_t index) {
universe@439 182 cx_linked_list *ll = (cx_linked_list *) list;
universe@447 183 cx_linked_list_node *node = cx_ll_node_at(ll, index);
universe@440 184 return node == NULL ? NULL : &node->payload;
universe@439 185 }
universe@439 186
universe@438 187 static size_t cx_ll_find(cx_list_s *list, void *elem) {
universe@437 188 CxListComparator cmp = list->cmpfunc;
universe@437 189 cx_linked_list *ll = (cx_linked_list *) list;
universe@437 190
universe@437 191 size_t index;
universe@446 192 cx_linked_list_node *node = ll->begin;
universe@446 193 for (index = 0; index < list->size; index++) {
universe@446 194 void *current = node->payload;
universe@437 195 if (cmp(current, elem) == 0) {
universe@437 196 return index;
universe@437 197 }
universe@437 198 node = node->next;
universe@437 199 }
universe@437 200 return index;
universe@398 201 }
universe@398 202
universe@438 203 static void *cx_ll_last(cx_list_s *list) {
universe@439 204 cx_linked_list *ll = (cx_linked_list *) list;
universe@446 205 cx_linked_list_node *last = cx_linked_list_last(NULL, (void **) &ll->end, CX_LL_LOC_NEXT);
universe@404 206 return &last->payload;
universe@404 207 }
universe@398 208
universe@398 209 cx_list_class cx_linked_list_class = {
universe@398 210 cx_ll_add,
universe@398 211 cx_ll_insert,
universe@398 212 cx_ll_remove,
universe@439 213 cx_ll_at,
universe@404 214 cx_ll_find,
universe@404 215 cx_ll_last
universe@398 216 };
universe@398 217
universe@406 218 CxList cxLinkedListCreate(CxAllocator allocator, CxListComparator comparator, size_t item_size) {
universe@446 219 cx_linked_list *list = cxMalloc(allocator, sizeof(cx_linked_list));
universe@398 220 if (list == NULL)
universe@398 221 return NULL;
universe@398 222
universe@435 223 list->base.cl = &cx_linked_list_class;
universe@435 224 list->base.allocator = allocator;
universe@435 225 list->base.cmpfunc = comparator;
universe@435 226 list->base.itemsize = item_size;
universe@435 227 list->base.capacity = SIZE_MAX;
universe@441 228 list->base.size = 0;
universe@406 229
universe@435 230 list->begin = NULL;
universe@441 231 list->end = NULL;
universe@406 232
universe@441 233 return (CxList) list;
universe@406 234 }
universe@406 235
universe@409 236 void cxLinkedListDestroy(CxList list) {
universe@446 237 cx_linked_list *ll = (cx_linked_list *) list;
universe@436 238
universe@446 239 cx_linked_list_node *node = ll->begin;
universe@436 240 while (node) {
universe@446 241 void *next = node->next;
universe@436 242 cxFree(list->allocator, node);
universe@436 243 node = next;
universe@436 244 }
universe@436 245
universe@435 246 cxFree(list->allocator, list);
universe@409 247 }
universe@409 248
universe@406 249 size_t cxLinkedListRecalculateSize(CxList list) {
universe@435 250 cx_linked_list *ll = (cx_linked_list *) list;
universe@406 251
universe@406 252 if (ll->begin == NULL) {
universe@435 253 ll->base.size = 0;
universe@407 254 ll->end = NULL;
universe@406 255 return 0;
universe@406 256 } else {
universe@446 257 cx_linked_list_node *cur = ll->begin;
universe@446 258 cx_linked_list_node *last;
universe@435 259 size_t size = 0;
universe@406 260 do {
universe@407 261 last = cur;
universe@406 262 size++;
universe@446 263 } while ((cur = cur->next) != NULL);
universe@407 264 ll->end = last;
universe@435 265 ll->base.size = size;
universe@406 266 return size;
universe@398 267 }
universe@406 268 }

mercurial