tree.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2024 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef UCX_TREE_H
#define UCX_TREE_H
 
#include "common.h"
 
#include "collection.h"

struct cx_tree_visitor_queue_s {
    void *node;
    size_t depth;
    struct cx_tree_visitor_queue_s *next;
};

typedef struct cx_tree_combined_iterator_s {
    CX_ITERATOR_BASE;
    ptrdiff_t loc_children;
    ptrdiff_t loc_next;
    size_t counter;
    size_t depth;
    void *node;
    union {
        struct {
            void *node_next;
            void **stack;
            size_t stack_capacity;
        };
        struct {
            struct cx_tree_visitor_queue_s *queue_next;
            struct cx_tree_visitor_queue_s *queue_last;
        };
    };
    bool skip;
    bool visit_on_exit;
    bool exiting;
    bool use_dfs;
} CxTreeIterator;

CX_EXTERN CX_NONNULL
void cxTreeIteratorDispose(CxTreeIterator *iter);

#define cxTreeIteratorContinue(iterator) (iterator).skip = true; continue

CX_EXTERN CX_NONNULL
void cx_tree_add(void *parent, void *node,
        ptrdiff_t loc_parent, ptrdiff_t loc_children, ptrdiff_t loc_last_child,
        ptrdiff_t loc_prev, ptrdiff_t loc_next);

CX_EXTERN CX_NONNULL
void cx_tree_remove(void *node,
        ptrdiff_t loc_parent, ptrdiff_t loc_children, ptrdiff_t loc_last_child,
        ptrdiff_t loc_prev, ptrdiff_t loc_next);

#define CX_TREE_SEARCH_INFINITE_DEPTH 0

typedef int (*cx_tree_search_func)(const void *node, const void *data);

CX_EXTERN CX_NONNULL_ARG(4, 5) CX_ACCESS_W(5)
int cx_tree_search(const void *root, size_t max_depth,
        const void *data, cx_tree_search_func sfunc, void **result,
        ptrdiff_t loc_children, ptrdiff_t loc_next);

CX_EXTERN CX_NODISCARD
CxTreeIterator cx_tree_iterator(void *root, bool visit_on_exit,
        ptrdiff_t loc_children, ptrdiff_t loc_next);

CX_EXTERN CX_NODISCARD
CxTreeIterator cx_tree_visitor(void *root,
        ptrdiff_t loc_children, ptrdiff_t loc_next);

struct cx_tree_node_base_s {
    struct cx_tree_node_base_s *parent;
    struct cx_tree_node_base_s *children;
    struct cx_tree_node_base_s *last_child;
    struct cx_tree_node_base_s *prev;
    struct cx_tree_node_base_s *next;
};

typedef struct cx_tree_s {
    CX_COLLECTION_BASE;
    void *root;

    size_t node_size;

    ptrdiff_t loc_parent;

    ptrdiff_t loc_children;

    ptrdiff_t loc_last_child;

    ptrdiff_t loc_prev;

    ptrdiff_t loc_next;

    ptrdiff_t loc_data;
} CxTree;

#define CX_TREE_NODE(type) \
    type *parent; \
    type *children;\
    type *last_child;\
    type *prev;\
    type *next

#define cx_tree_node_layout(struct_name) \
    offsetof(struct_name, parent),\
    offsetof(struct_name, children),\
    offsetof(struct_name, last_child),\
    offsetof(struct_name, prev),  \
    offsetof(struct_name, next)

CX_EXTERN CX_NONNULL
void cxTreeDestroySubtree(CxTree *tree, void *node);
 

CX_INLINE
void cxTreeClear(CxTree *tree) {
    if (tree->root != NULL) {
        cxTreeDestroySubtree(tree, tree->root);
    }
}

CX_EXTERN
void cxTreeFree(CxTree *tree);

