2 This file is part of GNUnet.
3 Copyright (C) 2012,2013 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @author Bartlomiej Polot
23 * @file regex/regex_block_lib.h
24 * @brief common function to manipulate blocks stored by regex in the DHT
27 #ifndef REGEX_BLOCK_LIB_H_
28 #define REGEX_BLOCK_LIB_H_
34 /* keep Emacsens' auto-indent happy */
40 #include "block_regex.h"
44 * Representation of a Regex node (and edges) in the DHT.
50 * Edge representation.
52 struct REGEX_BLOCK_Edge
55 * Label of the edge. FIXME: might want to not consume exactly
56 * multiples of 8 bits, need length!
61 * Destionation of the edge.
63 struct GNUNET_HashCode destination;
68 * Check if the given 'proof' matches the given 'key'.
70 * @param proof partial regex of a state
71 * @param proof_len number of bytes in @a proof
72 * @param key hash of a state.
73 * @return #GNUNET_OK if the proof is valid for the given key.
76 REGEX_BLOCK_check_proof (const char *proof,
78 const struct GNUNET_HashCode *key);
82 * Check if the regex block is well formed, including all edges.
84 * @param block The start of the block.
85 * @param size The size of the @a block.
86 * @param query the query for the @a block
87 * @param xquery String describing the edge we are looking for.
88 * Can be NULL in case this is a put block.
89 * @return #GNUNET_OK in case it's fine.
90 * #GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
91 * #GNUNET_SYSERR if the block is invalid.
94 REGEX_BLOCK_check (const struct RegexBlock *block,
96 const struct GNUNET_HashCode *query,
100 /* FIXME: might want to use 'struct REGEX_BLOCK_Edge' here instead of 3 arguments! */
103 * Iterator over edges in a block.
105 * @param cls Closure.
106 * @param token Token that follows to next state.
107 * @param len Length of token.
108 * @param key Hash of next state.
109 * @return #GNUNET_YES if should keep iterating, #GNUNET_NO otherwise.
112 (*REGEX_INTERNAL_EgdeIterator)(void *cls,
115 const struct GNUNET_HashCode *key);
119 * Iterate over all edges of a block of a regex state.
121 * @param block Block to iterate over.
122 * @param size Size of block.
123 * @param iterator Function to call on each edge in the block.
124 * @param iter_cls Closure for the @a iterator.
125 * @return #GNUNET_SYSERR if an error has been encountered.
126 * #GNUNET_OK if no error has been encountered.
127 * Note that if the iterator stops the iteration by returning
128 * #GNUNET_NO, the block will no longer be checked for further errors.
129 * The return value will be #GNUNET_OK meaning that no errors were
130 * found until the edge last notified to the iterator, but there might
131 * be errors in further edges.
134 REGEX_BLOCK_iterate (const struct RegexBlock *block,
136 REGEX_INTERNAL_EgdeIterator iterator,
141 * Obtain the key that a particular block is to be stored under.
143 * @param block block to get the key from
144 * @param block_len number of bytes in @a block
145 * @param key where to store the key
146 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed
149 REGEX_BLOCK_get_key (const struct RegexBlock *block,
151 struct GNUNET_HashCode *key);
155 * Test if this block is marked as being an accept state.
157 * @param block block to test
158 * @param size number of bytes in block
159 * @return #GNUNET_YES if the block is accepting, #GNUNET_NO if not
162 GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
167 * Construct a regex block to be stored in the DHT.
169 * @param proof proof string for the block
170 * @param num_edges number of edges in the block
171 * @param edges the edges of the block
172 * @param accepting is this an accepting state
173 * @param rsize set to the size of the returned block (OUT-only)
174 * @return the regex block, NULL on error
177 REGEX_BLOCK_create (const char *proof,
178 unsigned int num_edges,
179 const struct REGEX_BLOCK_Edge *edges,
184 #if 0 /* keep Emacsens' auto-indent happy */
191 /* ifndef REGEX_BLOCK_LIB_H */
193 /* end of regex_block_lib.h */