ucx: comparison src/cx/tree.h

-:cdc49211d87f
+:39aa4f106a71
 * @param loc_children offset in the node struct for the children linked list
 * @param loc_next offset in the node struct for the next pointer
 * @return the new tree iterator
 * @see cxTreeIteratorDispose()
 */
-__attribute__((__nonnull__))
 CxTreeIterator cx_tree_iterator(
 void *root,
 bool visit_on_exit,
 ptrdiff_t loc_children,
 ptrdiff_t loc_next
 * @param loc_children offset in the node struct for the children linked list
 * @param loc_next offset in the node struct for the next pointer
 * @return the new tree visitor
 * @see cxTreeVisitorDispose()
 */
-__attribute__((__nonnull__))
 CxTreeVisitor cx_tree_visitor(
 void *root,
 ptrdiff_t loc_children,
 ptrdiff_t loc_next
 );
 * A function to compare two nodes.
 */
 cx_tree_search_func search;
 /**
+* A function to compare a node with data.
+*/
+cx_tree_search_data_func search_data;
+/**
 * The number of currently stored elements.
 */
 size_t size;
 /**
 * will free the nodes with the allocator's free() method.
 *
 * @param allocator the allocator that shall 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
 * @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)
 * @param loc_prev offset in the node struct for the prev pointer
 __attribute__((__nonnull__, __warn_unused_result__))
 CxTree *cxTreeCreate(
 const CxAllocator *allocator,
 cx_tree_node_create_func create_func,
 cx_tree_search_func search_func,
+cx_tree_search_data_func search_data_func,
 ptrdiff_t loc_parent,
 ptrdiff_t loc_children,
 ptrdiff_t loc_last_child,
 ptrdiff_t loc_prev,
 ptrdiff_t loc_next
 * will free the nodes with the allocator's free() method.
 *
 * @param allocator the allocator that shall 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
 * @return the new tree
 * @see cxTreeCreate()
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 static inline CxTree *cxTreeCreateSimple(
 const CxAllocator *allocator,
 cx_tree_node_create_func create_func,
-cx_tree_search_func search_func
+cx_tree_search_func search_func,
+cx_tree_search_data_func search_data_func
 ) {
 return cxTreeCreate(
 allocator,
 create_func,
 search_func,
+search_data_func,
 cx_tree_node_base_layout
 );
 }
 /**
 * Creates a new tree structure based on an existing tree.
 *
-* The specified \p allocator will be used for creating the tree struct
+* The specified \p allocator will be used for creating the tree struct.
-* and SHALL be used by \p create_func to allocate memory for the nodes.
 *
 * \attention This function will create an incompletely defined tree structure
 * 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.
 * @return the new tree
 * @see cxTreeCreate()
 */
 __attribute__((__nonnull__, __warn_unused_result__))
 CxTree *cxTreeCreateWrapped(
+const CxAllocator *allocator,
 void *root,
 ptrdiff_t loc_parent,
 ptrdiff_t loc_children,
 ptrdiff_t loc_last_child,
 ptrdiff_t loc_prev,
 }
 /**
 * Searches the data in the specified tree.
 *
-* \remark For this function to work, the tree needs a specified search
+* \remark For this function to work, the tree needs a specified \c search_data
 * function, which might not be available wrapped trees
 * (see #cxTreeCreateWrapped()).
 *
 * @param tree the tree
 * @param data the data to search for
 * Searches the data in the specified subtree.
 *
 * \note When \p subtree_root is not part of the \p tree, the behavior is
 * undefined.
 *
-* \remark For this function to work, the tree needs a specified search
+* \remark For this function to work, the tree needs a specified \c search_data
 * function, which might not be the case for wrapped trees
 * (see #cxTreeCreateWrapped()).
 *
 * @param tree the tree
 * @param data the data to search for
 */
 __attribute__((__nonnull__))
 size_t cxTreeSubtreeDepth(CxTree *tree, void *subtree_root);
 /**
+* Determines the depth of the entire tree.
+*
+* @param tree the tree
+* @return the tree depth, counting the root as one
+*/
+__attribute__((__nonnull__))
+size_t cxTreeDepth(CxTree *tree);
+/**
 * Creates a depth-first iterator for the specified tree.
 *
 * @param tree the tree to iterate
 * @param visit_on_exit true, if the iterator shall visit a node again when
 * leaving the sub-tree
 void *parent,
 const void *data
 );
 /**
-* Removes a node from the tree.
+* Removes a node and it's subtree from the tree.
 *
 * If the node is not part of the tree, the behavior is undefined.
 *
-* \note The destructor function, if any, will \em not be invoked.
+* \note The destructor function, if any, will \em not be invoked. That means
+* you will need to free the removed subtree by yourself, eventually.
 *
 * @param tree the tree
 * @param node the node to remove
 */
 __attribute__((__nonnull__))
-static inline void cxTreeRemove(
+void cxTreeRemove(CxTree *tree, void *node);
-CxTree *tree,
-void *node) {
-cx_tree_unlink(node, cx_tree_node_layout(tree));
-tree->size--;
-}
 #ifdef __cplusplus
 } // extern "C"
 #endif

Mercurial > hg > ucx / file comparison

comparison: src/cx/tree.h

src/cx/tree.h