This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlre: fix typo
[perl5.git] / pod / perlre.pod
1 =head1 NAME
2 X<regular expression> X<regex> X<regexp>
3
4 perlre - Perl regular expressions
5
6 =head1 DESCRIPTION
7
8 This page describes the syntax of regular expressions in Perl.
9
10 If you haven't used regular expressions before, a quick-start
11 introduction is available in L<perlrequick>, and a longer tutorial
12 introduction is available in L<perlretut>.
13
14 For reference on how regular expressions are used in matching
15 operations, plus various examples of the same, see discussions of
16 C<m//>, C<s///>, C<qr//> and C<??> in L<perlop/"Regexp Quote-Like
17 Operators">.
18
19
20 =head2 Modifiers
21
22 Matching operations can have various modifiers.  Modifiers
23 that relate to the interpretation of the regular expression inside
24 are listed below.  Modifiers that alter the way a regular expression
25 is used by Perl are detailed in L<perlop/"Regexp Quote-Like Operators"> and
26 L<perlop/"Gory details of parsing quoted constructs">.
27
28 =over 4
29
30 =item m
31 X</m> X<regex, multiline> X<regexp, multiline> X<regular expression, multiline>
32
33 Treat string as multiple lines.  That is, change "^" and "$" from matching
34 the start or end of line only at the left and right ends of the string to
35 matching them anywhere within the string.
36
37 =item s
38 X</s> X<regex, single-line> X<regexp, single-line>
39 X<regular expression, single-line>
40
41 Treat string as single line.  That is, change "." to match any character
42 whatsoever, even a newline, which normally it would not match.
43
44 Used together, as C</ms>, they let the "." match any character whatsoever,
45 while still allowing "^" and "$" to match, respectively, just after
46 and just before newlines within the string.
47
48 =item i
49 X</i> X<regex, case-insensitive> X<regexp, case-insensitive>
50 X<regular expression, case-insensitive>
51
52 Do case-insensitive pattern matching.
53
54 If locale matching rules are in effect, the case map is taken from the
55 current
56 locale for code points less than 255, and from Unicode rules for larger
57 code points.  However, matches that would cross the Unicode
58 rules/non-Unicode rules boundary (ords 255/256) will not succeed.  See
59 L<perllocale>.
60
61 There are a number of Unicode characters that match multiple characters
62 under C</i>.  For example, C<LATIN SMALL LIGATURE FI>
63 should match the sequence C<fi>.  Perl is not
64 currently able to do this when the multiple characters are in the pattern and
65 are split between groupings, or when one or more are quantified.  Thus
66
67  "\N{LATIN SMALL LIGATURE FI}" =~ /fi/i;          # Matches
68  "\N{LATIN SMALL LIGATURE FI}" =~ /[fi][fi]/i;    # Doesn't match!
69  "\N{LATIN SMALL LIGATURE FI}" =~ /fi*/i;         # Doesn't match!
70
71  # The below doesn't match, and it isn't clear what $1 and $2 would
72  # be even if it did!!
73  "\N{LATIN SMALL LIGATURE FI}" =~ /(f)(i)/i;      # Doesn't match!
74
75 Perl doesn't match multiple characters in a bracketed
76 character class unless the character that maps to them is explicitly
77 mentioned, and it doesn't match them at all if the character class is
78 inverted, which otherwise could be highly confusing.  See
79 L<perlrecharclass/Bracketed Character Classes>, and
80 L<perlrecharclass/Negation>.
81
82 =item x
83 X</x>
84
85 Extend your pattern's legibility by permitting whitespace and comments.
86 Details in L</"/x">
87
88 =item p
89 X</p> X<regex, preserve> X<regexp, preserve>
90
91 Preserve the string matched such that ${^PREMATCH}, ${^MATCH}, and
92 ${^POSTMATCH} are available for use after matching.
93
94 In Perl 5.18 and higher this is ignored.  ${^PREMATCH}, ${^MATCH}, and
95 ${^POSTMATCH} will be available after the match regardless of the modifier.
96
97 =item g and c
98 X</g> X</c>
99
100 Global matching, and keep the Current position after failed matching.
101 Unlike i, m, s and x, these two flags affect the way the regex is used
102 rather than the regex itself. See
103 L<perlretut/"Using regular expressions in Perl"> for further explanation
104 of the g and c modifiers.
105
106 =item a, d, l and u
107 X</a> X</d> X</l> X</u>
108
109 These modifiers, all new in 5.14, affect which character-set semantics
110 (Unicode, etc.) are used, as described below in
111 L</Character set modifiers>.
112
113 =back
114
115 Regular expression modifiers are usually written in documentation
116 as e.g., "the C</x> modifier", even though the delimiter
117 in question might not really be a slash.  The modifiers C</imsxadlup>
118 may also be embedded within the regular expression itself using
119 the C<(?...)> construct, see L</Extended Patterns> below.
120
121 =head3 /x
122
123 C</x> tells
124 the regular expression parser to ignore most whitespace that is neither
125 backslashed nor within a character class.  You can use this to break up
126 your regular expression into (slightly) more readable parts.  The C<#>
127 character is also treated as a metacharacter introducing a comment,
128 just as in ordinary Perl code.  This also means that if you want real
129 whitespace or C<#> characters in the pattern (outside a character
130 class, where they are unaffected by C</x>), then you'll either have to
131 escape them (using backslashes or C<\Q...\E>) or encode them using octal,
132 hex, or C<\N{}> escapes.  Taken together, these features go a long way towards
133 making Perl's regular expressions more readable.  Note that you have to
134 be careful not to include the pattern delimiter in the comment--perl has
135 no way of knowing you did not intend to close the pattern early.  See
136 the C-comment deletion code in L<perlop>.  Also note that anything inside
137 a C<\Q...\E> stays unaffected by C</x>.  And note that C</x> doesn't affect
138 space interpretation within a single multi-character construct.  For
139 example in C<\x{...}>, regardless of the C</x> modifier, there can be no
140 spaces.  Same for a L<quantifier|/Quantifiers> such as C<{3}> or
141 C<{5,}>.  Similarly, C<(?:...)> can't have a space between the C<?> and C<:>,
142 but can between the C<(> and C<?>.  Within any delimiters for such a
143 construct, allowed spaces are not affected by C</x>, and depend on the
144 construct.  For example, C<\x{...}> can't have spaces because hexadecimal
145 numbers don't have spaces in them.  But, Unicode properties can have spaces, so
146 in C<\p{...}> there can be spaces that follow the Unicode rules, for which see
147 L<perluniprops/Properties accessible through \p{} and \P{}>.
148 X</x>
149
150 =head3 Character set modifiers
151
152 C</d>, C</u>, C</a>, and C</l>, available starting in 5.14, are called
153 the character set modifiers; they affect the character set semantics
154 used for the regular expression.
155
156 The C</d>, C</u>, and C</l> modifiers are not likely to be of much use
157 to you, and so you need not worry about them very much.  They exist for
158 Perl's internal use, so that complex regular expression data structures
159 can be automatically serialized and later exactly reconstituted,
160 including all their nuances.  But, since Perl can't keep a secret, and
161 there may be rare instances where they are useful, they are documented
162 here.
163
164 The C</a> modifier, on the other hand, may be useful.  Its purpose is to
165 allow code that is to work mostly on ASCII data to not have to concern
166 itself with Unicode.
167
168 Briefly, C</l> sets the character set to that of whatever B<L>ocale is in
169 effect at the time of the execution of the pattern match.
170
171 C</u> sets the character set to B<U>nicode.
172
173 C</a> also sets the character set to Unicode, BUT adds several
174 restrictions for B<A>SCII-safe matching.
175
176 C</d> is the old, problematic, pre-5.14 B<D>efault character set
177 behavior.  Its only use is to force that old behavior.
178
179 At any given time, exactly one of these modifiers is in effect.  Their
180 existence allows Perl to keep the originally compiled behavior of a
181 regular expression, regardless of what rules are in effect when it is
182 actually executed.  And if it is interpolated into a larger regex, the
183 original's rules continue to apply to it, and only it.
184
185 The C</l> and C</u> modifiers are automatically selected for
186 regular expressions compiled within the scope of various pragmas,
187 and we recommend that in general, you use those pragmas instead of
188 specifying these modifiers explicitly.  For one thing, the modifiers
189 affect only pattern matching, and do not extend to even any replacement
190 done, whereas using the pragmas give consistent results for all
191 appropriate operations within their scopes.  For example,
192
193  s/foo/\Ubar/il
194
195 will match "foo" using the locale's rules for case-insensitive matching,
196 but the C</l> does not affect how the C<\U> operates.  Most likely you
197 want both of them to use locale rules.  To do this, instead compile the
198 regular expression within the scope of C<use locale>.  This both
199 implicitly adds the C</l> and applies locale rules to the C<\U>.   The
200 lesson is to C<use locale> and not C</l> explicitly.
201
202 Similarly, it would be better to use C<use feature 'unicode_strings'>
203 instead of,
204
205  s/foo/\Lbar/iu
206
207 to get Unicode rules, as the C<\L> in the former (but not necessarily
208 the latter) would also use Unicode rules.
209
210 More detail on each of the modifiers follows.  Most likely you don't
211 need to know this detail for C</l>, C</u>, and C</d>, and can skip ahead
212 to L<E<sol>a|/E<sol>a (and E<sol>aa)>.
213
214 =head4 /l
215
216 means to use the current locale's rules (see L<perllocale>) when pattern
217 matching.  For example, C<\w> will match the "word" characters of that
218 locale, and C<"/i"> case-insensitive matching will match according to
219 the locale's case folding rules.  The locale used will be the one in
220 effect at the time of execution of the pattern match.  This may not be
221 the same as the compilation-time locale, and can differ from one match
222 to another if there is an intervening call of the
223 L<setlocale() function|perllocale/The setlocale function>.
224
225 Perl only supports single-byte locales.  This means that code points
226 above 255 are treated as Unicode no matter what locale is in effect.
227 Under Unicode rules, there are a few case-insensitive matches that cross
228 the 255/256 boundary.  These are disallowed under C</l>.  For example,
229 0xFF (on ASCII platforms) does not caselessly match the character at
230 0x178, C<LATIN CAPITAL LETTER Y WITH DIAERESIS>, because 0xFF may not be
231 C<LATIN SMALL LETTER Y WITH DIAERESIS> in the current locale, and Perl
232 has no way of knowing if that character even exists in the locale, much
233 less what code point it is.
234
235 This modifier may be specified to be the default by C<use locale>, but
236 see L</Which character set modifier is in effect?>.
237 X</l>
238
239 =head4 /u
240
241 means to use Unicode rules when pattern matching.  On ASCII platforms,
242 this means that the code points between 128 and 255 take on their
243 Latin-1 (ISO-8859-1) meanings (which are the same as Unicode's).
244 (Otherwise Perl considers their meanings to be undefined.)  Thus,
245 under this modifier, the ASCII platform effectively becomes a Unicode
246 platform; and hence, for example, C<\w> will match any of the more than
247 100_000 word characters in Unicode.
248
249 Unlike most locales, which are specific to a language and country pair,
250 Unicode classifies all the characters that are letters I<somewhere> in
251 the world as
252 C<\w>.  For example, your locale might not think that C<LATIN SMALL
253 LETTER ETH> is a letter (unless you happen to speak Icelandic), but
254 Unicode does.  Similarly, all the characters that are decimal digits
255 somewhere in the world will match C<\d>; this is hundreds, not 10,
256 possible matches.  And some of those digits look like some of the 10
257 ASCII digits, but mean a different number, so a human could easily think
258 a number is a different quantity than it really is.  For example,
259 C<BENGALI DIGIT FOUR> (U+09EA) looks very much like an
260 C<ASCII DIGIT EIGHT> (U+0038).  And, C<\d+>, may match strings of digits
261 that are a mixture from different writing systems, creating a security
262 issue.  L<Unicode::UCD/num()> can be used to sort
263 this out.  Or the C</a> modifier can be used to force C<\d> to match
264 just the ASCII 0 through 9.
265
266 Also, under this modifier, case-insensitive matching works on the full
267 set of Unicode
268 characters.  The C<KELVIN SIGN>, for example matches the letters "k" and
269 "K"; and C<LATIN SMALL LIGATURE FF> matches the sequence "ff", which,
270 if you're not prepared, might make it look like a hexadecimal constant,
271 presenting another potential security issue.  See
272 L<http://unicode.org/reports/tr36> for a detailed discussion of Unicode
273 security issues.
274
275 On the EBCDIC platforms that Perl handles, the native character set is
276 equivalent to Latin-1.  Thus this modifier changes behavior only when
277 the C<"/i"> modifier is also specified, and it turns out it affects only
278 two characters, giving them full Unicode semantics: the C<MICRO SIGN>
279 will match the Greek capital and small letters C<MU>, otherwise not; and
280 the C<LATIN CAPITAL LETTER SHARP S> will match any of C<SS>, C<Ss>,
281 C<sS>, and C<ss>, otherwise not.
282
283 This modifier may be specified to be the default by C<use feature
284 'unicode_strings>, C<use locale ':not_characters'>, or
285 C<L<use 5.012|perlfunc/use VERSION>> (or higher),
286 but see L</Which character set modifier is in effect?>.
287 X</u>
288
289 =head4 /d
290
291 This modifier means to use the "Default" native rules of the platform
292 except when there is cause to use Unicode rules instead, as follows:
293
294 =over 4
295
296 =item 1
297
298 the target string is encoded in UTF-8; or
299
300 =item 2
301
302 the pattern is encoded in UTF-8; or
303
304 =item 3
305
306 the pattern explicitly mentions a code point that is above 255 (say by
307 C<\x{100}>); or
308
309 =item 4
310
311 the pattern uses a Unicode name (C<\N{...}>);  or
312
313 =item 5
314
315 the pattern uses a Unicode property (C<\p{...}>); or
316
317 =item 6
318
319 the pattern uses L</C<(?[ ])>>
320
321 =back
322
323 Another mnemonic for this modifier is "Depends", as the rules actually
324 used depend on various things, and as a result you can get unexpected
325 results.  See L<perlunicode/The "Unicode Bug">.  The Unicode Bug has
326 become rather infamous, leading to yet another (printable) name for this
327 modifier, "Dodgy".
328
329 On ASCII platforms, the native rules are ASCII, and on EBCDIC platforms
330 (at least the ones that Perl handles), they are Latin-1.
331
332 Here are some examples of how that works on an ASCII platform:
333
334  $str =  "\xDF";      # $str is not in UTF-8 format.
335  $str =~ /^\w/;       # No match, as $str isn't in UTF-8 format.
336  $str .= "\x{0e0b}";  # Now $str is in UTF-8 format.
337  $str =~ /^\w/;       # Match! $str is now in UTF-8 format.
338  chop $str;
339  $str =~ /^\w/;       # Still a match! $str remains in UTF-8 format.
340
341 This modifier is automatically selected by default when none of the
342 others are, so yet another name for it is "Default".
343
344 Because of the unexpected behaviors associated with this modifier, you
345 probably should only use it to maintain weird backward compatibilities.
346
347 =head4 /a (and /aa)
348
349 This modifier stands for ASCII-restrict (or ASCII-safe).  This modifier,
350 unlike the others, may be doubled-up to increase its effect.
351
352 When it appears singly, it causes the sequences C<\d>, C<\s>, C<\w>, and
353 the Posix character classes to match only in the ASCII range.  They thus
354 revert to their pre-5.6, pre-Unicode meanings.  Under C</a>,  C<\d>
355 always means precisely the digits C<"0"> to C<"9">; C<\s> means the five
356 characters C<[ \f\n\r\t]>; C<\w> means the 63 characters
357 C<[A-Za-z0-9_]>; and likewise, all the Posix classes such as
358 C<[[:print:]]> match only the appropriate ASCII-range characters.
359
360 This modifier is useful for people who only incidentally use Unicode,
361 and who do not wish to be burdened with its complexities and security
362 concerns.
363
364 With C</a>, one can write C<\d> with confidence that it will only match
365 ASCII characters, and should the need arise to match beyond ASCII, you
366 can instead use C<\p{Digit}> (or C<\p{Word}> for C<\w>).  There are
367 similar C<\p{...}> constructs that can match beyond ASCII both white
368 space (see L<perlrecharclass/Whitespace>), and Posix classes (see
369 L<perlrecharclass/POSIX Character Classes>).  Thus, this modifier
370 doesn't mean you can't use Unicode, it means that to get Unicode
371 matching you must explicitly use a construct (C<\p{}>, C<\P{}>) that
372 signals Unicode.
373
374 As you would expect, this modifier causes, for example, C<\D> to mean
375 the same thing as C<[^0-9]>; in fact, all non-ASCII characters match
376 C<\D>, C<\S>, and C<\W>.  C<\b> still means to match at the boundary
377 between C<\w> and C<\W>, using the C</a> definitions of them (similarly
378 for C<\B>).
379
380 Otherwise, C</a> behaves like the C</u> modifier, in that
381 case-insensitive matching uses Unicode semantics; for example, "k" will
382 match the Unicode C<\N{KELVIN SIGN}> under C</i> matching, and code
383 points in the Latin1 range, above ASCII will have Unicode rules when it
384 comes to case-insensitive matching.
385
386 To forbid ASCII/non-ASCII matches (like "k" with C<\N{KELVIN SIGN}>),
387 specify the "a" twice, for example C</aai> or C</aia>.  (The first
388 occurrence of "a" restricts the C<\d>, etc., and the second occurrence
389 adds the C</i> restrictions.)  But, note that code points outside the
390 ASCII range will use Unicode rules for C</i> matching, so the modifier
391 doesn't really restrict things to just ASCII; it just forbids the
392 intermixing of ASCII and non-ASCII.
393
394 To summarize, this modifier provides protection for applications that
395 don't wish to be exposed to all of Unicode.  Specifying it twice
396 gives added protection.
397
398 This modifier may be specified to be the default by C<use re '/a'>
399 or C<use re '/aa'>.  If you do so, you may actually have occasion to use
400 the C</u> modifier explictly if there are a few regular expressions
401 where you do want full Unicode rules (but even here, it's best if
402 everything were under feature C<"unicode_strings">, along with the
403 C<use re '/aa'>).  Also see L</Which character set modifier is in
404 effect?>.
405 X</a>
406 X</aa>
407
408 =head4 Which character set modifier is in effect?
409
410 Which of these modifiers is in effect at any given point in a regular
411 expression depends on a fairly complex set of interactions.  These have
412 been designed so that in general you don't have to worry about it, but
413 this section gives the gory details.  As
414 explained below in L</Extended Patterns> it is possible to explicitly
415 specify modifiers that apply only to portions of a regular expression.
416 The innermost always has priority over any outer ones, and one applying
417 to the whole expression has priority over any of the default settings that are
418 described in the remainder of this section.
419
420 The C<L<use re 'E<sol>foo'|re/"'/flags' mode">> pragma can be used to set
421 default modifiers (including these) for regular expressions compiled
422 within its scope.  This pragma has precedence over the other pragmas
423 listed below that also change the defaults.
424
425 Otherwise, C<L<use locale|perllocale>> sets the default modifier to C</l>;
426 and C<L<use feature 'unicode_strings|feature>>, or
427 C<L<use 5.012|perlfunc/use VERSION>> (or higher) set the default to
428 C</u> when not in the same scope as either C<L<use locale|perllocale>>
429 or C<L<use bytes|bytes>>.
430 (C<L<use locale ':not_characters'|perllocale/Unicode and UTF-8>> also
431 sets the default to C</u>, overriding any plain C<use locale>.)
432 Unlike the mechanisms mentioned above, these
433 affect operations besides regular expressions pattern matching, and so
434 give more consistent results with other operators, including using
435 C<\U>, C<\l>, etc. in substitution replacements.
436
437 If none of the above apply, for backwards compatibility reasons, the
438 C</d> modifier is the one in effect by default.  As this can lead to
439 unexpected results, it is best to specify which other rule set should be
440 used.
441
442 =head4 Character set modifier behavior prior to Perl 5.14
443
444 Prior to 5.14, there were no explicit modifiers, but C</l> was implied
445 for regexes compiled within the scope of C<use locale>, and C</d> was
446 implied otherwise.  However, interpolating a regex into a larger regex
447 would ignore the original compilation in favor of whatever was in effect
448 at the time of the second compilation.  There were a number of
449 inconsistencies (bugs) with the C</d> modifier, where Unicode rules
450 would be used when inappropriate, and vice versa.  C<\p{}> did not imply
451 Unicode rules, and neither did all occurrences of C<\N{}>, until 5.12.
452
453 =head2 Regular Expressions
454
455 =head3 Metacharacters
456
457 The patterns used in Perl pattern matching evolved from those supplied in
458 the Version 8 regex routines.  (The routines are derived
459 (distantly) from Henry Spencer's freely redistributable reimplementation
460 of the V8 routines.)  See L<Version 8 Regular Expressions> for
461 details.
462
463 In particular the following metacharacters have their standard I<egrep>-ish
464 meanings:
465 X<metacharacter>
466 X<\> X<^> X<.> X<$> X<|> X<(> X<()> X<[> X<[]>
467
468
469     \        Quote the next metacharacter
470     ^        Match the beginning of the line
471     .        Match any character (except newline)
472     $        Match the end of the line (or before newline at the end)
473     |        Alternation
474     ()       Grouping
475     []       Bracketed Character class
476
477 By default, the "^" character is guaranteed to match only the
478 beginning of the string, the "$" character only the end (or before the
479 newline at the end), and Perl does certain optimizations with the
480 assumption that the string contains only one line.  Embedded newlines
481 will not be matched by "^" or "$".  You may, however, wish to treat a
482 string as a multi-line buffer, such that the "^" will match after any
483 newline within the string (except if the newline is the last character in
484 the string), and "$" will match before any newline.  At the
485 cost of a little more overhead, you can do this by using the /m modifier
486 on the pattern match operator.  (Older programs did this by setting C<$*>,
487 but this option was removed in perl 5.10.)
488 X<^> X<$> X</m>
489
490 To simplify multi-line substitutions, the "." character never matches a
491 newline unless you use the C</s> modifier, which in effect tells Perl to pretend
492 the string is a single line--even if it isn't.
493 X<.> X</s>
494
495 =head3 Quantifiers
496
497 The following standard quantifiers are recognized:
498 X<metacharacter> X<quantifier> X<*> X<+> X<?> X<{n}> X<{n,}> X<{n,m}>
499
500     *           Match 0 or more times
501     +           Match 1 or more times
502     ?           Match 1 or 0 times
503     {n}         Match exactly n times
504     {n,}        Match at least n times
505     {n,m}       Match at least n but not more than m times
506
507 (If a curly bracket occurs in any other context and does not form part of
508 a backslashed sequence like C<\x{...}>, it is treated
509 as a regular character.  In particular, the lower quantifier bound
510 is not optional.  However, in Perl v5.18, it is planned to issue a
511 deprecation warning for all such occurrences, and in Perl v5.20 to
512 require literal uses of a curly bracket to be escaped, say by preceding
513 them with a backslash or enclosing them within square brackets, (C<"\{">
514 or C<"[{]">).  This change will allow for future syntax extensions (like
515 making the lower bound of a quantifier optional), and better error
516 checking of quantifiers.  Now, a typo in a quantifier silently causes
517 it to be treated as the literal characters.  For example,
518
519     /o{4,3}/
520
521 looks like a quantifier that matches 0 times, since 4 is greater than 3,
522 but it really means to match the sequence of six characters
523 S<C<"o { 4 , 3 }">>.)
524
525 The "*" quantifier is equivalent to C<{0,}>, the "+"
526 quantifier to C<{1,}>, and the "?" quantifier to C<{0,1}>.  n and m are limited
527 to non-negative integral values less than a preset limit defined when perl is built.
528 This is usually 32766 on the most common platforms.  The actual limit can
529 be seen in the error message generated by code such as this:
530
531     $_ **= $_ , / {$_} / for 2 .. 42;
532
533 By default, a quantified subpattern is "greedy", that is, it will match as
534 many times as possible (given a particular starting location) while still
535 allowing the rest of the pattern to match.  If you want it to match the
536 minimum number of times possible, follow the quantifier with a "?".  Note
537 that the meanings don't change, just the "greediness":
538 X<metacharacter> X<greedy> X<greediness>
539 X<?> X<*?> X<+?> X<??> X<{n}?> X<{n,}?> X<{n,m}?>
540
541     *?        Match 0 or more times, not greedily
542     +?        Match 1 or more times, not greedily
543     ??        Match 0 or 1 time, not greedily
544     {n}?      Match exactly n times, not greedily (redundant)
545     {n,}?     Match at least n times, not greedily
546     {n,m}?    Match at least n but not more than m times, not greedily
547
548 By default, when a quantified subpattern does not allow the rest of the
549 overall pattern to match, Perl will backtrack. However, this behaviour is
550 sometimes undesirable. Thus Perl provides the "possessive" quantifier form
551 as well.
552
553  *+     Match 0 or more times and give nothing back
554  ++     Match 1 or more times and give nothing back
555  ?+     Match 0 or 1 time and give nothing back
556  {n}+   Match exactly n times and give nothing back (redundant)
557  {n,}+  Match at least n times and give nothing back
558  {n,m}+ Match at least n but not more than m times and give nothing back
559
560 For instance,
561
562    'aaaa' =~ /a++a/
563
564 will never match, as the C<a++> will gobble up all the C<a>'s in the
565 string and won't leave any for the remaining part of the pattern. This
566 feature can be extremely useful to give perl hints about where it
567 shouldn't backtrack. For instance, the typical "match a double-quoted
568 string" problem can be most efficiently performed when written as:
569
570    /"(?:[^"\\]++|\\.)*+"/
571
572 as we know that if the final quote does not match, backtracking will not
573 help. See the independent subexpression
574 L</C<< (?>pattern) >>> for more details;
575 possessive quantifiers are just syntactic sugar for that construct. For
576 instance the above example could also be written as follows:
577
578    /"(?>(?:(?>[^"\\]+)|\\.)*)"/
579
580 =head3 Escape sequences
581
582 Because patterns are processed as double-quoted strings, the following
583 also work:
584
585  \t          tab                   (HT, TAB)
586  \n          newline               (LF, NL)
587  \r          return                (CR)
588  \f          form feed             (FF)
589  \a          alarm (bell)          (BEL)
590  \e          escape (think troff)  (ESC)
591  \cK         control char          (example: VT)
592  \x{}, \x00  character whose ordinal is the given hexadecimal number
593  \N{name}    named Unicode character or character sequence
594  \N{U+263D}  Unicode character     (example: FIRST QUARTER MOON)
595  \o{}, \000  character whose ordinal is the given octal number
596  \l          lowercase next char (think vi)
597  \u          uppercase next char (think vi)
598  \L          lowercase till \E (think vi)
599  \U          uppercase till \E (think vi)
600  \Q          quote (disable) pattern metacharacters till \E
601  \E          end either case modification or quoted section, think vi
602
603 Details are in L<perlop/Quote and Quote-like Operators>.
604
605 =head3 Character Classes and other Special Escapes
606
607 In addition, Perl defines the following:
608 X<\g> X<\k> X<\K> X<backreference>
609
610  Sequence   Note    Description
611   [...]     [1]  Match a character according to the rules of the
612                    bracketed character class defined by the "...".
613                    Example: [a-z] matches "a" or "b" or "c" ... or "z"
614   [[:...:]] [2]  Match a character according to the rules of the POSIX
615                    character class "..." within the outer bracketed
616                    character class.  Example: [[:upper:]] matches any
617                    uppercase character.
618   \w        [3]  Match a "word" character (alphanumeric plus "_", plus
619                    other connector punctuation chars plus Unicode
620                    marks)
621   \W        [3]  Match a non-"word" character
622   \s        [3]  Match a whitespace character
623   \S        [3]  Match a non-whitespace character
624   \d        [3]  Match a decimal digit character
625   \D        [3]  Match a non-digit character
626   \pP       [3]  Match P, named property.  Use \p{Prop} for longer names
627   \PP       [3]  Match non-P
628   \X        [4]  Match Unicode "eXtended grapheme cluster"
629   \C             Match a single C-language char (octet) even if that is
630                    part of a larger UTF-8 character.  Thus it breaks up
631                    characters into their UTF-8 bytes, so you may end up
632                    with malformed pieces of UTF-8.  Unsupported in
633                    lookbehind.
634   \1        [5]  Backreference to a specific capture group or buffer.
635                    '1' may actually be any positive integer.
636   \g1       [5]  Backreference to a specific or previous group,
637   \g{-1}    [5]  The number may be negative indicating a relative
638                    previous group and may optionally be wrapped in
639                    curly brackets for safer parsing.
640   \g{name}  [5]  Named backreference
641   \k<name>  [5]  Named backreference
642   \K        [6]  Keep the stuff left of the \K, don't include it in $&
643   \N        [7]  Any character but \n (experimental).  Not affected by
644                    /s modifier
645   \v        [3]  Vertical whitespace
646   \V        [3]  Not vertical whitespace
647   \h        [3]  Horizontal whitespace
648   \H        [3]  Not horizontal whitespace
649   \R        [4]  Linebreak
650
651 =over 4
652
653 =item [1]
654
655 See L<perlrecharclass/Bracketed Character Classes> for details.
656
657 =item [2]
658
659 See L<perlrecharclass/POSIX Character Classes> for details.
660
661 =item [3]
662
663 See L<perlrecharclass/Backslash sequences> for details.
664
665 =item [4]
666
667 See L<perlrebackslash/Misc> for details.
668
669 =item [5]
670
671 See L</Capture groups> below for details.
672
673 =item [6]
674
675 See L</Extended Patterns> below for details.
676
677 =item [7]
678
679 Note that C<\N> has two meanings.  When of the form C<\N{NAME}>, it matches the
680 character or character sequence whose name is C<NAME>; and similarly
681 when of the form C<\N{U+I<hex>}>, it matches the character whose Unicode
682 code point is I<hex>.  Otherwise it matches any character but C<\n>.
683
684 =back
685
686 =head3 Assertions
687
688 Perl defines the following zero-width assertions:
689 X<zero-width assertion> X<assertion> X<regex, zero-width assertion>
690 X<regexp, zero-width assertion>
691 X<regular expression, zero-width assertion>
692 X<\b> X<\B> X<\A> X<\Z> X<\z> X<\G>
693
694     \b  Match a word boundary
695     \B  Match except at a word boundary
696     \A  Match only at beginning of string
697     \Z  Match only at end of string, or before newline at the end
698     \z  Match only at end of string
699     \G  Match only at pos() (e.g. at the end-of-match position
700         of prior m//g)
701
702 A word boundary (C<\b>) is a spot between two characters
703 that has a C<\w> on one side of it and a C<\W> on the other side
704 of it (in either order), counting the imaginary characters off the
705 beginning and end of the string as matching a C<\W>.  (Within
706 character classes C<\b> represents backspace rather than a word
707 boundary, just as it normally does in any double-quoted string.)
708 The C<\A> and C<\Z> are just like "^" and "$", except that they
709 won't match multiple times when the C</m> modifier is used, while
710 "^" and "$" will match at every internal line boundary.  To match
711 the actual end of the string and not ignore an optional trailing
712 newline, use C<\z>.
713 X<\b> X<\A> X<\Z> X<\z> X</m>
714
715 The C<\G> assertion can be used to chain global matches (using
716 C<m//g>), as described in L<perlop/"Regexp Quote-Like Operators">.
717 It is also useful when writing C<lex>-like scanners, when you have
718 several patterns that you want to match against consequent substrings
719 of your string; see the previous reference.  The actual location
720 where C<\G> will match can also be influenced by using C<pos()> as
721 an lvalue: see L<perlfunc/pos>. Note that the rule for zero-length
722 matches (see L</"Repeated Patterns Matching a Zero-length Substring">)
723 is modified somewhat, in that contents to the left of C<\G> are
724 not counted when determining the length of the match. Thus the following
725 will not match forever:
726 X<\G>
727
728      my $string = 'ABC';
729      pos($string) = 1;
730      while ($string =~ /(.\G)/g) {
731          print $1;
732      }
733
734 It will print 'A' and then terminate, as it considers the match to
735 be zero-width, and thus will not match at the same position twice in a
736 row.
737
738 It is worth noting that C<\G> improperly used can result in an infinite
739 loop. Take care when using patterns that include C<\G> in an alternation.
740
741 =head3 Capture groups
742
743 The bracketing construct C<( ... )> creates capture groups (also referred to as
744 capture buffers). To refer to the current contents of a group later on, within
745 the same pattern, use C<\g1> (or C<\g{1}>) for the first, C<\g2> (or C<\g{2}>)
746 for the second, and so on.
747 This is called a I<backreference>.
748 X<regex, capture buffer> X<regexp, capture buffer>
749 X<regex, capture group> X<regexp, capture group>
750 X<regular expression, capture buffer> X<backreference>
751 X<regular expression, capture group> X<backreference>
752 X<\g{1}> X<\g{-1}> X<\g{name}> X<relative backreference> X<named backreference>
753 X<named capture buffer> X<regular expression, named capture buffer>
754 X<named capture group> X<regular expression, named capture group>
755 X<%+> X<$+{name}> X<< \k<name> >>
756 There is no limit to the number of captured substrings that you may use.
757 Groups are numbered with the leftmost open parenthesis being number 1, etc.  If
758 a group did not match, the associated backreference won't match either. (This
759 can happen if the group is optional, or in a different branch of an
760 alternation.)
761 You can omit the C<"g">, and write C<"\1">, etc, but there are some issues with
762 this form, described below.
763
764 You can also refer to capture groups relatively, by using a negative number, so
765 that C<\g-1> and C<\g{-1}> both refer to the immediately preceding capture
766 group, and C<\g-2> and C<\g{-2}> both refer to the group before it.  For
767 example:
768
769         /
770          (Y)            # group 1
771          (              # group 2
772             (X)         # group 3
773             \g{-1}      # backref to group 3
774             \g{-3}      # backref to group 1
775          )
776         /x
777
778 would match the same as C</(Y) ( (X) \g3 \g1 )/x>.  This allows you to
779 interpolate regexes into larger regexes and not have to worry about the
780 capture groups being renumbered.
781
782 You can dispense with numbers altogether and create named capture groups.
783 The notation is C<(?E<lt>I<name>E<gt>...)> to declare and C<\g{I<name>}> to
784 reference.  (To be compatible with .Net regular expressions, C<\g{I<name>}> may
785 also be written as C<\k{I<name>}>, C<\kE<lt>I<name>E<gt>> or C<\k'I<name>'>.)
786 I<name> must not begin with a number, nor contain hyphens.
787 When different groups within the same pattern have the same name, any reference
788 to that name assumes the leftmost defined group.  Named groups count in
789 absolute and relative numbering, and so can also be referred to by those
790 numbers.
791 (It's possible to do things with named capture groups that would otherwise
792 require C<(??{})>.)
793
794 Capture group contents are dynamically scoped and available to you outside the
795 pattern until the end of the enclosing block or until the next successful
796 match, whichever comes first.  (See L<perlsyn/"Compound Statements">.)
797 You can refer to them by absolute number (using C<"$1"> instead of C<"\g1">,
798 etc); or by name via the C<%+> hash, using C<"$+{I<name>}">.
799
800 Braces are required in referring to named capture groups, but are optional for
801 absolute or relative numbered ones.  Braces are safer when creating a regex by
802 concatenating smaller strings.  For example if you have C<qr/$a$b/>, and C<$a>
803 contained C<"\g1">, and C<$b> contained C<"37">, you would get C</\g137/> which
804 is probably not what you intended.
805
806 The C<\g> and C<\k> notations were introduced in Perl 5.10.0.  Prior to that
807 there were no named nor relative numbered capture groups.  Absolute numbered
808 groups were referred to using C<\1>,
809 C<\2>, etc., and this notation is still
810 accepted (and likely always will be).  But it leads to some ambiguities if
811 there are more than 9 capture groups, as C<\10> could mean either the tenth
812 capture group, or the character whose ordinal in octal is 010 (a backspace in
813 ASCII).  Perl resolves this ambiguity by interpreting C<\10> as a backreference
814 only if at least 10 left parentheses have opened before it.  Likewise C<\11> is
815 a backreference only if at least 11 left parentheses have opened before it.
816 And so on.  C<\1> through C<\9> are always interpreted as backreferences.
817 There are several examples below that illustrate these perils.  You can avoid
818 the ambiguity by always using C<\g{}> or C<\g> if you mean capturing groups;
819 and for octal constants always using C<\o{}>, or for C<\077> and below, using 3
820 digits padded with leading zeros, since a leading zero implies an octal
821 constant.
822
823 The C<\I<digit>> notation also works in certain circumstances outside
824 the pattern.  See L</Warning on \1 Instead of $1> below for details.
825
826 Examples:
827
828     s/^([^ ]*) *([^ ]*)/$2 $1/;     # swap first two words
829
830     /(.)\g1/                        # find first doubled char
831          and print "'$1' is the first doubled character\n";
832
833     /(?<char>.)\k<char>/            # ... a different way
834          and print "'$+{char}' is the first doubled character\n";
835
836     /(?'char'.)\g1/                 # ... mix and match
837          and print "'$1' is the first doubled character\n";
838
839     if (/Time: (..):(..):(..)/) {   # parse out values
840         $hours = $1;
841         $minutes = $2;
842         $seconds = $3;
843     }
844
845     /(.)(.)(.)(.)(.)(.)(.)(.)(.)\g10/   # \g10 is a backreference
846     /(.)(.)(.)(.)(.)(.)(.)(.)(.)\10/    # \10 is octal
847     /((.)(.)(.)(.)(.)(.)(.)(.)(.))\10/  # \10 is a backreference
848     /((.)(.)(.)(.)(.)(.)(.)(.)(.))\010/ # \010 is octal
849
850     $a = '(.)\1';        # Creates problems when concatenated.
851     $b = '(.)\g{1}';     # Avoids the problems.
852     "aa" =~ /${a}/;      # True
853     "aa" =~ /${b}/;      # True
854     "aa0" =~ /${a}0/;    # False!
855     "aa0" =~ /${b}0/;    # True
856     "aa\x08" =~ /${a}0/;  # True!
857     "aa\x08" =~ /${b}0/;  # False
858
859 Several special variables also refer back to portions of the previous
860 match.  C<$+> returns whatever the last bracket match matched.
861 C<$&> returns the entire matched string.  (At one point C<$0> did
862 also, but now it returns the name of the program.)  C<$`> returns
863 everything before the matched string.  C<$'> returns everything
864 after the matched string. And C<$^N> contains whatever was matched by
865 the most-recently closed group (submatch). C<$^N> can be used in
866 extended patterns (see below), for example to assign a submatch to a
867 variable.
868 X<$+> X<$^N> X<$&> X<$`> X<$'>
869
870 These special variables, like the C<%+> hash and the numbered match variables
871 (C<$1>, C<$2>, C<$3>, etc.) are dynamically scoped
872 until the end of the enclosing block or until the next successful
873 match, whichever comes first.  (See L<perlsyn/"Compound Statements">.)
874 X<$+> X<$^N> X<$&> X<$`> X<$'>
875 X<$1> X<$2> X<$3> X<$4> X<$5> X<$6> X<$7> X<$8> X<$9>
876
877 B<NOTE>: Failed matches in Perl do not reset the match variables,
878 which makes it easier to write code that tests for a series of more
879 specific cases and remembers the best match.
880
881 B<WARNING>: If your code is to run on Perl 5.16 or earlier,
882 beware that once Perl sees that you need one of C<$&>, C<$`>, or
883 C<$'> anywhere in the program, it has to provide them for every
884 pattern match.  This may substantially slow your program.  (In Perl 5.18 a
885 more efficient mechanism is used, eliminating any slowdown.)  Perl
886 uses the same mechanism to produce C<$1>, C<$2>, etc, so you also pay a
887 price for each pattern that contains capturing parentheses.  (To
888 avoid this cost while retaining the grouping behaviour, use the
889 extended regular expression C<(?: ... )> instead.)  But if you never
890 use C<$&>, C<$`> or C<$'>, then patterns I<without> capturing
891 parentheses will not be penalized.  So avoid C<$&>, C<$'>, and C<$`>
892 if you can, but if you can't (and some algorithms really appreciate
893 them), once you've used them once, use them at will, because you've
894 already paid the price. 
895 X<$&> X<$`> X<$'>
896
897 As a workaround for this problem, Perl 5.10.0 introduced C<${^PREMATCH}>,
898 C<${^MATCH}> and C<${^POSTMATCH}>, which are equivalent to C<$`>, C<$&>
899 and C<$'>, B<except> that they are only guaranteed to be defined after a
900 successful match that was executed with the C</p> (preserve) modifier.
901 The use of these variables incurs no global performance penalty, unlike
902 their punctuation char equivalents, however at the trade-off that you
903 have to tell perl when you want to use them.  As of Perl 5.18, these three
904 variables are equivalent to C<$`>, C<$&> and C<$'>, and C</p> is ignored.
905 X</p> X<p modifier>
906
907 =head2 Quoting metacharacters
908
909 Backslashed metacharacters in Perl are alphanumeric, such as C<\b>,
910 C<\w>, C<\n>.  Unlike some other regular expression languages, there
911 are no backslashed symbols that aren't alphanumeric.  So anything
912 that looks like \\, \(, \), \<, \>, \{, or \} is always
913 interpreted as a literal character, not a metacharacter.  This was
914 once used in a common idiom to disable or quote the special meanings
915 of regular expression metacharacters in a string that you want to
916 use for a pattern. Simply quote all non-"word" characters:
917
918     $pattern =~ s/(\W)/\\$1/g;
919
920 (If C<use locale> is set, then this depends on the current locale.)
921 Today it is more common to use the quotemeta() function or the C<\Q>
922 metaquoting escape sequence to disable all metacharacters' special
923 meanings like this:
924
925     /$unquoted\Q$quoted\E$unquoted/
926
927 Beware that if you put literal backslashes (those not inside
928 interpolated variables) between C<\Q> and C<\E>, double-quotish
929 backslash interpolation may lead to confusing results.  If you
930 I<need> to use literal backslashes within C<\Q...\E>,
931 consult L<perlop/"Gory details of parsing quoted constructs">.
932
933 C<quotemeta()> and C<\Q> are fully described in L<perlfunc/quotemeta>.
934
935 =head2 Extended Patterns
936
937 Perl also defines a consistent extension syntax for features not
938 found in standard tools like B<awk> and
939 B<lex>.  The syntax for most of these is a
940 pair of parentheses with a question mark as the first thing within
941 the parentheses.  The character after the question mark indicates
942 the extension.
943
944 The stability of these extensions varies widely.  Some have been
945 part of the core language for many years.  Others are experimental
946 and may change without warning or be completely removed.  Check
947 the documentation on an individual feature to verify its current
948 status.
949
950 A question mark was chosen for this and for the minimal-matching
951 construct because 1) question marks are rare in older regular
952 expressions, and 2) whenever you see one, you should stop and
953 "question" exactly what is going on.  That's psychology....
954
955 =over 4
956
957 =item C<(?#text)>
958 X<(?#)>
959
960 A comment.  The text is ignored.  If the C</x> modifier enables
961 whitespace formatting, a simple C<#> will suffice.  Note that Perl closes
962 the comment as soon as it sees a C<)>, so there is no way to put a literal
963 C<)> in the comment.
964
965 =item C<(?adlupimsx-imsx)>
966
967 =item C<(?^alupimsx)>
968 X<(?)> X<(?^)>
969
970 One or more embedded pattern-match modifiers, to be turned on (or
971 turned off, if preceded by C<->) for the remainder of the pattern or
972 the remainder of the enclosing pattern group (if any).
973
974 This is particularly useful for dynamic patterns, such as those read in from a
975 configuration file, taken from an argument, or specified in a table
976 somewhere.  Consider the case where some patterns want to be
977 case-sensitive and some do not:  The case-insensitive ones merely need to
978 include C<(?i)> at the front of the pattern.  For example:
979
980     $pattern = "foobar";
981     if ( /$pattern/i ) { }
982
983     # more flexible:
984
985     $pattern = "(?i)foobar";
986     if ( /$pattern/ ) { }
987
988 These modifiers are restored at the end of the enclosing group. For example,
989
990     ( (?i) blah ) \s+ \g1
991
992 will match C<blah> in any case, some spaces, and an exact (I<including the case>!)
993 repetition of the previous word, assuming the C</x> modifier, and no C</i>
994 modifier outside this group.
995
996 These modifiers do not carry over into named subpatterns called in the
997 enclosing group. In other words, a pattern such as C<((?i)(?&NAME))> does not
998 change the case-sensitivity of the "NAME" pattern.
999
1000 Any of these modifiers can be set to apply globally to all regular
1001 expressions compiled within the scope of a C<use re>.  See
1002 L<re/"'/flags' mode">.
1003
1004 Starting in Perl 5.14, a C<"^"> (caret or circumflex accent) immediately
1005 after the C<"?"> is a shorthand equivalent to C<d-imsx>.  Flags (except
1006 C<"d">) may follow the caret to override it.
1007 But a minus sign is not legal with it.
1008
1009 Note that the C<a>, C<d>, C<l>, C<p>, and C<u> modifiers are special in
1010 that they can only be enabled, not disabled, and the C<a>, C<d>, C<l>, and
1011 C<u> modifiers are mutually exclusive: specifying one de-specifies the
1012 others, and a maximum of one (or two C<a>'s) may appear in the
1013 construct.  Thus, for
1014 example, C<(?-p)> will warn when compiled under C<use warnings>;
1015 C<(?-d:...)> and C<(?dl:...)> are fatal errors.
1016
1017 Note also that the C<p> modifier is special in that its presence
1018 anywhere in a pattern has a global effect.
1019
1020 =item C<(?:pattern)>
1021 X<(?:)>
1022
1023 =item C<(?adluimsx-imsx:pattern)>
1024
1025 =item C<(?^aluimsx:pattern)>
1026 X<(?^:)>
1027
1028 This is for clustering, not capturing; it groups subexpressions like
1029 "()", but doesn't make backreferences as "()" does.  So
1030
1031     @fields = split(/\b(?:a|b|c)\b/)
1032
1033 is like
1034
1035     @fields = split(/\b(a|b|c)\b/)
1036
1037 but doesn't spit out extra fields.  It's also cheaper not to capture
1038 characters if you don't need to.
1039
1040 Any letters between C<?> and C<:> act as flags modifiers as with
1041 C<(?adluimsx-imsx)>.  For example,
1042
1043     /(?s-i:more.*than).*million/i
1044
1045 is equivalent to the more verbose
1046
1047     /(?:(?s-i)more.*than).*million/i
1048
1049 Starting in Perl 5.14, a C<"^"> (caret or circumflex accent) immediately
1050 after the C<"?"> is a shorthand equivalent to C<d-imsx>.  Any positive
1051 flags (except C<"d">) may follow the caret, so
1052
1053     (?^x:foo)
1054
1055 is equivalent to
1056
1057     (?x-ims:foo)
1058
1059 The caret tells Perl that this cluster doesn't inherit the flags of any
1060 surrounding pattern, but uses the system defaults (C<d-imsx>),
1061 modified by any flags specified.
1062
1063 The caret allows for simpler stringification of compiled regular
1064 expressions.  These look like
1065
1066     (?^:pattern)
1067
1068 with any non-default flags appearing between the caret and the colon.
1069 A test that looks at such stringification thus doesn't need to have the
1070 system default flags hard-coded in it, just the caret.  If new flags are
1071 added to Perl, the meaning of the caret's expansion will change to include
1072 the default for those flags, so the test will still work, unchanged.
1073
1074 Specifying a negative flag after the caret is an error, as the flag is
1075 redundant.
1076
1077 Mnemonic for C<(?^...)>:  A fresh beginning since the usual use of a caret is
1078 to match at the beginning.
1079
1080 =item C<(?|pattern)>
1081 X<(?|)> X<Branch reset>
1082
1083 This is the "branch reset" pattern, which has the special property
1084 that the capture groups are numbered from the same starting point
1085 in each alternation branch. It is available starting from perl 5.10.0.
1086
1087 Capture groups are numbered from left to right, but inside this
1088 construct the numbering is restarted for each branch.
1089
1090 The numbering within each branch will be as normal, and any groups
1091 following this construct will be numbered as though the construct
1092 contained only one branch, that being the one with the most capture
1093 groups in it.
1094
1095 This construct is useful when you want to capture one of a
1096 number of alternative matches.
1097
1098 Consider the following pattern.  The numbers underneath show in
1099 which group the captured content will be stored.
1100
1101
1102     # before  ---------------branch-reset----------- after        
1103     / ( a )  (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x
1104     # 1            2         2  3        2     3     4  
1105
1106 Be careful when using the branch reset pattern in combination with 
1107 named captures. Named captures are implemented as being aliases to 
1108 numbered groups holding the captures, and that interferes with the
1109 implementation of the branch reset pattern. If you are using named
1110 captures in a branch reset pattern, it's best to use the same names,
1111 in the same order, in each of the alternations:
1112
1113    /(?|  (?<a> x ) (?<b> y )
1114       |  (?<a> z ) (?<b> w )) /x
1115
1116 Not doing so may lead to surprises:
1117
1118   "12" =~ /(?| (?<a> \d+ ) | (?<b> \D+))/x;
1119   say $+ {a};   # Prints '12'
1120   say $+ {b};   # *Also* prints '12'.
1121
1122 The problem here is that both the group named C<< a >> and the group
1123 named C<< b >> are aliases for the group belonging to C<< $1 >>.
1124
1125 =item Look-Around Assertions
1126 X<look-around assertion> X<lookaround assertion> X<look-around> X<lookaround>
1127
1128 Look-around assertions are zero-width patterns which match a specific
1129 pattern without including it in C<$&>. Positive assertions match when
1130 their subpattern matches, negative assertions match when their subpattern
1131 fails. Look-behind matches text up to the current match position,
1132 look-ahead matches text following the current match position.
1133
1134 =over 4
1135
1136 =item C<(?=pattern)>
1137 X<(?=)> X<look-ahead, positive> X<lookahead, positive>
1138
1139 A zero-width positive look-ahead assertion.  For example, C</\w+(?=\t)/>
1140 matches a word followed by a tab, without including the tab in C<$&>.
1141
1142 =item C<(?!pattern)>
1143 X<(?!)> X<look-ahead, negative> X<lookahead, negative>
1144
1145 A zero-width negative look-ahead assertion.  For example C</foo(?!bar)/>
1146 matches any occurrence of "foo" that isn't followed by "bar".  Note
1147 however that look-ahead and look-behind are NOT the same thing.  You cannot
1148 use this for look-behind.
1149
1150 If you are looking for a "bar" that isn't preceded by a "foo", C</(?!foo)bar/>
1151 will not do what you want.  That's because the C<(?!foo)> is just saying that
1152 the next thing cannot be "foo"--and it's not, it's a "bar", so "foobar" will
1153 match.  Use look-behind instead (see below).
1154
1155 =item C<(?<=pattern)> C<\K>
1156 X<(?<=)> X<look-behind, positive> X<lookbehind, positive> X<\K>
1157
1158 A zero-width positive look-behind assertion.  For example, C</(?<=\t)\w+/>
1159 matches a word that follows a tab, without including the tab in C<$&>.
1160 Works only for fixed-width look-behind.
1161
1162 There is a special form of this construct, called C<\K>, which causes the
1163 regex engine to "keep" everything it had matched prior to the C<\K> and
1164 not include it in C<$&>. This effectively provides variable-length
1165 look-behind. The use of C<\K> inside of another look-around assertion
1166 is allowed, but the behaviour is currently not well defined.
1167
1168 For various reasons C<\K> may be significantly more efficient than the
1169 equivalent C<< (?<=...) >> construct, and it is especially useful in
1170 situations where you want to efficiently remove something following
1171 something else in a string. For instance
1172
1173   s/(foo)bar/$1/g;
1174
1175 can be rewritten as the much more efficient
1176
1177   s/foo\Kbar//g;
1178
1179 =item C<(?<!pattern)>
1180 X<(?<!)> X<look-behind, negative> X<lookbehind, negative>
1181
1182 A zero-width negative look-behind assertion.  For example C</(?<!bar)foo/>
1183 matches any occurrence of "foo" that does not follow "bar".  Works
1184 only for fixed-width look-behind.
1185
1186 =back
1187
1188 =item C<(?'NAME'pattern)>
1189
1190 =item C<< (?<NAME>pattern) >>
1191 X<< (?<NAME>) >> X<(?'NAME')> X<named capture> X<capture>
1192
1193 A named capture group. Identical in every respect to normal capturing
1194 parentheses C<()> but for the additional fact that the group
1195 can be referred to by name in various regular expression
1196 constructs (like C<\g{NAME}>) and can be accessed by name
1197 after a successful match via C<%+> or C<%->. See L<perlvar>
1198 for more details on the C<%+> and C<%-> hashes.
1199
1200 If multiple distinct capture groups have the same name then the
1201 $+{NAME} will refer to the leftmost defined group in the match.
1202
1203 The forms C<(?'NAME'pattern)> and C<< (?<NAME>pattern) >> are equivalent.
1204
1205 B<NOTE:> While the notation of this construct is the same as the similar
1206 function in .NET regexes, the behavior is not. In Perl the groups are
1207 numbered sequentially regardless of being named or not. Thus in the
1208 pattern
1209
1210   /(x)(?<foo>y)(z)/
1211
1212 $+{foo} will be the same as $2, and $3 will contain 'z' instead of
1213 the opposite which is what a .NET regex hacker might expect.
1214
1215 Currently NAME is restricted to simple identifiers only.
1216 In other words, it must match C</^[_A-Za-z][_A-Za-z0-9]*\z/> or
1217 its Unicode extension (see L<utf8>),
1218 though it isn't extended by the locale (see L<perllocale>).
1219
1220 B<NOTE:> In order to make things easier for programmers with experience
1221 with the Python or PCRE regex engines, the pattern C<< (?PE<lt>NAMEE<gt>pattern) >>
1222 may be used instead of C<< (?<NAME>pattern) >>; however this form does not
1223 support the use of single quotes as a delimiter for the name.
1224
1225 =item C<< \k<NAME> >>
1226
1227 =item C<< \k'NAME' >>
1228
1229 Named backreference. Similar to numeric backreferences, except that
1230 the group is designated by name and not number. If multiple groups
1231 have the same name then it refers to the leftmost defined group in
1232 the current match.
1233
1234 It is an error to refer to a name not defined by a C<< (?<NAME>) >>
1235 earlier in the pattern.
1236
1237 Both forms are equivalent.
1238
1239 B<NOTE:> In order to make things easier for programmers with experience
1240 with the Python or PCRE regex engines, the pattern C<< (?P=NAME) >>
1241 may be used instead of C<< \k<NAME> >>.
1242
1243 =item C<(?{ code })>
1244 X<(?{})> X<regex, code in> X<regexp, code in> X<regular expression, code in>
1245
1246 B<WARNING>: This extended regular expression feature is considered
1247 experimental, and may be changed without notice. Code executed that
1248 has side effects may not perform identically from version to version
1249 due to the effect of future optimisations in the regex engine. The
1250 implementation of this feature was radically overhauled for the 5.18.0
1251 release, and its behaviour in earlier versions of perl was much buggier,
1252 especially in relation to parsing, lexical vars, scoping, recursion and
1253 reentrancy.
1254
1255 This zero-width assertion executes any embedded Perl code.  It always
1256 succeeds, and its return value is set as C<$^R>.
1257
1258 In literal patterns, the code is parsed at the same time as the
1259 surrounding code. While within the pattern, control is passed temporarily
1260 back to the perl parser, until the logically-balancing closing brace is
1261 encountered. This is similar to the way that an array index expression in
1262 a literal string is handled, for example
1263
1264     "abc$array[ 1 + f('[') + g()]def"
1265
1266 In particular, braces do not need to be balanced:
1267
1268     s/abc(?{ f('{'); })/def/
1269
1270 Even in a pattern that is interpolated and compiled at run-time, literal
1271 code blocks will be compiled once, at perl compile time; the following
1272 prints "ABCD":
1273
1274     print "D";
1275     my $qr = qr/(?{ BEGIN { print "A" } })/;
1276     my $foo = "foo";
1277     /$foo$qr(?{ BEGIN { print "B" } })/;
1278     BEGIN { print "C" }
1279
1280 In patterns where the text of the code is derived from run-time
1281 information rather than appearing literally in a source code /pattern/,
1282 the code is compiled at the same time that the pattern is compiled, and
1283 for reasons of security, C<use re 'eval'> must be in scope. This is to
1284 stop user-supplied patterns containing code snippets from being
1285 executable.
1286
1287 In situations where you need to enable this with C<use re 'eval'>, you should
1288 also have taint checking enabled.  Better yet, use the carefully
1289 constrained evaluation within a Safe compartment.  See L<perlsec> for
1290 details about both these mechanisms.
1291
1292 From the viewpoint of parsing, lexical variable scope and closures,
1293
1294     /AAA(?{ BBB })CCC/
1295
1296 behaves approximately like
1297
1298     /AAA/ && do { BBB } && /CCC/
1299
1300 Similarly,
1301
1302     qr/AAA(?{ BBB })CCC/
1303
1304 behaves approximately like
1305
1306     sub { /AAA/ && do { BBB } && /CCC/ }
1307
1308 In particular:
1309
1310     { my $i = 1; $r = qr/(?{ print $i })/ }
1311     my $i = 2;
1312     /$r/; # prints "1"
1313
1314 Inside a C<(?{...})> block, C<$_> refers to the string the regular
1315 expression is matching against. You can also use C<pos()> to know what is
1316 the current position of matching within this string.
1317
1318 The code block introduces a new scope from the perspective of lexical
1319 variable declarations, but B<not> from the perspective of C<local> and
1320 similar localizing behaviours. So later code blocks within the same
1321 pattern will still see the values which were localized in earlier blocks.
1322 These accumulated localizations are undone either at the end of a
1323 successful match, or if the assertion is backtracked (compare
1324 L<"Backtracking">). For example,
1325
1326   $_ = 'a' x 8;
1327   m<
1328      (?{ $cnt = 0 })               # Initialize $cnt.
1329      (
1330        a
1331        (?{
1332            local $cnt = $cnt + 1;  # Update $cnt,
1333                                    # backtracking-safe.
1334        })
1335      )*
1336      aaaa
1337      (?{ $res = $cnt })            # On success copy to
1338                                    # non-localized location.
1339    >x;
1340
1341 will initially increment C<$cnt> up to 8; then during backtracking, its
1342 value will be unwound back to 4, which is the value assigned to C<$res>.
1343 At the end of the regex execution, $cnt will be wound back to its initial
1344 value of 0.
1345
1346 This assertion may be used as the condition in a
1347
1348     (?(condition)yes-pattern|no-pattern)
1349
1350 switch.  If I<not> used in this way, the result of evaluation of C<code>
1351 is put into the special variable C<$^R>.  This happens immediately, so
1352 C<$^R> can be used from other C<(?{ code })> assertions inside the same
1353 regular expression.
1354
1355 The assignment to C<$^R> above is properly localized, so the old
1356 value of C<$^R> is restored if the assertion is backtracked; compare
1357 L<"Backtracking">.
1358
1359 Note that the special variable C<$^N>  is particularly useful with code
1360 blocks to capture the results of submatches in variables without having to
1361 keep track of the number of nested parentheses. For example:
1362
1363   $_ = "The brown fox jumps over the lazy dog";
1364   /the (\S+)(?{ $color = $^N }) (\S+)(?{ $animal = $^N })/i;
1365   print "color = $color, animal = $animal\n";
1366
1367
1368 =item C<(??{ code })>
1369 X<(??{})>
1370 X<regex, postponed> X<regexp, postponed> X<regular expression, postponed>
1371
1372 B<WARNING>: This extended regular expression feature is considered
1373 experimental, and may be changed without notice. Code executed that
1374 has side effects may not perform identically from version to version
1375 due to the effect of future optimisations in the regex engine.
1376
1377 This is a "postponed" regular subexpression.  It behaves in I<exactly> the
1378 same way as a C<(?{ code })> code block as described above, except that
1379 its return value, rather than being assigned to C<$^R>, is treated as a
1380 pattern, compiled if it's a string (or used as-is if its a qr// object),
1381 then matched as if it were inserted instead of this construct.
1382
1383 During the matching of this sub-pattern, it has its own set of
1384 captures which are valid during the sub-match, but are discarded once
1385 control returns to the main pattern. For example, the following matches,
1386 with the inner pattern capturing "B" and matching "BB", while the outer
1387 pattern captures "A";
1388
1389     my $inner = '(.)\1';
1390     "ABBA" =~ /^(.)(??{ $inner })\1/;
1391     print $1; # prints "A";
1392
1393 Note that this means that  there is no way for the inner pattern to refer
1394 to a capture group defined outside.  (The code block itself can use C<$1>,
1395 etc., to refer to the enclosing pattern's capture groups.)  Thus, although
1396
1397     ('a' x 100)=~/(??{'(.)' x 100})/
1398
1399 I<will> match, it will I<not> set $1 on exit.
1400
1401 The following pattern matches a parenthesized group:
1402
1403  $re = qr{
1404             \(
1405             (?:
1406                (?> [^()]+ )  # Non-parens without backtracking
1407              |
1408                (??{ $re })   # Group with matching parens
1409             )*
1410             \)
1411          }x;
1412
1413 See also C<(?PARNO)> for a different, more efficient way to accomplish
1414 the same task.
1415
1416 Executing a postponed regular expression 50 times without consuming any
1417 input string will result in a fatal error.  The maximum depth is compiled
1418 into perl, so changing it requires a custom build.
1419
1420 =item C<(?PARNO)> C<(?-PARNO)> C<(?+PARNO)> C<(?R)> C<(?0)>
1421 X<(?PARNO)> X<(?1)> X<(?R)> X<(?0)> X<(?-1)> X<(?+1)> X<(?-PARNO)> X<(?+PARNO)>
1422 X<regex, recursive> X<regexp, recursive> X<regular expression, recursive>
1423 X<regex, relative recursion>
1424
1425 Similar to C<(??{ code })> except that it does not involve executing any
1426 code or potentially compiling a returned pattern string; instead it treats
1427 the part of the current pattern contained within a specified capture group
1428 as an independent pattern that must match at the current position.
1429 Capture groups contained by the pattern will have the value as determined
1430 by the outermost recursion.
1431
1432 PARNO is a sequence of digits (not starting with 0) whose value reflects
1433 the paren-number of the capture group to recurse to. C<(?R)> recurses to
1434 the beginning of the whole pattern. C<(?0)> is an alternate syntax for
1435 C<(?R)>. If PARNO is preceded by a plus or minus sign then it is assumed
1436 to be relative, with negative numbers indicating preceding capture groups
1437 and positive ones following. Thus C<(?-1)> refers to the most recently
1438 declared group, and C<(?+1)> indicates the next group to be declared.
1439 Note that the counting for relative recursion differs from that of
1440 relative backreferences, in that with recursion unclosed groups B<are>
1441 included.
1442
1443 The following pattern matches a function foo() which may contain
1444 balanced parentheses as the argument.
1445
1446   $re = qr{ (                   # paren group 1 (full function)
1447               foo
1448               (                 # paren group 2 (parens)
1449                 \(
1450                   (             # paren group 3 (contents of parens)
1451                   (?:
1452                    (?> [^()]+ ) # Non-parens without backtracking
1453                   |
1454                    (?2)         # Recurse to start of paren group 2
1455                   )*
1456                   )
1457                 \)
1458               )
1459             )
1460           }x;
1461
1462 If the pattern was used as follows
1463
1464     'foo(bar(baz)+baz(bop))'=~/$re/
1465         and print "\$1 = $1\n",
1466                   "\$2 = $2\n",
1467                   "\$3 = $3\n";
1468
1469 the output produced should be the following:
1470
1471     $1 = foo(bar(baz)+baz(bop))
1472     $2 = (bar(baz)+baz(bop))
1473     $3 = bar(baz)+baz(bop)
1474
1475 If there is no corresponding capture group defined, then it is a
1476 fatal error.  Recursing deeper than 50 times without consuming any input
1477 string will also result in a fatal error.  The maximum depth is compiled
1478 into perl, so changing it requires a custom build.
1479
1480 The following shows how using negative indexing can make it
1481 easier to embed recursive patterns inside of a C<qr//> construct
1482 for later use:
1483
1484     my $parens = qr/(\((?:[^()]++|(?-1))*+\))/;
1485     if (/foo $parens \s+ \+ \s+ bar $parens/x) {
1486        # do something here...
1487     }
1488
1489 B<Note> that this pattern does not behave the same way as the equivalent
1490 PCRE or Python construct of the same form. In Perl you can backtrack into
1491 a recursed group, in PCRE and Python the recursed into group is treated
1492 as atomic. Also, modifiers are resolved at compile time, so constructs
1493 like (?i:(?1)) or (?:(?i)(?1)) do not affect how the sub-pattern will
1494 be processed.
1495
1496 =item C<(?&NAME)>
1497 X<(?&NAME)>
1498
1499 Recurse to a named subpattern. Identical to C<(?PARNO)> except that the
1500 parenthesis to recurse to is determined by name. If multiple parentheses have
1501 the same name, then it recurses to the leftmost.
1502
1503 It is an error to refer to a name that is not declared somewhere in the
1504 pattern.
1505
1506 B<NOTE:> In order to make things easier for programmers with experience
1507 with the Python or PCRE regex engines the pattern C<< (?P>NAME) >>
1508 may be used instead of C<< (?&NAME) >>.
1509
1510 =item C<(?(condition)yes-pattern|no-pattern)>
1511 X<(?()>
1512
1513 =item C<(?(condition)yes-pattern)>
1514
1515 Conditional expression. Matches C<yes-pattern> if C<condition> yields
1516 a true value, matches C<no-pattern> otherwise. A missing pattern always
1517 matches.
1518
1519 C<(condition)> should be one of: 1) an integer in
1520 parentheses (which is valid if the corresponding pair of parentheses
1521 matched); 2) a look-ahead/look-behind/evaluate zero-width assertion; 3) a
1522 name in angle brackets or single quotes (which is valid if a group
1523 with the given name matched); or 4) the special symbol (R) (true when
1524 evaluated inside of recursion or eval). Additionally the R may be
1525 followed by a number, (which will be true when evaluated when recursing
1526 inside of the appropriate group), or by C<&NAME>, in which case it will
1527 be true only when evaluated during recursion in the named group.
1528
1529 Here's a summary of the possible predicates:
1530
1531 =over 4
1532
1533 =item (1) (2) ...
1534
1535 Checks if the numbered capturing group has matched something.
1536
1537 =item (<NAME>) ('NAME')
1538
1539 Checks if a group with the given name has matched something.
1540
1541 =item (?=...) (?!...) (?<=...) (?<!...)
1542
1543 Checks whether the pattern matches (or does not match, for the '!'
1544 variants).
1545
1546 =item (?{ CODE })
1547
1548 Treats the return value of the code block as the condition.
1549
1550 =item (R)
1551
1552 Checks if the expression has been evaluated inside of recursion.
1553
1554 =item (R1) (R2) ...
1555
1556 Checks if the expression has been evaluated while executing directly
1557 inside of the n-th capture group. This check is the regex equivalent of
1558
1559   if ((caller(0))[3] eq 'subname') { ... }
1560
1561 In other words, it does not check the full recursion stack.
1562
1563 =item (R&NAME)
1564
1565 Similar to C<(R1)>, this predicate checks to see if we're executing
1566 directly inside of the leftmost group with a given name (this is the same
1567 logic used by C<(?&NAME)> to disambiguate). It does not check the full
1568 stack, but only the name of the innermost active recursion.
1569
1570 =item (DEFINE)
1571
1572 In this case, the yes-pattern is never directly executed, and no
1573 no-pattern is allowed. Similar in spirit to C<(?{0})> but more efficient.
1574 See below for details.
1575
1576 =back
1577
1578 For example:
1579
1580     m{ ( \( )?
1581        [^()]+
1582        (?(1) \) )
1583      }x
1584
1585 matches a chunk of non-parentheses, possibly included in parentheses
1586 themselves.
1587
1588 A special form is the C<(DEFINE)> predicate, which never executes its
1589 yes-pattern directly, and does not allow a no-pattern. This allows one to
1590 define subpatterns which will be executed only by the recursion mechanism.
1591 This way, you can define a set of regular expression rules that can be
1592 bundled into any pattern you choose.
1593
1594 It is recommended that for this usage you put the DEFINE block at the
1595 end of the pattern, and that you name any subpatterns defined within it.
1596
1597 Also, it's worth noting that patterns defined this way probably will
1598 not be as efficient, as the optimiser is not very clever about
1599 handling them.
1600
1601 An example of how this might be used is as follows:
1602
1603   /(?<NAME>(?&NAME_PAT))(?<ADDR>(?&ADDRESS_PAT))
1604    (?(DEFINE)
1605      (?<NAME_PAT>....)
1606      (?<ADRESS_PAT>....)
1607    )/x
1608
1609 Note that capture groups matched inside of recursion are not accessible
1610 after the recursion returns, so the extra layer of capturing groups is
1611 necessary. Thus C<$+{NAME_PAT}> would not be defined even though
1612 C<$+{NAME}> would be.
1613
1614 Finally, keep in mind that subpatterns created inside a DEFINE block
1615 count towards the absolute and relative number of captures, so this:
1616
1617     my @captures = "a" =~ /(.)                  # First capture
1618                            (?(DEFINE)
1619                                (?<EXAMPLE> 1 )  # Second capture
1620                            )/x;
1621     say scalar @captures;
1622
1623 Will output 2, not 1. This is particularly important if you intend to
1624 compile the definitions with the C<qr//> operator, and later
1625 interpolate them in another pattern.
1626
1627 =item C<< (?>pattern) >>
1628 X<backtrack> X<backtracking> X<atomic> X<possessive>
1629
1630 An "independent" subexpression, one which matches the substring
1631 that a I<standalone> C<pattern> would match if anchored at the given
1632 position, and it matches I<nothing other than this substring>.  This
1633 construct is useful for optimizations of what would otherwise be
1634 "eternal" matches, because it will not backtrack (see L<"Backtracking">).
1635 It may also be useful in places where the "grab all you can, and do not
1636 give anything back" semantic is desirable.
1637
1638 For example: C<< ^(?>a*)ab >> will never match, since C<< (?>a*) >>
1639 (anchored at the beginning of string, as above) will match I<all>
1640 characters C<a> at the beginning of string, leaving no C<a> for
1641 C<ab> to match.  In contrast, C<a*ab> will match the same as C<a+b>,
1642 since the match of the subgroup C<a*> is influenced by the following
1643 group C<ab> (see L<"Backtracking">).  In particular, C<a*> inside
1644 C<a*ab> will match fewer characters than a standalone C<a*>, since
1645 this makes the tail match.
1646
1647 C<< (?>pattern) >> does not disable backtracking altogether once it has
1648 matched. It is still possible to backtrack past the construct, but not
1649 into it. So C<< ((?>a*)|(?>b*))ar >> will still match "bar".
1650
1651 An effect similar to C<< (?>pattern) >> may be achieved by writing
1652 C<(?=(pattern))\g{-1}>.  This matches the same substring as a standalone
1653 C<a+>, and the following C<\g{-1}> eats the matched string; it therefore
1654 makes a zero-length assertion into an analogue of C<< (?>...) >>.
1655 (The difference between these two constructs is that the second one
1656 uses a capturing group, thus shifting ordinals of backreferences
1657 in the rest of a regular expression.)
1658
1659 Consider this pattern:
1660
1661     m{ \(
1662           (
1663             [^()]+           # x+
1664           |
1665             \( [^()]* \)
1666           )+
1667        \)
1668      }x
1669
1670 That will efficiently match a nonempty group with matching parentheses
1671 two levels deep or less.  However, if there is no such group, it
1672 will take virtually forever on a long string.  That's because there
1673 are so many different ways to split a long string into several
1674 substrings.  This is what C<(.+)+> is doing, and C<(.+)+> is similar
1675 to a subpattern of the above pattern.  Consider how the pattern
1676 above detects no-match on C<((()aaaaaaaaaaaaaaaaaa> in several
1677 seconds, but that each extra letter doubles this time.  This
1678 exponential performance will make it appear that your program has
1679 hung.  However, a tiny change to this pattern
1680
1681     m{ \(
1682           (
1683             (?> [^()]+ )        # change x+ above to (?> x+ )
1684           |
1685             \( [^()]* \)
1686           )+
1687        \)
1688      }x
1689
1690 which uses C<< (?>...) >> matches exactly when the one above does (verifying
1691 this yourself would be a productive exercise), but finishes in a fourth
1692 the time when used on a similar string with 1000000 C<a>s.  Be aware,
1693 however, that, when this construct is followed by a
1694 quantifier, it currently triggers a warning message under
1695 the C<use warnings> pragma or B<-w> switch saying it
1696 C<"matches null string many times in regex">.
1697
1698 On simple groups, such as the pattern C<< (?> [^()]+ ) >>, a comparable
1699 effect may be achieved by negative look-ahead, as in C<[^()]+ (?! [^()] )>.
1700 This was only 4 times slower on a string with 1000000 C<a>s.
1701
1702 The "grab all you can, and do not give anything back" semantic is desirable
1703 in many situations where on the first sight a simple C<()*> looks like
1704 the correct solution.  Suppose we parse text with comments being delimited
1705 by C<#> followed by some optional (horizontal) whitespace.  Contrary to
1706 its appearance, C<#[ \t]*> I<is not> the correct subexpression to match
1707 the comment delimiter, because it may "give up" some whitespace if
1708 the remainder of the pattern can be made to match that way.  The correct
1709 answer is either one of these:
1710
1711     (?>#[ \t]*)
1712     #[ \t]*(?![ \t])
1713
1714 For example, to grab non-empty comments into $1, one should use either
1715 one of these:
1716
1717     / (?> \# [ \t]* ) (        .+ ) /x;
1718     /     \# [ \t]*   ( [^ \t] .* ) /x;
1719
1720 Which one you pick depends on which of these expressions better reflects
1721 the above specification of comments.
1722
1723 In some literature this construct is called "atomic matching" or
1724 "possessive matching".
1725
1726 Possessive quantifiers are equivalent to putting the item they are applied
1727 to inside of one of these constructs. The following equivalences apply:
1728
1729     Quantifier Form     Bracketing Form
1730     ---------------     ---------------
1731     PAT*+               (?>PAT*)
1732     PAT++               (?>PAT+)
1733     PAT?+               (?>PAT?)
1734     PAT{min,max}+       (?>PAT{min,max})
1735
1736 =item C<(?[ ])>
1737 X<set operations>
1738
1739 This is an experimental feature present starting in 5.18, but is subject
1740 to change as we gain field experience with it.  Any attempt to use it
1741 will raise a warning, unless disabled via
1742
1743  no warnings "experimental::regex_sets";
1744
1745 Comments on this feature are welcome; send email to
1746 C<perl5-porters@perl.org>.
1747
1748 This is a fancy bracketed character class that can be used for more
1749 readable and less error-prone classes, and to perform set operations,
1750 such as intersection. An example is
1751
1752  /(?[ \p{Thai} & \p{Digit} ])/
1753
1754 This will match all the digit characters that are in the Thai script.
1755 We can extend this by
1756
1757  /(?[ ( \p{Thai} + \p{Lao} ) & \p{Digit} ])/
1758
1759 This matches digits that are in either the Thai or Laotian scripts.
1760
1761 Notice the white space in these examples.  This construct always has
1762 L</C<E<sol>x>> turned on.
1763
1764 The available binary operators are:
1765
1766  &    intersection
1767  +    union
1768  |    another name for '+', hence means union
1769  -    subtraction (the result matches the set consisting of those
1770       code points matched by the first operand, excluding any that
1771       are also matched by the second operand)
1772  ^    symmetric difference (the union minus the intersection).  This
1773       is like an exclusive or, in that the result is the set of code
1774       points that are matched by either, but not both, of the
1775       operands.
1776
1777 There is one unary operator:
1778
1779  !    complement
1780
1781 All the binary operators left associate, and are of equal precedence.
1782 The unary operator right associates, and has higher precedence.  Use
1783 parentheses to override the default associations.
1784
1785 The main restriction is that everything is a metacharacter.  Thus,
1786 you cannot refer to single characters by doing something like this:
1787
1788  /(?[ a + b ])/ # Syntax error!
1789
1790 The easiest way to specify an individual typable character is to enclose
1791 it in brackets:
1792
1793  /(?[ [a] + [b] ])/
1794
1795 (This is the same thing as C<[ab]>.)  You could also have said the
1796 equivalent
1797
1798  /(?[[ a b ]])/
1799
1800 (You can, of course, specify single characters by using, C<\x{ }>,
1801 C<\N{ }>, etc.)
1802
1803 This last example shows the use of this construct to specify an ordinary
1804 bracketed character class without set operations.  Note the white space
1805 within it.  To specify a matchable white space character, you can escape
1806 it with a backslash, like:
1807
1808  /(?[ [ a e i o u \  ] ])/
1809
1810 This matches the English vowels plus the SPACE character.
1811 All the other escapes accepted by normal bracketed character classes are
1812 accepted here as well; but unlike the normal ones, unrecognized escapes are
1813 fatal errors here.
1814
1815 All warnings from these class elements are fatal, as well as some
1816 practices that don't currently warn.  For example you cannot say
1817
1818  /(?[ [ \xF ] ])/     # Syntax error!
1819
1820 You have to have two hex digits after a braceless C<\x> (use a leading
1821 zero to make two).  These restrictions are to lower the incidence of
1822 typos causing the class to not match what you thought it would.
1823
1824 The final difference between regular bracketed character classes and
1825 these, is that it is not possible to get the latter to match a
1826 multi-character fold.  Thus,
1827
1828  /(?[ [\xDF] ])/iu
1829
1830 does not match the string C<ss>.
1831
1832 You don't have to enclose Posix class names inside double brackets.  The
1833 following works
1834
1835  /(?[ [:word:] - [:lower:] ])/
1836
1837 C<< (?[ ]) >> is a compile-time construct.  Any attempt to use something
1838 which isn't knowable until run-time is a fatal error.  Thus, this
1839 construct cannot be used within the scope of C<use locale> (or the
1840 L</C<E<sol>l>> regex modifier).  Any L<user-defined
1841 property|perlunicode/"User-Defined Character Properties"> used must be
1842 already defined by the time the regular expression is compiled; but note
1843 that this construct can be used to avoid defining such properties.
1844
1845 A regular expression using this construct that otherwise would compile
1846 using L</C<E<sol>d>> rules will instead use L</C<E<sol>u>>.
1847
1848 The L</C<E<sol>x>> processing within this class is an extended form.
1849 Besides the characters that are considered white space in normal C</x>
1850 processing, there are 5 others, recommended by the Unicode standard:
1851
1852  U+0085 NEXT LINE
1853  U+200E LEFT-TO-RIGHT MARK
1854  U+200F RIGHT-TO-LEFT MARK
1855  U+2028 LINE SEPARATOR
1856  U+2029 PARAGRAPH SEPARATOR
1857
1858 Note that skipping white space applies only to the interior of this
1859 construct.  There must not be any space between any of the characters
1860 that form the initial C<(?[>.  Nor may there be space between the
1861 closing C<])> characters.
1862
1863 Due to the way that Perl parses things, your parentheses and brackets
1864 may need to be balanced, even including comments.
1865
1866 Since this experimental, we may change this so that other legal uses of
1867 normal bracketed character classes might become illegal.  One proposal,
1868 for example, is to forbid adjacent uses of the same character, as in
1869 C<[aa]>.  This is likely a typo, as the second "a" adds nothing.
1870
1871 =back
1872
1873 =head2 Special Backtracking Control Verbs
1874
1875 B<WARNING:> These patterns are experimental and subject to change or
1876 removal in a future version of Perl. Their usage in production code should
1877 be noted to avoid problems during upgrades.
1878
1879 These special patterns are generally of the form C<(*VERB:ARG)>. Unless
1880 otherwise stated the ARG argument is optional; in some cases, it is
1881 forbidden.
1882
1883 Any pattern containing a special backtracking verb that allows an argument
1884 has the special behaviour that when executed it sets the current package's
1885 C<$REGERROR> and C<$REGMARK> variables. When doing so the following
1886 rules apply:
1887
1888 On failure, the C<$REGERROR> variable will be set to the ARG value of the
1889 verb pattern, if the verb was involved in the failure of the match. If the
1890 ARG part of the pattern was omitted, then C<$REGERROR> will be set to the
1891 name of the last C<(*MARK:NAME)> pattern executed, or to TRUE if there was
1892 none. Also, the C<$REGMARK> variable will be set to FALSE.
1893
1894 On a successful match, the C<$REGERROR> variable will be set to FALSE, and
1895 the C<$REGMARK> variable will be set to the name of the last
1896 C<(*MARK:NAME)> pattern executed.  See the explanation for the
1897 C<(*MARK:NAME)> verb below for more details.
1898
1899 B<NOTE:> C<$REGERROR> and C<$REGMARK> are not magic variables like C<$1>
1900 and most other regex-related variables. They are not local to a scope, nor
1901 readonly, but instead are volatile package variables similar to C<$AUTOLOAD>.
1902 Use C<local> to localize changes to them to a specific scope if necessary.
1903
1904 If a pattern does not contain a special backtracking verb that allows an
1905 argument, then C<$REGERROR> and C<$REGMARK> are not touched at all.
1906
1907 =over 3
1908
1909 =item Verbs that take an argument
1910
1911 =over 4
1912
1913 =item C<(*PRUNE)> C<(*PRUNE:NAME)>
1914 X<(*PRUNE)> X<(*PRUNE:NAME)>
1915
1916 This zero-width pattern prunes the backtracking tree at the current point
1917 when backtracked into on failure. Consider the pattern C<A (*PRUNE) B>,
1918 where A and B are complex patterns. Until the C<(*PRUNE)> verb is reached,
1919 A may backtrack as necessary to match. Once it is reached, matching
1920 continues in B, which may also backtrack as necessary; however, should B
1921 not match, then no further backtracking will take place, and the pattern
1922 will fail outright at the current starting position.
1923
1924 The following example counts all the possible matching strings in a
1925 pattern (without actually matching any of them).
1926
1927     'aaab' =~ /a+b?(?{print "$&\n"; $count++})(*FAIL)/;
1928     print "Count=$count\n";
1929
1930 which produces:
1931
1932     aaab
1933     aaa
1934     aa
1935     a
1936     aab
1937     aa
1938     a
1939     ab
1940     a
1941     Count=9
1942
1943 If we add a C<(*PRUNE)> before the count like the following
1944
1945     'aaab' =~ /a+b?(*PRUNE)(?{print "$&\n"; $count++})(*FAIL)/;
1946     print "Count=$count\n";
1947
1948 we prevent backtracking and find the count of the longest matching string
1949 at each matching starting point like so:
1950
1951     aaab
1952     aab
1953     ab
1954     Count=3
1955
1956 Any number of C<(*PRUNE)> assertions may be used in a pattern.
1957
1958 See also C<< (?>pattern) >> and possessive quantifiers for other ways to
1959 control backtracking. In some cases, the use of C<(*PRUNE)> can be
1960 replaced with a C<< (?>pattern) >> with no functional difference; however,
1961 C<(*PRUNE)> can be used to handle cases that cannot be expressed using a
1962 C<< (?>pattern) >> alone.
1963
1964 =item C<(*SKIP)> C<(*SKIP:NAME)>
1965 X<(*SKIP)>
1966
1967 This zero-width pattern is similar to C<(*PRUNE)>, except that on
1968 failure it also signifies that whatever text that was matched leading up
1969 to the C<(*SKIP)> pattern being executed cannot be part of I<any> match
1970 of this pattern. This effectively means that the regex engine "skips" forward
1971 to this position on failure and tries to match again, (assuming that
1972 there is sufficient room to match).
1973
1974 The name of the C<(*SKIP:NAME)> pattern has special significance. If a
1975 C<(*MARK:NAME)> was encountered while matching, then it is that position
1976 which is used as the "skip point". If no C<(*MARK)> of that name was
1977 encountered, then the C<(*SKIP)> operator has no effect. When used
1978 without a name the "skip point" is where the match point was when
1979 executing the (*SKIP) pattern.
1980
1981 Compare the following to the examples in C<(*PRUNE)>; note the string
1982 is twice as long:
1983
1984  'aaabaaab' =~ /a+b?(*SKIP)(?{print "$&\n"; $count++})(*FAIL)/;
1985  print "Count=$count\n";
1986
1987 outputs
1988
1989     aaab
1990     aaab
1991     Count=2
1992
1993 Once the 'aaab' at the start of the string has matched, and the C<(*SKIP)>
1994 executed, the next starting point will be where the cursor was when the
1995 C<(*SKIP)> was executed.
1996
1997 =item C<(*MARK:NAME)> C<(*:NAME)>
1998 X<(*MARK)> X<(*MARK:NAME)> X<(*:NAME)>
1999
2000 This zero-width pattern can be used to mark the point reached in a string
2001 when a certain part of the pattern has been successfully matched. This
2002 mark may be given a name. A later C<(*SKIP)> pattern will then skip
2003 forward to that point if backtracked into on failure. Any number of
2004 C<(*MARK)> patterns are allowed, and the NAME portion may be duplicated.
2005
2006 In addition to interacting with the C<(*SKIP)> pattern, C<(*MARK:NAME)>
2007 can be used to "label" a pattern branch, so that after matching, the
2008 program can determine which branches of the pattern were involved in the
2009 match.
2010
2011 When a match is successful, the C<$REGMARK> variable will be set to the
2012 name of the most recently executed C<(*MARK:NAME)> that was involved
2013 in the match.
2014
2015 This can be used to determine which branch of a pattern was matched
2016 without using a separate capture group for each branch, which in turn
2017 can result in a performance improvement, as perl cannot optimize
2018 C</(?:(x)|(y)|(z))/> as efficiently as something like
2019 C</(?:x(*MARK:x)|y(*MARK:y)|z(*MARK:z))/>.
2020
2021 When a match has failed, and unless another verb has been involved in
2022 failing the match and has provided its own name to use, the C<$REGERROR>
2023 variable will be set to the name of the most recently executed
2024 C<(*MARK:NAME)>.
2025
2026 See L</(*SKIP)> for more details.
2027
2028 As a shortcut C<(*MARK:NAME)> can be written C<(*:NAME)>.
2029
2030 =item C<(*THEN)> C<(*THEN:NAME)>
2031
2032 This is similar to the "cut group" operator C<::> from Perl 6.  Like
2033 C<(*PRUNE)>, this verb always matches, and when backtracked into on
2034 failure, it causes the regex engine to try the next alternation in the
2035 innermost enclosing group (capturing or otherwise) that has alternations.
2036 The two branches of a C<(?(condition)yes-pattern|no-pattern)> do not
2037 count as an alternation, as far as C<(*THEN)> is concerned.
2038
2039 Its name comes from the observation that this operation combined with the
2040 alternation operator (C<|>) can be used to create what is essentially a
2041 pattern-based if/then/else block:
2042
2043   ( COND (*THEN) FOO | COND2 (*THEN) BAR | COND3 (*THEN) BAZ )
2044
2045 Note that if this operator is used and NOT inside of an alternation then
2046 it acts exactly like the C<(*PRUNE)> operator.
2047
2048   / A (*PRUNE) B /
2049
2050 is the same as
2051
2052   / A (*THEN) B /
2053
2054 but
2055
2056   / ( A (*THEN) B | C ) /
2057
2058 is not the same as
2059
2060   / ( A (*PRUNE) B | C ) /
2061
2062 as after matching the A but failing on the B the C<(*THEN)> verb will
2063 backtrack and try C; but the C<(*PRUNE)> verb will simply fail.
2064
2065 =back
2066
2067 =item Verbs without an argument
2068
2069 =over 4
2070
2071 =item C<(*COMMIT)>
2072 X<(*COMMIT)>
2073
2074 This is the Perl 6 "commit pattern" C<< <commit> >> or C<:::>. It's a
2075 zero-width pattern similar to C<(*SKIP)>, except that when backtracked
2076 into on failure it causes the match to fail outright. No further attempts
2077 to find a valid match by advancing the start pointer will occur again.
2078 For example,
2079
2080  'aaabaaab' =~ /a+b?(*COMMIT)(?{print "$&\n"; $count++})(*FAIL)/;
2081  print "Count=$count\n";
2082
2083 outputs
2084
2085     aaab
2086     Count=1
2087
2088 In other words, once the C<(*COMMIT)> has been entered, and if the pattern
2089 does not match, the regex engine will not try any further matching on the
2090 rest of the string.
2091
2092 =item C<(*FAIL)> C<(*F)>
2093 X<(*FAIL)> X<(*F)>
2094
2095 This pattern matches nothing and always fails. It can be used to force the
2096 engine to backtrack. It is equivalent to C<(?!)>, but easier to read. In
2097 fact, C<(?!)> gets optimised into C<(*FAIL)> internally.
2098
2099 It is probably useful only when combined with C<(?{})> or C<(??{})>.
2100
2101 =item C<(*ACCEPT)>
2102 X<(*ACCEPT)>
2103
2104 B<WARNING:> This feature is highly experimental. It is not recommended
2105 for production code.
2106
2107 This pattern matches nothing and causes the end of successful matching at
2108 the point at which the C<(*ACCEPT)> pattern was encountered, regardless of
2109 whether there is actually more to match in the string. When inside of a
2110 nested pattern, such as recursion, or in a subpattern dynamically generated
2111 via C<(??{})>, only the innermost pattern is ended immediately.
2112
2113 If the C<(*ACCEPT)> is inside of capturing groups then the groups are
2114 marked as ended at the point at which the C<(*ACCEPT)> was encountered.
2115 For instance:
2116
2117   'AB' =~ /(A (A|B(*ACCEPT)|C) D)(E)/x;
2118
2119 will match, and C<$1> will be C<AB> and C<$2> will be C<B>, C<$3> will not
2120 be set. If another branch in the inner parentheses was matched, such as in the
2121 string 'ACDE', then the C<D> and C<E> would have to be matched as well.
2122
2123 =back
2124
2125 =back
2126
2127 =head2 Backtracking
2128 X<backtrack> X<backtracking>
2129
2130 NOTE: This section presents an abstract approximation of regular
2131 expression behavior.  For a more rigorous (and complicated) view of
2132 the rules involved in selecting a match among possible alternatives,
2133 see L<Combining RE Pieces>.
2134
2135 A fundamental feature of regular expression matching involves the
2136 notion called I<backtracking>, which is currently used (when needed)
2137 by all regular non-possessive expression quantifiers, namely C<*>, C<*?>, C<+>,
2138 C<+?>, C<{n,m}>, and C<{n,m}?>.  Backtracking is often optimized
2139 internally, but the general principle outlined here is valid.
2140
2141 For a regular expression to match, the I<entire> regular expression must
2142 match, not just part of it.  So if the beginning of a pattern containing a
2143 quantifier succeeds in a way that causes later parts in the pattern to
2144 fail, the matching engine backs up and recalculates the beginning
2145 part--that's why it's called backtracking.
2146
2147 Here is an example of backtracking:  Let's say you want to find the
2148 word following "foo" in the string "Food is on the foo table.":
2149
2150     $_ = "Food is on the foo table.";
2151     if ( /\b(foo)\s+(\w+)/i ) {
2152         print "$2 follows $1.\n";
2153     }
2154
2155 When the match runs, the first part of the regular expression (C<\b(foo)>)
2156 finds a possible match right at the beginning of the string, and loads up
2157 $1 with "Foo".  However, as soon as the matching engine sees that there's
2158 no whitespace following the "Foo" that it had saved in $1, it realizes its
2159 mistake and starts over again one character after where it had the
2160 tentative match.  This time it goes all the way until the next occurrence
2161 of "foo". The complete regular expression matches this time, and you get
2162 the expected output of "table follows foo."
2163
2164 Sometimes minimal matching can help a lot.  Imagine you'd like to match
2165 everything between "foo" and "bar".  Initially, you write something
2166 like this:
2167
2168     $_ =  "The food is under the bar in the barn.";
2169     if ( /foo(.*)bar/ ) {
2170         print "got <$1>\n";
2171     }
2172
2173 Which perhaps unexpectedly yields:
2174
2175   got <d is under the bar in the >
2176
2177 That's because C<.*> was greedy, so you get everything between the
2178 I<first> "foo" and the I<last> "bar".  Here it's more effective
2179 to use minimal matching to make sure you get the text between a "foo"
2180 and the first "bar" thereafter.
2181
2182     if ( /foo(.*?)bar/ ) { print "got <$1>\n" }
2183   got <d is under the >
2184
2185 Here's another example. Let's say you'd like to match a number at the end
2186 of a string, and you also want to keep the preceding part of the match.
2187 So you write this:
2188
2189     $_ = "I have 2 numbers: 53147";
2190     if ( /(.*)(\d*)/ ) {                                # Wrong!
2191         print "Beginning is <$1>, number is <$2>.\n";
2192     }
2193
2194 That won't work at all, because C<.*> was greedy and gobbled up the
2195 whole string. As C<\d*> can match on an empty string the complete
2196 regular expression matched successfully.
2197
2198     Beginning is <I have 2 numbers: 53147>, number is <>.
2199
2200 Here are some variants, most of which don't work:
2201
2202     $_ = "I have 2 numbers: 53147";
2203     @pats = qw{
2204         (.*)(\d*)
2205         (.*)(\d+)
2206         (.*?)(\d*)
2207         (.*?)(\d+)
2208         (.*)(\d+)$
2209         (.*?)(\d+)$
2210         (.*)\b(\d+)$
2211         (.*\D)(\d+)$
2212     };
2213
2214     for $pat (@pats) {
2215         printf "%-12s ", $pat;
2216         if ( /$pat/ ) {
2217             print "<$1> <$2>\n";
2218         } else {
2219             print "FAIL\n";
2220         }
2221     }
2222
2223 That will print out:
2224
2225     (.*)(\d*)    <I have 2 numbers: 53147> <>
2226     (.*)(\d+)    <I have 2 numbers: 5314> <7>
2227     (.*?)(\d*)   <> <>
2228     (.*?)(\d+)   <I have > <2>
2229     (.*)(\d+)$   <I have 2 numbers: 5314> <7>
2230     (.*?)(\d+)$  <I have 2 numbers: > <53147>
2231     (.*)\b(\d+)$ <I have 2 numbers: > <53147>
2232     (.*\D)(\d+)$ <I have 2 numbers: > <53147>
2233
2234 As you see, this can be a bit tricky.  It's important to realize that a
2235 regular expression is merely a set of assertions that gives a definition
2236 of success.  There may be 0, 1, or several different ways that the
2237 definition might succeed against a particular string.  And if there are
2238 multiple ways it might succeed, you need to understand backtracking to
2239 know which variety of success you will achieve.
2240
2241 When using look-ahead assertions and negations, this can all get even
2242 trickier.  Imagine you'd like to find a sequence of non-digits not
2243 followed by "123".  You might try to write that as
2244
2245     $_ = "ABC123";
2246     if ( /^\D*(?!123)/ ) {                # Wrong!
2247         print "Yup, no 123 in $_\n";
2248     }
2249
2250 But that isn't going to match; at least, not the way you're hoping.  It
2251 claims that there is no 123 in the string.  Here's a clearer picture of
2252 why that pattern matches, contrary to popular expectations:
2253
2254     $x = 'ABC123';
2255     $y = 'ABC445';
2256
2257     print "1: got $1\n" if $x =~ /^(ABC)(?!123)/;
2258     print "2: got $1\n" if $y =~ /^(ABC)(?!123)/;
2259
2260     print "3: got $1\n" if $x =~ /^(\D*)(?!123)/;
2261     print "4: got $1\n" if $y =~ /^(\D*)(?!123)/;
2262
2263 This prints
2264
2265     2: got ABC
2266     3: got AB
2267     4: got ABC
2268
2269 You might have expected test 3 to fail because it seems to a more
2270 general purpose version of test 1.  The important difference between
2271 them is that test 3 contains a quantifier (C<\D*>) and so can use
2272 backtracking, whereas test 1 will not.  What's happening is
2273 that you've asked "Is it true that at the start of $x, following 0 or more
2274 non-digits, you have something that's not 123?"  If the pattern matcher had
2275 let C<\D*> expand to "ABC", this would have caused the whole pattern to
2276 fail.
2277
2278 The search engine will initially match C<\D*> with "ABC".  Then it will
2279 try to match C<(?!123)> with "123", which fails.  But because
2280 a quantifier (C<\D*>) has been used in the regular expression, the
2281 search engine can backtrack and retry the match differently
2282 in the hope of matching the complete regular expression.
2283
2284 The pattern really, I<really> wants to succeed, so it uses the
2285 standard pattern back-off-and-retry and lets C<\D*> expand to just "AB" this
2286 time.  Now there's indeed something following "AB" that is not
2287 "123".  It's "C123", which suffices.
2288
2289 We can deal with this by using both an assertion and a negation.
2290 We'll say that the first part in $1 must be followed both by a digit
2291 and by something that's not "123".  Remember that the look-aheads
2292 are zero-width expressions--they only look, but don't consume any
2293 of the string in their match.  So rewriting this way produces what
2294 you'd expect; that is, case 5 will fail, but case 6 succeeds:
2295
2296     print "5: got $1\n" if $x =~ /^(\D*)(?=\d)(?!123)/;
2297     print "6: got $1\n" if $y =~ /^(\D*)(?=\d)(?!123)/;
2298
2299     6: got ABC
2300
2301 In other words, the two zero-width assertions next to each other work as though
2302 they're ANDed together, just as you'd use any built-in assertions:  C</^$/>
2303 matches only if you're at the beginning of the line AND the end of the
2304 line simultaneously.  The deeper underlying truth is that juxtaposition in
2305 regular expressions always means AND, except when you write an explicit OR
2306 using the vertical bar.  C</ab/> means match "a" AND (then) match "b",
2307 although the attempted matches are made at different positions because "a"
2308 is not a zero-width assertion, but a one-width assertion.
2309
2310 B<WARNING>: Particularly complicated regular expressions can take
2311 exponential time to solve because of the immense number of possible
2312 ways they can use backtracking to try for a match.  For example, without
2313 internal optimizations done by the regular expression engine, this will
2314 take a painfully long time to run:
2315
2316     'aaaaaaaaaaaa' =~ /((a{0,5}){0,5})*[c]/
2317
2318 And if you used C<*>'s in the internal groups instead of limiting them
2319 to 0 through 5 matches, then it would take forever--or until you ran
2320 out of stack space.  Moreover, these internal optimizations are not
2321 always applicable.  For example, if you put C<{0,5}> instead of C<*>
2322 on the external group, no current optimization is applicable, and the
2323 match takes a long time to finish.
2324
2325 A powerful tool for optimizing such beasts is what is known as an
2326 "independent group",
2327 which does not backtrack (see L</C<< (?>pattern) >>>).  Note also that
2328 zero-length look-ahead/look-behind assertions will not backtrack to make
2329 the tail match, since they are in "logical" context: only
2330 whether they match is considered relevant.  For an example
2331 where side-effects of look-ahead I<might> have influenced the
2332 following match, see L</C<< (?>pattern) >>>.
2333
2334 =head2 Version 8 Regular Expressions
2335 X<regular expression, version 8> X<regex, version 8> X<regexp, version 8>
2336
2337 In case you're not familiar with the "regular" Version 8 regex
2338 routines, here are the pattern-matching rules not described above.
2339
2340 Any single character matches itself, unless it is a I<metacharacter>
2341 with a special meaning described here or above.  You can cause
2342 characters that normally function as metacharacters to be interpreted
2343 literally by prefixing them with a "\" (e.g., "\." matches a ".", not any
2344 character; "\\" matches a "\"). This escape mechanism is also required
2345 for the character used as the pattern delimiter.
2346
2347 A series of characters matches that series of characters in the target
2348 string, so the pattern C<blurfl> would match "blurfl" in the target
2349 string.
2350
2351 You can specify a character class, by enclosing a list of characters
2352 in C<[]>, which will match any character from the list.  If the
2353 first character after the "[" is "^", the class matches any character not
2354 in the list.  Within a list, the "-" character specifies a
2355 range, so that C<a-z> represents all characters between "a" and "z",
2356 inclusive.  If you want either "-" or "]" itself to be a member of a
2357 class, put it at the start of the list (possibly after a "^"), or
2358 escape it with a backslash.  "-" is also taken literally when it is
2359 at the end of the list, just before the closing "]".  (The
2360 following all specify the same class of three characters: C<[-az]>,
2361 C<[az-]>, and C<[a\-z]>.  All are different from C<[a-z]>, which
2362 specifies a class containing twenty-six characters, even on EBCDIC-based
2363 character sets.)  Also, if you try to use the character
2364 classes C<\w>, C<\W>, C<\s>, C<\S>, C<\d>, or C<\D> as endpoints of
2365 a range, the "-" is understood literally.
2366
2367 Note also that the whole range idea is rather unportable between
2368 character sets--and even within character sets they may cause results
2369 you probably didn't expect.  A sound principle is to use only ranges
2370 that begin from and end at either alphabetics of equal case ([a-e],
2371 [A-E]), or digits ([0-9]).  Anything else is unsafe.  If in doubt,
2372 spell out the character sets in full.
2373
2374 Characters may be specified using a metacharacter syntax much like that
2375 used in C: "\n" matches a newline, "\t" a tab, "\r" a carriage return,
2376 "\f" a form feed, etc.  More generally, \I<nnn>, where I<nnn> is a string
2377 of three octal digits, matches the character whose coded character set value
2378 is I<nnn>.  Similarly, \xI<nn>, where I<nn> are hexadecimal digits,
2379 matches the character whose ordinal is I<nn>. The expression \cI<x>
2380 matches the character control-I<x>.  Finally, the "." metacharacter
2381 matches any character except "\n" (unless you use C</s>).
2382
2383 You can specify a series of alternatives for a pattern using "|" to
2384 separate them, so that C<fee|fie|foe> will match any of "fee", "fie",
2385 or "foe" in the target string (as would C<f(e|i|o)e>).  The
2386 first alternative includes everything from the last pattern delimiter
2387 ("(", "(?:", etc. or the beginning of the pattern) up to the first "|", and
2388 the last alternative contains everything from the last "|" to the next
2389 closing pattern delimiter.  That's why it's common practice to include
2390 alternatives in parentheses: to minimize confusion about where they
2391 start and end.
2392
2393 Alternatives are tried from left to right, so the first
2394 alternative found for which the entire expression matches, is the one that
2395 is chosen. This means that alternatives are not necessarily greedy. For
2396 example: when matching C<foo|foot> against "barefoot", only the "foo"
2397 part will match, as that is the first alternative tried, and it successfully
2398 matches the target string. (This might not seem important, but it is
2399 important when you are capturing matched text using parentheses.)
2400
2401 Also remember that "|" is interpreted as a literal within square brackets,
2402 so if you write C<[fee|fie|foe]> you're really only matching C<[feio|]>.
2403
2404 Within a pattern, you may designate subpatterns for later reference
2405 by enclosing them in parentheses, and you may refer back to the
2406 I<n>th subpattern later in the pattern using the metacharacter
2407 \I<n> or \gI<n>.  Subpatterns are numbered based on the left to right order
2408 of their opening parenthesis.  A backreference matches whatever
2409 actually matched the subpattern in the string being examined, not
2410 the rules for that subpattern.  Therefore, C<(0|0x)\d*\s\g1\d*> will
2411 match "0x1234 0x4321", but not "0x1234 01234", because subpattern
2412 1 matched "0x", even though the rule C<0|0x> could potentially match
2413 the leading 0 in the second number.
2414
2415 =head2 Warning on \1 Instead of $1
2416
2417 Some people get too used to writing things like:
2418
2419     $pattern =~ s/(\W)/\\\1/g;
2420
2421 This is grandfathered (for \1 to \9) for the RHS of a substitute to avoid
2422 shocking the
2423 B<sed> addicts, but it's a dirty habit to get into.  That's because in
2424 PerlThink, the righthand side of an C<s///> is a double-quoted string.  C<\1> in
2425 the usual double-quoted string means a control-A.  The customary Unix
2426 meaning of C<\1> is kludged in for C<s///>.  However, if you get into the habit
2427 of doing that, you get yourself into trouble if you then add an C</e>
2428 modifier.
2429
2430     s/(\d+)/ \1 + 1 /eg;            # causes warning under -w
2431
2432 Or if you try to do
2433
2434     s/(\d+)/\1000/;
2435
2436 You can't disambiguate that by saying C<\{1}000>, whereas you can fix it with
2437 C<${1}000>.  The operation of interpolation should not be confused
2438 with the operation of matching a backreference.  Certainly they mean two
2439 different things on the I<left> side of the C<s///>.
2440
2441 =head2 Repeated Patterns Matching a Zero-length Substring
2442
2443 B<WARNING>: Difficult material (and prose) ahead.  This section needs a rewrite.
2444
2445 Regular expressions provide a terse and powerful programming language.  As
2446 with most other power tools, power comes together with the ability
2447 to wreak havoc.
2448
2449 A common abuse of this power stems from the ability to make infinite
2450 loops using regular expressions, with something as innocuous as:
2451
2452     'foo' =~ m{ ( o? )* }x;
2453
2454 The C<o?> matches at the beginning of C<'foo'>, and since the position
2455 in the string is not moved by the match, C<o?> would match again and again
2456 because of the C<*> quantifier.  Another common way to create a similar cycle
2457 is with the looping modifier C<//g>:
2458
2459     @matches = ( 'foo' =~ m{ o? }xg );
2460
2461 or
2462
2463     print "match: <$&>\n" while 'foo' =~ m{ o? }xg;
2464
2465 or the loop implied by split().
2466
2467 However, long experience has shown that many programming tasks may
2468 be significantly simplified by using repeated subexpressions that
2469 may match zero-length substrings.  Here's a simple example being:
2470
2471     @chars = split //, $string;           # // is not magic in split
2472     ($whitewashed = $string) =~ s/()/ /g; # parens avoid magic s// /
2473
2474 Thus Perl allows such constructs, by I<forcefully breaking
2475 the infinite loop>.  The rules for this are different for lower-level
2476 loops given by the greedy quantifiers C<*+{}>, and for higher-level
2477 ones like the C</g> modifier or split() operator.
2478
2479 The lower-level loops are I<interrupted> (that is, the loop is
2480 broken) when Perl detects that a repeated expression matched a
2481 zero-length substring.   Thus
2482
2483    m{ (?: NON_ZERO_LENGTH | ZERO_LENGTH )* }x;
2484
2485 is made equivalent to
2486
2487    m{ (?: NON_ZERO_LENGTH )* (?: ZERO_LENGTH )? }x;
2488
2489 For example, this program
2490
2491    #!perl -l
2492    "aaaaab" =~ /
2493      (?:
2494         a                 # non-zero
2495         |                 # or
2496        (?{print "hello"}) # print hello whenever this
2497                           #    branch is tried
2498        (?=(b))            # zero-width assertion
2499      )*  # any number of times
2500     /x;
2501    print $&;
2502    print $1;
2503
2504 prints
2505
2506    hello
2507    aaaaa
2508    b
2509
2510 Notice that "hello" is only printed once, as when Perl sees that the sixth
2511 iteration of the outermost C<(?:)*> matches a zero-length string, it stops
2512 the C<*>.
2513
2514 The higher-level loops preserve an additional state between iterations:
2515 whether the last match was zero-length.  To break the loop, the following
2516 match after a zero-length match is prohibited to have a length of zero.
2517 This prohibition interacts with backtracking (see L<"Backtracking">),
2518 and so the I<second best> match is chosen if the I<best> match is of
2519 zero length.
2520
2521 For example:
2522
2523     $_ = 'bar';
2524     s/\w??/<$&>/g;
2525
2526 results in C<< <><b><><a><><r><> >>.  At each position of the string the best
2527 match given by non-greedy C<??> is the zero-length match, and the I<second
2528 best> match is what is matched by C<\w>.  Thus zero-length matches
2529 alternate with one-character-long matches.
2530
2531 Similarly, for repeated C<m/()/g> the second-best match is the match at the
2532 position one notch further in the string.
2533
2534 The additional state of being I<matched with zero-length> is associated with
2535 the matched string, and is reset by each assignment to pos().
2536 Zero-length matches at the end of the previous match are ignored
2537 during C<split>.
2538
2539 =head2 Combining RE Pieces
2540
2541 Each of the elementary pieces of regular expressions which were described
2542 before (such as C<ab> or C<\Z>) could match at most one substring
2543 at the given position of the input string.  However, in a typical regular
2544 expression these elementary pieces are combined into more complicated
2545 patterns using combining operators C<ST>, C<S|T>, C<S*> etc.
2546 (in these examples C<S> and C<T> are regular subexpressions).
2547
2548 Such combinations can include alternatives, leading to a problem of choice:
2549 if we match a regular expression C<a|ab> against C<"abc">, will it match
2550 substring C<"a"> or C<"ab">?  One way to describe which substring is
2551 actually matched is the concept of backtracking (see L<"Backtracking">).
2552 However, this description is too low-level and makes you think
2553 in terms of a particular implementation.
2554
2555 Another description starts with notions of "better"/"worse".  All the
2556 substrings which may be matched by the given regular expression can be
2557 sorted from the "best" match to the "worst" match, and it is the "best"
2558 match which is chosen.  This substitutes the question of "what is chosen?"
2559 by the question of "which matches are better, and which are worse?".
2560
2561 Again, for elementary pieces there is no such question, since at most
2562 one match at a given position is possible.  This section describes the
2563 notion of better/worse for combining operators.  In the description
2564 below C<S> and C<T> are regular subexpressions.
2565
2566 =over 4
2567
2568 =item C<ST>
2569
2570 Consider two possible matches, C<AB> and C<A'B'>, C<A> and C<A'> are
2571 substrings which can be matched by C<S>, C<B> and C<B'> are substrings
2572 which can be matched by C<T>.
2573
2574 If C<A> is a better match for C<S> than C<A'>, C<AB> is a better
2575 match than C<A'B'>.
2576
2577 If C<A> and C<A'> coincide: C<AB> is a better match than C<AB'> if
2578 C<B> is a better match for C<T> than C<B'>.
2579
2580 =item C<S|T>
2581
2582 When C<S> can match, it is a better match than when only C<T> can match.
2583
2584 Ordering of two matches for C<S> is the same as for C<S>.  Similar for
2585 two matches for C<T>.
2586
2587 =item C<S{REPEAT_COUNT}>
2588
2589 Matches as C<SSS...S> (repeated as many times as necessary).
2590
2591 =item C<S{min,max}>
2592
2593 Matches as C<S{max}|S{max-1}|...|S{min+1}|S{min}>.
2594
2595 =item C<S{min,max}?>
2596
2597 Matches as C<S{min}|S{min+1}|...|S{max-1}|S{max}>.
2598
2599 =item C<S?>, C<S*>, C<S+>
2600
2601 Same as C<S{0,1}>, C<S{0,BIG_NUMBER}>, C<S{1,BIG_NUMBER}> respectively.
2602
2603 =item C<S??>, C<S*?>, C<S+?>
2604
2605 Same as C<S{0,1}?>, C<S{0,BIG_NUMBER}?>, C<S{1,BIG_NUMBER}?> respectively.
2606
2607 =item C<< (?>S) >>
2608
2609 Matches the best match for C<S> and only that.
2610
2611 =item C<(?=S)>, C<(?<=S)>
2612
2613 Only the best match for C<S> is considered.  (This is important only if
2614 C<S> has capturing parentheses, and backreferences are used somewhere
2615 else in the whole regular expression.)
2616
2617 =item C<(?!S)>, C<(?<!S)>
2618
2619 For this grouping operator there is no need to describe the ordering, since
2620 only whether or not C<S> can match is important.
2621
2622 =item C<(??{ EXPR })>, C<(?PARNO)>
2623
2624 The ordering is the same as for the regular expression which is
2625 the result of EXPR, or the pattern contained by capture group PARNO.
2626
2627 =item C<(?(condition)yes-pattern|no-pattern)>
2628
2629 Recall that which of C<yes-pattern> or C<no-pattern> actually matches is
2630 already determined.  The ordering of the matches is the same as for the
2631 chosen subexpression.
2632
2633 =back
2634
2635 The above recipes describe the ordering of matches I<at a given position>.
2636 One more rule is needed to understand how a match is determined for the
2637 whole regular expression: a match at an earlier position is always better
2638 than a match at a later position.
2639
2640 =head2 Creating Custom RE Engines
2641
2642 As of Perl 5.10.0, one can create custom regular expression engines.  This
2643 is not for the faint of heart, as they have to plug in at the C level.  See
2644 L<perlreapi> for more details.
2645
2646 As an alternative, overloaded constants (see L<overload>) provide a simple
2647 way to extend the functionality of the RE engine, by substituting one
2648 pattern for another.
2649
2650 Suppose that we want to enable a new RE escape-sequence C<\Y|> which
2651 matches at a boundary between whitespace characters and non-whitespace
2652 characters.  Note that C<(?=\S)(?<!\S)|(?!\S)(?<=\S)> matches exactly
2653 at these positions, so we want to have each C<\Y|> in the place of the
2654 more complicated version.  We can create a module C<customre> to do
2655 this:
2656
2657     package customre;
2658     use overload;
2659
2660     sub import {
2661       shift;
2662       die "No argument to customre::import allowed" if @_;
2663       overload::constant 'qr' => \&convert;
2664     }
2665
2666     sub invalid { die "/$_[0]/: invalid escape '\\$_[1]'"}
2667
2668     # We must also take care of not escaping the legitimate \\Y|
2669     # sequence, hence the presence of '\\' in the conversion rules.
2670     my %rules = ( '\\' => '\\\\',
2671                   'Y|' => qr/(?=\S)(?<!\S)|(?!\S)(?<=\S)/ );
2672     sub convert {
2673       my $re = shift;
2674       $re =~ s{
2675                 \\ ( \\ | Y . )
2676               }
2677               { $rules{$1} or invalid($re,$1) }sgex;
2678       return $re;
2679     }
2680
2681 Now C<use customre> enables the new escape in constant regular
2682 expressions, i.e., those without any runtime variable interpolations.
2683 As documented in L<overload>, this conversion will work only over
2684 literal parts of regular expressions.  For C<\Y|$re\Y|> the variable
2685 part of this regular expression needs to be converted explicitly
2686 (but only if the special meaning of C<\Y|> should be enabled inside $re):
2687
2688     use customre;
2689     $re = <>;
2690     chomp $re;
2691     $re = customre::convert $re;
2692     /\Y|$re\Y|/;
2693
2694 =head2 PCRE/Python Support
2695
2696 As of Perl 5.10.0, Perl supports several Python/PCRE-specific extensions
2697 to the regex syntax. While Perl programmers are encouraged to use the
2698 Perl-specific syntax, the following are also accepted:
2699
2700 =over 4
2701
2702 =item C<< (?PE<lt>NAMEE<gt>pattern) >>
2703
2704 Define a named capture group. Equivalent to C<< (?<NAME>pattern) >>.
2705
2706 =item C<< (?P=NAME) >>
2707
2708 Backreference to a named capture group. Equivalent to C<< \g{NAME} >>.
2709
2710 =item C<< (?P>NAME) >>
2711
2712 Subroutine call to a named capture group. Equivalent to C<< (?&NAME) >>.
2713
2714 =back
2715
2716 =head1 BUGS
2717
2718 Many regular expression constructs don't work on EBCDIC platforms.
2719
2720 There are a number of issues with regard to case-insensitive matching
2721 in Unicode rules.  See C<i> under L</Modifiers> above.
2722
2723 This document varies from difficult to understand to completely
2724 and utterly opaque.  The wandering prose riddled with jargon is
2725 hard to fathom in several places.
2726
2727 This document needs a rewrite that separates the tutorial content
2728 from the reference content.
2729
2730 =head1 SEE ALSO
2731
2732 L<perlrequick>.
2733
2734 L<perlretut>.
2735
2736 L<perlop/"Regexp Quote-Like Operators">.
2737
2738 L<perlop/"Gory details of parsing quoted constructs">.
2739
2740 L<perlfaq6>.
2741
2742 L<perlfunc/pos>.
2743
2744 L<perllocale>.
2745
2746 L<perlebcdic>.
2747
2748 I<Mastering Regular Expressions> by Jeffrey Friedl, published
2749 by O'Reilly and Associates.