rbtree.h

Go to the documentation of this file.

/*
 * rbtree.h -- generic red-black tree
 *
 * Copyright (c) 2001-2008, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 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.
 *
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * 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 LDNS_RBTREE_H_
#define LDNS_RBTREE_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ldns_rbnode_t ldns_rbnode_t;
struct ldns_rbnode_t {
        ldns_rbnode_t   *parent;
        ldns_rbnode_t   *left;
        ldns_rbnode_t   *right;
        const void *key;
        const void *data;
        uint8_t     color;
};
 
#define LDNS_RBTREE_NULL &ldns_rbtree_null_node
extern  ldns_rbnode_t   ldns_rbtree_null_node;
 
typedef struct ldns_rbtree_t ldns_rbtree_t;
struct ldns_rbtree_t {
        ldns_rbnode_t    *root;
 
        size_t       count;
 
        int (*cmp) (const void *, const void *);
};
 
ldns_rbtree_t *ldns_rbtree_create(int (*cmpf)(const void *, const void *));
 
void ldns_rbtree_free(ldns_rbtree_t *rbtree);
 
void ldns_rbtree_init(ldns_rbtree_t *rbtree, int (*cmpf)(const void *, const void *));
 
ldns_rbnode_t *ldns_rbtree_insert(ldns_rbtree_t *rbtree, ldns_rbnode_t *data);
 
void ldns_rbtree_insert_vref(ldns_rbnode_t *data, void *rbtree);
 
ldns_rbnode_t *ldns_rbtree_delete(ldns_rbtree_t *rbtree, const void *key);
 
ldns_rbnode_t *ldns_rbtree_search(ldns_rbtree_t *rbtree, const void *key);
 
int ldns_rbtree_find_less_equal(ldns_rbtree_t *rbtree, const void *key,
        ldns_rbnode_t **result);
 
ldns_rbnode_t *ldns_rbtree_first(const ldns_rbtree_t *rbtree);
 
ldns_rbnode_t *ldns_rbtree_last(const ldns_rbtree_t *rbtree);
 
ldns_rbnode_t *ldns_rbtree_next(ldns_rbnode_t *rbtree);
 
ldns_rbnode_t *ldns_rbtree_previous(ldns_rbnode_t *rbtree);
 
ldns_rbtree_t *ldns_rbtree_split(ldns_rbtree_t *tree, size_t elements);
 
void ldns_rbtree_join(ldns_rbtree_t *tree1, ldns_rbtree_t *tree2);
 
#define LDNS_RBTREE_FOR(node, type, rbtree) \
        for(node=(type)ldns_rbtree_first(rbtree); \
                (ldns_rbnode_t*)node != LDNS_RBTREE_NULL; \
                node = (type)ldns_rbtree_next((ldns_rbnode_t*)node))
 
void ldns_traverse_postorder(ldns_rbtree_t* tree,
        void (*func)(ldns_rbnode_t*, void*), void* arg);
 
#ifdef __cplusplus
}
#endif
 
#endif /* UTIL_RBTREE_H_ */