libcommon/trie.h at master · Fruneau/libcommon · GitHub

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
/****************************************************************************/
/*          pfixtools: a collection of postfix related tools                */
/*          ~~~~~~~~~                                                       */
/*  ______________________________________________________________________  */
/*                                                                          */
/*  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 names of its contributors may not be used to endorse or promote  */
/*     products derived from this software without specific prior written   */
/*     permission.                                                          */
/*                                                                          */
/*  THIS SOFTWARE IS PROVIDED BY THE CONTRIBUTORS ``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 CONTRIBUTORS 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.                      */
/*                                                                          */
/*   Copyright (c) 2006-2014 the Authors                                    */
/*   see AUTHORS and source files for details                               */
/****************************************************************************/

#ifndef PFIXTOOLS_TRIE_H
#define PFIXTOOLS_TRIE_H

#include "common.h"
#include "array.h"
#include "regexp.h"

typedef struct trie_t trie_t;
PARRAY(trie_t)

typedef struct trie_match_t {
    regexp_t *regexp;
    unsigned match_len    : 30;
    bool     match_all    : 1;
    bool     match_prefix : 1;
} trie_match_t;

trie_t *trie_new(void);
void trie_delete(trie_t **trie);

/** Add a string in the trie.
 * \ref trie_compile.
 */
__attribute__((nonnull(1,2)))
bool trie_insert(trie_t *trie, const char *key);

/** Insert a string in the trie.
 */
__attribute__((nonnull(1,2)))
bool trie_insert_str(trie_t *trie, const clstr_t *key);

/** Add a string followed with a regexp in the trie.
 *
 * \ref trie_compile
 * \ref trie_insert
 */
__attribute__((nonnull(1,2)))
bool trie_insert_regexp(trie_t *trie, const char *key, const char *regexp);

/** Insert a string followed by a regexp in the trie.
 */
__attribute__((nonnull(1,2)))
bool trie_insert_regexp_str(trie_t *trie, const clstr_t *key,
                            const clstr_t *regexp);

/** Compile the trie.
 * A trie must be compiled before lookup is possible. Compiling the trie
 * consists in building the tree.
 *
 * \param memlock if true, the trie is locked into the RAM (mlock).
 *
 * Usage of a trie:
 *   trie_insert(trie, ...);
 *   trie_insert(trie, ...);
 *   ...
 *   trie_insert(trie, ...);
 *
 *   trie_compile(trie, lock);
 *
 *   trie_lookup(trie, ...);
 *   trie_lookup(trie, ...);
 */
__attribute__((nonnull(1)))
bool trie_compile(trie_t *trie, bool memlock);

/** Lock the trie into memory.
 * \ref trie_unlock
 */
__attribute__((nonnull(1)))
void trie_lock(trie_t *trie);

/** Unlock the trie.
 * \ref trie_lock
 */
__attribute__((nonnull(1)))
void trie_unlock(trie_t *trie);

/** Check if the trie contains \p key.
 */
__attribute__((nonnull(1,2)))
bool trie_lookup_match(const trie_t *trie, const char *key,
                       trie_match_t *match);
#define trie_lookup(trie, key) (trie_lookup_match(trie, key, NULL))

/** Check if the trie contains a prefix of \p key.
 */
__attribute__((nonnull(1,2)))
bool trie_prefix_match(const trie_t *trie, const char *key,
                       trie_match_t *match);
#define trie_prefix(trie, key) (trie_prefix_match(trie, key, NULL))

/** Show the content of the trie and computes statistics.
 */
__attribute__((nonnull(1)))
void trie_inspect(const trie_t *trie, bool show_content);

#endif

/* vim:set et sw=4 sts=4 sws=4: */