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.
17 * @author Bartlomiej Polot
18 * @file regex/regex_block_lib.h
19 * @brief common function to manipulate blocks stored by regex in the DHT
22 #ifndef REGEX_BLOCK_LIB_H_
23 #define REGEX_BLOCK_LIB_H_
29 /* keep Emacsens' auto-indent happy */
35 #include "block_regex.h"
39 * Representation of a Regex node (and edges) in the DHT.
45 * Edge representation.
47 struct REGEX_BLOCK_Edge
50 * Label of the edge. FIXME: might want to not consume exactly
51 * multiples of 8 bits, need length!
56 * Destionation of the edge.
58 struct GNUNET_HashCode destination;
63 * Check if the given 'proof' matches the given 'key'.
65 * @param proof partial regex of a state
66 * @param proof_len number of bytes in @a proof
67 * @param key hash of a state.
68 * @return #GNUNET_OK if the proof is valid for the given key.
71 REGEX_BLOCK_check_proof (const char *proof,
73 const struct GNUNET_HashCode *key);
77 * Check if the regex block is well formed, including all edges.
79 * @param block The start of the block.
80 * @param size The size of the @a block.
81 * @param query the query for the @a block
82 * @param xquery String describing the edge we are looking for.
83 * Can be NULL in case this is a put block.
84 * @return #GNUNET_OK in case it's fine.
85 * #GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
86 * #GNUNET_SYSERR if the block is invalid.
89 REGEX_BLOCK_check (const struct RegexBlock *block,
91 const struct GNUNET_HashCode *query,
95 /* FIXME: might want to use 'struct REGEX_BLOCK_Edge' here instead of 3 arguments! */
98 * Iterator over edges in a block.
100 * @param cls Closure.
101 * @param token Token that follows to next state.
102 * @param len Length of token.
103 * @param key Hash of next state.
104 * @return #GNUNET_YES if should keep iterating, #GNUNET_NO otherwise.
107 (*REGEX_INTERNAL_EgdeIterator)(void *cls,
110 const struct GNUNET_HashCode *key);
114 * Iterate over all edges of a block of a regex state.
116 * @param block Block to iterate over.
117 * @param size Size of block.
118 * @param iterator Function to call on each edge in the block.
119 * @param iter_cls Closure for the @a iterator.
120 * @return #GNUNET_SYSERR if an error has been encountered.
121 * #GNUNET_OK if no error has been encountered.
122 * Note that if the iterator stops the iteration by returning
123 * #GNUNET_NO, the block will no longer be checked for further errors.
124 * The return value will be #GNUNET_OK meaning that no errors were
125 * found until the edge last notified to the iterator, but there might
126 * be errors in further edges.
129 REGEX_BLOCK_iterate (const struct RegexBlock *block,
131 REGEX_INTERNAL_EgdeIterator iterator,
136 * Obtain the key that a particular block is to be stored under.
138 * @param block block to get the key from
139 * @param block_len number of bytes in @a block
140 * @param key where to store the key
141 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the block is malformed
144 REGEX_BLOCK_get_key (const struct RegexBlock *block,
146 struct GNUNET_HashCode *key);
150 * Test if this block is marked as being an accept state.
152 * @param block block to test
153 * @param size number of bytes in block
154 * @return #GNUNET_YES if the block is accepting, #GNUNET_NO if not
157 GNUNET_BLOCK_is_accepting (const struct RegexBlock *block,
162 * Construct a regex block to be stored in the DHT.
164 * @param proof proof string for the block
165 * @param num_edges number of edges in the block
166 * @param edges the edges of the block
167 * @param accepting is this an accepting state
168 * @param rsize set to the size of the returned block (OUT-only)
169 * @return the regex block, NULL on error
172 REGEX_BLOCK_create (const char *proof,
173 unsigned int num_edges,
174 const struct REGEX_BLOCK_Edge *edges,
179 #if 0 /* keep Emacsens' auto-indent happy */
186 /* ifndef REGEX_BLOCK_LIB_H */
188 /* end of regex_block_lib.h */