src/linked_list.c

Mon, 18 Dec 2023 16:14:07 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 18 Dec 2023 16:14:07 +0100
changeset 763
741a2040fa33
parent 735
b686d0c98c62
child 764
ccbdbd088455
permissions
-rw-r--r--

make cx_cmp_ptr default comparator for pointer lists - relates to #340

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

mercurial