1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/*
* libpfxtree - Delwink prefix tree library
* Copyright (C) 2015, 2017, 2020 Delwink, LLC
*
* Redistributions, modified or unmodified, in whole or in part, must retain
* applicable copyright or other legal privilege notices, these conditions, and
* the following license terms and disclaimer. Subject to these conditions,
* the holder(s) of copyright or other legal privileges, author(s) or
* assembler(s), and contributors of this work hereby grant to any person who
* obtains a copy of this work in any form:
*
* 1. Permission to reproduce, modify, distribute, publish, sell, sublicense,
* use, and/or otherwise deal in the licensed material without restriction.
*
* 2. A perpetual, worldwide, non-exclusive, royalty-free, irrevocable patent
* license to reproduce, modify, distribute, publish, sell, use, and/or
* otherwise deal in the licensed material without restriction, for any and all
* patents:
*
* a. Held by each such holder of copyright or other legal privilege,
* author or assembler, or contributor, necessarily infringed by the
* contributions alone or by combination with the work, of that privilege
* holder, author or assembler, or contributor.
*
* b. Necessarily infringed by the work at the time that holder of
* copyright or other privilege, author or assembler, or contributor made
* any contribution to the work.
*
* NO WARRANTY OF ANY KIND IS IMPLIED BY, OR SHOULD BE INFERRED FROM, THIS
* LICENSE OR THE ACT OF DISTRIBUTION UNDER THE TERMS OF THIS LICENSE,
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR
* A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS,
* ASSEMBLERS, OR HOLDERS OF COPYRIGHT OR OTHER LEGAL PRIVILEGE BE LIABLE FOR
* ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN ACTION OF CONTRACT, TORT,
* OR OTHERWISE ARISING FROM, OUT OF, OR IN CONNECTION WITH THE WORK OR THE USE
* OF OR OTHER DEALINGS IN THE WORK.
*/
/**
* @file pfxtree.h
* @version 0.4
* @date 2/25/2020
* @author David McMackins II
* @brief Delwink prefix tree (trie) library
*/
#ifndef DELWINK_PFXTREE_H
#define DELWINK_PFXTREE_H
#include <stdbool.h>
#ifdef __cplusplus
# define __BEGIN_DECLS extern "C" {
# define __END_DECLS }
#else
# define __BEGIN_DECLS
# define __END_DECLS
#endif
__BEGIN_DECLS
enum pt_data_type
{
PT_TYPE_INT,
PT_TYPE_PTR
};
/**
* @brief Error codes possibly returned by functions in this library.
*/
enum pt_error
{
PT_EALLOC = -1,
PT_ENOWORD = -2
};
union pt_data
{
int i;
void *p;
};
/**
* @brief A node in a prefix tree.
*/
typedef struct _pt_trie
{
union pt_data data;
struct _pt_trie *parent;
struct _pt_trie *children;
struct _pt_trie *next;
int ch;
enum pt_data_type type;
} PrefixTree;
/**
* @brief Creates a new prefix tree.
* @return Pointer to the root node of the tree or NULL on failure.
*/
PrefixTree *
pt_new(void);
/**
* @brief Frees an allocated prefix tree (and its child nodes).
* @param self The tree to free.
*/
void
pt_free(PrefixTree *self);
/**
* @brief Frees an allocated prefix tree (and its child nodes) and optionally
* its referenced data.
* @param self The tree to free.
* @param free_data Whether to free memory pointed to by the data (if pointer).
*/
void
pt_deep_free(PrefixTree *self, bool free_data);
/**
* @brief Adds a new word to a prefix tree with integer data.
* @param self The tree to which to add the word.
* @param word The word to be added.
* @param data A number to be associated with the word.
* @return Nonzero if an error occurred.
*/
int
pt_add(PrefixTree *self, const char *word, int data);
/**
* @brief Adds a new word to a prefix tree with pointer data.
* @param self The tree to which to add the word.
* @param word The word to be added.
* @param data A pointer to be associated with the word.
* @return Nonzero if an error occurred.
*/
int
pt_add_p(PrefixTree *self, const char *word, void *data);
/**
* @brief Deletes a word from a prefix tree.
* @param self The tree from which to delete the word.
* @param word The word to be deleted.
* @return Nonzero if word not found.
*/
int
pt_del(PrefixTree *self, const char *word);
/**
* @brief Gets the integer data from a prefix tree node.
* @param self The node from which to get the data.
* @return self's data (default 0).
*/
int
pt_data(const PrefixTree *self);
/**
* @brief Gets the pointer data from a prefix tree node.
* @param self The node from which to get the data.
* @return self's data (default NULL).
*/
void *
pt_data_p(const PrefixTree *self);
/**
* @brief Gets the type of the data stored in the prefix tree node.
* @param self The node whose type is to be examined.
* @return 'i' if integer, 'p' if pointer, or '\0' if no data.
*/
int
pt_data_type(const PrefixTree *self);
/**
* @brief Searches for a word in a prefix tree.
* @param root The node from which to begin the search.
* @param word The word for which to search.
* @return Pointer to the data-storing node of the word or NULL if not found.
*/
const PrefixTree *
pt_search(const PrefixTree *root, const char *word);
struct pt_entry
{
const char *word;
union pt_data data;
enum pt_data_type type;
};
/**
* @brief Run an operation for each word in a prefix tree.
* @param root The node from which to begin the search.
* @param f The operation to be run, accepting the word, its data, and
* and arbitrary data; returns nonzero to break the loop.
* @param data Data to be passed to f.
* @return Nonzero on error, or nonzero return from f.
*/
int
pt_foreach(const PrefixTree *root, int (*f)(const struct pt_entry *,void *),
void *data);
/**
* @brief Checks the current version of the library.
* @return A version string for this libpfxtree installation.
*/
const char *
pt_version(void);
__END_DECLS
#endif
|
