src/linked_list.c

Wed, 08 Feb 2023 20:26:09 +0100

author
Mike Becker <universe@uap-core.de>
date
Wed, 08 Feb 2023 20:26:09 +0100
changeset 647
2e6e9d9f2159
parent 641
d402fead3386
child 654
c9d008861178
permissions
-rw-r--r--

implement swap function for list elements - fixes #218

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

mercurial