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;
47 * Edge representation.
49 struct GNUNET_REGEX_Edge
52 * Label of the edge. FIXME: might want to not consume exactly multiples of 8 bits, need length?
57 * Destionation of the edge.
59 struct GNUNET_HashCode destination;
64 * Construct an NFA by parsing the regex string of length 'len'.
66 * @param regex regular expression string.
67 * @param len length of the string.
69 * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
71 struct GNUNET_REGEX_Automaton *
72 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
76 * Construct DFA for the given 'regex' of length 'len'.
78 * @param regex regular expression string.
79 * @param len length of the regular expression.
81 * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton.
83 struct GNUNET_REGEX_Automaton *
84 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
88 * Free the memory allocated by constructing the GNUNET_REGEX_Automaton.
91 * @param a automaton to be destroyed.
94 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
98 * Save the given automaton as a GraphViz dot file.
100 * @param a the automaton to be saved.
101 * @param filename where to save the file.
104 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
105 const char *filename);
108 * Evaluates the given 'string' against the given compiled regex.
110 * @param a automaton.
111 * @param string string to check.
113 * @return 0 if string matches, non 0 otherwise.
116 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
121 * Get the first key for the given 'input_string'. This hashes
122 * the first x bits of the 'input_string'.
124 * @param input_string string.
125 * @param string_len length of the 'input_string'.
126 * @param key pointer to where to write the hash code.
128 * @return number of bits of 'input_string' that have been consumed
129 * to construct the key
132 GNUNET_REGEX_get_first_key (const char *input_string, size_t string_len,
133 struct GNUNET_HashCode * key);
137 * Check if the given 'proof' matches the given 'key'.
139 * @param proof partial regex of a state.
140 * @param key hash of a state.
142 * @return GNUNET_OK if the proof is valid for the given key.
145 GNUNET_REGEX_check_proof (const char *proof,
146 const struct GNUNET_HashCode *key);
150 * Iterator callback function.
152 * @param cls closure.
153 * @param key hash for current state.
154 * @param proof proof for current state.
155 * @param accepting GNUNET_YES if this is an accepting state, GNUNET_NO if not.
156 * @param num_edges number of edges leaving current state.
157 * @param edges edges leaving current state.
159 typedef void (*GNUNET_REGEX_KeyIterator)(void *cls,
160 const struct GNUNET_HashCode *key,
163 unsigned int num_edges,
164 const struct GNUNET_REGEX_Edge *edges);
168 * Iterate over all edges starting from start state of automaton 'a'. Calling
169 * iterator for each edge.
171 * @param a automaton.
172 * @param iterator iterator called for each edge.
173 * @param iterator_cls closure.
176 GNUNET_REGEX_iterate_all_edges (struct GNUNET_REGEX_Automaton *a,
177 GNUNET_REGEX_KeyIterator iterator,
181 #if 0 /* keep Emacsens' auto-indent happy */
188 /* end of gnunet_regex_lib.h */