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
|
/****************************************************************************
* bfs *
* Copyright (C) 2019 Tavian Barnes <tavianator@tavianator.com> *
* *
* Permission to use, copy, modify, and/or distribute this software for any *
* purpose with or without fee is hereby granted. *
* *
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES *
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF *
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR *
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES *
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN *
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF *
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. *
****************************************************************************/
#ifndef BFS_TRIE_H
#define BFS_TRIE_H
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
/**
* A trie that holds a set of fixed- or variable-length strings.
*/
struct trie {
uintptr_t root;
};
/**
* A leaf of a trie.
*/
struct trie_leaf {
/**
* An arbitrary value associated with this leaf.
*/
const void *value;
/**
* The length of the key in bytes.
*/
size_t length;
/**
* The key itself, stored inline.
*/
char key[];
};
/**
* Initialize an empty trie.
*/
void trie_init(struct trie *trie);
/**
* Find the leaf for a string key.
*
* @param trie
* The trie to search.
* @param key
* The key to look up.
* @return
* The found leaf, or NULL if the key is not present.
*/
struct trie_leaf *trie_find_str(const struct trie *trie, const char *key);
/**
* Find the leaf for a fixed-size key.
*
* @param trie
* The trie to search.
* @param key
* The key to look up.
* @param length
* The length of the key in bytes.
* @return
* The found leaf, or NULL if the key is not present.
*/
struct trie_leaf *trie_find_mem(const struct trie *trie, const void *key, size_t length);
/**
* Insert a string key into the trie.
*
* @param trie
* The trie to modify.
* @param key
* The key to insert.
* @return
* The inserted leaf, or NULL on failure.
*/
struct trie_leaf *trie_insert_str(struct trie *trie, const char *key);
/**
* Insert a fixed-size key into the trie.
*
* @param trie
* The trie to modify.
* @param key
* The key to insert.
* @param length
* The length of the key in bytes.
* @return
* The inserted leaf, or NULL on failure.
*/
struct trie_leaf *trie_insert_mem(struct trie *trie, const void *key, size_t length);
/**
* Destroy a trie and its contents.
*/
void trie_destroy(struct trie *trie);
#endif // BFS_TRIE_H
|