1 //===-- Regex.h - Regular Expression matcher implementation -*- C++ -*-----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements a POSIX regular expression matcher.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SUPPORT_REGEX_H
15 #define LLVM_SUPPORT_REGEX_H
23 template<typename T> class SmallVectorImpl;
29 /// Compile for matching that ignores upper/lower case distinctions.
31 /// Compile for newline-sensitive matching. With this flag '[^' bracket
32 /// expressions and '.' never match newline. A ^ anchor matches the
33 /// null string after any newline in the string in addition to its normal
34 /// function, and the $ anchor matches the null string before any
35 /// newline in the string in addition to its normal function.
39 /// Compiles the given POSIX Extended Regular Expression \arg Regex.
40 /// This implementation supports regexes and matching strings with embedded
42 Regex(StringRef Regex, unsigned Flags = NoFlags);
45 /// isValid - returns the error encountered during regex compilation, or
47 bool isValid(std::string &Error);
49 /// getNumMatches - In a valid regex, return the number of parenthesized
50 /// matches it contains. The number filled in by match will include this
51 /// many entries plus one for the whole regex (as element 0).
52 unsigned getNumMatches() const;
54 /// matches - Match the regex against a given \arg String.
56 /// \param Matches - If given, on a succesful match this will be filled in
57 /// with references to the matched group expressions (inside \arg String),
58 /// the first group is always the entire pattern.
60 /// This returns true on a successful match.
61 bool match(StringRef String, SmallVectorImpl<StringRef> *Matches = 0);
63 /// sub - Return the result of replacing the first match of the regex in
64 /// \arg String with the \arg Repl string. Backreferences like "\0" in the
65 /// replacement string are replaced with the appropriate match substring.
67 /// Note that the replacement string has backslash escaping performed on
68 /// it. Invalid backreferences are ignored (replaced by empty strings).
70 /// \param Error If non-null, any errors in the substitution (invalid
71 /// backreferences, trailing backslashes) will be recorded as a non-empty
73 std::string sub(StringRef Repl, StringRef String, std::string *Error = 0);
76 struct llvm_regex *preg;
81 #endif // LLVM_SUPPORT_REGEX_H