webserver: comparison src/ucx/cx/tree.h

-:4a049e416021
+:82b60a8dd55c
 * Internal stack size.
 */
 size_t stack_size;
 /**
 * The current depth in the tree.
+* The node with which the iteration starts has depth 1.
 */
 size_t depth;
 };
 } CxTreeIterator;
 * The tree node to visit.
 */
 void *node;
 /**
 * The depth of the node.
+* The first visited node has depth 1.
 */
 size_t depth;
 /**
 * The next element in the queue or @c NULL.
 */
 * Releases internal memory of the given tree iterator.
 * @param iter the iterator
 */
 cx_attr_nonnull
 static inline void cxTreeIteratorDispose(CxTreeIterator *iter) {
-free(iter->stack);
+cxFreeDefault(iter->stack);
 iter->stack = NULL;
 }
 /**
 * Releases internal memory of the given tree visitor.
 cx_attr_nonnull
 static inline void cxTreeVisitorDispose(CxTreeVisitor *visitor) {
 struct cx_tree_visitor_queue_s *q = visitor->queue_next;
 while (q != NULL) {
 struct cx_tree_visitor_queue_s *next = q->next;
-free(q);
+cxFreeDefault(q);
 q = next;
 }
 }
 /**
 /**
 * Creates a depth-first iterator for a tree with the specified root node.
 *
 * @note A tree iterator needs to maintain a stack of visited nodes, which is
-* allocated using stdlib malloc().
+* allocated using the cxDefaultAllocator.
 * When the iterator becomes invalid, this memory is automatically released.
 * However, if you wish to cancel the iteration before the iterator becomes
 * invalid by itself, you MUST call cxTreeIteratorDispose() manually to release
 * the memory.
 *
 );
 /**
 * Creates a breadth-first iterator for a tree with the specified root node.
 *
-* @note A tree visitor needs to maintain a queue of to be visited nodes, which
+* @note A tree visitor needs to maintain a queue of to-be visited nodes, which
-* is allocated using stdlib malloc().
+* is allocated using the cxDefaultAllocator.
 * When the visitor becomes invalid, this memory is automatically released.
 * However, if you wish to cancel the iteration before the visitor becomes
 * invalid by itself, you MUST call cxTreeVisitorDispose() manually to release
 * the memory.
 *
 *
 * @note This function will also register an advanced destructor which
 * will free the nodes with the allocator's free() method.
 *
 * @param allocator the allocator that shall be used
-* (if @c NULL, a default stdlib allocator will be used)
+* (if @c NULL, the cxDefaultAllocator will be used)
 * @param create_func a function that creates new nodes
 * @param search_func a function that compares two nodes
 * @param search_data_func a function that compares a node with data
 * @param loc_parent offset in the node struct for the parent pointer
 * @param loc_children offset in the node struct for the children linked list
 * where neither the create function, the search function, nor a destructor
 * will be set. If you wish to use any of this functionality for the wrapped
 * tree, you need to specify those functions afterwards.
 *
 * @param allocator the allocator that was used for nodes of the wrapped tree
-* (if @c NULL, a default stdlib allocator is assumed)
+* (if @c NULL, the cxDefaultAllocator is assumed)
 * @param root the root node of the tree that shall be wrapped
 * @param loc_parent offset in the node struct for the parent pointer
 * @param loc_children offset in the node struct for the children linked list
 * @param loc_last_child optional offset in the node struct for the pointer to
 * the last child in the linked list (negative if there is no such pointer)
 cx_attr_nodiscard
 cx_attr_export
 size_t cxTreeSubtreeDepth(CxTree *tree, void *subtree_root);
 /**
+* Determines the size of the entire tree.
+*
+* @param tree the tree
+* @return the tree size, counting the root as one
+*/
+cx_attr_nonnull
+cx_attr_nodiscard
+static inline size_t cxTreeSize(CxTree *tree) {
+return tree->size;
+}
+/**
 * Determines the depth of the entire tree.
 *
 * @param tree the tree
 * @return the tree depth, counting the root as one
 */

Mercurial > hg > webserver / file comparison

comparison: src/ucx/cx/tree.h

src/ucx/cx/tree.h