1//===-- Regex.h - Regular Expression matcher implementation -*- C++ -*-----===//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//===----------------------------------------------------------------------===//
9// This file implements a POSIX regular expression matcher. Both Basic and
10// Extended POSIX regular expressions (ERE) are supported. EREs were extended
11// to support backreferences in matches.
12// This implementation also supports matching strings with embedded NUL chars.
14//===----------------------------------------------------------------------===//
16#ifndef LLVM_SUPPORT_REGEX_H
17#define LLVM_SUPPORT_REGEX_H
33 /// Compile for matching that ignores upper/lower case distinctions.
35 /// Compile for newline-sensitive matching. With this flag '[^' bracket
36 /// expressions and '.' never match newline. A ^ anchor matches the
37 /// null string after any newline in the string in addition to its normal
38 /// function, and the $ anchor matches the null string before any
39 /// newline in the string in addition to its normal function.
41 /// By default, the POSIX extended regular expression (ERE) syntax is
42 /// assumed. Pass this flag to turn on basic regular expressions (BRE)
50 /// Compiles the given regular expression \p Regex.
52 /// \param Regex - referenced string is no longer needed after this
53 /// constructor does finish. Only its compiled form is kept stored.
65 /// isValid - returns the error encountered during regex compilation, if
70 /// getNumMatches - In a valid regex, return the number of parenthesized
71 /// matches it contains. The number filled in by match will include this
72 /// many entries plus one for the whole regex (as element 0).
75 /// matches - Match the regex against a given \p String.
77 /// \param Matches - If given, on a successful match this will be filled in
78 /// with references to the matched group expressions (inside \p String),
79 /// the first group is always the entire pattern.
81 /// \param Error - If non-null, any errors in the matching will be recorded
82 /// as a non-empty string. If there is no error, it will be an empty string.
84 /// This returns true on a successful match.
87 std::string *
Error =
nullptr)
const;
89 /// sub - Return the result of replacing the first match of the regex in
90 /// \p String with the \p Repl string. Backreferences like "0円" and "\g<1>"
91 /// in the replacement string are replaced with the appropriate match
94 /// Note that the replacement string has backslash escaping performed on
95 /// it. Invalid backreferences are ignored (replaced by empty strings).
97 /// \param Error If non-null, any errors in the substitution (invalid
98 /// backreferences, trailing backslashes) will be recorded as a non-empty
99 /// string. If there is no error, it will be an empty string.
101 std::string *
Error =
nullptr)
const;
103 /// If this function returns true, ^Str$ is an extended regular
104 /// expression that matches Str and only Str.
107 /// Turn String into a regex by escaping its special characters.
116#endif // LLVM_SUPPORT_REGEX_H
Lightweight error class with error context and mandatory checking.
Regex(const Regex &)=delete
@ Newline
Compile for newline-sensitive matching.
@ IgnoreCase
Compile for matching that ignores upper/lower case distinctions.
@ BasicRegex
By default, the POSIX extended regular expression (ERE) syntax is assumed.
static LLVM_ABI std::string escape(StringRef String)
Turn String into a regex by escaping its special characters.
Regex & operator=(Regex regex)
LLVM_ABI std::string sub(StringRef Repl, StringRef String, std::string *Error=nullptr) const
sub - Return the result of replacing the first match of the regex in String with the Repl string.
static LLVM_ABI bool isLiteralERE(StringRef Str)
If this function returns true, ^Str$ is an extended regular expression that matches Str and only Str.
LLVM_ABI unsigned getNumMatches() const
getNumMatches - In a valid regex, return the number of parenthesized matches it contains.
LLVM_ABI bool match(StringRef String, SmallVectorImpl< StringRef > *Matches=nullptr, std::string *Error=nullptr) const
matches - Match the regex against a given String.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
StringRef - Represent a constant reference to a string, i.e.
This is an optimization pass for GlobalISel generic memory operations.
@ LLVM_MARK_AS_BITMASK_ENUM
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.