2 This file is part of GNUnet
3 (C) 2012 Christian Grothoff (and other contributing authors)
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.
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.
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.
21 * @file include/gnunet_regex_lib.h
22 * @brief library to parse regular expressions into dfa
23 * @author Maximilian Szengel
27 #ifndef GNUNET_REGEX_LIB_H
28 #define GNUNET_REGEX_LIB_H
30 #include "gnunet_util_lib.h"
35 #if 0 /* keep Emacsens' auto-indent happy */
41 * Automaton (NFA/DFA) representation.
43 struct GNUNET_REGEX_Automaton;
46 * State representation.
48 struct GNUNET_REGEX_State;
51 * Construct an NFA by parsing the regex string of length 'len'.
53 * @param regex regular expression string.
54 * @param len length of the string.
56 * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
58 struct GNUNET_REGEX_Automaton *
59 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
62 * Construct DFA for the given 'regex' of length 'len'.
64 * @param regex regular expression string.
65 * @param len length of the regular expression.
67 * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
69 struct GNUNET_REGEX_Automaton *
70 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
73 * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
76 * @param a automaton to be destroyed.
79 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
82 * Save the given automaton as a GraphViz dot file.
84 * @param a the automaton to be saved.
85 * @param filename where to save the file.
88 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
89 const char *filename);
92 * Evaluates the given 'string' against the given compiled regex.
95 * @param string string to check.
97 * @return 0 if string matches, non 0 otherwise.
100 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
106 * Get the starting state of the given automaton 'a'.
108 * @param a automaton.
110 * @return starting state.
112 struct GNUNET_REGEX_State *
113 GNUNET_REGEX_automaton_get_start (struct GNUNET_REGEX_Automaton *a);
117 * @return number of bits of 'input_string' that have been consumed
118 * to construct the key
121 GNUNET_REGEX_get_first_key (const char *input_string,
122 GNUNET_HashCode *key);
127 * @return GNUNET_OK if the proof is valid for the given key
130 GNUNET_REGEX_check_proof (const char *proof,
131 const GNUNET_HashCode *key);
134 struct GNUNET_REGEX_Edge
137 GNUNET_HashCode destination;
141 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
142 const GNUNET_HashCode *key,
144 unsigned int num_edges,
145 const struct GNUNET_REGEX_Edge *edges);
149 GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
150 GNUNET_REGEX_KeyIterator iterator,
155 * Get the next states, starting from states 's'.
157 * @param a automaton.
159 * @param count number of states given in 's'. Will contain number of
160 * states that were returned upon return.
162 * @return next states, 'count' will contain the number of states.
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);
170 * Hash a set of states.
172 * @param a automaton.
174 * @param count number of states.
178 struct GNUNET_HashCode
179 GNUNET_REGEX_automaton_states_hash (struct GNUNET_REGEX_Automaton *a,
180 struct GNUNET_REGEX_State **s,
186 #if 0 /* keep Emacsens' auto-indent happy */
193 /* end of gnunet_regex_lib.h */