src/fa.h

   1 /*
   2  * fa.h: finite automata
   3  *
   4  * Copyright (C) 2007-2011 David Lutterkort
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  19  *
  20  * Author: David Lutterkort <dlutter@redhat.com>
  21  */
  22
  23 #ifndef FA_H_
  24 #define FA_H_
  25
  26 #include <stdio.h>
  27 #include <regex.h>
  28
  29 /* The type for a finite automaton. */
  30 struct fa;
  31
  32 /* Denote some basic automata, used by fa_is_basic and fa_make_basic */
  33 enum fa_basic {
  34     FA_EMPTY,        /* Accepts the empty language, i.e. no strings */
  35     FA_EPSILON,      /* Accepts only the empty word */
  36     FA_TOTAL         /* Accepts all words */
  37 };
  38
  39 /* Choice of minimization algorithm to use; either Hopcroft's O(n log(n))
  40  * algorithm or Brzozowski's reverse-determinize-reverse-determinize
  41  * algorithm. While the latter has exponential complexity in theory, it
  42  * works quite well for some cases.
  43  */
  44 enum fa_minimization_algorithms {
  45     FA_MIN_HOPCROFT,
  46     FA_MIN_BRZOZOWSKI
  47 };
  48
  49 /* Which minimization algorithm to use in FA_MINIMIZE. The library
  50  * minimizes internally at certain points, too.
  51  *
  52  * Defaults to FA_MIN_HOPCROFT
  53  */
  54 extern int fa_minimization_algorithm;
  55
  56 /* Unless otherwise mentioned, automata passed into routines are never
  57  * modified. It is the responsibility of the caller to free automata
  58  * returned by any of these routines when they are no longer needed.
  59  */
  60
  61 /*
  62  * Compile the regular expression RE of length SIZE into an automaton. The
  63  * return value is the same as the return value for the POSIX function
  64  * regcomp. The syntax for regular expressions is extended POSIX syntax,
  65  * with the difference that '.' does not match newlines.
  66  *
  67  * On success, FA points to the newly allocated automaton constructed for
  68  * RE, and the function returns REG_NOERROR. Otherwise, FA is NULL, and the
  69  * return value indicates the error.
  70  *
  71  * The FA is case sensitive. Call FA_NOCASE to switch it to
  72  * case-insensitive.
  73  */
  74 int fa_compile(const char *re, size_t size, struct fa **fa);
  75
  76 /* Make a new automaton that accepts one of the basic languages defined in
  77  * the enum FA_BASIC.
  78  */
  79 struct fa *fa_make_basic(unsigned int basic);
  80
  81 /* Return 1 if FA accepts the basic language BASIC, which must be one of
  82  * the constantsfrom enum FA_BASIC.
  83  */
  84 int fa_is_basic(struct fa *fa, unsigned int basic);
  85
  86 /* Minimize FA using Brzozowski's algorithm. As a side-effect, the
  87  * automaton will also be deterministic after being minimized. Modifies the
  88  * automaton in place.
  89  */
  90 int fa_minimize(struct fa *fa);
  91
  92 /* Return a finite automaton that accepts the concatenation of the
  93  * languages for FA1 and FA2, i.e. L(FA1).L(FA2)
  94  */
  95 struct fa *fa_concat(struct fa *fa1, struct fa *fa2);
  96
  97 /* Return a finite automaton that accepts the union of the languages that
  98  * FA1 and FA2 accept (the '|' operator in regular expressions).
  99  */
 100 struct fa *fa_union(struct fa *fa1, struct fa *fa2);
 101
 102 /* Return a finite automaton that accepts the intersection of the languages
 103  * of FA1 and FA2.
 104  */
 105 struct fa *fa_intersect(struct fa *fa1, struct fa *fa2);
 106
 107 /* Return a finite automaton that accepts the complement of the language of
 108  * FA, i.e. the set of all words not accepted by FA
 109  */
 110 struct fa *fa_complement(struct fa *fa);
 111
 112 /* Return a finite automaton that accepts the set difference of the
 113  * languages of FA1 and FA2, i.e. L(FA1)\L(FA2)
 114  */
 115 struct fa *fa_minus(struct fa *fa1, struct fa *fa2);
 116
 117 /* Return a finite automaton that accepts a repetition of the language that
 118  * FA accepts. If MAX == -1, the returned automaton accepts arbitrarily
 119  * long repetitions. MIN must be 0 or bigger, and unless MAX == -1, MIN
 120  * must be less or equal to MAX. If MIN is greater than 0, the returned
 121  * automaton accepts only words that have at least MIN repetitions of words
 122  * from L(FA).
 123  *
 124  * The following common regexp repetitios are achieved by the following
 125  * calls (using a lose notation equating automata and their languages):
 126  *
 127  * - FA* = FA_ITER(FA, 0, -1)
 128  * - FA+ = FA_ITER(FA, 1, -1)
 129  * - FA? = FA_ITER(FA, 0, 1)
 130  * - FA{n,m} = FA_ITER(FA, n, m) with 0 <= n and m = -1 or n <= m
 131  */
 132 struct fa *fa_iter(struct fa *fa, int min, int max);
 133
 134 /* Return 1 if the language of FA1 is contained in the language of FA2, 0
 135  * otherwise.
 136  */
 137 int fa_contains(struct fa *fa1, struct fa *fa2);
 138
 139 /* Return 1 if the language of FA1 equals the language of FA2 */
 140 int fa_equals(struct fa *fa1, struct fa *fa2);
 141
 142 /* Free all memory used by FA */
 143 void fa_free(struct fa *fa);
 144
 145 /* Print FA to OUT as a graphviz dot file */
 146 void fa_dot(FILE *out, struct fa *fa);
 147
 148 /* Return a finite automaton that accepts the overlap of the languages of
 149  * FA1 and FA2. The overlap of two languages is the set of strings that can
 150  * be split in more than one way into a left part accepted by FA1 and a
 151  * right part accepted by FA2.
 152  */
 153 struct fa *fa_overlap(struct fa *fa1, struct fa *fa2);
 154
 155 /* Produce an example for the language of FA. The example is not
 156  * necessarily the shortest possible. The implementation works very hard to
 157  * have printable characters (preferrably alphanumeric) in the example, and
 158  * to avoid just an empty word.
 159  *
 160  * *EXAMPLE will be the example, which may be NULL. If it is non-NULL,
 161  *  EXAMPLE_LEN will hold the length of the example.
 162  *
 163  * Return 0 on success, and a negative numer on error. On error, *EXAMPLE
 164  * will be NULL
 165  */
 166 int fa_example(struct fa *fa, char **example, size_t *example_len);
 167
 168 /* Produce an example of an ambiguous word for the concatenation of the
 169  * languages of FA1 and FA2. The return value is such a word (which must be
 170  * freed by the caller) if it exists. If none exists, NULL is returned.
 171  *
 172  * The returned word is of the form UPV and PV and V are set to the first
 173  * character of P and V in the returned word. The word UPV has the property
 174  * that U and UP are accepted by FA1 and that PV and V are accepted by FA2.
 175  *
 176  * Neither the language of FA1 or of FA2 may contain words with the
 177  * characters '\001' and '\002', as they are used during construction of
 178  * the ambiguous word.
 179  *
 180  * UPV_LEN will be set to the length of the entire string UPV
 181  *
 182  * Returns 0 on success, and a negative number on failure. On failure, UPV,
 183  * PV, and V will be NULL
 184  */
 185 int fa_ambig_example(struct fa *fa1, struct fa *fa2,
 186                      char **upv, size_t *upv_len,
 187                      char **pv, char **v);
 188
 189 /* Convert the finite automaton FA into a regular expression and set REGEXP
 190  * to point to that. When REGEXP is compiled into another automaton, it is
 191  * guaranteed that that automaton and FA accept the same language.
 192  *
 193  * The code tries to be semi-clever about keeping the generated regular
 194  * expression short; to guarantee reasonably short regexps, the automaton
 195  * should be minimized before passing it to this routine.
 196  *
 197  * On success, REGEXP_LEN is set to the length of REGEXP
 198  *
 199  * Return 0 on success, and a negative number on failure. The only reason
 200  * to fail for FA_AS_REGEXP is running out of memory.
 201  */
 202 int fa_as_regexp(struct fa *fa, char **regexp, size_t *regexp_len);
 203
 204 /* Given the regular expression REGEXP construct a new regular expression
 205  * NEWREGEXP that does not match strings containing any of the characters
 206  * in the range FROM to TO, with the endpoints included.
 207  *
 208  * The new regular expression is constructed by removing the range FROM to
 209  * TO from all character sets in REGEXP; if any of the characters [FROM,
 210  * TO] appear outside a character set in REGEXP, return -2.
 211  *
 212  * Return 0 if NEWREGEXP was constructed successfully, -1 if an internal
 213  * error happened (e.g., an allocation failed) and -2 if NEWREGEXP can not
 214  * be constructed because any character in the range [FROM, TO] appears
 215  * outside of a character set.
 216  *
 217  * Return a positive value if REGEXP is not syntactically valid; the value
 218  * returned is one of the REG_ERRCODE_T POSIX error codes. Return 0 on
 219  * success and -1 if an allocation fails.
 220  */
 221 int fa_restrict_alphabet(const char *regexp, size_t regexp_len,
 222                          char **newregexp, size_t *newregexp_len,
 223                          char from, char to);
 224
 225 /* Convert REGEXP into one that does not use ranges inside character
 226  * classes.
 227  *
 228  * Return a positive value if REGEXP is not syntactically valid; the value
 229  * returned is one of the REG_ERRCODE_T POSIX error codes. Return 0 on
 230  * success and -1 if an allocation fails.
 231  */
 232 int fa_expand_char_ranges(const char *regexp, size_t regexp_len,
 233                           char **newregexp, size_t *newregexp_len);
 234
 235 /* Modify FA so that it matches ignoring case.
 236  *
 237  * Returns 0 on success, and -1 if an allocation fails. On failure, the
 238  * automaton is not guaranteed to represent anything sensible.
 239  */
 240 int fa_nocase(struct fa *fa);
 241
 242 /* Return 1 if FA matches ignoring case, 0 if matches are case sensitive */
 243 int fa_is_nocase(struct fa *fa);
 244
 245 /* Assume REGEXP is a case-insensitive regular expression, and convert it
 246  * to one that matches the same strings when used case sensitively. All
 247  * occurrences of individual letters c in the regular expression will be
 248  * replaced by character sets [cC], and lower/upper case characters are
 249  * added to character sets as needed.
 250  *
 251  * Return a positive value if REGEXP is not syntactically valid; the value
 252  * returned is one of the REG_ERRCODE_T POSIX error codes. Return 0 on
 253  * success and -1 if an allocation fails.
 254  */
 255 int fa_expand_nocase(const char *regexp, size_t regexp_len,
 256                      char **newregexp, size_t *newregexp_len);
 257 #endif
 258
 259
 260 /*
 261  * Local variables:
 262  *  indent-tabs-mode: nil
 263  *  c-indent-level: 4
 264  *  c-basic-offset: 4
 265  *  tab-width: 4
 266  * End:
 267  */