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  * Edge representation.
  47  */
  48 struct GNUNET_REGEX_Edge
  49 {
  50   /**
  51    * Label of the edge.
  52    */
  53   const char *label;
  54
  55   /**
  56    * Destionation of the edge.
  57    */
  58   GNUNET_HashCode destination;
  59 };
  60
  61 /**
  62  * Construct an NFA by parsing the regex string of length 'len'.
  63  *
  64  * @param regex regular expression string.
  65  * @param len length of the string.
  66  *
  67  * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  68  */
  69 struct GNUNET_REGEX_Automaton *
  70 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
  71
  72 /**
  73  * Construct DFA for the given 'regex' of length 'len'.
  74  *
  75  * @param regex regular expression string.
  76  * @param len length of the regular expression.
  77  *
  78  * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  79  */
  80 struct GNUNET_REGEX_Automaton *
  81 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
  82
  83 /**
  84  * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
  85  * data structure.
  86  *
  87  * @param a automaton to be destroyed.
  88  */
  89 void
  90 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
  91
  92 /**
  93  * Save the given automaton as a GraphViz dot file.
  94  *
  95  * @param a the automaton to be saved.
  96  * @param filename where to save the file.
  97  */
  98 void
  99 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
 100                                    const char *filename);
 101
 102 /**
 103  * Evaluates the given 'string' against the given compiled regex.
 104  *
 105  * @param a automaton.
 106  * @param string string to check.
 107  *
 108  * @return 0 if string matches, non 0 otherwise.
 109  */
 110 int
 111 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
 112                    const char *string);
 113
 114 /**
 115  * @return number of bits of 'input_string' that have been consumed
 116  *         to construct the key
 117  */
 118 unsigned int
 119 GNUNET_REGEX_get_first_key (const char *input_string,
 120                             unsigned int string_len,
 121                             GNUNET_HashCode *key);
 122
 123
 124 /**
 125  * Check if the given 'proof' matches the given 'key'.
 126  *
 127  * @param proof partial regex
 128  * @param key hash
 129  *
 130  * @return GNUNET_OK if the proof is valid for the given key
 131  */
 132 int
 133 GNUNET_REGEX_check_proof (const char *proof,
 134                           const GNUNET_HashCode *key);
 135
 136
 137 /**
 138  * Iterator callback function.
 139  *
 140  * @param cls closure.
 141  * @param key hash for current state.
 142  * @param proof proof for current state.
 143  * @param accepting GNUNET_YES if this is an accepting state, GNUNET_NO if not.
 144  * @param num_edges number of edges leaving current state.
 145  * @param edges edges leaving current state.
 146  */
 147 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
 148                                          const GNUNET_HashCode *key,
 149                                          const char *proof,
 150                                          int accepting,
 151                                          unsigned int num_edges,
 152                                          const struct GNUNET_REGEX_Edge *edges);
 153
 154
 155 /**
 156  * Iterate over all edges starting from start state of automaton 'a'. Calling
 157  * iterator for each edge.
 158  *
 159  * @param a automaton.
 160  * @param iterator iterator called for each edge.
 161  * @param iterator_cls closure.
 162  */
 163 void
 164 GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
 165                                 GNUNET_REGEX_KeyIterator iterator,
 166                                 void *iterator_cls);
 167
 168
 169 #if 0                           /* keep Emacsens' auto-indent happy */
 170 {
 171 #endif
 172 #ifdef __cplusplus
 173 }
 174 #endif
 175
 176 /* end of gnunet_regex_lib.h */
 177 #endif
 178