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  * Automaton (NFA/DFA) representation
  42  */
  43 struct GNUNET_REGEX_Automaton;
  44
  45 /**
  46  * Construct an NFA by parsing the regex string of length 'len'.
  47  *
  48  * @param regex regular expression string
  49  * @param len length of the string
  50  *
  51  * @return NFA, needs to be freed using GNUNET_REGEX_destroy_automaton
  52  */
  53 struct GNUNET_REGEX_Automaton *
  54 GNUNET_REGEX_construct_nfa (const char *regex, const size_t len);
  55
  56 /**
  57  * Construct DFA for the given 'regex' of length 'len'
  58  *
  59  * @param regex regular expression string
  60  * @param len length of the regular expression
  61  *
  62  * @return DFA, needs to be freed using GNUNET_REGEX_destroy_automaton
  63  */
  64 struct GNUNET_REGEX_Automaton *
  65 GNUNET_REGEX_construct_dfa (const char *regex, const size_t len);
  66
  67 /**
  68  * Free the memory allocated by constructing the GNUNET_REGEX_Automaton
  69  * data structure.
  70  *
  71  * @param a automaton to be destroyed
  72  */
  73 void
  74 GNUNET_REGEX_automaton_destroy (struct GNUNET_REGEX_Automaton *a);
  75
  76 /**
  77  * Save the given automaton as a GraphViz dot file
  78  *
  79  * @param a the automaton to be saved
  80  * @param filename where to save the file
  81  */
  82 void
  83 GNUNET_REGEX_automaton_save_graph (struct GNUNET_REGEX_Automaton *a,
  84                                    const char *filename);
  85
  86 /**
  87  * Evaluates the given 'string' against the given compiled regex
  88  *
  89  * @param a automaton
  90  * @param string string to check
  91  *
  92  * @return 0 if string matches, non 0 otherwise
  93  */
  94 int
  95 GNUNET_REGEX_eval (struct GNUNET_REGEX_Automaton *a,
  96                    const char *string);
  97
  98 #if 0                           /* keep Emacsens' auto-indent happy */
  99 {
 100 #endif
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 /* end of gnunet_regex_lib.h */
 106 #endif