Provide a portability macro for __builtin_trap.

[oota-llvm.git] / include / llvm / Support / Regex.h

diff --git a/include/llvm/Support/Regex.h b/include/llvm/Support/Regex.h
index 4c4229eb57b10b508355ce77bc3ce816f2ba6cf3..7648e77bfbb53b0131d028b3291e536be59e045b 100644 (file)
--- a/include/llvm/Support/Regex.h
+++ b/include/llvm/Support/Regex.h
@@ -11,53 +11,71 @@
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/ADT/SmallVector.h"
-#include "llvm/ADT/StringRef.h"
+#ifndef LLVM_SUPPORT_REGEX_H
+#define LLVM_SUPPORT_REGEX_H
+
+#include <string>
 
 struct llvm_regex;
+
 namespace llvm {
+  class StringRef;
+  template<typename T> class SmallVectorImpl;
+
   class Regex {
   public:
     enum {
-      /// Compile with support for subgroup matches, this is just to make
-      /// constructs like Regex("...", 0) more readable as Regex("...", Sub).
-      Sub=0,
+      NoFlags=0,
       /// Compile for matching that ignores upper/lower case distinctions.
       IgnoreCase=1,
-      /// Compile for matching that need only report success or failure,
-      /// not what was matched.
-      NoSub=2,
       /// Compile for newline-sensitive matching. With this flag '[^' bracket
-      /// expressions and '.' never match newline. A ^ anchor matches the 
-      /// null string after any newline in the string in addition to its normal 
-      /// function, and the $ anchor matches the null string before any 
+      /// expressions and '.' never match newline. A ^ anchor matches the
+      /// null string after any newline in the string in addition to its normal
+      /// function, and the $ anchor matches the null string before any
       /// newline in the string in addition to its normal function.
-      Newline=4
+      Newline=2
     };
 
     /// Compiles the given POSIX Extended Regular Expression \arg Regex.
     /// This implementation supports regexes and matching strings with embedded
     /// NUL characters.
-    Regex(const StringRef &Regex, unsigned Flags=NoSub);
+    Regex(StringRef Regex, unsigned Flags = NoFlags);
     ~Regex();
 
     /// isValid - returns the error encountered during regex compilation, or
     /// matching, if any.
     bool isValid(std::string &Error);
 
+    /// getNumMatches - In a valid regex, return the number of parenthesized
+    /// matches it contains.  The number filled in by match will include this
+    /// many entries plus one for the whole regex (as element 0).
+    unsigned getNumMatches() const;
+
     /// matches - Match the regex against a given \arg String.
     ///
-    /// \param Matches - If given, on a succesful match this will be filled in
+    /// \param Matches - If given, on a successful match this will be filled in
     /// with references to the matched group expressions (inside \arg String),
     /// the first group is always the entire pattern.
-    /// By default the regex is compiled with NoSub, which disables support for
-    /// Matches.
-    /// For this feature to be enabled you must construct the regex using
-    /// Regex("...", Regex::Sub) constructor.
-    bool match(const StringRef &String, SmallVectorImpl<StringRef> *Matches=0);
+    ///
+    /// This returns true on a successful match.
+    bool match(StringRef String, SmallVectorImpl<StringRef> *Matches = 0);
+
+    /// sub - Return the result of replacing the first match of the regex in
+    /// \arg String with the \arg Repl string. Backreferences like "\0" in the
+    /// replacement string are replaced with the appropriate match substring.
+    ///
+    /// Note that the replacement string has backslash escaping performed on
+    /// it. Invalid backreferences are ignored (replaced by empty strings).
+    ///
+    /// \param Error If non-null, any errors in the substitution (invalid
+    /// backreferences, trailing backslashes) will be recorded as a non-empty
+    /// string.
+    std::string sub(StringRef Repl, StringRef String, std::string *Error = 0);
+
   private:
     struct llvm_regex *preg;
     int error;
-    bool sub;
   };
 }
+
+#endif // LLVM_SUPPORT_REGEX_H