xref: /aosp_15_r20/external/regex-re2/util/pcre.h (revision ccdc9c3e24c519bfa4832a66aa2e83a52c19f295)
1*ccdc9c3eSSadaf Ebrahimi // Copyright 2003-2010 Google Inc.  All Rights Reserved.
2*ccdc9c3eSSadaf Ebrahimi // Use of this source code is governed by a BSD-style
3*ccdc9c3eSSadaf Ebrahimi // license that can be found in the LICENSE file.
4*ccdc9c3eSSadaf Ebrahimi 
5*ccdc9c3eSSadaf Ebrahimi #ifndef UTIL_PCRE_H_
6*ccdc9c3eSSadaf Ebrahimi #define UTIL_PCRE_H_
7*ccdc9c3eSSadaf Ebrahimi 
8*ccdc9c3eSSadaf Ebrahimi // This is a variant of PCRE's pcrecpp.h, originally written at Google.
9*ccdc9c3eSSadaf Ebrahimi // The main changes are the addition of the HitLimit method and
10*ccdc9c3eSSadaf Ebrahimi // compilation as PCRE in namespace re2.
11*ccdc9c3eSSadaf Ebrahimi 
12*ccdc9c3eSSadaf Ebrahimi // C++ interface to the pcre regular-expression library.  PCRE supports
13*ccdc9c3eSSadaf Ebrahimi // Perl-style regular expressions (with extensions like \d, \w, \s,
14*ccdc9c3eSSadaf Ebrahimi // ...).
15*ccdc9c3eSSadaf Ebrahimi //
16*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
17*ccdc9c3eSSadaf Ebrahimi // REGEXP SYNTAX:
18*ccdc9c3eSSadaf Ebrahimi //
19*ccdc9c3eSSadaf Ebrahimi // This module uses the pcre library and hence supports its syntax
20*ccdc9c3eSSadaf Ebrahimi // for regular expressions:
21*ccdc9c3eSSadaf Ebrahimi //
22*ccdc9c3eSSadaf Ebrahimi //      http://www.google.com/search?q=pcre
23*ccdc9c3eSSadaf Ebrahimi //
24*ccdc9c3eSSadaf Ebrahimi // The syntax is pretty similar to Perl's.  For those not familiar
25*ccdc9c3eSSadaf Ebrahimi // with Perl's regular expressions, here are some examples of the most
26*ccdc9c3eSSadaf Ebrahimi // commonly used extensions:
27*ccdc9c3eSSadaf Ebrahimi //
28*ccdc9c3eSSadaf Ebrahimi //   "hello (\\w+) world"  -- \w matches a "word" character
29*ccdc9c3eSSadaf Ebrahimi //   "version (\\d+)"      -- \d matches a digit
30*ccdc9c3eSSadaf Ebrahimi //   "hello\\s+world"      -- \s matches any whitespace character
31*ccdc9c3eSSadaf Ebrahimi //   "\\b(\\w+)\\b"        -- \b matches empty string at a word boundary
32*ccdc9c3eSSadaf Ebrahimi //   "(?i)hello"           -- (?i) turns on case-insensitive matching
33*ccdc9c3eSSadaf Ebrahimi //   "/\\*(.*?)\\*/"       -- .*? matches . minimum no. of times possible
34*ccdc9c3eSSadaf Ebrahimi //
35*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
36*ccdc9c3eSSadaf Ebrahimi // MATCHING INTERFACE:
37*ccdc9c3eSSadaf Ebrahimi //
38*ccdc9c3eSSadaf Ebrahimi // The "FullMatch" operation checks that supplied text matches a
39*ccdc9c3eSSadaf Ebrahimi // supplied pattern exactly.
40*ccdc9c3eSSadaf Ebrahimi //
41*ccdc9c3eSSadaf Ebrahimi // Example: successful match
42*ccdc9c3eSSadaf Ebrahimi //    CHECK(PCRE::FullMatch("hello", "h.*o"));
43*ccdc9c3eSSadaf Ebrahimi //
44*ccdc9c3eSSadaf Ebrahimi // Example: unsuccessful match (requires full match):
45*ccdc9c3eSSadaf Ebrahimi //    CHECK(!PCRE::FullMatch("hello", "e"));
46*ccdc9c3eSSadaf Ebrahimi //
47*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
48*ccdc9c3eSSadaf Ebrahimi // UTF-8 AND THE MATCHING INTERFACE:
49*ccdc9c3eSSadaf Ebrahimi //
50*ccdc9c3eSSadaf Ebrahimi // By default, pattern and text are plain text, one byte per character.
51*ccdc9c3eSSadaf Ebrahimi // The UTF8 flag, passed to the constructor, causes both pattern
52*ccdc9c3eSSadaf Ebrahimi // and string to be treated as UTF-8 text, still a byte stream but
53*ccdc9c3eSSadaf Ebrahimi // potentially multiple bytes per character. In practice, the text
54*ccdc9c3eSSadaf Ebrahimi // is likelier to be UTF-8 than the pattern, but the match returned
55*ccdc9c3eSSadaf Ebrahimi // may depend on the UTF8 flag, so always use it when matching
56*ccdc9c3eSSadaf Ebrahimi // UTF8 text.  E.g., "." will match one byte normally but with UTF8
57*ccdc9c3eSSadaf Ebrahimi // set may match up to three bytes of a multi-byte character.
58*ccdc9c3eSSadaf Ebrahimi //
59*ccdc9c3eSSadaf Ebrahimi // Example:
60*ccdc9c3eSSadaf Ebrahimi //    PCRE re(utf8_pattern, PCRE::UTF8);
61*ccdc9c3eSSadaf Ebrahimi //    CHECK(PCRE::FullMatch(utf8_string, re));
62*ccdc9c3eSSadaf Ebrahimi //
63*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
64*ccdc9c3eSSadaf Ebrahimi // MATCHING WITH SUBSTRING EXTRACTION:
65*ccdc9c3eSSadaf Ebrahimi //
66*ccdc9c3eSSadaf Ebrahimi // You can supply extra pointer arguments to extract matched substrings.
67*ccdc9c3eSSadaf Ebrahimi //
68*ccdc9c3eSSadaf Ebrahimi // Example: extracts "ruby" into "s" and 1234 into "i"
69*ccdc9c3eSSadaf Ebrahimi //    int i;
70*ccdc9c3eSSadaf Ebrahimi //    string s;
71*ccdc9c3eSSadaf Ebrahimi //    CHECK(PCRE::FullMatch("ruby:1234", "(\\w+):(\\d+)", &s, &i));
72*ccdc9c3eSSadaf Ebrahimi //
73*ccdc9c3eSSadaf Ebrahimi // Example: fails because string cannot be stored in integer
74*ccdc9c3eSSadaf Ebrahimi //    CHECK(!PCRE::FullMatch("ruby", "(.*)", &i));
75*ccdc9c3eSSadaf Ebrahimi //
76*ccdc9c3eSSadaf Ebrahimi // Example: fails because there aren't enough sub-patterns:
77*ccdc9c3eSSadaf Ebrahimi //    CHECK(!PCRE::FullMatch("ruby:1234", "\\w+:\\d+", &s));
78*ccdc9c3eSSadaf Ebrahimi //
79*ccdc9c3eSSadaf Ebrahimi // Example: does not try to extract any extra sub-patterns
80*ccdc9c3eSSadaf Ebrahimi //    CHECK(PCRE::FullMatch("ruby:1234", "(\\w+):(\\d+)", &s));
81*ccdc9c3eSSadaf Ebrahimi //
82*ccdc9c3eSSadaf Ebrahimi // Example: does not try to extract into NULL
83*ccdc9c3eSSadaf Ebrahimi //    CHECK(PCRE::FullMatch("ruby:1234", "(\\w+):(\\d+)", NULL, &i));
84*ccdc9c3eSSadaf Ebrahimi //
85*ccdc9c3eSSadaf Ebrahimi // Example: integer overflow causes failure
86*ccdc9c3eSSadaf Ebrahimi //    CHECK(!PCRE::FullMatch("ruby:1234567891234", "\\w+:(\\d+)", &i));
87*ccdc9c3eSSadaf Ebrahimi //
88*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
89*ccdc9c3eSSadaf Ebrahimi // PARTIAL MATCHES
90*ccdc9c3eSSadaf Ebrahimi //
91*ccdc9c3eSSadaf Ebrahimi // You can use the "PartialMatch" operation when you want the pattern
92*ccdc9c3eSSadaf Ebrahimi // to match any substring of the text.
93*ccdc9c3eSSadaf Ebrahimi //
94*ccdc9c3eSSadaf Ebrahimi // Example: simple search for a string:
95*ccdc9c3eSSadaf Ebrahimi //      CHECK(PCRE::PartialMatch("hello", "ell"));
96*ccdc9c3eSSadaf Ebrahimi //
97*ccdc9c3eSSadaf Ebrahimi // Example: find first number in a string
98*ccdc9c3eSSadaf Ebrahimi //      int number;
99*ccdc9c3eSSadaf Ebrahimi //      CHECK(PCRE::PartialMatch("x*100 + 20", "(\\d+)", &number));
100*ccdc9c3eSSadaf Ebrahimi //      CHECK_EQ(number, 100);
101*ccdc9c3eSSadaf Ebrahimi //
102*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
103*ccdc9c3eSSadaf Ebrahimi // PPCRE-COMPILED PCREGULAR EXPPCRESSIONS
104*ccdc9c3eSSadaf Ebrahimi //
105*ccdc9c3eSSadaf Ebrahimi // PCRE makes it easy to use any string as a regular expression, without
106*ccdc9c3eSSadaf Ebrahimi // requiring a separate compilation step.
107*ccdc9c3eSSadaf Ebrahimi //
108*ccdc9c3eSSadaf Ebrahimi // If speed is of the essence, you can create a pre-compiled "PCRE"
109*ccdc9c3eSSadaf Ebrahimi // object from the pattern and use it multiple times.  If you do so,
110*ccdc9c3eSSadaf Ebrahimi // you can typically parse text faster than with sscanf.
111*ccdc9c3eSSadaf Ebrahimi //
112*ccdc9c3eSSadaf Ebrahimi // Example: precompile pattern for faster matching:
113*ccdc9c3eSSadaf Ebrahimi //    PCRE pattern("h.*o");
114*ccdc9c3eSSadaf Ebrahimi //    while (ReadLine(&str)) {
115*ccdc9c3eSSadaf Ebrahimi //      if (PCRE::FullMatch(str, pattern)) ...;
116*ccdc9c3eSSadaf Ebrahimi //    }
117*ccdc9c3eSSadaf Ebrahimi //
118*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
119*ccdc9c3eSSadaf Ebrahimi // SCANNING TEXT INCPCREMENTALLY
120*ccdc9c3eSSadaf Ebrahimi //
121*ccdc9c3eSSadaf Ebrahimi // The "Consume" operation may be useful if you want to repeatedly
122*ccdc9c3eSSadaf Ebrahimi // match regular expressions at the front of a string and skip over
123*ccdc9c3eSSadaf Ebrahimi // them as they match.  This requires use of the "StringPiece" type,
124*ccdc9c3eSSadaf Ebrahimi // which represents a sub-range of a real string.
125*ccdc9c3eSSadaf Ebrahimi //
126*ccdc9c3eSSadaf Ebrahimi // Example: read lines of the form "var = value" from a string.
127*ccdc9c3eSSadaf Ebrahimi //      string contents = ...;          // Fill string somehow
128*ccdc9c3eSSadaf Ebrahimi //      StringPiece input(contents);    // Wrap a StringPiece around it
129*ccdc9c3eSSadaf Ebrahimi //
130*ccdc9c3eSSadaf Ebrahimi //      string var;
131*ccdc9c3eSSadaf Ebrahimi //      int value;
132*ccdc9c3eSSadaf Ebrahimi //      while (PCRE::Consume(&input, "(\\w+) = (\\d+)\n", &var, &value)) {
133*ccdc9c3eSSadaf Ebrahimi //        ...;
134*ccdc9c3eSSadaf Ebrahimi //      }
135*ccdc9c3eSSadaf Ebrahimi //
136*ccdc9c3eSSadaf Ebrahimi // Each successful call to "Consume" will set "var/value", and also
137*ccdc9c3eSSadaf Ebrahimi // advance "input" so it points past the matched text.  Note that if the
138*ccdc9c3eSSadaf Ebrahimi // regular expression matches an empty string, input will advance
139*ccdc9c3eSSadaf Ebrahimi // by 0 bytes.  If the regular expression being used might match
140*ccdc9c3eSSadaf Ebrahimi // an empty string, the loop body must check for this case and either
141*ccdc9c3eSSadaf Ebrahimi // advance the string or break out of the loop.
142*ccdc9c3eSSadaf Ebrahimi //
143*ccdc9c3eSSadaf Ebrahimi // The "FindAndConsume" operation is similar to "Consume" but does not
144*ccdc9c3eSSadaf Ebrahimi // anchor your match at the beginning of the string.  For example, you
145*ccdc9c3eSSadaf Ebrahimi // could extract all words from a string by repeatedly calling
146*ccdc9c3eSSadaf Ebrahimi //     PCRE::FindAndConsume(&input, "(\\w+)", &word)
147*ccdc9c3eSSadaf Ebrahimi //
148*ccdc9c3eSSadaf Ebrahimi // -----------------------------------------------------------------------
149*ccdc9c3eSSadaf Ebrahimi // PARSING HEX/OCTAL/C-RADIX NUMBERS
150*ccdc9c3eSSadaf Ebrahimi //
151*ccdc9c3eSSadaf Ebrahimi // By default, if you pass a pointer to a numeric value, the
152*ccdc9c3eSSadaf Ebrahimi // corresponding text is interpreted as a base-10 number.  You can
153*ccdc9c3eSSadaf Ebrahimi // instead wrap the pointer with a call to one of the operators Hex(),
154*ccdc9c3eSSadaf Ebrahimi // Octal(), or CRadix() to interpret the text in another base.  The
155*ccdc9c3eSSadaf Ebrahimi // CRadix operator interprets C-style "0" (base-8) and "0x" (base-16)
156*ccdc9c3eSSadaf Ebrahimi // prefixes, but defaults to base-10.
157*ccdc9c3eSSadaf Ebrahimi //
158*ccdc9c3eSSadaf Ebrahimi // Example:
159*ccdc9c3eSSadaf Ebrahimi //   int a, b, c, d;
160*ccdc9c3eSSadaf Ebrahimi //   CHECK(PCRE::FullMatch("100 40 0100 0x40", "(.*) (.*) (.*) (.*)",
161*ccdc9c3eSSadaf Ebrahimi //         Octal(&a), Hex(&b), CRadix(&c), CRadix(&d));
162*ccdc9c3eSSadaf Ebrahimi // will leave 64 in a, b, c, and d.
163*ccdc9c3eSSadaf Ebrahimi 
164*ccdc9c3eSSadaf Ebrahimi #include "util/util.h"
165*ccdc9c3eSSadaf Ebrahimi #include "re2/stringpiece.h"
166*ccdc9c3eSSadaf Ebrahimi 
167*ccdc9c3eSSadaf Ebrahimi #ifdef USEPCRE
168*ccdc9c3eSSadaf Ebrahimi #include <pcre.h>
169*ccdc9c3eSSadaf Ebrahimi namespace re2 {
170*ccdc9c3eSSadaf Ebrahimi const bool UsingPCRE = true;
171*ccdc9c3eSSadaf Ebrahimi }  // namespace re2
172*ccdc9c3eSSadaf Ebrahimi #else
173*ccdc9c3eSSadaf Ebrahimi struct pcre;  // opaque
174*ccdc9c3eSSadaf Ebrahimi namespace re2 {
175*ccdc9c3eSSadaf Ebrahimi const bool UsingPCRE = false;
176*ccdc9c3eSSadaf Ebrahimi }  // namespace re2
177*ccdc9c3eSSadaf Ebrahimi #endif
178*ccdc9c3eSSadaf Ebrahimi 
179*ccdc9c3eSSadaf Ebrahimi namespace re2 {
180*ccdc9c3eSSadaf Ebrahimi 
181*ccdc9c3eSSadaf Ebrahimi class PCRE_Options;
182*ccdc9c3eSSadaf Ebrahimi 
183*ccdc9c3eSSadaf Ebrahimi // Interface for regular expression matching.  Also corresponds to a
184*ccdc9c3eSSadaf Ebrahimi // pre-compiled regular expression.  An "PCRE" object is safe for
185*ccdc9c3eSSadaf Ebrahimi // concurrent use by multiple threads.
186*ccdc9c3eSSadaf Ebrahimi class PCRE {
187*ccdc9c3eSSadaf Ebrahimi  public:
188*ccdc9c3eSSadaf Ebrahimi   // We convert user-passed pointers into special Arg objects
189*ccdc9c3eSSadaf Ebrahimi   class Arg;
190*ccdc9c3eSSadaf Ebrahimi 
191*ccdc9c3eSSadaf Ebrahimi   // Marks end of arg list.
192*ccdc9c3eSSadaf Ebrahimi   // ONLY USE IN OPTIONAL ARG DEFAULTS.
193*ccdc9c3eSSadaf Ebrahimi   // DO NOT PASS EXPLICITLY.
194*ccdc9c3eSSadaf Ebrahimi   static Arg no_more_args;
195*ccdc9c3eSSadaf Ebrahimi 
196*ccdc9c3eSSadaf Ebrahimi   // Options are same value as those in pcre.  We provide them here
197*ccdc9c3eSSadaf Ebrahimi   // to avoid users needing to include pcre.h and also to isolate
198*ccdc9c3eSSadaf Ebrahimi   // users from pcre should we change the underlying library.
199*ccdc9c3eSSadaf Ebrahimi   // Only those needed by Google programs are exposed here to
200*ccdc9c3eSSadaf Ebrahimi   // avoid collision with options employed internally by regexp.cc
201*ccdc9c3eSSadaf Ebrahimi   // Note that some options have equivalents that can be specified in
202*ccdc9c3eSSadaf Ebrahimi   // the regexp itself.  For example, prefixing your regexp with
203*ccdc9c3eSSadaf Ebrahimi   // "(?s)" has the same effect as the PCRE_DOTALL option.
204*ccdc9c3eSSadaf Ebrahimi   enum Option {
205*ccdc9c3eSSadaf Ebrahimi     None = 0x0000,
206*ccdc9c3eSSadaf Ebrahimi     UTF8 = 0x0800,  // == PCRE_UTF8
207*ccdc9c3eSSadaf Ebrahimi     EnabledCompileOptions = UTF8,
208*ccdc9c3eSSadaf Ebrahimi     EnabledExecOptions = 0x0000,  // TODO: use to replace anchor flag
209*ccdc9c3eSSadaf Ebrahimi   };
210*ccdc9c3eSSadaf Ebrahimi 
211*ccdc9c3eSSadaf Ebrahimi   // We provide implicit conversions from strings so that users can
212*ccdc9c3eSSadaf Ebrahimi   // pass in a string or a "const char*" wherever an "PCRE" is expected.
213*ccdc9c3eSSadaf Ebrahimi   PCRE(const char* pattern);
214*ccdc9c3eSSadaf Ebrahimi   PCRE(const char* pattern, Option option);
215*ccdc9c3eSSadaf Ebrahimi   PCRE(const string& pattern);
216*ccdc9c3eSSadaf Ebrahimi   PCRE(const string& pattern, Option option);
217*ccdc9c3eSSadaf Ebrahimi   PCRE(const char *pattern, const PCRE_Options& re_option);
218*ccdc9c3eSSadaf Ebrahimi   PCRE(const string& pattern, const PCRE_Options& re_option);
219*ccdc9c3eSSadaf Ebrahimi 
220*ccdc9c3eSSadaf Ebrahimi   ~PCRE();
221*ccdc9c3eSSadaf Ebrahimi 
222*ccdc9c3eSSadaf Ebrahimi   // The string specification for this PCRE.  E.g.
223*ccdc9c3eSSadaf Ebrahimi   //   PCRE re("ab*c?d+");
224*ccdc9c3eSSadaf Ebrahimi   //   re.pattern();    // "ab*c?d+"
pattern()225*ccdc9c3eSSadaf Ebrahimi   const string& pattern() const { return pattern_; }
226*ccdc9c3eSSadaf Ebrahimi 
227*ccdc9c3eSSadaf Ebrahimi   // If PCRE could not be created properly, returns an error string.
228*ccdc9c3eSSadaf Ebrahimi   // Else returns the empty string.
error()229*ccdc9c3eSSadaf Ebrahimi   const string& error() const { return *error_; }
230*ccdc9c3eSSadaf Ebrahimi 
231*ccdc9c3eSSadaf Ebrahimi   // Whether the PCRE has hit a match limit during execution.
232*ccdc9c3eSSadaf Ebrahimi   // Not thread safe.  Intended only for testing.
233*ccdc9c3eSSadaf Ebrahimi   // If hitting match limits is a problem,
234*ccdc9c3eSSadaf Ebrahimi   // you should be using PCRE2 (re2/re2.h)
235*ccdc9c3eSSadaf Ebrahimi   // instead of checking this flag.
236*ccdc9c3eSSadaf Ebrahimi   bool HitLimit();
237*ccdc9c3eSSadaf Ebrahimi   void ClearHitLimit();
238*ccdc9c3eSSadaf Ebrahimi 
239*ccdc9c3eSSadaf Ebrahimi   /***** The useful part: the matching interface *****/
240*ccdc9c3eSSadaf Ebrahimi 
241*ccdc9c3eSSadaf Ebrahimi   // Matches "text" against "pattern".  If pointer arguments are
242*ccdc9c3eSSadaf Ebrahimi   // supplied, copies matched sub-patterns into them.
243*ccdc9c3eSSadaf Ebrahimi   //
244*ccdc9c3eSSadaf Ebrahimi   // You can pass in a "const char*" or a "string" for "text".
245*ccdc9c3eSSadaf Ebrahimi   // You can pass in a "const char*" or a "string" or a "PCRE" for "pattern".
246*ccdc9c3eSSadaf Ebrahimi   //
247*ccdc9c3eSSadaf Ebrahimi   // The provided pointer arguments can be pointers to any scalar numeric
248*ccdc9c3eSSadaf Ebrahimi   // type, or one of:
249*ccdc9c3eSSadaf Ebrahimi   //    string          (matched piece is copied to string)
250*ccdc9c3eSSadaf Ebrahimi   //    StringPiece     (StringPiece is mutated to point to matched piece)
251*ccdc9c3eSSadaf Ebrahimi   //    T               (where "bool T::ParseFrom(const char*, size_t)" exists)
252*ccdc9c3eSSadaf Ebrahimi   //    (void*)NULL     (the corresponding matched sub-pattern is not copied)
253*ccdc9c3eSSadaf Ebrahimi   //
254*ccdc9c3eSSadaf Ebrahimi   // Returns true iff all of the following conditions are satisfied:
255*ccdc9c3eSSadaf Ebrahimi   //   a. "text" matches "pattern" exactly
256*ccdc9c3eSSadaf Ebrahimi   //   b. The number of matched sub-patterns is >= number of supplied pointers
257*ccdc9c3eSSadaf Ebrahimi   //   c. The "i"th argument has a suitable type for holding the
258*ccdc9c3eSSadaf Ebrahimi   //      string captured as the "i"th sub-pattern.  If you pass in
259*ccdc9c3eSSadaf Ebrahimi   //      NULL for the "i"th argument, or pass fewer arguments than
260*ccdc9c3eSSadaf Ebrahimi   //      number of sub-patterns, "i"th captured sub-pattern is
261*ccdc9c3eSSadaf Ebrahimi   //      ignored.
262*ccdc9c3eSSadaf Ebrahimi   //
263*ccdc9c3eSSadaf Ebrahimi   // CAVEAT: An optional sub-pattern that does not exist in the
264*ccdc9c3eSSadaf Ebrahimi   // matched string is assigned the empty string.  Therefore, the
265*ccdc9c3eSSadaf Ebrahimi   // following will return false (because the empty string is not a
266*ccdc9c3eSSadaf Ebrahimi   // valid number):
267*ccdc9c3eSSadaf Ebrahimi   //    int number;
268*ccdc9c3eSSadaf Ebrahimi   //    PCRE::FullMatch("abc", "[a-z]+(\\d+)?", &number);
269*ccdc9c3eSSadaf Ebrahimi   struct FullMatchFunctor {
270*ccdc9c3eSSadaf Ebrahimi     bool operator ()(const StringPiece& text, const PCRE& re, // 3..16 args
271*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr1 = no_more_args,
272*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr2 = no_more_args,
273*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr3 = no_more_args,
274*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr4 = no_more_args,
275*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr5 = no_more_args,
276*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr6 = no_more_args,
277*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr7 = no_more_args,
278*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr8 = no_more_args,
279*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr9 = no_more_args,
280*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr10 = no_more_args,
281*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr11 = no_more_args,
282*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr12 = no_more_args,
283*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr13 = no_more_args,
284*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr14 = no_more_args,
285*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr15 = no_more_args,
286*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr16 = no_more_args) const;
287*ccdc9c3eSSadaf Ebrahimi   };
288*ccdc9c3eSSadaf Ebrahimi 
289*ccdc9c3eSSadaf Ebrahimi   static const FullMatchFunctor FullMatch;
290*ccdc9c3eSSadaf Ebrahimi 
291*ccdc9c3eSSadaf Ebrahimi   // Exactly like FullMatch(), except that "pattern" is allowed to match
292*ccdc9c3eSSadaf Ebrahimi   // a substring of "text".
293*ccdc9c3eSSadaf Ebrahimi   struct PartialMatchFunctor {
294*ccdc9c3eSSadaf Ebrahimi     bool operator ()(const StringPiece& text, const PCRE& re, // 3..16 args
295*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr1 = no_more_args,
296*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr2 = no_more_args,
297*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr3 = no_more_args,
298*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr4 = no_more_args,
299*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr5 = no_more_args,
300*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr6 = no_more_args,
301*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr7 = no_more_args,
302*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr8 = no_more_args,
303*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr9 = no_more_args,
304*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr10 = no_more_args,
305*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr11 = no_more_args,
306*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr12 = no_more_args,
307*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr13 = no_more_args,
308*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr14 = no_more_args,
309*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr15 = no_more_args,
310*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr16 = no_more_args) const;
311*ccdc9c3eSSadaf Ebrahimi   };
312*ccdc9c3eSSadaf Ebrahimi 
313*ccdc9c3eSSadaf Ebrahimi   static const PartialMatchFunctor PartialMatch;
314*ccdc9c3eSSadaf Ebrahimi 
315*ccdc9c3eSSadaf Ebrahimi   // Like FullMatch() and PartialMatch(), except that pattern has to
316*ccdc9c3eSSadaf Ebrahimi   // match a prefix of "text", and "input" is advanced past the matched
317*ccdc9c3eSSadaf Ebrahimi   // text.  Note: "input" is modified iff this routine returns true.
318*ccdc9c3eSSadaf Ebrahimi   struct ConsumeFunctor {
319*ccdc9c3eSSadaf Ebrahimi     bool operator ()(StringPiece* input, const PCRE& pattern, // 3..16 args
320*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr1 = no_more_args,
321*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr2 = no_more_args,
322*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr3 = no_more_args,
323*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr4 = no_more_args,
324*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr5 = no_more_args,
325*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr6 = no_more_args,
326*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr7 = no_more_args,
327*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr8 = no_more_args,
328*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr9 = no_more_args,
329*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr10 = no_more_args,
330*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr11 = no_more_args,
331*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr12 = no_more_args,
332*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr13 = no_more_args,
333*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr14 = no_more_args,
334*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr15 = no_more_args,
335*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr16 = no_more_args) const;
336*ccdc9c3eSSadaf Ebrahimi   };
337*ccdc9c3eSSadaf Ebrahimi 
338*ccdc9c3eSSadaf Ebrahimi   static const ConsumeFunctor Consume;
339*ccdc9c3eSSadaf Ebrahimi 
340*ccdc9c3eSSadaf Ebrahimi   // Like Consume(..), but does not anchor the match at the beginning of the
341*ccdc9c3eSSadaf Ebrahimi   // string.  That is, "pattern" need not start its match at the beginning of
342*ccdc9c3eSSadaf Ebrahimi   // "input".  For example, "FindAndConsume(s, "(\\w+)", &word)" finds the next
343*ccdc9c3eSSadaf Ebrahimi   // word in "s" and stores it in "word".
344*ccdc9c3eSSadaf Ebrahimi   struct FindAndConsumeFunctor {
345*ccdc9c3eSSadaf Ebrahimi     bool operator ()(StringPiece* input, const PCRE& pattern,
346*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr1 = no_more_args,
347*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr2 = no_more_args,
348*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr3 = no_more_args,
349*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr4 = no_more_args,
350*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr5 = no_more_args,
351*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr6 = no_more_args,
352*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr7 = no_more_args,
353*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr8 = no_more_args,
354*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr9 = no_more_args,
355*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr10 = no_more_args,
356*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr11 = no_more_args,
357*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr12 = no_more_args,
358*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr13 = no_more_args,
359*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr14 = no_more_args,
360*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr15 = no_more_args,
361*ccdc9c3eSSadaf Ebrahimi                      const Arg& ptr16 = no_more_args) const;
362*ccdc9c3eSSadaf Ebrahimi   };
363*ccdc9c3eSSadaf Ebrahimi 
364*ccdc9c3eSSadaf Ebrahimi   static const FindAndConsumeFunctor FindAndConsume;
365*ccdc9c3eSSadaf Ebrahimi 
366*ccdc9c3eSSadaf Ebrahimi   // Replace the first match of "pattern" in "str" with "rewrite".
367*ccdc9c3eSSadaf Ebrahimi   // Within "rewrite", backslash-escaped digits (\1 to \9) can be
368*ccdc9c3eSSadaf Ebrahimi   // used to insert text matching corresponding parenthesized group
369*ccdc9c3eSSadaf Ebrahimi   // from the pattern.  \0 in "rewrite" refers to the entire matching
370*ccdc9c3eSSadaf Ebrahimi   // text.  E.g.,
371*ccdc9c3eSSadaf Ebrahimi   //
372*ccdc9c3eSSadaf Ebrahimi   //   string s = "yabba dabba doo";
373*ccdc9c3eSSadaf Ebrahimi   //   CHECK(PCRE::Replace(&s, "b+", "d"));
374*ccdc9c3eSSadaf Ebrahimi   //
375*ccdc9c3eSSadaf Ebrahimi   // will leave "s" containing "yada dabba doo"
376*ccdc9c3eSSadaf Ebrahimi   //
377*ccdc9c3eSSadaf Ebrahimi   // Returns true if the pattern matches and a replacement occurs,
378*ccdc9c3eSSadaf Ebrahimi   // false otherwise.
379*ccdc9c3eSSadaf Ebrahimi   static bool Replace(string *str,
380*ccdc9c3eSSadaf Ebrahimi                       const PCRE& pattern,
381*ccdc9c3eSSadaf Ebrahimi                       const StringPiece& rewrite);
382*ccdc9c3eSSadaf Ebrahimi 
383*ccdc9c3eSSadaf Ebrahimi   // Like Replace(), except replaces all occurrences of the pattern in
384*ccdc9c3eSSadaf Ebrahimi   // the string with the rewrite.  Replacements are not subject to
385*ccdc9c3eSSadaf Ebrahimi   // re-matching.  E.g.,
386*ccdc9c3eSSadaf Ebrahimi   //
387*ccdc9c3eSSadaf Ebrahimi   //   string s = "yabba dabba doo";
388*ccdc9c3eSSadaf Ebrahimi   //   CHECK(PCRE::GlobalReplace(&s, "b+", "d"));
389*ccdc9c3eSSadaf Ebrahimi   //
390*ccdc9c3eSSadaf Ebrahimi   // will leave "s" containing "yada dada doo"
391*ccdc9c3eSSadaf Ebrahimi   //
392*ccdc9c3eSSadaf Ebrahimi   // Returns the number of replacements made.
393*ccdc9c3eSSadaf Ebrahimi   static int GlobalReplace(string *str,
394*ccdc9c3eSSadaf Ebrahimi                            const PCRE& pattern,
395*ccdc9c3eSSadaf Ebrahimi                            const StringPiece& rewrite);
396*ccdc9c3eSSadaf Ebrahimi 
397*ccdc9c3eSSadaf Ebrahimi   // Like Replace, except that if the pattern matches, "rewrite"
398*ccdc9c3eSSadaf Ebrahimi   // is copied into "out" with substitutions.  The non-matching
399*ccdc9c3eSSadaf Ebrahimi   // portions of "text" are ignored.
400*ccdc9c3eSSadaf Ebrahimi   //
401*ccdc9c3eSSadaf Ebrahimi   // Returns true iff a match occurred and the extraction happened
402*ccdc9c3eSSadaf Ebrahimi   // successfully;  if no match occurs, the string is left unaffected.
403*ccdc9c3eSSadaf Ebrahimi   static bool Extract(const StringPiece &text,
404*ccdc9c3eSSadaf Ebrahimi                       const PCRE& pattern,
405*ccdc9c3eSSadaf Ebrahimi                       const StringPiece &rewrite,
406*ccdc9c3eSSadaf Ebrahimi                       string *out);
407*ccdc9c3eSSadaf Ebrahimi 
408*ccdc9c3eSSadaf Ebrahimi   // Check that the given @p rewrite string is suitable for use with
409*ccdc9c3eSSadaf Ebrahimi   // this PCRE.  It checks that:
410*ccdc9c3eSSadaf Ebrahimi   //   * The PCRE has enough parenthesized subexpressions to satisfy all
411*ccdc9c3eSSadaf Ebrahimi   //       of the \N tokens in @p rewrite, and
412*ccdc9c3eSSadaf Ebrahimi   //   * The @p rewrite string doesn't have any syntax errors
413*ccdc9c3eSSadaf Ebrahimi   //       ('\' followed by anything besides [0-9] and '\').
414*ccdc9c3eSSadaf Ebrahimi   // Making this test will guarantee that "replace" and "extract"
415*ccdc9c3eSSadaf Ebrahimi   // operations won't LOG(ERROR) or fail because of a bad rewrite
416*ccdc9c3eSSadaf Ebrahimi   // string.
417*ccdc9c3eSSadaf Ebrahimi   // @param rewrite The proposed rewrite string.
418*ccdc9c3eSSadaf Ebrahimi   // @param error An error message is recorded here, iff we return false.
419*ccdc9c3eSSadaf Ebrahimi   //              Otherwise, it is unchanged.
420*ccdc9c3eSSadaf Ebrahimi   // @return true, iff @p rewrite is suitable for use with the PCRE.
421*ccdc9c3eSSadaf Ebrahimi   bool CheckRewriteString(const StringPiece& rewrite, string* error) const;
422*ccdc9c3eSSadaf Ebrahimi 
423*ccdc9c3eSSadaf Ebrahimi   // Returns a copy of 'unquoted' with all potentially meaningful
424*ccdc9c3eSSadaf Ebrahimi   // regexp characters backslash-escaped.  The returned string, used
425*ccdc9c3eSSadaf Ebrahimi   // as a regular expression, will exactly match the original string.
426*ccdc9c3eSSadaf Ebrahimi   // For example,
427*ccdc9c3eSSadaf Ebrahimi   //           1.5-2.0?
428*ccdc9c3eSSadaf Ebrahimi   //  becomes:
429*ccdc9c3eSSadaf Ebrahimi   //           1\.5\-2\.0\?
430*ccdc9c3eSSadaf Ebrahimi   static string QuoteMeta(const StringPiece& unquoted);
431*ccdc9c3eSSadaf Ebrahimi 
432*ccdc9c3eSSadaf Ebrahimi   /***** Generic matching interface (not so nice to use) *****/
433*ccdc9c3eSSadaf Ebrahimi 
434*ccdc9c3eSSadaf Ebrahimi   // Type of match (TODO: Should be restructured as an Option)
435*ccdc9c3eSSadaf Ebrahimi   enum Anchor {
436*ccdc9c3eSSadaf Ebrahimi     UNANCHORED,         // No anchoring
437*ccdc9c3eSSadaf Ebrahimi     ANCHOR_START,       // Anchor at start only
438*ccdc9c3eSSadaf Ebrahimi     ANCHOR_BOTH,        // Anchor at start and end
439*ccdc9c3eSSadaf Ebrahimi   };
440*ccdc9c3eSSadaf Ebrahimi 
441*ccdc9c3eSSadaf Ebrahimi   // General matching routine.  Stores the length of the match in
442*ccdc9c3eSSadaf Ebrahimi   // "*consumed" if successful.
443*ccdc9c3eSSadaf Ebrahimi   bool DoMatch(const StringPiece& text,
444*ccdc9c3eSSadaf Ebrahimi                Anchor anchor,
445*ccdc9c3eSSadaf Ebrahimi                size_t* consumed,
446*ccdc9c3eSSadaf Ebrahimi                const Arg* const* args, int n) const;
447*ccdc9c3eSSadaf Ebrahimi 
448*ccdc9c3eSSadaf Ebrahimi   // Return the number of capturing subpatterns, or -1 if the
449*ccdc9c3eSSadaf Ebrahimi   // regexp wasn't valid on construction.
450*ccdc9c3eSSadaf Ebrahimi   int NumberOfCapturingGroups() const;
451*ccdc9c3eSSadaf Ebrahimi 
452*ccdc9c3eSSadaf Ebrahimi  private:
453*ccdc9c3eSSadaf Ebrahimi   void Init(const char* pattern, Option option, int match_limit,
454*ccdc9c3eSSadaf Ebrahimi             int stack_limit, bool report_errors);
455*ccdc9c3eSSadaf Ebrahimi 
456*ccdc9c3eSSadaf Ebrahimi   // Match against "text", filling in "vec" (up to "vecsize" * 2/3) with
457*ccdc9c3eSSadaf Ebrahimi   // pairs of integers for the beginning and end positions of matched
458*ccdc9c3eSSadaf Ebrahimi   // text.  The first pair corresponds to the entire matched text;
459*ccdc9c3eSSadaf Ebrahimi   // subsequent pairs correspond, in order, to parentheses-captured
460*ccdc9c3eSSadaf Ebrahimi   // matches.  Returns the number of pairs (one more than the number of
461*ccdc9c3eSSadaf Ebrahimi   // the last subpattern with a match) if matching was successful
462*ccdc9c3eSSadaf Ebrahimi   // and zero if the match failed.
463*ccdc9c3eSSadaf Ebrahimi   // I.e. for PCRE("(foo)|(bar)|(baz)") it will return 2, 3, and 4 when matching
464*ccdc9c3eSSadaf Ebrahimi   // against "foo", "bar", and "baz" respectively.
465*ccdc9c3eSSadaf Ebrahimi   // When matching PCRE("(foo)|hello") against "hello", it will return 1.
466*ccdc9c3eSSadaf Ebrahimi   // But the values for all subpattern are filled in into "vec".
467*ccdc9c3eSSadaf Ebrahimi   int TryMatch(const StringPiece& text,
468*ccdc9c3eSSadaf Ebrahimi                size_t startpos,
469*ccdc9c3eSSadaf Ebrahimi                Anchor anchor,
470*ccdc9c3eSSadaf Ebrahimi                bool empty_ok,
471*ccdc9c3eSSadaf Ebrahimi                int *vec,
472*ccdc9c3eSSadaf Ebrahimi                int vecsize) const;
473*ccdc9c3eSSadaf Ebrahimi 
474*ccdc9c3eSSadaf Ebrahimi   // Append the "rewrite" string, with backslash subsitutions from "text"
475*ccdc9c3eSSadaf Ebrahimi   // and "vec", to string "out".
476*ccdc9c3eSSadaf Ebrahimi   bool Rewrite(string *out,
477*ccdc9c3eSSadaf Ebrahimi                const StringPiece &rewrite,
478*ccdc9c3eSSadaf Ebrahimi                const StringPiece &text,
479*ccdc9c3eSSadaf Ebrahimi                int *vec,
480*ccdc9c3eSSadaf Ebrahimi                int veclen) const;
481*ccdc9c3eSSadaf Ebrahimi 
482*ccdc9c3eSSadaf Ebrahimi   // internal implementation for DoMatch
483*ccdc9c3eSSadaf Ebrahimi   bool DoMatchImpl(const StringPiece& text,
484*ccdc9c3eSSadaf Ebrahimi                    Anchor anchor,
485*ccdc9c3eSSadaf Ebrahimi                    size_t* consumed,
486*ccdc9c3eSSadaf Ebrahimi                    const Arg* const args[],
487*ccdc9c3eSSadaf Ebrahimi                    int n,
488*ccdc9c3eSSadaf Ebrahimi                    int* vec,
489*ccdc9c3eSSadaf Ebrahimi                    int vecsize) const;
490*ccdc9c3eSSadaf Ebrahimi 
491*ccdc9c3eSSadaf Ebrahimi   // Compile the regexp for the specified anchoring mode
492*ccdc9c3eSSadaf Ebrahimi   pcre* Compile(Anchor anchor);
493*ccdc9c3eSSadaf Ebrahimi 
494*ccdc9c3eSSadaf Ebrahimi   string            pattern_;
495*ccdc9c3eSSadaf Ebrahimi   Option            options_;
496*ccdc9c3eSSadaf Ebrahimi   pcre*             re_full_;        // For full matches
497*ccdc9c3eSSadaf Ebrahimi   pcre*             re_partial_;     // For partial matches
498*ccdc9c3eSSadaf Ebrahimi   const string*     error_;          // Error indicator (or empty string)
499*ccdc9c3eSSadaf Ebrahimi   bool              report_errors_;  // Silences error logging if false
500*ccdc9c3eSSadaf Ebrahimi   int               match_limit_;    // Limit on execution resources
501*ccdc9c3eSSadaf Ebrahimi   int               stack_limit_;    // Limit on stack resources (bytes)
502*ccdc9c3eSSadaf Ebrahimi   mutable int32_t   hit_limit_;  // Hit limit during execution (bool)?
503*ccdc9c3eSSadaf Ebrahimi 
504*ccdc9c3eSSadaf Ebrahimi   PCRE(const PCRE&) = delete;
505*ccdc9c3eSSadaf Ebrahimi   PCRE& operator=(const PCRE&) = delete;
506*ccdc9c3eSSadaf Ebrahimi };
507*ccdc9c3eSSadaf Ebrahimi 
508*ccdc9c3eSSadaf Ebrahimi // PCRE_Options allow you to set the PCRE::Options, plus any pcre
509*ccdc9c3eSSadaf Ebrahimi // "extra" options.  The only extras are match_limit, which limits
510*ccdc9c3eSSadaf Ebrahimi // the CPU time of a match, and stack_limit, which limits the
511*ccdc9c3eSSadaf Ebrahimi // stack usage.  Setting a limit to <= 0 lets PCRE pick a sensible default
512*ccdc9c3eSSadaf Ebrahimi // that should not cause too many problems in production code.
513*ccdc9c3eSSadaf Ebrahimi // If PCRE hits a limit during a match, it may return a false negative,
514*ccdc9c3eSSadaf Ebrahimi // but (hopefully) it won't crash.
515*ccdc9c3eSSadaf Ebrahimi //
516*ccdc9c3eSSadaf Ebrahimi // NOTE: If you are handling regular expressions specified by
517*ccdc9c3eSSadaf Ebrahimi // (external or internal) users, rather than hard-coded ones,
518*ccdc9c3eSSadaf Ebrahimi // you should be using PCRE2, which uses an alternate implementation
519*ccdc9c3eSSadaf Ebrahimi // that avoids these issues.  See http://go/re2quick.
520*ccdc9c3eSSadaf Ebrahimi class PCRE_Options {
521*ccdc9c3eSSadaf Ebrahimi  public:
522*ccdc9c3eSSadaf Ebrahimi   // constructor
PCRE_Options()523*ccdc9c3eSSadaf Ebrahimi   PCRE_Options() : option_(PCRE::None), match_limit_(0), stack_limit_(0), report_errors_(true) {}
524*ccdc9c3eSSadaf Ebrahimi   // accessors
option()525*ccdc9c3eSSadaf Ebrahimi   PCRE::Option option() const { return option_; }
set_option(PCRE::Option option)526*ccdc9c3eSSadaf Ebrahimi   void set_option(PCRE::Option option) {
527*ccdc9c3eSSadaf Ebrahimi     option_ = option;
528*ccdc9c3eSSadaf Ebrahimi   }
match_limit()529*ccdc9c3eSSadaf Ebrahimi   int match_limit() const { return match_limit_; }
set_match_limit(int match_limit)530*ccdc9c3eSSadaf Ebrahimi   void set_match_limit(int match_limit) {
531*ccdc9c3eSSadaf Ebrahimi     match_limit_ = match_limit;
532*ccdc9c3eSSadaf Ebrahimi   }
stack_limit()533*ccdc9c3eSSadaf Ebrahimi   int stack_limit() const { return stack_limit_; }
set_stack_limit(int stack_limit)534*ccdc9c3eSSadaf Ebrahimi   void set_stack_limit(int stack_limit) {
535*ccdc9c3eSSadaf Ebrahimi     stack_limit_ = stack_limit;
536*ccdc9c3eSSadaf Ebrahimi   }
537*ccdc9c3eSSadaf Ebrahimi 
538*ccdc9c3eSSadaf Ebrahimi   // If the regular expression is malformed, an error message will be printed
539*ccdc9c3eSSadaf Ebrahimi   // iff report_errors() is true.  Default: true.
report_errors()540*ccdc9c3eSSadaf Ebrahimi   bool report_errors() const { return report_errors_; }
set_report_errors(bool report_errors)541*ccdc9c3eSSadaf Ebrahimi   void set_report_errors(bool report_errors) {
542*ccdc9c3eSSadaf Ebrahimi     report_errors_ = report_errors;
543*ccdc9c3eSSadaf Ebrahimi   }
544*ccdc9c3eSSadaf Ebrahimi  private:
545*ccdc9c3eSSadaf Ebrahimi   PCRE::Option option_;
546*ccdc9c3eSSadaf Ebrahimi   int match_limit_;
547*ccdc9c3eSSadaf Ebrahimi   int stack_limit_;
548*ccdc9c3eSSadaf Ebrahimi   bool report_errors_;
549*ccdc9c3eSSadaf Ebrahimi };
550*ccdc9c3eSSadaf Ebrahimi 
551*ccdc9c3eSSadaf Ebrahimi 
552*ccdc9c3eSSadaf Ebrahimi /***** Implementation details *****/
553*ccdc9c3eSSadaf Ebrahimi 
554*ccdc9c3eSSadaf Ebrahimi // Hex/Octal/Binary?
555*ccdc9c3eSSadaf Ebrahimi 
556*ccdc9c3eSSadaf Ebrahimi // Special class for parsing into objects that define a ParseFrom() method
557*ccdc9c3eSSadaf Ebrahimi template <class T>
558*ccdc9c3eSSadaf Ebrahimi class _PCRE_MatchObject {
559*ccdc9c3eSSadaf Ebrahimi  public:
Parse(const char * str,size_t n,void * dest)560*ccdc9c3eSSadaf Ebrahimi   static inline bool Parse(const char* str, size_t n, void* dest) {
561*ccdc9c3eSSadaf Ebrahimi     if (dest == NULL) return true;
562*ccdc9c3eSSadaf Ebrahimi     T* object = reinterpret_cast<T*>(dest);
563*ccdc9c3eSSadaf Ebrahimi     return object->ParseFrom(str, n);
564*ccdc9c3eSSadaf Ebrahimi   }
565*ccdc9c3eSSadaf Ebrahimi };
566*ccdc9c3eSSadaf Ebrahimi 
567*ccdc9c3eSSadaf Ebrahimi class PCRE::Arg {
568*ccdc9c3eSSadaf Ebrahimi  public:
569*ccdc9c3eSSadaf Ebrahimi   // Empty constructor so we can declare arrays of PCRE::Arg
570*ccdc9c3eSSadaf Ebrahimi   Arg();
571*ccdc9c3eSSadaf Ebrahimi 
572*ccdc9c3eSSadaf Ebrahimi   // Constructor specially designed for NULL arguments
573*ccdc9c3eSSadaf Ebrahimi   Arg(void*);
574*ccdc9c3eSSadaf Ebrahimi 
575*ccdc9c3eSSadaf Ebrahimi   typedef bool (*Parser)(const char* str, size_t n, void* dest);
576*ccdc9c3eSSadaf Ebrahimi 
577*ccdc9c3eSSadaf Ebrahimi // Type-specific parsers
578*ccdc9c3eSSadaf Ebrahimi #define MAKE_PARSER(type, name)            \
579*ccdc9c3eSSadaf Ebrahimi   Arg(type* p) : arg_(p), parser_(name) {} \
580*ccdc9c3eSSadaf Ebrahimi   Arg(type* p, Parser parser) : arg_(p), parser_(parser) {}
581*ccdc9c3eSSadaf Ebrahimi 
582*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(char,               parse_char);
583*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(signed char,        parse_schar);
584*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(unsigned char,      parse_uchar);
585*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(float,              parse_float);
586*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(double,             parse_double);
587*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(string,             parse_string);
588*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(StringPiece,        parse_stringpiece);
589*ccdc9c3eSSadaf Ebrahimi 
590*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(short,              parse_short);
591*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(unsigned short,     parse_ushort);
592*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(int,                parse_int);
593*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(unsigned int,       parse_uint);
594*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(long,               parse_long);
595*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(unsigned long,      parse_ulong);
596*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(long long,          parse_longlong);
597*ccdc9c3eSSadaf Ebrahimi   MAKE_PARSER(unsigned long long, parse_ulonglong);
598*ccdc9c3eSSadaf Ebrahimi 
599*ccdc9c3eSSadaf Ebrahimi #undef MAKE_PARSER
600*ccdc9c3eSSadaf Ebrahimi 
601*ccdc9c3eSSadaf Ebrahimi   // Generic constructor
602*ccdc9c3eSSadaf Ebrahimi   template <class T> Arg(T*, Parser parser);
603*ccdc9c3eSSadaf Ebrahimi   // Generic constructor template
Arg(T * p)604*ccdc9c3eSSadaf Ebrahimi   template <class T> Arg(T* p)
605*ccdc9c3eSSadaf Ebrahimi     : arg_(p), parser_(_PCRE_MatchObject<T>::Parse) {
606*ccdc9c3eSSadaf Ebrahimi   }
607*ccdc9c3eSSadaf Ebrahimi 
608*ccdc9c3eSSadaf Ebrahimi   // Parse the data
609*ccdc9c3eSSadaf Ebrahimi   bool Parse(const char* str, size_t n) const;
610*ccdc9c3eSSadaf Ebrahimi 
611*ccdc9c3eSSadaf Ebrahimi  private:
612*ccdc9c3eSSadaf Ebrahimi   void*         arg_;
613*ccdc9c3eSSadaf Ebrahimi   Parser        parser_;
614*ccdc9c3eSSadaf Ebrahimi 
615*ccdc9c3eSSadaf Ebrahimi   static bool parse_null          (const char* str, size_t n, void* dest);
616*ccdc9c3eSSadaf Ebrahimi   static bool parse_char          (const char* str, size_t n, void* dest);
617*ccdc9c3eSSadaf Ebrahimi   static bool parse_schar         (const char* str, size_t n, void* dest);
618*ccdc9c3eSSadaf Ebrahimi   static bool parse_uchar         (const char* str, size_t n, void* dest);
619*ccdc9c3eSSadaf Ebrahimi   static bool parse_float         (const char* str, size_t n, void* dest);
620*ccdc9c3eSSadaf Ebrahimi   static bool parse_double        (const char* str, size_t n, void* dest);
621*ccdc9c3eSSadaf Ebrahimi   static bool parse_string        (const char* str, size_t n, void* dest);
622*ccdc9c3eSSadaf Ebrahimi   static bool parse_stringpiece   (const char* str, size_t n, void* dest);
623*ccdc9c3eSSadaf Ebrahimi 
624*ccdc9c3eSSadaf Ebrahimi #define DECLARE_INTEGER_PARSER(name)                                       \
625*ccdc9c3eSSadaf Ebrahimi  private:                                                                  \
626*ccdc9c3eSSadaf Ebrahimi   static bool parse_##name(const char* str, size_t n, void* dest);         \
627*ccdc9c3eSSadaf Ebrahimi   static bool parse_##name##_radix(const char* str, size_t n, void* dest,  \
628*ccdc9c3eSSadaf Ebrahimi                                    int radix);                             \
629*ccdc9c3eSSadaf Ebrahimi                                                                            \
630*ccdc9c3eSSadaf Ebrahimi  public:                                                                   \
631*ccdc9c3eSSadaf Ebrahimi   static bool parse_##name##_hex(const char* str, size_t n, void* dest);   \
632*ccdc9c3eSSadaf Ebrahimi   static bool parse_##name##_octal(const char* str, size_t n, void* dest); \
633*ccdc9c3eSSadaf Ebrahimi   static bool parse_##name##_cradix(const char* str, size_t n, void* dest)
634*ccdc9c3eSSadaf Ebrahimi 
635*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(short);
636*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(ushort);
637*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(int);
638*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(uint);
639*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(long);
640*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(ulong);
641*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(longlong);
642*ccdc9c3eSSadaf Ebrahimi   DECLARE_INTEGER_PARSER(ulonglong);
643*ccdc9c3eSSadaf Ebrahimi 
644*ccdc9c3eSSadaf Ebrahimi #undef DECLARE_INTEGER_PARSER
645*ccdc9c3eSSadaf Ebrahimi 
646*ccdc9c3eSSadaf Ebrahimi };
647*ccdc9c3eSSadaf Ebrahimi 
Arg()648*ccdc9c3eSSadaf Ebrahimi inline PCRE::Arg::Arg() : arg_(NULL), parser_(parse_null) { }
Arg(void * p)649*ccdc9c3eSSadaf Ebrahimi inline PCRE::Arg::Arg(void* p) : arg_(p), parser_(parse_null) { }
650*ccdc9c3eSSadaf Ebrahimi 
Parse(const char * str,size_t n)651*ccdc9c3eSSadaf Ebrahimi inline bool PCRE::Arg::Parse(const char* str, size_t n) const {
652*ccdc9c3eSSadaf Ebrahimi   return (*parser_)(str, n, arg_);
653*ccdc9c3eSSadaf Ebrahimi }
654*ccdc9c3eSSadaf Ebrahimi 
655*ccdc9c3eSSadaf Ebrahimi // This part of the parser, appropriate only for ints, deals with bases
656*ccdc9c3eSSadaf Ebrahimi #define MAKE_INTEGER_PARSER(type, name)                      \
657*ccdc9c3eSSadaf Ebrahimi   inline PCRE::Arg Hex(type* ptr) {                          \
658*ccdc9c3eSSadaf Ebrahimi     return PCRE::Arg(ptr, PCRE::Arg::parse_##name##_hex);    \
659*ccdc9c3eSSadaf Ebrahimi   }                                                          \
660*ccdc9c3eSSadaf Ebrahimi   inline PCRE::Arg Octal(type* ptr) {                        \
661*ccdc9c3eSSadaf Ebrahimi     return PCRE::Arg(ptr, PCRE::Arg::parse_##name##_octal);  \
662*ccdc9c3eSSadaf Ebrahimi   }                                                          \
663*ccdc9c3eSSadaf Ebrahimi   inline PCRE::Arg CRadix(type* ptr) {                       \
664*ccdc9c3eSSadaf Ebrahimi     return PCRE::Arg(ptr, PCRE::Arg::parse_##name##_cradix); \
665*ccdc9c3eSSadaf Ebrahimi   }
666*ccdc9c3eSSadaf Ebrahimi 
667*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(short,              short);
668*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(unsigned short,     ushort);
669*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(int,                int);
670*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(unsigned int,       uint);
671*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(long,               long);
672*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(unsigned long,      ulong);
673*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(long long,          longlong);
674*ccdc9c3eSSadaf Ebrahimi MAKE_INTEGER_PARSER(unsigned long long, ulonglong);
675*ccdc9c3eSSadaf Ebrahimi 
676*ccdc9c3eSSadaf Ebrahimi #undef MAKE_INTEGER_PARSER
677*ccdc9c3eSSadaf Ebrahimi 
678*ccdc9c3eSSadaf Ebrahimi }  // namespace re2
679*ccdc9c3eSSadaf Ebrahimi 
680*ccdc9c3eSSadaf Ebrahimi #endif  // UTIL_PCRE_H_
681