rbtree.h

/* etcpal/rbtree.h: C-language red-black tree implementation. .his 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 ETCPAL_RBTREE_H_
#define ETCPAL_RBTREE_H_
 
#include <stddef.h>
#include "etcpal/error.h"
 
#ifndef ETCPAL_RB_ITER_MAX_HEIGHT
#define ETCPAL_RB_ITER_MAX_HEIGHT 64
#endif
 
typedef struct EtcPalRbNode EtcPalRbNode;
typedef struct EtcPalRbTree EtcPalRbTree;
typedef int (*EtcPalRbTreeNodeCmpFunc)(const EtcPalRbTree* self, const void* value_a, const void* value_b);
 
typedef void (*EtcPalRbTreeNodeFunc)(const EtcPalRbTree* self, EtcPalRbNode* node);
 
typedef EtcPalRbNode* (*EtcPalRbNodeAllocFunc)(void);
 
typedef void (*EtcPalRbNodeDeallocFunc)(EtcPalRbNode* node);
 
struct EtcPalRbNode
{
  int           red;     
  EtcPalRbNode* link[2]; 
  void*         value;   
};
 
struct EtcPalRbTree
{
  EtcPalRbNode*           root;      
  EtcPalRbTreeNodeCmpFunc cmp;       
  size_t                  size;      
  EtcPalRbNodeAllocFunc   alloc_f;   
  EtcPalRbNodeDeallocFunc dealloc_f; 
  void*                   info;      
};
 
typedef struct EtcPalRbIter
{
  EtcPalRbTree* tree;                            
  EtcPalRbNode* node;                            
  EtcPalRbNode* path[ETCPAL_RB_ITER_MAX_HEIGHT]; 
  size_t        top;                             
  void*         info;                            
} EtcPalRbIter;
 
#ifdef __cplusplus
extern "C" {
#endif
 
int  etcpal_rbtree_node_cmp_ptr_cb(const EtcPalRbTree* self, const void* a, const void* b);
void etcpal_rbtree_node_dealloc_cb(const EtcPalRbTree* self, EtcPalRbNode* node);
 
EtcPalRbNode* etcpal_rbnode_init(EtcPalRbNode* self, void* value);
 
EtcPalRbTree*  etcpal_rbtree_init(EtcPalRbTree*           self,
                                  EtcPalRbTreeNodeCmpFunc node_cmp_cb,
                                  EtcPalRbNodeAllocFunc   alloc_f,
                                  EtcPalRbNodeDeallocFunc dealloc_f);
void*          etcpal_rbtree_find(EtcPalRbTree* self, const void* value);
etcpal_error_t etcpal_rbtree_insert(EtcPalRbTree* self, void* value);
etcpal_error_t etcpal_rbtree_remove(EtcPalRbTree* self, const void* value);
etcpal_error_t etcpal_rbtree_clear(EtcPalRbTree* self);
size_t         etcpal_rbtree_size(EtcPalRbTree* self);
 
etcpal_error_t etcpal_rbtree_insert_node(EtcPalRbTree* self, EtcPalRbNode* node);
etcpal_error_t etcpal_rbtree_remove_with_cb(EtcPalRbTree* self, const void* value, EtcPalRbTreeNodeFunc node_cb);
etcpal_error_t etcpal_rbtree_clear_with_cb(EtcPalRbTree* self, EtcPalRbTreeNodeFunc node_cb);
 
int etcpal_rbtree_test(EtcPalRbTree* self, EtcPalRbNode* root);
 
EtcPalRbIter* etcpal_rbiter_init(EtcPalRbIter* self);
void*         etcpal_rbiter_first(EtcPalRbIter* self, EtcPalRbTree* tree);
void*         etcpal_rbiter_last(EtcPalRbIter* self, EtcPalRbTree* tree);
void*         etcpal_rbiter_next(EtcPalRbIter* self);
void*         etcpal_rbiter_prev(EtcPalRbIter* self);
void*         etcpal_rbiter_lower_bound(EtcPalRbIter* self, EtcPalRbTree* tree, const void* value);
void*         etcpal_rbiter_upper_bound(EtcPalRbIter* self, EtcPalRbTree* tree, const void* value);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_RBTREE_H_ */