postlicyd/filter.h

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  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     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  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 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2008 Florent Bruneau
  34  */
  35
  36 #ifndef PFIXTOOLS_FILTER_H
  37 #define PFIXTOOLS_FILTER_H
  38
  39 #include "common.h"
  40 #include "filter_tokens.h"
  41 #include "query.h"
  42 #include "array.h"
  43
  44 typedef filter_token filter_type_t;
  45
  46 typedef struct filter_hook_t {
  47     char *name;
  48     char *value;
  49 } filter_hook_t;
  50 ARRAY(filter_hook_t)
  51
  52 typedef struct filter_params_t {
  53     char *name;
  54     char *value;
  55 } filter_params_t;
  56 ARRAY(filter_params_t)
  57
  58 typedef struct filter_t {
  59     char *name;
  60     filter_type_t type;
  61
  62     A(filter_hook_t)   hooks;
  63     A(filter_params_t) params;
  64     void *data;
  65 } filter_t;
  66 ARRAY(filter_t)
  67
  68 #define FILTER_INIT { NULL, FTK_UNKNOWN, ARRAY_INIT, ARRAY_INIT, NULL }
  69
  70 typedef const char *filter_result_t;
  71 typedef filter_result_t (*filter_runner_t)(const filter_t *filter,
  72                                            const query_t *query);
  73 typedef bool (*filter_constructor_t)(filter_t *filter);
  74 typedef void (*filter_destructor_t)(filter_t *filter);
  75
  76 __attribute__((nonnull(1,4)))
  77 void filter_register(const char *type, filter_constructor_t constructor,
  78                      filter_destructor_t destructor, filter_runner_t runner);
  79
  80 __attribute__((nonnull(1)))
  81 static inline void filter_init(filter_t *filter)
  82 {
  83     const filter_t f = FILTER_INIT;
  84     *filter = f;
  85 }
  86
  87 __attribute__((nonnull(1,2)))
  88 void filter_set_name(filter_t *filter, const char *name, ssize_t len);
  89
  90 __attribute__((nonnull(1,2)))
  91 bool filter_set_type(filter_t *filter, const char *type, ssize_t len);
  92
  93 __attribute__((nonnull(1,2,4)))
  94 bool filter_add_param(filter_t *filter, const char *name, ssize_t name_len,
  95                       const char *value, ssize_t value_len);
  96
  97 __attribute__((nonnull(1,2,4)))
  98 bool filter_add_hook(filter_t *filter, const char *name, ssize_t name_len,
  99                      const char *value, ssize_t value_len);
 100
 101 __attribute__((nonnull(1)))
 102 bool filter_build(filter_t *filter);
 103
 104 __attribute__((nonnull(1)))
 105 static inline void filter_hook_wipe(filter_hook_t *hook)
 106 {
 107     p_delete(&hook->name);
 108     p_delete(&hook->value);
 109 }
 110
 111 __attribute__((nonnull(1)))
 112 static inline void filter_params_wipe(filter_params_t *param)
 113 {
 114     p_delete(&param->name);
 115     p_delete(&param->value);
 116 }
 117
 118 __attribute__((nonnull(1)))
 119 void filter_wipe(filter_t *filter);
 120
 121 __attribute__((nonnull(1,2)))
 122 filter_result_t filter_run(const filter_t *filter, const query_t *query);
 123
 124
 125 #endif