src/linked_list.c

Wed, 15 Feb 2023 16:48:11 +0100

author
Mike Becker <universe@uap-core.de>
date
Wed, 15 Feb 2023 16:48:11 +0100
changeset 655
7340c4255f1f
parent 654
c9d008861178
child 661
0a71ac9547fd
permissions
-rw-r--r--

implement backwards iterator - fixes #238

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@509 30 #include "cx/utils.h"
universe@401 31 #include <string.h>
universe@453 32 #include <assert.h>
universe@398 33
universe@628 34 // LOW LEVEL LINKED LIST FUNCTIONS
universe@398 35
universe@592 36 #define CX_LL_PTR(cur, off) (*(void**)(((char*)(cur))+(off)))
universe@480 37 #define ll_prev(node) CX_LL_PTR(node, loc_prev)
universe@480 38 #define ll_next(node) CX_LL_PTR(node, loc_next)
universe@480 39 #define ll_advance(node) CX_LL_PTR(node, loc_advance)
universe@639 40 #define ll_data(node) (((char*)(node))+loc_data)
universe@398 41
universe@481 42 void *cx_linked_list_at(
universe@508 43 void const *start,
universe@481 44 size_t start_index,
universe@481 45 ptrdiff_t loc_advance,
universe@481 46 size_t index
universe@481 47 ) {
universe@473 48 assert(start != NULL);
universe@473 49 assert(loc_advance >= 0);
universe@438 50 size_t i = start_index;
universe@508 51 void const *cur = start;
universe@438 52 while (i != index && cur != NULL) {
universe@480 53 cur = ll_advance(cur);
universe@438 54 i < index ? i++ : i--;
universe@438 55 }
universe@508 56 return (void *) cur;
universe@438 57 }
universe@438 58
universe@481 59 size_t cx_linked_list_find(
universe@489 60 void const *start,
universe@481 61 ptrdiff_t loc_advance,
universe@481 62 ptrdiff_t loc_data,
universe@481 63 CxListComparator cmp_func,
universe@489 64 void const *elem
universe@481 65 ) {
universe@480 66 assert(start != NULL);
universe@480 67 assert(loc_advance >= 0);
universe@480 68 assert(loc_data >= 0);
universe@480 69 assert(cmp_func);
universe@480 70
universe@489 71 void const *node = start;
universe@480 72 size_t index = 0;
universe@480 73 do {
universe@480 74 void *current = ll_data(node);
universe@480 75 if (cmp_func(current, elem) == 0) {
universe@480 76 return index;
universe@480 77 }
universe@480 78 node = ll_advance(node);
universe@480 79 index++;
universe@480 80 } while (node != NULL);
universe@480 81 return index;
universe@480 82 }
universe@480 83
universe@481 84 void *cx_linked_list_first(
universe@508 85 void const *node,
universe@481 86 ptrdiff_t loc_prev
universe@481 87 ) {
universe@475 88 return cx_linked_list_last(node, loc_prev);
universe@475 89 }
universe@475 90
universe@481 91 void *cx_linked_list_last(
universe@508 92 void const *node,
universe@481 93 ptrdiff_t loc_next
universe@481 94 ) {
universe@478 95 assert(node != NULL);
universe@473 96 assert(loc_next >= 0);
universe@398 97
universe@508 98 void const *cur = node;
universe@508 99 void const *last;
universe@456 100 do {
universe@456 101 last = cur;
universe@480 102 } while ((cur = ll_next(cur)) != NULL);
universe@398 103
universe@508 104 return (void *) last;
universe@398 105 }
universe@398 106
universe@481 107 void *cx_linked_list_prev(
universe@508 108 void const *begin,
universe@481 109 ptrdiff_t loc_next,
universe@508 110 void const *node
universe@481 111 ) {
universe@473 112 assert(begin != NULL);
universe@478 113 assert(node != NULL);
universe@473 114 assert(loc_next >= 0);
universe@473 115 if (begin == node) return NULL;
universe@508 116 void const *cur = begin;
universe@508 117 void const *next;
universe@473 118 while (1) {
universe@480 119 next = ll_next(cur);
universe@508 120 if (next == node) return (void *) cur;
universe@473 121 cur = next;
universe@473 122 }
universe@473 123 }
universe@473 124
universe@481 125 void cx_linked_list_link(
universe@481 126 void *left,
universe@481 127 void *right,
universe@481 128 ptrdiff_t loc_prev,
universe@481 129 ptrdiff_t loc_next
universe@481 130 ) {
universe@473 131 assert(loc_next >= 0);
universe@481 132 ll_next(left) = right;
universe@481 133 if (loc_prev >= 0) {
universe@481 134 ll_prev(right) = left;
universe@481 135 }
universe@481 136 }
universe@481 137
universe@481 138 void cx_linked_list_unlink(
universe@481 139 void *left,
universe@481 140 void *right,
universe@481 141 ptrdiff_t loc_prev,
universe@481 142 ptrdiff_t loc_next
universe@481 143 ) {
universe@481 144 assert (loc_next >= 0);
universe@481 145 assert(ll_next(left) == right);
universe@481 146 ll_next(left) = NULL;
universe@481 147 if (loc_prev >= 0) {
universe@481 148 assert(ll_prev(right) == left);
universe@481 149 ll_prev(right) = NULL;
universe@481 150 }
universe@481 151 }
universe@481 152
universe@481 153 void cx_linked_list_add(
universe@481 154 void **begin,
universe@481 155 void **end,
universe@481 156 ptrdiff_t loc_prev,
universe@481 157 ptrdiff_t loc_next,
universe@481 158 void *new_node
universe@481 159 ) {
universe@456 160 void *last;
universe@456 161 if (end == NULL) {
universe@456 162 assert(begin != NULL);
universe@478 163 last = *begin == NULL ? NULL : cx_linked_list_last(*begin, loc_next);
universe@456 164 } else {
universe@456 165 last = *end;
universe@456 166 }
universe@481 167 cx_linked_list_insert_chain(begin, end, loc_prev, loc_next, last, new_node, new_node);
universe@481 168 }
universe@481 169
universe@481 170 void cx_linked_list_prepend(
universe@481 171 void **begin,
universe@481 172 void **end,
universe@481 173 ptrdiff_t loc_prev,
universe@481 174 ptrdiff_t loc_next,
universe@481 175 void *new_node
universe@481 176 ) {
universe@481 177 cx_linked_list_insert_chain(begin, end, loc_prev, loc_next, NULL, new_node, new_node);
universe@481 178 }
universe@481 179
universe@481 180 void cx_linked_list_insert(
universe@481 181 void **begin,
universe@481 182 void **end,
universe@481 183 ptrdiff_t loc_prev,
universe@481 184 ptrdiff_t loc_next,
universe@481 185 void *node,
universe@481 186 void *new_node
universe@481 187 ) {
universe@481 188 cx_linked_list_insert_chain(begin, end, loc_prev, loc_next, node, new_node, new_node);
universe@481 189 }
universe@481 190
universe@481 191 void cx_linked_list_insert_chain(
universe@481 192 void **begin,
universe@481 193 void **end,
universe@481 194 ptrdiff_t loc_prev,
universe@481 195 ptrdiff_t loc_next,
universe@481 196 void *node,
universe@481 197 void *insert_begin,
universe@481 198 void *insert_end
universe@481 199 ) {
universe@481 200 // find the end of the chain, if not specified
universe@481 201 if (insert_end == NULL) {
universe@481 202 insert_end = cx_linked_list_last(insert_begin, loc_next);
universe@481 203 }
universe@481 204
universe@481 205 // determine the successor
universe@481 206 void *successor;
universe@481 207 if (node == NULL) {
universe@481 208 assert(begin != NULL || (end != NULL && loc_prev >= 0));
universe@475 209 if (begin != NULL) {
universe@481 210 successor = *begin;
universe@481 211 *begin = insert_begin;
universe@481 212 } else {
universe@481 213 successor = *end == NULL ? NULL : cx_linked_list_first(*end, loc_prev);
universe@475 214 }
universe@428 215 } else {
universe@481 216 successor = ll_next(node);
universe@481 217 cx_linked_list_link(node, insert_begin, loc_prev, loc_next);
universe@398 218 }
universe@398 219
universe@481 220 if (successor == NULL) {
universe@481 221 // the list ends with the new chain
universe@481 222 if (end != NULL) {
universe@481 223 *end = insert_end;
universe@481 224 }
universe@481 225 } else {
universe@481 226 cx_linked_list_link(insert_end, successor, loc_prev, loc_next);
universe@398 227 }
universe@398 228 }
universe@398 229
universe@481 230 void cx_linked_list_remove(
universe@481 231 void **begin,
universe@481 232 void **end,
universe@481 233 ptrdiff_t loc_prev,
universe@481 234 ptrdiff_t loc_next,
universe@481 235 void *node
universe@481 236 ) {
universe@477 237 assert(node != NULL);
universe@473 238 assert(loc_next >= 0);
universe@473 239 assert(loc_prev >= 0 || begin != NULL);
universe@473 240
universe@473 241 // find adjacent nodes
universe@480 242 void *next = ll_next(node);
universe@473 243 void *prev;
universe@473 244 if (loc_prev >= 0) {
universe@480 245 prev = ll_prev(node);
universe@473 246 } else {
universe@473 247 prev = cx_linked_list_prev(*begin, loc_next, node);
universe@473 248 }
universe@473 249
universe@476 250 // update next pointer of prev node, or set begin
universe@476 251 if (prev == NULL) {
universe@476 252 if (begin != NULL) {
universe@476 253 *begin = next;
universe@476 254 }
universe@476 255 } else {
universe@480 256 ll_next(prev) = next;
universe@473 257 }
universe@476 258
universe@476 259 // update prev pointer of next node, or set end
universe@476 260 if (next == NULL) {
universe@476 261 if (end != NULL) {
universe@476 262 *end = prev;
universe@476 263 }
universe@476 264 } else if (loc_prev >= 0) {
universe@480 265 ll_prev(next) = prev;
universe@473 266 }
universe@473 267 }
universe@473 268
universe@481 269 size_t cx_linked_list_size(
universe@489 270 void const *node,
universe@481 271 ptrdiff_t loc_next
universe@481 272 ) {
universe@473 273 assert(loc_next >= 0);
universe@468 274 size_t size = 0;
universe@468 275 while (node != NULL) {
universe@480 276 node = ll_next(node);
universe@468 277 size++;
universe@468 278 }
universe@468 279 return size;
universe@468 280 }
universe@468 281
universe@481 282 static void *cx_linked_list_sort_merge(
universe@481 283 ptrdiff_t loc_prev,
universe@481 284 ptrdiff_t loc_next,
universe@481 285 ptrdiff_t loc_data,
universe@481 286 size_t length,
universe@481 287 void *ls,
universe@481 288 void *le,
universe@481 289 void *re,
universe@481 290 CxListComparator cmp_func
universe@481 291 ) {
universe@468 292 const size_t sbo_len = 1024;
universe@468 293 void *sbo[sbo_len];
universe@468 294 void **sorted = (length >= sbo_len) ? malloc(sizeof(void *) * length) : sbo;
universe@508 295 if (sorted == NULL) abort();
universe@468 296 void *rc, *lc;
universe@468 297
universe@468 298 lc = ls;
universe@468 299 rc = le;
universe@468 300 size_t n = 0;
universe@468 301 while (lc && lc != le && rc != re) {
universe@468 302 if (cmp_func(ll_data(lc), ll_data(rc)) <= 0) {
universe@468 303 sorted[n] = lc;
universe@468 304 lc = ll_next(lc);
universe@468 305 } else {
universe@468 306 sorted[n] = rc;
universe@468 307 rc = ll_next(rc);
universe@468 308 }
universe@468 309 n++;
universe@468 310 }
universe@468 311 while (lc && lc != le) {
universe@468 312 sorted[n] = lc;
universe@468 313 lc = ll_next(lc);
universe@468 314 n++;
universe@468 315 }
universe@468 316 while (rc && rc != re) {
universe@468 317 sorted[n] = rc;
universe@468 318 rc = ll_next(rc);
universe@468 319 n++;
universe@468 320 }
universe@468 321
universe@468 322 // Update pointer
universe@468 323 if (loc_prev >= 0) ll_prev(sorted[0]) = NULL;
universe@509 324 cx_for_n (i, length - 1) {
universe@481 325 cx_linked_list_link(sorted[i], sorted[i + 1], loc_prev, loc_next);
universe@468 326 }
universe@468 327 ll_next(sorted[length - 1]) = NULL;
universe@468 328
universe@468 329 void *ret = sorted[0];
universe@468 330 if (sorted != sbo) {
universe@468 331 free(sorted);
universe@468 332 }
universe@468 333 return ret;
universe@468 334 }
universe@468 335
universe@628 336 void cx_linked_list_sort( // NOLINT(misc-no-recursion) - purposely recursive function
universe@481 337 void **begin,
universe@481 338 void **end,
universe@481 339 ptrdiff_t loc_prev,
universe@481 340 ptrdiff_t loc_next,
universe@481 341 ptrdiff_t loc_data,
universe@481 342 CxListComparator cmp_func
universe@481 343 ) {
universe@468 344 assert(begin != NULL);
universe@473 345 assert(loc_next >= 0);
universe@473 346 assert(loc_data >= 0);
universe@473 347 assert(cmp_func);
universe@468 348
universe@468 349 void *lc, *ls, *le, *re;
universe@468 350
universe@468 351 // set start node
universe@468 352 ls = *begin;
universe@468 353
universe@468 354 // check how many elements are already sorted
universe@468 355 lc = ls;
universe@468 356 size_t ln = 1;
universe@468 357 while (ll_next(lc) != NULL && cmp_func(ll_data(ll_next(lc)), ll_data(lc)) > 0) {
universe@468 358 lc = ll_next(lc);
universe@468 359 ln++;
universe@468 360 }
universe@468 361 le = ll_next(lc);
universe@468 362
universe@468 363 // if first unsorted node is NULL, the list is already completely sorted
universe@468 364 if (le != NULL) {
universe@468 365 void *rc;
universe@468 366 size_t rn = 1;
universe@468 367 rc = le;
universe@468 368 // skip already sorted elements
universe@468 369 while (ll_next(rc) != NULL && cmp_func(ll_data(ll_next(rc)), ll_data(rc)) > 0) {
universe@468 370 rc = ll_next(rc);
universe@468 371 rn++;
universe@468 372 }
universe@468 373 re = ll_next(rc);
universe@468 374
universe@468 375 // {ls,...,le->prev} and {rs,...,re->prev} are sorted - merge them
universe@639 376 void *sorted = cx_linked_list_sort_merge(loc_prev, loc_next, loc_data,
universe@468 377 ln + rn, ls, le, re, cmp_func);
universe@468 378
universe@468 379 // Something left? Sort it!
universe@468 380 size_t remainder_length = cx_linked_list_size(re, loc_next);
universe@468 381 if (remainder_length > 0) {
universe@468 382 void *remainder = re;
universe@639 383 cx_linked_list_sort(&remainder, NULL, loc_prev, loc_next, loc_data, cmp_func);
universe@468 384
universe@468 385 // merge sorted list with (also sorted) remainder
universe@639 386 *begin = cx_linked_list_sort_merge(loc_prev, loc_next, loc_data,
universe@468 387 ln + rn + remainder_length,
universe@468 388 sorted, remainder, NULL, cmp_func);
universe@468 389 } else {
universe@468 390 // no remainder - we've got our sorted list
universe@468 391 *begin = sorted;
universe@468 392 }
universe@468 393 if (end) *end = cx_linked_list_last(sorted, loc_next);
universe@468 394 }
universe@468 395 }
universe@468 396
universe@486 397 int cx_linked_list_compare(
universe@489 398 void const *begin_left,
universe@489 399 void const *begin_right,
universe@486 400 ptrdiff_t loc_advance,
universe@486 401 ptrdiff_t loc_data,
universe@486 402 CxListComparator cmp_func
universe@486 403 ) {
universe@489 404 void const *left = begin_left, *right = begin_right;
universe@486 405
universe@486 406 while (left != NULL && right != NULL) {
universe@639 407 void const *left_data = ll_data(left);
universe@639 408 void const *right_data = ll_data(right);
universe@552 409 int result = cmp_func(left_data, right_data);
universe@486 410 if (result != 0) return result;
universe@486 411 left = ll_advance(left);
universe@486 412 right = ll_advance(right);
universe@486 413 }
universe@486 414
universe@486 415 if (left != NULL) { return 1; }
universe@486 416 else if (right != NULL) { return -1; }
universe@486 417 else { return 0; }
universe@486 418 }
universe@486 419
universe@481 420 void cx_linked_list_reverse(
universe@481 421 void **begin,
universe@481 422 void **end,
universe@481 423 ptrdiff_t loc_prev,
universe@481 424 ptrdiff_t loc_next
universe@481 425 ) {
universe@473 426 assert(begin != NULL);
universe@473 427 assert(loc_next >= 0);
universe@473 428
universe@473 429 // swap all links
universe@473 430 void *prev = NULL;
universe@473 431 void *cur = *begin;
universe@473 432 while (cur != NULL) {
universe@480 433 void *next = ll_next(cur);
universe@473 434
universe@480 435 ll_next(cur) = prev;
universe@473 436 if (loc_prev >= 0) {
universe@480 437 ll_prev(cur) = next;
universe@473 438 }
universe@473 439
universe@473 440 prev = cur;
universe@473 441 cur = next;
universe@473 442 }
universe@473 443
universe@473 444 // update begin and end
universe@473 445 if (end != NULL) {
universe@473 446 *end = *begin;
universe@473 447 }
universe@473 448 *begin = prev;
universe@473 449 }
universe@473 450
universe@628 451 // HIGH LEVEL LINKED LIST IMPLEMENTATION
universe@398 452
universe@647 453 bool CX_DISABLE_LINKED_LIST_SWAP_SBO = false;
universe@647 454
universe@447 455 typedef struct cx_linked_list_node cx_linked_list_node;
universe@447 456 struct cx_linked_list_node {
universe@447 457 cx_linked_list_node *prev;
universe@447 458 cx_linked_list_node *next;
universe@403 459 char payload[];
universe@447 460 };
universe@402 461
universe@446 462 #define CX_LL_LOC_PREV offsetof(cx_linked_list_node, prev)
universe@446 463 #define CX_LL_LOC_NEXT offsetof(cx_linked_list_node, next)
universe@469 464 #define CX_LL_LOC_DATA offsetof(cx_linked_list_node, payload)
universe@439 465
universe@398 466 typedef struct {
universe@500 467 struct cx_list_s base;
universe@446 468 cx_linked_list_node *begin;
universe@446 469 cx_linked_list_node *end;
universe@398 470 } cx_linked_list;
universe@398 471
universe@481 472 static cx_linked_list_node *cx_ll_node_at(
universe@489 473 cx_linked_list const *list,
universe@481 474 size_t index
universe@481 475 ) {
universe@447 476 if (index >= list->base.size) {
universe@447 477 return NULL;
universe@447 478 } else if (index > list->base.size / 2) {
universe@468 479 return cx_linked_list_at(list->end, list->base.size - 1, CX_LL_LOC_PREV, index);
universe@447 480 } else {
universe@447 481 return cx_linked_list_at(list->begin, 0, CX_LL_LOC_NEXT, index);
universe@447 482 }
universe@447 483 }
universe@447 484
universe@499 485 static int cx_ll_insert_at(
universe@500 486 struct cx_list_s *list,
universe@499 487 cx_linked_list_node *node,
universe@489 488 void const *elem
universe@481 489 ) {
universe@448 490
universe@481 491 // create the new new_node
universe@481 492 cx_linked_list_node *new_node = cxMalloc(list->allocator,
universe@481 493 sizeof(cx_linked_list_node) + list->itemsize);
universe@448 494
universe@448 495 // sortir if failed
universe@481 496 if (new_node == NULL) return 1;
universe@448 497
universe@481 498 // initialize new new_node
universe@481 499 new_node->prev = new_node->next = NULL;
universe@481 500 memcpy(new_node->payload, elem, list->itemsize);
universe@448 501
universe@481 502 // insert
universe@499 503 cx_linked_list *ll = (cx_linked_list *) list;
universe@481 504 cx_linked_list_insert_chain(
universe@481 505 (void **) &ll->begin, (void **) &ll->end,
universe@481 506 CX_LL_LOC_PREV, CX_LL_LOC_NEXT,
universe@481 507 node, new_node, new_node
universe@481 508 );
universe@448 509
universe@448 510 // increase the size and return
universe@448 511 list->size++;
universe@448 512 return 0;
universe@448 513 }
universe@448 514
universe@638 515 static size_t cx_ll_insert_array(
universe@638 516 struct cx_list_s *list,
universe@638 517 size_t index,
universe@638 518 void const *array,
universe@638 519 size_t n
universe@638 520 ) {
universe@638 521 // out-of bounds and corner case check
universe@638 522 if (index > list->size || n == 0) return 0;
universe@638 523
universe@638 524 // find position efficiently
universe@638 525 cx_linked_list_node *node = index == 0 ? NULL : cx_ll_node_at((cx_linked_list *) list, index - 1);
universe@638 526
universe@638 527 // perform first insert
universe@638 528 if (0 != cx_ll_insert_at(list, node, array)) {
universe@638 529 return 1;
universe@638 530 }
universe@638 531
universe@638 532 // is there more?
universe@638 533 if (n == 1) return 1;
universe@638 534
universe@638 535 // we now know exactly where we are
universe@638 536 node = node == NULL ? ((cx_linked_list *) list)->begin : node->next;
universe@638 537
universe@638 538 // we can add the remaining nodes and immedately advance to the inserted node
universe@638 539 char const *source = array;
universe@638 540 for (size_t i = 1; i < n; i++) {
universe@638 541 source += list->itemsize;
universe@638 542 if (0 != cx_ll_insert_at(list, node, source)) {
universe@638 543 return i;
universe@638 544 }
universe@638 545 node = node->next;
universe@638 546 }
universe@638 547 return n;
universe@638 548 }
universe@638 549
universe@641 550 static int cx_ll_insert_element(
universe@641 551 struct cx_list_s *list,
universe@641 552 size_t index,
universe@641 553 void const *element
universe@641 554 ) {
universe@641 555 return 1 != cx_ll_insert_array(list, index, element, 1);
universe@641 556 }
universe@641 557
universe@481 558 static int cx_ll_remove(
universe@500 559 struct cx_list_s *list,
universe@481 560 size_t index
universe@481 561 ) {
universe@447 562 cx_linked_list *ll = (cx_linked_list *) list;
universe@447 563 cx_linked_list_node *node = cx_ll_node_at(ll, index);
universe@447 564
universe@447 565 // out-of-bounds check
universe@447 566 if (node == NULL) return 1;
universe@447 567
universe@476 568 // remove
universe@476 569 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
universe@476 570 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
universe@447 571
universe@447 572 // adjust size
universe@447 573 list->size--;
universe@447 574
universe@447 575 // free and return
universe@447 576 cxFree(list->allocator, node);
universe@447 577
universe@438 578 return 0;
universe@398 579 }
universe@398 580
universe@647 581 #ifndef CX_LINKED_LIST_SWAP_SBO_SIZE
universe@647 582 #define CX_LINKED_LIST_SWAP_SBO_SIZE 16
universe@647 583 #endif
universe@647 584
universe@647 585 static int cx_ll_swap(
universe@647 586 struct cx_list_s *list,
universe@647 587 size_t i,
universe@647 588 size_t j
universe@647 589 ) {
universe@647 590 if (i >= list->size || j >= list->size) return 1;
universe@647 591 if (i == j) return 0;
universe@647 592
universe@647 593 // perform an optimized search that finds both elements in one run
universe@647 594 cx_linked_list *ll = (cx_linked_list *) list;
universe@647 595 size_t mid = list->size / 2;
universe@647 596 size_t left, right;
universe@647 597 if (i < j) {
universe@647 598 left = i;
universe@647 599 right = j;
universe@647 600 } else {
universe@647 601 left = j;
universe@647 602 right = i;
universe@647 603 }
universe@647 604 cx_linked_list_node *nleft, *nright;
universe@647 605 if (left < mid && right < mid) {
universe@647 606 // case 1: both items left from mid
universe@647 607 nleft = cx_ll_node_at(ll, left);
universe@647 608 nright = nleft;
universe@647 609 for (size_t c = left; c < right; c++) {
universe@647 610 nright = nright->next;
universe@647 611 }
universe@647 612 } else if (left >= mid && right >= mid) {
universe@647 613 // case 2: both items right from mid
universe@647 614 nright = cx_ll_node_at(ll, right);
universe@647 615 nleft = nright;
universe@647 616 for (size_t c = right; c > left; c--) {
universe@647 617 nleft = nleft->prev;
universe@647 618 }
universe@647 619 } else {
universe@647 620 // case 3: one item left, one item right
universe@647 621
universe@647 622 // chose the closest to begin / end
universe@647 623 size_t closest;
universe@647 624 size_t other;
universe@647 625 size_t diff2boundary = list->size - right - 1;
universe@647 626 if (left <= diff2boundary) {
universe@647 627 closest = left;
universe@647 628 other = right;
universe@647 629 nleft = cx_ll_node_at(ll, left);
universe@647 630 } else {
universe@647 631 closest = right;
universe@647 632 other = left;
universe@647 633 diff2boundary = left;
universe@647 634 nright = cx_ll_node_at(ll, right);
universe@647 635 }
universe@647 636
universe@647 637 // is other element closer to us or closer to boundary?
universe@647 638 if (right - left <= diff2boundary) {
universe@647 639 // search other element starting from already found element
universe@647 640 if (closest == left) {
universe@647 641 nright = nleft;
universe@647 642 for (size_t c = left; c < right; c++) {
universe@647 643 nright = nright->next;
universe@647 644 }
universe@647 645 } else {
universe@647 646 nleft = nright;
universe@647 647 for (size_t c = right; c > left; c--) {
universe@647 648 nleft = nleft->prev;
universe@647 649 }
universe@647 650 }
universe@647 651 } else {
universe@647 652 // search other element starting at the boundary
universe@647 653 if (closest == left) {
universe@647 654 nright = cx_ll_node_at(ll, other);
universe@647 655 } else {
universe@647 656 nleft = cx_ll_node_at(ll, other);
universe@647 657 }
universe@647 658 }
universe@647 659 }
universe@647 660
universe@647 661 if (list->itemsize > CX_LINKED_LIST_SWAP_SBO_SIZE || CX_DISABLE_LINKED_LIST_SWAP_SBO) {
universe@647 662 cx_linked_list_node *prev = nleft->prev;
universe@647 663 cx_linked_list_node *next = nright->next;
universe@647 664 cx_linked_list_node *midstart = nleft->next;
universe@647 665 cx_linked_list_node *midend = nright->prev;
universe@647 666
universe@647 667 if (prev == NULL) {
universe@647 668 ll->begin = nright;
universe@647 669 } else {
universe@647 670 prev->next = nright;
universe@647 671 }
universe@647 672 nright->prev = prev;
universe@647 673 if (midstart == nright) {
universe@647 674 // special case: both nodes are adjacent
universe@647 675 nright->next = nleft;
universe@647 676 nleft->prev = nright;
universe@647 677 } else {
universe@647 678 // likely case: a chain is between the two nodes
universe@647 679 nright->next = midstart;
universe@647 680 midstart->prev = nright;
universe@647 681 midend->next = nleft;
universe@647 682 nleft->prev = midend;
universe@647 683 }
universe@647 684 nleft->next = next;
universe@647 685 if (next == NULL) {
universe@647 686 ll->end = nleft;
universe@647 687 } else {
universe@647 688 next->prev = nleft;
universe@647 689 }
universe@647 690 } else {
universe@647 691 // swap payloads to avoid relinking
universe@647 692 char buf[CX_LINKED_LIST_SWAP_SBO_SIZE];
universe@647 693 memcpy(buf, nleft->payload, list->itemsize);
universe@647 694 memcpy(nleft->payload, nright->payload, list->itemsize);
universe@647 695 memcpy(nright->payload, buf, list->itemsize);
universe@647 696 }
universe@647 697
universe@647 698 return 0;
universe@647 699 }
universe@647 700
universe@481 701 static void *cx_ll_at(
universe@500 702 struct cx_list_s const *list,
universe@481 703 size_t index
universe@481 704 ) {
universe@439 705 cx_linked_list *ll = (cx_linked_list *) list;
universe@447 706 cx_linked_list_node *node = cx_ll_node_at(ll, index);
universe@466 707 return node == NULL ? NULL : node->payload;
universe@466 708 }
universe@466 709
universe@481 710 static size_t cx_ll_find(
universe@500 711 struct cx_list_s const *list,
universe@489 712 void const *elem
universe@481 713 ) {
universe@480 714 return cx_linked_list_find(((cx_linked_list *) list)->begin,
universe@480 715 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
universe@639 716 list->cmpfunc, elem);
universe@466 717 }
universe@466 718
universe@500 719 static void cx_ll_sort(struct cx_list_s *list) {
universe@469 720 cx_linked_list *ll = (cx_linked_list *) list;
universe@469 721 cx_linked_list_sort((void **) &ll->begin, (void **) &ll->end,
universe@469 722 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
universe@639 723 list->cmpfunc);
universe@469 724 }
universe@469 725
universe@500 726 static void cx_ll_reverse(struct cx_list_s *list) {
universe@490 727 cx_linked_list *ll = (cx_linked_list *) list;
universe@521 728 cx_linked_list_reverse((void **) &ll->begin, (void **) &ll->end, CX_LL_LOC_PREV, CX_LL_LOC_NEXT);
universe@490 729 }
universe@490 730
universe@488 731 static int cx_ll_compare(
universe@500 732 struct cx_list_s const *list,
universe@500 733 struct cx_list_s const *other
universe@488 734 ) {
universe@488 735 cx_linked_list *left = (cx_linked_list *) list;
universe@488 736 cx_linked_list *right = (cx_linked_list *) other;
universe@488 737 return cx_linked_list_compare(left->begin, right->begin,
universe@488 738 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
universe@639 739 list->cmpfunc);
universe@488 740 }
universe@488 741
universe@630 742 static bool cx_ll_iter_valid(void const *it) {
universe@630 743 struct cx_iterator_s const *iter = it;
universe@495 744 return iter->elem_handle != NULL;
universe@494 745 }
universe@494 746
universe@630 747 static void cx_ll_iter_next(void *it) {
universe@630 748 struct cx_iterator_base_s *itbase = it;
universe@630 749 if (itbase->remove) {
universe@630 750 itbase->remove = false;
universe@630 751 struct cx_mut_iterator_s *iter = it;
universe@495 752 cx_linked_list *ll = iter->src_handle;
universe@495 753 cx_linked_list_node *node = iter->elem_handle;
universe@495 754 iter->elem_handle = node->next;
universe@495 755 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
universe@495 756 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
universe@495 757 ll->base.size--;
universe@495 758 cxFree(ll->base.allocator, node);
universe@495 759 } else {
universe@630 760 struct cx_iterator_s *iter = it;
universe@495 761 iter->index++;
universe@495 762 cx_linked_list_node *node = iter->elem_handle;
universe@495 763 iter->elem_handle = node->next;
universe@495 764 }
universe@494 765 }
universe@494 766
universe@655 767 static void cx_ll_iter_prev(void *it) {
universe@655 768 struct cx_iterator_base_s *itbase = it;
universe@655 769 if (itbase->remove) {
universe@655 770 itbase->remove = false;
universe@655 771 struct cx_mut_iterator_s *iter = it;
universe@655 772 cx_linked_list *ll = iter->src_handle;
universe@655 773 cx_linked_list_node *node = iter->elem_handle;
universe@655 774 iter->elem_handle = node->prev;
universe@655 775 iter->index--;
universe@655 776 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
universe@655 777 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
universe@655 778 ll->base.size--;
universe@655 779 cxFree(ll->base.allocator, node);
universe@655 780 } else {
universe@655 781 struct cx_iterator_s *iter = it;
universe@655 782 iter->index--;
universe@655 783 cx_linked_list_node *node = iter->elem_handle;
universe@655 784 iter->elem_handle = node->prev;
universe@655 785 }
universe@655 786 }
universe@655 787
universe@630 788 static void *cx_ll_iter_current(void const *it) {
universe@630 789 struct cx_iterator_s const *iter = it;
universe@495 790 cx_linked_list_node *node = iter->elem_handle;
universe@494 791 return node->payload;
universe@494 792 }
universe@494 793
universe@630 794 static bool cx_ll_iter_flag_rm(void *it) {
universe@630 795 struct cx_iterator_base_s *iter = it;
universe@630 796 if (iter->mutating) {
universe@630 797 iter->remove = true;
universe@630 798 return true;
universe@630 799 } else {
universe@630 800 return false;
universe@630 801 }
universe@630 802 }
universe@630 803
universe@494 804 static CxIterator cx_ll_iterator(
universe@630 805 struct cx_list_s const *list,
universe@655 806 size_t index,
universe@655 807 bool backwards
universe@494 808 ) {
universe@494 809 CxIterator iter;
universe@494 810 iter.index = index;
universe@495 811 iter.src_handle = list;
universe@495 812 iter.elem_handle = cx_ll_node_at((cx_linked_list const *) list, index);
universe@630 813 iter.base.valid = cx_ll_iter_valid;
universe@630 814 iter.base.current = cx_ll_iter_current;
universe@655 815 iter.base.next = backwards ? cx_ll_iter_prev : cx_ll_iter_next;
universe@630 816 iter.base.flag_removal = cx_ll_iter_flag_rm;
universe@630 817 iter.base.mutating = false;
universe@630 818 iter.base.remove = false;
universe@494 819 return iter;
universe@494 820 }
universe@494 821
universe@499 822 static int cx_ll_insert_iter(
universe@630 823 CxMutIterator *iter,
universe@499 824 void const *elem,
universe@499 825 int prepend
universe@499 826 ) {
universe@500 827 struct cx_list_s *list = iter->src_handle;
universe@499 828 cx_linked_list_node *node = iter->elem_handle;
universe@499 829 if (node != NULL) {
universe@499 830 assert(prepend >= 0 && prepend <= 1);
universe@499 831 cx_linked_list_node *choice[2] = {node, node->prev};
universe@499 832 int result = cx_ll_insert_at(list, choice[prepend], elem);
universe@499 833 iter->index += prepend * (0 == result);
universe@499 834 return result;
universe@499 835 } else {
universe@641 836 int result = cx_ll_insert_element(list, list->size, elem);
universe@499 837 iter->index = list->size;
universe@499 838 return result;
universe@499 839 }
universe@499 840 }
universe@499 841
universe@524 842 static void cx_ll_destructor(CxList *list) {
universe@524 843 cx_linked_list *ll = (cx_linked_list *) list;
universe@524 844
universe@524 845 cx_linked_list_node *node = ll->begin;
universe@524 846 while (node) {
universe@524 847 void *next = node->next;
universe@524 848 cxFree(list->allocator, node);
universe@524 849 node = next;
universe@524 850 }
universe@524 851 // do not free the list pointer, this is just a destructor!
universe@524 852 }
universe@524 853
universe@451 854 static cx_list_class cx_linked_list_class = {
universe@524 855 cx_ll_destructor,
universe@641 856 cx_ll_insert_element,
universe@638 857 cx_ll_insert_array,
universe@499 858 cx_ll_insert_iter,
universe@398 859 cx_ll_remove,
universe@647 860 cx_ll_swap,
universe@439 861 cx_ll_at,
universe@404 862 cx_ll_find,
universe@488 863 cx_ll_sort,
universe@490 864 cx_ll_compare,
universe@494 865 cx_ll_reverse,
universe@630 866 cx_ll_iterator,
universe@398 867 };
universe@398 868
universe@500 869 CxList *cxLinkedListCreate(
universe@508 870 CxAllocator const *allocator,
universe@481 871 CxListComparator comparator,
universe@481 872 size_t item_size
universe@481 873 ) {
universe@503 874 cx_linked_list *list = cxCalloc(allocator, 1, sizeof(cx_linked_list));
universe@528 875 if (list == NULL) return NULL;
universe@398 876
universe@435 877 list->base.cl = &cx_linked_list_class;
universe@435 878 list->base.allocator = allocator;
universe@435 879 list->base.cmpfunc = comparator;
universe@435 880 list->base.itemsize = item_size;
universe@435 881 list->base.capacity = SIZE_MAX;
universe@406 882
universe@500 883 return (CxList *) list;
universe@406 884 }

mercurial