universe@816: /*
universe@816:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@816:  *
universe@816:  * Copyright 2023 Mike Becker, Olaf Wintermann All rights reserved.
universe@816:  *
universe@816:  * Redistribution and use in source and binary forms, with or without
universe@816:  * modification, are permitted provided that the following conditions are met:
universe@816:  *
universe@816:  *   1. Redistributions of source code must retain the above copyright
universe@816:  *      notice, this list of conditions and the following disclaimer.
universe@816:  *
universe@816:  *   2. Redistributions in binary form must reproduce the above copyright
universe@816:  *      notice, this list of conditions and the following disclaimer in the
universe@816:  *      documentation and/or other materials provided with the distribution.
universe@816:  *
universe@816:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@816:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@816:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@816:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@816:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@816:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@816:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@816:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@816:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@816:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@816:  * POSSIBILITY OF SUCH DAMAGE.
universe@816:  */
universe@816: 
universe@816: #include "cx/tree.h"
universe@816: 
universe@816: #include "cx/test.h"
universe@816: 
universe@816: typedef struct tree_node {
universe@816:     struct tree_node *parent;
universe@816:     struct tree_node *next;
universe@816:     struct tree_node *prev;
universe@816:     struct tree_node *children;
universe@816:     int data;
universe@816: } tree_node;
universe@816: 
universe@816: #define tree_node_layout \
universe@816:     offsetof(tree_node, parent), offsetof(tree_node, children), \
universe@816:     offsetof(tree_node, prev), offsetof(tree_node, next)
universe@816: 
universe@826: #define tree_child_list offsetof(tree_node, children),offsetof(tree_node, next)
universe@826: 
universe@816: CX_TEST(test_tree_link_new_child) {
universe@816:     tree_node parent = {0};
universe@816:     tree_node child = {0};
universe@816: 
universe@816:     CX_TEST_DO {
universe@816:         cx_tree_link(&parent, &child, tree_node_layout);
universe@816:         CX_TEST_ASSERT(parent.next == NULL);
universe@816:         CX_TEST_ASSERT(parent.prev == NULL);
universe@816:         CX_TEST_ASSERT(parent.parent == NULL);
universe@816:         CX_TEST_ASSERT(parent.children == &child);
universe@816:         CX_TEST_ASSERT(child.parent == &parent);
universe@816:         CX_TEST_ASSERT(child.next == NULL);
universe@816:         CX_TEST_ASSERT(child.prev == NULL);
universe@816:         CX_TEST_ASSERT(child.children == NULL);
universe@816:     }
universe@816: }
universe@816: 
universe@816: CX_TEST(test_tree_link_add_child) {
universe@816:     tree_node parent = {0};
universe@816:     tree_node child1 = {0};
universe@816:     tree_node child2 = {0};
universe@816:     tree_node child3 = {0};
universe@816: 
universe@816:     CX_TEST_DO {
universe@816:         cx_tree_link(&parent, &child1, tree_node_layout);
universe@816:         cx_tree_link(&parent, &child2, tree_node_layout);
universe@816:         cx_tree_link(&parent, &child3, tree_node_layout);
universe@816:         CX_TEST_ASSERT(parent.next == NULL);
universe@816:         CX_TEST_ASSERT(parent.prev == NULL);
universe@816:         CX_TEST_ASSERT(parent.parent == NULL);
universe@816:         CX_TEST_ASSERT(parent.children == &child3);
universe@816: 
universe@816:         CX_TEST_ASSERT(child1.parent == &parent);
universe@816:         CX_TEST_ASSERT(child2.parent == &parent);
universe@816:         CX_TEST_ASSERT(child3.parent == &parent);
universe@816:         CX_TEST_ASSERT(child1.children == NULL);
universe@816:         CX_TEST_ASSERT(child2.children == NULL);
universe@816:         CX_TEST_ASSERT(child3.children == NULL);
universe@816: 
universe@816:         CX_TEST_ASSERT(child3.prev == NULL);
universe@816:         CX_TEST_ASSERT(child3.next == &child2);
universe@816:         CX_TEST_ASSERT(child2.prev == &child3);
universe@816:         CX_TEST_ASSERT(child2.next == &child1);
universe@816:         CX_TEST_ASSERT(child1.prev == &child2);
universe@816:         CX_TEST_ASSERT(child1.next == NULL);
universe@816:     }
universe@816: }
universe@816: 
universe@816: CX_TEST(test_tree_link_move_to_other_parent) {
universe@816:     tree_node parent = {0};
universe@816:     tree_node child1 = {0};
universe@816:     tree_node child2 = {0};
universe@816:     tree_node child3 = {0};
universe@816:     cx_tree_link(&parent, &child1, tree_node_layout);
universe@816:     cx_tree_link(&parent, &child2, tree_node_layout);
universe@816:     cx_tree_link(&parent, &child3, tree_node_layout);
universe@816: 
universe@816:     CX_TEST_DO {
universe@816:         cx_tree_link(&child3, &child2, tree_node_layout);
universe@816: 
universe@816:         CX_TEST_ASSERT(parent.next == NULL);
universe@816:         CX_TEST_ASSERT(parent.prev == NULL);
universe@816:         CX_TEST_ASSERT(parent.parent == NULL);
universe@816:         CX_TEST_ASSERT(parent.children == &child3);
universe@816: 
universe@816:         CX_TEST_ASSERT(child1.parent == &parent);
universe@816:         CX_TEST_ASSERT(child2.parent == &child3);
universe@816:         CX_TEST_ASSERT(child3.parent == &parent);
universe@816:         CX_TEST_ASSERT(child1.children == NULL);
universe@816:         CX_TEST_ASSERT(child2.children == NULL);
universe@816:         CX_TEST_ASSERT(child3.children == &child2);
universe@816: 
universe@816:         CX_TEST_ASSERT(child3.prev == NULL);
universe@816:         CX_TEST_ASSERT(child3.next == &child1);
universe@816:         CX_TEST_ASSERT(child1.prev == &child3);
universe@816:         CX_TEST_ASSERT(child1.next == NULL);
universe@816: 
universe@816:         CX_TEST_ASSERT(child2.prev == NULL);
universe@816:         CX_TEST_ASSERT(child2.next == NULL);
universe@816:     }
universe@816: }
universe@816: 
universe@816: CX_TEST(test_tree_unlink) {
universe@816:     tree_node parent = {0};
universe@816:     tree_node child1 = {0};
universe@816:     tree_node child2 = {0};
universe@816:     tree_node child3 = {0};
universe@816:     cx_tree_link(&parent, &child1, tree_node_layout);
universe@816:     cx_tree_link(&parent, &child3, tree_node_layout);
universe@816:     cx_tree_link(&child3, &child2, tree_node_layout);
universe@816: 
universe@816:     CX_TEST_DO {
universe@816:         cx_tree_unlink(&child3, tree_node_layout);
universe@816: 
universe@816:         CX_TEST_ASSERT(parent.next == NULL);
universe@816:         CX_TEST_ASSERT(parent.prev == NULL);
universe@816:         CX_TEST_ASSERT(parent.parent == NULL);
universe@816:         CX_TEST_ASSERT(parent.children == &child1);
universe@816: 
universe@816:         CX_TEST_ASSERT(child1.parent == &parent);
universe@816:         CX_TEST_ASSERT(child1.children == NULL);
universe@816:         CX_TEST_ASSERT(child1.prev == NULL);
universe@816:         CX_TEST_ASSERT(child1.next == NULL);
universe@816: 
universe@816:         // child 3 is unlinked
universe@816:         CX_TEST_ASSERT(child3.parent == NULL);
universe@816:         CX_TEST_ASSERT(child3.prev == NULL);
universe@816:         CX_TEST_ASSERT(child3.next == NULL);
universe@816: 
universe@816:         // child 2 is still child of the unlinked child 3
universe@816:         CX_TEST_ASSERT(child3.children == &child2);
universe@816:         CX_TEST_ASSERT(child2.parent == &child3);
universe@816:         CX_TEST_ASSERT(child2.children == NULL);
universe@816:         CX_TEST_ASSERT(child2.prev == NULL);
universe@816:         CX_TEST_ASSERT(child2.next == NULL);
universe@816:     }
universe@816: }
universe@816: 
universe@826: static int test_tree_search_function(void const *n, void const *d) {
universe@826:     tree_node const *node = n;
universe@826:     int data = *((int const*)d);
universe@826: 
universe@826:     if (data < node->data) return -1;
universe@826:     else if (data == node->data) return 0;
universe@826:     else return data - node->data;
universe@826: }
universe@826: 
universe@826: CX_TEST(test_tree_search) {
universe@826:     tree_node root = {0};
universe@826:     tree_node a = {0};
universe@826:     tree_node b = {0};
universe@826:     tree_node c = {0};
universe@826:     tree_node aa = {0};
universe@826:     tree_node ab = {0};
universe@826:     tree_node ba = {0};
universe@826:     tree_node ca = {0};
universe@826:     tree_node cb = {0};
universe@826:     tree_node cc = {0};
universe@826:     tree_node cba = {0};
universe@826: 
universe@826:     int testdata[] = {0, 10, 14, 18, 20, 25, 30, 32, 34, 36, 40};
universe@826:     tree_node* testnodes[] = {&root, &a, &aa, &ab, &b, &ba, &c, &ca, &cb, &cba, &cc};
universe@826: 
universe@826:     for (unsigned i = 0 ; i <= 10 ; i++) {
universe@826:         testnodes[i]->data = testdata[i];
universe@826:     }
universe@826: 
universe@826:     cx_tree_link(&root, &a, tree_node_layout);
universe@826:     cx_tree_link(&root, &b, tree_node_layout);
universe@826:     cx_tree_link(&root, &c, tree_node_layout);
universe@826: 
universe@826:     cx_tree_link(&a, &aa, tree_node_layout);
universe@826:     cx_tree_link(&a, &ab, tree_node_layout);
universe@826: 
universe@826:     cx_tree_link(&b, &ba, tree_node_layout);
universe@826: 
universe@826:     cx_tree_link(&c, &ca, tree_node_layout);
universe@826:     cx_tree_link(&c, &cb, tree_node_layout);
universe@826:     cx_tree_link(&c, &cc, tree_node_layout);
universe@826: 
universe@826:     cx_tree_link(&cb, &cba, tree_node_layout);
universe@826: 
universe@826:     int s;
universe@826:     int r;
universe@826:     tree_node *n;
universe@826:     CX_TEST_DO {
universe@826:         for (unsigned i = 0 ; i <= 10 ; i++) {
universe@826:             s = testdata[i];
universe@826:             r = cx_tree_search(&root, &s, test_tree_search_function,
universe@826:                                (void **) &n, tree_child_list);
universe@826:             CX_TEST_ASSERT(r == 0);
universe@826:             CX_TEST_ASSERT(n == testnodes[i]);
universe@826:         }
universe@826: 
universe@826:         s = -5;
universe@826:         r = cx_tree_search(&root, &s, test_tree_search_function,
universe@826:                            (void **) &n, tree_child_list);
universe@826:         CX_TEST_ASSERT(r < 0);
universe@826:         CX_TEST_ASSERT(n == NULL);
universe@826: 
universe@826:         s = 26;
universe@826:         r = cx_tree_search(&root, &s, test_tree_search_function,
universe@826:                            (void **) &n, tree_child_list);
universe@826:         CX_TEST_ASSERT(r > 0);
universe@826:         CX_TEST_ASSERT(n == &ba);
universe@826: 
universe@826:         s = 35;
universe@826:         r = cx_tree_search(&root, &s, test_tree_search_function,
universe@826:                            (void **) &n, tree_child_list);
universe@826:         CX_TEST_ASSERT(r > 0);
universe@826:         CX_TEST_ASSERT(n == &cb);
universe@826: 
universe@826:         s = 38;
universe@826:         r = cx_tree_search(&root, &s, test_tree_search_function,
universe@826:                            (void **) &n, tree_child_list);
universe@826:         CX_TEST_ASSERT(r > 0);
universe@826:         CX_TEST_ASSERT(n == &cba);
universe@826: 
universe@826:         s = 42;
universe@826:         r = cx_tree_search(&root, &s, test_tree_search_function,
universe@826:                            (void **) &n, tree_child_list);
universe@826:         CX_TEST_ASSERT(r > 0);
universe@826:         CX_TEST_ASSERT(n == &cc);
universe@826:     }
universe@826: }
universe@826: 
universe@836: CX_TEST(test_tree_iterator_create_and_dispose) {
universe@833:     tree_node root;
universe@833:     CX_TEST_DO {
universe@833:         CxTreeIterator iter = cx_tree_iterator(&root, false, tree_child_list);
universe@833:         CX_TEST_ASSERT(!iter.visit_on_exit);
universe@833:         CX_TEST_ASSERT(!iter.exiting);
universe@833:         CX_TEST_ASSERT(iter.counter == 1);
universe@833:         CX_TEST_ASSERT(iter.node == &root);
universe@833:         CX_TEST_ASSERT(!iter.base.mutating);
universe@833:         CX_TEST_ASSERT(!iter.base.remove);
universe@833:         CX_TEST_ASSERT(iter.stack != NULL);
universe@833:         CX_TEST_ASSERT(iter.stack_capacity > 0);
universe@833:         CX_TEST_ASSERT(iter.stack_size == 1);
universe@833:         CX_TEST_ASSERT(iter.depth == 1);
universe@833:         CX_TEST_ASSERT(iter.loc_next == offsetof(tree_node, next));
universe@833:         CX_TEST_ASSERT(iter.loc_children == offsetof(tree_node, children));
universe@836:         cxTreeIteratorDispose(&iter);
universe@836:         CX_TEST_ASSERT(iter.stack == NULL);
universe@836:     }
universe@836: }
universe@836: 
universe@836: CX_TEST(test_tree_iterator_basic_test_only_enter) {
universe@836:     tree_node root = {0};
universe@836:     tree_node a = {0};
universe@836:     tree_node b = {0};
universe@836:     tree_node c = {0};
universe@836:     tree_node aa = {0};
universe@836:     tree_node ab = {0};
universe@836:     tree_node ba = {0};
universe@836:     tree_node ca = {0};
universe@836:     tree_node cb = {0};
universe@836:     tree_node cc = {0};
universe@836:     tree_node cba = {0};
universe@836: 
universe@836:     cx_tree_link(&root, &a, tree_node_layout);
universe@836:     cx_tree_link(&root, &b, tree_node_layout);
universe@836:     cx_tree_link(&root, &c, tree_node_layout);
universe@836:     cx_tree_link(&a, &aa, tree_node_layout);
universe@836:     cx_tree_link(&a, &ab, tree_node_layout);
universe@836:     cx_tree_link(&b, &ba, tree_node_layout);
universe@836:     cx_tree_link(&c, &ca, tree_node_layout);
universe@836:     cx_tree_link(&c, &cb, tree_node_layout);
universe@836:     cx_tree_link(&c, &cc, tree_node_layout);
universe@836:     cx_tree_link(&cb, &cba, tree_node_layout);
universe@836:     CX_TEST_DO {
universe@836:         CxTreeIterator iter = cx_tree_iterator(&root, false, tree_child_list);
universe@836:         unsigned chk = 0;
universe@836:         cx_foreach(tree_node*, node, iter) {
universe@836:             CX_TEST_ASSERT(node->data == 0);
universe@836:             node->data++;
universe@836:             chk++;
universe@836:             CX_TEST_ASSERT(node == iter.node);
universe@836:             CX_TEST_ASSERT(!iter.exiting);
universe@836:         }
universe@836:         CX_TEST_ASSERT(iter.counter == 11);
universe@836:         CX_TEST_ASSERT(chk == 11);
universe@836:         CX_TEST_ASSERT(iter.stack == NULL);
universe@836:         CX_TEST_ASSERT(root.data == 1);
universe@836:         CX_TEST_ASSERT(a.data == 1);
universe@836:         CX_TEST_ASSERT(b.data == 1);
universe@836:         CX_TEST_ASSERT(c.data == 1);
universe@836:         CX_TEST_ASSERT(aa.data == 1);
universe@836:         CX_TEST_ASSERT(ab.data == 1);
universe@836:         CX_TEST_ASSERT(ba.data == 1);
universe@836:         CX_TEST_ASSERT(ca.data == 1);
universe@836:         CX_TEST_ASSERT(cb.data == 1);
universe@836:         CX_TEST_ASSERT(cc.data == 1);
universe@836:         CX_TEST_ASSERT(cba.data == 1);
universe@833:     }
universe@833: }
universe@833: 
universe@816: CxTestSuite *cx_test_suite_tree_low_level(void) {
universe@816:     CxTestSuite *suite = cx_test_suite_new("tree (low level)");
universe@816: 
universe@816:     cx_test_register(suite, test_tree_link_new_child);
universe@816:     cx_test_register(suite, test_tree_link_add_child);
universe@816:     cx_test_register(suite, test_tree_link_move_to_other_parent);
universe@816:     cx_test_register(suite, test_tree_unlink);
universe@826:     cx_test_register(suite, test_tree_search);
universe@836:     cx_test_register(suite, test_tree_iterator_create_and_dispose);
universe@836:     cx_test_register(suite, test_tree_iterator_basic_test_only_enter);
universe@816: 
universe@816:     return suite;
universe@816: }