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 #include "llvm/ADT/SmallVector.h"
15 #include "llvm/ADT/StringRef.h"
22 /// Compile with support for subgroup matches, this is just to make
23 /// constructs like Regex("...", 0) more readable as Regex("...", Sub).
25 /// Compile for matching that ignores upper/lower case distinctions.
27 /// Compile for matching that need only report success or failure,
28 /// not what was matched.
30 /// Compile for newline-sensitive matching. With this flag '[^' bracket
31 /// expressions and '.' never match newline. A ^ anchor matches the
32 /// null string after any newline in the string in addition to its normal
33 /// function, and the $ anchor matches the null string before any
34 /// newline in the string in addition to its normal function.
38 /// Compiles the given POSIX Extended Regular Expression \arg Regex.
39 /// This implementation supports regexes and matching strings with embedded
41 Regex(const StringRef &Regex, unsigned Flags=NoSub);
44 /// isValid - returns the error encountered during regex compilation, or
46 bool isValid(std::string &Error);
48 /// matches - Match the regex against a given \arg String.
50 /// \param Matches - If given, on a succesful match this will be filled in
51 /// with references to the matched group expressions (inside \arg String),
52 /// the first group is always the entire pattern.
53 /// By default the regex is compiled with NoSub, which disables support for
55 /// For this feature to be enabled you must construct the regex using
56 /// Regex("...", Regex::Sub) constructor.
58 bool match(const StringRef &String, SmallVectorImpl<StringRef> *Matches=0);
60 struct llvm_regex *preg;