CX_EXTERN CX_NODISCARD  CX_MALLOC  CX_DEALLOC(cxTreeFree, 1)
CxTree *cxTreeCreate(const CxAllocator *allocator,
        size_t node_size, size_t elem_size, void *root, ptrdiff_t loc_data,
        ptrdiff_t loc_parent, ptrdiff_t loc_children, ptrdiff_t loc_last_child,
        ptrdiff_t loc_prev, ptrdiff_t loc_next);

CX_EXTERN CX_NONNULL_ARG(1, 2) CX_NODISCARD
void *cxTreeFindInSubtree(CxTree *tree, const void *data, void *subtree_root,
        size_t max_depth, bool use_dfs);

CX_INLINE CX_NONNULL CX_NODISCARD
void *cxTreeFind(CxTree *tree, const void *data, bool use_dfs) {
    if (tree->root == NULL) return NULL;
    return cxTreeFindInSubtree(tree, data, tree->root, 0, use_dfs);
}

CX_EXTERN CX_NONNULL CX_NODISCARD
void *cxTreeFindFastInSubtree(CxTree *tree, const void *data,
        cx_tree_search_func sfunc, void *subtree_root, size_t max_depth);

CX_INLINE CX_NONNULL CX_NODISCARD
void *cxTreeFindFast(CxTree *tree, const void *data, cx_tree_search_func sfunc) {
    return cxTreeFindFastInSubtree(tree, data, sfunc, tree->root, 0);
}

CX_EXTERN CX_NONNULL CX_NODISCARD
size_t cxTreeSubtreeSize(CxTree *tree, void *subtree_root);

CX_EXTERN CX_NONNULL CX_NODISCARD
size_t cxTreeSubtreeDepth(CxTree *tree, void *subtree_root);

CX_EXTERN CX_NONNULL CX_NODISCARD
size_t cxTreeSize(CxTree *tree);

CX_EXTERN CX_NONNULL CX_NODISCARD
size_t cxTreeDepth(CxTree *tree);

CX_EXTERN CX_NONNULL CX_NODISCARD
CxTreeIterator cxTreeIterateSubtree(CxTree *tree, void *node, bool visit_on_exit);

CX_EXTERN CX_NONNULL CX_NODISCARD
CxTreeIterator cxTreeVisitSubtree(CxTree *tree, void *node);

CX_EXTERN CX_NONNULL CX_NODISCARD
CxTreeIterator cxTreeIterate(CxTree *tree, bool visit_on_exit);

CX_EXTERN CX_NONNULL CX_NODISCARD
CxTreeIterator cxTreeVisit(CxTree *tree);

CX_EXTERN CX_NONNULL
void cxTreeSetParent(CxTree *tree, void *parent, void *child);

CX_EXTERN CX_NONNULL
void cxTreeAddNode(CxTree *tree, void *parent, void *child);

CX_EXTERN CX_NONNULL
void *cxTreeAddData(CxTree *tree, void *parent, const void *data);

CX_EXTERN CX_NODISCARD CX_NONNULL
void *cxTreeCreateNode(CxTree *tree, void *parent);

CX_EXTERN CX_NODISCARD CX_NONNULL
void *cxTreeCreateRoot(CxTree *tree);

CX_EXTERN CX_NODISCARD CX_NONNULL
void *cxTreeCreateRootData(CxTree *tree, const void *data);

CX_EXTERN CX_NONNULL_ARG(1) CX_NODISCARD
void *cxTreeSetRoot(CxTree *tree, void *new_root);

typedef void (*cx_tree_relink_func)(
        void *node,
        const void *old_parent,
        const void *new_parent
);

CX_EXTERN CX_NONNULL_ARG(1, 2)
int cxTreeRemoveNode(CxTree *tree, void *node, cx_tree_relink_func relink_func);

CX_EXTERN CX_NONNULL
void cxTreeRemoveSubtree(CxTree *tree, void *node);

CX_EXTERN CX_NONNULL_ARG(1, 2)
int cxTreeDestroyNode(CxTree *tree, void *node, cx_tree_relink_func relink_func);
 
#endif //UCX_TREE_H