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 /**
  47  * Edge representation.
  48  */
  49 struct GNUNET_REGEX_Edge
  50 {
  51   /**
  52    * Label of the edge.  FIXME: might want to not consume exactly multiples of 8 bits, need length?
  53    */
  54   const char *label;
  55
  56   /**
  57    * Destionation of the edge.
  58    */
  59   struct GNUNET_HashCode destination;
  60 };
  61
  62
  63 /**
  64  * Construct an NFA by parsing the regex string of length 'len'.
  65  *
  66  * @param regex regular expression string.
  67  * @param len length of the string.
  68  *
  69  * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  70  */
  71 struct GNUNET_REGEX_Automaton *
  72 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
  73
  74
  75 /**
  76  * Construct DFA for the given 'regex' of length 'len'.
  77  *
  78  * @param regex regular expression string.
  79  * @param len length of the regular expression.
  80  *
  81  * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
  82  */
  83 struct GNUNET_REGEX_Automaton *
  84 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
  85
  86
  87 /**
  88  * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
  89  * data structure.
  90  *
  91  * @param a automaton to be destroyed.
  92  */
  93 void
  94 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
  95
  96
  97 /**
  98  * Options for graph creation function
  99  * GNUNET_REGEX_automaton_save_graph.
 100  */
 101 enum GNUNET_REGEX_GraphSavingOptions
 102 {
 103   /**
 104    * Default. Do nothing special.
 105    */
 106   GNUNET_REGEX_GRAPH_DEFAULT = 0,
 107
 108   /**
 109    * The generated graph will include extra information such as the NFA states
 110    * that were used to generate the DFA state.
 111    */
 112   GNUNET_REGEX_GRAPH_VERBOSE = 1,
 113
 114   /**
 115    * Enable graph coloring. Will color each SCC in a different color.
 116    */
 117   GNUNET_REGEX_GRAPH_COLORING = 2
 118 };
 119
 120
 121 /**
 122  * Save the given automaton as a GraphViz dot file.
 123  *
 124  * @param a the automaton to be saved.
 125  * @param filename where to save the file.
 126  * @param options options for graph generation that include coloring or verbose
 127  *                mode
 128  */
 129 void
 130 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
 131                                    const char *filename,
 132                                    enum GNUNET_REGEX_GraphSavingOptions options);
 133
 134
 135 /**
 136  * Evaluates the given 'string' against the given compiled regex.
 137  *
 138  * @param a automaton.
 139  * @param string string to check.
 140  *
 141  * @return 0 if string matches, non 0 otherwise.
 142  */
 143 int
 144 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
 145                    const char *string);
 146
 147
 148 /**
 149  * Get the first key for the given 'input_string'. This hashes
 150  * the first x bits of the 'input_string'.
 151  *
 152  * @param input_string string.
 153  * @param string_len length of the 'input_string'.
 154  * @param key pointer to where to write the hash code.
 155  *
 156  * @return number of bits of 'input_string' that have been consumed
 157  *         to construct the key
 158  */
 159 size_t
 160 GNUNET_REGEX_get_first_key (const char *input_string, size_t string_len,
 161                             struct GNUNET_HashCode * key);
 162
 163
 164 /**
 165  * Check if the given 'proof' matches the given 'key'.
 166  *
 167  * @param proof partial regex of a state.
 168  * @param key hash of a state.
 169  *
 170  * @return GNUNET_OK if the proof is valid for the given key.
 171  */
 172 int
 173 GNUNET_REGEX_check_proof (const char *proof,
 174                           const struct GNUNET_HashCode *key);
 175
 176
 177 /**
 178  * Iterator callback function.
 179  *
 180  * @param cls closure.
 181  * @param key hash for current state.
 182  * @param proof proof for current state.
 183  * @param accepting GNUNET_YES if this is an accepting state, GNUNET_NO if not.
 184  * @param num_edges number of edges leaving current state.
 185  * @param edges edges leaving current state.
 186  */
 187 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
 188                                          const struct GNUNET_HashCode *key,
 189                                          const char *proof,
 190                                          int accepting,
 191                                          unsigned int num_edges,
 192                                          const struct GNUNET_REGEX_Edge *edges);
 193
 194
 195 /**
 196  * Iterate over all edges starting from start state of automaton 'a'. Calling
 197  * iterator for each edge.
 198  *
 199  * @param a automaton.
 200  * @param iterator iterator called for each edge.
 201  * @param iterator_cls closure.
 202  */
 203 void
 204 GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
 205                                 GNUNET_REGEX_KeyIterator iterator,
 206                                 void *iterator_cls);
 207
 208
 209 #if 0                           /* keep Emacsens' auto-indent happy */
 210 {
 211 #endif
 212 #ifdef __cplusplus
 213 }
 214 #endif
 215
 216 /* end of gnunet_regex_lib.h */
 217 #endif