src/regex/regex_test_lib.h

   1 /*
   2  *  This file is part of GNUnet
   3  *  Copyright (C) 2012 GNUnet e.V.
   4  *
   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.
   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  *  Affero General Public License for more details.
  14  *
  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/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  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 /**
  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.
  46  *
  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.
  50  *
  51  * @param regexes A NULL-terminated array of regexes.
  52  * @param alphabet_size Size of the alphabet the regex uses.
  53  *
  54  * @return A string with a single regex that matches any of the original regexes
  55  */
  56 char *
  57 REGEX_TEST_combine(char * const regexes[], unsigned int alphabet_size);
  58
  59
  60 /**
  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.
  64  *
  65  * @param filename Name of the file containing the regexes.
  66  *
  67  * @return A newly allocated, NULL terminated array of regexes.
  68  */
  69 char **
  70 REGEX_TEST_read_from_file(const char *filename);
  71
  72
  73 /**
  74  * Free all memory reserved for a set of regexes created by read_from_file.
  75  *
  76  * @param regexes NULL-terminated array of regexes.
  77  */
  78 void
  79 REGEX_TEST_free_from_file(char **regexes);
  80
  81
  82 /**
  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.
  86  *
  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.
  91  *
  92  * @return NULL if 'rx_length' is 0, a random regex of length 'rx_length', which
  93  *         needs to be freed, otherwise.
  94  */
  95 char *
  96 REGEX_TEST_generate_random_regex(size_t rx_length, char *matching_str);
  97
  98
  99 /**
 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'.
 103  *
 104  * @param max_len maximum length of the string that should be generated.
 105  *
 106  * @return random string that needs to be freed.
 107  */
 108 char *
 109 REGEX_TEST_generate_random_string(size_t max_len);
 110
 111
 112 /**
 113  * Options for graph creation function
 114  * REGEX_TEST_automaton_save_graph.
 115  */
 116 enum REGEX_TEST_GraphSavingOptions {
 117   /**
 118    * Default. Do nothing special.
 119    */
 120   REGEX_TEST_GRAPH_DEFAULT = 0,
 121
 122   /**
 123    * The generated graph will include extra information such as the NFA states
 124    * that were used to generate the DFA state.
 125    */
 126   REGEX_TEST_GRAPH_VERBOSE = 1,
 127
 128   /**
 129    * Enable graph coloring. Will color each SCC in a different color.
 130    */
 131   REGEX_TEST_GRAPH_COLORING = 2
 132 };
 133
 134
 135 /**
 136  * Save the given automaton as a GraphViz dot file.
 137  *
 138  * @param a the automaton to be saved.
 139  * @param filename where to save the file.
 140  * @param options options for graph generation that include coloring or verbose
 141  *                mode
 142  */
 143 void
 144 REGEX_TEST_automaton_save_graph(struct REGEX_INTERNAL_Automaton *a,
 145                                 const char *filename,
 146                                 enum REGEX_TEST_GraphSavingOptions options);
 147
 148
 149
 150 #if 0                           /* keep Emacsens' auto-indent happy */
 151 {
 152   #endif
 153   #ifdef __cplusplus
 154 }
 155 #endif
 156
 157 /* end of regex_internal_lib.h */
 158 #endif