src/regex/regex_block_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2012,2013 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @author Bartlomiej Polot
  23  * @file regex/regex_block_lib.h
  24  * @brief common function to manipulate blocks stored by regex in the DHT
  25  */
  26
  27 #ifndef REGEX_BLOCK_LIB_H_
  28 #define REGEX_BLOCK_LIB_H_
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0
  34   /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 #include "platform.h"
  40 #include "block_regex.h"
  41
  42 /**
  43  * Check if the regex block is well formed, including all edges.
  44  *
  45  * @param block The start of the block.
  46  * @param size The size of the block.
  47  * @param xquery String describing the edge we are looking for.
  48  *               Can be NULL in case this is a put block.
  49  *
  50  * @return GNUNET_OK in case it's fine.
  51  *         GNUNET_NO in case the xquery exists and is not found (IRRELEVANT).
  52  *         GNUNET_SYSERR if the block is invalid.
  53  */
  54 int
  55 GNUNET_REGEX_block_check (const struct RegexBlock *block,
  56                           size_t size,
  57                           const char *xquery);
  58
  59 /**
  60  * Iterator over edges in a block.
  61  *
  62  * @param cls Closure.
  63  * @param token Token that follows to next state.
  64  * @param len Length of token.
  65  * @param key Hash of next state.
  66  *
  67  * @return GNUNET_YES if should keep iterating, GNUNET_NO otherwise.
  68  */
  69 typedef int (*GNUNET_REGEX_EgdeIterator)(void *cls,
  70                                          const char *token,
  71                                          size_t len,
  72                                          const struct GNUNET_HashCode *key);
  73
  74
  75 /**
  76  * Iterate over all edges of a block of a regex state.
  77  *
  78  * @param block Block to iterate over.
  79  * @param size Size of block.
  80  * @param iterator Function to call on each edge in the block.
  81  * @param iter_cls Closure for the iterator.
  82  *
  83  * @return GNUNET_SYSERR if an error has been encountered.
  84  *         GNUNET_OK if no error has been encountered.
  85  *           Note that if the iterator stops the iteration by returning
  86  *         GNUNET_NO, the block will no longer be checked for further errors.
  87  *           The return value will be GNUNET_OK meaning that no errors were
  88  *         found until the edge last notified to the iterator, but there might
  89  *         be errors in further edges.
  90  */
  91 int
  92 GNUNET_REGEX_block_iterate (const struct RegexBlock *block,
  93                             size_t size,
  94                             GNUNET_REGEX_EgdeIterator iterator,
  95                             void *iter_cls);
  96
  97 #if 0                           /* keep Emacsens' auto-indent happy */
  98 {
  99 #endif
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 /* ifndef REGEX_BLOCK_LIB_H */
 105 #endif
 106 /* end of regex_block_lib.h */