Sat, 26 Nov 2022 16:58:41 +0100
separate iterators and mutating iterators
Trade tons of code duplication for const-correctness.
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/array_list.h"
31 #include "cx/utils.h"
32 #include "cx/compare.h"
33 #include "util_allocator.h"
35 #include <gtest/gtest.h>
36 #include <array>
37 #include <vector>
38 #include <unordered_set>
39 #include <algorithm>
41 struct node {
42 node *next = nullptr;
43 node *prev = nullptr;
44 int data = 0;
45 };
47 const ptrdiff_t loc_prev = offsetof(struct node, prev);
48 const ptrdiff_t loc_next = offsetof(struct node, next);
49 const ptrdiff_t loc_data = offsetof(struct node, data);
51 struct node_test_data {
52 node *begin = nullptr;
54 explicit node_test_data(node *begin) : begin(begin) {
55 auto n = begin;
56 while (n != nullptr) {
57 nodes.push_back(n);
58 n = n->next;
59 }
60 }
62 node_test_data(node_test_data &) = delete;
64 node_test_data(node_test_data &&) = default;
66 ~node_test_data() {
67 for (auto &&n: nodes) delete n;
68 }
70 private:
71 std::vector<node *> nodes;
72 };
74 static node_test_data create_nodes_test_data(size_t len) {
75 if (len == 0) return node_test_data{nullptr};
76 auto begin = new node;
77 auto prev = begin;
78 for (size_t i = 1; i < len; i++) {
79 auto n = new node;
80 cx_linked_list_link(prev, n, loc_prev, loc_next);
81 prev = n;
82 }
83 return node_test_data{begin};
84 }
86 template<typename InputIter>
87 static node_test_data create_nodes_test_data(
88 InputIter begin,
89 InputIter end
90 ) {
91 if (begin == end) return node_test_data{nullptr};
92 node *first = new node;
93 first->data = *begin;
94 node *prev = first;
95 begin++;
96 for (; begin != end; begin++) {
97 auto n = new node;
98 n->data = *begin;
99 cx_linked_list_link(prev, n, loc_prev, loc_next);
100 prev = n;
101 }
102 return node_test_data{first};
103 }
105 static node_test_data create_nodes_test_data(std::initializer_list<int> data) {
106 return create_nodes_test_data(data.begin(), data.end());
107 }
109 template<size_t N>
110 struct int_test_data {
111 std::array<int, N> data;
113 int_test_data() {
114 cx_for_n (i, N) data[i] = ::rand(); // NOLINT(cert-msc50-cpp)
115 }
116 };
118 TEST(LinkedList_LowLevel, link_unlink) {
119 node a, b, c;
121 cx_linked_list_link(&a, &b, loc_prev, loc_next);
122 EXPECT_EQ(a.prev, nullptr);
123 EXPECT_EQ(a.next, &b);
124 EXPECT_EQ(b.prev, &a);
125 EXPECT_EQ(b.next, nullptr);
127 cx_linked_list_unlink(&a, &b, loc_prev, loc_next);
128 EXPECT_EQ(a.prev, nullptr);
129 EXPECT_EQ(a.next, nullptr);
130 EXPECT_EQ(b.prev, nullptr);
131 EXPECT_EQ(b.next, nullptr);
133 cx_linked_list_link(&b, &c, loc_prev, loc_next);
134 cx_linked_list_link(&a, &b, loc_prev, loc_next);
135 cx_linked_list_unlink(&b, &c, loc_prev, loc_next);
136 EXPECT_EQ(a.prev, nullptr);
137 EXPECT_EQ(a.next, &b);
138 EXPECT_EQ(b.prev, &a);
139 EXPECT_EQ(b.next, nullptr);
140 EXPECT_EQ(c.prev, nullptr);
141 EXPECT_EQ(c.next, nullptr);
142 }
144 TEST(LinkedList_LowLevel, cx_linked_list_at) {
145 node a, b, c, d;
146 cx_linked_list_link(&a, &b, loc_prev, loc_next);
147 cx_linked_list_link(&b, &c, loc_prev, loc_next);
148 cx_linked_list_link(&c, &d, loc_prev, loc_next);
150 EXPECT_EQ(cx_linked_list_at(&a, 0, loc_next, 0), &a);
151 EXPECT_EQ(cx_linked_list_at(&a, 0, loc_next, 1), &b);
152 EXPECT_EQ(cx_linked_list_at(&a, 0, loc_next, 2), &c);
153 EXPECT_EQ(cx_linked_list_at(&a, 0, loc_next, 3), &d);
154 EXPECT_EQ(cx_linked_list_at(&a, 0, loc_next, 4), nullptr);
156 EXPECT_EQ(cx_linked_list_at(&b, 1, loc_prev, 0), &a);
157 EXPECT_EQ(cx_linked_list_at(&b, 1, loc_next, 1), &b);
158 EXPECT_EQ(cx_linked_list_at(&b, 1, loc_next, 2), &c);
159 EXPECT_EQ(cx_linked_list_at(&b, 1, loc_next, 3), &d);
160 EXPECT_EQ(cx_linked_list_at(&b, 1, loc_next, 4), nullptr);
162 EXPECT_EQ(cx_linked_list_at(&d, 3, loc_prev, 0), &a);
163 EXPECT_EQ(cx_linked_list_at(&d, 3, loc_prev, 1), &b);
164 }
166 TEST(LinkedList_LowLevel, cx_linked_list_find) {
167 auto testdata = create_nodes_test_data({2, 4, 6, 8});
168 auto list = testdata.begin;
169 int s;
171 s = 2;
172 EXPECT_EQ(cx_linked_list_find(list, loc_next, loc_data, false, cx_cmp_int, &s), 0);
173 s = 4;
174 EXPECT_EQ(cx_linked_list_find(list, loc_next, loc_data, false, cx_cmp_int, &s), 1);
175 s = 6;
176 EXPECT_EQ(cx_linked_list_find(list, loc_next, loc_data, false, cx_cmp_int, &s), 2);
177 s = 8;
178 EXPECT_EQ(cx_linked_list_find(list, loc_next, loc_data, false, cx_cmp_int, &s), 3);
179 s = 10;
180 EXPECT_EQ(cx_linked_list_find(list, loc_next, loc_data, false, cx_cmp_int, &s), 4);
181 s = -2;
182 EXPECT_EQ(cx_linked_list_find(list, loc_next, loc_data, false, cx_cmp_int, &s), 4);
183 }
185 TEST(LinkedList_LowLevel, cx_linked_list_compare) {
186 auto ta = create_nodes_test_data({2, 4, 6, 8});
187 auto tb = create_nodes_test_data({2, 4, 6});
188 auto tc = create_nodes_test_data({2, 4, 6, 9});
189 auto la = ta.begin, lb = tb.begin, lc = tc.begin;
191 EXPECT_GT(cx_linked_list_compare(la, lb, loc_next, loc_data, false, false, cx_cmp_int), 0);
192 EXPECT_LT(cx_linked_list_compare(lb, la, loc_next, loc_data, false, false, cx_cmp_int), 0);
193 EXPECT_GT(cx_linked_list_compare(lc, la, loc_next, loc_data, false, false, cx_cmp_int), 0);
194 EXPECT_LT(cx_linked_list_compare(la, lc, loc_next, loc_data, false, false, cx_cmp_int), 0);
195 EXPECT_EQ(cx_linked_list_compare(la, la, loc_next, loc_data, false, false, cx_cmp_int), 0);
196 }
198 TEST(LinkedList_LowLevel, cx_linked_list_add) {
199 // test with begin, end / prev, next
200 {
201 node nodes[4];
202 void *begin = nullptr, *end = nullptr;
204 cx_linked_list_add(&begin, &end, loc_prev, loc_next, &nodes[0]);
205 EXPECT_EQ(begin, &nodes[0]);
206 EXPECT_EQ(end, &nodes[0]);
207 EXPECT_EQ(nodes[0].prev, nullptr);
208 EXPECT_EQ(nodes[0].next, nullptr);
210 cx_linked_list_add(&begin, &end, loc_prev, loc_next, &nodes[1]);
211 EXPECT_EQ(begin, &nodes[0]);
212 EXPECT_EQ(end, &nodes[1]);
213 EXPECT_EQ(nodes[0].next, &nodes[1]);
214 EXPECT_EQ(nodes[1].prev, &nodes[0]);
215 }
217 // test with begin only / prev, next
218 {
219 node nodes[4];
220 void *begin = nullptr;
222 cx_linked_list_add(&begin, nullptr, loc_prev, loc_next, &nodes[0]);
223 EXPECT_EQ(begin, &nodes[0]);
224 cx_linked_list_add(&begin, nullptr, loc_prev, loc_next, &nodes[1]);
225 EXPECT_EQ(begin, &nodes[0]);
226 EXPECT_EQ(nodes[0].next, &nodes[1]);
227 EXPECT_EQ(nodes[1].prev, &nodes[0]);
229 cx_linked_list_add(&begin, nullptr, loc_prev, loc_next, &nodes[2]);
230 EXPECT_EQ(nodes[1].next, &nodes[2]);
231 EXPECT_EQ(nodes[2].prev, &nodes[1]);
232 }
234 // test with end only / prev, next
235 {
236 node nodes[4];
237 void *end = nullptr;
239 cx_linked_list_add(nullptr, &end, loc_prev, loc_next, &nodes[0]);
240 EXPECT_EQ(end, &nodes[0]);
241 cx_linked_list_add(nullptr, &end, loc_prev, loc_next, &nodes[1]);
242 EXPECT_EQ(end, &nodes[1]);
243 EXPECT_EQ(nodes[0].next, &nodes[1]);
244 EXPECT_EQ(nodes[1].prev, &nodes[0]);
246 cx_linked_list_add(nullptr, &end, loc_prev, loc_next, &nodes[2]);
247 EXPECT_EQ(end, &nodes[2]);
248 EXPECT_EQ(nodes[1].next, &nodes[2]);
249 EXPECT_EQ(nodes[2].prev, &nodes[1]);
250 }
252 // test with begin, end / next
253 {
254 node nodes[4];
255 void *begin = nullptr, *end = nullptr;
257 cx_linked_list_add(&begin, &end, -1, loc_next, &nodes[0]);
258 EXPECT_EQ(begin, &nodes[0]);
259 EXPECT_EQ(end, &nodes[0]);
260 cx_linked_list_add(&begin, &end, -1, loc_next, &nodes[1]);
261 EXPECT_EQ(end, &nodes[1]);
262 EXPECT_EQ(nodes[0].next, &nodes[1]);
263 EXPECT_EQ(nodes[1].prev, nullptr);
264 }
265 }
267 TEST(LinkedList_LowLevel, cx_linked_list_prepend) {
268 // test with begin, end / prev, next
269 {
270 node nodes[4];
271 void *begin = nullptr, *end = nullptr;
273 cx_linked_list_prepend(&begin, &end, loc_prev, loc_next, &nodes[0]);
274 EXPECT_EQ(begin, &nodes[0]);
275 EXPECT_EQ(end, &nodes[0]);
276 EXPECT_EQ(nodes[0].prev, nullptr);
277 EXPECT_EQ(nodes[0].next, nullptr);
279 cx_linked_list_prepend(&begin, &end, loc_prev, loc_next, &nodes[1]);
280 EXPECT_EQ(begin, &nodes[1]);
281 EXPECT_EQ(end, &nodes[0]);
282 EXPECT_EQ(nodes[1].next, &nodes[0]);
283 EXPECT_EQ(nodes[0].prev, &nodes[1]);
284 }
286 // test with begin only / prev, next
287 {
288 node nodes[4];
289 void *begin = nullptr;
291 cx_linked_list_prepend(&begin, nullptr, loc_prev, loc_next, &nodes[0]);
292 EXPECT_EQ(begin, &nodes[0]);
293 cx_linked_list_prepend(&begin, nullptr, loc_prev, loc_next, &nodes[1]);
294 EXPECT_EQ(begin, &nodes[1]);
295 EXPECT_EQ(nodes[1].next, &nodes[0]);
296 EXPECT_EQ(nodes[0].prev, &nodes[1]);
298 cx_linked_list_prepend(&begin, nullptr, loc_prev, loc_next, &nodes[2]);
299 EXPECT_EQ(begin, &nodes[2]);
300 EXPECT_EQ(nodes[2].next, &nodes[1]);
301 EXPECT_EQ(nodes[1].prev, &nodes[2]);
302 }
304 // test with end only / prev, next
305 {
306 node nodes[4];
307 void *end = nullptr;
309 cx_linked_list_prepend(nullptr, &end, loc_prev, loc_next, &nodes[0]);
310 EXPECT_EQ(end, &nodes[0]);
311 cx_linked_list_prepend(nullptr, &end, loc_prev, loc_next, &nodes[1]);
312 EXPECT_EQ(end, &nodes[0]);
313 EXPECT_EQ(nodes[1].next, &nodes[0]);
314 EXPECT_EQ(nodes[0].prev, &nodes[1]);
316 cx_linked_list_prepend(nullptr, &end, loc_prev, loc_next, &nodes[2]);
317 EXPECT_EQ(end, &nodes[0]);
318 EXPECT_EQ(nodes[2].next, &nodes[1]);
319 EXPECT_EQ(nodes[1].prev, &nodes[2]);
320 }
322 // test with begin, end / next
323 {
324 node nodes[4];
325 void *begin = nullptr, *end = nullptr;
327 cx_linked_list_prepend(&begin, &end, -1, loc_next, &nodes[0]);
328 EXPECT_EQ(begin, &nodes[0]);
329 EXPECT_EQ(end, &nodes[0]);
330 cx_linked_list_prepend(&begin, &end, -1, loc_next, &nodes[1]);
331 cx_linked_list_prepend(&begin, &end, -1, loc_next, &nodes[2]);
332 EXPECT_EQ(begin, &nodes[2]);
333 EXPECT_EQ(end, &nodes[0]);
334 EXPECT_EQ(nodes[1].next, &nodes[0]);
335 EXPECT_EQ(nodes[2].next, &nodes[1]);
336 EXPECT_EQ(nodes[1].prev, nullptr);
337 EXPECT_EQ(nodes[0].prev, nullptr);
338 }
339 }
341 TEST(LinkedList_LowLevel, cx_linked_list_insert) {
342 // insert mid list
343 {
344 node nodes[4];
345 void *begin = &nodes[0], *end = &nodes[2];
347 cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
348 cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
350 cx_linked_list_insert(&begin, &end, loc_prev, loc_next, &nodes[1], &nodes[3]);
351 EXPECT_EQ(begin, &nodes[0]);
352 EXPECT_EQ(end, &nodes[2]);
353 EXPECT_EQ(nodes[1].next, &nodes[3]);
354 EXPECT_EQ(nodes[2].prev, &nodes[3]);
355 EXPECT_EQ(nodes[3].prev, &nodes[1]);
356 EXPECT_EQ(nodes[3].next, &nodes[2]);
357 }
359 // insert end
360 {
361 node nodes[4];
362 void *begin = &nodes[0], *end = &nodes[2];
364 cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
365 cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
367 cx_linked_list_insert(&begin, &end, loc_prev, loc_next, &nodes[2], &nodes[3]);
368 EXPECT_EQ(begin, &nodes[0]);
369 EXPECT_EQ(end, &nodes[3]);
370 EXPECT_EQ(nodes[2].next, &nodes[3]);
371 EXPECT_EQ(nodes[3].prev, &nodes[2]);
372 EXPECT_EQ(nodes[3].next, nullptr);
373 }
375 // insert begin
376 {
377 node nodes[4];
378 void *begin = &nodes[0], *end = &nodes[2];
380 cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
381 cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
383 cx_linked_list_insert(&begin, &end, loc_prev, loc_next, nullptr, &nodes[3]);
384 EXPECT_EQ(begin, &nodes[3]);
385 EXPECT_EQ(end, &nodes[2]);
386 EXPECT_EQ(nodes[0].prev, &nodes[3]);
387 EXPECT_EQ(nodes[3].prev, nullptr);
388 EXPECT_EQ(nodes[3].next, &nodes[0]);
389 }
390 }
392 TEST(LinkedList_LowLevel, cx_linked_list_insert_chain) {
393 // insert mid list
394 {
395 node nodes[5];
396 void *begin = &nodes[0], *end = &nodes[2];
398 cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
399 cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
400 cx_linked_list_link(&nodes[3], &nodes[4], loc_prev, loc_next);
402 cx_linked_list_insert_chain(&begin, &end, loc_prev, loc_next, &nodes[1], &nodes[3], nullptr);
403 EXPECT_EQ(begin, &nodes[0]);
404 EXPECT_EQ(end, &nodes[2]);
405 EXPECT_EQ(nodes[1].next, &nodes[3]);
406 EXPECT_EQ(nodes[2].prev, &nodes[4]);
407 EXPECT_EQ(nodes[3].prev, &nodes[1]);
408 EXPECT_EQ(nodes[4].next, &nodes[2]);
409 }
411 // insert end
412 {
413 node nodes[5];
414 void *begin = &nodes[0], *end = &nodes[2];
416 cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
417 cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
418 cx_linked_list_link(&nodes[3], &nodes[4], loc_prev, loc_next);
420 cx_linked_list_insert_chain(&begin, &end, loc_prev, loc_next, &nodes[2], &nodes[3], nullptr);
421 EXPECT_EQ(begin, &nodes[0]);
422 EXPECT_EQ(end, &nodes[4]);
423 EXPECT_EQ(nodes[2].next, &nodes[3]);
424 EXPECT_EQ(nodes[3].prev, &nodes[2]);
425 EXPECT_EQ(nodes[4].next, nullptr);
426 }
428 // insert begin
429 {
430 node nodes[5];
431 void *begin = &nodes[0], *end = &nodes[2];
433 cx_linked_list_link(&nodes[0], &nodes[1], loc_prev, loc_next);
434 cx_linked_list_link(&nodes[1], &nodes[2], loc_prev, loc_next);
435 cx_linked_list_link(&nodes[3], &nodes[4], loc_prev, loc_next);
437 cx_linked_list_insert_chain(&begin, &end, loc_prev, loc_next, nullptr, &nodes[3], nullptr);
438 EXPECT_EQ(begin, &nodes[3]);
439 EXPECT_EQ(end, &nodes[2]);
440 EXPECT_EQ(nodes[0].prev, &nodes[4]);
441 EXPECT_EQ(nodes[3].prev, nullptr);
442 EXPECT_EQ(nodes[4].next, &nodes[0]);
443 }
444 }
446 TEST(LinkedList_LowLevel, cx_linked_list_first) {
447 auto testdata = create_nodes_test_data(3);
448 auto begin = testdata.begin;
449 EXPECT_EQ(cx_linked_list_first(begin, loc_prev), begin);
450 EXPECT_EQ(cx_linked_list_first(begin->next, loc_prev), begin);
451 EXPECT_EQ(cx_linked_list_first(begin->next->next, loc_prev), begin);
452 }
454 TEST(LinkedList_LowLevel, cx_linked_list_last) {
455 auto testdata = create_nodes_test_data(3);
456 auto begin = testdata.begin;
457 auto end = begin->next->next;
458 EXPECT_EQ(cx_linked_list_last(begin, loc_next), end);
459 EXPECT_EQ(cx_linked_list_last(begin->next, loc_next), end);
460 EXPECT_EQ(cx_linked_list_last(begin->next->next, loc_next), end);
461 }
463 TEST(LinkedList_LowLevel, cx_linked_list_prev) {
464 auto testdata = create_nodes_test_data(3);
465 auto begin = testdata.begin;
466 EXPECT_EQ(cx_linked_list_prev(begin, loc_next, begin), nullptr);
467 EXPECT_EQ(cx_linked_list_prev(begin, loc_next, begin->next), begin);
468 EXPECT_EQ(cx_linked_list_prev(begin, loc_next, begin->next->next), begin->next);
469 }
471 TEST(LinkedList_LowLevel, cx_linked_list_remove) {
472 auto testdata = create_nodes_test_data({2, 4, 6});
473 auto begin = reinterpret_cast<void *>(testdata.begin);
474 auto first = testdata.begin;
475 auto second = first->next;
476 auto third = second->next;
477 auto end = reinterpret_cast<void *>(third);
479 cx_linked_list_remove(&begin, &end, loc_prev, loc_next, second);
480 EXPECT_EQ(begin, first);
481 EXPECT_EQ(end, third);
482 EXPECT_EQ(first->prev, nullptr);
483 EXPECT_EQ(first->next, third);
484 EXPECT_EQ(third->prev, first);
485 EXPECT_EQ(third->next, nullptr);
487 cx_linked_list_remove(&begin, &end, loc_prev, loc_next, third);
488 EXPECT_EQ(begin, first);
489 EXPECT_EQ(end, first);
490 EXPECT_EQ(first->prev, nullptr);
491 EXPECT_EQ(first->next, nullptr);
493 cx_linked_list_remove(&begin, &end, loc_prev, loc_next, first);
494 EXPECT_EQ(begin, nullptr);
495 EXPECT_EQ(end, nullptr);
496 }
498 TEST(LinkedList_LowLevel, cx_linked_list_size) {
499 EXPECT_EQ(cx_linked_list_size(nullptr, loc_next), 0);
501 {
502 auto testdata = create_nodes_test_data(5);
503 EXPECT_EQ(cx_linked_list_size(testdata.begin, loc_next), 5);
504 }
506 {
507 auto testdata = create_nodes_test_data(13);
508 EXPECT_EQ(cx_linked_list_size(testdata.begin, loc_next), 13);
509 }
510 }
512 TEST(LinkedList_LowLevel, cx_linked_list_sort) {
513 int_test_data<1500> testdata;
514 std::array<int, 1500> sorted{};
515 std::partial_sort_copy(testdata.data.begin(), testdata.data.end(), sorted.begin(), sorted.end());
517 auto scrambled = create_nodes_test_data(testdata.data.begin(), testdata.data.end());
518 void *begin = scrambled.begin;
519 void *end = cx_linked_list_last(begin, loc_next);
521 cx_linked_list_sort(&begin, &end, loc_prev, loc_next, loc_data,
522 false, cx_cmp_int);
524 node *check = reinterpret_cast<node *>(begin);
525 node *check_last = nullptr;
526 cx_for_n (i, sorted.size()) {
527 EXPECT_EQ(check->data, sorted[i]);
528 EXPECT_EQ(check->prev, check_last);
529 if (i < sorted.size() - 1) {
530 ASSERT_NE(check->next, nullptr);
531 }
532 check_last = check;
533 check = check->next;
534 }
535 EXPECT_EQ(check, nullptr);
536 EXPECT_EQ(end, check_last);
537 }
539 TEST(LinkedList_LowLevel, cx_linked_list_reverse) {
540 auto testdata = create_nodes_test_data({2, 4, 6, 8});
541 auto expected = create_nodes_test_data({8, 6, 4, 2});
543 auto begin = reinterpret_cast<void *>(testdata.begin);
544 auto end = cx_linked_list_last(begin, loc_next);
545 auto orig_begin = begin, orig_end = end;
547 cx_linked_list_reverse(&begin, &end, loc_prev, loc_next);
548 EXPECT_EQ(end, orig_begin);
549 EXPECT_EQ(begin, orig_end);
550 EXPECT_EQ(cx_linked_list_compare(begin, expected.begin, loc_next, loc_data, false, false, cx_cmp_int), 0);
551 }
553 class HighLevelTest : public ::testing::Test {
554 mutable std::unordered_set<CxList *> lists;
555 protected:
556 CxTestingAllocator testingAllocator;
558 void TearDown() override {
559 for (auto &&l: lists) cxListDestroy(l);
560 EXPECT_TRUE(testingAllocator.verify());
561 }
563 static constexpr size_t testdata_len = 250;
564 int_test_data<testdata_len> testdata;
566 auto autofree(CxList *list) const -> CxList * {
567 if (list != nullptr) lists.insert(list);
568 return list;
569 }
571 auto linkedListFromTestData() const -> CxList * {
572 auto list = autofree(cxLinkedListCreate(&testingAllocator, cx_cmp_int, sizeof(int)));
573 cxListAddArray(list, testdata.data.data(), testdata_len);
574 return list;
575 }
577 auto pointerLinkedListFromTestData() const -> CxList * {
578 auto list = autofree(cxPointerLinkedListCreate(&testingAllocator, cx_cmp_int));
579 // note: cannot use cxListAddArray() because we don't have a list of pointers
580 cx_for_n(i, testdata_len) cxListAdd(list, &testdata.data[i]);
581 return list;
582 }
584 auto arrayListFromTestData() const -> CxList * {
585 auto list = autofree(cxArrayListCreate(&testingAllocator, cx_cmp_int, sizeof(int), testdata_len));
586 cxListAddArray(list, testdata.data.data(), testdata_len);
587 return list;
588 }
590 void verifyCreate(CxList *list) const {
591 EXPECT_EQ(list->content_destructor_type, CX_DESTRUCTOR_NONE);
592 EXPECT_EQ(list->size, 0);
593 EXPECT_EQ(list->allocator, &testingAllocator);
594 EXPECT_EQ(list->cmpfunc, cx_cmp_int);
595 }
597 void verifyAdd(
598 CxList *list,
599 bool as_pointer
600 ) {
601 auto len = testdata_len;
602 cx_for_n (i, len) EXPECT_EQ(cxListAdd(list, &testdata.data[i]), 0);
603 EXPECT_EQ(list->size, len);
604 EXPECT_GE(list->capacity, list->size);
605 cx_for_n (i, len) EXPECT_EQ(*(int *) cxListAt(list, i), testdata.data[i]);
606 cx_for_n (i, len) ++testdata.data[i];
607 if (as_pointer) {
608 cx_for_n (i, len) EXPECT_EQ(*(int *) cxListAt(list, i), testdata.data[i]);
609 } else {
610 cx_for_n (i, len) EXPECT_EQ(*(int *) cxListAt(list, i), testdata.data[i] - 1);
611 }
612 }
614 static void verifyInsert(CxList *list) {
615 int a = 5, b = 47, c = 13, d = 42;
617 EXPECT_NE(cxListInsert(list, 1, &a), 0);
618 EXPECT_EQ(list->size, 0);
619 EXPECT_EQ(cxListInsert(list, 0, &a), 0);
620 EXPECT_EQ(list->size, 1);
621 EXPECT_EQ(cxListInsert(list, 0, &b), 0);
622 EXPECT_EQ(list->size, 2);
623 EXPECT_EQ(cxListInsert(list, 1, &c), 0);
624 EXPECT_EQ(list->size, 3);
625 EXPECT_EQ(cxListInsert(list, 3, &d), 0);
627 ASSERT_EQ(list->size, 4);
628 EXPECT_GE(list->capacity, list->size);
630 EXPECT_EQ(*(int *) cxListAt(list, 0), 47);
631 EXPECT_EQ(*(int *) cxListAt(list, 1), 13);
632 EXPECT_EQ(*(int *) cxListAt(list, 2), 5);
633 EXPECT_EQ(*(int *) cxListAt(list, 3), 42);
634 }
636 void verifyRemove(CxList *list) const {
637 EXPECT_EQ(cxListRemove(list, 2), 0);
638 EXPECT_EQ(cxListRemove(list, 4), 0);
639 EXPECT_EQ(list->size, testdata_len - 2);
640 EXPECT_GE(list->capacity, list->size);
641 EXPECT_EQ(*(int *) cxListAt(list, 0), testdata.data[0]);
642 EXPECT_EQ(*(int *) cxListAt(list, 1), testdata.data[1]);
643 EXPECT_EQ(*(int *) cxListAt(list, 2), testdata.data[3]);
644 EXPECT_EQ(*(int *) cxListAt(list, 3), testdata.data[4]);
645 EXPECT_EQ(*(int *) cxListAt(list, 4), testdata.data[6]);
647 EXPECT_EQ(cxListRemove(list, 0), 0);
648 EXPECT_EQ(list->size, testdata_len - 3);
649 EXPECT_GE(list->capacity, list->size);
650 EXPECT_EQ(*(int *) cxListAt(list, 0), testdata.data[1]);
651 EXPECT_EQ(*(int *) cxListAt(list, 1), testdata.data[3]);
653 EXPECT_NE(cxListRemove(list, testdata_len), 0);
654 }
656 void verifyAt(CxList *list) const {
657 auto len = testdata_len;
658 EXPECT_EQ(list->size, len);
659 cx_for_n (i, len) {
660 EXPECT_EQ(*(int *) cxListAt(list, i), testdata.data[i]);
661 }
662 EXPECT_EQ(cxListAt(list, list->size), nullptr);
663 }
665 void verifyFind(CxList *list) const {
666 cx_for_n (attempt, 25) {
667 size_t exp = rand() % testdata_len; // NOLINT(cert-msc50-cpp)
668 int val = testdata.data[exp];
669 // randomly picked number could occur earlier in list - find first position
670 cx_for_n (i, exp) {
671 if (testdata.data[i] == val) {
672 exp = i;
673 break;
674 }
675 }
676 EXPECT_EQ(cxListFind(list, &val), exp);
677 }
678 }
680 void verifySort(CxList *list) const {
681 std::array<int, testdata_len> expected{};
682 std::partial_sort_copy(testdata.data.begin(), testdata.data.end(), expected.begin(), expected.end());
683 cxListSort(list);
684 cx_for_n (i, testdata_len) ASSERT_EQ(*(int *) cxListAt(list, i), expected[i]);
685 }
687 void verifyIterator(CxList *list) const {
688 int i = 0;
689 auto iter = cxListBeginMut(list);
690 cx_foreach(int*, x, iter) {
691 ASSERT_EQ(iter.index, (size_t) (i + 1) / 2);
692 ASSERT_EQ(*x, testdata.data[i]);
693 if (i % 2 == 1) cxIteratorFlagRemoval(iter);
694 i++;
695 }
696 auto len = testdata_len;
697 EXPECT_EQ(i, len);
698 ASSERT_EQ(list->size, len / 2);
699 cx_for_n(j, len / 2) ASSERT_EQ(*(int *) cxListAt(list, j), testdata.data[j * 2]);
700 }
702 static void verifyInsertViaIterator(CxList *list) {
703 int newdata[] = {10, 20, 30, 40, 50};
705 auto iter = cxListMutIterator(list, 2);
706 EXPECT_TRUE(cxIteratorValid(iter));
707 EXPECT_EQ(iter.index, 2);
708 EXPECT_EQ(*(int *) cxIteratorCurrent(iter), 2);
709 cxListInsertAfter(&iter, &newdata[0]);
710 EXPECT_TRUE(cxIteratorValid(iter));
711 EXPECT_EQ(iter.index, 2);
712 EXPECT_EQ(*(int *) cxIteratorCurrent(iter), 2);
713 cxListInsertBefore(&iter, &newdata[1]);
714 EXPECT_TRUE(cxIteratorValid(iter));
715 EXPECT_EQ(iter.index, 3);
716 EXPECT_EQ(*(int *) cxIteratorCurrent(iter), 2);
718 iter = cxListBeginMut(list);
719 cxListInsertBefore(&iter, &newdata[2]);
720 EXPECT_TRUE(cxIteratorValid(iter));
721 EXPECT_EQ(iter.index, 1);
722 EXPECT_EQ(*(int *) cxIteratorCurrent(iter), 0);
723 iter = cxListMutIterator(list, list->size);
724 cxListInsertBefore(&iter, &newdata[3]);
725 EXPECT_FALSE(cxIteratorValid(iter));
726 EXPECT_EQ(iter.index, 9);
727 iter = cxListMutIterator(list, list->size);
728 cxListInsertAfter(&iter, &newdata[4]);
729 EXPECT_FALSE(cxIteratorValid(iter));
730 EXPECT_EQ(iter.index, 10);
732 int expdata[] = {30, 0, 1, 20, 2, 10, 3, 4, 40, 50};
733 cx_for_n (j, 10) EXPECT_EQ(*(int *) cxListAt(list, j), expdata[j]);
734 }
736 void verifyReverse(CxList *list) const {
737 cxListReverse(list);
738 cx_for_n(i, testdata_len) {
739 ASSERT_EQ(*(int *) cxListAt(list, i), testdata.data[testdata_len - 1 - i]);
740 }
741 }
743 static void verifyCompare(
744 CxList *left,
745 CxList *right
746 ) {
747 EXPECT_EQ(cxListCompare(left, right), 0);
748 int x = 42;
749 cxListAdd(left, &x);
750 ASSERT_GT(left->size, right->size);
751 EXPECT_GT(cxListCompare(left, right), 0);
752 EXPECT_LT(cxListCompare(right, left), 0);
753 cxListAdd(right, &x);
754 ASSERT_EQ(left->size, right->size);
755 EXPECT_EQ(cxListCompare(left, right), 0);
756 int a = 5, b = 10;
757 cxListInsert(left, 15, &a);
758 cxListInsert(right, 15, &b);
759 ASSERT_EQ(left->size, right->size);
760 EXPECT_LT(cxListCompare(left, right), 0);
761 EXPECT_GT(cxListCompare(right, left), 0);
762 *(int *) cxListAt(left, 15) = 10;
763 EXPECT_EQ(cxListCompare(left, right), 0);
764 }
765 };
767 class LinkedList : public HighLevelTest {
768 };
770 class PointerLinkedList : public HighLevelTest {
771 };
773 class ArrayList : public HighLevelTest {
774 };
776 TEST_F(LinkedList, cxLinkedListCreate) {
777 CxList *list = autofree(cxLinkedListCreate(&testingAllocator, cx_cmp_int, sizeof(int)));
778 ASSERT_NE(list, nullptr);
779 EXPECT_EQ(list->itemsize, sizeof(int));
780 EXPECT_EQ(list->capacity, (size_t) -1);
781 verifyCreate(list);
782 }
784 TEST_F(PointerLinkedList, cxPointerLinkedListCreate) {
785 CxList *list = autofree(cxPointerLinkedListCreate(&testingAllocator, cx_cmp_int));
786 ASSERT_NE(list, nullptr);
787 EXPECT_EQ(list->itemsize, sizeof(void *));
788 EXPECT_EQ(list->capacity, (size_t) -1);
789 verifyCreate(list);
790 }
792 TEST_F(ArrayList, cxArrayListCreate) {
793 CxList *list = autofree(cxArrayListCreate(&testingAllocator, cx_cmp_int, sizeof(int), 8));
794 ASSERT_NE(list, nullptr);
795 EXPECT_EQ(list->itemsize, sizeof(int));
796 EXPECT_EQ(list->capacity, 8);
797 verifyCreate(list);
798 }
800 TEST_F(LinkedList, cxListAdd) {
801 CxList *list = autofree(cxLinkedListCreate(&testingAllocator, cx_cmp_int, sizeof(int)));
802 verifyAdd(list, false);
803 }
805 TEST_F(PointerLinkedList, cxListAdd) {
806 CxList *list = autofree(cxPointerLinkedListCreate(&testingAllocator, cx_cmp_int));
807 verifyAdd(list, true);
808 }
810 TEST_F(ArrayList, cxListAdd) {
811 CxList *list = autofree(cxArrayListCreate(&testingAllocator, cx_cmp_int, sizeof(int), 8));
812 verifyAdd(list, false);
813 }
815 TEST_F(LinkedList, cxListInsert) {
816 verifyInsert(autofree(cxLinkedListCreate(&testingAllocator, cx_cmp_int, sizeof(int))));
817 }
819 TEST_F(PointerLinkedList, cxListInsert) {
820 verifyInsert(autofree(cxPointerLinkedListCreate(&testingAllocator, cx_cmp_int)));
821 }
823 TEST_F(ArrayList, cxListInsert) {
824 verifyInsert(autofree(cxArrayListCreate(&testingAllocator, cx_cmp_int, sizeof(int), 2)));
825 }
827 TEST_F(LinkedList, cxListRemove) {
828 verifyRemove(linkedListFromTestData());
829 }
831 TEST_F(PointerLinkedList, cxListRemove) {
832 verifyRemove(pointerLinkedListFromTestData());
833 }
835 TEST_F(ArrayList, cxListRemove) {
836 verifyRemove(arrayListFromTestData());
837 }
839 TEST_F(LinkedList, cxListAt) {
840 verifyAt(linkedListFromTestData());
841 }
843 TEST_F(PointerLinkedList, cxListAt) {
844 verifyAt(pointerLinkedListFromTestData());
845 }
847 TEST_F(ArrayList, cxListAt) {
848 verifyAt(arrayListFromTestData());
849 }
851 TEST_F(LinkedList, cxListFind) {
852 verifyFind(linkedListFromTestData());
853 }
855 TEST_F(PointerLinkedList, cxListFind) {
856 verifyFind(pointerLinkedListFromTestData());
857 }
859 TEST_F(ArrayList, cxListFind) {
860 verifyFind(arrayListFromTestData());
861 }
863 TEST_F(LinkedList, cxListSort) {
864 verifySort(linkedListFromTestData());
865 }
867 TEST_F(PointerLinkedList, cxListSort) {
868 verifySort(pointerLinkedListFromTestData());
869 }
871 TEST_F(ArrayList, cxListSort) {
872 verifySort(arrayListFromTestData());
873 }
875 TEST_F(LinkedList, Iterator) {
876 verifyIterator(linkedListFromTestData());
877 }
879 TEST_F(PointerLinkedList, Iterator) {
880 verifyIterator(pointerLinkedListFromTestData());
881 }
883 TEST_F(ArrayList, Iterator) {
884 verifyIterator(arrayListFromTestData());
885 }
887 TEST_F(LinkedList, InsertViaIterator) {
888 int fivenums[] = {0, 1, 2, 3, 4, 5};
889 CxList *list = autofree(cxLinkedListCreate(&testingAllocator, cx_cmp_int, sizeof(int)));
890 cxListAddArray(list, fivenums, 5);
891 verifyInsertViaIterator(list);
892 }
894 TEST_F(PointerLinkedList, InsertViaIterator) {
895 int fivenums[] = {0, 1, 2, 3, 4, 5};
896 CxList *list = autofree(cxPointerLinkedListCreate(&testingAllocator, cx_cmp_int));
897 // note: don't use cxListAddArray() here, because we don't have a list of pointers
898 cx_for_n (i, 5) cxListAdd(list, &fivenums[i]);
899 verifyInsertViaIterator(list);
900 }
902 TEST_F(ArrayList, InsertViaIterator) {
903 int fivenums[] = {0, 1, 2, 3, 4, 5};
904 CxList *list = autofree(cxArrayListCreate(&testingAllocator, cx_cmp_int, sizeof(int), 4));
905 cxListAddArray(list, fivenums, 5);
906 verifyInsertViaIterator(list);
907 }
909 TEST_F(LinkedList, cxListReverse) {
910 verifyReverse(linkedListFromTestData());
911 }
913 TEST_F(PointerLinkedList, cxListReverse) {
914 verifyReverse(pointerLinkedListFromTestData());
915 }
917 TEST_F(ArrayList, cxListReverse) {
918 verifyReverse(arrayListFromTestData());
919 }
921 TEST_F(LinkedList, cxListCompare) {
922 auto left = linkedListFromTestData();
923 auto right = linkedListFromTestData();
924 verifyCompare(left, right);
925 }
927 TEST_F(LinkedList, cxListCompareWithPtrList) {
928 auto left = linkedListFromTestData();
929 auto right = pointerLinkedListFromTestData();
930 verifyCompare(left, right);
931 }
933 TEST_F(LinkedList, cxListCompareWithArrayList) {
934 auto left = linkedListFromTestData();
935 auto right = arrayListFromTestData();
936 verifyCompare(left, right);
937 }
939 TEST_F(PointerLinkedList, cxListCompare) {
940 auto left = pointerLinkedListFromTestData();
941 auto right = pointerLinkedListFromTestData();
942 verifyCompare(left, right);
943 }
945 TEST_F(PointerLinkedList, cxListCompareWithNormalList) {
946 auto left = pointerLinkedListFromTestData();
947 auto right = linkedListFromTestData();
948 verifyCompare(left, right);
949 }
951 TEST_F(PointerLinkedList, cxListCompareWithArrayList) {
952 auto left = pointerLinkedListFromTestData();
953 auto right = arrayListFromTestData();
954 verifyCompare(left, right);
955 }
957 TEST_F(ArrayList, cxListCompare) {
958 auto left = arrayListFromTestData();
959 auto right = arrayListFromTestData();
960 verifyCompare(left, right);
961 }
963 TEST_F(ArrayList, cxListCompareWithPtrList) {
964 auto left = arrayListFromTestData();
965 auto right = pointerLinkedListFromTestData();
966 verifyCompare(left, right);
967 }
969 TEST_F(ArrayList, cxListCompareWithNormalList) {
970 auto left = arrayListFromTestData();
971 auto right = linkedListFromTestData();
972 verifyCompare(left, right);
973 }
975 TEST_F(PointerLinkedList, NoDestructor) {
976 void *item = cxMalloc(&testingAllocator, sizeof(int));
977 auto list = cxPointerLinkedListCreate(cxDefaultAllocator, cx_cmp_int);
978 cxListAdd(list, item);
979 ASSERT_FALSE(testingAllocator.verify());
980 cxListDestroy(list);
981 EXPECT_FALSE(testingAllocator.verify());
982 cxFree(&testingAllocator, item);
983 EXPECT_TRUE(testingAllocator.verify());
984 }
986 TEST_F(PointerLinkedList, SimpleDestructor) {
987 int item = 0;
988 auto list = cxPointerLinkedListCreate(cxDefaultAllocator, cx_cmp_int);
989 list->content_destructor_type = CX_DESTRUCTOR_SIMPLE;
990 list->simple_destructor = [](void *elem) { *(int *) elem = 42; };
991 cxListAdd(list, &item);
992 cxListDestroy(list);
993 EXPECT_EQ(item, 42);
994 }
996 TEST_F(PointerLinkedList, AdvancedDestructor) {
997 void *item = cxMalloc(&testingAllocator, sizeof(int));
998 auto list = cxPointerLinkedListCreate(cxDefaultAllocator, cx_cmp_int);
999 list->content_destructor_type = CX_DESTRUCTOR_ADVANCED;
1000 list->advanced_destructor.data = &testingAllocator;
1001 list->advanced_destructor.func = (cx_destructor_func2) cxFree;
1002 cxListAdd(list, item);
1003 ASSERT_FALSE(testingAllocator.verify());
1004 cxListDestroy(list);
1005 EXPECT_TRUE(testingAllocator.verify());
1006 }