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"
43 typedef filter_token filter_type_t;
45 typedef struct filter_hook_t {
50 typedef struct filter_params_t {
55 typedef struct filter_t {
60 filter_params_t *params;
64 typedef const char *filter_result_t;
65 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
66 const query_t *query);
67 typedef bool (*filter_constructor_t)(filter_t *filter);
68 typedef void (*filter_destructor_t)(filter_t *filter);
70 __attribute__((nonnull(1,4)))
71 void filter_register(const char *type, filter_constructor_t constructor,
72 filter_destructor_t destructor, filter_runner_t runner);
74 __attribute__((nonnull(1,2)))
75 bool filter_set_name(filter_t *filter, const char *name, ssize_t len);
77 __attribute__((nonnull(1,2)))
78 bool filter_set_type(filter_t *filter, const char *type, ssize_t len);
80 __attribute__((nonnull(1,2,4)))
81 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
82 const char *value, ssize_t value_len);
84 __attribute__((nonnull(1,2,4)))
85 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
86 const char *value, ssize_t value_len);
88 __attribute__((nonnull(1)))
89 bool filter_build(filter_t *filter);
91 __attribute__((nonnull(1)))
92 void filter_wipe(filter_t *filter);
94 __attribute__((nonnull(1,2)))
95 filter_result_t filter_run(const filter_t *filter, const query_t *query);