lwpa_rbtree.h

/* lwpa_rbtree.h: C-language red-black tree implementation. This module is
 * based heavily on a public-domain red-black tree implementation. The license
 * of that implementation follows as it was when retrieved from Github on
 * 2018-02-28.
 *
 ******************************************************************************
 * Based on Julienne Walker's <http://eternallyconfuzzled.com/> rb_tree
 * implementation.
 *
 * Modified by Mirek Rusin <http://github.com/mirek/rb_tree>.
 *
 * This is free and unencumbered software released into the public domain.
 *
 * Anyone is free to copy, modify, publish, use, compile, sell, or
 * distribute this software, either in source code form or as a compiled
 * binary, for any purpose, commercial or non-commercial, and by any
 * means.
 *
 * In jurisdictions that recognize copyright laws, the author or authors
 * of this software dedicate any and all copyright interest in the
 * software to the public domain. We make this dedication for the benefit
 * of the public at large and to the detriment of our heirs and
 * successors. We intend this dedication to be an overt act of
 * relinquishment in perpetuity of all present and future rights to this
 * software under copyright law.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * For more information, please refer to <http://unlicense.org/>
 */
#ifndef _LWPA_RBTREE_H_
#define _LWPA_RBTREE_H_
 
#include <stddef.h>
 
#ifndef RB_ITER_MAX_HEIGHT
#define RB_ITER_MAX_HEIGHT 64
#endif
 
typedef struct LwpaRbNode LwpaRbNode;
typedef struct LwpaRbTree LwpaRbTree;
 
typedef int (*rb_tree_node_cmp_f)(const LwpaRbTree *self, const LwpaRbNode *node_a, const LwpaRbNode *node_b);
 
typedef void (*rb_tree_node_f)(const LwpaRbTree *self, LwpaRbNode *node);
 
typedef LwpaRbNode *(*rb_node_alloc_f)();
 
typedef void (*rb_node_dealloc_f)(LwpaRbNode *node);
 
struct LwpaRbNode
{
  int red;             
  LwpaRbNode *link[2]; 
  void *value;         
};
 
struct LwpaRbTree
{
  LwpaRbNode *root;       
  rb_tree_node_cmp_f cmp; 
  size_t size;            
  rb_node_alloc_f alloc_f;
  rb_node_dealloc_f dealloc_f;
  void *info; 
};
 
typedef struct LwpaRbIter
{
  LwpaRbTree *tree; 
  LwpaRbNode *node; 
  LwpaRbNode *path[RB_ITER_MAX_HEIGHT];
  size_t top; 
  void *info; 
} LwpaRbIter;
 
#ifdef __cplusplus
extern "C" {
#endif
 
int rb_tree_node_cmp_ptr_cb(const LwpaRbTree *self, const LwpaRbNode *a, const LwpaRbNode *b);
void rb_tree_node_dealloc_cb(const LwpaRbTree *self, LwpaRbNode *node);
 
LwpaRbNode *rb_node_init(LwpaRbNode *self, void *value);
 
LwpaRbTree *rb_tree_init(LwpaRbTree *self, rb_tree_node_cmp_f cmp, rb_node_alloc_f alloc_f,
                         rb_node_dealloc_f dealloc_f);
void *rb_tree_find(LwpaRbTree *self, void *value);
int rb_tree_insert(LwpaRbTree *self, void *value);
int rb_tree_remove(LwpaRbTree *self, void *value);
int rb_tree_clear(LwpaRbTree *self);
size_t rb_tree_size(LwpaRbTree *self);
 
int rb_tree_insert_node(LwpaRbTree *self, LwpaRbNode *node);
int rb_tree_remove_with_cb(LwpaRbTree *self, void *value, rb_tree_node_f node_cb);
int rb_tree_clear_with_cb(LwpaRbTree *self, rb_tree_node_f node_cb);
 
int rb_tree_test(LwpaRbTree *self, LwpaRbNode *root);
 
LwpaRbIter *rb_iter_init(LwpaRbIter *self);
void *rb_iter_first(LwpaRbIter *self, LwpaRbTree *tree);
void *rb_iter_last(LwpaRbIter *self, LwpaRbTree *tree);
void *rb_iter_next(LwpaRbIter *self);
void *rb_iter_prev(LwpaRbIter *self);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _LWPA_RBTREE_H_ */