/[pcre]/code/trunk/doc/pcrepattern.3
ViewVC logotype

Contents of /code/trunk/doc/pcrepattern.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1405 - (show annotations)
Mon Nov 25 15:09:21 2013 UTC (5 years, 10 months ago) by ph10
File size: 133857 byte(s)
Clarify handling of \s in documentation; fix VT in pcretest's built-in tables.
1 .TH PCREPATTERN 3 "25 November 2013" "PCRE 8.34"
2 .SH NAME
3 PCRE - Perl-compatible regular expressions
4 .SH "PCRE REGULAR EXPRESSION DETAILS"
5 .rs
6 .sp
7 The syntax and semantics of the regular expressions that are supported by PCRE
8 are described in detail below. There is a quick-reference syntax summary in the
9 .\" HREF
10 \fBpcresyntax\fP
11 .\"
12 page. PCRE tries to match Perl syntax and semantics as closely as it can. PCRE
13 also supports some alternative regular expression syntax (which does not
14 conflict with the Perl syntax) in order to provide some compatibility with
15 regular expressions in Python, .NET, and Oniguruma.
16 .P
17 Perl's regular expressions are described in its own documentation, and
18 regular expressions in general are covered in a number of books, some of which
19 have copious examples. Jeffrey Friedl's "Mastering Regular Expressions",
20 published by O'Reilly, covers regular expressions in great detail. This
21 description of PCRE's regular expressions is intended as reference material.
22 .P
23 This document discusses the patterns that are supported by PCRE when one its
24 main matching functions, \fBpcre_exec()\fP (8-bit) or \fBpcre[16|32]_exec()\fP
25 (16- or 32-bit), is used. PCRE also has alternative matching functions,
26 \fBpcre_dfa_exec()\fP and \fBpcre[16|32_dfa_exec()\fP, which match using a
27 different algorithm that is not Perl-compatible. Some of the features discussed
28 below are not available when DFA matching is used. The advantages and
29 disadvantages of the alternative functions, and how they differ from the normal
30 functions, are discussed in the
31 .\" HREF
32 \fBpcrematching\fP
33 .\"
34 page.
35 .
36 .
37 .SH "SPECIAL START-OF-PATTERN ITEMS"
38 .rs
39 .sp
40 A number of options that can be passed to \fBpcre_compile()\fP can also be set
41 by special items at the start of a pattern. These are not Perl-compatible, but
42 are provided to make these options accessible to pattern writers who are not
43 able to change the program that processes the pattern. Any number of these
44 items may appear, but they must all be together right at the start of the
45 pattern string, and the letters must be in upper case.
46 .
47 .
48 .SS "UTF support"
49 .rs
50 .sp
51 The original operation of PCRE was on strings of one-byte characters. However,
52 there is now also support for UTF-8 strings in the original library, an
53 extra library that supports 16-bit and UTF-16 character strings, and a
54 third library that supports 32-bit and UTF-32 character strings. To use these
55 features, PCRE must be built to include appropriate support. When using UTF
56 strings you must either call the compiling function with the PCRE_UTF8,
57 PCRE_UTF16, or PCRE_UTF32 option, or the pattern must start with one of
58 these special sequences:
59 .sp
60 (*UTF8)
61 (*UTF16)
62 (*UTF32)
63 (*UTF)
64 .sp
65 (*UTF) is a generic sequence that can be used with any of the libraries.
66 Starting a pattern with such a sequence is equivalent to setting the relevant
67 option. How setting a UTF mode affects pattern matching is mentioned in several
68 places below. There is also a summary of features in the
69 .\" HREF
70 \fBpcreunicode\fP
71 .\"
72 page.
73 .P
74 Some applications that allow their users to supply patterns may wish to
75 restrict them to non-UTF data for security reasons. If the PCRE_NEVER_UTF
76 option is set at compile time, (*UTF) etc. are not allowed, and their
77 appearance causes an error.
78 .
79 .
80 .SS "Unicode property support"
81 .rs
82 .sp
83 Another special sequence that may appear at the start of a pattern is (*UCP).
84 This has the same effect as setting the PCRE_UCP option: it causes sequences
85 such as \ed and \ew to use Unicode properties to determine character types,
86 instead of recognizing only characters with codes less than 128 via a lookup
87 table.
88 .
89 .
90 .SS "Disabling auto-possessification"
91 .rs
92 .sp
93 If a pattern starts with (*NO_AUTO_POSSESS), it has the same effect as setting
94 the PCRE_NO_AUTO_POSSESS option at compile time. This stops PCRE from making
95 quantifiers possessive when what follows cannot match the repeated item. For
96 example, by default a+b is treated as a++b. For more details, see the
97 .\" HREF
98 \fBpcreapi\fP
99 .\"
100 documentation.
101 .
102 .
103 .SS "Disabling start-up optimizations"
104 .rs
105 .sp
106 If a pattern starts with (*NO_START_OPT), it has the same effect as setting the
107 PCRE_NO_START_OPTIMIZE option either at compile or matching time. This disables
108 several optimizations for quickly reaching "no match" results. For more
109 details, see the
110 .\" HREF
111 \fBpcreapi\fP
112 .\"
113 documentation.
114 .
115 .
116 .\" HTML <a name="newlines"></a>
117 .SS "Newline conventions"
118 .rs
119 .sp
120 PCRE supports five different conventions for indicating line breaks in
121 strings: a single CR (carriage return) character, a single LF (linefeed)
122 character, the two-character sequence CRLF, any of the three preceding, or any
123 Unicode newline sequence. The
124 .\" HREF
125 \fBpcreapi\fP
126 .\"
127 page has
128 .\" HTML <a href="pcreapi.html#newlines">
129 .\" </a>
130 further discussion
131 .\"
132 about newlines, and shows how to set the newline convention in the
133 \fIoptions\fP arguments for the compiling and matching functions.
134 .P
135 It is also possible to specify a newline convention by starting a pattern
136 string with one of the following five sequences:
137 .sp
138 (*CR) carriage return
139 (*LF) linefeed
140 (*CRLF) carriage return, followed by linefeed
141 (*ANYCRLF) any of the three above
142 (*ANY) all Unicode newline sequences
143 .sp
144 These override the default and the options given to the compiling function. For
145 example, on a Unix system where LF is the default newline sequence, the pattern
146 .sp
147 (*CR)a.b
148 .sp
149 changes the convention to CR. That pattern matches "a\enb" because LF is no
150 longer a newline. If more than one of these settings is present, the last one
151 is used.
152 .P
153 The newline convention affects where the circumflex and dollar assertions are
154 true. It also affects the interpretation of the dot metacharacter when
155 PCRE_DOTALL is not set, and the behaviour of \eN. However, it does not affect
156 what the \eR escape sequence matches. By default, this is any Unicode newline
157 sequence, for Perl compatibility. However, this can be changed; see the
158 description of \eR in the section entitled
159 .\" HTML <a href="#newlineseq">
160 .\" </a>
161 "Newline sequences"
162 .\"
163 below. A change of \eR setting can be combined with a change of newline
164 convention.
165 .
166 .
167 .SS "Setting match and recursion limits"
168 .rs
169 .sp
170 The caller of \fBpcre_exec()\fP can set a limit on the number of times the
171 internal \fBmatch()\fP function is called and on the maximum depth of
172 recursive calls. These facilities are provided to catch runaway matches that
173 are provoked by patterns with huge matching trees (a typical example is a
174 pattern with nested unlimited repeats) and to avoid running out of system stack
175 by too much recursion. When one of these limits is reached, \fBpcre_exec()\fP
176 gives an error return. The limits can also be set by items at the start of the
177 pattern of the form
178 .sp
179 (*LIMIT_MATCH=d)
180 (*LIMIT_RECURSION=d)
181 .sp
182 where d is any number of decimal digits. However, the value of the setting must
183 be less than the value set (or defaulted) by the caller of \fBpcre_exec()\fP
184 for it to have any effect. In other words, the pattern writer can lower the
185 limits set by the programmer, but not raise them. If there is more than one
186 setting of one of these limits, the lower value is used.
187 .
188 .
189 .SH "EBCDIC CHARACTER CODES"
190 .rs
191 .sp
192 PCRE can be compiled to run in an environment that uses EBCDIC as its character
193 code rather than ASCII or Unicode (typically a mainframe system). In the
194 sections below, character code values are ASCII or Unicode; in an EBCDIC
195 environment these characters may have different code values, and there are no
196 code points greater than 255.
197 .
198 .
199 .SH "CHARACTERS AND METACHARACTERS"
200 .rs
201 .sp
202 A regular expression is a pattern that is matched against a subject string from
203 left to right. Most characters stand for themselves in a pattern, and match the
204 corresponding characters in the subject. As a trivial example, the pattern
205 .sp
206 The quick brown fox
207 .sp
208 matches a portion of a subject string that is identical to itself. When
209 caseless matching is specified (the PCRE_CASELESS option), letters are matched
210 independently of case. In a UTF mode, PCRE always understands the concept of
211 case for characters whose values are less than 128, so caseless matching is
212 always possible. For characters with higher values, the concept of case is
213 supported if PCRE is compiled with Unicode property support, but not otherwise.
214 If you want to use caseless matching for characters 128 and above, you must
215 ensure that PCRE is compiled with Unicode property support as well as with
216 UTF support.
217 .P
218 The power of regular expressions comes from the ability to include alternatives
219 and repetitions in the pattern. These are encoded in the pattern by the use of
220 \fImetacharacters\fP, which do not stand for themselves but instead are
221 interpreted in some special way.
222 .P
223 There are two different sets of metacharacters: those that are recognized
224 anywhere in the pattern except within square brackets, and those that are
225 recognized within square brackets. Outside square brackets, the metacharacters
226 are as follows:
227 .sp
228 \e general escape character with several uses
229 ^ assert start of string (or line, in multiline mode)
230 $ assert end of string (or line, in multiline mode)
231 . match any character except newline (by default)
232 [ start character class definition
233 | start of alternative branch
234 ( start subpattern
235 ) end subpattern
236 ? extends the meaning of (
237 also 0 or 1 quantifier
238 also quantifier minimizer
239 * 0 or more quantifier
240 + 1 or more quantifier
241 also "possessive quantifier"
242 { start min/max quantifier
243 .sp
244 Part of a pattern that is in square brackets is called a "character class". In
245 a character class the only metacharacters are:
246 .sp
247 \e general escape character
248 ^ negate the class, but only if the first character
249 - indicates character range
250 .\" JOIN
251 [ POSIX character class (only if followed by POSIX
252 syntax)
253 ] terminates the character class
254 .sp
255 The following sections describe the use of each of the metacharacters.
256 .
257 .
258 .SH BACKSLASH
259 .rs
260 .sp
261 The backslash character has several uses. Firstly, if it is followed by a
262 character that is not a number or a letter, it takes away any special meaning
263 that character may have. This use of backslash as an escape character applies
264 both inside and outside character classes.
265 .P
266 For example, if you want to match a * character, you write \e* in the pattern.
267 This escaping action applies whether or not the following character would
268 otherwise be interpreted as a metacharacter, so it is always safe to precede a
269 non-alphanumeric with backslash to specify that it stands for itself. In
270 particular, if you want to match a backslash, you write \e\e.
271 .P
272 In a UTF mode, only ASCII numbers and letters have any special meaning after a
273 backslash. All other characters (in particular, those whose codepoints are
274 greater than 127) are treated as literals.
275 .P
276 If a pattern is compiled with the PCRE_EXTENDED option, most white space in the
277 pattern (other than in a character class), and characters between a # outside a
278 character class and the next newline, inclusive, are ignored. An escaping
279 backslash can be used to include a white space or # character as part of the
280 pattern.
281 .P
282 If you want to remove the special meaning from a sequence of characters, you
283 can do so by putting them between \eQ and \eE. This is different from Perl in
284 that $ and @ are handled as literals in \eQ...\eE sequences in PCRE, whereas in
285 Perl, $ and @ cause variable interpolation. Note the following examples:
286 .sp
287 Pattern PCRE matches Perl matches
288 .sp
289 .\" JOIN
290 \eQabc$xyz\eE abc$xyz abc followed by the
291 contents of $xyz
292 \eQabc\e$xyz\eE abc\e$xyz abc\e$xyz
293 \eQabc\eE\e$\eQxyz\eE abc$xyz abc$xyz
294 .sp
295 The \eQ...\eE sequence is recognized both inside and outside character classes.
296 An isolated \eE that is not preceded by \eQ is ignored. If \eQ is not followed
297 by \eE later in the pattern, the literal interpretation continues to the end of
298 the pattern (that is, \eE is assumed at the end). If the isolated \eQ is inside
299 a character class, this causes an error, because the character class is not
300 terminated.
301 .
302 .
303 .\" HTML <a name="digitsafterbackslash"></a>
304 .SS "Non-printing characters"
305 .rs
306 .sp
307 A second use of backslash provides a way of encoding non-printing characters
308 in patterns in a visible manner. There is no restriction on the appearance of
309 non-printing characters, apart from the binary zero that terminates a pattern,
310 but when a pattern is being prepared by text editing, it is often easier to use
311 one of the following escape sequences than the binary character it represents:
312 .sp
313 \ea alarm, that is, the BEL character (hex 07)
314 \ecx "control-x", where x is any ASCII character
315 \ee escape (hex 1B)
316 \ef form feed (hex 0C)
317 \en linefeed (hex 0A)
318 \er carriage return (hex 0D)
319 \et tab (hex 09)
320 \e0dd character with octal code 0dd
321 \eddd character with octal code ddd, or back reference
322 \eo{ddd..} character with octal code ddd..
323 \exhh character with hex code hh
324 \ex{hhh..} character with hex code hhh.. (non-JavaScript mode)
325 \euhhhh character with hex code hhhh (JavaScript mode only)
326 .sp
327 The precise effect of \ecx on ASCII characters is as follows: if x is a lower
328 case letter, it is converted to upper case. Then bit 6 of the character (hex
329 40) is inverted. Thus \ecA to \ecZ become hex 01 to hex 1A (A is 41, Z is 5A),
330 but \ec{ becomes hex 3B ({ is 7B), and \ec; becomes hex 7B (; is 3B). If the
331 data item (byte or 16-bit value) following \ec has a value greater than 127, a
332 compile-time error occurs. This locks out non-ASCII characters in all modes.
333 .P
334 The \ec facility was designed for use with ASCII characters, but with the
335 extension to Unicode it is even less useful than it once was. It is, however,
336 recognized when PCRE is compiled in EBCDIC mode, where data items are always
337 bytes. In this mode, all values are valid after \ec. If the next character is a
338 lower case letter, it is converted to upper case. Then the 0xc0 bits of the
339 byte are inverted. Thus \ecA becomes hex 01, as in ASCII (A is C1), but because
340 the EBCDIC letters are disjoint, \ecZ becomes hex 29 (Z is E9), and other
341 characters also generate different values.
342 .P
343 After \e0 up to two further octal digits are read. If there are fewer than two
344 digits, just those that are present are used. Thus the sequence \e0\ex\e07
345 specifies two binary zeros followed by a BEL character (code value 7). Make
346 sure you supply two digits after the initial zero if the pattern character that
347 follows is itself an octal digit.
348 .P
349 The escape \eo must be followed by a sequence of octal digits, enclosed in
350 braces. An error occurs if this is not the case. This escape is a recent
351 addition to Perl; it provides way of specifying character code points as octal
352 numbers greater than 0777, and it also allows octal numbers and back references
353 to be unambiguously specified.
354 .P
355 For greater clarity and unambiguity, it is best to avoid following \e by a
356 digit greater than zero. Instead, use \eo{} or \ex{} to specify character
357 numbers, and \eg{} to specify back references. The following paragraphs
358 describe the old, ambiguous syntax.
359 .P
360 The handling of a backslash followed by a digit other than 0 is complicated,
361 and Perl has changed in recent releases, causing PCRE also to change. Outside a
362 character class, PCRE reads the digit and any following digits as a decimal
363 number. If the number is less than 8, or if there have been at least that many
364 previous capturing left parentheses in the expression, the entire sequence is
365 taken as a \fIback reference\fP. A description of how this works is given
366 .\" HTML <a href="#backreferences">
367 .\" </a>
368 later,
369 .\"
370 following the discussion of
371 .\" HTML <a href="#subpattern">
372 .\" </a>
373 parenthesized subpatterns.
374 .\"
375 .P
376 Inside a character class, or if the decimal number following \e is greater than
377 7 and there have not been that many capturing subpatterns, PCRE handles \e8 and
378 \e9 as the literal characters "8" and "9", and otherwise re-reads up to three
379 octal digits following the backslash, using them to generate a data character.
380 Any subsequent digits stand for themselves. For example:
381 .sp
382 \e040 is another way of writing an ASCII space
383 .\" JOIN
384 \e40 is the same, provided there are fewer than 40
385 previous capturing subpatterns
386 \e7 is always a back reference
387 .\" JOIN
388 \e11 might be a back reference, or another way of
389 writing a tab
390 \e011 is always a tab
391 \e0113 is a tab followed by the character "3"
392 .\" JOIN
393 \e113 might be a back reference, otherwise the
394 character with octal code 113
395 .\" JOIN
396 \e377 might be a back reference, otherwise
397 the value 255 (decimal)
398 .\" JOIN
399 \e81 is either a back reference, or the two
400 characters "8" and "1"
401 .sp
402 Note that octal values of 100 or greater that are specified using this syntax
403 must not be introduced by a leading zero, because no more than three octal
404 digits are ever read.
405 .P
406 By default, after \ex that is not followed by {, from zero to two hexadecimal
407 digits are read (letters can be in upper or lower case). Any number of
408 hexadecimal digits may appear between \ex{ and }. If a character other than
409 a hexadecimal digit appears between \ex{ and }, or if there is no terminating
410 }, an error occurs.
411 .P
412 If the PCRE_JAVASCRIPT_COMPAT option is set, the interpretation of \ex is
413 as just described only when it is followed by two hexadecimal digits.
414 Otherwise, it matches a literal "x" character. In JavaScript mode, support for
415 code points greater than 256 is provided by \eu, which must be followed by
416 four hexadecimal digits; otherwise it matches a literal "u" character.
417 .P
418 Characters whose value is less than 256 can be defined by either of the two
419 syntaxes for \ex (or by \eu in JavaScript mode). There is no difference in the
420 way they are handled. For example, \exdc is exactly the same as \ex{dc} (or
421 \eu00dc in JavaScript mode).
422 .
423 .
424 .SS "Constraints on character values"
425 .rs
426 .sp
427 Characters that are specified using octal or hexadecimal numbers are
428 limited to certain values, as follows:
429 .sp
430 8-bit non-UTF mode less than 0x100
431 8-bit UTF-8 mode less than 0x10ffff and a valid codepoint
432 16-bit non-UTF mode less than 0x10000
433 16-bit UTF-16 mode less than 0x10ffff and a valid codepoint
434 32-bit non-UTF mode less than 0x100000000
435 32-bit UTF-32 mode less than 0x10ffff and a valid codepoint
436 .sp
437 Invalid Unicode codepoints are the range 0xd800 to 0xdfff (the so-called
438 "surrogate" codepoints), and 0xffef.
439 .
440 .
441 .SS "Escape sequences in character classes"
442 .rs
443 .sp
444 All the sequences that define a single character value can be used both inside
445 and outside character classes. In addition, inside a character class, \eb is
446 interpreted as the backspace character (hex 08).
447 .P
448 \eN is not allowed in a character class. \eB, \eR, and \eX are not special
449 inside a character class. Like other unrecognized escape sequences, they are
450 treated as the literal characters "B", "R", and "X" by default, but cause an
451 error if the PCRE_EXTRA option is set. Outside a character class, these
452 sequences have different meanings.
453 .
454 .
455 .SS "Unsupported escape sequences"
456 .rs
457 .sp
458 In Perl, the sequences \el, \eL, \eu, and \eU are recognized by its string
459 handler and used to modify the case of following characters. By default, PCRE
460 does not support these escape sequences. However, if the PCRE_JAVASCRIPT_COMPAT
461 option is set, \eU matches a "U" character, and \eu can be used to define a
462 character by code point, as described in the previous section.
463 .
464 .
465 .SS "Absolute and relative back references"
466 .rs
467 .sp
468 The sequence \eg followed by an unsigned or a negative number, optionally
469 enclosed in braces, is an absolute or relative back reference. A named back
470 reference can be coded as \eg{name}. Back references are discussed
471 .\" HTML <a href="#backreferences">
472 .\" </a>
473 later,
474 .\"
475 following the discussion of
476 .\" HTML <a href="#subpattern">
477 .\" </a>
478 parenthesized subpatterns.
479 .\"
480 .
481 .
482 .SS "Absolute and relative subroutine calls"
483 .rs
484 .sp
485 For compatibility with Oniguruma, the non-Perl syntax \eg followed by a name or
486 a number enclosed either in angle brackets or single quotes, is an alternative
487 syntax for referencing a subpattern as a "subroutine". Details are discussed
488 .\" HTML <a href="#onigurumasubroutines">
489 .\" </a>
490 later.
491 .\"
492 Note that \eg{...} (Perl syntax) and \eg<...> (Oniguruma syntax) are \fInot\fP
493 synonymous. The former is a back reference; the latter is a
494 .\" HTML <a href="#subpatternsassubroutines">
495 .\" </a>
496 subroutine
497 .\"
498 call.
499 .
500 .
501 .\" HTML <a name="genericchartypes"></a>
502 .SS "Generic character types"
503 .rs
504 .sp
505 Another use of backslash is for specifying generic character types:
506 .sp
507 \ed any decimal digit
508 \eD any character that is not a decimal digit
509 \eh any horizontal white space character
510 \eH any character that is not a horizontal white space character
511 \es any white space character
512 \eS any character that is not a white space character
513 \ev any vertical white space character
514 \eV any character that is not a vertical white space character
515 \ew any "word" character
516 \eW any "non-word" character
517 .sp
518 There is also the single sequence \eN, which matches a non-newline character.
519 This is the same as
520 .\" HTML <a href="#fullstopdot">
521 .\" </a>
522 the "." metacharacter
523 .\"
524 when PCRE_DOTALL is not set. Perl also uses \eN to match characters by name;
525 PCRE does not support this.
526 .P
527 Each pair of lower and upper case escape sequences partitions the complete set
528 of characters into two disjoint sets. Any given character matches one, and only
529 one, of each pair. The sequences can appear both inside and outside character
530 classes. They each match one character of the appropriate type. If the current
531 matching point is at the end of the subject string, all of them fail, because
532 there is no character to match.
533 .P
534 For compatibility with Perl, \es did not used to match the VT character (code
535 11), which made it different from the the POSIX "space" class. However, Perl
536 added VT at release 5.18, and PCRE followed suit at release 8.34. The default
537 \es characters are now HT (9), LF (10), VT (11), FF (12), CR (13), and space
538 (32), which are defined as white space in the "C" locale. This list may vary if
539 locale-specific matching is taking place. For example, in some locales the
540 "non-breaking space" character (\exA0) is recognized as white space, and in
541 others the VT character is not.
542 .P
543 A "word" character is an underscore or any character that is a letter or digit.
544 By default, the definition of letters and digits is controlled by PCRE's
545 low-valued character tables, and may vary if locale-specific matching is taking
546 place (see
547 .\" HTML <a href="pcreapi.html#localesupport">
548 .\" </a>
549 "Locale support"
550 .\"
551 in the
552 .\" HREF
553 \fBpcreapi\fP
554 .\"
555 page). For example, in a French locale such as "fr_FR" in Unix-like systems,
556 or "french" in Windows, some character codes greater than 127 are used for
557 accented letters, and these are then matched by \ew. The use of locales with
558 Unicode is discouraged.
559 .P
560 By default, characters whose code points are greater than 127 never match \ed,
561 \es, or \ew, and always match \eD, \eS, and \eW, although this may vary for
562 characters in the range 128-255 when locale-specific matching is happening.
563 These escape sequences retain their original meanings from before Unicode
564 support was available, mainly for efficiency reasons. If PCRE is compiled with
565 Unicode property support, and the PCRE_UCP option is set, the behaviour is
566 changed so that Unicode properties are used to determine character types, as
567 follows:
568 .sp
569 \ed any character that matches \ep{Nd} (decimal digit)
570 \es any character that matches \ep{Z} or \eh or \ev
571 \ew any character that matches \ep{L} or \ep{N}, plus underscore
572 .sp
573 The upper case escapes match the inverse sets of characters. Note that \ed
574 matches only decimal digits, whereas \ew matches any Unicode digit, as well as
575 any Unicode letter, and underscore. Note also that PCRE_UCP affects \eb, and
576 \eB because they are defined in terms of \ew and \eW. Matching these sequences
577 is noticeably slower when PCRE_UCP is set.
578 .P
579 The sequences \eh, \eH, \ev, and \eV are features that were added to Perl at
580 release 5.10. In contrast to the other sequences, which match only ASCII
581 characters by default, these always match certain high-valued code points,
582 whether or not PCRE_UCP is set. The horizontal space characters are:
583 .sp
584 U+0009 Horizontal tab (HT)
585 U+0020 Space
586 U+00A0 Non-break space
587 U+1680 Ogham space mark
588 U+180E Mongolian vowel separator
589 U+2000 En quad
590 U+2001 Em quad
591 U+2002 En space
592 U+2003 Em space
593 U+2004 Three-per-em space
594 U+2005 Four-per-em space
595 U+2006 Six-per-em space
596 U+2007 Figure space
597 U+2008 Punctuation space
598 U+2009 Thin space
599 U+200A Hair space
600 U+202F Narrow no-break space
601 U+205F Medium mathematical space
602 U+3000 Ideographic space
603 .sp
604 The vertical space characters are:
605 .sp
606 U+000A Linefeed (LF)
607 U+000B Vertical tab (VT)
608 U+000C Form feed (FF)
609 U+000D Carriage return (CR)
610 U+0085 Next line (NEL)
611 U+2028 Line separator
612 U+2029 Paragraph separator
613 .sp
614 In 8-bit, non-UTF-8 mode, only the characters with codepoints less than 256 are
615 relevant.
616 .
617 .
618 .\" HTML <a name="newlineseq"></a>
619 .SS "Newline sequences"
620 .rs
621 .sp
622 Outside a character class, by default, the escape sequence \eR matches any
623 Unicode newline sequence. In 8-bit non-UTF-8 mode \eR is equivalent to the
624 following:
625 .sp
626 (?>\er\en|\en|\ex0b|\ef|\er|\ex85)
627 .sp
628 This is an example of an "atomic group", details of which are given
629 .\" HTML <a href="#atomicgroup">
630 .\" </a>
631 below.
632 .\"
633 This particular group matches either the two-character sequence CR followed by
634 LF, or one of the single characters LF (linefeed, U+000A), VT (vertical tab,
635 U+000B), FF (form feed, U+000C), CR (carriage return, U+000D), or NEL (next
636 line, U+0085). The two-character sequence is treated as a single unit that
637 cannot be split.
638 .P
639 In other modes, two additional characters whose codepoints are greater than 255
640 are added: LS (line separator, U+2028) and PS (paragraph separator, U+2029).
641 Unicode character property support is not needed for these characters to be
642 recognized.
643 .P
644 It is possible to restrict \eR to match only CR, LF, or CRLF (instead of the
645 complete set of Unicode line endings) by setting the option PCRE_BSR_ANYCRLF
646 either at compile time or when the pattern is matched. (BSR is an abbrevation
647 for "backslash R".) This can be made the default when PCRE is built; if this is
648 the case, the other behaviour can be requested via the PCRE_BSR_UNICODE option.
649 It is also possible to specify these settings by starting a pattern string with
650 one of the following sequences:
651 .sp
652 (*BSR_ANYCRLF) CR, LF, or CRLF only
653 (*BSR_UNICODE) any Unicode newline sequence
654 .sp
655 These override the default and the options given to the compiling function, but
656 they can themselves be overridden by options given to a matching function. Note
657 that these special settings, which are not Perl-compatible, are recognized only
658 at the very start of a pattern, and that they must be in upper case. If more
659 than one of them is present, the last one is used. They can be combined with a
660 change of newline convention; for example, a pattern can start with:
661 .sp
662 (*ANY)(*BSR_ANYCRLF)
663 .sp
664 They can also be combined with the (*UTF8), (*UTF16), (*UTF32), (*UTF) or
665 (*UCP) special sequences. Inside a character class, \eR is treated as an
666 unrecognized escape sequence, and so matches the letter "R" by default, but
667 causes an error if PCRE_EXTRA is set.
668 .
669 .
670 .\" HTML <a name="uniextseq"></a>
671 .SS Unicode character properties
672 .rs
673 .sp
674 When PCRE is built with Unicode character property support, three additional
675 escape sequences that match characters with specific properties are available.
676 When in 8-bit non-UTF-8 mode, these sequences are of course limited to testing
677 characters whose codepoints are less than 256, but they do work in this mode.
678 The extra escape sequences are:
679 .sp
680 \ep{\fIxx\fP} a character with the \fIxx\fP property
681 \eP{\fIxx\fP} a character without the \fIxx\fP property
682 \eX a Unicode extended grapheme cluster
683 .sp
684 The property names represented by \fIxx\fP above are limited to the Unicode
685 script names, the general category properties, "Any", which matches any
686 character (including newline), and some special PCRE properties (described
687 in the
688 .\" HTML <a href="#extraprops">
689 .\" </a>
690 next section).
691 .\"
692 Other Perl properties such as "InMusicalSymbols" are not currently supported by
693 PCRE. Note that \eP{Any} does not match any characters, so always causes a
694 match failure.
695 .P
696 Sets of Unicode characters are defined as belonging to certain scripts. A
697 character from one of these sets can be matched using a script name. For
698 example:
699 .sp
700 \ep{Greek}
701 \eP{Han}
702 .sp
703 Those that are not part of an identified script are lumped together as
704 "Common". The current list of scripts is:
705 .P
706 Arabic,
707 Armenian,
708 Avestan,
709 Balinese,
710 Bamum,
711 Batak,
712 Bengali,
713 Bopomofo,
714 Brahmi,
715 Braille,
716 Buginese,
717 Buhid,
718 Canadian_Aboriginal,
719 Carian,
720 Chakma,
721 Cham,
722 Cherokee,
723 Common,
724 Coptic,
725 Cuneiform,
726 Cypriot,
727 Cyrillic,
728 Deseret,
729 Devanagari,
730 Egyptian_Hieroglyphs,
731 Ethiopic,
732 Georgian,
733 Glagolitic,
734 Gothic,
735 Greek,
736 Gujarati,
737 Gurmukhi,
738 Han,
739 Hangul,
740 Hanunoo,
741 Hebrew,
742 Hiragana,
743 Imperial_Aramaic,
744 Inherited,
745 Inscriptional_Pahlavi,
746 Inscriptional_Parthian,
747 Javanese,
748 Kaithi,
749 Kannada,
750 Katakana,
751 Kayah_Li,
752 Kharoshthi,
753 Khmer,
754 Lao,
755 Latin,
756 Lepcha,
757 Limbu,
758 Linear_B,
759 Lisu,
760 Lycian,
761 Lydian,
762 Malayalam,
763 Mandaic,
764 Meetei_Mayek,
765 Meroitic_Cursive,
766 Meroitic_Hieroglyphs,
767 Miao,
768 Mongolian,
769 Myanmar,
770 New_Tai_Lue,
771 Nko,
772 Ogham,
773 Old_Italic,
774 Old_Persian,
775 Old_South_Arabian,
776 Old_Turkic,
777 Ol_Chiki,
778 Oriya,
779 Osmanya,
780 Phags_Pa,
781 Phoenician,
782 Rejang,
783 Runic,
784 Samaritan,
785 Saurashtra,
786 Sharada,
787 Shavian,
788 Sinhala,
789 Sora_Sompeng,
790 Sundanese,
791 Syloti_Nagri,
792 Syriac,
793 Tagalog,
794 Tagbanwa,
795 Tai_Le,
796 Tai_Tham,
797 Tai_Viet,
798 Takri,
799 Tamil,
800 Telugu,
801 Thaana,
802 Thai,
803 Tibetan,
804 Tifinagh,
805 Ugaritic,
806 Vai,
807 Yi.
808 .P
809 Each character has exactly one Unicode general category property, specified by
810 a two-letter abbreviation. For compatibility with Perl, negation can be
811 specified by including a circumflex between the opening brace and the property
812 name. For example, \ep{^Lu} is the same as \eP{Lu}.
813 .P
814 If only one letter is specified with \ep or \eP, it includes all the general
815 category properties that start with that letter. In this case, in the absence
816 of negation, the curly brackets in the escape sequence are optional; these two
817 examples have the same effect:
818 .sp
819 \ep{L}
820 \epL
821 .sp
822 The following general category property codes are supported:
823 .sp
824 C Other
825 Cc Control
826 Cf Format
827 Cn Unassigned
828 Co Private use
829 Cs Surrogate
830 .sp
831 L Letter
832 Ll Lower case letter
833 Lm Modifier letter
834 Lo Other letter
835 Lt Title case letter
836 Lu Upper case letter
837 .sp
838 M Mark
839 Mc Spacing mark
840 Me Enclosing mark
841 Mn Non-spacing mark
842 .sp
843 N Number
844 Nd Decimal number
845 Nl Letter number
846 No Other number
847 .sp
848 P Punctuation
849 Pc Connector punctuation
850 Pd Dash punctuation
851 Pe Close punctuation
852 Pf Final punctuation
853 Pi Initial punctuation
854 Po Other punctuation
855 Ps Open punctuation
856 .sp
857 S Symbol
858 Sc Currency symbol
859 Sk Modifier symbol
860 Sm Mathematical symbol
861 So Other symbol
862 .sp
863 Z Separator
864 Zl Line separator
865 Zp Paragraph separator
866 Zs Space separator
867 .sp
868 The special property L& is also supported: it matches a character that has
869 the Lu, Ll, or Lt property, in other words, a letter that is not classified as
870 a modifier or "other".
871 .P
872 The Cs (Surrogate) property applies only to characters in the range U+D800 to
873 U+DFFF. Such characters are not valid in Unicode strings and so
874 cannot be tested by PCRE, unless UTF validity checking has been turned off
875 (see the discussion of PCRE_NO_UTF8_CHECK, PCRE_NO_UTF16_CHECK and
876 PCRE_NO_UTF32_CHECK in the
877 .\" HREF
878 \fBpcreapi\fP
879 .\"
880 page). Perl does not support the Cs property.
881 .P
882 The long synonyms for property names that Perl supports (such as \ep{Letter})
883 are not supported by PCRE, nor is it permitted to prefix any of these
884 properties with "Is".
885 .P
886 No character that is in the Unicode table has the Cn (unassigned) property.
887 Instead, this property is assumed for any code point that is not in the
888 Unicode table.
889 .P
890 Specifying caseless matching does not affect these escape sequences. For
891 example, \ep{Lu} always matches only upper case letters. This is different from
892 the behaviour of current versions of Perl.
893 .P
894 Matching characters by Unicode property is not fast, because PCRE has to do a
895 multistage table lookup in order to find a character's property. That is why
896 the traditional escape sequences such as \ed and \ew do not use Unicode
897 properties in PCRE by default, though you can make them do so by setting the
898 PCRE_UCP option or by starting the pattern with (*UCP).
899 .
900 .
901 .SS Extended grapheme clusters
902 .rs
903 .sp
904 The \eX escape matches any number of Unicode characters that form an "extended
905 grapheme cluster", and treats the sequence as an atomic group
906 .\" HTML <a href="#atomicgroup">
907 .\" </a>
908 (see below).
909 .\"
910 Up to and including release 8.31, PCRE matched an earlier, simpler definition
911 that was equivalent to
912 .sp
913 (?>\ePM\epM*)
914 .sp
915 That is, it matched a character without the "mark" property, followed by zero
916 or more characters with the "mark" property. Characters with the "mark"
917 property are typically non-spacing accents that affect the preceding character.
918 .P
919 This simple definition was extended in Unicode to include more complicated
920 kinds of composite character by giving each character a grapheme breaking
921 property, and creating rules that use these properties to define the boundaries
922 of extended grapheme clusters. In releases of PCRE later than 8.31, \eX matches
923 one of these clusters.
924 .P
925 \eX always matches at least one character. Then it decides whether to add
926 additional characters according to the following rules for ending a cluster:
927 .P
928 1. End at the end of the subject string.
929 .P
930 2. Do not end between CR and LF; otherwise end after any control character.
931 .P
932 3. Do not break Hangul (a Korean script) syllable sequences. Hangul characters
933 are of five types: L, V, T, LV, and LVT. An L character may be followed by an
934 L, V, LV, or LVT character; an LV or V character may be followed by a V or T
935 character; an LVT or T character may be follwed only by a T character.
936 .P
937 4. Do not end before extending characters or spacing marks. Characters with
938 the "mark" property always have the "extend" grapheme breaking property.
939 .P
940 5. Do not end after prepend characters.
941 .P
942 6. Otherwise, end the cluster.
943 .
944 .
945 .\" HTML <a name="extraprops"></a>
946 .SS PCRE's additional properties
947 .rs
948 .sp
949 As well as the standard Unicode properties described above, PCRE supports four
950 more that make it possible to convert traditional escape sequences such as \ew
951 and \es to use Unicode properties. PCRE uses these non-standard, non-Perl
952 properties internally when PCRE_UCP is set. However, they may also be used
953 explicitly. These properties are:
954 .sp
955 Xan Any alphanumeric character
956 Xps Any POSIX space character
957 Xsp Any Perl space character
958 Xwd Any Perl "word" character
959 .sp
960 Xan matches characters that have either the L (letter) or the N (number)
961 property. Xps matches the characters tab, linefeed, vertical tab, form feed, or
962 carriage return, and any other character that has the Z (separator) property.
963 Xsp is the same as Xps; it used to exclude vertical tab, for Perl
964 compatibility, but Perl changed, and so PCRE followed at release 8.34. Xwd
965 matches the same characters as Xan, plus underscore.
966 .P
967 There is another non-standard property, Xuc, which matches any character that
968 can be represented by a Universal Character Name in C++ and other programming
969 languages. These are the characters $, @, ` (grave accent), and all characters
970 with Unicode code points greater than or equal to U+00A0, except for the
971 surrogates U+D800 to U+DFFF. Note that most base (ASCII) characters are
972 excluded. (Universal Character Names are of the form \euHHHH or \eUHHHHHHHH
973 where H is a hexadecimal digit. Note that the Xuc property does not match these
974 sequences but the characters that they represent.)
975 .
976 .
977 .\" HTML <a name="resetmatchstart"></a>
978 .SS "Resetting the match start"
979 .rs
980 .sp
981 The escape sequence \eK causes any previously matched characters not to be
982 included in the final matched sequence. For example, the pattern:
983 .sp
984 foo\eKbar
985 .sp
986 matches "foobar", but reports that it has matched "bar". This feature is
987 similar to a lookbehind assertion
988 .\" HTML <a href="#lookbehind">
989 .\" </a>
990 (described below).
991 .\"
992 However, in this case, the part of the subject before the real match does not
993 have to be of fixed length, as lookbehind assertions do. The use of \eK does
994 not interfere with the setting of
995 .\" HTML <a href="#subpattern">
996 .\" </a>
997 captured substrings.
998 .\"
999 For example, when the pattern
1000 .sp
1001 (foo)\eKbar
1002 .sp
1003 matches "foobar", the first substring is still set to "foo".
1004 .P
1005 Perl documents that the use of \eK within assertions is "not well defined". In
1006 PCRE, \eK is acted upon when it occurs inside positive assertions, but is
1007 ignored in negative assertions.
1008 .
1009 .
1010 .\" HTML <a name="smallassertions"></a>
1011 .SS "Simple assertions"
1012 .rs
1013 .sp
1014 The final use of backslash is for certain simple assertions. An assertion
1015 specifies a condition that has to be met at a particular point in a match,
1016 without consuming any characters from the subject string. The use of
1017 subpatterns for more complicated assertions is described
1018 .\" HTML <a href="#bigassertions">
1019 .\" </a>
1020 below.
1021 .\"
1022 The backslashed assertions are:
1023 .sp
1024 \eb matches at a word boundary
1025 \eB matches when not at a word boundary
1026 \eA matches at the start of the subject
1027 \eZ matches at the end of the subject
1028 also matches before a newline at the end of the subject
1029 \ez matches only at the end of the subject
1030 \eG matches at the first matching position in the subject
1031 .sp
1032 Inside a character class, \eb has a different meaning; it matches the backspace
1033 character. If any other of these assertions appears in a character class, by
1034 default it matches the corresponding literal character (for example, \eB
1035 matches the letter B). However, if the PCRE_EXTRA option is set, an "invalid
1036 escape sequence" error is generated instead.
1037 .P
1038 A word boundary is a position in the subject string where the current character
1039 and the previous character do not both match \ew or \eW (i.e. one matches
1040 \ew and the other matches \eW), or the start or end of the string if the
1041 first or last character matches \ew, respectively. In a UTF mode, the meanings
1042 of \ew and \eW can be changed by setting the PCRE_UCP option. When this is
1043 done, it also affects \eb and \eB. Neither PCRE nor Perl has a separate "start
1044 of word" or "end of word" metasequence. However, whatever follows \eb normally
1045 determines which it is. For example, the fragment \eba matches "a" at the start
1046 of a word.
1047 .P
1048 The \eA, \eZ, and \ez assertions differ from the traditional circumflex and
1049 dollar (described in the next section) in that they only ever match at the very
1050 start and end of the subject string, whatever options are set. Thus, they are
1051 independent of multiline mode. These three assertions are not affected by the
1052 PCRE_NOTBOL or PCRE_NOTEOL options, which affect only the behaviour of the
1053 circumflex and dollar metacharacters. However, if the \fIstartoffset\fP
1054 argument of \fBpcre_exec()\fP is non-zero, indicating that matching is to start
1055 at a point other than the beginning of the subject, \eA can never match. The
1056 difference between \eZ and \ez is that \eZ matches before a newline at the end
1057 of the string as well as at the very end, whereas \ez matches only at the end.
1058 .P
1059 The \eG assertion is true only when the current matching position is at the
1060 start point of the match, as specified by the \fIstartoffset\fP argument of
1061 \fBpcre_exec()\fP. It differs from \eA when the value of \fIstartoffset\fP is
1062 non-zero. By calling \fBpcre_exec()\fP multiple times with appropriate
1063 arguments, you can mimic Perl's /g option, and it is in this kind of
1064 implementation where \eG can be useful.
1065 .P
1066 Note, however, that PCRE's interpretation of \eG, as the start of the current
1067 match, is subtly different from Perl's, which defines it as the end of the
1068 previous match. In Perl, these can be different when the previously matched
1069 string was empty. Because PCRE does just one match at a time, it cannot
1070 reproduce this behaviour.
1071 .P
1072 If all the alternatives of a pattern begin with \eG, the expression is anchored
1073 to the starting match position, and the "anchored" flag is set in the compiled
1074 regular expression.
1075 .
1076 .
1077 .SH "CIRCUMFLEX AND DOLLAR"
1078 .rs
1079 .sp
1080 The circumflex and dollar metacharacters are zero-width assertions. That is,
1081 they test for a particular condition being true without consuming any
1082 characters from the subject string.
1083 .P
1084 Outside a character class, in the default matching mode, the circumflex
1085 character is an assertion that is true only if the current matching point is at
1086 the start of the subject string. If the \fIstartoffset\fP argument of
1087 \fBpcre_exec()\fP is non-zero, circumflex can never match if the PCRE_MULTILINE
1088 option is unset. Inside a character class, circumflex has an entirely different
1089 meaning
1090 .\" HTML <a href="#characterclass">
1091 .\" </a>
1092 (see below).
1093 .\"
1094 .P
1095 Circumflex need not be the first character of the pattern if a number of
1096 alternatives are involved, but it should be the first thing in each alternative
1097 in which it appears if the pattern is ever to match that branch. If all
1098 possible alternatives start with a circumflex, that is, if the pattern is
1099 constrained to match only at the start of the subject, it is said to be an
1100 "anchored" pattern. (There are also other constructs that can cause a pattern
1101 to be anchored.)
1102 .P
1103 The dollar character is an assertion that is true only if the current matching
1104 point is at the end of the subject string, or immediately before a newline at
1105 the end of the string (by default). Note, however, that it does not actually
1106 match the newline. Dollar need not be the last character of the pattern if a
1107 number of alternatives are involved, but it should be the last item in any
1108 branch in which it appears. Dollar has no special meaning in a character class.
1109 .P
1110 The meaning of dollar can be changed so that it matches only at the very end of
1111 the string, by setting the PCRE_DOLLAR_ENDONLY option at compile time. This
1112 does not affect the \eZ assertion.
1113 .P
1114 The meanings of the circumflex and dollar characters are changed if the
1115 PCRE_MULTILINE option is set. When this is the case, a circumflex matches
1116 immediately after internal newlines as well as at the start of the subject
1117 string. It does not match after a newline that ends the string. A dollar
1118 matches before any newlines in the string, as well as at the very end, when
1119 PCRE_MULTILINE is set. When newline is specified as the two-character
1120 sequence CRLF, isolated CR and LF characters do not indicate newlines.
1121 .P
1122 For example, the pattern /^abc$/ matches the subject string "def\enabc" (where
1123 \en represents a newline) in multiline mode, but not otherwise. Consequently,
1124 patterns that are anchored in single line mode because all branches start with
1125 ^ are not anchored in multiline mode, and a match for circumflex is possible
1126 when the \fIstartoffset\fP argument of \fBpcre_exec()\fP is non-zero. The
1127 PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is set.
1128 .P
1129 Note that the sequences \eA, \eZ, and \ez can be used to match the start and
1130 end of the subject in both modes, and if all branches of a pattern start with
1131 \eA it is always anchored, whether or not PCRE_MULTILINE is set.
1132 .
1133 .
1134 .\" HTML <a name="fullstopdot"></a>
1135 .SH "FULL STOP (PERIOD, DOT) AND \eN"
1136 .rs
1137 .sp
1138 Outside a character class, a dot in the pattern matches any one character in
1139 the subject string except (by default) a character that signifies the end of a
1140 line.
1141 .P
1142 When a line ending is defined as a single character, dot never matches that
1143 character; when the two-character sequence CRLF is used, dot does not match CR
1144 if it is immediately followed by LF, but otherwise it matches all characters
1145 (including isolated CRs and LFs). When any Unicode line endings are being
1146 recognized, dot does not match CR or LF or any of the other line ending
1147 characters.
1148 .P
1149 The behaviour of dot with regard to newlines can be changed. If the PCRE_DOTALL
1150 option is set, a dot matches any one character, without exception. If the
1151 two-character sequence CRLF is present in the subject string, it takes two dots
1152 to match it.
1153 .P
1154 The handling of dot is entirely independent of the handling of circumflex and
1155 dollar, the only relationship being that they both involve newlines. Dot has no
1156 special meaning in a character class.
1157 .P
1158 The escape sequence \eN behaves like a dot, except that it is not affected by
1159 the PCRE_DOTALL option. In other words, it matches any character except one
1160 that signifies the end of a line. Perl also uses \eN to match characters by
1161 name; PCRE does not support this.
1162 .
1163 .
1164 .SH "MATCHING A SINGLE DATA UNIT"
1165 .rs
1166 .sp
1167 Outside a character class, the escape sequence \eC matches any one data unit,
1168 whether or not a UTF mode is set. In the 8-bit library, one data unit is one
1169 byte; in the 16-bit library it is a 16-bit unit; in the 32-bit library it is
1170 a 32-bit unit. Unlike a dot, \eC always
1171 matches line-ending characters. The feature is provided in Perl in order to
1172 match individual bytes in UTF-8 mode, but it is unclear how it can usefully be
1173 used. Because \eC breaks up characters into individual data units, matching one
1174 unit with \eC in a UTF mode means that the rest of the string may start with a
1175 malformed UTF character. This has undefined results, because PCRE assumes that
1176 it is dealing with valid UTF strings (and by default it checks this at the
1177 start of processing unless the PCRE_NO_UTF8_CHECK, PCRE_NO_UTF16_CHECK or
1178 PCRE_NO_UTF32_CHECK option is used).
1179 .P
1180 PCRE does not allow \eC to appear in lookbehind assertions
1181 .\" HTML <a href="#lookbehind">
1182 .\" </a>
1183 (described below)
1184 .\"
1185 in a UTF mode, because this would make it impossible to calculate the length of
1186 the lookbehind.
1187 .P
1188 In general, the \eC escape sequence is best avoided. However, one
1189 way of using it that avoids the problem of malformed UTF characters is to use a
1190 lookahead to check the length of the next character, as in this pattern, which
1191 could be used with a UTF-8 string (ignore white space and line breaks):
1192 .sp
1193 (?| (?=[\ex00-\ex7f])(\eC) |
1194 (?=[\ex80-\ex{7ff}])(\eC)(\eC) |
1195 (?=[\ex{800}-\ex{ffff}])(\eC)(\eC)(\eC) |
1196 (?=[\ex{10000}-\ex{1fffff}])(\eC)(\eC)(\eC)(\eC))
1197 .sp
1198 A group that starts with (?| resets the capturing parentheses numbers in each
1199 alternative (see
1200 .\" HTML <a href="#dupsubpatternnumber">
1201 .\" </a>
1202 "Duplicate Subpattern Numbers"
1203 .\"
1204 below). The assertions at the start of each branch check the next UTF-8
1205 character for values whose encoding uses 1, 2, 3, or 4 bytes, respectively. The
1206 character's individual bytes are then captured by the appropriate number of
1207 groups.
1208 .
1209 .
1210 .\" HTML <a name="characterclass"></a>
1211 .SH "SQUARE BRACKETS AND CHARACTER CLASSES"
1212 .rs
1213 .sp
1214 An opening square bracket introduces a character class, terminated by a closing
1215 square bracket. A closing square bracket on its own is not special by default.
1216 However, if the PCRE_JAVASCRIPT_COMPAT option is set, a lone closing square
1217 bracket causes a compile-time error. If a closing square bracket is required as
1218 a member of the class, it should be the first data character in the class
1219 (after an initial circumflex, if present) or escaped with a backslash.
1220 .P
1221 A character class matches a single character in the subject. In a UTF mode, the
1222 character may be more than one data unit long. A matched character must be in
1223 the set of characters defined by the class, unless the first character in the
1224 class definition is a circumflex, in which case the subject character must not
1225 be in the set defined by the class. If a circumflex is actually required as a
1226 member of the class, ensure it is not the first character, or escape it with a
1227 backslash.
1228 .P
1229 For example, the character class [aeiou] matches any lower case vowel, while
1230 [^aeiou] matches any character that is not a lower case vowel. Note that a
1231 circumflex is just a convenient notation for specifying the characters that
1232 are in the class by enumerating those that are not. A class that starts with a
1233 circumflex is not an assertion; it still consumes a character from the subject
1234 string, and therefore it fails if the current pointer is at the end of the
1235 string.
1236 .P
1237 In UTF-8 (UTF-16, UTF-32) mode, characters with values greater than 255 (0xffff)
1238 can be included in a class as a literal string of data units, or by using the
1239 \ex{ escaping mechanism.
1240 .P
1241 When caseless matching is set, any letters in a class represent both their
1242 upper case and lower case versions, so for example, a caseless [aeiou] matches
1243 "A" as well as "a", and a caseless [^aeiou] does not match "A", whereas a
1244 caseful version would. In a UTF mode, PCRE always understands the concept of
1245 case for characters whose values are less than 128, so caseless matching is
1246 always possible. For characters with higher values, the concept of case is
1247 supported if PCRE is compiled with Unicode property support, but not otherwise.
1248 If you want to use caseless matching in a UTF mode for characters 128 and
1249 above, you must ensure that PCRE is compiled with Unicode property support as
1250 well as with UTF support.
1251 .P
1252 Characters that might indicate line breaks are never treated in any special way
1253 when matching character classes, whatever line-ending sequence is in use, and
1254 whatever setting of the PCRE_DOTALL and PCRE_MULTILINE options is used. A class
1255 such as [^a] always matches one of these characters.
1256 .P
1257 The minus (hyphen) character can be used to specify a range of characters in a
1258 character class. For example, [d-m] matches any letter between d and m,
1259 inclusive. If a minus character is required in a class, it must be escaped with
1260 a backslash or appear in a position where it cannot be interpreted as
1261 indicating a range, typically as the first or last character in the class, or
1262 immediately after a range. For example, [b-d-z] matches letters in the range b
1263 to d, a hyphen character, or z.
1264 .P
1265 It is not possible to have the literal character "]" as the end character of a
1266 range. A pattern such as [W-]46] is interpreted as a class of two characters
1267 ("W" and "-") followed by a literal string "46]", so it would match "W46]" or
1268 "-46]". However, if the "]" is escaped with a backslash it is interpreted as
1269 the end of range, so [W-\e]46] is interpreted as a class containing a range
1270 followed by two other characters. The octal or hexadecimal representation of
1271 "]" can also be used to end a range.
1272 .P
1273 An error is generated if a POSIX character class (see below) or an escape
1274 sequence other than one that defines a single character appears at a point
1275 where a range ending character is expected. For example, [z-\exff] is valid,
1276 but [A-\ed] and [A-[:digit:]] are not.
1277 .P
1278 Ranges operate in the collating sequence of character values. They can also be
1279 used for characters specified numerically, for example [\e000-\e037]. Ranges
1280 can include any characters that are valid for the current mode.
1281 .P
1282 If a range that includes letters is used when caseless matching is set, it
1283 matches the letters in either case. For example, [W-c] is equivalent to
1284 [][\e\e^_`wxyzabc], matched caselessly, and in a non-UTF mode, if character
1285 tables for a French locale are in use, [\exc8-\excb] matches accented E
1286 characters in both cases. In UTF modes, PCRE supports the concept of case for
1287 characters with values greater than 128 only when it is compiled with Unicode
1288 property support.
1289 .P
1290 The character escape sequences \ed, \eD, \eh, \eH, \ep, \eP, \es, \eS, \ev,
1291 \eV, \ew, and \eW may appear in a character class, and add the characters that
1292 they match to the class. For example, [\edABCDEF] matches any hexadecimal
1293 digit. In UTF modes, the PCRE_UCP option affects the meanings of \ed, \es, \ew
1294 and their upper case partners, just as it does when they appear outside a
1295 character class, as described in the section entitled
1296 .\" HTML <a href="#genericchartypes">
1297 .\" </a>
1298 "Generic character types"
1299 .\"
1300 above. The escape sequence \eb has a different meaning inside a character
1301 class; it matches the backspace character. The sequences \eB, \eN, \eR, and \eX
1302 are not special inside a character class. Like any other unrecognized escape
1303 sequences, they are treated as the literal characters "B", "N", "R", and "X" by
1304 default, but cause an error if the PCRE_EXTRA option is set.
1305 .P
1306 A circumflex can conveniently be used with the upper case character types to
1307 specify a more restricted set of characters than the matching lower case type.
1308 For example, the class [^\eW_] matches any letter or digit, but not underscore,
1309 whereas [\ew] includes underscore. A positive character class should be read as
1310 "something OR something OR ..." and a negative class as "NOT something AND NOT
1311 something AND NOT ...".
1312 .P
1313 The only metacharacters that are recognized in character classes are backslash,
1314 hyphen (only where it can be interpreted as specifying a range), circumflex
1315 (only at the start), opening square bracket (only when it can be interpreted as
1316 introducing a POSIX class name - see the next section), and the terminating
1317 closing square bracket. However, escaping other non-alphanumeric characters
1318 does no harm.
1319 .
1320 .
1321 .SH "POSIX CHARACTER CLASSES"
1322 .rs
1323 .sp
1324 Perl supports the POSIX notation for character classes. This uses names
1325 enclosed by [: and :] within the enclosing square brackets. PCRE also supports
1326 this notation. For example,
1327 .sp
1328 [01[:alpha:]%]
1329 .sp
1330 matches "0", "1", any alphabetic character, or "%". The supported class names
1331 are:
1332 .sp
1333 alnum letters and digits
1334 alpha letters
1335 ascii character codes 0 - 127
1336 blank space or tab only
1337 cntrl control characters
1338 digit decimal digits (same as \ed)
1339 graph printing characters, excluding space
1340 lower lower case letters
1341 print printing characters, including space
1342 punct printing characters, excluding letters and digits and space
1343 space white space (the same as \es from PCRE 8.34)
1344 upper upper case letters
1345 word "word" characters (same as \ew)
1346 xdigit hexadecimal digits
1347 .sp
1348 The default "space" characters are HT (9), LF (10), VT (11), FF (12), CR (13),
1349 and space (32). If locale-specific matching is taking place, the list of space
1350 characters may be different; there may be fewer or more of them. "Space" used
1351 to be different to \es, which did not include VT, for Perl compatibility.
1352 However, Perl changed at release 5.18, and PCRE followed at release 8.34.
1353 "Space" and \es now match the same set of characters.
1354 .P
1355 The name "word" is a Perl extension, and "blank" is a GNU extension from Perl
1356 5.8. Another Perl extension is negation, which is indicated by a ^ character
1357 after the colon. For example,
1358 .sp
1359 [12[:^digit:]]
1360 .sp
1361 matches "1", "2", or any non-digit. PCRE (and Perl) also recognize the POSIX
1362 syntax [.ch.] and [=ch=] where "ch" is a "collating element", but these are not
1363 supported, and an error is given if they are encountered.
1364 .P
1365 By default, characters with values greater than 128 do not match any of the
1366 POSIX character classes. However, if the PCRE_UCP option is passed to
1367 \fBpcre_compile()\fP, some of the classes are changed so that Unicode character
1368 properties are used. This is achieved by replacing certain POSIX classes by
1369 other sequences, as follows:
1370 .sp
1371 [:alnum:] becomes \ep{Xan}
1372 [:alpha:] becomes \ep{L}
1373 [:blank:] becomes \eh
1374 [:digit:] becomes \ep{Nd}
1375 [:lower:] becomes \ep{Ll}
1376 [:space:] becomes \ep{Xps}
1377 [:upper:] becomes \ep{Lu}
1378 [:word:] becomes \ep{Xwd}
1379 .sp
1380 Negated versions, such as [:^alpha:] use \eP instead of \ep. Three other POSIX
1381 classes are handled specially in UCP mode:
1382 .TP 10
1383 [:graph:]
1384 This matches characters that have glyphs that mark the page when printed. In
1385 Unicode property terms, it matches all characters with the L, M, N, P, S, or Cf
1386 properties, except for:
1387 .sp
1388 U+061C Arabic Letter Mark
1389 U+180E Mongolian Vowel Separator
1390 U+2066 - U+2069 Various "isolate"s
1391 .sp
1392 .TP 10
1393 [:print:]
1394 This matches the same characters as [:graph:] plus space characters that are
1395 not controls, that is, characters with the Zs property.
1396 .TP 10
1397 [:punct:]
1398 This matches all characters that have the Unicode P (punctuation) property,
1399 plus those characters whose code points are less than 128 that have the S
1400 (Symbol) property.
1401 .P
1402 The other POSIX classes are unchanged, and match only characters with code
1403 points less than 128.
1404 .
1405 .
1406 .SH "VERTICAL BAR"
1407 .rs
1408 .sp
1409 Vertical bar characters are used to separate alternative patterns. For example,
1410 the pattern
1411 .sp
1412 gilbert|sullivan
1413 .sp
1414 matches either "gilbert" or "sullivan". Any number of alternatives may appear,
1415 and an empty alternative is permitted (matching the empty string). The matching
1416 process tries each alternative in turn, from left to right, and the first one
1417 that succeeds is used. If the alternatives are within a subpattern
1418 .\" HTML <a href="#subpattern">
1419 .\" </a>
1420 (defined below),
1421 .\"
1422 "succeeds" means matching the rest of the main pattern as well as the
1423 alternative in the subpattern.
1424 .
1425 .
1426 .SH "INTERNAL OPTION SETTING"
1427 .rs
1428 .sp
1429 The settings of the PCRE_CASELESS, PCRE_MULTILINE, PCRE_DOTALL, and
1430 PCRE_EXTENDED options (which are Perl-compatible) can be changed from within
1431 the pattern by a sequence of Perl option letters enclosed between "(?" and ")".
1432 The option letters are
1433 .sp
1434 i for PCRE_CASELESS
1435 m for PCRE_MULTILINE
1436 s for PCRE_DOTALL
1437 x for PCRE_EXTENDED
1438 .sp
1439 For example, (?im) sets caseless, multiline matching. It is also possible to
1440 unset these options by preceding the letter with a hyphen, and a combined
1441 setting and unsetting such as (?im-sx), which sets PCRE_CASELESS and
1442 PCRE_MULTILINE while unsetting PCRE_DOTALL and PCRE_EXTENDED, is also
1443 permitted. If a letter appears both before and after the hyphen, the option is
1444 unset.
1445 .P
1446 The PCRE-specific options PCRE_DUPNAMES, PCRE_UNGREEDY, and PCRE_EXTRA can be
1447 changed in the same way as the Perl-compatible options by using the characters
1448 J, U and X respectively.
1449 .P
1450 When one of these option changes occurs at top level (that is, not inside
1451 subpattern parentheses), the change applies to the remainder of the pattern
1452 that follows. If the change is placed right at the start of a pattern, PCRE
1453 extracts it into the global options (and it will therefore show up in data
1454 extracted by the \fBpcre_fullinfo()\fP function).
1455 .P
1456 An option change within a subpattern (see below for a description of
1457 subpatterns) affects only that part of the subpattern that follows it, so
1458 .sp
1459 (a(?i)b)c
1460 .sp
1461 matches abc and aBc and no other strings (assuming PCRE_CASELESS is not used).
1462 By this means, options can be made to have different settings in different
1463 parts of the pattern. Any changes made in one alternative do carry on
1464 into subsequent branches within the same subpattern. For example,
1465 .sp
1466 (a(?i)b|c)
1467 .sp
1468 matches "ab", "aB", "c", and "C", even though when matching "C" the first
1469 branch is abandoned before the option setting. This is because the effects of
1470 option settings happen at compile time. There would be some very weird
1471 behaviour otherwise.
1472 .P
1473 \fBNote:\fP There are other PCRE-specific options that can be set by the
1474 application when the compiling or matching functions are called. In some cases
1475 the pattern can contain special leading sequences such as (*CRLF) to override
1476 what the application has set or what has been defaulted. Details are given in
1477 the section entitled
1478 .\" HTML <a href="#newlineseq">
1479 .\" </a>
1480 "Newline sequences"
1481 .\"
1482 above. There are also the (*UTF8), (*UTF16),(*UTF32), and (*UCP) leading
1483 sequences that can be used to set UTF and Unicode property modes; they are
1484 equivalent to setting the PCRE_UTF8, PCRE_UTF16, PCRE_UTF32 and the PCRE_UCP
1485 options, respectively. The (*UTF) sequence is a generic version that can be
1486 used with any of the libraries. However, the application can set the
1487 PCRE_NEVER_UTF option, which locks out the use of the (*UTF) sequences.
1488 .
1489 .
1490 .\" HTML <a name="subpattern"></a>
1491 .SH SUBPATTERNS
1492 .rs
1493 .sp
1494 Subpatterns are delimited by parentheses (round brackets), which can be nested.
1495 Turning part of a pattern into a subpattern does two things:
1496 .sp
1497 1. It localizes a set of alternatives. For example, the pattern
1498 .sp
1499 cat(aract|erpillar|)
1500 .sp
1501 matches "cataract", "caterpillar", or "cat". Without the parentheses, it would
1502 match "cataract", "erpillar" or an empty string.
1503 .sp
1504 2. It sets up the subpattern as a capturing subpattern. This means that, when
1505 the whole pattern matches, that portion of the subject string that matched the
1506 subpattern is passed back to the caller via the \fIovector\fP argument of the
1507 matching function. (This applies only to the traditional matching functions;
1508 the DFA matching functions do not support capturing.)
1509 .P
1510 Opening parentheses are counted from left to right (starting from 1) to obtain
1511 numbers for the capturing subpatterns. For example, if the string "the red
1512 king" is matched against the pattern
1513 .sp
1514 the ((red|white) (king|queen))
1515 .sp
1516 the captured substrings are "red king", "red", and "king", and are numbered 1,
1517 2, and 3, respectively.
1518 .P
1519 The fact that plain parentheses fulfil two functions is not always helpful.
1520 There are often times when a grouping subpattern is required without a
1521 capturing requirement. If an opening parenthesis is followed by a question mark
1522 and a colon, the subpattern does not do any capturing, and is not counted when
1523 computing the number of any subsequent capturing subpatterns. For example, if
1524 the string "the white queen" is matched against the pattern
1525 .sp
1526 the ((?:red|white) (king|queen))
1527 .sp
1528 the captured substrings are "white queen" and "queen", and are numbered 1 and
1529 2. The maximum number of capturing subpatterns is 65535.
1530 .P
1531 As a convenient shorthand, if any option settings are required at the start of
1532 a non-capturing subpattern, the option letters may appear between the "?" and
1533 the ":". Thus the two patterns
1534 .sp
1535 (?i:saturday|sunday)
1536 (?:(?i)saturday|sunday)
1537 .sp
1538 match exactly the same set of strings. Because alternative branches are tried
1539 from left to right, and options are not reset until the end of the subpattern
1540 is reached, an option setting in one branch does affect subsequent branches, so
1541 the above patterns match "SUNDAY" as well as "Saturday".
1542 .
1543 .
1544 .\" HTML <a name="dupsubpatternnumber"></a>
1545 .SH "DUPLICATE SUBPATTERN NUMBERS"
1546 .rs
1547 .sp
1548 Perl 5.10 introduced a feature whereby each alternative in a subpattern uses
1549 the same numbers for its capturing parentheses. Such a subpattern starts with
1550 (?| and is itself a non-capturing subpattern. For example, consider this
1551 pattern:
1552 .sp
1553 (?|(Sat)ur|(Sun))day
1554 .sp
1555 Because the two alternatives are inside a (?| group, both sets of capturing
1556 parentheses are numbered one. Thus, when the pattern matches, you can look
1557 at captured substring number one, whichever alternative matched. This construct
1558 is useful when you want to capture part, but not all, of one of a number of
1559 alternatives. Inside a (?| group, parentheses are numbered as usual, but the
1560 number is reset at the start of each branch. The numbers of any capturing
1561 parentheses that follow the subpattern start after the highest number used in
1562 any branch. The following example is taken from the Perl documentation. The
1563 numbers underneath show in which buffer the captured content will be stored.
1564 .sp
1565 # before ---------------branch-reset----------- after
1566 / ( a ) (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x
1567 # 1 2 2 3 2 3 4
1568 .sp
1569 A back reference to a numbered subpattern uses the most recent value that is
1570 set for that number by any subpattern. The following pattern matches "abcabc"
1571 or "defdef":
1572 .sp
1573 /(?|(abc)|(def))\e1/
1574 .sp
1575 In contrast, a subroutine call to a numbered subpattern always refers to the
1576 first one in the pattern with the given number. The following pattern matches
1577 "abcabc" or "defabc":
1578 .sp
1579 /(?|(abc)|(def))(?1)/
1580 .sp
1581 If a
1582 .\" HTML <a href="#conditions">
1583 .\" </a>
1584 condition test
1585 .\"
1586 for a subpattern's having matched refers to a non-unique number, the test is
1587 true if any of the subpatterns of that number have matched.
1588 .P
1589 An alternative approach to using this "branch reset" feature is to use
1590 duplicate named subpatterns, as described in the next section.
1591 .
1592 .
1593 .SH "NAMED SUBPATTERNS"
1594 .rs
1595 .sp
1596 Identifying capturing parentheses by number is simple, but it can be very hard
1597 to keep track of the numbers in complicated regular expressions. Furthermore,
1598 if an expression is modified, the numbers may change. To help with this
1599 difficulty, PCRE supports the naming of subpatterns. This feature was not
1600 added to Perl until release 5.10. Python had the feature earlier, and PCRE
1601 introduced it at release 4.0, using the Python syntax. PCRE now supports both
1602 the Perl and the Python syntax. Perl allows identically numbered subpatterns to
1603 have different names, but PCRE does not.
1604 .P
1605 In PCRE, a subpattern can be named in one of three ways: (?<name>...) or
1606 (?'name'...) as in Perl, or (?P<name>...) as in Python. References to capturing
1607 parentheses from other parts of the pattern, such as
1608 .\" HTML <a href="#backreferences">
1609 .\" </a>
1610 back references,
1611 .\"
1612 .\" HTML <a href="#recursion">
1613 .\" </a>
1614 recursion,
1615 .\"
1616 and
1617 .\" HTML <a href="#conditions">
1618 .\" </a>
1619 conditions,
1620 .\"
1621 can be made by name as well as by number.
1622 .P
1623 Names consist of up to 32 alphanumeric characters and underscores, but must
1624 start with a non-digit. Named capturing parentheses are still allocated numbers
1625 as well as names, exactly as if the names were not present. The PCRE API
1626 provides function calls for extracting the name-to-number translation table
1627 from a compiled pattern. There is also a convenience function for extracting a
1628 captured substring by name.
1629 .P
1630 By default, a name must be unique within a pattern, but it is possible to relax
1631 this constraint by setting the PCRE_DUPNAMES option at compile time. (Duplicate
1632 names are also always permitted for subpatterns with the same number, set up as
1633 described in the previous section.) Duplicate names can be useful for patterns
1634 where only one instance of the named parentheses can match. Suppose you want to
1635 match the name of a weekday, either as a 3-letter abbreviation or as the full
1636 name, and in both cases you want to extract the abbreviation. This pattern
1637 (ignoring the line breaks) does the job:
1638 .sp
1639 (?<DN>Mon|Fri|Sun)(?:day)?|
1640 (?<DN>Tue)(?:sday)?|
1641 (?<DN>Wed)(?:nesday)?|
1642 (?<DN>Thu)(?:rsday)?|
1643 (?<DN>Sat)(?:urday)?
1644 .sp
1645 There are five capturing substrings, but only one is ever set after a match.
1646 (An alternative way of solving this problem is to use a "branch reset"
1647 subpattern, as described in the previous section.)
1648 .P
1649 The convenience function for extracting the data by name returns the substring
1650 for the first (and in this example, the only) subpattern of that name that
1651 matched. This saves searching to find which numbered subpattern it was.
1652 .P
1653 If you make a back reference to a non-unique named subpattern from elsewhere in
1654 the pattern, the subpatterns to which the name refers are checked in the order
1655 in which they appear in the overall pattern. The first one that is set is used
1656 for the reference. For example, this pattern matches both "foofoo" and
1657 "barbar" but not "foobar" or "barfoo":
1658 .sp
1659 (?:(?<n>foo)|(?<n>bar))\ek<n>
1660 .sp
1661 .P
1662 If you make a subroutine call to a non-unique named subpattern, the one that
1663 corresponds to the first occurrence of the name is used. In the absence of
1664 duplicate numbers (see the previous section) this is the one with the lowest
1665 number.
1666 .P
1667 If you use a named reference in a condition
1668 test (see the
1669 .\"
1670 .\" HTML <a href="#conditions">
1671 .\" </a>
1672 section about conditions
1673 .\"
1674 below), either to check whether a subpattern has matched, or to check for
1675 recursion, all subpatterns with the same name are tested. If the condition is
1676 true for any one of them, the overall condition is true. This is the same
1677 behaviour as testing by number. For further details of the interfaces for
1678 handling named subpatterns, see the
1679 .\" HREF
1680 \fBpcreapi\fP
1681 .\"
1682 documentation.
1683 .P
1684 \fBWarning:\fP You cannot use different names to distinguish between two
1685 subpatterns with the same number because PCRE uses only the numbers when
1686 matching. For this reason, an error is given at compile time if different names
1687 are given to subpatterns with the same number. However, you can always give the
1688 same name to subpatterns with the same number, even when PCRE_DUPNAMES is not
1689 set.
1690 .
1691 .
1692 .SH REPETITION
1693 .rs
1694 .sp
1695 Repetition is specified by quantifiers, which can follow any of the following
1696 items:
1697 .sp
1698 a literal data character
1699 the dot metacharacter
1700 the \eC escape sequence
1701 the \eX escape sequence
1702 the \eR escape sequence
1703 an escape such as \ed or \epL that matches a single character
1704 a character class
1705 a back reference (see next section)
1706 a parenthesized subpattern (including assertions)
1707 a subroutine call to a subpattern (recursive or otherwise)
1708 .sp
1709 The general repetition quantifier specifies a minimum and maximum number of
1710 permitted matches, by giving the two numbers in curly brackets (braces),
1711 separated by a comma. The numbers must be less than 65536, and the first must
1712 be less than or equal to the second. For example:
1713 .sp
1714 z{2,4}
1715 .sp
1716 matches "zz", "zzz", or "zzzz". A closing brace on its own is not a special
1717 character. If the second number is omitted, but the comma is present, there is
1718 no upper limit; if the second number and the comma are both omitted, the
1719 quantifier specifies an exact number of required matches. Thus
1720 .sp
1721 [aeiou]{3,}
1722 .sp
1723 matches at least 3 successive vowels, but may match many more, while
1724 .sp
1725 \ed{8}
1726 .sp
1727 matches exactly 8 digits. An opening curly bracket that appears in a position
1728 where a quantifier is not allowed, or one that does not match the syntax of a
1729 quantifier, is taken as a literal character. For example, {,6} is not a
1730 quantifier, but a literal string of four characters.
1731 .P
1732 In UTF modes, quantifiers apply to characters rather than to individual data
1733 units. Thus, for example, \ex{100}{2} matches two characters, each of
1734 which is represented by a two-byte sequence in a UTF-8 string. Similarly,
1735 \eX{3} matches three Unicode extended grapheme clusters, each of which may be
1736 several data units long (and they may be of different lengths).
1737 .P
1738 The quantifier {0} is permitted, causing the expression to behave as if the
1739 previous item and the quantifier were not present. This may be useful for
1740 subpatterns that are referenced as
1741 .\" HTML <a href="#subpatternsassubroutines">
1742 .\" </a>
1743 subroutines
1744 .\"
1745 from elsewhere in the pattern (but see also the section entitled
1746 .\" HTML <a href="#subdefine">
1747 .\" </a>
1748 "Defining subpatterns for use by reference only"
1749 .\"
1750 below). Items other than subpatterns that have a {0} quantifier are omitted
1751 from the compiled pattern.
1752 .P
1753 For convenience, the three most common quantifiers have single-character
1754 abbreviations:
1755 .sp
1756 * is equivalent to {0,}
1757 + is equivalent to {1,}
1758 ? is equivalent to {0,1}
1759 .sp
1760 It is possible to construct infinite loops by following a subpattern that can
1761 match no characters with a quantifier that has no upper limit, for example:
1762 .sp
1763 (a?)*
1764 .sp
1765 Earlier versions of Perl and PCRE used to give an error at compile time for
1766 such patterns. However, because there are cases where this can be useful, such
1767 patterns are now accepted, but if any repetition of the subpattern does in fact
1768 match no characters, the loop is forcibly broken.
1769 .P
1770 By default, the quantifiers are "greedy", that is, they match as much as
1771 possible (up to the maximum number of permitted times), without causing the
1772 rest of the pattern to fail. The classic example of where this gives problems
1773 is in trying to match comments in C programs. These appear between /* and */
1774 and within the comment, individual * and / characters may appear. An attempt to
1775 match C comments by applying the pattern
1776 .sp
1777 /\e*.*\e*/
1778 .sp
1779 to the string
1780 .sp
1781 /* first comment */ not comment /* second comment */
1782 .sp
1783 fails, because it matches the entire string owing to the greediness of the .*
1784 item.
1785 .P
1786 However, if a quantifier is followed by a question mark, it ceases to be
1787 greedy, and instead matches the minimum number of times possible, so the
1788 pattern
1789 .sp
1790 /\e*.*?\e*/
1791 .sp
1792 does the right thing with the C comments. The meaning of the various
1793 quantifiers is not otherwise changed, just the preferred number of matches.
1794 Do not confuse this use of question mark with its use as a quantifier in its
1795 own right. Because it has two uses, it can sometimes appear doubled, as in
1796 .sp
1797 \ed??\ed
1798 .sp
1799 which matches one digit by preference, but can match two if that is the only
1800 way the rest of the pattern matches.
1801 .P
1802 If the PCRE_UNGREEDY option is set (an option that is not available in Perl),
1803 the quantifiers are not greedy by default, but individual ones can be made
1804 greedy by following them with a question mark. In other words, it inverts the
1805 default behaviour.
1806 .P
1807 When a parenthesized subpattern is quantified with a minimum repeat count that
1808 is greater than 1 or with a limited maximum, more memory is required for the
1809 compiled pattern, in proportion to the size of the minimum or maximum.
1810 .P
1811 If a pattern starts with .* or .{0,} and the PCRE_DOTALL option (equivalent
1812 to Perl's /s) is set, thus allowing the dot to match newlines, the pattern is
1813 implicitly anchored, because whatever follows will be tried against every
1814 character position in the subject string, so there is no point in retrying the
1815 overall match at any position after the first. PCRE normally treats such a
1816 pattern as though it were preceded by \eA.
1817 .P
1818 In cases where it is known that the subject string contains no newlines, it is
1819 worth setting PCRE_DOTALL in order to obtain this optimization, or
1820 alternatively using ^ to indicate anchoring explicitly.
1821 .P
1822 However, there are some cases where the optimization cannot be used. When .*
1823 is inside capturing parentheses that are the subject of a back reference
1824 elsewhere in the pattern, a match at the start may fail where a later one
1825 succeeds. Consider, for example:
1826 .sp
1827 (.*)abc\e1
1828 .sp
1829 If the subject is "xyz123abc123" the match point is the fourth character. For
1830 this reason, such a pattern is not implicitly anchored.
1831 .P
1832 Another case where implicit anchoring is not applied is when the leading .* is
1833 inside an atomic group. Once again, a match at the start may fail where a later
1834 one succeeds. Consider this pattern:
1835 .sp
1836 (?>.*?a)b
1837 .sp
1838 It matches "ab" in the subject "aab". The use of the backtracking control verbs
1839 (*PRUNE) and (*SKIP) also disable this optimization.
1840 .P
1841 When a capturing subpattern is repeated, the value captured is the substring
1842 that matched the final iteration. For example, after
1843 .sp
1844 (tweedle[dume]{3}\es*)+
1845 .sp
1846 has matched "tweedledum tweedledee" the value of the captured substring is
1847 "tweedledee". However, if there are nested capturing subpatterns, the
1848 corresponding captured values may have been set in previous iterations. For
1849 example, after
1850 .sp
1851 /(a|(b))+/
1852 .sp
1853 matches "aba" the value of the second captured substring is "b".
1854 .
1855 .
1856 .\" HTML <a name="atomicgroup"></a>
1857 .SH "ATOMIC GROUPING AND POSSESSIVE QUANTIFIERS"
1858 .rs
1859 .sp
1860 With both maximizing ("greedy") and minimizing ("ungreedy" or "lazy")
1861 repetition, failure of what follows normally causes the repeated item to be
1862 re-evaluated to see if a different number of repeats allows the rest of the
1863 pattern to match. Sometimes it is useful to prevent this, either to change the
1864 nature of the match, or to cause it fail earlier than it otherwise might, when
1865 the author of the pattern knows there is no point in carrying on.
1866 .P
1867 Consider, for example, the pattern \ed+foo when applied to the subject line
1868 .sp
1869 123456bar
1870 .sp
1871 After matching all 6 digits and then failing to match "foo", the normal
1872 action of the matcher is to try again with only 5 digits matching the \ed+
1873 item, and then with 4, and so on, before ultimately failing. "Atomic grouping"
1874 (a term taken from Jeffrey Friedl's book) provides the means for specifying
1875 that once a subpattern has matched, it is not to be re-evaluated in this way.
1876 .P
1877 If we use atomic grouping for the previous example, the matcher gives up
1878 immediately on failing to match "foo" the first time. The notation is a kind of
1879 special parenthesis, starting with (?> as in this example:
1880 .sp
1881 (?>\ed+)foo
1882 .sp
1883 This kind of parenthesis "locks up" the part of the pattern it contains once
1884 it has matched, and a failure further into the pattern is prevented from
1885 backtracking into it. Backtracking past it to previous items, however, works as
1886 normal.
1887 .P
1888 An alternative description is that a subpattern of this type matches the string
1889 of characters that an identical standalone pattern would match, if anchored at
1890 the current point in the subject string.
1891 .P
1892 Atomic grouping subpatterns are not capturing subpatterns. Simple cases such as
1893 the above example can be thought of as a maximizing repeat that must swallow
1894 everything it can. So, while both \ed+ and \ed+? are prepared to adjust the
1895 number of digits they match in order to make the rest of the pattern match,
1896 (?>\ed+) can only match an entire sequence of digits.
1897 .P
1898 Atomic groups in general can of course contain arbitrarily complicated
1899 subpatterns, and can be nested. However, when the subpattern for an atomic
1900 group is just a single repeated item, as in the example above, a simpler
1901 notation, called a "possessive quantifier" can be used. This consists of an
1902 additional + character following a quantifier. Using this notation, the
1903 previous example can be rewritten as
1904 .sp
1905 \ed++foo
1906 .sp
1907 Note that a possessive quantifier can be used with an entire group, for
1908 example:
1909 .sp
1910 (abc|xyz){2,3}+
1911 .sp
1912 Possessive quantifiers are always greedy; the setting of the PCRE_UNGREEDY
1913 option is ignored. They are a convenient notation for the simpler forms of
1914 atomic group. However, there is no difference in the meaning of a possessive
1915 quantifier and the equivalent atomic group, though there may be a performance
1916 difference; possessive quantifiers should be slightly faster.
1917 .P
1918 The possessive quantifier syntax is an extension to the Perl 5.8 syntax.
1919 Jeffrey Friedl originated the idea (and the name) in the first edition of his
1920 book. Mike McCloskey liked it, so implemented it when he built Sun's Java
1921 package, and PCRE copied it from there. It ultimately found its way into Perl
1922 at release 5.10.
1923 .P
1924 PCRE has an optimization that automatically "possessifies" certain simple
1925 pattern constructs. For example, the sequence A+B is treated as A++B because
1926 there is no point in backtracking into a sequence of A's when B must follow.
1927 .P
1928 When a pattern contains an unlimited repeat inside a subpattern that can itself
1929 be repeated an unlimited number of times, the use of an atomic group is the
1930 only way to avoid some failing matches taking a very long time indeed. The
1931 pattern
1932 .sp
1933 (\eD+|<\ed+>)*[!?]
1934 .sp
1935 matches an unlimited number of substrings that either consist of non-digits, or
1936 digits enclosed in <>, followed by either ! or ?. When it matches, it runs
1937 quickly. However, if it is applied to
1938 .sp
1939 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
1940 .sp
1941 it takes a long time before reporting failure. This is because the string can
1942 be divided between the internal \eD+ repeat and the external * repeat in a
1943 large number of ways, and all have to be tried. (The example uses [!?] rather
1944 than a single character at the end, because both PCRE and Perl have an
1945 optimization that allows for fast failure when a single character is used. They
1946 remember the last single character that is required for a match, and fail early
1947 if it is not present in the string.) If the pattern is changed so that it uses
1948 an atomic group, like this:
1949 .sp
1950 ((?>\eD+)|<\ed+>)*[!?]
1951 .sp
1952 sequences of non-digits cannot be broken, and failure happens quickly.
1953 .
1954 .
1955 .\" HTML <a name="backreferences"></a>
1956 .SH "BACK REFERENCES"
1957 .rs
1958 .sp
1959 Outside a character class, a backslash followed by a digit greater than 0 (and
1960 possibly further digits) is a back reference to a capturing subpattern earlier
1961 (that is, to its left) in the pattern, provided there have been that many
1962 previous capturing left parentheses.
1963 .P
1964 However, if the decimal number following the backslash is less than 10, it is
1965 always taken as a back reference, and causes an error only if there are not
1966 that many capturing left parentheses in the entire pattern. In other words, the
1967 parentheses that are referenced need not be to the left of the reference for
1968 numbers less than 10. A "forward back reference" of this type can make sense
1969 when a repetition is involved and the subpattern to the right has participated
1970 in an earlier iteration.
1971 .P
1972 It is not possible to have a numerical "forward back reference" to a subpattern
1973 whose number is 10 or more using this syntax because a sequence such as \e50 is
1974 interpreted as a character defined in octal. See the subsection entitled
1975 "Non-printing characters"
1976 .\" HTML <a href="#digitsafterbackslash">
1977 .\" </a>
1978 above
1979 .\"
1980 for further details of the handling of digits following a backslash. There is
1981 no such problem when named parentheses are used. A back reference to any
1982 subpattern is possible using named parentheses (see below).
1983 .P
1984 Another way of avoiding the ambiguity inherent in the use of digits following a
1985 backslash is to use the \eg escape sequence. This escape must be followed by an
1986 unsigned number or a negative number, optionally enclosed in braces. These
1987 examples are all identical:
1988 .sp
1989 (ring), \e1
1990 (ring), \eg1
1991 (ring), \eg{1}
1992 .sp
1993 An unsigned number specifies an absolute reference without the ambiguity that
1994 is present in the older syntax. It is also useful when literal digits follow
1995 the reference. A negative number is a relative reference. Consider this
1996 example:
1997 .sp
1998 (abc(def)ghi)\eg{-1}
1999 .sp
2000 The sequence \eg{-1} is a reference to the most recently started capturing
2001 subpattern before \eg, that is, is it equivalent to \e2 in this example.
2002 Similarly, \eg{-2} would be equivalent to \e1. The use of relative references
2003 can be helpful in long patterns, and also in patterns that are created by
2004 joining together fragments that contain references within themselves.
2005 .P
2006 A back reference matches whatever actually matched the capturing subpattern in
2007 the current subject string, rather than anything matching the subpattern
2008 itself (see
2009 .\" HTML <a href="#subpatternsassubroutines">
2010 .\" </a>
2011 "Subpatterns as subroutines"
2012 .\"
2013 below for a way of doing that). So the pattern
2014 .sp
2015 (sens|respons)e and \e1ibility
2016 .sp
2017 matches "sense and sensibility" and "response and responsibility", but not
2018 "sense and responsibility". If caseful matching is in force at the time of the
2019 back reference, the case of letters is relevant. For example,
2020 .sp
2021 ((?i)rah)\es+\e1
2022 .sp
2023 matches "rah rah" and "RAH RAH", but not "RAH rah", even though the original
2024 capturing subpattern is matched caselessly.
2025 .P
2026 There are several different ways of writing back references to named
2027 subpatterns. The .NET syntax \ek{name} and the Perl syntax \ek<name> or
2028 \ek'name' are supported, as is the Python syntax (?P=name). Perl 5.10's unified
2029 back reference syntax, in which \eg can be used for both numeric and named
2030 references, is also supported. We could rewrite the above example in any of
2031 the following ways:
2032 .sp
2033 (?<p1>(?i)rah)\es+\ek<p1>
2034 (?'p1'(?i)rah)\es+\ek{p1}
2035 (?P<p1>(?i)rah)\es+(?P=p1)
2036 (?<p1>(?i)rah)\es+\eg{p1}
2037 .sp
2038 A subpattern that is referenced by name may appear in the pattern before or
2039 after the reference.
2040 .P
2041 There may be more than one back reference to the same subpattern. If a
2042 subpattern has not actually been used in a particular match, any back
2043 references to it always fail by default. For example, the pattern
2044 .sp
2045 (a|(bc))\e2
2046 .sp
2047 always fails if it starts to match "a" rather than "bc". However, if the
2048 PCRE_JAVASCRIPT_COMPAT option is set at compile time, a back reference to an
2049 unset value matches an empty string.
2050 .P
2051 Because there may be many capturing parentheses in a pattern, all digits
2052 following a backslash are taken as part of a potential back reference number.
2053 If the pattern continues with a digit character, some delimiter must be used to
2054 terminate the back reference. If the PCRE_EXTENDED option is set, this can be
2055 white space. Otherwise, the \eg{ syntax or an empty comment (see
2056 .\" HTML <a href="#comments">
2057 .\" </a>
2058 "Comments"
2059 .\"
2060 below) can be used.
2061 .
2062 .SS "Recursive back references"
2063 .rs
2064 .sp
2065 A back reference that occurs inside the parentheses to which it refers fails
2066 when the subpattern is first used, so, for example, (a\e1) never matches.
2067 However, such references can be useful inside repeated subpatterns. For
2068 example, the pattern
2069 .sp
2070 (a|b\e1)+
2071 .sp
2072 matches any number of "a"s and also "aba", "ababbaa" etc. At each iteration of
2073 the subpattern, the back reference matches the character string corresponding
2074 to the previous iteration. In order for this to work, the pattern must be such
2075 that the first iteration does not need to match the back reference. This can be
2076 done using alternation, as in the example above, or by a quantifier with a
2077 minimum of zero.
2078 .P
2079 Back references of this type cause the group that they reference to be treated
2080 as an
2081 .\" HTML <a href="#atomicgroup">
2082 .\" </a>
2083 atomic group.
2084 .\"
2085 Once the whole group has been matched, a subsequent matching failure cannot
2086 cause backtracking into the middle of the group.
2087 .
2088 .
2089 .\" HTML <a name="bigassertions"></a>
2090 .SH ASSERTIONS
2091 .rs
2092 .sp
2093 An assertion is a test on the characters following or preceding the current
2094 matching point that does not actually consume any characters. The simple
2095 assertions coded as \eb, \eB, \eA, \eG, \eZ, \ez, ^ and $ are described
2096 .\" HTML <a href="#smallassertions">
2097 .\" </a>
2098 above.
2099 .\"
2100 .P
2101 More complicated assertions are coded as subpatterns. There are two kinds:
2102 those that look ahead of the current position in the subject string, and those
2103 that look behind it. An assertion subpattern is matched in the normal way,
2104 except that it does not cause the current matching position to be changed.
2105 .P
2106 Assertion subpatterns are not capturing subpatterns. If such an assertion
2107 contains capturing subpatterns within it, these are counted for the purposes of
2108 numbering the capturing subpatterns in the whole pattern. However, substring
2109 capturing is carried out only for positive assertions. (Perl sometimes, but not
2110 always, does do capturing in negative assertions.)
2111 .P
2112 For compatibility with Perl, assertion subpatterns may be repeated; though
2113 it makes no sense to assert the same thing several times, the side effect of
2114 capturing parentheses may occasionally be useful. In practice, there only three
2115 cases:
2116 .sp
2117 (1) If the quantifier is {0}, the assertion is never obeyed during matching.
2118 However, it may contain internal capturing parenthesized groups that are called
2119 from elsewhere via the
2120 .\" HTML <a href="#subpatternsassubroutines">
2121 .\" </a>
2122 subroutine mechanism.
2123 .\"
2124 .sp
2125 (2) If quantifier is {0,n} where n is greater than zero, it is treated as if it
2126 were {0,1}. At run time, the rest of the pattern match is tried with and
2127 without the assertion, the order depending on the greediness of the quantifier.
2128 .sp
2129 (3) If the minimum repetition is greater than zero, the quantifier is ignored.
2130 The assertion is obeyed just once when encountered during matching.
2131 .
2132 .
2133 .SS "Lookahead assertions"
2134 .rs
2135 .sp
2136 Lookahead assertions start with (?= for positive assertions and (?! for
2137 negative assertions. For example,
2138 .sp
2139 \ew+(?=;)
2140 .sp
2141 matches a word followed by a semicolon, but does not include the semicolon in
2142 the match, and
2143 .sp
2144 foo(?!bar)
2145 .sp
2146 matches any occurrence of "foo" that is not followed by "bar". Note that the
2147 apparently similar pattern
2148 .sp
2149 (?!foo)bar
2150 .sp
2151 does not find an occurrence of "bar" that is preceded by something other than
2152 "foo"; it finds any occurrence of "bar" whatsoever, because the assertion
2153 (?!foo) is always true when the next three characters are "bar". A
2154 lookbehind assertion is needed to achieve the other effect.
2155 .P
2156 If you want to force a matching failure at some point in a pattern, the most
2157 convenient way to do it is with (?!) because an empty string always matches, so
2158 an assertion that requires there not to be an empty string must always fail.
2159 The backtracking control verb (*FAIL) or (*F) is a synonym for (?!).
2160 .
2161 .
2162 .\" HTML <a name="lookbehind"></a>
2163 .SS "Lookbehind assertions"
2164 .rs
2165 .sp
2166 Lookbehind assertions start with (?<= for positive assertions and (?<! for
2167 negative assertions. For example,
2168 .sp
2169 (?<!foo)bar
2170 .sp
2171 does find an occurrence of "bar" that is not preceded by "foo". The contents of
2172 a lookbehind assertion are restricted such that all the strings it matches must
2173 have a fixed length. However, if there are several top-level alternatives, they
2174 do not all have to have the same fixed length. Thus
2175 .sp
2176 (?<=bullock|donkey)
2177 .sp
2178 is permitted, but
2179 .sp
2180 (?<!dogs?|cats?)
2181 .sp
2182 causes an error at compile time. Branches that match different length strings
2183 are permitted only at the top level of a lookbehind assertion. This is an
2184 extension compared with Perl, which requires all branches to match the same
2185 length of string. An assertion such as
2186 .sp
2187 (?<=ab(c|de))
2188 .sp
2189 is not permitted, because its single top-level branch can match two different
2190 lengths, but it is acceptable to PCRE if rewritten to use two top-level
2191 branches:
2192 .sp
2193 (?<=abc|abde)
2194 .sp
2195 In some cases, the escape sequence \eK
2196 .\" HTML <a href="#resetmatchstart">
2197 .\" </a>
2198 (see above)
2199 .\"
2200 can be used instead of a lookbehind assertion to get round the fixed-length
2201 restriction.
2202 .P
2203 The implementation of lookbehind assertions is, for each alternative, to
2204 temporarily move the current position back by the fixed length and then try to
2205 match. If there are insufficient characters before the current position, the
2206 assertion fails.
2207 .P
2208 In a UTF mode, PCRE does not allow the \eC escape (which matches a single data
2209 unit even in a UTF mode) to appear in lookbehind assertions, because it makes
2210 it impossible to calculate the length of the lookbehind. The \eX and \eR
2211 escapes, which can match different numbers of data units, are also not
2212 permitted.
2213 .P
2214 .\" HTML <a href="#subpatternsassubroutines">
2215 .\" </a>
2216 "Subroutine"
2217 .\"
2218 calls (see below) such as (?2) or (?&X) are permitted in lookbehinds, as long
2219 as the subpattern matches a fixed-length string.
2220 .\" HTML <a href="#recursion">
2221 .\" </a>
2222 Recursion,
2223 .\"
2224 however, is not supported.
2225 .P
2226 Possessive quantifiers can be used in conjunction with lookbehind assertions to
2227 specify efficient matching of fixed-length strings at the end of subject
2228 strings. Consider a simple pattern such as
2229 .sp
2230 abcd$
2231 .sp
2232 when applied to a long string that does not match. Because matching proceeds
2233 from left to right, PCRE will look for each "a" in the subject and then see if
2234 what follows matches the rest of the pattern. If the pattern is specified as
2235 .sp
2236 ^.*abcd$
2237 .sp
2238 the initial .* matches the entire string at first, but when this fails (because
2239 there is no following "a"), it backtracks to match all but the last character,
2240 then all but the last two characters, and so on. Once again the search for "a"
2241 covers the entire string, from right to left, so we are no better off. However,
2242 if the pattern is written as
2243 .sp
2244 ^.*+(?<=abcd)
2245 .sp
2246 there can be no backtracking for the .*+ item; it can match only the entire
2247 string. The subsequent lookbehind assertion does a single test on the last four
2248 characters. If it fails, the match fails immediately. For long strings, this
2249 approach makes a significant difference to the processing time.
2250 .
2251 .
2252 .SS "Using multiple assertions"
2253 .rs
2254 .sp
2255 Several assertions (of any sort) may occur in succession. For example,
2256 .sp
2257 (?<=\ed{3})(?<!999)foo
2258 .sp
2259 matches "foo" preceded by three digits that are not "999". Notice that each of
2260 the assertions is applied independently at the same point in the subject
2261 string. First there is a check that the previous three characters are all
2262 digits, and then there is a check that the same three characters are not "999".
2263 This pattern does \fInot\fP match "foo" preceded by six characters, the first
2264 of which are digits and the last three of which are not "999". For example, it
2265 doesn't match "123abcfoo". A pattern to do that is
2266 .sp
2267 (?<=\ed{3}...)(?<!999)foo
2268 .sp
2269 This time the first assertion looks at the preceding six characters, checking
2270 that the first three are digits, and then the second assertion checks that the
2271 preceding three characters are not "999".
2272 .P
2273 Assertions can be nested in any combination. For example,
2274 .sp
2275 (?<=(?<!foo)bar)baz
2276 .sp
2277 matches an occurrence of "baz" that is preceded by "bar" which in turn is not
2278 preceded by "foo", while
2279 .sp
2280 (?<=\ed{3}(?!999)...)foo
2281 .sp
2282 is another pattern that matches "foo" preceded by three digits and any three
2283 characters that are not "999".
2284 .
2285 .
2286 .\" HTML <a name="conditions"></a>
2287 .SH "CONDITIONAL SUBPATTERNS"
2288 .rs
2289 .sp
2290 It is possible to cause the matching process to obey a subpattern
2291 conditionally or to choose between two alternative subpatterns, depending on
2292 the result of an assertion, or whether a specific capturing subpattern has
2293 already been matched. The two possible forms of conditional subpattern are:
2294 .sp
2295 (?(condition)yes-pattern)
2296 (?(condition)yes-pattern|no-pattern)
2297 .sp
2298 If the condition is satisfied, the yes-pattern is used; otherwise the
2299 no-pattern (if present) is used. If there are more than two alternatives in the
2300 subpattern, a compile-time error occurs. Each of the two alternatives may
2301 itself contain nested subpatterns of any form, including conditional
2302 subpatterns; the restriction to two alternatives applies only at the level of
2303 the condition. This pattern fragment is an example where the alternatives are
2304 complex:
2305 .sp
2306 (?(1) (A|B|C) | (D | (?(2)E|F) | E) )
2307 .sp
2308 .P
2309 There are four kinds of condition: references to subpatterns, references to
2310 recursion, a pseudo-condition called DEFINE, and assertions.
2311 .
2312 .SS "Checking for a used subpattern by number"
2313 .rs
2314 .sp
2315 If the text between the parentheses consists of a sequence of digits, the
2316 condition is true if a capturing subpattern of that number has previously
2317 matched. If there is more than one capturing subpattern with the same number
2318 (see the earlier
2319 .\"
2320 .\" HTML <a href="#recursion">
2321 .\" </a>
2322 section about duplicate subpattern numbers),
2323 .\"
2324 the condition is true if any of them have matched. An alternative notation is
2325 to precede the digits with a plus or minus sign. In this case, the subpattern
2326 number is relative rather than absolute. The most recently opened parentheses
2327 can be referenced by (?(-1), the next most recent by (?(-2), and so on. Inside
2328 loops it can also make sense to refer to subsequent groups. The next
2329 parentheses to be opened can be referenced as (?(+1), and so on. (The value
2330 zero in any of these forms is not used; it provokes a compile-time error.)
2331 .P
2332 Consider the following pattern, which contains non-significant white space to
2333 make it more readable (assume the PCRE_EXTENDED option) and to divide it into
2334 three parts for ease of discussion:
2335 .sp
2336 ( \e( )? [^()]+ (?(1) \e) )
2337 .sp
2338 The first part matches an optional opening parenthesis, and if that
2339 character is present, sets it as the first captured substring. The second part
2340 matches one or more characters that are not parentheses. The third part is a
2341 conditional subpattern that tests whether or not the first set of parentheses
2342 matched. If they did, that is, if subject started with an opening parenthesis,
2343 the condition is true, and so the yes-pattern is executed and a closing
2344 parenthesis is required. Otherwise, since no-pattern is not present, the
2345 subpattern matches nothing. In other words, this pattern matches a sequence of
2346 non-parentheses, optionally enclosed in parentheses.
2347 .P
2348 If you were embedding this pattern in a larger one, you could use a relative
2349 reference:
2350 .sp
2351 ...other stuff... ( \e( )? [^()]+ (?(-1) \e) ) ...
2352 .sp
2353 This makes the fragment independent of the parentheses in the larger pattern.
2354 .
2355 .SS "Checking for a used subpattern by name"
2356 .rs
2357 .sp
2358 Perl uses the syntax (?(<name>)...) or (?('name')...) to test for a used
2359 subpattern by name. For compatibility with earlier versions of PCRE, which had
2360 this facility before Perl, the syntax (?(name)...) is also recognized.
2361 .P
2362 Rewriting the above example to use a named subpattern gives this:
2363 .sp
2364 (?<OPEN> \e( )? [^()]+ (?(<OPEN>) \e) )
2365 .sp
2366 If the name used in a condition of this kind is a duplicate, the test is
2367 applied to all subpatterns of the same name, and is true if any one of them has
2368 matched.
2369 .
2370 .SS "Checking for pattern recursion"
2371 .rs
2372 .sp
2373 If the condition is the string (R), and there is no subpattern with the name R,
2374 the condition is true if a recursive call to the whole pattern or any
2375 subpattern has been made. If digits or a name preceded by ampersand follow the
2376 letter R, for example:
2377 .sp
2378 (?(R3)...) or (?(R&name)...)
2379 .sp
2380 the condition is true if the most recent recursion is into a subpattern whose
2381 number or name is given. This condition does not check the entire recursion
2382 stack. If the name used in a condition of this kind is a duplicate, the test is
2383 applied to all subpatterns of the same name, and is true if any one of them is
2384 the most recent recursion.
2385 .P
2386 At "top level", all these recursion test conditions are false.
2387 .\" HTML <a href="#recursion">
2388 .\" </a>
2389 The syntax for recursive patterns
2390 .\"
2391 is described below.
2392 .
2393 .\" HTML <a name="subdefine"></a>
2394 .SS "Defining subpatterns for use by reference only"
2395 .rs
2396 .sp
2397 If the condition is the string (DEFINE), and there is no subpattern with the
2398 name DEFINE, the condition is always false. In this case, there may be only one
2399 alternative in the subpattern. It is always skipped if control reaches this
2400 point in the pattern; the idea of DEFINE is that it can be used to define
2401 subroutines that can be referenced from elsewhere. (The use of
2402 .\" HTML <a href="#subpatternsassubroutines">
2403 .\" </a>
2404 subroutines
2405 .\"
2406 is described below.) For example, a pattern to match an IPv4 address such as
2407 "192.168.23.245" could be written like this (ignore white space and line
2408 breaks):
2409 .sp
2410 (?(DEFINE) (?<byte> 2[0-4]\ed | 25[0-5] | 1\ed\ed | [1-9]?\ed) )
2411 \eb (?&byte) (\e.(?&byte)){3} \eb
2412 .sp
2413 The first part of the pattern is a DEFINE group inside which a another group
2414 named "byte" is defined. This matches an individual component of an IPv4
2415 address (a number less than 256). When matching takes place, this part of the
2416 pattern is skipped because DEFINE acts like a false condition. The rest of the
2417 pattern uses references to the named group to match the four dot-separated
2418 components of an IPv4 address, insisting on a word boundary at each end.
2419 .
2420 .SS "Assertion conditions"
2421 .rs
2422 .sp
2423 If the condition is not in any of the above formats, it must be an assertion.
2424 This may be a positive or negative lookahead or lookbehind assertion. Consider
2425 this pattern, again containing non-significant white space, and with the two
2426 alternatives on the second line:
2427 .sp
2428 (?(?=[^a-z]*[a-z])
2429 \ed{2}-[a-z]{3}-\ed{2} | \ed{2}-\ed{2}-\ed{2} )
2430 .sp
2431 The condition is a positive lookahead assertion that matches an optional
2432 sequence of non-letters followed by a letter. In other words, it tests for the
2433 presence of at least one letter in the subject. If a letter is found, the
2434 subject is matched against the first alternative; otherwise it is matched
2435 against the second. This pattern matches strings in one of the two forms
2436 dd-aaa-dd or dd-dd-dd, where aaa are letters and dd are digits.
2437 .
2438 .
2439 .\" HTML <a name="comments"></a>
2440 .SH COMMENTS
2441 .rs
2442 .sp
2443 There are two ways of including comments in patterns that are processed by
2444 PCRE. In both cases, the start of the comment must not be in a character class,
2445 nor in the middle of any other sequence of related characters such as (?: or a
2446 subpattern name or number. The characters that make up a comment play no part
2447 in the pattern matching.
2448 .P
2449 The sequence (?# marks the start of a comment that continues up to the next
2450 closing parenthesis. Nested parentheses are not permitted. If the PCRE_EXTENDED
2451 option is set, an unescaped # character also introduces a comment, which in
2452 this case continues to immediately after the next newline character or
2453 character sequence in the pattern. Which characters are interpreted as newlines
2454 is controlled by the options passed to a compiling function or by a special
2455 sequence at the start of the pattern, as described in the section entitled
2456 .\" HTML <a href="#newlines">
2457 .\" </a>
2458 "Newline conventions"
2459 .\"
2460 above. Note that the end of this type of comment is a literal newline sequence
2461 in the pattern; escape sequences that happen to represent a newline do not
2462 count. For example, consider this pattern when PCRE_EXTENDED is set, and the
2463 default newline convention is in force:
2464 .sp
2465 abc #comment \en still comment
2466 .sp
2467 On encountering the # character, \fBpcre_compile()\fP skips along, looking for
2468 a newline in the pattern. The sequence \en is still literal at this stage, so
2469 it does not terminate the comment. Only an actual character with the code value
2470 0x0a (the default newline) does so.
2471 .
2472 .
2473 .\" HTML <a name="recursion"></a>
2474 .SH "RECURSIVE PATTERNS"
2475 .rs
2476 .sp
2477 Consider the problem of matching a string in parentheses, allowing for
2478 unlimited nested parentheses. Without the use of recursion, the best that can
2479 be done is to use a pattern that matches up to some fixed depth of nesting. It
2480 is not possible to handle an arbitrary nesting depth.
2481 .P
2482 For some time, Perl has provided a facility that allows regular expressions to
2483 recurse (amongst other things). It does this by interpolating Perl code in the
2484 expression at run time, and the code can refer to the expression itself. A Perl
2485 pattern using code interpolation to solve the parentheses problem can be
2486 created like this:
2487 .sp
2488 $re = qr{\e( (?: (?>[^()]+) | (?p{$re}) )* \e)}x;
2489 .sp
2490 The (?p{...}) item interpolates Perl code at run time, and in this case refers
2491 recursively to the pattern in which it appears.
2492 .P
2493 Obviously, PCRE cannot support the interpolation of Perl code. Instead, it
2494 supports special syntax for recursion of the entire pattern, and also for
2495 individual subpattern recursion. After its introduction in PCRE and Python,
2496 this kind of recursion was subsequently introduced into Perl at release 5.10.
2497 .P
2498 A special item that consists of (? followed by a number greater than zero and a
2499 closing parenthesis is a recursive subroutine call of the subpattern of the
2500 given number, provided that it occurs inside that subpattern. (If not, it is a
2501 .\" HTML <a href="#subpatternsassubroutines">
2502 .\" </a>
2503 non-recursive subroutine
2504 .\"
2505 call, which is described in the next section.) The special item (?R) or (?0) is
2506 a recursive call of the entire regular expression.
2507 .P
2508 This PCRE pattern solves the nested parentheses problem (assume the
2509 PCRE_EXTENDED option is set so that white space is ignored):
2510 .sp
2511 \e( ( [^()]++ | (?R) )* \e)
2512 .sp
2513 First it matches an opening parenthesis. Then it matches any number of
2514 substrings which can either be a sequence of non-parentheses, or a recursive
2515 match of the pattern itself (that is, a correctly parenthesized substring).
2516 Finally there is a closing parenthesis. Note the use of a possessive quantifier
2517 to avoid backtracking into sequences of non-parentheses.
2518 .P
2519 If this were part of a larger pattern, you would not want to recurse the entire
2520 pattern, so instead you could use this:
2521 .sp
2522 ( \e( ( [^()]++ | (?1) )* \e) )
2523 .sp
2524 We have put the pattern into parentheses, and caused the recursion to refer to
2525 them instead of the whole pattern.
2526 .P
2527 In a larger pattern, keeping track of parenthesis numbers can be tricky. This
2528 is made easier by the use of relative references. Instead of (?1) in the
2529 pattern above you can write (?-2) to refer to the second most recently opened
2530 parentheses preceding the recursion. In other words, a negative number counts
2531 capturing parentheses leftwards from the point at which it is encountered.
2532 .P
2533 It is also possible to refer to subsequently opened parentheses, by writing
2534 references such as (?+2). However, these cannot be recursive because the
2535 reference is not inside the parentheses that are referenced. They are always
2536 .\" HTML <a href="#subpatternsassubroutines">
2537 .\" </a>
2538 non-recursive subroutine
2539 .\"
2540 calls, as described in the next section.
2541 .P
2542 An alternative approach is to use named parentheses instead. The Perl syntax
2543 for this is (?&name); PCRE's earlier syntax (?P>name) is also supported. We
2544 could rewrite the above example as follows:
2545 .sp
2546 (?<pn> \e( ( [^()]++ | (?&pn) )* \e) )
2547 .sp
2548 If there is more than one subpattern with the same name, the earliest one is
2549 used.
2550 .P
2551 This particular example pattern that we have been looking at contains nested
2552 unlimited repeats, and so the use of a possessive quantifier for matching
2553 strings of non-parentheses is important when applying the pattern to strings
2554 that do not match. For example, when this pattern is applied to
2555 .sp
2556 (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()
2557 .sp
2558 it yields "no match" quickly. However, if a possessive quantifier is not used,
2559 the match runs for a very long time indeed because there are so many different
2560 ways the + and * repeats can carve up the subject, and all have to be tested
2561 before failure can be reported.
2562 .P
2563 At the end of a match, the values of capturing parentheses are those from
2564 the outermost level. If you want to obtain intermediate values, a callout
2565 function can be used (see below and the
2566 .\" HREF
2567 \fBpcrecallout\fP
2568 .\"
2569 documentation). If the pattern above is matched against
2570 .sp
2571 (ab(cd)ef)
2572 .sp
2573 the value for the inner capturing parentheses (numbered 2) is "ef", which is
2574 the last value taken on at the top level. If a capturing subpattern is not
2575 matched at the top level, its final captured value is unset, even if it was
2576 (temporarily) set at a deeper level during the matching process.
2577 .P
2578 If there are more than 15 capturing parentheses in a pattern, PCRE has to
2579 obtain extra memory to store data during a recursion, which it does by using
2580 \fBpcre_malloc\fP, freeing it via \fBpcre_free\fP afterwards. If no memory can
2581 be obtained, the match fails with the PCRE_ERROR_NOMEMORY error.
2582 .P
2583 Do not confuse the (?R) item with the condition (R), which tests for recursion.
2584 Consider this pattern, which matches text in angle brackets, allowing for
2585 arbitrary nesting. Only digits are allowed in nested brackets (that is, when
2586 recursing), whereas any characters are permitted at the outer level.
2587 .sp
2588 < (?: (?(R) \ed++ | [^<>]*+) | (?R)) * >
2589 .sp
2590 In this pattern, (?(R) is the start of a conditional subpattern, with two
2591 different alternatives for the recursive and non-recursive cases. The (?R) item
2592 is the actual recursive call.
2593 .
2594 .
2595 .\" HTML <a name="recursiondifference"></a>
2596 .SS "Differences in recursion processing between PCRE and Perl"
2597 .rs
2598 .sp
2599 Recursion processing in PCRE differs from Perl in two important ways. In PCRE
2600 (like Python, but unlike Perl), a recursive subpattern call is always treated
2601 as an atomic group. That is, once it has matched some of the subject string, it
2602 is never re-entered, even if it contains untried alternatives and there is a
2603 subsequent matching failure. This can be illustrated by the following pattern,
2604 which purports to match a palindromic string that contains an odd number of
2605 characters (for example, "a", "aba", "abcba", "abcdcba"):
2606 .sp
2607 ^(.|(.)(?1)\e2)$
2608 .sp
2609 The idea is that it either matches a single character, or two identical
2610 characters surrounding a sub-palindrome. In Perl, this pattern works; in PCRE
2611 it does not if the pattern is longer than three characters. Consider the
2612 subject string "abcba":
2613 .P
2614 At the top level, the first character is matched, but as it is not at the end
2615 of the string, the first alternative fails; the second alternative is taken
2616 and the recursion kicks in. The recursive call to subpattern 1 successfully
2617 matches the next character ("b"). (Note that the beginning and end of line
2618 tests are not part of the recursion).
2619 .P
2620 Back at the top level, the next character ("c") is compared with what
2621 subpattern 2 matched, which was "a". This fails. Because the recursion is
2622 treated as an atomic group, there are now no backtracking points, and so the
2623 entire match fails. (Perl is able, at this point, to re-enter the recursion and
2624 try the second alternative.) However, if the pattern is written with the
2625 alternatives in the other order, things are different:
2626 .sp
2627 ^((.)(?1)\e2|.)$
2628 .sp
2629 This time, the recursing alternative is tried first, and continues to recurse
2630 until it runs out of characters, at which point the recursion fails. But this
2631 time we do have another alternative to try at the higher level. That is the big
2632 difference: in the previous case the remaining alternative is at a deeper
2633 recursion level, which PCRE cannot use.
2634 .P
2635 To change the pattern so that it matches all palindromic strings, not just
2636 those with an odd number of characters, it is tempting to change the pattern to
2637 this:
2638 .sp
2639 ^((.)(?1)\e2|.?)$
2640 .sp
2641 Again, this works in Perl, but not in PCRE, and for the same reason. When a
2642 deeper recursion has matched a single character, it cannot be entered again in
2643 order to match an empty string. The solution is to separate the two cases, and
2644 write out the odd and even cases as alternatives at the higher level:
2645 .sp
2646 ^(?:((.)(?1)\e2|)|((.)(?3)\e4|.))
2647 .sp
2648 If you want to match typical palindromic phrases, the pattern has to ignore all
2649 non-word characters, which can be done like this:
2650 .sp
2651 ^\eW*+(?:((.)\eW*+(?1)\eW*+\e2|)|((.)\eW*+(?3)\eW*+\e4|\eW*+.\eW*+))\eW*+$
2652 .sp
2653 If run with the PCRE_CASELESS option, this pattern matches phrases such as "A
2654 man, a plan, a canal: Panama!" and it works well in both PCRE and Perl. Note
2655 the use of the possessive quantifier *+ to avoid backtracking into sequences of
2656 non-word characters. Without this, PCRE takes a great deal longer (ten times or
2657 more) to match typical phrases, and Perl takes so long that you think it has
2658 gone into a loop.
2659 .P
2660 \fBWARNING\fP: The palindrome-matching patterns above work only if the subject
2661 string does not start with a palindrome that is shorter than the entire string.
2662 For example, although "abcba" is correctly matched, if the subject is "ababa",
2663 PCRE finds the palindrome "aba" at the start, then fails at top level because
2664 the end of the string does not follow. Once again, it cannot jump back into the
2665 recursion to try other alternatives, so the entire match fails.
2666 .P
2667 The second way in which PCRE and Perl differ in their recursion processing is
2668 in the handling of captured values. In Perl, when a subpattern is called
2669 recursively or as a subpattern (see the next section), it has no access to any
2670 values that were captured outside the recursion, whereas in PCRE these values
2671 can be referenced. Consider this pattern:
2672 .sp
2673 ^(.)(\e1|a(?2))
2674 .sp
2675 In PCRE, this pattern matches "bab". The first capturing parentheses match "b",
2676 then in the second group, when the back reference \e1 fails to match "b", the
2677 second alternative matches "a" and then recurses. In the recursion, \e1 does
2678 now match "b" and so the whole match succeeds. In Perl, the pattern fails to
2679 match because inside the recursive call \e1 cannot access the externally set
2680 value.
2681 .
2682 .
2683 .\" HTML <a name="subpatternsassubroutines"></a>
2684 .SH "SUBPATTERNS AS SUBROUTINES"
2685 .rs
2686 .sp
2687 If the syntax for a recursive subpattern call (either by number or by
2688 name) is used outside the parentheses to which it refers, it operates like a
2689 subroutine in a programming language. The called subpattern may be defined
2690 before or after the reference. A numbered reference can be absolute or
2691 relative, as in these examples:
2692 .sp
2693 (...(absolute)...)...(?2)...
2694 (...(relative)...)...(?-1)...
2695 (...(?+1)...(relative)...
2696 .sp
2697 An earlier example pointed out that the pattern
2698 .sp
2699 (sens|respons)e and \e1ibility
2700 .sp
2701 matches "sense and sensibility" and "response and responsibility", but not
2702 "sense and responsibility". If instead the pattern
2703 .sp
2704 (sens|respons)e and (?1)ibility
2705 .sp
2706 is used, it does match "sense and responsibility" as well as the other two
2707 strings. Another example is given in the discussion of DEFINE above.
2708 .P
2709 All subroutine calls, whether recursive or not, are always treated as atomic
2710 groups. That is, once a subroutine has matched some of the subject string, it
2711 is never re-entered, even if it contains untried alternatives and there is a
2712 subsequent matching failure. Any capturing parentheses that are set during the
2713 subroutine call revert to their previous values afterwards.
2714 .P
2715 Processing options such as case-independence are fixed when a subpattern is
2716 defined, so if it is used as a subroutine, such options cannot be changed for
2717 different calls. For example, consider this pattern:
2718 .sp
2719 (abc)(?i:(?-1))
2720 .sp
2721 It matches "abcabc". It does not match "abcABC" because the change of
2722 processing option does not affect the called subpattern.
2723 .
2724 .
2725 .\" HTML <a name="onigurumasubroutines"></a>
2726 .SH "ONIGURUMA SUBROUTINE SYNTAX"
2727 .rs
2728 .sp
2729 For compatibility with Oniguruma, the non-Perl syntax \eg followed by a name or
2730 a number enclosed either in angle brackets or single quotes, is an alternative
2731 syntax for referencing a subpattern as a subroutine, possibly recursively. Here
2732 are two of the examples used above, rewritten using this syntax:
2733 .sp
2734 (?<pn> \e( ( (?>[^()]+) | \eg<pn> )* \e) )
2735 (sens|respons)e and \eg'1'ibility
2736 .sp
2737 PCRE supports an extension to Oniguruma: if a number is preceded by a
2738 plus or a minus sign it is taken as a relative reference. For example:
2739 .sp
2740 (abc)(?i:\eg<-1>)
2741 .sp
2742 Note that \eg{...} (Perl syntax) and \eg<...> (Oniguruma syntax) are \fInot\fP
2743 synonymous. The former is a back reference; the latter is a subroutine call.
2744 .
2745 .
2746 .SH CALLOUTS
2747 .rs
2748 .sp
2749 Perl has a feature whereby using the sequence (?{...}) causes arbitrary Perl
2750 code to be obeyed in the middle of matching a regular expression. This makes it
2751 possible, amongst other things, to extract different substrings that match the
2752 same pair of parentheses when there is a repetition.
2753 .P
2754 PCRE provides a similar feature, but of course it cannot obey arbitrary Perl
2755 code. The feature is called "callout". The caller of PCRE provides an external
2756 function by putting its entry point in the global variable \fIpcre_callout\fP
2757 (8-bit library) or \fIpcre[16|32]_callout\fP (16-bit or 32-bit library).
2758 By default, this variable contains NULL, which disables all calling out.
2759 .P
2760 Within a regular expression, (?C) indicates the points at which the external
2761 function is to be called. If you want to identify different callout points, you
2762 can put a number less than 256 after the letter C. The default value is zero.
2763 For example, this pattern has two callout points:
2764 .sp
2765 (?C1)abc(?C2)def
2766 .sp
2767 If the PCRE_AUTO_CALLOUT flag is passed to a compiling function, callouts are
2768 automatically installed before each item in the pattern. They are all numbered
2769 255. If there is a conditional group in the pattern whose condition is an
2770 assertion, an additional callout is inserted just before the condition. An
2771 explicit callout may also be set at this position, as in this example:
2772 .sp
2773 (?(?C9)(?=a)abc|def)
2774 .sp
2775 Note that this applies only to assertion conditions, not to other types of
2776 condition.
2777 .P
2778 During matching, when PCRE reaches a callout point, the external function is
2779 called. It is provided with the number of the callout, the position in the
2780 pattern, and, optionally, one item of data originally supplied by the caller of
2781 the matching function. The callout function may cause matching to proceed, to
2782 backtrack, or to fail altogether.
2783 .P
2784 By default, PCRE implements a number of optimizations at compile time and
2785 matching time, and one side-effect is that sometimes callouts are skipped. If
2786 you need all possible callouts to happen, you need to set options that disable
2787 the relevant optimizations. More details, and a complete description of the
2788 interface to the callout function, are given in the
2789 .\" HREF
2790 \fBpcrecallout\fP
2791 .\"
2792 documentation.
2793 .
2794 .
2795 .\" HTML <a name="backtrackcontrol"></a>
2796 .SH "BACKTRACKING CONTROL"
2797 .rs
2798 .sp
2799 Perl 5.10 introduced a number of "Special Backtracking Control Verbs", which
2800 are still described in the Perl documentation as "experimental and subject to
2801 change or removal in a future version of Perl". It goes on to say: "Their usage
2802 in production code should be noted to avoid problems during upgrades." The same
2803 remarks apply to the PCRE features described in this section.
2804 .P
2805 The new verbs make use of what was previously invalid syntax: an opening
2806 parenthesis followed by an asterisk. They are generally of the form
2807 (*VERB) or (*VERB:NAME). Some may take either form, possibly behaving
2808 differently depending on whether or not a name is present. A name is any
2809 sequence of characters that does not include a closing parenthesis. The maximum
2810 length of name is 255 in the 8-bit library and 65535 in the 16-bit and 32-bit
2811 libraries. If the name is empty, that is, if the closing parenthesis
2812 immediately follows the colon, the effect is as if the colon were not there.
2813 Any number of these verbs may occur in a pattern.
2814 .P
2815 Since these verbs are specifically related to backtracking, most of them can be
2816 used only when the pattern is to be matched using one of the traditional
2817 matching functions, because these use a backtracking algorithm. With the
2818 exception of (*FAIL), which behaves like a failing negative assertion, the
2819 backtracking control verbs cause an error if encountered by a DFA matching
2820 function.
2821 .P
2822 The behaviour of these verbs in
2823 .\" HTML <a href="#btrepeat">
2824 .\" </a>
2825 repeated groups,
2826 .\"
2827 .\" HTML <a href="#btassert">
2828 .\" </a>
2829 assertions,
2830 .\"
2831 and in
2832 .\" HTML <a href="#btsub">
2833 .\" </a>
2834 subpatterns called as subroutines
2835 .\"
2836 (whether or not recursively) is documented below.
2837 .
2838 .
2839 .\" HTML <a name="nooptimize"></a>
2840 .SS "Optimizations that affect backtracking verbs"
2841 .rs
2842 .sp
2843 PCRE contains some optimizations that are used to speed up matching by running
2844 some checks at the start of each match attempt. For example, it may know the
2845 minimum length of matching subject, or that a particular character must be
2846 present. When one of these optimizations bypasses the running of a match, any
2847 included backtracking verbs will not, of course, be processed. You can suppress
2848 the start-of-match optimizations by setting the PCRE_NO_START_OPTIMIZE option
2849 when calling \fBpcre_compile()\fP or \fBpcre_exec()\fP, or by starting the
2850 pattern with (*NO_START_OPT). There is more discussion of this option in the
2851 section entitled
2852 .\" HTML <a href="pcreapi.html#execoptions">
2853 .\" </a>
2854 "Option bits for \fBpcre_exec()\fP"
2855 .\"
2856 in the
2857 .\" HREF
2858 \fBpcreapi\fP
2859 .\"
2860 documentation.
2861 .P
2862 Experiments with Perl suggest that it too has similar optimizations, sometimes
2863 leading to anomalous results.
2864 .
2865 .
2866 .SS "Verbs that act immediately"
2867 .rs
2868 .sp
2869 The following verbs act as soon as they are encountered. They may not be
2870 followed by a name.
2871 .sp
2872 (*ACCEPT)
2873 .sp
2874 This verb causes the match to end successfully, skipping the remainder of the
2875 pattern. However, when it is inside a subpattern that is called as a
2876 subroutine, only that subpattern is ended successfully. Matching then continues
2877 at the outer level. If (*ACCEPT) in triggered in a positive assertion, the
2878 assertion succeeds; in a negative assertion, the assertion fails.
2879 .P
2880 If (*ACCEPT) is inside capturing parentheses, the data so far is captured. For
2881 example:
2882 .sp
2883 A((?:A|B(*ACCEPT)|C)D)
2884 .sp
2885 This matches "AB", "AAD", or "ACD"; when it matches "AB", "B" is captured by
2886 the outer parentheses.
2887 .sp
2888 (*FAIL) or (*F)
2889 .sp
2890 This verb causes a matching failure, forcing backtracking to occur. It is
2891 equivalent to (?!) but easier to read. The Perl documentation notes that it is
2892 probably useful only when combined with (?{}) or (??{}). Those are, of course,
2893 Perl features that are not present in PCRE. The nearest equivalent is the
2894 callout feature, as for example in this pattern:
2895 .sp
2896 a+(?C)(*FAIL)
2897 .sp
2898 A match with the string "aaaa" always fails, but the callout is taken before
2899 each backtrack happens (in this example, 10 times).
2900 .
2901 .
2902 .SS "Recording which path was taken"
2903 .rs
2904 .sp
2905 There is one verb whose main purpose is to track how a match was arrived at,
2906 though it also has a secondary use in conjunction with advancing the match
2907 starting point (see (*SKIP) below).
2908 .sp
2909 (*MARK:NAME) or (*:NAME)
2910 .sp
2911 A name is always required with this verb. There may be as many instances of
2912 (*MARK) as you like in a pattern, and their names do not have to be unique.
2913 .P
2914 When a match succeeds, the name of the last-encountered (*MARK:NAME),
2915 (*PRUNE:NAME), or (*THEN:NAME) on the matching path is passed back to the
2916 caller as described in the section entitled
2917 .\" HTML <a href="pcreapi.html#extradata">
2918 .\" </a>
2919 "Extra data for \fBpcre_exec()\fP"
2920 .\"
2921 in the
2922 .\" HREF
2923 \fBpcreapi\fP
2924 .\"
2925 documentation. Here is an example of \fBpcretest\fP output, where the /K
2926 modifier requests the retrieval and outputting of (*MARK) data:
2927 .sp
2928 re> /X(*MARK:A)Y|X(*MARK:B)Z/K
2929 data> XY
2930 0: XY
2931 MK: A
2932 XZ
2933 0: XZ
2934 MK: B
2935 .sp
2936 The (*MARK) name is tagged with "MK:" in this output, and in this example it
2937 indicates which of the two alternatives matched. This is a more efficient way
2938 of obtaining this information than putting each alternative in its own
2939 capturing parentheses.
2940 .P
2941 If a verb with a name is encountered in a positive assertion that is true, the
2942 name is recorded and passed back if it is the last-encountered. This does not
2943 happen for negative assertions or failing positive assertions.
2944 .P
2945 After a partial match or a failed match, the last encountered name in the
2946 entire match process is returned. For example:
2947 .sp
2948 re> /X(*MARK:A)Y|X(*MARK:B)Z/K
2949 data> XP
2950 No match, mark = B
2951 .sp
2952 Note that in this unanchored example the mark is retained from the match
2953 attempt that started at the letter "X" in the subject. Subsequent match
2954 attempts starting at "P" and then with an empty string do not get as far as the
2955 (*MARK) item, but nevertheless do not reset it.
2956 .P
2957 If you are interested in (*MARK) values after failed matches, you should
2958 probably set the PCRE_NO_START_OPTIMIZE option
2959 .\" HTML <a href="#nooptimize">
2960 .\" </a>
2961 (see above)
2962 .\"
2963 to ensure that the match is always attempted.
2964 .
2965 .
2966 .SS "Verbs that act after backtracking"
2967 .rs
2968 .sp
2969 The following verbs do nothing when they are encountered. Matching continues
2970 with what follows, but if there is no subsequent match, causing a backtrack to
2971 the verb, a failure is forced. That is, backtracking cannot pass to the left of
2972 the verb. However, when one of these verbs appears inside an atomic group or an
2973 assertion that is true, its effect is confined to that group, because once the
2974 group has been matched, there is never any backtracking into it. In this
2975 situation, backtracking can "jump back" to the left of the entire atomic group
2976 or assertion. (Remember also, as stated above, that this localization also
2977 applies in subroutine calls.)
2978 .P
2979 These verbs differ in exactly what kind of failure occurs when backtracking
2980 reaches them. The behaviour described below is what happens when the verb is
2981 not in a subroutine or an assertion. Subsequent sections cover these special
2982 cases.
2983 .sp
2984 (*COMMIT)
2985 .sp
2986 This verb, which may not be followed by a name, causes the whole match to fail
2987 outright if there is a later matching failure that causes backtracking to reach
2988 it. Even if the pattern is unanchored, no further attempts to find a match by
2989 advancing the starting point take place. If (*COMMIT) is the only backtracking
2990 verb that is encountered, once it has been passed \fBpcre_exec()\fP is
2991 committed to finding a match at the current starting point, or not at all. For
2992 example:
2993 .sp
2994 a+(*COMMIT)b
2995 .sp
2996 This matches "xxaab" but not "aacaab". It can be thought of as a kind of
2997 dynamic anchor, or "I've started, so I must finish." The name of the most
2998 recently passed (*MARK) in the path is passed back when (*COMMIT) forces a
2999 match failure.
3000 .P
3001 If there is more than one backtracking verb in a pattern, a different one that
3002 follows (*COMMIT) may be triggered first, so merely passing (*COMMIT) during a
3003 match does not always guarantee that a match must be at this starting point.
3004 .P
3005 Note that (*COMMIT) at the start of a pattern is not the same as an anchor,
3006 unless PCRE's start-of-match optimizations are turned off, as shown in this
3007 \fBpcretest\fP example:
3008 .sp
3009 re> /(*COMMIT)abc/
3010 data> xyzabc
3011 0: abc
3012 xyzabc\eY
3013 No match
3014 .sp
3015 PCRE knows that any match must start with "a", so the optimization skips along
3016 the subject to "a" before running the first match attempt, which succeeds. When
3017 the optimization is disabled by the \eY escape in the second subject, the match
3018 starts at "x" and so the (*COMMIT) causes it to fail without trying any other
3019 starting points.
3020 .sp
3021 (*PRUNE) or (*PRUNE:NAME)
3022 .sp
3023 This verb causes the match to fail at the current starting position in the
3024 subject if there is a later matching failure that causes backtracking to reach
3025 it. If the pattern is unanchored, the normal "bumpalong" advance to the next
3026 starting character then happens. Backtracking can occur as usual to the left of
3027 (*PRUNE), before it is reached, or when matching to the right of (*PRUNE), but
3028 if there is no match to the right, backtracking cannot cross (*PRUNE). In
3029 simple cases, the use of (*PRUNE) is just an alternative to an atomic group or
3030 possessive quantifier, but there are some uses of (*PRUNE) that cannot be
3031 expressed in any other way. In an anchored pattern (*PRUNE) has the same effect
3032 as (*COMMIT).
3033 .P
3034 The behaviour of (*PRUNE:NAME) is the not the same as (*MARK:NAME)(*PRUNE).
3035 It is like (*MARK:NAME) in that the name is remembered for passing back to the
3036 caller. However, (*SKIP:NAME) searches only for names set with (*MARK).
3037 .sp
3038 (*SKIP)
3039 .sp
3040 This verb, when given without a name, is like (*PRUNE), except that if the
3041 pattern is unanchored, the "bumpalong" advance is not to the next character,
3042 but to the position in the subject where (*SKIP) was encountered. (*SKIP)
3043 signifies that whatever text was matched leading up to it cannot be part of a
3044 successful match. Consider:
3045 .sp
3046 a+(*SKIP)b
3047 .sp
3048 If the subject is "aaaac...", after the first match attempt fails (starting at
3049 the first character in the string), the starting point skips on to start the
3050 next attempt at "c". Note that a possessive quantifer does not have the same
3051 effect as this example; although it would suppress backtracking during the
3052 first match attempt, the second attempt would start at the second character
3053 instead of skipping on to "c".
3054 .sp
3055 (*SKIP:NAME)
3056 .sp
3057 When (*SKIP) has an associated name, its behaviour is modified. When it is
3058 triggered, the previous path through the pattern is searched for the most
3059 recent (*MARK) that has the same name. If one is found, the "bumpalong" advance
3060 is to the subject position that corresponds to that (*MARK) instead of to where
3061 (*SKIP) was encountered. If no (*MARK) with a matching name is found, the
3062 (*SKIP) is ignored.
3063 .P
3064 Note that (*SKIP:NAME) searches only for names set by (*MARK:NAME). It ignores
3065 names that are set by (*PRUNE:NAME) or (*THEN:NAME).
3066 .sp
3067 (*THEN) or (*THEN:NAME)
3068 .sp
3069 This verb causes a skip to the next innermost alternative when backtracking
3070 reaches it. That is, it cancels any further backtracking within the current
3071 alternative. Its name comes from the observation that it can be used for a
3072 pattern-based if-then-else block:
3073 .sp
3074 ( COND1 (*THEN) FOO | COND2 (*THEN) BAR | COND3 (*THEN) BAZ ) ...
3075 .sp
3076 If the COND1 pattern matches, FOO is tried (and possibly further items after
3077 the end of the group if FOO succeeds); on failure, the matcher skips to the
3078 second alternative and tries COND2, without backtracking into COND1. If that
3079 succeeds and BAR fails, COND3 is tried. If subsequently BAZ fails, there are no
3080 more alternatives, so there is a backtrack to whatever came before the entire
3081 group. If (*THEN) is not inside an alternation, it acts like (*PRUNE).
3082 .P
3083 The behaviour of (*THEN:NAME) is the not the same as (*MARK:NAME)(*THEN).
3084 It is like (*MARK:NAME) in that the name is remembered for passing back to the
3085 caller. However, (*SKIP:NAME) searches only for names set with (*MARK).
3086 .P
3087 A subpattern that does not contain a | character is just a part of the
3088 enclosing alternative; it is not a nested alternation with only one
3089 alternative. The effect of (*THEN) extends beyond such a subpattern to the
3090 enclosing alternative. Consider this pattern, where A, B, etc. are complex
3091 pattern fragments that do not contain any | characters at this level:
3092 .sp
3093 A (B(*THEN)C) | D
3094 .sp
3095 If A and B are matched, but there is a failure in C, matching does not
3096 backtrack into A; instead it moves to the next alternative, that is, D.
3097 However, if the subpattern containing (*THEN) is given an alternative, it
3098 behaves differently:
3099 .sp
3100 A (B(*THEN)C | (*FAIL)) | D
3101 .sp
3102 The effect of (*THEN) is now confined to the inner subpattern. After a failure
3103 in C, matching moves to (*FAIL), which causes the whole subpattern to fail
3104 because there are no more alternatives to try. In this case, matching does now
3105 backtrack into A.
3106 .P
3107 Note that a conditional subpattern is not considered as having two
3108 alternatives, because only one is ever used. In other words, the | character in
3109 a conditional subpattern has a different meaning. Ignoring white space,
3110 consider:
3111 .sp
3112 ^.*? (?(?=a) a | b(*THEN)c )
3113 .sp
3114 If the subject is "ba", this pattern does not match. Because .*? is ungreedy,
3115 it initially matches zero characters. The condition (?=a) then fails, the
3116 character "b" is matched, but "c" is not. At this point, matching does not
3117 backtrack to .*? as might perhaps be expected from the presence of the |
3118 character. The conditional subpattern is part of the single alternative that
3119 comprises the whole pattern, and so the match fails. (If there was a backtrack
3120 into .*?, allowing it to match "b", the match would succeed.)
3121 .P
3122 The verbs just described provide four different "strengths" of control when
3123 subsequent matching fails. (*THEN) is the weakest, carrying on the match at the
3124 next alternative. (*PRUNE) comes next, failing the match at the current
3125 starting position, but allowing an advance to the next character (for an
3126 unanchored pattern). (*SKIP) is similar, except that the advance may be more
3127 than one character. (*COMMIT) is the strongest, causing the entire match to
3128 fail.
3129 .
3130 .
3131 .SS "More than one backtracking verb"
3132 .rs
3133 .sp
3134 If more than one backtracking verb is present in a pattern, the one that is
3135 backtracked onto first acts. For example, consider this pattern, where A, B,
3136 etc. are complex pattern fragments:
3137 .sp
3138 (A(*COMMIT)B(*THEN)C|ABD)
3139 .sp
3140 If A matches but B fails, the backtrack to (*COMMIT) causes the entire match to
3141 fail. However, if A and B match, but C fails, the backtrack to (*THEN) causes
3142 the next alternative (ABD) to be tried. This behaviour is consistent, but is
3143 not always the same as Perl's. It means that if two or more backtracking verbs
3144 appear in succession, all the the last of them has no effect. Consider this
3145 example:
3146 .sp
3147 ...(*COMMIT)(*PRUNE)...
3148 .sp
3149 If there is a matching failure to the right, backtracking onto (*PRUNE) causes
3150 it to be triggered, and its action is taken. There can never be a backtrack
3151 onto (*COMMIT).
3152 .
3153 .
3154 .\" HTML <a name="btrepeat"></a>
3155 .SS "Backtracking verbs in repeated groups"
3156 .rs
3157 .sp
3158 PCRE differs from Perl in its handling of backtracking verbs in repeated
3159 groups. For example, consider:
3160 .sp
3161 /(a(*COMMIT)b)+ac/
3162 .sp
3163 If the subject is "abac", Perl matches, but PCRE fails because the (*COMMIT) in
3164 the second repeat of the group acts.
3165 .
3166 .
3167 .\" HTML <a name="btassert"></a>
3168 .SS "Backtracking verbs in assertions"
3169 .rs
3170 .sp
3171 (*FAIL) in an assertion has its normal effect: it forces an immediate backtrack.
3172 .P
3173 (*ACCEPT) in a positive assertion causes the assertion to succeed without any
3174 further processing. In a negative assertion, (*ACCEPT) causes the assertion to
3175 fail without any further processing.
3176 .P
3177 The other backtracking verbs are not treated specially if they appear in a
3178 positive assertion. In particular, (*THEN) skips to the next alternative in the
3179 innermost enclosing group that has alternations, whether or not this is within
3180 the assertion.
3181 .P
3182 Negative assertions are, however, different, in order to ensure that changing a
3183 positive assertion into a negative assertion changes its result. Backtracking
3184 into (*COMMIT), (*SKIP), or (*PRUNE) causes a negative assertion to be true,
3185 without considering any further alternative branches in the assertion.
3186 Backtracking into (*THEN) causes it to skip to the next enclosing alternative
3187 within the assertion (the normal behaviour), but if the assertion does not have
3188 such an alternative, (*THEN) behaves like (*PRUNE).
3189 .
3190 .
3191 .\" HTML <a name="btsub"></a>
3192 .SS "Backtracking verbs in subroutines"
3193 .rs
3194 .sp
3195 These behaviours occur whether or not the subpattern is called recursively.
3196 Perl's treatment of subroutines is different in some cases.
3197 .P
3198 (*FAIL) in a subpattern called as a subroutine has its normal effect: it forces
3199 an immediate backtrack.
3200 .P
3201 (*ACCEPT) in a subpattern called as a subroutine causes the subroutine match to
3202 succeed without any further processing. Matching then continues after the
3203 subroutine call.
3204 .P
3205 (*COMMIT), (*SKIP), and (*PRUNE) in a subpattern called as a subroutine cause
3206 the subroutine match to fail.
3207 .P
3208 (*THEN) skips to the next alternative in the innermost enclosing group within
3209 the subpattern that has alternatives. If there is no such group within the
3210 subpattern, (*THEN) causes the subroutine match to fail.
3211 .
3212 .
3213 .SH "SEE ALSO"
3214 .rs
3215 .sp
3216 \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3),
3217 \fBpcresyntax\fP(3), \fBpcre\fP(3), \fBpcre16(3)\fP, \fBpcre32(3)\fP.
3218 .
3219 .
3220 .SH AUTHOR
3221 .rs
3222 .sp
3223 .nf
3224 Philip Hazel
3225 University Computing Service
3226 Cambridge CB2 3QH, England.
3227 .fi
3228 .
3229 .
3230 .SH REVISION
3231 .rs
3232 .sp
3233 .nf
3234 Last updated: 25 November 2013
3235 Copyright (c) 1997-2013 University of Cambridge.
3236 .fi

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5