missing fi
[oweals/gnunet.git] / src / regex / regex_test_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 src/regex/regex_test_lib.h
22  * @brief library to read regexes representing IP networks from a file.
23  *        and simplifying the into one big regex, in order to run
24  *        tests (regex performance, regex profiler).
25  * @author Bertlomiej Polot
26  */
27
28 #ifndef REGEX_INTERNAL_TEST_LIB_H
29 #define REGEX_INTERNAL_TEST_LIB_H
30
31 #include "regex_internal_lib.h"
32
33 #ifdef __cplusplus
34 extern "C"
35 {
36   #if 0                           /* keep Emacsens' auto-indent happy */
37 }
38 #endif
39 #endif
40
41 /**
42  * Combine an array of regexes into a single prefix-shared regex.
43  *
44  * @param regexes A NULL-terminated array of regexes.
45  *
46  * @return A string with a single regex that matches any of the original regexes
47  */
48 char *
49 REGEX_TEST_combine(char * const regexes[]);
50
51
52 /**
53  * Read a set of regexes from a file, one per line and return them in an array
54  * suitable for REGEX_TEST_combine.
55  * The array must be free'd using REGEX_TEST_free_from_file.
56  *
57  * @param filename Name of the file containing the regexes.
58  *
59  * @return A newly allocated, NULL terminated array of regexes.
60  */
61 char **
62 REGEX_TEST_read_from_file (const char *filename);
63
64
65 /**
66  * Free all memory reserved for a set of regexes created by read_from_file.
67  *
68  * @param regexes NULL-terminated array of regexes.
69  */
70 void
71 REGEX_TEST_free_from_file (char **regexes);
72
73
74 /**
75  * Generate a (pseudo) random regular expression of length 'rx_length', as well
76  * as a (optional) string that will be matched by the generated regex. The
77  * returned regex needs to be freed.
78  *
79  * @param rx_length length of the random regex.
80  * @param matching_str (optional) pointer to a string that will contain a string
81  *                     that will be matched by the generated regex, if
82  *                     'matching_str' pointer was not NULL.
83  *
84  * @return NULL if 'rx_length' is 0, a random regex of length 'rx_length', which
85  *         needs to be freed, otherwise.
86  */
87 char *
88 REGEX_TEST_generate_random_regex (size_t rx_length, char *matching_str);
89
90
91 /**
92  * Generate a random string of maximum length 'max_len' that only contains literals allowed
93  * in a regular expression. The string might be 0 chars long but is garantueed
94  * to be shorter or equal to 'max_len'.
95  *
96  * @param max_len maximum length of the string that should be generated.
97  *
98  * @return random string that needs to be freed.
99  */
100 char *
101 REGEX_TEST_generate_random_string (size_t max_len);
102
103
104 /**
105  * Options for graph creation function
106  * REGEX_TEST_automaton_save_graph.
107  */
108 enum REGEX_TEST_GraphSavingOptions
109 {
110   /**
111    * Default. Do nothing special.
112    */
113   REGEX_TEST_GRAPH_DEFAULT = 0,
114
115   /**
116    * The generated graph will include extra information such as the NFA states
117    * that were used to generate the DFA state.
118    */
119   REGEX_TEST_GRAPH_VERBOSE = 1,
120
121   /**
122    * Enable graph coloring. Will color each SCC in a different color.
123    */
124   REGEX_TEST_GRAPH_COLORING = 2
125 };
126
127
128 /**
129  * Save the given automaton as a GraphViz dot file.
130  *
131  * @param a the automaton to be saved.
132  * @param filename where to save the file.
133  * @param options options for graph generation that include coloring or verbose
134  *                mode
135  */
136 void
137 REGEX_TEST_automaton_save_graph (struct REGEX_INTERNAL_Automaton *a,
138                                    const char *filename,
139                                    enum REGEX_TEST_GraphSavingOptions options);
140
141
142
143 #if 0                           /* keep Emacsens' auto-indent happy */
144 {
145   #endif
146   #ifdef __cplusplus
147 }
148 #endif
149
150 /* end of regex_internal_lib.h */
151 #endif