158 lines
6.5 KiB
C
158 lines
6.5 KiB
C
/*
|
|
* Solanum: a slightly advanced ircd
|
|
* rb_radixtree.h: Dictionary-based storage.
|
|
*
|
|
* Copyright (c) 2007-2016 William Pitcock <nenolod -at- dereferenced.org>
|
|
* Copyright (c) 2007-2016 Jilles Tjoelker <jilles -at- stack.nl>
|
|
*
|
|
* 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.
|
|
*
|
|
* 3. The name of the author may not be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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 __rb_radixtree_H__
|
|
#define __rb_radixtree_H__
|
|
|
|
struct rb_radixtree; /* defined in src/rb_radixtree.c */
|
|
|
|
struct rb_radixtree_leaf; /* defined in src/rb_radixtree.c */
|
|
|
|
typedef struct rb_radixtree rb_radixtree;
|
|
typedef struct rb_radixtree_leaf rb_radixtree_leaf;
|
|
typedef struct rb_radixtree_iteration_state rb_radixtree_iteration_state;
|
|
|
|
/*
|
|
* struct rb_radixtree_iteration_state, private.
|
|
*/
|
|
struct rb_radixtree_iteration_state
|
|
{
|
|
rb_radixtree_leaf *cur, *next;
|
|
void *pspare[4];
|
|
int ispare[4];
|
|
};
|
|
|
|
/*
|
|
* this is a convenience macro for inlining iteration of dictionaries.
|
|
*/
|
|
#define RB_RADIXTREE_FOREACH(element, state, dict) \
|
|
for (rb_radixtree_foreach_start((dict), (state)); (element = rb_radixtree_foreach_cur((dict), (state))); rb_radixtree_foreach_next((dict), (state)))
|
|
|
|
#define RB_RADIXTREE_FOREACH_FROM(element, state, dict, key) \
|
|
for (rb_radixtree_foreach_start_from((dict), (state), (key)); (element = rb_radixtree_foreach_cur((dict), (state))); rb_radixtree_foreach_next((dict), (state)))
|
|
|
|
/*
|
|
* rb_radixtree_create() creates a new patricia tree of the defined resolution.
|
|
* compare_cb is the canonizing function.
|
|
*/
|
|
|
|
extern rb_radixtree *rb_radixtree_create(const char *name, void (*canonize_cb)(char *key));
|
|
|
|
/*
|
|
* rb_radixtree_shutdown() deallocates all heaps used in patricia trees. This is
|
|
* useful on embedded devices with little memory, and/or when you know you won't need
|
|
* any more patricia trees.
|
|
*/
|
|
extern void rb_radixtree_shutdown(void);
|
|
|
|
/*
|
|
* rb_radixtree_destroy() destroys all entries in a dtree, and also optionally calls
|
|
* a defined callback function to destroy any data attached to it.
|
|
*/
|
|
extern void rb_radixtree_destroy(rb_radixtree *dtree, void (*destroy_cb)(const char *key, void *data, void *privdata), void *privdata);
|
|
|
|
/*
|
|
* rb_radixtree_foreach() iterates all entries in a dtree, and also optionally calls
|
|
* a defined callback function to use any data attached to it.
|
|
*
|
|
* To shortcircuit iteration, return non-zero from the callback function.
|
|
*/
|
|
extern void rb_radixtree_foreach(rb_radixtree *dtree, int (*foreach_cb)(const char *key, void *data, void *privdata), void *privdata);
|
|
|
|
/*
|
|
* rb_radixtree_search() iterates all entries in a dtree, and also optionally calls
|
|
* a defined callback function to use any data attached to it.
|
|
*
|
|
* When the object is found, a non-NULL is returned from the callback, which results
|
|
* in that object being returned to the user.
|
|
*/
|
|
extern void *rb_radixtree_search(rb_radixtree *dtree, void *(*foreach_cb)(const char *key, void *data, void *privdata), void *privdata);
|
|
|
|
/*
|
|
* rb_radixtree_foreach_start() begins an iteration over all items
|
|
* keeping state in the given struct. If there is only one iteration
|
|
* in progress at a time, it is permitted to remove the current element
|
|
* of the iteration (but not any other element).
|
|
*/
|
|
extern void rb_radixtree_foreach_start(rb_radixtree *dtree, rb_radixtree_iteration_state *state);
|
|
|
|
/*
|
|
* rb_radixtree_foreach_start_from() begins an iteration over all items,
|
|
* starting with the item specified by `key`. If there is only one iteration
|
|
* in progress at a time, it is permitted to remove the current element
|
|
* of the iteration (but not any other element).
|
|
* Use NULL as a key to have it start at the beginning.
|
|
*/
|
|
extern void rb_radixtree_foreach_start_from(rb_radixtree *dtree, rb_radixtree_iteration_state *state, const char *key);
|
|
|
|
/*
|
|
* rb_radixtree_foreach_cur() returns the current element of the iteration,
|
|
* or NULL if there are no more elements.
|
|
*/
|
|
extern void *rb_radixtree_foreach_cur(rb_radixtree *dtree, rb_radixtree_iteration_state *state);
|
|
|
|
/*
|
|
* rb_radixtree_foreach_next() moves to the next element.
|
|
*/
|
|
extern void rb_radixtree_foreach_next(rb_radixtree *dtree, rb_radixtree_iteration_state *state);
|
|
|
|
/*
|
|
* rb_radixtree_add() adds a key->value entry to the patricia tree.
|
|
*/
|
|
extern int rb_radixtree_add(rb_radixtree *dtree, const char *key, void *data);
|
|
|
|
/*
|
|
* rb_radixtree_find() returns data from a dtree for key 'key'.
|
|
*/
|
|
extern void *rb_radixtree_retrieve(rb_radixtree *dtree, const char *key);
|
|
|
|
/*
|
|
* rb_radixtree_delete() deletes a key->value entry from the patricia tree.
|
|
*/
|
|
extern void *rb_radixtree_delete(rb_radixtree *dtree, const char *key);
|
|
|
|
/* Low-level functions */
|
|
rb_radixtree_leaf *rb_radixtree_elem_add(rb_radixtree *dtree, const char *key, void *data);
|
|
rb_radixtree_leaf *rb_radixtree_elem_find(rb_radixtree *dtree, const char *key, int fuzzy);
|
|
void rb_radixtree_elem_delete(rb_radixtree *dtree, rb_radixtree_leaf *elem);
|
|
const char *rb_radixtree_elem_get_key(rb_radixtree_leaf *elem);
|
|
void rb_radixtree_elem_set_data(rb_radixtree_leaf *elem, void *data);
|
|
void *rb_radixtree_elem_get_data(rb_radixtree_leaf *elem);
|
|
|
|
unsigned int rb_radixtree_size(rb_radixtree *dict);
|
|
void rb_radixtree_stats(rb_radixtree *dict, void (*cb)(const char *line, void *privdata), void *privdata);
|
|
void rb_radixtree_stats_walk(void (*cb)(const char *line, void *privdata), void *privdata);
|
|
|
|
#endif
|