2 * This file is part of GNUnet
3 * Copyright (C) 2012 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.
15 * You should have received a copy of the GNU Affero General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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
28 #ifndef REGEX_INTERNAL_TEST_LIB_H
29 #define REGEX_INTERNAL_TEST_LIB_H
31 #include "regex_internal_lib.h"
36 #if 0 /* keep Emacsens' auto-indent happy */
43 * Combine an array of regexes into a single prefix-shared regex.
44 * Returns a prefix-combine regex that matches the same strings as
45 * any of the original regexes.
47 * WARNING: only useful for reading specific regexes for specific applications,
48 * namely the gnunet-regex-profiler / gnunet-regex-daemon.
49 * This function DOES NOT support arbitrary regex combining.
51 * @param regexes A NULL-terminated array of regexes.
52 * @param alphabet_size Size of the alphabet the regex uses.
54 * @return A string with a single regex that matches any of the original regexes
57 REGEX_TEST_combine (char * const regexes[], unsigned int alphabet_size);
61 * Read a set of regexes from a file, one per line and return them in an array
62 * suitable for REGEX_TEST_combine.
63 * The array must be free'd using REGEX_TEST_free_from_file.
65 * @param filename Name of the file containing the regexes.
67 * @return A newly allocated, NULL terminated array of regexes.
70 REGEX_TEST_read_from_file (const char *filename);
74 * Free all memory reserved for a set of regexes created by read_from_file.
76 * @param regexes NULL-terminated array of regexes.
79 REGEX_TEST_free_from_file (char **regexes);
83 * Generate a (pseudo) random regular expression of length 'rx_length', as well
84 * as a (optional) string that will be matched by the generated regex. The
85 * returned regex needs to be freed.
87 * @param rx_length length of the random regex.
88 * @param matching_str (optional) pointer to a string that will contain a string
89 * that will be matched by the generated regex, if
90 * 'matching_str' pointer was not NULL.
92 * @return NULL if 'rx_length' is 0, a random regex of length 'rx_length', which
93 * needs to be freed, otherwise.
96 REGEX_TEST_generate_random_regex (size_t rx_length, char *matching_str);
100 * Generate a random string of maximum length 'max_len' that only contains literals allowed
101 * in a regular expression. The string might be 0 chars long but is garantueed
102 * to be shorter or equal to 'max_len'.
104 * @param max_len maximum length of the string that should be generated.
106 * @return random string that needs to be freed.
109 REGEX_TEST_generate_random_string (size_t max_len);
113 * Options for graph creation function
114 * REGEX_TEST_automaton_save_graph.
116 enum REGEX_TEST_GraphSavingOptions
119 * Default. Do nothing special.
121 REGEX_TEST_GRAPH_DEFAULT = 0,
124 * The generated graph will include extra information such as the NFA states
125 * that were used to generate the DFA state.
127 REGEX_TEST_GRAPH_VERBOSE = 1,
130 * Enable graph coloring. Will color each SCC in a different color.
132 REGEX_TEST_GRAPH_COLORING = 2
137 * Save the given automaton as a GraphViz dot file.
139 * @param a the automaton to be saved.
140 * @param filename where to save the file.
141 * @param options options for graph generation that include coloring or verbose
145 REGEX_TEST_automaton_save_graph (struct REGEX_INTERNAL_Automaton *a,
146 const char *filename,
147 enum REGEX_TEST_GraphSavingOptions options);
151 #if 0 /* keep Emacsens' auto-indent happy */
158 /* end of regex_internal_lib.h */