Wed, 20 Mar 2024 23:31:41 +0100
add cx_tree_visitor()
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 | * \file tree.h |
universe@816 | 30 | * \brief Interface for tree implementations. |
universe@816 | 31 | * \author Mike Becker |
universe@816 | 32 | * \author Olaf Wintermann |
universe@816 | 33 | * \copyright 2-Clause BSD License |
universe@816 | 34 | */ |
universe@816 | 35 | |
universe@816 | 36 | #ifndef UCX_TREE_H |
universe@816 | 37 | #define UCX_TREE_H |
universe@816 | 38 | |
universe@816 | 39 | #include "common.h" |
universe@816 | 40 | |
universe@827 | 41 | #include "iterator.h" |
universe@827 | 42 | |
universe@816 | 43 | #ifdef __cplusplus |
universe@816 | 44 | extern "C" { |
universe@816 | 45 | #endif |
universe@816 | 46 | |
universe@827 | 47 | /** |
universe@845 | 48 | * A depth-first tree iterator. |
universe@827 | 49 | * |
universe@827 | 50 | * This iterator is not position-aware in a strict sense, as it does not assume a particular order of elements in the |
universe@827 | 51 | * tree. However, the iterator keeps track of the number of nodes it has passed in a counter variable. |
universe@827 | 52 | * Each node, regardless of the number of passes, is counted only once. |
universe@827 | 53 | * |
universe@827 | 54 | * @note Objects that are pointed to by an iterator are mutable through that iterator. However, if the |
universe@833 | 55 | * underlying data structure is mutated by other means than this iterator (e.g. elements added or removed), |
universe@833 | 56 | * the iterator becomes invalid (regardless of what cxIteratorValid() returns). |
universe@827 | 57 | * |
universe@827 | 58 | * @see CxIterator |
universe@827 | 59 | */ |
universe@827 | 60 | typedef struct cx_tree_iterator_s { |
universe@827 | 61 | /** |
universe@827 | 62 | * The base properties of this iterator. |
universe@827 | 63 | */ |
universe@827 | 64 | struct cx_iterator_base_s base; |
universe@827 | 65 | /** |
universe@833 | 66 | * Set to true, when the iterator shall visit a node again |
universe@833 | 67 | * when all it's children have been processed. |
universe@827 | 68 | */ |
universe@833 | 69 | bool visit_on_exit; |
universe@827 | 70 | /** |
universe@833 | 71 | * True, if this iterator is currently leaving the node. |
universe@827 | 72 | */ |
universe@833 | 73 | bool exiting; |
universe@827 | 74 | /** |
universe@827 | 75 | * Offset in the node struct for the children linked list. |
universe@827 | 76 | */ |
universe@845 | 77 | ptrdiff_t loc_children; |
universe@827 | 78 | /** |
universe@827 | 79 | * Offset in the node struct for the next pointer. |
universe@827 | 80 | */ |
universe@845 | 81 | ptrdiff_t loc_next; |
universe@827 | 82 | /** |
universe@827 | 83 | * The total number of distinct nodes that have been passed so far. |
universe@827 | 84 | */ |
universe@827 | 85 | size_t counter; |
universe@827 | 86 | /** |
universe@827 | 87 | * The currently observed node. |
universe@827 | 88 | * |
universe@827 | 89 | * This is the same what cxIteratorCurrent() would return. |
universe@827 | 90 | */ |
universe@827 | 91 | void *node; |
universe@827 | 92 | /** |
universe@840 | 93 | * Stores a copy of the next pointer of the visited node. |
universe@840 | 94 | * Allows freeing a node on exit without corrupting the iteration. |
universe@840 | 95 | */ |
universe@840 | 96 | void *next; |
universe@840 | 97 | /** |
universe@827 | 98 | * Internal stack. |
universe@827 | 99 | * Will be automatically freed once the iterator becomes invalid. |
universe@827 | 100 | * |
universe@827 | 101 | * If you want to discard the iterator before, you need to manually |
universe@827 | 102 | * call cxTreeIteratorDispose(). |
universe@827 | 103 | */ |
universe@827 | 104 | void **stack; |
universe@828 | 105 | /** |
universe@828 | 106 | * Internal capacity of the stack. |
universe@828 | 107 | */ |
universe@828 | 108 | size_t stack_capacity; |
universe@833 | 109 | union { |
universe@833 | 110 | /** |
universe@833 | 111 | * Internal stack size. |
universe@833 | 112 | */ |
universe@833 | 113 | size_t stack_size; |
universe@833 | 114 | /** |
universe@833 | 115 | * The current depth in the tree. |
universe@833 | 116 | */ |
universe@833 | 117 | size_t depth; |
universe@833 | 118 | }; |
universe@827 | 119 | } CxTreeIterator; |
universe@827 | 120 | |
universe@827 | 121 | /** |
universe@845 | 122 | * An element in a visitor queue. |
universe@845 | 123 | */ |
universe@845 | 124 | struct cx_tree_visitor_queue_s { |
universe@845 | 125 | /** |
universe@845 | 126 | * The tree node to visit. |
universe@845 | 127 | */ |
universe@845 | 128 | void *node; |
universe@845 | 129 | /** |
universe@845 | 130 | * The depth of the node. |
universe@845 | 131 | */ |
universe@845 | 132 | size_t depth; |
universe@845 | 133 | /** |
universe@845 | 134 | * The next element in the queue or \c NULL. |
universe@845 | 135 | */ |
universe@845 | 136 | struct cx_tree_visitor_queue_s *next; |
universe@845 | 137 | }; |
universe@845 | 138 | |
universe@845 | 139 | /** |
universe@845 | 140 | * A breadth-first tree iterator. |
universe@845 | 141 | * |
universe@845 | 142 | * This iterator needs to maintain a visitor queue that will be automatically freed once the iterator becomes invalid. |
universe@845 | 143 | * If you want to discard the iterator before, you MUST manually call cxTreeVisitorDispose(). |
universe@845 | 144 | * |
universe@845 | 145 | * This iterator is not position-aware in a strict sense, as it does not assume a particular order of elements in the |
universe@845 | 146 | * tree. However, the iterator keeps track of the number of nodes it has passed in a counter variable. |
universe@845 | 147 | * Each node, regardless of the number of passes, is counted only once. |
universe@845 | 148 | * |
universe@845 | 149 | * @note Objects that are pointed to by an iterator are mutable through that iterator. However, if the |
universe@845 | 150 | * underlying data structure is mutated by other means than this iterator (e.g. elements added or removed), |
universe@845 | 151 | * the iterator becomes invalid (regardless of what cxIteratorValid() returns). |
universe@845 | 152 | * |
universe@845 | 153 | * @see CxIterator |
universe@845 | 154 | */ |
universe@845 | 155 | typedef struct cx_tree_visitor_s { |
universe@845 | 156 | /** |
universe@845 | 157 | * The base properties of this iterator. |
universe@845 | 158 | */ |
universe@845 | 159 | struct cx_iterator_base_s base; |
universe@845 | 160 | /** |
universe@845 | 161 | * Offset in the node struct for the children linked list. |
universe@845 | 162 | */ |
universe@845 | 163 | ptrdiff_t loc_children; |
universe@845 | 164 | /** |
universe@845 | 165 | * Offset in the node struct for the next pointer. |
universe@845 | 166 | */ |
universe@845 | 167 | ptrdiff_t loc_next; |
universe@845 | 168 | /** |
universe@845 | 169 | * The total number of distinct nodes that have been passed so far. |
universe@845 | 170 | */ |
universe@845 | 171 | size_t counter; |
universe@845 | 172 | /** |
universe@845 | 173 | * The currently observed node. |
universe@845 | 174 | * |
universe@845 | 175 | * This is the same what cxIteratorCurrent() would return. |
universe@845 | 176 | */ |
universe@845 | 177 | void *node; |
universe@845 | 178 | /** |
universe@845 | 179 | * The current depth in the tree. |
universe@845 | 180 | */ |
universe@845 | 181 | size_t depth; |
universe@845 | 182 | /** |
universe@845 | 183 | * The next element in the visitor queue. |
universe@845 | 184 | */ |
universe@845 | 185 | struct cx_tree_visitor_queue_s *queue_next; |
universe@845 | 186 | /** |
universe@845 | 187 | * The last element in the visitor queue. |
universe@845 | 188 | */ |
universe@845 | 189 | struct cx_tree_visitor_queue_s *queue_last; |
universe@845 | 190 | } CxTreeVisitor; |
universe@845 | 191 | |
universe@845 | 192 | /** |
universe@827 | 193 | * Releases internal memory of the given tree iterator. |
universe@827 | 194 | * @param iter the iterator |
universe@827 | 195 | */ |
universe@845 | 196 | __attribute__((__nonnull__)) |
universe@827 | 197 | static inline void cxTreeIteratorDispose(CxTreeIterator *iter) { |
universe@827 | 198 | free(iter->stack); |
universe@835 | 199 | iter->stack = NULL; |
universe@827 | 200 | } |
universe@816 | 201 | |
universe@822 | 202 | /** |
universe@845 | 203 | * Releases internal memory of the given tree visitor. |
universe@845 | 204 | * @param visitor the visitor |
universe@845 | 205 | */ |
universe@845 | 206 | __attribute__((__nonnull__)) |
universe@845 | 207 | static inline void cxTreeVisitorDispose(CxTreeVisitor *visitor) { |
universe@845 | 208 | struct cx_tree_visitor_queue_s *q = visitor->queue_next; |
universe@845 | 209 | while (q != NULL) { |
universe@845 | 210 | struct cx_tree_visitor_queue_s *next = q->next; |
universe@845 | 211 | free(q); |
universe@845 | 212 | q = next; |
universe@845 | 213 | } |
universe@845 | 214 | } |
universe@845 | 215 | |
universe@845 | 216 | /** |
universe@822 | 217 | * Links a node to a (new) parent. |
universe@822 | 218 | * |
universe@822 | 219 | * If the node has already a parent, it is unlinked, first. |
universe@845 | 220 | * If the parent has children already, the node is \em prepended to the list |
universe@826 | 221 | * of all currently existing children. |
universe@822 | 222 | * |
universe@822 | 223 | * @param parent the parent node |
universe@822 | 224 | * @param node the node that shall be linked |
universe@822 | 225 | * @param loc_parent offset in the node struct for the parent pointer |
universe@822 | 226 | * @param loc_children offset in the node struct for the children linked list |
universe@822 | 227 | * @param loc_prev offset in the node struct for the prev pointer |
universe@822 | 228 | * @param loc_next offset in the node struct for the next pointer |
universe@822 | 229 | * @see cx_tree_unlink() |
universe@822 | 230 | */ |
universe@816 | 231 | __attribute__((__nonnull__)) |
universe@816 | 232 | void cx_tree_link( |
universe@816 | 233 | void * restrict parent, |
universe@816 | 234 | void * restrict node, |
universe@816 | 235 | ptrdiff_t loc_parent, |
universe@816 | 236 | ptrdiff_t loc_children, |
universe@816 | 237 | ptrdiff_t loc_prev, |
universe@816 | 238 | ptrdiff_t loc_next |
universe@816 | 239 | ); |
universe@816 | 240 | |
universe@822 | 241 | /** |
universe@822 | 242 | * Unlinks a node from its parent. |
universe@822 | 243 | * |
universe@822 | 244 | * If the node has no parent, this function does nothing. |
universe@822 | 245 | * |
universe@822 | 246 | * @param node the node that shall be unlinked from its parent |
universe@822 | 247 | * @param loc_parent offset in the node struct for the parent pointer |
universe@822 | 248 | * @param loc_children offset in the node struct for the children linked list |
universe@822 | 249 | * @param loc_prev offset in the node struct for the prev pointer |
universe@822 | 250 | * @param loc_next offset in the node struct for the next pointer |
universe@822 | 251 | * @see cx_tree_link() |
universe@822 | 252 | */ |
universe@816 | 253 | __attribute__((__nonnull__)) |
universe@816 | 254 | void cx_tree_unlink( |
universe@816 | 255 | void *node, |
universe@816 | 256 | ptrdiff_t loc_parent, |
universe@816 | 257 | ptrdiff_t loc_children, |
universe@816 | 258 | ptrdiff_t loc_prev, |
universe@816 | 259 | ptrdiff_t loc_next |
universe@816 | 260 | ); |
universe@816 | 261 | |
universe@823 | 262 | /** |
universe@823 | 263 | * Function pointer for a search function. |
universe@823 | 264 | * |
universe@823 | 265 | * A function of this kind shall check if the specified \p node |
universe@823 | 266 | * contains the given \p data or if one of the children might contain |
universe@823 | 267 | * the data. |
universe@823 | 268 | * |
universe@826 | 269 | * The function should use the returned integer to indicate how close the |
universe@826 | 270 | * match is, where a negative number means that it does not match at all. |
universe@826 | 271 | * |
universe@823 | 272 | * For example if a tree stores file path information, a node that is |
universe@823 | 273 | * describing a parent directory of a filename that is searched, shall |
universe@826 | 274 | * return a positive number to indicate that a child node might contain the |
universe@826 | 275 | * searched item. On the other hand, if the node denotes a path that is not a |
universe@826 | 276 | * prefix of the searched filename, the function would return -1 to indicate |
universe@826 | 277 | * that * the search does not need to be continued in that branch. |
universe@823 | 278 | * |
universe@823 | 279 | * @param node the node that is currently investigated |
universe@823 | 280 | * @param data the data that is searched for |
universe@823 | 281 | * |
universe@823 | 282 | * @return 0 if the node contains the data, |
universe@826 | 283 | * positive if one of the children might contain the data, |
universe@826 | 284 | * negative if neither the node, nor the children contains the data |
universe@823 | 285 | */ |
universe@824 | 286 | typedef int (*cx_tree_search_func)(void const *node, void const* data); |
universe@823 | 287 | |
universe@826 | 288 | |
universe@826 | 289 | /** |
universe@826 | 290 | * Searches for data in a tree. |
universe@826 | 291 | * |
universe@826 | 292 | * When the data cannot be found exactly, the search function might return a |
universe@826 | 293 | * closest result which might be a good starting point for adding a new node |
universe@826 | 294 | * to the tree. |
universe@826 | 295 | * |
universe@826 | 296 | * Depending on the tree structure it is not necessarily guaranteed that the |
universe@826 | 297 | * "closest" match is uniquely defined. This function will search for a node |
universe@826 | 298 | * with the best match according to the \p sfunc (meaning: the return value of |
universe@826 | 299 | * \p sfunc which is closest to zero). If that is also ambiguous, an arbitrary |
universe@826 | 300 | * node matching the criteria is returned. |
universe@826 | 301 | * |
universe@826 | 302 | * @param root the root node |
universe@826 | 303 | * @param data the data to search for |
universe@826 | 304 | * @param sfunc the search function |
universe@826 | 305 | * @param result where the result shall be stored |
universe@826 | 306 | * @param loc_children offset in the node struct for the children linked list |
universe@826 | 307 | * @param loc_next offset in the node struct for the next pointer |
universe@826 | 308 | * @return zero if the node was found exactly, positive if a node was found that |
universe@826 | 309 | * could contain the node (but doesn't right now), negative if the tree does not |
universe@826 | 310 | * contain any node that might be related to the searched data |
universe@826 | 311 | */ |
universe@826 | 312 | __attribute__((__nonnull__)) |
universe@826 | 313 | int cx_tree_search( |
universe@826 | 314 | void const *root, |
universe@826 | 315 | void const *data, |
universe@826 | 316 | cx_tree_search_func sfunc, |
universe@826 | 317 | void **result, |
universe@826 | 318 | ptrdiff_t loc_children, |
universe@826 | 319 | ptrdiff_t loc_next |
universe@826 | 320 | ); |
universe@826 | 321 | |
universe@828 | 322 | /** |
universe@845 | 323 | * Creates a depth-first iterator for a tree with the specified root node. |
universe@828 | 324 | * |
universe@828 | 325 | * @note A tree iterator needs to maintain a stack of visited nodes, which is allocated using stdlib malloc(). |
universe@828 | 326 | * When the iterator becomes invalid, this memory is automatically released. However, if you wish to cancel the |
universe@828 | 327 | * iteration before the iterator becomes invalid by itself, you MUST call cxTreeIteratorDispose() manually to release |
universe@828 | 328 | * the memory. |
universe@828 | 329 | * |
universe@845 | 330 | * @remark The returned iterator does not support cxIteratorFlagRemoval(). |
universe@828 | 331 | * |
universe@828 | 332 | * @param root the root node |
universe@833 | 333 | * @param visit_on_exit set to true, when the iterator shall visit a node again after processing all children |
universe@828 | 334 | * @param loc_children offset in the node struct for the children linked list |
universe@828 | 335 | * @param loc_next offset in the node struct for the next pointer |
universe@828 | 336 | * @return the new tree iterator |
universe@828 | 337 | * @see cxTreeIteratorDispose() |
universe@828 | 338 | */ |
universe@828 | 339 | __attribute__((__nonnull__)) |
universe@830 | 340 | CxTreeIterator cx_tree_iterator( |
universe@830 | 341 | void *root, |
universe@833 | 342 | bool visit_on_exit, |
universe@828 | 343 | ptrdiff_t loc_children, |
universe@828 | 344 | ptrdiff_t loc_next |
universe@828 | 345 | ); |
universe@828 | 346 | |
universe@845 | 347 | /** |
universe@845 | 348 | * Creates a breadth-first iterator for a tree with the specified root node. |
universe@845 | 349 | * |
universe@845 | 350 | * @note A tree visitor needs to maintain a queue of to be visited nodes, which is allocated using stdlib malloc(). |
universe@845 | 351 | * When the visitor becomes invalid, this memory is automatically released. However, if you wish to cancel the |
universe@845 | 352 | * iteration before the visitor becomes invalid by itself, you MUST call cxTreeVisitorDispose() manually to release |
universe@845 | 353 | * the memory. |
universe@845 | 354 | * |
universe@845 | 355 | * @remark The returned iterator does not support cxIteratorFlagRemoval(). |
universe@845 | 356 | * |
universe@845 | 357 | * @param root the root node |
universe@845 | 358 | * @param loc_children offset in the node struct for the children linked list |
universe@845 | 359 | * @param loc_next offset in the node struct for the next pointer |
universe@845 | 360 | * @return the new tree visitor |
universe@845 | 361 | * @see cxTreeVisitorDispose() |
universe@845 | 362 | */ |
universe@845 | 363 | __attribute__((__nonnull__)) |
universe@845 | 364 | CxTreeVisitor cx_tree_visitor( |
universe@845 | 365 | void *root, |
universe@845 | 366 | ptrdiff_t loc_children, |
universe@845 | 367 | ptrdiff_t loc_next |
universe@845 | 368 | ); |
universe@845 | 369 | |
universe@816 | 370 | #ifdef __cplusplus |
universe@816 | 371 | } // extern "C" |
universe@816 | 372 | #endif |
universe@816 | 373 | |
universe@816 | 374 | #endif //UCX_TREE_H |