rbtree.h

Go to the documentation of this file.

/*
 * rbtree.h -- generic red-black tree
 *
 * Copyright (c) 2001-2007, 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 UTIL_RBTREE_H_
#define UTIL_RBTREE_H_

typedef struct rbnode_type rbnode_type;
struct rbnode_type {
    rbnode_type   *parent;
    rbnode_type   *left;
    rbnode_type   *right;
    const void    *key;
    uint8_t        color;
};

#define RBTREE_NULL &rbtree_null_node
extern  rbnode_type rbtree_null_node;

typedef struct rbtree_type rbtree_type;
struct rbtree_type {
    rbnode_type    *root;

    size_t          count;

    int (*cmp) (const void *, const void *);
};

rbtree_type *rbtree_create(int (*cmpf)(const void *, const void *));

void rbtree_init(rbtree_type *rbtree, int (*cmpf)(const void *, const void *));

rbnode_type *rbtree_insert(rbtree_type *rbtree, rbnode_type *data);

rbnode_type *rbtree_delete(rbtree_type *rbtree, const void *key);

rbnode_type *rbtree_search(rbtree_type *rbtree, const void *key);

int rbtree_find_less_equal(rbtree_type *rbtree, const void *key, 
    rbnode_type **result);

rbnode_type *rbtree_first(rbtree_type *rbtree);

rbnode_type *rbtree_last(rbtree_type *rbtree);

rbnode_type *rbtree_next(rbnode_type *rbtree);

rbnode_type *rbtree_previous(rbnode_type *rbtree);

#define RBTREE_FOR(node, type, rbtree) \
    for(node=(type)rbtree_first(rbtree); \
        (rbnode_type*)node != RBTREE_NULL; \
        node = (type)rbtree_next((rbnode_type*)node))

void traverse_postorder(rbtree_type* tree, void (*func)(rbnode_type*, void*),
    void* arg);
 
#endif /* UTIL_RBTREE_H_ */