src/linked_list.c@77021e06b1a8
src/linked_list.c
Tue, 07 Feb 2023 20:08:45 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Tue, 07 Feb 2023 20:08:45 +0100
- changeset 650
- 77021e06b1a8
- parent 641
- d402fead3386
- child 654
- c9d008861178
- permissions
- -rw-r--r--
fix code not compiling under windows+mingw
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
29 #include "cx/linked_list.h"
30 #include "cx/utils.h"
31 #include <string.h>
32 #include <assert.h>
34 // LOW LEVEL LINKED LIST FUNCTIONS
36 #define CX_LL_PTR(cur, off) (*(void**)(((char*)(cur))+(off)))
37 #define ll_prev(node) CX_LL_PTR(node, loc_prev)
38 #define ll_next(node) CX_LL_PTR(node, loc_next)
39 #define ll_advance(node) CX_LL_PTR(node, loc_advance)
40 #define ll_data(node) (((char*)(node))+loc_data)
42 void *cx_linked_list_at(
43 void const *start,
44 size_t start_index,
45 ptrdiff_t loc_advance,
46 size_t index
47 ) {
48 assert(start != NULL);
49 assert(loc_advance >= 0);
50 size_t i = start_index;
51 void const *cur = start;
52 while (i != index && cur != NULL) {
53 cur = ll_advance(cur);
54 i < index ? i++ : i--;
55 }
56 return (void *) cur;
57 }
59 size_t cx_linked_list_find(
60 void const *start,
61 ptrdiff_t loc_advance,
62 ptrdiff_t loc_data,
63 CxListComparator cmp_func,
64 void const *elem
65 ) {
66 assert(start != NULL);
67 assert(loc_advance >= 0);
68 assert(loc_data >= 0);
69 assert(cmp_func);
71 void const *node = start;
72 size_t index = 0;
73 do {
74 void *current = ll_data(node);
75 if (cmp_func(current, elem) == 0) {
76 return index;
77 }
78 node = ll_advance(node);
79 index++;
80 } while (node != NULL);
81 return index;
82 }
84 void *cx_linked_list_first(
85 void const *node,
86 ptrdiff_t loc_prev
87 ) {
88 return cx_linked_list_last(node, loc_prev);
89 }
91 void *cx_linked_list_last(
92 void const *node,
93 ptrdiff_t loc_next
94 ) {
95 assert(node != NULL);
96 assert(loc_next >= 0);
98 void const *cur = node;
99 void const *last;
100 do {
101 last = cur;
102 } while ((cur = ll_next(cur)) != NULL);
104 return (void *) last;
105 }
107 void *cx_linked_list_prev(
108 void const *begin,
109 ptrdiff_t loc_next,
110 void const *node
111 ) {
112 assert(begin != NULL);
113 assert(node != NULL);
114 assert(loc_next >= 0);
115 if (begin == node) return NULL;
116 void const *cur = begin;
117 void const *next;
118 while (1) {
119 next = ll_next(cur);
120 if (next == node) return (void *) cur;
121 cur = next;
122 }
123 }
125 void cx_linked_list_link(
126 void *left,
127 void *right,
128 ptrdiff_t loc_prev,
129 ptrdiff_t loc_next
130 ) {
131 assert(loc_next >= 0);
132 ll_next(left) = right;
133 if (loc_prev >= 0) {
134 ll_prev(right) = left;
135 }
136 }
138 void cx_linked_list_unlink(
139 void *left,
140 void *right,
141 ptrdiff_t loc_prev,
142 ptrdiff_t loc_next
143 ) {
144 assert (loc_next >= 0);
145 assert(ll_next(left) == right);
146 ll_next(left) = NULL;
147 if (loc_prev >= 0) {
148 assert(ll_prev(right) == left);
149 ll_prev(right) = NULL;
150 }
151 }
153 void cx_linked_list_add(
154 void **begin,
155 void **end,
156 ptrdiff_t loc_prev,
157 ptrdiff_t loc_next,
158 void *new_node
159 ) {
160 void *last;
161 if (end == NULL) {
162 assert(begin != NULL);
163 last = *begin == NULL ? NULL : cx_linked_list_last(*begin, loc_next);
164 } else {
165 last = *end;
166 }
167 cx_linked_list_insert_chain(begin, end, loc_prev, loc_next, last, new_node, new_node);
168 }
170 void cx_linked_list_prepend(
171 void **begin,
172 void **end,
173 ptrdiff_t loc_prev,
174 ptrdiff_t loc_next,
175 void *new_node
176 ) {
177 cx_linked_list_insert_chain(begin, end, loc_prev, loc_next, NULL, new_node, new_node);
178 }
180 void cx_linked_list_insert(
181 void **begin,
182 void **end,
183 ptrdiff_t loc_prev,
184 ptrdiff_t loc_next,
185 void *node,
186 void *new_node
187 ) {
188 cx_linked_list_insert_chain(begin, end, loc_prev, loc_next, node, new_node, new_node);
189 }
191 void cx_linked_list_insert_chain(
192 void **begin,
193 void **end,
194 ptrdiff_t loc_prev,
195 ptrdiff_t loc_next,
196 void *node,
197 void *insert_begin,
198 void *insert_end
199 ) {
200 // find the end of the chain, if not specified
201 if (insert_end == NULL) {
202 insert_end = cx_linked_list_last(insert_begin, loc_next);
203 }
205 // determine the successor
206 void *successor;
207 if (node == NULL) {
208 assert(begin != NULL || (end != NULL && loc_prev >= 0));
209 if (begin != NULL) {
210 successor = *begin;
211 *begin = insert_begin;
212 } else {
213 successor = *end == NULL ? NULL : cx_linked_list_first(*end, loc_prev);
214 }
215 } else {
216 successor = ll_next(node);
217 cx_linked_list_link(node, insert_begin, loc_prev, loc_next);
218 }
220 if (successor == NULL) {
221 // the list ends with the new chain
222 if (end != NULL) {
223 *end = insert_end;
224 }
225 } else {
226 cx_linked_list_link(insert_end, successor, loc_prev, loc_next);
227 }
228 }
230 void cx_linked_list_remove(
231 void **begin,
232 void **end,
233 ptrdiff_t loc_prev,
234 ptrdiff_t loc_next,
235 void *node
236 ) {
237 assert(node != NULL);
238 assert(loc_next >= 0);
239 assert(loc_prev >= 0 || begin != NULL);
241 // find adjacent nodes
242 void *next = ll_next(node);
243 void *prev;
244 if (loc_prev >= 0) {
245 prev = ll_prev(node);
246 } else {
247 prev = cx_linked_list_prev(*begin, loc_next, node);
248 }
250 // update next pointer of prev node, or set begin
251 if (prev == NULL) {
252 if (begin != NULL) {
253 *begin = next;
254 }
255 } else {
256 ll_next(prev) = next;
257 }
259 // update prev pointer of next node, or set end
260 if (next == NULL) {
261 if (end != NULL) {
262 *end = prev;
263 }
264 } else if (loc_prev >= 0) {
265 ll_prev(next) = prev;
266 }
267 }
269 size_t cx_linked_list_size(
270 void const *node,
271 ptrdiff_t loc_next
272 ) {
273 assert(loc_next >= 0);
274 size_t size = 0;
275 while (node != NULL) {
276 node = ll_next(node);
277 size++;
278 }
279 return size;
280 }
282 static void *cx_linked_list_sort_merge(
283 ptrdiff_t loc_prev,
284 ptrdiff_t loc_next,
285 ptrdiff_t loc_data,
286 size_t length,
287 void *ls,
288 void *le,
289 void *re,
290 CxListComparator cmp_func
291 ) {
292 const size_t sbo_len = 1024;
293 void *sbo[sbo_len];
294 void **sorted = (length >= sbo_len) ? malloc(sizeof(void *) * length) : sbo;
295 if (sorted == NULL) abort();
296 void *rc, *lc;
298 lc = ls;
299 rc = le;
300 size_t n = 0;
301 while (lc && lc != le && rc != re) {
302 if (cmp_func(ll_data(lc), ll_data(rc)) <= 0) {
303 sorted[n] = lc;
304 lc = ll_next(lc);
305 } else {
306 sorted[n] = rc;
307 rc = ll_next(rc);
308 }
309 n++;
310 }
311 while (lc && lc != le) {
312 sorted[n] = lc;
313 lc = ll_next(lc);
314 n++;
315 }
316 while (rc && rc != re) {
317 sorted[n] = rc;
318 rc = ll_next(rc);
319 n++;
320 }
322 // Update pointer
323 if (loc_prev >= 0) ll_prev(sorted[0]) = NULL;
324 cx_for_n (i, length - 1) {
325 cx_linked_list_link(sorted[i], sorted[i + 1], loc_prev, loc_next);
326 }
327 ll_next(sorted[length - 1]) = NULL;
329 void *ret = sorted[0];
330 if (sorted != sbo) {
331 free(sorted);
332 }
333 return ret;
334 }
336 void cx_linked_list_sort( // NOLINT(misc-no-recursion) - purposely recursive function
337 void **begin,
338 void **end,
339 ptrdiff_t loc_prev,
340 ptrdiff_t loc_next,
341 ptrdiff_t loc_data,
342 CxListComparator cmp_func
343 ) {
344 assert(begin != NULL);
345 assert(loc_next >= 0);
346 assert(loc_data >= 0);
347 assert(cmp_func);
349 void *lc, *ls, *le, *re;
351 // set start node
352 ls = *begin;
354 // check how many elements are already sorted
355 lc = ls;
356 size_t ln = 1;
357 while (ll_next(lc) != NULL && cmp_func(ll_data(ll_next(lc)), ll_data(lc)) > 0) {
358 lc = ll_next(lc);
359 ln++;
360 }
361 le = ll_next(lc);
363 // if first unsorted node is NULL, the list is already completely sorted
364 if (le != NULL) {
365 void *rc;
366 size_t rn = 1;
367 rc = le;
368 // skip already sorted elements
369 while (ll_next(rc) != NULL && cmp_func(ll_data(ll_next(rc)), ll_data(rc)) > 0) {
370 rc = ll_next(rc);
371 rn++;
372 }
373 re = ll_next(rc);
375 // {ls,...,le->prev} and {rs,...,re->prev} are sorted - merge them
376 void *sorted = cx_linked_list_sort_merge(loc_prev, loc_next, loc_data,
377 ln + rn, ls, le, re, cmp_func);
379 // Something left? Sort it!
380 size_t remainder_length = cx_linked_list_size(re, loc_next);
381 if (remainder_length > 0) {
382 void *remainder = re;
383 cx_linked_list_sort(&remainder, NULL, loc_prev, loc_next, loc_data, cmp_func);
385 // merge sorted list with (also sorted) remainder
386 *begin = cx_linked_list_sort_merge(loc_prev, loc_next, loc_data,
387 ln + rn + remainder_length,
388 sorted, remainder, NULL, cmp_func);
389 } else {
390 // no remainder - we've got our sorted list
391 *begin = sorted;
392 }
393 if (end) *end = cx_linked_list_last(sorted, loc_next);
394 }
395 }
397 int cx_linked_list_compare(
398 void const *begin_left,
399 void const *begin_right,
400 ptrdiff_t loc_advance,
401 ptrdiff_t loc_data,
402 CxListComparator cmp_func
403 ) {
404 void const *left = begin_left, *right = begin_right;
406 while (left != NULL && right != NULL) {
407 void const *left_data = ll_data(left);
408 void const *right_data = ll_data(right);
409 int result = cmp_func(left_data, right_data);
410 if (result != 0) return result;
411 left = ll_advance(left);
412 right = ll_advance(right);
413 }
415 if (left != NULL) { return 1; }
416 else if (right != NULL) { return -1; }
417 else { return 0; }
418 }
420 void cx_linked_list_reverse(
421 void **begin,
422 void **end,
423 ptrdiff_t loc_prev,
424 ptrdiff_t loc_next
425 ) {
426 assert(begin != NULL);
427 assert(loc_next >= 0);
429 // swap all links
430 void *prev = NULL;
431 void *cur = *begin;
432 while (cur != NULL) {
433 void *next = ll_next(cur);
435 ll_next(cur) = prev;
436 if (loc_prev >= 0) {
437 ll_prev(cur) = next;
438 }
440 prev = cur;
441 cur = next;
442 }
444 // update begin and end
445 if (end != NULL) {
446 *end = *begin;
447 }
448 *begin = prev;
449 }
451 // HIGH LEVEL LINKED LIST IMPLEMENTATION
453 typedef struct cx_linked_list_node cx_linked_list_node;
454 struct cx_linked_list_node {
455 cx_linked_list_node *prev;
456 cx_linked_list_node *next;
457 char payload[];
458 };
460 #define CX_LL_LOC_PREV offsetof(cx_linked_list_node, prev)
461 #define CX_LL_LOC_NEXT offsetof(cx_linked_list_node, next)
462 #define CX_LL_LOC_DATA offsetof(cx_linked_list_node, payload)
464 typedef struct {
465 struct cx_list_s base;
466 cx_linked_list_node *begin;
467 cx_linked_list_node *end;
468 } cx_linked_list;
470 static cx_linked_list_node *cx_ll_node_at(
471 cx_linked_list const *list,
472 size_t index
473 ) {
474 if (index >= list->base.size) {
475 return NULL;
476 } else if (index > list->base.size / 2) {
477 return cx_linked_list_at(list->end, list->base.size - 1, CX_LL_LOC_PREV, index);
478 } else {
479 return cx_linked_list_at(list->begin, 0, CX_LL_LOC_NEXT, index);
480 }
481 }
483 static int cx_ll_insert_at(
484 struct cx_list_s *list,
485 cx_linked_list_node *node,
486 void const *elem
487 ) {
489 // create the new new_node
490 cx_linked_list_node *new_node = cxMalloc(list->allocator,
491 sizeof(cx_linked_list_node) + list->itemsize);
493 // sortir if failed
494 if (new_node == NULL) return 1;
496 // initialize new new_node
497 new_node->prev = new_node->next = NULL;
498 memcpy(new_node->payload, elem, list->itemsize);
500 // insert
501 cx_linked_list *ll = (cx_linked_list *) list;
502 cx_linked_list_insert_chain(
503 (void **) &ll->begin, (void **) &ll->end,
504 CX_LL_LOC_PREV, CX_LL_LOC_NEXT,
505 node, new_node, new_node
506 );
508 // increase the size and return
509 list->size++;
510 return 0;
511 }
513 static size_t cx_ll_insert_array(
514 struct cx_list_s *list,
515 size_t index,
516 void const *array,
517 size_t n
518 ) {
519 // out-of bounds and corner case check
520 if (index > list->size || n == 0) return 0;
522 // find position efficiently
523 cx_linked_list_node *node = index == 0 ? NULL : cx_ll_node_at((cx_linked_list *) list, index - 1);
525 // perform first insert
526 if (0 != cx_ll_insert_at(list, node, array)) {
527 return 1;
528 }
530 // is there more?
531 if (n == 1) return 1;
533 // we now know exactly where we are
534 node = node == NULL ? ((cx_linked_list *) list)->begin : node->next;
536 // we can add the remaining nodes and immedately advance to the inserted node
537 char const *source = array;
538 for (size_t i = 1; i < n; i++) {
539 source += list->itemsize;
540 if (0 != cx_ll_insert_at(list, node, source)) {
541 return i;
542 }
543 node = node->next;
544 }
545 return n;
546 }
548 static int cx_ll_insert_element(
549 struct cx_list_s *list,
550 size_t index,
551 void const *element
552 ) {
553 return 1 != cx_ll_insert_array(list, index, element, 1);
554 }
556 static int cx_ll_remove(
557 struct cx_list_s *list,
558 size_t index
559 ) {
560 cx_linked_list *ll = (cx_linked_list *) list;
561 cx_linked_list_node *node = cx_ll_node_at(ll, index);
563 // out-of-bounds check
564 if (node == NULL) return 1;
566 // remove
567 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
568 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
570 // adjust size
571 list->size--;
573 // free and return
574 cxFree(list->allocator, node);
576 return 0;
577 }
579 static void *cx_ll_at(
580 struct cx_list_s const *list,
581 size_t index
582 ) {
583 cx_linked_list *ll = (cx_linked_list *) list;
584 cx_linked_list_node *node = cx_ll_node_at(ll, index);
585 return node == NULL ? NULL : node->payload;
586 }
588 static size_t cx_ll_find(
589 struct cx_list_s const *list,
590 void const *elem
591 ) {
592 return cx_linked_list_find(((cx_linked_list *) list)->begin,
593 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
594 list->cmpfunc, elem);
595 }
597 static void cx_ll_sort(struct cx_list_s *list) {
598 cx_linked_list *ll = (cx_linked_list *) list;
599 cx_linked_list_sort((void **) &ll->begin, (void **) &ll->end,
600 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
601 list->cmpfunc);
602 }
604 static void cx_ll_reverse(struct cx_list_s *list) {
605 cx_linked_list *ll = (cx_linked_list *) list;
606 cx_linked_list_reverse((void **) &ll->begin, (void **) &ll->end, CX_LL_LOC_PREV, CX_LL_LOC_NEXT);
607 }
609 static int cx_ll_compare(
610 struct cx_list_s const *list,
611 struct cx_list_s const *other
612 ) {
613 cx_linked_list *left = (cx_linked_list *) list;
614 cx_linked_list *right = (cx_linked_list *) other;
615 return cx_linked_list_compare(left->begin, right->begin,
616 CX_LL_LOC_NEXT, CX_LL_LOC_DATA,
617 list->cmpfunc);
618 }
620 static bool cx_ll_iter_valid(void const *it) {
621 struct cx_iterator_s const *iter = it;
622 return iter->elem_handle != NULL;
623 }
625 static void cx_ll_iter_next(void *it) {
626 struct cx_iterator_base_s *itbase = it;
627 if (itbase->remove) {
628 itbase->remove = false;
629 struct cx_mut_iterator_s *iter = it;
630 cx_linked_list *ll = iter->src_handle;
631 cx_linked_list_node *node = iter->elem_handle;
632 iter->elem_handle = node->next;
633 cx_linked_list_remove((void **) &ll->begin, (void **) &ll->end,
634 CX_LL_LOC_PREV, CX_LL_LOC_NEXT, node);
635 ll->base.size--;
636 cxFree(ll->base.allocator, node);
637 } else {
638 struct cx_iterator_s *iter = it;
639 iter->index++;
640 cx_linked_list_node *node = iter->elem_handle;
641 iter->elem_handle = node->next;
642 }
643 }
645 static void *cx_ll_iter_current(void const *it) {
646 struct cx_iterator_s const *iter = it;
647 cx_linked_list_node *node = iter->elem_handle;
648 return node->payload;
649 }
651 static bool cx_ll_iter_flag_rm(void *it) {
652 struct cx_iterator_base_s *iter = it;
653 if (iter->mutating) {
654 iter->remove = true;
655 return true;
656 } else {
657 return false;
658 }
659 }
661 static CxIterator cx_ll_iterator(
662 struct cx_list_s const *list,
663 size_t index
664 ) {
665 CxIterator iter;
666 iter.index = index;
667 iter.src_handle = list;
668 iter.elem_handle = cx_ll_node_at((cx_linked_list const *) list, index);
669 iter.base.valid = cx_ll_iter_valid;
670 iter.base.current = cx_ll_iter_current;
671 iter.base.next = cx_ll_iter_next;
672 iter.base.flag_removal = cx_ll_iter_flag_rm;
673 iter.base.mutating = false;
674 iter.base.remove = false;
675 return iter;
676 }
678 static int cx_ll_insert_iter(
679 CxMutIterator *iter,
680 void const *elem,
681 int prepend
682 ) {
683 struct cx_list_s *list = iter->src_handle;
684 cx_linked_list_node *node = iter->elem_handle;
685 if (node != NULL) {
686 assert(prepend >= 0 && prepend <= 1);
687 cx_linked_list_node *choice[2] = {node, node->prev};
688 int result = cx_ll_insert_at(list, choice[prepend], elem);
689 iter->index += prepend * (0 == result);
690 return result;
691 } else {
692 int result = cx_ll_insert_element(list, list->size, elem);
693 iter->index = list->size;
694 return result;
695 }
696 }
698 static void cx_ll_destructor(CxList *list) {
699 cx_linked_list *ll = (cx_linked_list *) list;
701 cx_linked_list_node *node = ll->begin;
702 while (node) {
703 void *next = node->next;
704 cxFree(list->allocator, node);
705 node = next;
706 }
707 // do not free the list pointer, this is just a destructor!
708 }
710 static cx_list_class cx_linked_list_class = {
711 cx_ll_destructor,
712 cx_ll_insert_element,
713 cx_ll_insert_array,
714 cx_ll_insert_iter,
715 cx_ll_remove,
716 cx_ll_at,
717 cx_ll_find,
718 cx_ll_sort,
719 cx_ll_compare,
720 cx_ll_reverse,
721 cx_ll_iterator,
722 };
724 CxList *cxLinkedListCreate(
725 CxAllocator const *allocator,
726 CxListComparator comparator,
727 size_t item_size
728 ) {
729 cx_linked_list *list = cxCalloc(allocator, 1, sizeof(cx_linked_list));
730 if (list == NULL) return NULL;
732 list->base.cl = &cx_linked_list_class;
733 list->base.allocator = allocator;
734 list->base.cmpfunc = comparator;
735 list->base.itemsize = item_size;
736 list->base.capacity = SIZE_MAX;
738 return (CxList *) list;
739 }
