2 This file is part of GNUnet.
3 Copyright (C) 2012,2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * @author Bartlomiej Polot
21 * @file regex/regex_block_lib.h
22 * @brief common function to manipulate blocks stored by regex in the DHT
25 #ifndef REGEX_BLOCK_LIB_H_
26 #define REGEX_BLOCK_LIB_H_
32 /* keep Emacsens' auto-indent happy */
38 #include "block_regex.h"
42 * Representation of a Regex node (and edges) in the DHT.
48 * Edge representation.
50 struct REGEX_BLOCK_Edge
53 * Label of the edge. FIXME: might want to not consume exactly
54 * multiples of 8 bits, need length!
59 * Destionation of the edge.
61 struct GNUNET_HashCode destination;
66 * Check if the given 'proof' matches the given 'key'.
68 * @param proof partial regex of a state
69 * @param proof_len number of bytes in @a proof
70 * @param key hash of a state.
71 * @return #GNUNET_OK if the proof is valid for the given key.
74 REGEX_BLOCK_check_proof (const char *proof,
76 const struct GNUNET_HashCode *key);
80 * Check if the regex block is well formed, including all edges.
82 * @param block The start of the block.
83 * @param size The size of the @a block.
84 * @param query the query for the @a block
85 * @param xquery String describing the edge we are looking for.
86 * Can be NULL in case this is a put block.
87 * @return #GNUNET_OK in case it's fine.
88 * #GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
89 * #GNUNET_SYSERR if the block is invalid.
92 REGEX_BLOCK_check (const struct RegexBlock *block,
94 const struct GNUNET_HashCode *query,
98 /* FIXME: might want to use 'struct REGEX_BLOCK_Edge' here instead of 3 arguments! */
101 * Iterator over edges in a block.
103 * @param cls Closure.
104 * @param token Token that follows to next state.
105 * @param len Length of token.
106 * @param key Hash of next state.
107 * @return #GNUNET_YES if should keep iterating, #GNUNET_NO otherwise.
110 (*REGEX_INTERNAL_EgdeIterator)(void *cls,
113 const struct GNUNET_HashCode *key);
117 * Iterate over all edges of a block of a regex state.
119 * @param block Block to iterate over.
120 * @param size Size of block.
121 * @param iterator Function to call on each edge in the block.
122 * @param iter_cls Closure for the @a iterator.
123 * @return #GNUNET_SYSERR if an error has been encountered.
124 * #GNUNET_OK if no error has been encountered.
125 * Note that if the iterator stops the iteration by returning
126 * #GNUNET_NO, the block will no longer be checked for further errors.
127 * The return value will be #GNUNET_OK meaning that no errors were
128 * found until the edge last notified to the iterator, but there might
129 * be errors in further edges.
132 REGEX_BLOCK_iterate (const struct RegexBlock *block,
134 REGEX_INTERNAL_EgdeIterator iterator,
139 * Obtain the key that a particular block is to be stored under.
141 * @param block block to get the key from
142 * @param block_len number of bytes in @a block
143 * @param key where to store the key
144 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed
147 REGEX_BLOCK_get_key (const struct RegexBlock *block,
149 struct GNUNET_HashCode *key);
153 * Test if this block is marked as being an accept state.
155 * @param block block to test
156 * @param size number of bytes in block
157 * @return #GNUNET_YES if the block is accepting, #GNUNET_NO if not
160 GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
165 * Construct a regex block to be stored in the DHT.
167 * @param proof proof string for the block
168 * @param num_edges number of edges in the block
169 * @param edges the edges of the block
170 * @param accepting is this an accepting state
171 * @param rsize set to the size of the returned block (OUT-only)
172 * @return the regex block, NULL on error
175 REGEX_BLOCK_create (const char *proof,
176 unsigned int num_edges,
177 const struct REGEX_BLOCK_Edge *edges,
182 #if 0 /* keep Emacsens' auto-indent happy */
189 /* ifndef REGEX_BLOCK_LIB_H */
191 /* end of regex_block_lib.h */