1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
10 /* 1. Redistributions of source code must retain the above copyright */
11 /* notice, this list of conditions and the following disclaimer. */
12 /* 2. Redistributions in binary form must reproduce the above copyright */
13 /* notice, this list of conditions and the following disclaimer in the */
14 /* documentation and/or other materials provided with the distribution. */
15 /* 3. The names of its contributors may not be used to endorse or promote */
16 /* products derived from this software without specific prior written */
19 /* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
21 /* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
22 /* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS */
23 /* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR */
24 /* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF */
25 /* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS */
26 /* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN */
27 /* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) */
28 /* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF */
29 /* THE POSSIBILITY OF SUCH DAMAGE. */
30 /******************************************************************************/
33 * Copyright © 2008 Florent Bruneau
36 #ifndef PFIXTOOLS_FILTER_H
37 #define PFIXTOOLS_FILTER_H
40 #include "filter_tokens.h"
41 #include "hook_tokens.h"
42 #include "param_tokens.h"
46 typedef filter_token filter_type_t;
47 typedef hook_token filter_result_t;
48 typedef param_token filter_param_id_t;
50 typedef struct filter_hook_t {
59 typedef struct filter_param_t {
60 filter_param_id_t type;
65 typedef struct filter_t {
69 A(filter_hook_t) hooks;
72 A(filter_param_t) params;
76 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, NULL, ARRAY_INIT }
77 #define CHECK_FILTER(Filter) \
78 assert(Filter != FTK_UNKNOWN && Filter != FTK_count \
79 && "Unknown filter type")
80 #define CHECK_HOOK(Hook) \
81 assert(Hook != HTK_UNKNOWN && Hook != HTK_count \
83 #define CHECK_PARAM(Param) \
84 assert(Param != ATK_UNKNOWN && Param != ATK_count \
87 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
88 const query_t *query);
89 typedef bool (*filter_constructor_t)(filter_t *filter);
90 typedef void (*filter_destructor_t)(filter_t *filter);
92 __attribute__((nonnull(1,4)))
93 filter_type_t filter_register(const char *type, filter_constructor_t constructor,
94 filter_destructor_t destructor, filter_runner_t runner);
96 __attribute__((nonnull(2)))
97 filter_result_t filter_hook_register(filter_type_t filter, const char *name);
99 __attribute__((nonnull(2)))
100 filter_param_id_t filter_param_register(filter_type_t filter, const char *name);
102 __attribute__((nonnull(1)))
103 static inline void filter_init(filter_t *filter)
105 const filter_t f = FILTER_INIT;
109 __attribute__((nonnull(1,2)))
110 void filter_set_name(filter_t *filter, const char *name, ssize_t len);
112 __attribute__((nonnull(1,2)))
113 bool filter_set_type(filter_t *filter, const char *type, ssize_t len);
115 __attribute__((nonnull(1,2,4)))
116 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
117 const char *value, ssize_t value_len);
119 __attribute__((nonnull(1,2,4)))
120 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
121 const char *value, ssize_t value_len);
123 __attribute__((nonnull(1)))
124 bool filter_build(filter_t *filter);
126 __attribute__((nonnull(1,2)))
127 static inline int filter_find_with_name(A(filter_t) *array, const char *name)
130 int end = array->len;
132 while (start < end) {
133 int mid = (start + end) / 2;
134 int cmp = strcmp(name, array_elt(*array, mid).name);
138 } else if (cmp < 0) {
147 __attribute__((nonnull(1,2)))
148 bool filter_update_references(filter_t *filter, A(filter_t) *array);
150 __attribute__((nonnull(1)))
151 static inline void filter_hook_wipe(filter_hook_t *hook)
153 p_delete(&hook->value);
156 __attribute__((nonnull(1)))
157 static inline void filter_params_wipe(filter_param_t *param)
159 p_delete(¶m->value);
162 __attribute__((nonnull(1)))
163 void filter_wipe(filter_t *filter);
165 __attribute__((nonnull(1,2)))
166 filter_hook_t *filter_run(const filter_t *filter, const query_t *query);