This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
0f9ded3d0ca711494f49f7be67a8183d0c21451c
[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 the string to matching the start or end of any
35 line 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 /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 C<use locale> is in effect, the case map is taken from the current
55 locale.  See L<perllocale>.
56
57 =item x
58 X</x>
59
60 Extend your pattern's legibility by permitting whitespace and comments.
61
62 =item p
63 X</p> X<regex, preserve> X<regexp, preserve>
64
65 Preserve the string matched such that ${^PREMATCH}, {$^MATCH}, and
66 ${^POSTMATCH} are available for use after matching.
67
68 =back
69
70 These are usually written as "the C</x> modifier", even though the delimiter
71 in question might not really be a slash.  Any of these
72 modifiers may also be embedded within the regular expression itself using
73 the C<(?...)> construct.  See below.
74
75 The C</x> modifier itself needs a little more explanation.  It tells
76 the regular expression parser to ignore whitespace that is neither
77 backslashed nor within a character class.  You can use this to break up
78 your regular expression into (slightly) more readable parts.  The C<#>
79 character is also treated as a metacharacter introducing a comment,
80 just as in ordinary Perl code.  This also means that if you want real
81 whitespace or C<#> characters in the pattern (outside a character
82 class, where they are unaffected by C</x>), then you'll either have to
83 escape them (using backslashes or C<\Q...\E>) or encode them using octal
84 or hex escapes.  Taken together, these features go a long way towards
85 making Perl's regular expressions more readable.  Note that you have to
86 be careful not to include the pattern delimiter in the comment--perl has
87 no way of knowing you did not intend to close the pattern early.  See
88 the C-comment deletion code in L<perlop>.  Also note that anything inside
89 a C<\Q...\E> stays unaffected by C</x>.
90 X</x>
91
92 =head2 Regular Expressions
93
94 =head3 Metacharacters
95
96 The patterns used in Perl pattern matching evolved from the ones supplied in
97 the Version 8 regex routines.  (The routines are derived
98 (distantly) from Henry Spencer's freely redistributable reimplementation
99 of the V8 routines.)  See L<Version 8 Regular Expressions> for
100 details.
101
102 In particular the following metacharacters have their standard I<egrep>-ish
103 meanings:
104 X<metacharacter>
105 X<\> X<^> X<.> X<$> X<|> X<(> X<()> X<[> X<[]>
106
107
108     \   Quote the next metacharacter
109     ^   Match the beginning of the line
110     .   Match any character (except newline)
111     $   Match the end of the line (or before newline at the end)
112     |   Alternation
113     ()  Grouping
114     []  Character class
115
116 By default, the "^" character is guaranteed to match only the
117 beginning of the string, the "$" character only the end (or before the
118 newline at the end), and Perl does certain optimizations with the
119 assumption that the string contains only one line.  Embedded newlines
120 will not be matched by "^" or "$".  You may, however, wish to treat a
121 string as a multi-line buffer, such that the "^" will match after any
122 newline within the string (except if the newline is the last character in
123 the string), and "$" will match before any newline.  At the
124 cost of a little more overhead, you can do this by using the /m modifier
125 on the pattern match operator.  (Older programs did this by setting C<$*>,
126 but this practice has been removed in perl 5.9.)
127 X<^> X<$> X</m>
128
129 To simplify multi-line substitutions, the "." character never matches a
130 newline unless you use the C</s> modifier, which in effect tells Perl to pretend
131 the string is a single line--even if it isn't.
132 X<.> X</s>
133
134 =head3 Quantifiers
135
136 The following standard quantifiers are recognized:
137 X<metacharacter> X<quantifier> X<*> X<+> X<?> X<{n}> X<{n,}> X<{n,m}>
138
139     *      Match 0 or more times
140     +      Match 1 or more times
141     ?      Match 1 or 0 times
142     {n}    Match exactly n times
143     {n,}   Match at least n times
144     {n,m}  Match at least n but not more than m times
145
146 (If a curly bracket occurs in any other context, it is treated
147 as a regular character.  In particular, the lower bound
148 is not optional.)  The "*" quantifier is equivalent to C<{0,}>, the "+"
149 quantifier to C<{1,}>, and the "?" quantifier to C<{0,1}>.  n and m are limited
150 to integral values less than a preset limit defined when perl is built.
151 This is usually 32766 on the most common platforms.  The actual limit can
152 be seen in the error message generated by code such as this:
153
154     $_ **= $_ , / {$_} / for 2 .. 42;
155
156 By default, a quantified subpattern is "greedy", that is, it will match as
157 many times as possible (given a particular starting location) while still
158 allowing the rest of the pattern to match.  If you want it to match the
159 minimum number of times possible, follow the quantifier with a "?".  Note
160 that the meanings don't change, just the "greediness":
161 X<metacharacter> X<greedy> X<greediness>
162 X<?> X<*?> X<+?> X<??> X<{n}?> X<{n,}?> X<{n,m}?>
163
164     *?     Match 0 or more times, not greedily
165     +?     Match 1 or more times, not greedily
166     ??     Match 0 or 1 time, not greedily
167     {n}?   Match exactly n times, not greedily
168     {n,}?  Match at least n times, not greedily
169     {n,m}? Match at least n but not more than m times, not greedily
170
171 By default, when a quantified subpattern does not allow the rest of the
172 overall pattern to match, Perl will backtrack. However, this behaviour is
173 sometimes undesirable. Thus Perl provides the "possessive" quantifier form
174 as well.
175
176     *+     Match 0 or more times and give nothing back
177     ++     Match 1 or more times and give nothing back
178     ?+     Match 0 or 1 time and give nothing back
179     {n}+   Match exactly n times and give nothing back (redundant)
180     {n,}+  Match at least n times and give nothing back
181     {n,m}+ Match at least n but not more than m times and give nothing back
182
183 For instance,
184
185    'aaaa' =~ /a++a/
186
187 will never match, as the C<a++> will gobble up all the C<a>'s in the
188 string and won't leave any for the remaining part of the pattern. This
189 feature can be extremely useful to give perl hints about where it
190 shouldn't backtrack. For instance, the typical "match a double-quoted
191 string" problem can be most efficiently performed when written as:
192
193    /"(?:[^"\\]++|\\.)*+"/
194
195 as we know that if the final quote does not match, backtracking will not
196 help. See the independent subexpression C<< (?>...) >> for more details;
197 possessive quantifiers are just syntactic sugar for that construct. For
198 instance the above example could also be written as follows:
199
200    /"(?>(?:(?>[^"\\]+)|\\.)*)"/
201
202 =head3 Escape sequences
203
204 Because patterns are processed as double quoted strings, the following
205 also work:
206 X<\t> X<\n> X<\r> X<\f> X<\e> X<\a> X<\l> X<\u> X<\L> X<\U> X<\E> X<\Q>
207 X<\0> X<\c> X<\N> X<\x>
208
209     \t          tab                   (HT, TAB)
210     \n          newline               (LF, NL)
211     \r          return                (CR)
212     \f          form feed             (FF)
213     \a          alarm (bell)          (BEL)
214     \e          escape (think troff)  (ESC)
215     \033        octal char            (example: ESC)
216     \x1B        hex char              (example: ESC)
217     \x{263a}    wide hex char         (example: Unicode SMILEY)
218     \cK         control char          (example: VT)
219     \N{name}    named char
220     \l          lowercase next char (think vi)
221     \u          uppercase next char (think vi)
222     \L          lowercase till \E (think vi)
223     \U          uppercase till \E (think vi)
224     \E          end case modification (think vi)
225     \Q          quote (disable) pattern metacharacters till \E
226
227 If C<use locale> is in effect, the case map used by C<\l>, C<\L>, C<\u>
228 and C<\U> is taken from the current locale.  See L<perllocale>.  For
229 documentation of C<\N{name}>, see L<charnames>.
230
231 You cannot include a literal C<$> or C<@> within a C<\Q> sequence.
232 An unescaped C<$> or C<@> interpolates the corresponding variable,
233 while escaping will cause the literal string C<\$> to be matched.
234 You'll need to write something like C<m/\Quser\E\@\Qhost/>.
235
236 =head3 Character Classes and other Special Escapes
237
238 In addition, Perl defines the following:
239 X<\w> X<\W> X<\s> X<\S> X<\d> X<\D> X<\X> X<\p> X<\P> X<\C>
240 X<\g> X<\k> X<\N> X<\K> X<\v> X<\V>
241 X<word> X<whitespace> X<character class> X<backreference>
242
243     \w       Match a "word" character (alphanumeric plus "_")
244     \W       Match a non-"word" character
245     \s       Match a whitespace character
246     \S       Match a non-whitespace character
247     \d       Match a digit character
248     \D       Match a non-digit character
249     \pP      Match P, named property.  Use \p{Prop} for longer names.
250     \PP      Match non-P
251     \X       Match eXtended Unicode "combining character sequence",
252              equivalent to (?:\PM\pM*)
253     \C       Match a single C char (octet) even under Unicode.
254              NOTE: breaks up characters into their UTF-8 bytes,
255              so you may end up with malformed pieces of UTF-8.
256              Unsupported in lookbehind.
257     \1       Backreference to a specific group.
258              '1' may actually be any positive integer.
259     \g1      Backreference to a specific or previous group,
260     \g{-1}   number may be negative indicating a previous buffer and may
261              optionally be wrapped in curly brackets for safer parsing.
262     \g{name} Named backreference
263     \k<name> Named backreference
264     \N{name} Named Unicode character, or Unicode escape
265     \x12     Hexadecimal escape sequence
266     \x{1234} Long hexadecimal escape sequence
267     \K       Keep the stuff left of the \K, don't include it in $&
268     \v       Vertical whitespace
269     \V       Not vertical whitespace
270     \h       Horizontal whitespace
271     \H       Not horizontal whitespace
272     \R       Linebreak
273
274 A C<\w> matches a single alphanumeric character (an alphabetic
275 character, or a decimal digit) or C<_>, not a whole word.  Use C<\w+>
276 to match a string of Perl-identifier characters (which isn't the same
277 as matching an English word).  If C<use locale> is in effect, the list
278 of alphabetic characters generated by C<\w> is taken from the current
279 locale.  See L<perllocale>.  You may use C<\w>, C<\W>, C<\s>, C<\S>,
280 C<\d>, and C<\D> within character classes, but they aren't usable
281 as either end of a range. If any of them precedes or follows a "-",
282 the "-" is understood literally. If Unicode is in effect, C<\s> matches
283 also "\x{85}", "\x{2028}", and "\x{2029}". See L<perlunicode> for more
284 details about C<\pP>, C<\PP>, C<\X> and the possibility of defining
285 your own C<\p> and C<\P> properties, and L<perluniintro> about Unicode
286 in general.
287 X<\w> X<\W> X<word>
288
289 C<\R> will atomically match a linebreak, including the network line-ending
290 "\x0D\x0A".  Specifically, X<\R> is exactly equivelent to
291
292   (?>\x0D\x0A?|[\x0A-\x0C\x85\x{2028}\x{2029}])
293
294 B<Note:> C<\R> has no special meaning inside of a character class;
295 use C<\v> instead (vertical whitespace).
296 X<\R>
297
298 The POSIX character class syntax
299 X<character class>
300
301     [:class:]
302
303 is also available.  Note that the C<[> and C<]> brackets are I<literal>;
304 they must always be used within a character class expression.
305
306     # this is correct:
307     $string =~ /[[:alpha:]]/;
308
309     # this is not, and will generate a warning:
310     $string =~ /[:alpha:]/;
311
312 The available classes and their backslash equivalents (if available) are
313 as follows:
314 X<character class>
315 X<alpha> X<alnum> X<ascii> X<blank> X<cntrl> X<digit> X<graph>
316 X<lower> X<print> X<punct> X<space> X<upper> X<word> X<xdigit>
317
318     alpha
319     alnum
320     ascii
321     blank               [1]
322     cntrl
323     digit       \d
324     graph
325     lower
326     print
327     punct
328     space       \s      [2]
329     upper
330     word        \w      [3]
331     xdigit
332
333 =over
334
335 =item [1]
336
337 A GNU extension equivalent to C<[ \t]>, "all horizontal whitespace".
338
339 =item [2]
340
341 Not exactly equivalent to C<\s> since the C<[[:space:]]> includes
342 also the (very rare) "vertical tabulator", "\cK" or chr(11) in ASCII.
343
344 =item [3]
345
346 A Perl extension, see above.
347
348 =back
349
350 For example use C<[:upper:]> to match all the uppercase characters.
351 Note that the C<[]> are part of the C<[::]> construct, not part of the
352 whole character class.  For example:
353
354     [01[:alpha:]%]
355
356 matches zero, one, any alphabetic character, and the percent sign.
357
358 The following equivalences to Unicode \p{} constructs and equivalent
359 backslash character classes (if available), will hold:
360 X<character class> X<\p> X<\p{}>
361
362     [[:...:]]   \p{...}         backslash
363
364     alpha       IsAlpha
365     alnum       IsAlnum
366     ascii       IsASCII
367     blank
368     cntrl       IsCntrl
369     digit       IsDigit        \d
370     graph       IsGraph
371     lower       IsLower
372     print       IsPrint
373     punct       IsPunct
374     space       IsSpace
375                 IsSpacePerl    \s
376     upper       IsUpper
377     word        IsWord
378     xdigit      IsXDigit
379
380 For example C<[[:lower:]]> and C<\p{IsLower}> are equivalent.
381
382 If the C<utf8> pragma is not used but the C<locale> pragma is, the
383 classes correlate with the usual isalpha(3) interface (except for
384 "word" and "blank").
385
386 The assumedly non-obviously named classes are:
387
388 =over 4
389
390 =item cntrl
391 X<cntrl>
392
393 Any control character.  Usually characters that don't produce output as
394 such but instead control the terminal somehow: for example newline and
395 backspace are control characters.  All characters with ord() less than
396 32 are usually classified as control characters (assuming ASCII,
397 the ISO Latin character sets, and Unicode), as is the character with
398 the ord() value of 127 (C<DEL>).
399
400 =item graph
401 X<graph>
402
403 Any alphanumeric or punctuation (special) character.
404
405 =item print
406 X<print>
407
408 Any alphanumeric or punctuation (special) character or the space character.
409
410 =item punct
411 X<punct>
412
413 Any punctuation (special) character.
414
415 =item xdigit
416 X<xdigit>
417
418 Any hexadecimal digit.  Though this may feel silly ([0-9A-Fa-f] would
419 work just fine) it is included for completeness.
420
421 =back
422
423 You can negate the [::] character classes by prefixing the class name
424 with a '^'. This is a Perl extension.  For example:
425 X<character class, negation>
426
427     POSIX         traditional  Unicode
428
429     [[:^digit:]]    \D         \P{IsDigit}
430     [[:^space:]]    \S         \P{IsSpace}
431     [[:^word:]]     \W         \P{IsWord}
432
433 Perl respects the POSIX standard in that POSIX character classes are
434 only supported within a character class.  The POSIX character classes
435 [.cc.] and [=cc=] are recognized but B<not> supported and trying to
436 use them will cause an error.
437
438 =head3 Assertions
439
440 Perl defines the following zero-width assertions:
441 X<zero-width assertion> X<assertion> X<regex, zero-width assertion>
442 X<regexp, zero-width assertion>
443 X<regular expression, zero-width assertion>
444 X<\b> X<\B> X<\A> X<\Z> X<\z> X<\G>
445
446     \b  Match a word boundary
447     \B  Match except at a word boundary
448     \A  Match only at beginning of string
449     \Z  Match only at end of string, or before newline at the end
450     \z  Match only at end of string
451     \G  Match only at pos() (e.g. at the end-of-match position
452         of prior m//g)
453
454 A word boundary (C<\b>) is a spot between two characters
455 that has a C<\w> on one side of it and a C<\W> on the other side
456 of it (in either order), counting the imaginary characters off the
457 beginning and end of the string as matching a C<\W>.  (Within
458 character classes C<\b> represents backspace rather than a word
459 boundary, just as it normally does in any double-quoted string.)
460 The C<\A> and C<\Z> are just like "^" and "$", except that they
461 won't match multiple times when the C</m> modifier is used, while
462 "^" and "$" will match at every internal line boundary.  To match
463 the actual end of the string and not ignore an optional trailing
464 newline, use C<\z>.
465 X<\b> X<\A> X<\Z> X<\z> X</m>
466
467 The C<\G> assertion can be used to chain global matches (using
468 C<m//g>), as described in L<perlop/"Regexp Quote-Like Operators">.
469 It is also useful when writing C<lex>-like scanners, when you have
470 several patterns that you want to match against consequent substrings
471 of your string, see the previous reference.  The actual location
472 where C<\G> will match can also be influenced by using C<pos()> as
473 an lvalue: see L<perlfunc/pos>. Note that the rule for zero-length
474 matches is modified somewhat, in that contents to the left of C<\G> is
475 not counted when determining the length of the match. Thus the following
476 will not match forever:
477 X<\G>
478
479     $str = 'ABC';
480     pos($str) = 1;
481     while (/.\G/g) {
482         print $&;
483     }
484
485 It will print 'A' and then terminate, as it considers the match to
486 be zero-width, and thus will not match at the same position twice in a
487 row.
488
489 It is worth noting that C<\G> improperly used can result in an infinite
490 loop. Take care when using patterns that include C<\G> in an alternation.
491
492 =head3 Capture buffers
493
494 The bracketing construct C<( ... )> creates capture buffers. To refer
495 to the current contents of a buffer later on, within the same pattern,
496 use \1 for the first, \2 for the second, and so on.
497 Outside the match use "$" instead of "\".  (The
498 \<digit> notation works in certain circumstances outside
499 the match.  See the warning below about \1 vs $1 for details.)
500 Referring back to another part of the match is called a
501 I<backreference>.
502 X<regex, capture buffer> X<regexp, capture buffer>
503 X<regular expression, capture buffer> X<backreference>
504
505 There is no limit to the number of captured substrings that you may
506 use.  However Perl also uses \10, \11, etc. as aliases for \010,
507 \011, etc.  (Recall that 0 means octal, so \011 is the character at
508 number 9 in your coded character set; which would be the 10th character,
509 a horizontal tab under ASCII.)  Perl resolves this
510 ambiguity by interpreting \10 as a backreference only if at least 10
511 left parentheses have opened before it.  Likewise \11 is a
512 backreference only if at least 11 left parentheses have opened
513 before it.  And so on.  \1 through \9 are always interpreted as
514 backreferences.
515
516 X<\g{1}> X<\g{-1}> X<\g{name}> X<relative backreference> X<named backreference>
517 In order to provide a safer and easier way to construct patterns using
518 backreferences, Perl 5.10 provides the C<\g{N}> notation. The curly
519 brackets are optional, however omitting them is less safe as the meaning
520 of the pattern can be changed by text (such as digits) following it.
521 When N is a positive integer the C<\g{N}> notation is exactly equivalent
522 to using normal backreferences. When N is a negative integer then it is
523 a relative backreference referring to the previous N'th capturing group.
524 When the bracket form is used and N is not an integer, it is treated as a
525 reference to a named buffer.
526
527 Thus C<\g{-1}> refers to the last buffer, C<\g{-2}> refers to the
528 buffer before that. For example:
529
530         /
531          (Y)            # buffer 1
532          (              # buffer 2
533             (X)         # buffer 3
534             \g{-1}      # backref to buffer 3
535             \g{-3}      # backref to buffer 1
536          )
537         /x
538
539 and would match the same as C</(Y) ( (X) \3 \1 )/x>.
540
541 Additionally, as of Perl 5.10 you may use named capture buffers and named
542 backreferences. The notation is C<< (?<name>...) >> to declare and C<< \k<name> >>
543 to reference. You may also use apostrophes instead of angle brackets to delimit the
544 name; and you may use the bracketed C<< \g{name} >> backreference syntax.
545 It's possible to refer to a named capture buffer by absolute and relative number as well.
546 Outside the pattern, a named capture buffer is available via the C<%+> hash.
547 When different buffers within the same pattern have the same name, C<$+{name}>
548 and C<< \k<name> >> refer to the leftmost defined group. (Thus it's possible
549 to do things with named capture buffers that would otherwise require C<(??{})>
550 code to accomplish.)
551 X<named capture buffer> X<regular expression, named capture buffer>
552 X<%+> X<$+{name}> X<\k{name}>
553
554 Examples:
555
556     s/^([^ ]*) *([^ ]*)/$2 $1/;     # swap first two words
557
558     /(.)\1/                         # find first doubled char
559          and print "'$1' is the first doubled character\n";
560
561     /(?<char>.)\k<char>/            # ... a different way
562          and print "'$+{char}' is the first doubled character\n";
563
564     /(?'char'.)\1/                  # ... mix and match
565          and print "'$1' is the first doubled character\n";
566
567     if (/Time: (..):(..):(..)/) {   # parse out values
568         $hours = $1;
569         $minutes = $2;
570         $seconds = $3;
571     }
572
573 Several special variables also refer back to portions of the previous
574 match.  C<$+> returns whatever the last bracket match matched.
575 C<$&> returns the entire matched string.  (At one point C<$0> did
576 also, but now it returns the name of the program.)  C<$`> returns
577 everything before the matched string.  C<$'> returns everything
578 after the matched string. And C<$^N> contains whatever was matched by
579 the most-recently closed group (submatch). C<$^N> can be used in
580 extended patterns (see below), for example to assign a submatch to a
581 variable.
582 X<$+> X<$^N> X<$&> X<$`> X<$'>
583
584 The numbered match variables ($1, $2, $3, etc.) and the related punctuation
585 set (C<$+>, C<$&>, C<$`>, C<$'>, and C<$^N>) are all dynamically scoped
586 until the end of the enclosing block or until the next successful
587 match, whichever comes first.  (See L<perlsyn/"Compound Statements">.)
588 X<$+> X<$^N> X<$&> X<$`> X<$'>
589 X<$1> X<$2> X<$3> X<$4> X<$5> X<$6> X<$7> X<$8> X<$9>
590
591
592 B<NOTE>: Failed matches in Perl do not reset the match variables,
593 which makes it easier to write code that tests for a series of more
594 specific cases and remembers the best match.
595
596 B<WARNING>: Once Perl sees that you need one of C<$&>, C<$`>, or
597 C<$'> anywhere in the program, it has to provide them for every
598 pattern match.  This may substantially slow your program.  Perl
599 uses the same mechanism to produce $1, $2, etc, so you also pay a
600 price for each pattern that contains capturing parentheses.  (To
601 avoid this cost while retaining the grouping behaviour, use the
602 extended regular expression C<(?: ... )> instead.)  But if you never
603 use C<$&>, C<$`> or C<$'>, then patterns I<without> capturing
604 parentheses will not be penalized.  So avoid C<$&>, C<$'>, and C<$`>
605 if you can, but if you can't (and some algorithms really appreciate
606 them), once you've used them once, use them at will, because you've
607 already paid the price.  As of 5.005, C<$&> is not so costly as the
608 other two.
609 X<$&> X<$`> X<$'>
610
611 As a workaround for this problem, Perl 5.10 introduces C<${^PREMATCH}>,
612 C<${^MATCH}> and C<${^POSTMATCH}>, which are equivalent to C<$`>, C<$&>
613 and C<$'>, B<except> that they are only guaranteed to be defined after a
614 successful match that was executed with the C</p> (preserve) modifier.
615 The use of these variables incurs no global performance penalty, unlike
616 their punctuation char equivalents, however at the trade-off that you
617 have to tell perl when you want to use them.
618 X</p> X<p modifier>
619
620 Backslashed metacharacters in Perl are alphanumeric, such as C<\b>,
621 C<\w>, C<\n>.  Unlike some other regular expression languages, there
622 are no backslashed symbols that aren't alphanumeric.  So anything
623 that looks like \\, \(, \), \<, \>, \{, or \} is always
624 interpreted as a literal character, not a metacharacter.  This was
625 once used in a common idiom to disable or quote the special meanings
626 of regular expression metacharacters in a string that you want to
627 use for a pattern. Simply quote all non-"word" characters:
628
629     $pattern =~ s/(\W)/\\$1/g;
630
631 (If C<use locale> is set, then this depends on the current locale.)
632 Today it is more common to use the quotemeta() function or the C<\Q>
633 metaquoting escape sequence to disable all metacharacters' special
634 meanings like this:
635
636     /$unquoted\Q$quoted\E$unquoted/
637
638 Beware that if you put literal backslashes (those not inside
639 interpolated variables) between C<\Q> and C<\E>, double-quotish
640 backslash interpolation may lead to confusing results.  If you
641 I<need> to use literal backslashes within C<\Q...\E>,
642 consult L<perlop/"Gory details of parsing quoted constructs">.
643
644 =head2 Extended Patterns
645
646 Perl also defines a consistent extension syntax for features not
647 found in standard tools like B<awk> and B<lex>.  The syntax is a
648 pair of parentheses with a question mark as the first thing within
649 the parentheses.  The character after the question mark indicates
650 the extension.
651
652 The stability of these extensions varies widely.  Some have been
653 part of the core language for many years.  Others are experimental
654 and may change without warning or be completely removed.  Check
655 the documentation on an individual feature to verify its current
656 status.
657
658 A question mark was chosen for this and for the minimal-matching
659 construct because 1) question marks are rare in older regular
660 expressions, and 2) whenever you see one, you should stop and
661 "question" exactly what is going on.  That's psychology...
662
663 =over 10
664
665 =item C<(?#text)>
666 X<(?#)>
667
668 A comment.  The text is ignored.  If the C</x> modifier enables
669 whitespace formatting, a simple C<#> will suffice.  Note that Perl closes
670 the comment as soon as it sees a C<)>, so there is no way to put a literal
671 C<)> in the comment.
672
673 =item C<(?kimsx-imsx)>
674 X<(?)>
675
676 One or more embedded pattern-match modifiers, to be turned on (or
677 turned off, if preceded by C<->) for the remainder of the pattern or
678 the remainder of the enclosing pattern group (if any). This is
679 particularly useful for dynamic patterns, such as those read in from a
680 configuration file, taken from an argument, or specified in a table
681 somewhere.  Consider the case where some patterns want to be case
682 sensitive and some do not:  The case insensitive ones merely need to
683 include C<(?i)> at the front of the pattern.  For example:
684
685     $pattern = "foobar";
686     if ( /$pattern/i ) { }
687
688     # more flexible:
689
690     $pattern = "(?i)foobar";
691     if ( /$pattern/ ) { }
692
693 These modifiers are restored at the end of the enclosing group. For example,
694
695     ( (?i) blah ) \s+ \1
696
697 will match C<blah> in any case, some spaces, and an exact (I<including the case>!)
698 repetition of the previous word, assuming the C</x> modifier, and no C</i>
699 modifier outside this group.
700
701 Note that the C<k> modifier is special in that it can only be enabled,
702 not disabled, and that its presence anywhere in a pattern has a global
703 effect. Thus C<(?-k)> and C<(?-k:...)> are meaningless and will warn
704 when executed under C<use warnings>.
705
706 =item C<(?:pattern)>
707 X<(?:)>
708
709 =item C<(?imsx-imsx:pattern)>
710
711 This is for clustering, not capturing; it groups subexpressions like
712 "()", but doesn't make backreferences as "()" does.  So
713
714     @fields = split(/\b(?:a|b|c)\b/)
715
716 is like
717
718     @fields = split(/\b(a|b|c)\b/)
719
720 but doesn't spit out extra fields.  It's also cheaper not to capture
721 characters if you don't need to.
722
723 Any letters between C<?> and C<:> act as flags modifiers as with
724 C<(?imsx-imsx)>.  For example,
725
726     /(?s-i:more.*than).*million/i
727
728 is equivalent to the more verbose
729
730     /(?:(?s-i)more.*than).*million/i
731
732 =item C<(?|pattern)>
733 X<(?|)> X<Branch reset>
734
735 This is the "branch reset" pattern, which has the special property
736 that the capture buffers are numbered from the same starting point
737 in each alternation branch. It is available starting from perl 5.10.
738
739 Capture buffers are numbered from left to right, but inside this
740 construct the numbering is restarted for each branch.
741
742 The numbering within each branch will be as normal, and any buffers
743 following this construct will be numbered as though the construct
744 contained only one branch, that being the one with the most capture
745 buffers in it.
746
747 This construct will be useful when you want to capture one of a
748 number of alternative matches.
749
750 Consider the following pattern.  The numbers underneath show in
751 which buffer the captured content will be stored.
752
753
754     # before  ---------------branch-reset----------- after        
755     / ( a )  (?| x ( y ) z | (p (q) r) | (t) u (v) ) ( z ) /x
756     # 1            2         2  3        2     3     4  
757
758 =item Look-Around Assertions
759 X<look-around assertion> X<lookaround assertion> X<look-around> X<lookaround>
760
761 Look-around assertions are zero width patterns which match a specific
762 pattern without including it in C<$&>. Positive assertions match when
763 their subpattern matches, negative assertions match when their subpattern
764 fails. Look-behind matches text up to the current match position,
765 look-ahead matches text following the current match position.
766
767 =over 4
768
769 =item C<(?=pattern)>
770 X<(?=)> X<look-ahead, positive> X<lookahead, positive>
771
772 A zero-width positive look-ahead assertion.  For example, C</\w+(?=\t)/>
773 matches a word followed by a tab, without including the tab in C<$&>.
774
775 =item C<(?!pattern)>
776 X<(?!)> X<look-ahead, negative> X<lookahead, negative>
777
778 A zero-width negative look-ahead assertion.  For example C</foo(?!bar)/>
779 matches any occurrence of "foo" that isn't followed by "bar".  Note
780 however that look-ahead and look-behind are NOT the same thing.  You cannot
781 use this for look-behind.
782
783 If you are looking for a "bar" that isn't preceded by a "foo", C</(?!foo)bar/>
784 will not do what you want.  That's because the C<(?!foo)> is just saying that
785 the next thing cannot be "foo"--and it's not, it's a "bar", so "foobar" will
786 match.  You would have to do something like C</(?!foo)...bar/> for that.   We
787 say "like" because there's the case of your "bar" not having three characters
788 before it.  You could cover that this way: C</(?:(?!foo)...|^.{0,2})bar/>.
789 Sometimes it's still easier just to say:
790
791     if (/bar/ && $` !~ /foo$/)
792
793 For look-behind see below.
794
795 =item C<(?<=pattern)> C<\K>
796 X<(?<=)> X<look-behind, positive> X<lookbehind, positive> X<\K>
797
798 A zero-width positive look-behind assertion.  For example, C</(?<=\t)\w+/>
799 matches a word that follows a tab, without including the tab in C<$&>.
800 Works only for fixed-width look-behind.
801
802 There is a special form of this construct, called C<\K>, which causes the
803 regex engine to "keep" everything it had matched prior to the C<\K> and
804 not include it in C<$&>. This effectively provides variable length
805 look-behind. The use of C<\K> inside of another look-around assertion
806 is allowed, but the behaviour is currently not well defined.
807
808 For various reasons C<\K> may be significantly more efficient than the
809 equivalent C<< (?<=...) >> construct, and it is especially useful in
810 situations where you want to efficiently remove something following
811 something else in a string. For instance
812
813   s/(foo)bar/$1/g;
814
815 can be rewritten as the much more efficient
816
817   s/foo\Kbar//g;
818
819 =item C<(?<!pattern)>
820 X<(?<!)> X<look-behind, negative> X<lookbehind, negative>
821
822 A zero-width negative look-behind assertion.  For example C</(?<!bar)foo/>
823 matches any occurrence of "foo" that does not follow "bar".  Works
824 only for fixed-width look-behind.
825
826 =back
827
828 =item C<(?'NAME'pattern)>
829
830 =item C<< (?<NAME>pattern) >>
831 X<< (?<NAME>) >> X<(?'NAME')> X<named capture> X<capture>
832
833 A named capture buffer. Identical in every respect to normal capturing
834 parentheses C<()> but for the additional fact that C<%+> may be used after
835 a successful match to refer to a named buffer. See C<perlvar> for more
836 details on the C<%+> hash.
837
838 If multiple distinct capture buffers have the same name then the
839 $+{NAME} will refer to the leftmost defined buffer in the match.
840
841 The forms C<(?'NAME'pattern)> and C<< (?<NAME>pattern) >> are equivalent.
842
843 B<NOTE:> While the notation of this construct is the same as the similar
844 function in .NET regexes, the behavior is not. In Perl the buffers are
845 numbered sequentially regardless of being named or not. Thus in the
846 pattern
847
848   /(x)(?<foo>y)(z)/
849
850 $+{foo} will be the same as $2, and $3 will contain 'z' instead of
851 the opposite which is what a .NET regex hacker might expect.
852
853 Currently NAME is restricted to simple identifiers only.
854 In other words, it must match C</^[_A-Za-z][_A-Za-z0-9]*\z/> or
855 its Unicode extension (see L<utf8>),
856 though it isn't extended by the locale (see L<perllocale>).
857
858 B<NOTE:> In order to make things easier for programmers with experience
859 with the Python or PCRE regex engines, the pattern C<< (?PE<lt>NAMEE<gt>pattern) >>
860 may be used instead of C<< (?<NAME>pattern) >>; however this form does not
861 support the use of single quotes as a delimiter for the name. This is
862 only available in Perl 5.10 or later.
863
864 =item C<< \k<NAME> >>
865
866 =item C<< \k'NAME' >>
867
868 Named backreference. Similar to numeric backreferences, except that
869 the group is designated by name and not number. If multiple groups
870 have the same name then it refers to the leftmost defined group in
871 the current match.
872
873 It is an error to refer to a name not defined by a C<< (?<NAME>) >>
874 earlier in the pattern.
875
876 Both forms are equivalent.
877
878 B<NOTE:> In order to make things easier for programmers with experience
879 with the Python or PCRE regex engines, the pattern C<< (?P=NAME) >>
880 may be used instead of C<< \k<NAME> >> in Perl 5.10 or later.
881
882 =item C<(?{ code })>
883 X<(?{})> X<regex, code in> X<regexp, code in> X<regular expression, code in>
884
885 B<WARNING>: This extended regular expression feature is considered
886 experimental, and may be changed without notice. Code executed that
887 has side effects may not perform identically from version to version
888 due to the effect of future optimisations in the regex engine.
889
890 This zero-width assertion evaluates any embedded Perl code.  It
891 always succeeds, and its C<code> is not interpolated.  Currently,
892 the rules to determine where the C<code> ends are somewhat convoluted.
893
894 This feature can be used together with the special variable C<$^N> to
895 capture the results of submatches in variables without having to keep
896 track of the number of nested parentheses. For example:
897
898   $_ = "The brown fox jumps over the lazy dog";
899   /the (\S+)(?{ $color = $^N }) (\S+)(?{ $animal = $^N })/i;
900   print "color = $color, animal = $animal\n";
901
902 Inside the C<(?{...})> block, C<$_> refers to the string the regular
903 expression is matching against. You can also use C<pos()> to know what is
904 the current position of matching within this string.
905
906 The C<code> is properly scoped in the following sense: If the assertion
907 is backtracked (compare L<"Backtracking">), all changes introduced after
908 C<local>ization are undone, so that
909
910   $_ = 'a' x 8;
911   m<
912      (?{ $cnt = 0 })                    # Initialize $cnt.
913      (
914        a
915        (?{
916            local $cnt = $cnt + 1;       # Update $cnt, backtracking-safe.
917        })
918      )*
919      aaaa
920      (?{ $res = $cnt })                 # On success copy to non-localized
921                                         # location.
922    >x;
923
924 will set C<$res = 4>.  Note that after the match, C<$cnt> returns to the globally
925 introduced value, because the scopes that restrict C<local> operators
926 are unwound.
927
928 This assertion may be used as a C<(?(condition)yes-pattern|no-pattern)>
929 switch.  If I<not> used in this way, the result of evaluation of
930 C<code> is put into the special variable C<$^R>.  This happens
931 immediately, so C<$^R> can be used from other C<(?{ code })> assertions
932 inside the same regular expression.
933
934 The assignment to C<$^R> above is properly localized, so the old
935 value of C<$^R> is restored if the assertion is backtracked; compare
936 L<"Backtracking">.
937
938 Due to an unfortunate implementation issue, the Perl code contained in these
939 blocks is treated as a compile time closure that can have seemingly bizarre
940 consequences when used with lexically scoped variables inside of subroutines
941 or loops.  There are various workarounds for this, including simply using
942 global variables instead.  If you are using this construct and strange results
943 occur then check for the use of lexically scoped variables.
944
945 For reasons of security, this construct is forbidden if the regular
946 expression involves run-time interpolation of variables, unless the
947 perilous C<use re 'eval'> pragma has been used (see L<re>), or the
948 variables contain results of C<qr//> operator (see
949 L<perlop/"qr/STRING/imosx">).
950
951 This restriction is due to the wide-spread and remarkably convenient
952 custom of using run-time determined strings as patterns.  For example:
953
954     $re = <>;
955     chomp $re;
956     $string =~ /$re/;
957
958 Before Perl knew how to execute interpolated code within a pattern,
959 this operation was completely safe from a security point of view,
960 although it could raise an exception from an illegal pattern.  If
961 you turn on the C<use re 'eval'>, though, it is no longer secure,
962 so you should only do so if you are also using taint checking.
963 Better yet, use the carefully constrained evaluation within a Safe
964 compartment.  See L<perlsec> for details about both these mechanisms.
965
966 Because Perl's regex engine is currently not re-entrant, interpolated
967 code may not invoke the regex engine either directly with C<m//> or C<s///>),
968 or indirectly with functions such as C<split>.
969
970 =item C<(??{ code })>
971 X<(??{})>
972 X<regex, postponed> X<regexp, postponed> X<regular expression, postponed>
973
974 B<WARNING>: This extended regular expression feature is considered
975 experimental, and may be changed without notice. Code executed that
976 has side effects may not perform identically from version to version
977 due to the effect of future optimisations in the regex engine.
978
979 This is a "postponed" regular subexpression.  The C<code> is evaluated
980 at run time, at the moment this subexpression may match.  The result
981 of evaluation is considered as a regular expression and matched as
982 if it were inserted instead of this construct.  Note that this means
983 that the contents of capture buffers defined inside an eval'ed pattern
984 are not available outside of the pattern, and vice versa, there is no
985 way for the inner pattern to refer to a capture buffer defined outside.
986 Thus,
987
988     ('a' x 100)=~/(??{'(.)' x 100})/
989
990 B<will> match, it will B<not> set $1.
991
992 The C<code> is not interpolated.  As before, the rules to determine
993 where the C<code> ends are currently somewhat convoluted.
994
995 The following pattern matches a parenthesized group:
996
997   $re = qr{
998              \(
999              (?:
1000                 (?> [^()]+ )    # Non-parens without backtracking
1001               |
1002                 (??{ $re })     # Group with matching parens
1003              )*
1004              \)
1005           }x;
1006
1007 See also C<(?PARNO)> for a different, more efficient way to accomplish
1008 the same task.
1009
1010 Because perl's regex engine is not currently re-entrant, delayed
1011 code may not invoke the regex engine either directly with C<m//> or C<s///>),
1012 or indirectly with functions such as C<split>.
1013
1014 Recursing deeper than 50 times without consuming any input string will
1015 result in a fatal error.  The maximum depth is compiled into perl, so
1016 changing it requires a custom build.
1017
1018 =item C<(?PARNO)> C<(?-PARNO)> C<(?+PARNO)> C<(?R)> C<(?0)>
1019 X<(?PARNO)> X<(?1)> X<(?R)> X<(?0)> X<(?-1)> X<(?+1)> X<(?-PARNO)> X<(?+PARNO)>
1020 X<regex, recursive> X<regexp, recursive> X<regular expression, recursive>
1021 X<regex, relative recursion>
1022
1023 Similar to C<(??{ code })> except it does not involve compiling any code,
1024 instead it treats the contents of a capture buffer as an independent
1025 pattern that must match at the current position.  Capture buffers
1026 contained by the pattern will have the value as determined by the
1027 outermost recursion.
1028
1029 PARNO is a sequence of digits (not starting with 0) whose value reflects
1030 the paren-number of the capture buffer to recurse to. C<(?R)> recurses to
1031 the beginning of the whole pattern. C<(?0)> is an alternate syntax for
1032 C<(?R)>. If PARNO is preceded by a plus or minus sign then it is assumed
1033 to be relative, with negative numbers indicating preceding capture buffers
1034 and positive ones following. Thus C<(?-1)> refers to the most recently
1035 declared buffer, and C<(?+1)> indicates the next buffer to be declared.
1036 Note that the counting for relative recursion differs from that of
1037 relative backreferences, in that with recursion unclosed buffers B<are>
1038 included.
1039
1040 The following pattern matches a function foo() which may contain
1041 balanced parentheses as the argument.
1042
1043   $re = qr{ (                    # paren group 1 (full function)
1044               foo
1045               (                  # paren group 2 (parens)
1046                 \(
1047                   (              # paren group 3 (contents of parens)
1048                   (?:
1049                    (?> [^()]+ )  # Non-parens without backtracking
1050                   |
1051                    (?2)          # Recurse to start of paren group 2
1052                   )*
1053                   )
1054                 \)
1055               )
1056             )
1057           }x;
1058
1059 If the pattern was used as follows
1060
1061     'foo(bar(baz)+baz(bop))'=~/$re/
1062         and print "\$1 = $1\n",
1063                   "\$2 = $2\n",
1064                   "\$3 = $3\n";
1065
1066 the output produced should be the following:
1067
1068     $1 = foo(bar(baz)+baz(bop))
1069     $2 = (bar(baz)+baz(bop))
1070     $3 = bar(baz)+baz(bop)
1071
1072 If there is no corresponding capture buffer defined, then it is a
1073 fatal error.  Recursing deeper than 50 times without consuming any input
1074 string will also result in a fatal error.  The maximum depth is compiled
1075 into perl, so changing it requires a custom build.
1076
1077 The following shows how using negative indexing can make it
1078 easier to embed recursive patterns inside of a C<qr//> construct
1079 for later use:
1080
1081     my $parens = qr/(\((?:[^()]++|(?-1))*+\))/;
1082     if (/foo $parens \s+ + \s+ bar $parens/x) {
1083        # do something here...
1084     }
1085
1086 B<Note> that this pattern does not behave the same way as the equivalent
1087 PCRE or Python construct of the same form. In Perl you can backtrack into
1088 a recursed group, in PCRE and Python the recursed into group is treated
1089 as atomic. Also, modifiers are resolved at compile time, so constructs
1090 like (?i:(?1)) or (?:(?i)(?1)) do not affect how the sub-pattern will
1091 be processed.
1092
1093 =item C<(?&NAME)>
1094 X<(?&NAME)>
1095
1096 Recurse to a named subpattern. Identical to C<(?PARNO)> except that the
1097 parenthesis to recurse to is determined by name. If multiple parentheses have
1098 the same name, then it recurses to the leftmost.
1099
1100 It is an error to refer to a name that is not declared somewhere in the
1101 pattern.
1102
1103 B<NOTE:> In order to make things easier for programmers with experience
1104 with the Python or PCRE regex engines the pattern C<< (?P>NAME) >>
1105 may be used instead of C<< (?&NAME) >> in Perl 5.10 or later.
1106
1107 =item C<(?(condition)yes-pattern|no-pattern)>
1108 X<(?()>
1109
1110 =item C<(?(condition)yes-pattern)>
1111
1112 Conditional expression.  C<(condition)> should be either an integer in
1113 parentheses (which is valid if the corresponding pair of parentheses
1114 matched), a look-ahead/look-behind/evaluate zero-width assertion, a
1115 name in angle brackets or single quotes (which is valid if a buffer
1116 with the given name matched), or the special symbol (R) (true when
1117 evaluated inside of recursion or eval). Additionally the R may be
1118 followed by a number, (which will be true when evaluated when recursing
1119 inside of the appropriate group), or by C<&NAME>, in which case it will
1120 be true only when evaluated during recursion in the named group.
1121
1122 Here's a summary of the possible predicates:
1123
1124 =over 4
1125
1126 =item (1) (2) ...
1127
1128 Checks if the numbered capturing buffer has matched something.
1129
1130 =item (<NAME>) ('NAME')
1131
1132 Checks if a buffer with the given name has matched something.
1133
1134 =item (?{ CODE })
1135
1136 Treats the code block as the condition.
1137
1138 =item (R)
1139
1140 Checks if the expression has been evaluated inside of recursion.
1141
1142 =item (R1) (R2) ...
1143
1144 Checks if the expression has been evaluated while executing directly
1145 inside of the n-th capture group. This check is the regex equivalent of
1146
1147   if ((caller(0))[3] eq 'subname') { ... }
1148
1149 In other words, it does not check the full recursion stack.
1150
1151 =item (R&NAME)
1152
1153 Similar to C<(R1)>, this predicate checks to see if we're executing
1154 directly inside of the leftmost group with a given name (this is the same
1155 logic used by C<(?&NAME)> to disambiguate). It does not check the full
1156 stack, but only the name of the innermost active recursion.
1157
1158 =item (DEFINE)
1159
1160 In this case, the yes-pattern is never directly executed, and no
1161 no-pattern is allowed. Similar in spirit to C<(?{0})> but more efficient.
1162 See below for details.
1163
1164 =back
1165
1166 For example:
1167
1168     m{ ( \( )?
1169        [^()]+
1170        (?(1) \) )
1171      }x
1172
1173 matches a chunk of non-parentheses, possibly included in parentheses
1174 themselves.
1175
1176 A special form is the C<(DEFINE)> predicate, which never executes directly
1177 its yes-pattern, and does not allow a no-pattern. This allows to define
1178 subpatterns which will be executed only by using the recursion mechanism.
1179 This way, you can define a set of regular expression rules that can be
1180 bundled into any pattern you choose.
1181
1182 It is recommended that for this usage you put the DEFINE block at the
1183 end of the pattern, and that you name any subpatterns defined within it.
1184
1185 Also, it's worth noting that patterns defined this way probably will
1186 not be as efficient, as the optimiser is not very clever about
1187 handling them.
1188
1189 An example of how this might be used is as follows:
1190
1191   /(?<NAME>(?&NAME_PAT))(?<ADDR>(?&ADDRESS_PAT))
1192    (?(DEFINE)
1193      (?<NAME_PAT>....)
1194      (?<ADRESS_PAT>....)
1195    )/x
1196
1197 Note that capture buffers matched inside of recursion are not accessible
1198 after the recursion returns, so the extra layer of capturing buffers is
1199 necessary. Thus C<$+{NAME_PAT}> would not be defined even though
1200 C<$+{NAME}> would be.
1201
1202 =item C<< (?>pattern) >>
1203 X<backtrack> X<backtracking> X<atomic> X<possessive>
1204
1205 An "independent" subexpression, one which matches the substring
1206 that a I<standalone> C<pattern> would match if anchored at the given
1207 position, and it matches I<nothing other than this substring>.  This
1208 construct is useful for optimizations of what would otherwise be
1209 "eternal" matches, because it will not backtrack (see L<"Backtracking">).
1210 It may also be useful in places where the "grab all you can, and do not
1211 give anything back" semantic is desirable.
1212
1213 For example: C<< ^(?>a*)ab >> will never match, since C<< (?>a*) >>
1214 (anchored at the beginning of string, as above) will match I<all>
1215 characters C<a> at the beginning of string, leaving no C<a> for
1216 C<ab> to match.  In contrast, C<a*ab> will match the same as C<a+b>,
1217 since the match of the subgroup C<a*> is influenced by the following
1218 group C<ab> (see L<"Backtracking">).  In particular, C<a*> inside
1219 C<a*ab> will match fewer characters than a standalone C<a*>, since
1220 this makes the tail match.
1221
1222 An effect similar to C<< (?>pattern) >> may be achieved by writing
1223 C<(?=(pattern))\1>.  This matches the same substring as a standalone
1224 C<a+>, and the following C<\1> eats the matched string; it therefore
1225 makes a zero-length assertion into an analogue of C<< (?>...) >>.
1226 (The difference between these two constructs is that the second one
1227 uses a capturing group, thus shifting ordinals of backreferences
1228 in the rest of a regular expression.)
1229
1230 Consider this pattern:
1231
1232     m{ \(
1233           (
1234             [^()]+              # x+
1235           |
1236             \( [^()]* \)
1237           )+
1238        \)
1239      }x
1240
1241 That will efficiently match a nonempty group with matching parentheses
1242 two levels deep or less.  However, if there is no such group, it
1243 will take virtually forever on a long string.  That's because there
1244 are so many different ways to split a long string into several
1245 substrings.  This is what C<(.+)+> is doing, and C<(.+)+> is similar
1246 to a subpattern of the above pattern.  Consider how the pattern
1247 above detects no-match on C<((()aaaaaaaaaaaaaaaaaa> in several
1248 seconds, but that each extra letter doubles this time.  This
1249 exponential performance will make it appear that your program has
1250 hung.  However, a tiny change to this pattern
1251
1252     m{ \(
1253           (
1254             (?> [^()]+ )        # change x+ above to (?> x+ )
1255           |
1256             \( [^()]* \)
1257           )+
1258        \)
1259      }x
1260
1261 which uses C<< (?>...) >> matches exactly when the one above does (verifying
1262 this yourself would be a productive exercise), but finishes in a fourth
1263 the time when used on a similar string with 1000000 C<a>s.  Be aware,
1264 however, that this pattern currently triggers a warning message under
1265 the C<use warnings> pragma or B<-w> switch saying it
1266 C<"matches null string many times in regex">.
1267
1268 On simple groups, such as the pattern C<< (?> [^()]+ ) >>, a comparable
1269 effect may be achieved by negative look-ahead, as in C<[^()]+ (?! [^()] )>.
1270 This was only 4 times slower on a string with 1000000 C<a>s.
1271
1272 The "grab all you can, and do not give anything back" semantic is desirable
1273 in many situations where on the first sight a simple C<()*> looks like
1274 the correct solution.  Suppose we parse text with comments being delimited
1275 by C<#> followed by some optional (horizontal) whitespace.  Contrary to
1276 its appearance, C<#[ \t]*> I<is not> the correct subexpression to match
1277 the comment delimiter, because it may "give up" some whitespace if
1278 the remainder of the pattern can be made to match that way.  The correct
1279 answer is either one of these:
1280
1281     (?>#[ \t]*)
1282     #[ \t]*(?![ \t])
1283
1284 For example, to grab non-empty comments into $1, one should use either
1285 one of these:
1286
1287     / (?> \# [ \t]* ) (        .+ ) /x;
1288     /     \# [ \t]*   ( [^ \t] .* ) /x;
1289
1290 Which one you pick depends on which of these expressions better reflects
1291 the above specification of comments.
1292
1293 In some literature this construct is called "atomic matching" or
1294 "possessive matching".
1295
1296 Possessive quantifiers are equivalent to putting the item they are applied
1297 to inside of one of these constructs. The following equivalences apply:
1298
1299     Quantifier Form     Bracketing Form
1300     ---------------     ---------------
1301     PAT*+               (?>PAT*)
1302     PAT++               (?>PAT+)
1303     PAT?+               (?>PAT?)
1304     PAT{min,max}+       (?>PAT{min,max})
1305
1306 =back
1307
1308 =head2 Special Backtracking Control Verbs
1309
1310 B<WARNING:> These patterns are experimental and subject to change or
1311 removal in a future version of Perl. Their usage in production code should
1312 be noted to avoid problems during upgrades.
1313
1314 These special patterns are generally of the form C<(*VERB:ARG)>. Unless
1315 otherwise stated the ARG argument is optional; in some cases, it is
1316 forbidden.
1317
1318 Any pattern containing a special backtracking verb that allows an argument
1319 has the special behaviour that when executed it sets the current packages'
1320 C<$REGERROR> and C<$REGMARK> variables. When doing so the following
1321 rules apply:
1322
1323 On failure, the C<$REGERROR> variable will be set to the ARG value of the
1324 verb pattern, if the verb was involved in the failure of the match. If the
1325 ARG part of the pattern was omitted, then C<$REGERROR> will be set to the
1326 name of the last C<(*MARK:NAME)> pattern executed, or to TRUE if there was
1327 none. Also, the C<$REGMARK> variable will be set to FALSE.
1328
1329 On a successful match, the C<$REGERROR> variable will be set to FALSE, and
1330 the C<$REGMARK> variable will be set to the name of the last
1331 C<(*MARK:NAME)> pattern executed.  See the explanation for the
1332 C<(*MARK:NAME)> verb below for more details.
1333
1334 B<NOTE:> C<$REGERROR> and C<$REGMARK> are not magic variables like C<$1>
1335 and most other regex related variables. They are not local to a scope, nor
1336 readonly, but instead are volatile package variables similar to C<$AUTOLOAD>.
1337 Use C<local> to localize changes to them to a specific scope if necessary.
1338
1339 If a pattern does not contain a special backtracking verb that allows an
1340 argument, then C<$REGERROR> and C<$REGMARK> are not touched at all.
1341
1342 =over 4
1343
1344 =item Verbs that take an argument
1345
1346 =over 4
1347
1348 =item C<(*PRUNE)> C<(*PRUNE:NAME)>
1349 X<(*PRUNE)> X<(*PRUNE:NAME)> X<\v>
1350
1351 This zero-width pattern prunes the backtracking tree at the current point
1352 when backtracked into on failure. Consider the pattern C<A (*PRUNE) B>,
1353 where A and B are complex patterns. Until the C<(*PRUNE)> verb is reached,
1354 A may backtrack as necessary to match. Once it is reached, matching
1355 continues in B, which may also backtrack as necessary; however, should B
1356 not match, then no further backtracking will take place, and the pattern
1357 will fail outright at the current starting position.
1358
1359 As a shortcut, C<\v> is exactly equivalent to C<(*PRUNE)>.
1360
1361 The following example counts all the possible matching strings in a
1362 pattern (without actually matching any of them).
1363
1364     'aaab' =~ /a+b?(?{print "$&\n"; $count++})(*FAIL)/;
1365     print "Count=$count\n";
1366
1367 which produces:
1368
1369     aaab
1370     aaa
1371     aa
1372     a
1373     aab
1374     aa
1375     a
1376     ab
1377     a
1378     Count=9
1379
1380 If we add a C<(*PRUNE)> before the count like the following
1381
1382     'aaab' =~ /a+b?(*PRUNE)(?{print "$&\n"; $count++})(*FAIL)/;
1383     print "Count=$count\n";
1384
1385 we prevent backtracking and find the count of the longest matching
1386 at each matching startpoint like so:
1387
1388     aaab
1389     aab
1390     ab
1391     Count=3
1392
1393 Any number of C<(*PRUNE)> assertions may be used in a pattern.
1394
1395 See also C<< (?>pattern) >> and possessive quantifiers for other ways to
1396 control backtracking. In some cases, the use of C<(*PRUNE)> can be
1397 replaced with a C<< (?>pattern) >> with no functional difference; however,
1398 C<(*PRUNE)> can be used to handle cases that cannot be expressed using a
1399 C<< (?>pattern) >> alone.
1400
1401
1402 =item C<(*SKIP)> C<(*SKIP:NAME)>
1403 X<(*SKIP)>
1404
1405 This zero-width pattern is similar to C<(*PRUNE)>, except that on
1406 failure it also signifies that whatever text that was matched leading up
1407 to the C<(*SKIP)> pattern being executed cannot be part of I<any> match
1408 of this pattern. This effectively means that the regex engine "skips" forward
1409 to this position on failure and tries to match again, (assuming that
1410 there is sufficient room to match).
1411
1412 As a shortcut C<\V> is exactly equivalent to C<(*SKIP)>.
1413
1414 The name of the C<(*SKIP:NAME)> pattern has special significance. If a
1415 C<(*MARK:NAME)> was encountered while matching, then it is that position
1416 which is used as the "skip point". If no C<(*MARK)> of that name was
1417 encountered, then the C<(*SKIP)> operator has no effect. When used
1418 without a name the "skip point" is where the match point was when
1419 executing the (*SKIP) pattern.
1420
1421 Compare the following to the examples in C<(*PRUNE)>, note the string
1422 is twice as long:
1423
1424     'aaabaaab' =~ /a+b?(*SKIP)(?{print "$&\n"; $count++})(*FAIL)/;
1425     print "Count=$count\n";
1426
1427 outputs
1428
1429     aaab
1430     aaab
1431     Count=2
1432
1433 Once the 'aaab' at the start of the string has matched, and the C<(*SKIP)>
1434 executed, the next startpoint will be where the cursor was when the
1435 C<(*SKIP)> was executed.
1436
1437 =item C<(*MARK:NAME)> C<(*:NAME)>
1438 X<(*MARK)> C<(*MARK:NAME)> C<(*:NAME)>
1439
1440 This zero-width pattern can be used to mark the point reached in a string
1441 when a certain part of the pattern has been successfully matched. This
1442 mark may be given a name. A later C<(*SKIP)> pattern will then skip
1443 forward to that point if backtracked into on failure. Any number of
1444 C<(*MARK)> patterns are allowed, and the NAME portion is optional and may
1445 be duplicated.
1446
1447 In addition to interacting with the C<(*SKIP)> pattern, C<(*MARK:NAME)>
1448 can be used to "label" a pattern branch, so that after matching, the
1449 program can determine which branches of the pattern were involved in the
1450 match.
1451
1452 When a match is successful, the C<$REGMARK> variable will be set to the
1453 name of the most recently executed C<(*MARK:NAME)> that was involved
1454 in the match.
1455
1456 This can be used to determine which branch of a pattern was matched
1457 without using a separate capture buffer for each branch, which in turn
1458 can result in a performance improvement, as perl cannot optimize
1459 C</(?:(x)|(y)|(z))/> as efficiently as something like
1460 C</(?:x(*MARK:x)|y(*MARK:y)|z(*MARK:z))/>.
1461
1462 When a match has failed, and unless another verb has been involved in
1463 failing the match and has provided its own name to use, the C<$REGERROR>
1464 variable will be set to the name of the most recently executed
1465 C<(*MARK:NAME)>.
1466
1467 See C<(*SKIP)> for more details.
1468
1469 As a shortcut C<(*MARK:NAME)> can be written C<(*:NAME)>.
1470
1471 =item C<(*THEN)> C<(*THEN:NAME)>
1472
1473 This is similar to the "cut group" operator C<::> from Perl6. Like
1474 C<(*PRUNE)>, this verb always matches, and when backtracked into on
1475 failure, it causes the regex engine to try the next alternation in the
1476 innermost enclosing group (capturing or otherwise).
1477
1478 Its name comes from the observation that this operation combined with the
1479 alternation operator (C<|>) can be used to create what is essentially a
1480 pattern-based if/then/else block:
1481
1482   ( COND (*THEN) FOO | COND2 (*THEN) BAR | COND3 (*THEN) BAZ )
1483
1484 Note that if this operator is used and NOT inside of an alternation then
1485 it acts exactly like the C<(*PRUNE)> operator.
1486
1487   / A (*PRUNE) B /
1488
1489 is the same as
1490
1491   / A (*THEN) B /
1492
1493 but
1494
1495   / ( A (*THEN) B | C (*THEN) D ) /
1496
1497 is not the same as
1498
1499   / ( A (*PRUNE) B | C (*PRUNE) D ) /
1500
1501 as after matching the A but failing on the B the C<(*THEN)> verb will
1502 backtrack and try C; but the C<(*PRUNE)> verb will simply fail.
1503
1504 =item C<(*COMMIT)>
1505 X<(*COMMIT)>
1506
1507 This is the Perl6 "commit pattern" C<< <commit> >> or C<:::>. It's a
1508 zero-width pattern similar to C<(*SKIP)>, except that when backtracked
1509 into on failure it causes the match to fail outright. No further attempts
1510 to find a valid match by advancing the start pointer will occur again.
1511 For example,
1512
1513     'aaabaaab' =~ /a+b?(*COMMIT)(?{print "$&\n"; $count++})(*FAIL)/;
1514     print "Count=$count\n";
1515
1516 outputs
1517
1518     aaab
1519     Count=1
1520
1521 In other words, once the C<(*COMMIT)> has been entered, and if the pattern
1522 does not match, the regex engine will not try any further matching on the
1523 rest of the string.
1524
1525 =back
1526
1527 =item Verbs without an argument
1528
1529 =over 4
1530
1531 =item C<(*FAIL)> C<(*F)>
1532 X<(*FAIL)> X<(*F)>
1533
1534 This pattern matches nothing and always fails. It can be used to force the
1535 engine to backtrack. It is equivalent to C<(?!)>, but easier to read. In
1536 fact, C<(?!)> gets optimised into C<(*FAIL)> internally.
1537
1538 It is probably useful only when combined with C<(?{})> or C<(??{})>.
1539
1540 =item C<(*ACCEPT)>
1541 X<(*ACCEPT)>
1542
1543 B<WARNING:> This feature is highly experimental. It is not recommended
1544 for production code.
1545
1546 This pattern matches nothing and causes the end of successful matching at
1547 the point at which the C<(*ACCEPT)> pattern was encountered, regardless of
1548 whether there is actually more to match in the string. When inside of a
1549 nested pattern, such as recursion, or in a subpattern dynamically generated
1550 via C<(??{})>, only the innermost pattern is ended immediately.
1551
1552 If the C<(*ACCEPT)> is inside of capturing buffers then the buffers are
1553 marked as ended at the point at which the C<(*ACCEPT)> was encountered.
1554 For instance:
1555
1556   'AB' =~ /(A (A|B(*ACCEPT)|C) D)(E)/x;
1557
1558 will match, and C<$1> will be C<AB> and C<$2> will be C<B>, C<$3> will not
1559 be set. If another branch in the inner parentheses were matched, such as in the
1560 string 'ACDE', then the C<D> and C<E> would have to be matched as well.
1561
1562 =back
1563
1564 =back
1565
1566 =head2 Backtracking
1567 X<backtrack> X<backtracking>
1568
1569 NOTE: This section presents an abstract approximation of regular
1570 expression behavior.  For a more rigorous (and complicated) view of
1571 the rules involved in selecting a match among possible alternatives,
1572 see L<Combining RE Pieces>.
1573
1574 A fundamental feature of regular expression matching involves the
1575 notion called I<backtracking>, which is currently used (when needed)
1576 by all regular non-possessive expression quantifiers, namely C<*>, C<*?>, C<+>,
1577 C<+?>, C<{n,m}>, and C<{n,m}?>.  Backtracking is often optimized
1578 internally, but the general principle outlined here is valid.
1579
1580 For a regular expression to match, the I<entire> regular expression must
1581 match, not just part of it.  So if the beginning of a pattern containing a
1582 quantifier succeeds in a way that causes later parts in the pattern to
1583 fail, the matching engine backs up and recalculates the beginning
1584 part--that's why it's called backtracking.
1585
1586 Here is an example of backtracking:  Let's say you want to find the
1587 word following "foo" in the string "Food is on the foo table.":
1588
1589     $_ = "Food is on the foo table.";
1590     if ( /\b(foo)\s+(\w+)/i ) {
1591         print "$2 follows $1.\n";
1592     }
1593
1594 When the match runs, the first part of the regular expression (C<\b(foo)>)
1595 finds a possible match right at the beginning of the string, and loads up
1596 $1 with "Foo".  However, as soon as the matching engine sees that there's
1597 no whitespace following the "Foo" that it had saved in $1, it realizes its
1598 mistake and starts over again one character after where it had the
1599 tentative match.  This time it goes all the way until the next occurrence
1600 of "foo". The complete regular expression matches this time, and you get
1601 the expected output of "table follows foo."
1602
1603 Sometimes minimal matching can help a lot.  Imagine you'd like to match
1604 everything between "foo" and "bar".  Initially, you write something
1605 like this:
1606
1607     $_ =  "The food is under the bar in the barn.";
1608     if ( /foo(.*)bar/ ) {
1609         print "got <$1>\n";
1610     }
1611
1612 Which perhaps unexpectedly yields:
1613
1614   got <d is under the bar in the >
1615
1616 That's because C<.*> was greedy, so you get everything between the
1617 I<first> "foo" and the I<last> "bar".  Here it's more effective
1618 to use minimal matching to make sure you get the text between a "foo"
1619 and the first "bar" thereafter.
1620
1621     if ( /foo(.*?)bar/ ) { print "got <$1>\n" }
1622   got <d is under the >
1623
1624 Here's another example. Let's say you'd like to match a number at the end
1625 of a string, and you also want to keep the preceding part of the match.
1626 So you write this:
1627
1628     $_ = "I have 2 numbers: 53147";
1629     if ( /(.*)(\d*)/ ) {                                # Wrong!
1630         print "Beginning is <$1>, number is <$2>.\n";
1631     }
1632
1633 That won't work at all, because C<.*> was greedy and gobbled up the
1634 whole string. As C<\d*> can match on an empty string the complete
1635 regular expression matched successfully.
1636
1637     Beginning is <I have 2 numbers: 53147>, number is <>.
1638
1639 Here are some variants, most of which don't work:
1640
1641     $_ = "I have 2 numbers: 53147";
1642     @pats = qw{
1643         (.*)(\d*)
1644         (.*)(\d+)
1645         (.*?)(\d*)
1646         (.*?)(\d+)
1647         (.*)(\d+)$
1648         (.*?)(\d+)$
1649         (.*)\b(\d+)$
1650         (.*\D)(\d+)$
1651     };
1652
1653     for $pat (@pats) {
1654         printf "%-12s ", $pat;
1655         if ( /$pat/ ) {
1656             print "<$1> <$2>\n";
1657         } else {
1658             print "FAIL\n";
1659         }
1660     }
1661
1662 That will print out:
1663
1664     (.*)(\d*)    <I have 2 numbers: 53147> <>
1665     (.*)(\d+)    <I have 2 numbers: 5314> <7>
1666     (.*?)(\d*)   <> <>
1667     (.*?)(\d+)   <I have > <2>
1668     (.*)(\d+)$   <I have 2 numbers: 5314> <7>
1669     (.*?)(\d+)$  <I have 2 numbers: > <53147>
1670     (.*)\b(\d+)$ <I have 2 numbers: > <53147>
1671     (.*\D)(\d+)$ <I have 2 numbers: > <53147>
1672
1673 As you see, this can be a bit tricky.  It's important to realize that a
1674 regular expression is merely a set of assertions that gives a definition
1675 of success.  There may be 0, 1, or several different ways that the
1676 definition might succeed against a particular string.  And if there are
1677 multiple ways it might succeed, you need to understand backtracking to
1678 know which variety of success you will achieve.
1679
1680 When using look-ahead assertions and negations, this can all get even
1681 trickier.  Imagine you'd like to find a sequence of non-digits not
1682 followed by "123".  You might try to write that as
1683
1684     $_ = "ABC123";
1685     if ( /^\D*(?!123)/ ) {              # Wrong!
1686         print "Yup, no 123 in $_\n";
1687     }
1688
1689 But that isn't going to match; at least, not the way you're hoping.  It
1690 claims that there is no 123 in the string.  Here's a clearer picture of
1691 why that pattern matches, contrary to popular expectations:
1692
1693     $x = 'ABC123';
1694     $y = 'ABC445';
1695
1696     print "1: got $1\n" if $x =~ /^(ABC)(?!123)/;
1697     print "2: got $1\n" if $y =~ /^(ABC)(?!123)/;
1698
1699     print "3: got $1\n" if $x =~ /^(\D*)(?!123)/;
1700     print "4: got $1\n" if $y =~ /^(\D*)(?!123)/;
1701
1702 This prints
1703
1704     2: got ABC
1705     3: got AB
1706     4: got ABC
1707
1708 You might have expected test 3 to fail because it seems to a more
1709 general purpose version of test 1.  The important difference between
1710 them is that test 3 contains a quantifier (C<\D*>) and so can use
1711 backtracking, whereas test 1 will not.  What's happening is
1712 that you've asked "Is it true that at the start of $x, following 0 or more
1713 non-digits, you have something that's not 123?"  If the pattern matcher had
1714 let C<\D*> expand to "ABC", this would have caused the whole pattern to
1715 fail.
1716
1717 The search engine will initially match C<\D*> with "ABC".  Then it will
1718 try to match C<(?!123> with "123", which fails.  But because
1719 a quantifier (C<\D*>) has been used in the regular expression, the
1720 search engine can backtrack and retry the match differently
1721 in the hope of matching the complete regular expression.
1722
1723 The pattern really, I<really> wants to succeed, so it uses the
1724 standard pattern back-off-and-retry and lets C<\D*> expand to just "AB" this
1725 time.  Now there's indeed something following "AB" that is not
1726 "123".  It's "C123", which suffices.
1727
1728 We can deal with this by using both an assertion and a negation.
1729 We'll say that the first part in $1 must be followed both by a digit
1730 and by something that's not "123".  Remember that the look-aheads
1731 are zero-width expressions--they only look, but don't consume any
1732 of the string in their match.  So rewriting this way produces what
1733 you'd expect; that is, case 5 will fail, but case 6 succeeds:
1734
1735     print "5: got $1\n" if $x =~ /^(\D*)(?=\d)(?!123)/;
1736     print "6: got $1\n" if $y =~ /^(\D*)(?=\d)(?!123)/;
1737
1738     6: got ABC
1739
1740 In other words, the two zero-width assertions next to each other work as though
1741 they're ANDed together, just as you'd use any built-in assertions:  C</^$/>
1742 matches only if you're at the beginning of the line AND the end of the
1743 line simultaneously.  The deeper underlying truth is that juxtaposition in
1744 regular expressions always means AND, except when you write an explicit OR
1745 using the vertical bar.  C</ab/> means match "a" AND (then) match "b",
1746 although the attempted matches are made at different positions because "a"
1747 is not a zero-width assertion, but a one-width assertion.
1748
1749 B<WARNING>: Particularly complicated regular expressions can take
1750 exponential time to solve because of the immense number of possible
1751 ways they can use backtracking to try for a match.  For example, without
1752 internal optimizations done by the regular expression engine, this will
1753 take a painfully long time to run:
1754
1755     'aaaaaaaaaaaa' =~ /((a{0,5}){0,5})*[c]/
1756
1757 And if you used C<*>'s in the internal groups instead of limiting them
1758 to 0 through 5 matches, then it would take forever--or until you ran
1759 out of stack space.  Moreover, these internal optimizations are not
1760 always applicable.  For example, if you put C<{0,5}> instead of C<*>
1761 on the external group, no current optimization is applicable, and the
1762 match takes a long time to finish.
1763
1764 A powerful tool for optimizing such beasts is what is known as an
1765 "independent group",
1766 which does not backtrack (see L<C<< (?>pattern) >>>).  Note also that
1767 zero-length look-ahead/look-behind assertions will not backtrack to make
1768 the tail match, since they are in "logical" context: only
1769 whether they match is considered relevant.  For an example
1770 where side-effects of look-ahead I<might> have influenced the
1771 following match, see L<C<< (?>pattern) >>>.
1772
1773 =head2 Version 8 Regular Expressions
1774 X<regular expression, version 8> X<regex, version 8> X<regexp, version 8>
1775
1776 In case you're not familiar with the "regular" Version 8 regex
1777 routines, here are the pattern-matching rules not described above.
1778
1779 Any single character matches itself, unless it is a I<metacharacter>
1780 with a special meaning described here or above.  You can cause
1781 characters that normally function as metacharacters to be interpreted
1782 literally by prefixing them with a "\" (e.g., "\." matches a ".", not any
1783 character; "\\" matches a "\"). This escape mechanism is also required
1784 for the character used as the pattern delimiter.
1785
1786 A series of characters matches that series of characters in the target
1787 string, so the pattern  C<blurfl> would match "blurfl" in the target
1788 string.
1789
1790 You can specify a character class, by enclosing a list of characters
1791 in C<[]>, which will match any character from the list.  If the
1792 first character after the "[" is "^", the class matches any character not
1793 in the list.  Within a list, the "-" character specifies a
1794 range, so that C<a-z> represents all characters between "a" and "z",
1795 inclusive.  If you want either "-" or "]" itself to be a member of a
1796 class, put it at the start of the list (possibly after a "^"), or
1797 escape it with a backslash.  "-" is also taken literally when it is
1798 at the end of the list, just before the closing "]".  (The
1799 following all specify the same class of three characters: C<[-az]>,
1800 C<[az-]>, and C<[a\-z]>.  All are different from C<[a-z]>, which
1801 specifies a class containing twenty-six characters, even on EBCDIC-based
1802 character sets.)  Also, if you try to use the character
1803 classes C<\w>, C<\W>, C<\s>, C<\S>, C<\d>, or C<\D> as endpoints of
1804 a range, the "-" is understood literally.
1805
1806 Note also that the whole range idea is rather unportable between
1807 character sets--and even within character sets they may cause results
1808 you probably didn't expect.  A sound principle is to use only ranges
1809 that begin from and end at either alphabetics of equal case ([a-e],
1810 [A-E]), or digits ([0-9]).  Anything else is unsafe.  If in doubt,
1811 spell out the character sets in full.
1812
1813 Characters may be specified using a metacharacter syntax much like that
1814 used in C: "\n" matches a newline, "\t" a tab, "\r" a carriage return,
1815 "\f" a form feed, etc.  More generally, \I<nnn>, where I<nnn> is a string
1816 of octal digits, matches the character whose coded character set value
1817 is I<nnn>.  Similarly, \xI<nn>, where I<nn> are hexadecimal digits,
1818 matches the character whose numeric value is I<nn>. The expression \cI<x>
1819 matches the character control-I<x>.  Finally, the "." metacharacter
1820 matches any character except "\n" (unless you use C</s>).
1821
1822 You can specify a series of alternatives for a pattern using "|" to
1823 separate them, so that C<fee|fie|foe> will match any of "fee", "fie",
1824 or "foe" in the target string (as would C<f(e|i|o)e>).  The
1825 first alternative includes everything from the last pattern delimiter
1826 ("(", "[", or the beginning of the pattern) up to the first "|", and
1827 the last alternative contains everything from the last "|" to the next
1828 pattern delimiter.  That's why it's common practice to include
1829 alternatives in parentheses: to minimize confusion about where they
1830 start and end.
1831
1832 Alternatives are tried from left to right, so the first
1833 alternative found for which the entire expression matches, is the one that
1834 is chosen. This means that alternatives are not necessarily greedy. For
1835 example: when matching C<foo|foot> against "barefoot", only the "foo"
1836 part will match, as that is the first alternative tried, and it successfully
1837 matches the target string. (This might not seem important, but it is
1838 important when you are capturing matched text using parentheses.)
1839
1840 Also remember that "|" is interpreted as a literal within square brackets,
1841 so if you write C<[fee|fie|foe]> you're really only matching C<[feio|]>.
1842
1843 Within a pattern, you may designate subpatterns for later reference
1844 by enclosing them in parentheses, and you may refer back to the
1845 I<n>th subpattern later in the pattern using the metacharacter
1846 \I<n>.  Subpatterns are numbered based on the left to right order
1847 of their opening parenthesis.  A backreference matches whatever
1848 actually matched the subpattern in the string being examined, not
1849 the rules for that subpattern.  Therefore, C<(0|0x)\d*\s\1\d*> will
1850 match "0x1234 0x4321", but not "0x1234 01234", because subpattern
1851 1 matched "0x", even though the rule C<0|0x> could potentially match
1852 the leading 0 in the second number.
1853
1854 =head2 Warning on \1 Instead of $1
1855
1856 Some people get too used to writing things like:
1857
1858     $pattern =~ s/(\W)/\\\1/g;
1859
1860 This is grandfathered for the RHS of a substitute to avoid shocking the
1861 B<sed> addicts, but it's a dirty habit to get into.  That's because in
1862 PerlThink, the righthand side of an C<s///> is a double-quoted string.  C<\1> in
1863 the usual double-quoted string means a control-A.  The customary Unix
1864 meaning of C<\1> is kludged in for C<s///>.  However, if you get into the habit
1865 of doing that, you get yourself into trouble if you then add an C</e>
1866 modifier.
1867
1868     s/(\d+)/ \1 + 1 /eg;        # causes warning under -w
1869
1870 Or if you try to do
1871
1872     s/(\d+)/\1000/;
1873
1874 You can't disambiguate that by saying C<\{1}000>, whereas you can fix it with
1875 C<${1}000>.  The operation of interpolation should not be confused
1876 with the operation of matching a backreference.  Certainly they mean two
1877 different things on the I<left> side of the C<s///>.
1878
1879 =head2 Repeated Patterns Matching a Zero-length Substring
1880
1881 B<WARNING>: Difficult material (and prose) ahead.  This section needs a rewrite.
1882
1883 Regular expressions provide a terse and powerful programming language.  As
1884 with most other power tools, power comes together with the ability
1885 to wreak havoc.
1886
1887 A common abuse of this power stems from the ability to make infinite
1888 loops using regular expressions, with something as innocuous as:
1889
1890     'foo' =~ m{ ( o? )* }x;
1891
1892 The C<o?> matches at the beginning of C<'foo'>, and since the position
1893 in the string is not moved by the match, C<o?> would match again and again
1894 because of the C<*> quantifier.  Another common way to create a similar cycle
1895 is with the looping modifier C<//g>:
1896
1897     @matches = ( 'foo' =~ m{ o? }xg );
1898
1899 or
1900
1901     print "match: <$&>\n" while 'foo' =~ m{ o? }xg;
1902
1903 or the loop implied by split().
1904
1905 However, long experience has shown that many programming tasks may
1906 be significantly simplified by using repeated subexpressions that
1907 may match zero-length substrings.  Here's a simple example being:
1908
1909     @chars = split //, $string;           # // is not magic in split
1910     ($whitewashed = $string) =~ s/()/ /g; # parens avoid magic s// /
1911
1912 Thus Perl allows such constructs, by I<forcefully breaking
1913 the infinite loop>.  The rules for this are different for lower-level
1914 loops given by the greedy quantifiers C<*+{}>, and for higher-level
1915 ones like the C</g> modifier or split() operator.
1916
1917 The lower-level loops are I<interrupted> (that is, the loop is
1918 broken) when Perl detects that a repeated expression matched a
1919 zero-length substring.   Thus
1920
1921    m{ (?: NON_ZERO_LENGTH | ZERO_LENGTH )* }x;
1922
1923 is made equivalent to
1924
1925    m{   (?: NON_ZERO_LENGTH )*
1926       |
1927         (?: ZERO_LENGTH )?
1928     }x;
1929
1930 The higher level-loops preserve an additional state between iterations:
1931 whether the last match was zero-length.  To break the loop, the following
1932 match after a zero-length match is prohibited to have a length of zero.
1933 This prohibition interacts with backtracking (see L<"Backtracking">),
1934 and so the I<second best> match is chosen if the I<best> match is of
1935 zero length.
1936
1937 For example:
1938
1939     $_ = 'bar';
1940     s/\w??/<$&>/g;
1941
1942 results in C<< <><b><><a><><r><> >>.  At each position of the string the best
1943 match given by non-greedy C<??> is the zero-length match, and the I<second
1944 best> match is what is matched by C<\w>.  Thus zero-length matches
1945 alternate with one-character-long matches.
1946
1947 Similarly, for repeated C<m/()/g> the second-best match is the match at the
1948 position one notch further in the string.
1949
1950 The additional state of being I<matched with zero-length> is associated with
1951 the matched string, and is reset by each assignment to pos().
1952 Zero-length matches at the end of the previous match are ignored
1953 during C<split>.
1954
1955 =head2 Combining RE Pieces
1956
1957 Each of the elementary pieces of regular expressions which were described
1958 before (such as C<ab> or C<\Z>) could match at most one substring
1959 at the given position of the input string.  However, in a typical regular
1960 expression these elementary pieces are combined into more complicated
1961 patterns using combining operators C<ST>, C<S|T>, C<S*> etc
1962 (in these examples C<S> and C<T> are regular subexpressions).
1963
1964 Such combinations can include alternatives, leading to a problem of choice:
1965 if we match a regular expression C<a|ab> against C<"abc">, will it match
1966 substring C<"a"> or C<"ab">?  One way to describe which substring is
1967 actually matched is the concept of backtracking (see L<"Backtracking">).
1968 However, this description is too low-level and makes you think
1969 in terms of a particular implementation.
1970
1971 Another description starts with notions of "better"/"worse".  All the
1972 substrings which may be matched by the given regular expression can be
1973 sorted from the "best" match to the "worst" match, and it is the "best"
1974 match which is chosen.  This substitutes the question of "what is chosen?"
1975 by the question of "which matches are better, and which are worse?".
1976
1977 Again, for elementary pieces there is no such question, since at most
1978 one match at a given position is possible.  This section describes the
1979 notion of better/worse for combining operators.  In the description
1980 below C<S> and C<T> are regular subexpressions.
1981
1982 =over 4
1983
1984 =item C<ST>
1985
1986 Consider two possible matches, C<AB> and C<A'B'>, C<A> and C<A'> are
1987 substrings which can be matched by C<S>, C<B> and C<B'> are substrings
1988 which can be matched by C<T>.
1989
1990 If C<A> is better match for C<S> than C<A'>, C<AB> is a better
1991 match than C<A'B'>.
1992
1993 If C<A> and C<A'> coincide: C<AB> is a better match than C<AB'> if
1994 C<B> is better match for C<T> than C<B'>.
1995
1996 =item C<S|T>
1997
1998 When C<S> can match, it is a better match than when only C<T> can match.
1999
2000 Ordering of two matches for C<S> is the same as for C<S>.  Similar for
2001 two matches for C<T>.
2002
2003 =item C<S{REPEAT_COUNT}>
2004
2005 Matches as C<SSS...S> (repeated as many times as necessary).
2006
2007 =item C<S{min,max}>
2008
2009 Matches as C<S{max}|S{max-1}|...|S{min+1}|S{min}>.
2010
2011 =item C<S{min,max}?>
2012
2013 Matches as C<S{min}|S{min+1}|...|S{max-1}|S{max}>.
2014
2015 =item C<S?>, C<S*>, C<S+>
2016
2017 Same as C<S{0,1}>, C<S{0,BIG_NUMBER}>, C<S{1,BIG_NUMBER}> respectively.
2018
2019 =item C<S??>, C<S*?>, C<S+?>
2020
2021 Same as C<S{0,1}?>, C<S{0,BIG_NUMBER}?>, C<S{1,BIG_NUMBER}?> respectively.
2022
2023 =item C<< (?>S) >>
2024
2025 Matches the best match for C<S> and only that.
2026
2027 =item C<(?=S)>, C<(?<=S)>
2028
2029 Only the best match for C<S> is considered.  (This is important only if
2030 C<S> has capturing parentheses, and backreferences are used somewhere
2031 else in the whole regular expression.)
2032
2033 =item C<(?!S)>, C<(?<!S)>
2034
2035 For this grouping operator there is no need to describe the ordering, since
2036 only whether or not C<S> can match is important.
2037
2038 =item C<(??{ EXPR })>, C<(?PARNO)>
2039
2040 The ordering is the same as for the regular expression which is
2041 the result of EXPR, or the pattern contained by capture buffer PARNO.
2042
2043 =item C<(?(condition)yes-pattern|no-pattern)>
2044
2045 Recall that which of C<yes-pattern> or C<no-pattern> actually matches is
2046 already determined.  The ordering of the matches is the same as for the
2047 chosen subexpression.
2048
2049 =back
2050
2051 The above recipes describe the ordering of matches I<at a given position>.
2052 One more rule is needed to understand how a match is determined for the
2053 whole regular expression: a match at an earlier position is always better
2054 than a match at a later position.
2055
2056 =head2 Creating Custom RE Engines
2057
2058 Overloaded constants (see L<overload>) provide a simple way to extend
2059 the functionality of the RE engine.
2060
2061 Suppose that we want to enable a new RE escape-sequence C<\Y|> which
2062 matches at a boundary between whitespace characters and non-whitespace
2063 characters.  Note that C<(?=\S)(?<!\S)|(?!\S)(?<=\S)> matches exactly
2064 at these positions, so we want to have each C<\Y|> in the place of the
2065 more complicated version.  We can create a module C<customre> to do
2066 this:
2067
2068     package customre;
2069     use overload;
2070
2071     sub import {
2072       shift;
2073       die "No argument to customre::import allowed" if @_;
2074       overload::constant 'qr' => \&convert;
2075     }
2076
2077     sub invalid { die "/$_[0]/: invalid escape '\\$_[1]'"}
2078
2079     # We must also take care of not escaping the legitimate \\Y|
2080     # sequence, hence the presence of '\\' in the conversion rules.
2081     my %rules = ( '\\' => '\\\\',
2082                   'Y|' => qr/(?=\S)(?<!\S)|(?!\S)(?<=\S)/ );
2083     sub convert {
2084       my $re = shift;
2085       $re =~ s{
2086                 \\ ( \\ | Y . )
2087               }
2088               { $rules{$1} or invalid($re,$1) }sgex;
2089       return $re;
2090     }
2091
2092 Now C<use customre> enables the new escape in constant regular
2093 expressions, i.e., those without any runtime variable interpolations.
2094 As documented in L<overload>, this conversion will work only over
2095 literal parts of regular expressions.  For C<\Y|$re\Y|> the variable
2096 part of this regular expression needs to be converted explicitly
2097 (but only if the special meaning of C<\Y|> should be enabled inside $re):
2098
2099     use customre;
2100     $re = <>;
2101     chomp $re;
2102     $re = customre::convert $re;
2103     /\Y|$re\Y|/;
2104
2105 =head1 PCRE/Python Support
2106
2107 As of Perl 5.10 Perl supports several Python/PCRE specific extensions
2108 to the regex syntax. While Perl programmers are encouraged to use the
2109 Perl specific syntax, the following are legal in Perl 5.10:
2110
2111 =over 4
2112
2113 =item C<< (?PE<lt>NAMEE<gt>pattern) >>
2114
2115 Define a named capture buffer. Equivalent to C<< (?<NAME>pattern) >>.
2116
2117 =item C<< (?P=NAME) >>
2118
2119 Backreference to a named capture buffer. Equivalent to C<< \g{NAME} >>.
2120
2121 =item C<< (?P>NAME) >>
2122
2123 Subroutine call to a named capture buffer. Equivalent to C<< (?&NAME) >>.
2124
2125 =back
2126
2127 =head1 BUGS
2128
2129 This document varies from difficult to understand to completely
2130 and utterly opaque.  The wandering prose riddled with jargon is
2131 hard to fathom in several places.
2132
2133 This document needs a rewrite that separates the tutorial content
2134 from the reference content.
2135
2136 =head1 SEE ALSO
2137
2138 L<perlrequick>.
2139
2140 L<perlretut>.
2141
2142 L<perlop/"Regexp Quote-Like Operators">.
2143
2144 L<perlop/"Gory details of parsing quoted constructs">.
2145
2146 L<perlfaq6>.
2147
2148 L<perlfunc/pos>.
2149
2150 L<perllocale>.
2151
2152 L<perlebcdic>.
2153
2154 I<Mastering Regular Expressions> by Jeffrey Friedl, published
2155 by O'Reilly and Associates.