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