Sun, 18 Feb 2024 13:38:42 +0100
vastly simplify tree iterators and add test for creating them
relates to #371
universe@816 | 1 | /* |
universe@816 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@816 | 3 | * |
universe@816 | 4 | * Copyright 2024 Mike Becker, Olaf Wintermann All rights reserved. |
universe@816 | 5 | * |
universe@816 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@816 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@816 | 8 | * |
universe@816 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@816 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@816 | 11 | * |
universe@816 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@816 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@816 | 14 | * documentation and/or other materials provided with the distribution. |
universe@816 | 15 | * |
universe@816 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@816 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@816 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@816 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@816 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@816 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@816 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@816 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@816 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@816 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@816 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@816 | 27 | */ |
universe@816 | 28 | |
universe@816 | 29 | #include "cx/tree.h" |
universe@816 | 30 | |
universe@826 | 31 | #include "cx/array_list.h" |
universe@826 | 32 | |
universe@816 | 33 | #include <assert.h> |
universe@816 | 34 | |
universe@816 | 35 | #define CX_TREE_PTR(cur, off) (*(void**)(((char*)(cur))+(off))) |
universe@816 | 36 | #define CX_TREE_PTR(cur, off) (*(void**)(((char*)(cur))+(off))) |
universe@816 | 37 | #define tree_parent(node) CX_TREE_PTR(node, loc_parent) |
universe@816 | 38 | #define tree_children(node) CX_TREE_PTR(node, loc_children) |
universe@816 | 39 | #define tree_prev(node) CX_TREE_PTR(node, loc_prev) |
universe@816 | 40 | #define tree_next(node) CX_TREE_PTR(node, loc_next) |
universe@816 | 41 | |
universe@816 | 42 | void cx_tree_link( |
universe@816 | 43 | void *restrict parent, |
universe@816 | 44 | void *restrict node, |
universe@816 | 45 | ptrdiff_t loc_parent, |
universe@816 | 46 | ptrdiff_t loc_children, |
universe@816 | 47 | ptrdiff_t loc_prev, |
universe@816 | 48 | ptrdiff_t loc_next |
universe@816 | 49 | ) { |
universe@816 | 50 | void *current_parent = tree_parent(node); |
universe@816 | 51 | if (current_parent == parent) return; |
universe@816 | 52 | if (current_parent != NULL) { |
universe@816 | 53 | cx_tree_unlink(node, loc_parent, loc_children, |
universe@816 | 54 | loc_prev, loc_next); |
universe@816 | 55 | } |
universe@816 | 56 | |
universe@816 | 57 | if (tree_children(parent) == NULL) { |
universe@816 | 58 | tree_children(parent) = node; |
universe@816 | 59 | } else { |
universe@816 | 60 | void *children = tree_children(parent); |
universe@816 | 61 | tree_prev(children) = node; |
universe@816 | 62 | tree_next(node) = children; |
universe@816 | 63 | tree_children(parent) = node; |
universe@816 | 64 | } |
universe@816 | 65 | tree_parent(node) = parent; |
universe@816 | 66 | } |
universe@816 | 67 | |
universe@816 | 68 | void cx_tree_unlink( |
universe@816 | 69 | void *node, |
universe@816 | 70 | ptrdiff_t loc_parent, |
universe@816 | 71 | ptrdiff_t loc_children, |
universe@816 | 72 | ptrdiff_t loc_prev, |
universe@816 | 73 | ptrdiff_t loc_next |
universe@816 | 74 | ) { |
universe@816 | 75 | if (tree_parent(node) == NULL) return; |
universe@816 | 76 | |
universe@816 | 77 | void *left = tree_prev(node); |
universe@816 | 78 | void *right = tree_next(node); |
universe@816 | 79 | assert(left == NULL || tree_children(tree_parent(node)) != node); |
universe@816 | 80 | if (left == NULL) { |
universe@816 | 81 | tree_children(tree_parent(node)) = right; |
universe@816 | 82 | } else { |
universe@816 | 83 | tree_next(left) = right; |
universe@816 | 84 | } |
universe@816 | 85 | if (right != NULL) tree_prev(right) = left; |
universe@816 | 86 | tree_parent(node) = NULL; |
universe@816 | 87 | tree_prev(node) = NULL; |
universe@816 | 88 | tree_next(node) = NULL; |
universe@816 | 89 | } |
universe@826 | 90 | |
universe@826 | 91 | int cx_tree_search( |
universe@826 | 92 | void const *root, |
universe@826 | 93 | void const *data, |
universe@826 | 94 | cx_tree_search_func sfunc, |
universe@826 | 95 | void **result, |
universe@826 | 96 | ptrdiff_t loc_children, |
universe@826 | 97 | ptrdiff_t loc_next |
universe@826 | 98 | ) { |
universe@826 | 99 | int ret; |
universe@826 | 100 | *result = NULL; |
universe@826 | 101 | |
universe@826 | 102 | // shortcut: compare root before doing anything else |
universe@826 | 103 | ret = sfunc(root, data); |
universe@826 | 104 | if (ret < 0) { |
universe@826 | 105 | return ret; |
universe@826 | 106 | } else if (ret == 0 || tree_children(root) == NULL) { |
universe@826 | 107 | *result = (void*)root; |
universe@826 | 108 | return ret; |
universe@826 | 109 | } |
universe@826 | 110 | |
universe@826 | 111 | // create a working stack |
universe@833 | 112 | cx_array_declare(void const*, work); |
universe@833 | 113 | cx_array_initialize(work, 32); |
universe@826 | 114 | |
universe@826 | 115 | // add the children of root to the working stack |
universe@826 | 116 | { |
universe@826 | 117 | void *c = tree_children(root); |
universe@826 | 118 | while (c != NULL) { |
universe@833 | 119 | cx_array_simple_add(work, c); |
universe@826 | 120 | c = tree_next(c); |
universe@826 | 121 | } |
universe@826 | 122 | } |
universe@826 | 123 | |
universe@826 | 124 | // remember a candidate for adding the data |
universe@826 | 125 | // also remember the exact return code from sfunc |
universe@826 | 126 | void *candidate = NULL; |
universe@826 | 127 | int ret_candidate = -1; |
universe@826 | 128 | |
universe@826 | 129 | // process the working stack |
universe@826 | 130 | while (work_size > 0) { |
universe@826 | 131 | // pop element |
universe@826 | 132 | void const *node = work[--work_size]; |
universe@826 | 133 | |
universe@826 | 134 | // apply the search function |
universe@826 | 135 | ret = sfunc(node, data); |
universe@826 | 136 | |
universe@826 | 137 | if (ret == 0) { |
universe@826 | 138 | // if found, exit the search |
universe@826 | 139 | *result = (void*) node; |
universe@826 | 140 | work_size = 0; |
universe@826 | 141 | break; |
universe@826 | 142 | } else if (ret > 0) { |
universe@826 | 143 | // if children might contain the data, add them to the stack |
universe@826 | 144 | void *c = tree_children(node); |
universe@826 | 145 | while (c != NULL) { |
universe@833 | 146 | cx_array_simple_add(work, c); |
universe@826 | 147 | c = tree_next(c); |
universe@826 | 148 | } |
universe@826 | 149 | |
universe@826 | 150 | // remember this node in case no child is suitable |
universe@826 | 151 | if (ret_candidate < 0 || ret < ret_candidate) { |
universe@826 | 152 | candidate = (void *) node; |
universe@826 | 153 | ret_candidate = ret; |
universe@826 | 154 | } |
universe@826 | 155 | } |
universe@826 | 156 | } |
universe@826 | 157 | |
universe@826 | 158 | // not found, but was there a candidate? |
universe@826 | 159 | if (ret != 0 && candidate != NULL) { |
universe@826 | 160 | ret = ret_candidate; |
universe@826 | 161 | *result = candidate; |
universe@826 | 162 | } |
universe@826 | 163 | |
universe@826 | 164 | // free the working queue and return |
universe@826 | 165 | free(work); |
universe@826 | 166 | return ret; |
universe@826 | 167 | } |
universe@830 | 168 | |
universe@830 | 169 | static bool cx_tree_iter_valid(void const *it) { |
universe@830 | 170 | struct cx_tree_iterator_s const *iter = it; |
universe@830 | 171 | return iter->node != NULL; |
universe@830 | 172 | } |
universe@830 | 173 | |
universe@830 | 174 | static void *cx_tree_iter_current(void const *it) { |
universe@830 | 175 | struct cx_tree_iterator_s const *iter = it; |
universe@830 | 176 | return iter->node; |
universe@830 | 177 | } |
universe@830 | 178 | |
universe@830 | 179 | static void cx_tree_iter_next(void *it) { |
universe@830 | 180 | struct cx_tree_iterator_s *iter = it; |
universe@830 | 181 | // TODO: support mutating iterator |
universe@830 | 182 | |
universe@830 | 183 | // TODO: implement |
universe@830 | 184 | } |
universe@830 | 185 | |
universe@830 | 186 | CxTreeIterator cx_tree_iterator( |
universe@830 | 187 | void *root, |
universe@833 | 188 | bool visit_on_exit, |
universe@830 | 189 | ptrdiff_t loc_children, |
universe@830 | 190 | ptrdiff_t loc_next |
universe@830 | 191 | ) { |
universe@830 | 192 | CxTreeIterator iter; |
universe@830 | 193 | iter.loc_children = loc_children; |
universe@830 | 194 | iter.loc_next = loc_next; |
universe@833 | 195 | iter.visit_on_exit = visit_on_exit; |
universe@830 | 196 | |
universe@830 | 197 | // allocate stack |
universe@830 | 198 | iter.stack_capacity = 16; |
universe@830 | 199 | iter.stack = malloc(sizeof(void *) * 16); |
universe@830 | 200 | iter.depth = 0; |
universe@830 | 201 | |
universe@833 | 202 | // visit the root node |
universe@833 | 203 | iter.node = root; |
universe@833 | 204 | iter.counter = 1; |
universe@833 | 205 | iter.depth = 1; |
universe@833 | 206 | iter.stack[0] = root; |
universe@833 | 207 | iter.exiting = false; |
universe@830 | 208 | |
universe@830 | 209 | // assign base iterator functions |
universe@830 | 210 | iter.base.mutating = false; |
universe@830 | 211 | iter.base.remove = false; |
universe@830 | 212 | iter.base.current_impl = NULL; |
universe@830 | 213 | iter.base.valid = cx_tree_iter_valid; |
universe@830 | 214 | iter.base.next = cx_tree_iter_next; |
universe@830 | 215 | iter.base.current = cx_tree_iter_current; |
universe@830 | 216 | |
universe@830 | 217 | return iter; |
universe@830 | 218 | } |