src/include/gnunet_regex_lib.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file include/gnunet_regex_lib.h
  22  * @brief library to parse regular expressions into dfa
  23  * @author Maximilian Szengel
  24  *
  25  */
  26
  27 #ifndef GNUNET_REGEX_LIB_H
  28 #define GNUNET_REGEX_LIB_H
  29
  30 #include "gnunet_util_lib.h"
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 /**
  41  * Automaton (NFA/DFA) representation.
  42  */
  43 struct GNUNET_REGEX_Automaton;
  44
  45 /**
  46  * State representation.
  47  */
  48 struct GNUNET_REGEX_State;
  49
  50 /**
  51  * Construct an NFA by parsing the regex string of length 'len'.
  52  *
  53  * @param regex regular expression string.
  54  * @param len length of the string.
  55  *
  56  * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  57  */
  58 struct GNUNET_REGEX_Automaton *
  59 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
  60
  61 /**
  62  * Construct DFA for the given 'regex' of length 'len'.
  63  *
  64  * @param regex regular expression string.
  65  * @param len length of the regular expression.
  66  *
  67  * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  68  */
  69 struct GNUNET_REGEX_Automaton *
  70 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
  71
  72 /**
  73  * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
  74  * data structure.
  75  *
  76  * @param a automaton to be destroyed.
  77  */
  78 void
  79 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
  80
  81 /**
  82  * Save the given automaton as a GraphViz dot file.
  83  *
  84  * @param a the automaton to be saved.
  85  * @param filename where to save the file.
  86  */
  87 void
  88 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
  89                                    const char *filename);
  90
  91 /**
  92  * Evaluates the given 'string' against the given compiled regex.
  93  *
  94  * @param a automaton.
  95  * @param string string to check.
  96  *
  97  * @return 0 if string matches, non 0 otherwise.
  98  */
  99 int
 100 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
 101                    const char *string);
 102
 103
 104
 105 /**
 106  * Get the starting state of the given automaton 'a'.
 107  *
 108  * @param a automaton.
 109  *
 110  * @return starting state.
 111  */
 112 struct GNUNET_REGEX_State *
 113 GNUNET_REGEX_automaton_get_start (struct GNUNET_REGEX_Automaton *a);
 114
 115
 116 /**
 117  * @return number of bits of 'input_string' that have been consumed
 118  *         to construct the key
 119  */
 120 unsigned int
 121 GNUNET_REGEX_get_first_key (const char *input_string,
 122                             GNUNET_HashCode *key);
 123
 124
 125
 126 /**
 127  * @return GNUNET_OK if the proof is valid for the given key
 128  */
 129 int
 130 GNUNET_REGEX_check_proof (const char *proof,
 131                           const GNUNET_HashCode *key);
 132
 133
 134 struct GNUNET_REGEX_Edge
 135 {
 136   const char *label;
 137   GNUNET_HashCode destination;
 138 };
 139
 140
 141 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
 142                                          const GNUNET_HashCode *key,
 143                                          const char *proof,
 144                                          unsigned int num_edges,
 145                                          const struct GNUNET_REGEX_Edge *edges);
 146
 147
 148 int
 149 GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
 150                                 GNUNET_REGEX_KeyIterator iterator,
 151                                 void *iterator_cls);
 152
 153
 154 /**
 155  * Get the next states, starting from states 's'.
 156  *
 157  * @param a automaton.
 158  * @param s states.
 159  * @param count number of states given in 's'. Will contain number of
 160  *              states that were returned upon return.
 161  *
 162  * @return next states, 'count' will contain the number of states.
 163  */
 164 struct GNUNET_REGEX_State **
 165 GNUNET_REGEX_automaton_states_get_next (struct GNUNET_REGEX_Automaton *a,
 166                                         struct GNUNET_REGEX_State **s,
 167                                         unsigned int *count);
 168
 169 /**
 170  * Hash a set of states.
 171  *
 172  * @param a automaton.
 173  * @param s states.
 174  * @param count number of states.
 175  *
 176  * @return hash.
 177  */
 178 struct GNUNET_HashCode
 179 GNUNET_REGEX_automaton_states_hash (struct GNUNET_REGEX_Automaton *a,
 180                                     struct GNUNET_REGEX_State **s,
 181                                     unsigned int count);
 182
 183
 184
 185
 186 #if 0                           /* keep Emacsens' auto-indent happy */
 187 {
 188 #endif
 189 #ifdef __cplusplus
 190 }
 191 #endif
 192
 193 /* end of gnunet_regex_lib.h */
 194 #endif
 195