src/linked_list.c

Fri, 05 May 2023 19:07:56 +0200

author
Mike Becker <universe@uap-core.de>
date
Fri, 05 May 2023 19:07:56 +0200
changeset 702
3390b58ad15a
parent 699
35b2b99ee523
child 703
425d4279856f
permissions
-rw-r--r--

fix cx_linked_list_sort() not working for empty lists

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@699 59 ssize_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@677 63 cx_compare_func 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@699 72 ssize_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@699 81 return -1;
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@661 282 #ifndef CX_LINKED_LIST_SORT_SBO_SIZE
universe@661 283 #define CX_LINKED_LIST_SORT_SBO_SIZE 1024
universe@661 284 #endif
universe@661 285
universe@481 286 static void *cx_linked_list_sort_merge(
universe@481 287 ptrdiff_t loc_prev,
universe@481 288 ptrdiff_t loc_next,
universe@481 289 ptrdiff_t loc_data,
universe@481 290 size_t length,
universe@481 291 void *ls,
universe@481 292 void *le,
universe@481 293 void *re,
universe@677 294 cx_compare_func cmp_func
universe@481 295 ) {
universe@661 296 void *sbo[CX_LINKED_LIST_SORT_SBO_SIZE];
universe@661 297 void **sorted = length >= CX_LINKED_LIST_SORT_SBO_SIZE ?
universe@662 298 malloc(sizeof(void *) * length) : sbo;
universe@508 299 if (sorted == NULL) abort();
universe@468 300 void *rc, *lc;
universe@468 301
universe@468 302 lc = ls;
universe@468 303 rc = le;
universe@468 304 size_t n = 0;
universe@468 305 while (lc && lc != le && rc != re) {
universe@468 306 if (cmp_func(ll_data(lc), ll_data(rc)) <= 0) {
universe@468 307 sorted[n] = lc;
universe@468 308 lc = ll_next(lc);
universe@468 309 } else {
universe@468 310 sorted[n] = rc;
universe@468 311 rc = ll_next(rc);
universe@468 312 }
universe@468 313 n++;
universe@468 314 }
universe@468 315 while (lc && lc != le) {
universe@468 316 sorted[n] = lc;
universe@468 317 lc = ll_next(lc);
universe@468 318 n++;
universe@468 319 }
universe@468 320 while (rc && rc != re) {
universe@468 321 sorted[n] = rc;
universe@468 322 rc = ll_next(rc);
universe@468 323 n++;
universe@468 324 }
universe@468 325
universe@468 326 // Update pointer
universe@468 327 if (loc_prev >= 0) ll_prev(sorted[0]) = NULL;
universe@509 328 cx_for_n (i, length - 1) {
universe@481 329 cx_linked_list_link(sorted[i], sorted[i + 1], loc_prev, loc_next);
universe@468 330 }
universe@468 331 ll_next(sorted[length - 1]) = NULL;
universe@468 332
universe@468 333 void *ret = sorted[0];
universe@468 334 if (sorted != sbo) {
universe@468 335 free(sorted);
universe@468 336 }
universe@468 337 return ret;
universe@468 338 }
universe@468 339
universe@628 340 void cx_linked_list_sort( // NOLINT(misc-no-recursion) - purposely recursive function
universe@481 341 void **begin,
universe@481 342 void **end,
universe@481 343 ptrdiff_t loc_prev,
universe@481 344 ptrdiff_t loc_next,
universe@481 345 ptrdiff_t loc_data,
universe@677 346 cx_compare_func cmp_func
universe@481 347 ) {
universe@468 348 assert(begin != NULL);
universe@473 349 assert(loc_next >= 0);
universe@473 350 assert(loc_data >= 0);
universe@473 351 assert(cmp_func);
universe@468 352
universe@468 353 void *lc, *ls, *le, *re;
universe@468 354
universe@468 355 // set start node
universe@468 356 ls = *begin;
universe@468 357
universe@702 358 // early exit when this list is empty
universe@702 359 if (ls == NULL) return;
universe@702 360
universe@468 361 // check how many elements are already sorted
universe@468 362 lc = ls;
universe@468 363 size_t ln = 1;
universe@468 364 while (ll_next(lc) != NULL && cmp_func(ll_data(ll_next(lc)), ll_data(lc)) > 0) {
universe@468 365 lc = ll_next(lc);
universe@468 366 ln++;
universe@468 367 }
universe@468 368 le = ll_next(lc);
universe@468 369
universe@468 370 // if first unsorted node is NULL, the list is already completely sorted
universe@468 371 if (le != NULL) {
universe@468 372 void *rc;
universe@468 373 size_t rn = 1;
universe@468 374 rc = le;
universe@468 375 // skip already sorted elements
universe@468 376 while (ll_next(rc) != NULL && cmp_func(ll_data(ll_next(rc)), ll_data(rc)) > 0) {
universe@468 377 rc = ll_next(rc);
universe@468 378 rn++;
universe@468 379 }
universe@468 380 re = ll_next(rc);
universe@468 381
universe@468 382 // {ls,...,le->prev} and {rs,...,re->prev} are sorted - merge them
universe@639 383 void *sorted = cx_linked_list_sort_merge(loc_prev, loc_next, loc_data,
universe@468 384 ln + rn, ls, le, re, cmp_func);
universe@468 385
universe@468 386 // Something left? Sort it!
universe@468 387 size_t remainder_length = cx_linked_list_size(re, loc_next);
universe@468 388 if (remainder_length > 0) {
universe@468 389 void *remainder = re;
universe@639 390 cx_linked_list_sort(&remainder, NULL, loc_prev, loc_next, loc_data, cmp_func);
universe@468 391
universe@468 392 // merge sorted list with (also sorted) remainder
universe@639 393 *begin = cx_linked_list_sort_merge(loc_prev, loc_next, loc_data,
universe@468 394 ln + rn + remainder_length,
universe@468 395 sorted, remainder, NULL, cmp_func);
universe@468 396 } else {
universe@468 397 // no remainder - we've got our sorted list
universe@468 398 *begin = sorted;
universe@468 399 }
universe@468 400 if (end) *end = cx_linked_list_last(sorted, loc_next);
universe@468 401 }
universe@468 402 }
universe@468 403
universe@486 404 int cx_linked_list_compare(
universe@489 405 void const *begin_left,
universe@489 406 void const *begin_right,
universe@486 407 ptrdiff_t loc_advance,
universe@486 408 ptrdiff_t loc_data,
universe@677 409 cx_compare_func cmp_func
universe@486 410 ) {
universe@489 411 void const *left = begin_left, *right = begin_right;
universe@486 412
universe@486 413 while (left != NULL && right != NULL) {
universe@639 414 void const *left_data = ll_data(left);
universe@639 415 void const *right_data = ll_data(right);
universe@552 416 int result = cmp_func(left_data, right_data);
universe@486 417 if (result != 0) return result;
universe@486 418 left = ll_advance(left);
universe@486 419 right = ll_advance(right);
universe@486 420 }
universe@486 421
universe@486 422 if (left != NULL) { return 1; }
universe@486 423 else if (right != NULL) { return -1; }
universe@486 424 else { return 0; }
universe@486 425 }
universe@486 426
universe@481 427 void cx_linked_list_reverse(
universe@481 428 void **begin,
universe@481 429 void **end,
universe@481 430 ptrdiff_t loc_prev,
universe@481 431 ptrdiff_t loc_next
universe@481 432 ) {
universe@473 433 assert(begin != NULL);
universe@473 434 assert(loc_next >= 0);
universe@473 435
universe@473 436 // swap all links
universe@473 437 void *prev = NULL;
universe@473 438 void *cur = *begin;
universe@473 439 while (cur != NULL) {
universe@480 440 void *next = ll_next(cur);
universe@473 441
universe@480 442 ll_next(cur) = prev;
universe@473 443 if (loc_prev >= 0) {
universe@480 444 ll_prev(cur) = next;
universe@473 445 }
universe@473 446
universe@473 447 prev = cur;
universe@473 448 cur = next;
universe@473 449 }
universe@473 450
universe@473 451 // update begin and end
universe@473 452 if (end != NULL) {
universe@473 453 *end = *begin;
universe@473 454 }
universe@473 455 *begin = prev;
universe@473 456 }
universe@473 457
universe@628 458 // HIGH LEVEL LINKED LIST IMPLEMENTATION
universe@398 459
universe@647 460 bool CX_DISABLE_LINKED_LIST_SWAP_SBO = false;
universe@647 461
universe@447 462 typedef struct cx_linked_list_node cx_linked_list_node;
universe@447 463 struct cx_linked_list_node {
universe@447 464 cx_linked_list_node *prev;
universe@447 465 cx_linked_list_node *next;
universe@403 466 char payload[];
universe@447 467 };
universe@402 468
universe@446 469 #define CX_LL_LOC_PREV offsetof(cx_linked_list_node, prev)
universe@446 470 #define CX_LL_LOC_NEXT offsetof(cx_linked_list_node, next)
universe@469 471 #define CX_LL_LOC_DATA offsetof(cx_linked_list_node, payload)
universe@439 472
universe@398 473 typedef struct {
universe@500 474 struct cx_list_s base;
universe@446 475 cx_linked_list_node *begin;
universe@446 476 cx_linked_list_node *end;
universe@398 477 } cx_linked_list;
universe@398 478
universe@481 479 static cx_linked_list_node *cx_ll_node_at(
universe@489 480 cx_linked_list const *list,
universe@481 481 size_t index
universe@481 482 ) {
universe@447 483 if (index >= list->base.size) {
universe@447 484 return NULL;
universe@447 485 } else if (index > list->base.size / 2) {
universe@468 486 return cx_linked_list_at(list->end, list->base.size - 1, CX_LL_LOC_PREV, index);
universe@447 487 } else {
universe@447 488 return cx_linked_list_at(list->begin, 0, CX_LL_LOC_NEXT, index);
universe@447 489 }
universe@447 490 }
universe@447 491
universe@499 492 static int cx_ll_insert_at(
universe@500 493 struct cx_list_s *list,
universe@499 494 cx_linked_list_node *node,
universe@489 495 void const *elem
universe@481 496 ) {
universe@448 497
universe@481 498 // create the new new_node
universe@481 499 cx_linked_list_node *new_node = cxMalloc(list->allocator,
universe@677 500 sizeof(cx_linked_list_node) + list->item_size);
universe@448 501
universe@448 502 // sortir if failed
universe@481 503 if (new_node == NULL) return 1;
universe@448 504
universe@481 505 // initialize new new_node
universe@481 506 new_node->prev = new_node->next = NULL;
universe@677 507 memcpy(new_node->payload, elem, list->item_size);
universe@448 508
universe@481 509 // insert
universe@499 510 cx_linked_list *ll = (cx_linked_list *) list;
universe@481 511 cx_linked_list_insert_chain(
universe@481 512 (void **) &ll->begin, (void **) &ll->end,
universe@481 513 CX_LL_LOC_PREV, CX_LL_LOC_NEXT,
universe@481 514 node, new_node, new_node
universe@481 515 );
universe@448 516
universe@448 517 // increase the size and return
universe@448 518 list->size++;
universe@448 519 return 0;
universe@448 520 }
universe@448 521
universe@638 522 static size_t cx_ll_insert_array(
universe@638 523 struct cx_list_s *list,
universe@638 524 size_t index,
universe@638 525 void const *array,
universe@638 526 size_t n
universe@638 527 ) {
universe@638 528 // out-of bounds and corner case check
universe@638 529 if (index > list->size || n == 0) return 0;
universe@638 530
universe@638 531 // find position efficiently
universe@638 532 cx_linked_list_node *node = index == 0 ? NULL : cx_ll_node_at((cx_linked_list *) list, index - 1);
universe@638 533
universe@638 534 // perform first insert
universe@638 535 if (0 != cx_ll_insert_at(list, node, array)) {
universe@638 536 return 1;
universe@638 537 }
universe@638 538
universe@638 539 // is there more?
universe@638 540 if (n == 1) return 1;
universe@638 541
universe@638 542 // we now know exactly where we are
universe@638 543 node = node == NULL ? ((cx_linked_list *) list)->begin : node->next;
universe@638 544
universe@638 545 // we can add the remaining nodes and immedately advance to the inserted node
universe@638 546 char const *source = array;
universe@638 547 for (size_t i = 1; i < n; i++) {
universe@677 548 source += list->item_size;
universe@638 549 if (0 != cx_ll_insert_at(list, node, source)) {
universe@638 550 return i;
universe@638 551 }
universe@638 552 node = node->next;
universe@638 553 }
universe@638 554 return n;
universe@638 555 }
universe@638 556
universe@641 557 static int cx_ll_insert_element(
universe@641 558 struct cx_list_s *list,
universe@641 559 size_t index,
universe@641 560 void const *element
universe@641 561 ) {
universe@641 562 return 1 != cx_ll_insert_array(list, index, element, 1);
universe@641 563 }
universe@641 564
universe@481 565 static int cx_ll_remove(
universe@500 566 struct cx_list_s *list,
universe@481 567 size_t index
universe@481 568 ) {
universe@447 569 cx_linked_list *ll = (cx_linked_list *) list;
universe@447 570 cx_linked_list_node *node = cx_ll_node_at(ll, index);
universe@447 571
universe@447 572 // out-of-bounds check
universe@447 573 if (node == NULL) return 1;
universe@447 574
universe@664 575 // element destruction
universe@677 576 cx_invoke_destructor(list, node->payload);
universe@664 577
universe@476 578 // remove
universe@476 579 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
universe@476 580 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
universe@447 581
universe@447 582 // adjust size
universe@447 583 list->size--;
universe@447 584
universe@447 585 // free and return
universe@447 586 cxFree(list->allocator, node);
universe@447 587
universe@438 588 return 0;
universe@398 589 }
universe@398 590
universe@664 591 static void cx_ll_clear(struct cx_list_s *list) {
universe@664 592 if (list->size == 0) return;
universe@664 593
universe@664 594 cx_linked_list *ll = (cx_linked_list *) list;
universe@664 595 cx_linked_list_node *node = ll->begin;
universe@677 596 while (node != NULL) {
universe@677 597 cx_invoke_destructor(list, node->payload);
universe@677 598 cx_linked_list_node *next = node->next;
universe@677 599 cxFree(list->allocator, node);
universe@677 600 node = next;
universe@664 601 }
universe@664 602 ll->begin = ll->end = NULL;
universe@664 603 list->size = 0;
universe@664 604 }
universe@664 605
universe@647 606 #ifndef CX_LINKED_LIST_SWAP_SBO_SIZE
universe@647 607 #define CX_LINKED_LIST_SWAP_SBO_SIZE 16
universe@647 608 #endif
universe@647 609
universe@647 610 static int cx_ll_swap(
universe@647 611 struct cx_list_s *list,
universe@647 612 size_t i,
universe@647 613 size_t j
universe@647 614 ) {
universe@647 615 if (i >= list->size || j >= list->size) return 1;
universe@647 616 if (i == j) return 0;
universe@647 617
universe@647 618 // perform an optimized search that finds both elements in one run
universe@647 619 cx_linked_list *ll = (cx_linked_list *) list;
universe@647 620 size_t mid = list->size / 2;
universe@647 621 size_t left, right;
universe@647 622 if (i < j) {
universe@647 623 left = i;
universe@647 624 right = j;
universe@647 625 } else {
universe@647 626 left = j;
universe@647 627 right = i;
universe@647 628 }
universe@647 629 cx_linked_list_node *nleft, *nright;
universe@647 630 if (left < mid && right < mid) {
universe@647 631 // case 1: both items left from mid
universe@647 632 nleft = cx_ll_node_at(ll, left);
universe@647 633 nright = nleft;
universe@647 634 for (size_t c = left; c < right; c++) {
universe@647 635 nright = nright->next;
universe@647 636 }
universe@647 637 } else if (left >= mid && right >= mid) {
universe@647 638 // case 2: both items right from mid
universe@647 639 nright = cx_ll_node_at(ll, right);
universe@647 640 nleft = nright;
universe@647 641 for (size_t c = right; c > left; c--) {
universe@647 642 nleft = nleft->prev;
universe@647 643 }
universe@647 644 } else {
universe@647 645 // case 3: one item left, one item right
universe@647 646
universe@647 647 // chose the closest to begin / end
universe@647 648 size_t closest;
universe@647 649 size_t other;
universe@647 650 size_t diff2boundary = list->size - right - 1;
universe@647 651 if (left <= diff2boundary) {
universe@647 652 closest = left;
universe@647 653 other = right;
universe@647 654 nleft = cx_ll_node_at(ll, left);
universe@647 655 } else {
universe@647 656 closest = right;
universe@647 657 other = left;
universe@647 658 diff2boundary = left;
universe@647 659 nright = cx_ll_node_at(ll, right);
universe@647 660 }
universe@647 661
universe@647 662 // is other element closer to us or closer to boundary?
universe@647 663 if (right - left <= diff2boundary) {
universe@647 664 // search other element starting from already found element
universe@647 665 if (closest == left) {
universe@647 666 nright = nleft;
universe@647 667 for (size_t c = left; c < right; c++) {
universe@647 668 nright = nright->next;
universe@647 669 }
universe@647 670 } else {
universe@647 671 nleft = nright;
universe@647 672 for (size_t c = right; c > left; c--) {
universe@647 673 nleft = nleft->prev;
universe@647 674 }
universe@647 675 }
universe@647 676 } else {
universe@647 677 // search other element starting at the boundary
universe@647 678 if (closest == left) {
universe@647 679 nright = cx_ll_node_at(ll, other);
universe@647 680 } else {
universe@647 681 nleft = cx_ll_node_at(ll, other);
universe@647 682 }
universe@647 683 }
universe@647 684 }
universe@647 685
universe@677 686 if (list->item_size > CX_LINKED_LIST_SWAP_SBO_SIZE || CX_DISABLE_LINKED_LIST_SWAP_SBO) {
universe@647 687 cx_linked_list_node *prev = nleft->prev;
universe@647 688 cx_linked_list_node *next = nright->next;
universe@647 689 cx_linked_list_node *midstart = nleft->next;
universe@647 690 cx_linked_list_node *midend = nright->prev;
universe@647 691
universe@647 692 if (prev == NULL) {
universe@647 693 ll->begin = nright;
universe@647 694 } else {
universe@647 695 prev->next = nright;
universe@647 696 }
universe@647 697 nright->prev = prev;
universe@647 698 if (midstart == nright) {
universe@647 699 // special case: both nodes are adjacent
universe@647 700 nright->next = nleft;
universe@647 701 nleft->prev = nright;
universe@647 702 } else {
universe@647 703 // likely case: a chain is between the two nodes
universe@647 704 nright->next = midstart;
universe@647 705 midstart->prev = nright;
universe@647 706 midend->next = nleft;
universe@647 707 nleft->prev = midend;
universe@647 708 }
universe@647 709 nleft->next = next;
universe@647 710 if (next == NULL) {
universe@647 711 ll->end = nleft;
universe@647 712 } else {
universe@647 713 next->prev = nleft;
universe@647 714 }
universe@647 715 } else {
universe@647 716 // swap payloads to avoid relinking
universe@647 717 char buf[CX_LINKED_LIST_SWAP_SBO_SIZE];
universe@677 718 memcpy(buf, nleft->payload, list->item_size);
universe@677 719 memcpy(nleft->payload, nright->payload, list->item_size);
universe@677 720 memcpy(nright->payload, buf, list->item_size);
universe@647 721 }
universe@647 722
universe@647 723 return 0;
universe@647 724 }
universe@647 725
universe@481 726 static void *cx_ll_at(
universe@500 727 struct cx_list_s const *list,
universe@481 728 size_t index
universe@481 729 ) {
universe@439 730 cx_linked_list *ll = (cx_linked_list *) list;
universe@447 731 cx_linked_list_node *node = cx_ll_node_at(ll, index);
universe@466 732 return node == NULL ? NULL : node->payload;
universe@466 733 }
universe@466 734
universe@699 735 static ssize_t cx_ll_find(
universe@500 736 struct cx_list_s const *list,
universe@489 737 void const *elem
universe@481 738 ) {
universe@480 739 return cx_linked_list_find(((cx_linked_list *) list)->begin,
universe@480 740 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
universe@639 741 list->cmpfunc, elem);
universe@466 742 }
universe@466 743
universe@500 744 static void cx_ll_sort(struct cx_list_s *list) {
universe@469 745 cx_linked_list *ll = (cx_linked_list *) list;
universe@469 746 cx_linked_list_sort((void **) &ll->begin, (void **) &ll->end,
universe@469 747 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
universe@639 748 list->cmpfunc);
universe@469 749 }
universe@469 750
universe@500 751 static void cx_ll_reverse(struct cx_list_s *list) {
universe@490 752 cx_linked_list *ll = (cx_linked_list *) list;
universe@521 753 cx_linked_list_reverse((void **) &ll->begin, (void **) &ll->end, CX_LL_LOC_PREV, CX_LL_LOC_NEXT);
universe@490 754 }
universe@490 755
universe@488 756 static int cx_ll_compare(
universe@500 757 struct cx_list_s const *list,
universe@500 758 struct cx_list_s const *other
universe@488 759 ) {
universe@488 760 cx_linked_list *left = (cx_linked_list *) list;
universe@488 761 cx_linked_list *right = (cx_linked_list *) other;
universe@488 762 return cx_linked_list_compare(left->begin, right->begin,
universe@488 763 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
universe@639 764 list->cmpfunc);
universe@488 765 }
universe@488 766
universe@630 767 static bool cx_ll_iter_valid(void const *it) {
universe@630 768 struct cx_iterator_s const *iter = it;
universe@495 769 return iter->elem_handle != NULL;
universe@494 770 }
universe@494 771
universe@630 772 static void cx_ll_iter_next(void *it) {
universe@630 773 struct cx_iterator_base_s *itbase = it;
universe@630 774 if (itbase->remove) {
universe@630 775 itbase->remove = false;
universe@630 776 struct cx_mut_iterator_s *iter = it;
universe@664 777 struct cx_list_s *list = iter->src_handle;
universe@495 778 cx_linked_list *ll = iter->src_handle;
universe@495 779 cx_linked_list_node *node = iter->elem_handle;
universe@495 780 iter->elem_handle = node->next;
universe@677 781 cx_invoke_destructor(list, node->payload);
universe@495 782 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
universe@495 783 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
universe@664 784 list->size--;
universe@664 785 cxFree(list->allocator, node);
universe@495 786 } else {
universe@630 787 struct cx_iterator_s *iter = it;
universe@495 788 iter->index++;
universe@495 789 cx_linked_list_node *node = iter->elem_handle;
universe@495 790 iter->elem_handle = node->next;
universe@495 791 }
universe@494 792 }
universe@494 793
universe@655 794 static void cx_ll_iter_prev(void *it) {
universe@655 795 struct cx_iterator_base_s *itbase = it;
universe@655 796 if (itbase->remove) {
universe@655 797 itbase->remove = false;
universe@655 798 struct cx_mut_iterator_s *iter = it;
universe@664 799 struct cx_list_s *list = iter->src_handle;
universe@655 800 cx_linked_list *ll = iter->src_handle;
universe@655 801 cx_linked_list_node *node = iter->elem_handle;
universe@655 802 iter->elem_handle = node->prev;
universe@655 803 iter->index--;
universe@677 804 cx_invoke_destructor(list, node->payload);
universe@655 805 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
universe@655 806 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
universe@664 807 list->size--;
universe@664 808 cxFree(list->allocator, node);
universe@655 809 } else {
universe@655 810 struct cx_iterator_s *iter = it;
universe@655 811 iter->index--;
universe@655 812 cx_linked_list_node *node = iter->elem_handle;
universe@655 813 iter->elem_handle = node->prev;
universe@655 814 }
universe@655 815 }
universe@655 816
universe@630 817 static void *cx_ll_iter_current(void const *it) {
universe@630 818 struct cx_iterator_s const *iter = it;
universe@495 819 cx_linked_list_node *node = iter->elem_handle;
universe@494 820 return node->payload;
universe@494 821 }
universe@494 822
universe@630 823 static bool cx_ll_iter_flag_rm(void *it) {
universe@630 824 struct cx_iterator_base_s *iter = it;
universe@630 825 if (iter->mutating) {
universe@630 826 iter->remove = true;
universe@630 827 return true;
universe@630 828 } else {
universe@630 829 return false;
universe@630 830 }
universe@630 831 }
universe@630 832
universe@494 833 static CxIterator cx_ll_iterator(
universe@630 834 struct cx_list_s const *list,
universe@655 835 size_t index,
universe@655 836 bool backwards
universe@494 837 ) {
universe@494 838 CxIterator iter;
universe@494 839 iter.index = index;
universe@495 840 iter.src_handle = list;
universe@495 841 iter.elem_handle = cx_ll_node_at((cx_linked_list const *) list, index);
universe@630 842 iter.base.valid = cx_ll_iter_valid;
universe@630 843 iter.base.current = cx_ll_iter_current;
universe@655 844 iter.base.next = backwards ? cx_ll_iter_prev : cx_ll_iter_next;
universe@630 845 iter.base.flag_removal = cx_ll_iter_flag_rm;
universe@630 846 iter.base.mutating = false;
universe@630 847 iter.base.remove = false;
universe@494 848 return iter;
universe@494 849 }
universe@494 850
universe@499 851 static int cx_ll_insert_iter(
universe@630 852 CxMutIterator *iter,
universe@499 853 void const *elem,
universe@499 854 int prepend
universe@499 855 ) {
universe@500 856 struct cx_list_s *list = iter->src_handle;
universe@499 857 cx_linked_list_node *node = iter->elem_handle;
universe@499 858 if (node != NULL) {
universe@499 859 assert(prepend >= 0 && prepend <= 1);
universe@499 860 cx_linked_list_node *choice[2] = {node, node->prev};
universe@499 861 int result = cx_ll_insert_at(list, choice[prepend], elem);
universe@499 862 iter->index += prepend * (0 == result);
universe@499 863 return result;
universe@499 864 } else {
universe@641 865 int result = cx_ll_insert_element(list, list->size, elem);
universe@499 866 iter->index = list->size;
universe@499 867 return result;
universe@499 868 }
universe@499 869 }
universe@499 870
universe@524 871 static void cx_ll_destructor(CxList *list) {
universe@524 872 cx_linked_list *ll = (cx_linked_list *) list;
universe@524 873
universe@524 874 cx_linked_list_node *node = ll->begin;
universe@524 875 while (node) {
universe@524 876 void *next = node->next;
universe@524 877 cxFree(list->allocator, node);
universe@524 878 node = next;
universe@524 879 }
universe@524 880 // do not free the list pointer, this is just a destructor!
universe@524 881 }
universe@524 882
universe@451 883 static cx_list_class cx_linked_list_class = {
universe@524 884 cx_ll_destructor,
universe@641 885 cx_ll_insert_element,
universe@638 886 cx_ll_insert_array,
universe@499 887 cx_ll_insert_iter,
universe@398 888 cx_ll_remove,
universe@664 889 cx_ll_clear,
universe@647 890 cx_ll_swap,
universe@439 891 cx_ll_at,
universe@404 892 cx_ll_find,
universe@488 893 cx_ll_sort,
universe@490 894 cx_ll_compare,
universe@494 895 cx_ll_reverse,
universe@630 896 cx_ll_iterator,
universe@398 897 };
universe@398 898
universe@670 899 CxList *cxLinkedListCreate(
universe@508 900 CxAllocator const *allocator,
universe@677 901 cx_compare_func comparator,
universe@481 902 size_t item_size
universe@481 903 ) {
universe@670 904 if (allocator == NULL) {
universe@670 905 allocator = cxDefaultAllocator;
universe@670 906 }
universe@670 907
universe@503 908 cx_linked_list *list = cxCalloc(allocator, 1, sizeof(cx_linked_list));
universe@528 909 if (list == NULL) return NULL;
universe@398 910
universe@435 911 list->base.cl = &cx_linked_list_class;
universe@435 912 list->base.allocator = allocator;
universe@435 913 list->base.cmpfunc = comparator;
universe@406 914
universe@667 915 if (item_size > 0) {
universe@677 916 list->base.item_size = item_size;
universe@667 917 } else {
universe@667 918 cxListStorePointers((CxList *) list);
universe@667 919 }
universe@667 920
universe@500 921 return (CxList *) list;
universe@406 922 }

mercurial