src/include/gnunet_regex_lib.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2012 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  * @file include/gnunet_regex_lib.h
  22  * @brief library to parse regular expressions into dfa
  23  * @author Maximilian Szengel
  24  *
  25  */
  26
  27 #ifndef GNUNET_REGEX_LIB_H
  28 #define GNUNET_REGEX_LIB_H
  29
  30 #include "gnunet_util_lib.h"
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 /**
  41  * NFA representation
  42  */
  43 struct GNUNET_REGEX_Nfa;
  44
  45 /**
  46  * Construct an NFA data structure by parsing the regex string of
  47  * length len.
  48  *
  49  * @param regex regular expression string
  50  * @param len length of the string
  51  *
  52  * @return NFA data structure. Needs to be freed using
  53  *         GNUNET_REGEX_destroy_nfa
  54  */
  55 struct GNUNET_REGEX_Nfa *
  56 GNUNET_REGEX_construct_nfa(const char *regex, size_t len);
  57
  58 /**
  59  * Free the memory allocated by constructing the GNUNET_REGEX_Nfa
  60  * data structure.
  61  *
  62  * @param n NFA to be destroyed
  63  */
  64 void
  65 GNUNET_REGEX_destroy_nfa(struct GNUNET_REGEX_Nfa *n);
  66
  67 /**
  68  * Save the given NFA as a GraphViz dot file
  69  *
  70  * @param n NFA to be saved
  71  * @param filename where to save the file
  72  */
  73 void
  74 GNUNET_REGEX_save_nfa_graph(struct GNUNET_REGEX_Nfa *n,
  75                             const char *filename);
  76
  77 #if 0                           /* keep Emacsens' auto-indent happy */
  78 {
  79 #endif
  80 #ifdef __cplusplus
  81 }
  82 #endif
  83
  84 /* end of gnunet_regex_lib.h */
  85 #endif