Commit | Line | Data |
a0d0e21e |
1 | =head1 NAME |
2 | |
3 | perlre - Perl regular expressions |
4 | |
5 | =head1 DESCRIPTION |
6 | |
cb1a09d0 |
7 | This page describes the syntax of regular expressions in Perl. For a |
5f05dabc |
8 | description of how to I<use> regular expressions in matching |
19799a22 |
9 | operations, plus various examples of the same, see discussions |
1e66bd83 |
10 | of C<m//>, C<s///>, C<qr//> and C<??> in L<perlop/"Regexp Quote-Like Operators">. |
cb1a09d0 |
11 | |
19799a22 |
12 | Matching operations can have various modifiers. Modifiers |
5a964f20 |
13 | that relate to the interpretation of the regular expression inside |
19799a22 |
14 | are listed below. Modifiers that alter the way a regular expression |
15 | is used by Perl are detailed in L<perlop/"Regexp Quote-Like Operators"> and |
1e66bd83 |
16 | L<perlop/"Gory details of parsing quoted constructs">. |
a0d0e21e |
17 | |
55497cff |
18 | =over 4 |
19 | |
20 | =item i |
21 | |
22 | Do case-insensitive pattern matching. |
23 | |
a034a98d |
24 | If C<use locale> is in effect, the case map is taken from the current |
25 | locale. See L<perllocale>. |
26 | |
54310121 |
27 | =item m |
55497cff |
28 | |
29 | Treat string as multiple lines. That is, change "^" and "$" from matching |
14218588 |
30 | the start or end of the string to matching the start or end of any |
7f761169 |
31 | line anywhere within the string. |
55497cff |
32 | |
54310121 |
33 | =item s |
55497cff |
34 | |
35 | Treat string as single line. That is, change "." to match any character |
19799a22 |
36 | whatsoever, even a newline, which normally it would not match. |
55497cff |
37 | |
19799a22 |
38 | The C</s> and C</m> modifiers both override the C<$*> setting. That |
39 | is, no matter what C<$*> contains, C</s> without C</m> will force |
40 | "^" to match only at the beginning of the string and "$" to match |
41 | only at the end (or just before a newline at the end) of the string. |
42 | Together, as /ms, they let the "." match any character whatsoever, |
43 | while yet allowing "^" and "$" to match, respectively, just after |
44 | and just before newlines within the string. |
7b8d334a |
45 | |
54310121 |
46 | =item x |
55497cff |
47 | |
48 | Extend your pattern's legibility by permitting whitespace and comments. |
49 | |
50 | =back |
a0d0e21e |
51 | |
52 | These are usually written as "the C</x> modifier", even though the delimiter |
14218588 |
53 | in question might not really be a slash. Any of these |
a0d0e21e |
54 | modifiers may also be embedded within the regular expression itself using |
14218588 |
55 | the C<(?...)> construct. See below. |
a0d0e21e |
56 | |
4633a7c4 |
57 | The C</x> modifier itself needs a little more explanation. It tells |
55497cff |
58 | the regular expression parser to ignore whitespace that is neither |
59 | backslashed nor within a character class. You can use this to break up |
4633a7c4 |
60 | your regular expression into (slightly) more readable parts. The C<#> |
54310121 |
61 | character is also treated as a metacharacter introducing a comment, |
55497cff |
62 | just as in ordinary Perl code. This also means that if you want real |
14218588 |
63 | whitespace or C<#> characters in the pattern (outside a character |
5a964f20 |
64 | class, where they are unaffected by C</x>), that you'll either have to |
55497cff |
65 | escape them or encode them using octal or hex escapes. Taken together, |
66 | these features go a long way towards making Perl's regular expressions |
0c815be9 |
67 | more readable. Note that you have to be careful not to include the |
68 | pattern delimiter in the comment--perl has no way of knowing you did |
5a964f20 |
69 | not intend to close the pattern early. See the C-comment deletion code |
0c815be9 |
70 | in L<perlop>. |
a0d0e21e |
71 | |
72 | =head2 Regular Expressions |
73 | |
19799a22 |
74 | The patterns used in Perl pattern matching derive from supplied in |
14218588 |
75 | the Version 8 regex routines. (The routines are derived |
19799a22 |
76 | (distantly) from Henry Spencer's freely redistributable reimplementation |
77 | of the V8 routines.) See L<Version 8 Regular Expressions> for |
78 | details. |
a0d0e21e |
79 | |
80 | In particular the following metacharacters have their standard I<egrep>-ish |
81 | meanings: |
82 | |
54310121 |
83 | \ Quote the next metacharacter |
a0d0e21e |
84 | ^ Match the beginning of the line |
85 | . Match any character (except newline) |
c07a80fd |
86 | $ Match the end of the line (or before newline at the end) |
a0d0e21e |
87 | | Alternation |
88 | () Grouping |
89 | [] Character class |
90 | |
14218588 |
91 | By default, the "^" character is guaranteed to match only the |
92 | beginning of the string, the "$" character only the end (or before the |
93 | newline at the end), and Perl does certain optimizations with the |
a0d0e21e |
94 | assumption that the string contains only one line. Embedded newlines |
95 | will not be matched by "^" or "$". You may, however, wish to treat a |
4a6725af |
96 | string as a multi-line buffer, such that the "^" will match after any |
a0d0e21e |
97 | newline within the string, and "$" will match before any newline. At the |
98 | cost of a little more overhead, you can do this by using the /m modifier |
99 | on the pattern match operator. (Older programs did this by setting C<$*>, |
5f05dabc |
100 | but this practice is now deprecated.) |
a0d0e21e |
101 | |
14218588 |
102 | To simplify multi-line substitutions, the "." character never matches a |
55497cff |
103 | newline unless you use the C</s> modifier, which in effect tells Perl to pretend |
a0d0e21e |
104 | the string is a single line--even if it isn't. The C</s> modifier also |
105 | overrides the setting of C<$*>, in case you have some (badly behaved) older |
106 | code that sets it in another module. |
107 | |
108 | The following standard quantifiers are recognized: |
109 | |
110 | * Match 0 or more times |
111 | + Match 1 or more times |
112 | ? Match 1 or 0 times |
113 | {n} Match exactly n times |
114 | {n,} Match at least n times |
115 | {n,m} Match at least n but not more than m times |
116 | |
117 | (If a curly bracket occurs in any other context, it is treated |
118 | as a regular character.) The "*" modifier is equivalent to C<{0,}>, the "+" |
25f94b33 |
119 | modifier to C<{1,}>, and the "?" modifier to C<{0,1}>. n and m are limited |
9c79236d |
120 | to integral values less than a preset limit defined when perl is built. |
121 | This is usually 32766 on the most common platforms. The actual limit can |
122 | be seen in the error message generated by code such as this: |
123 | |
820475bd |
124 | $_ **= $_ , / {$_} / for 2 .. 42; |
a0d0e21e |
125 | |
54310121 |
126 | By default, a quantified subpattern is "greedy", that is, it will match as |
127 | many times as possible (given a particular starting location) while still |
128 | allowing the rest of the pattern to match. If you want it to match the |
129 | minimum number of times possible, follow the quantifier with a "?". Note |
130 | that the meanings don't change, just the "greediness": |
a0d0e21e |
131 | |
132 | *? Match 0 or more times |
133 | +? Match 1 or more times |
134 | ?? Match 0 or 1 time |
135 | {n}? Match exactly n times |
136 | {n,}? Match at least n times |
137 | {n,m}? Match at least n but not more than m times |
138 | |
5f05dabc |
139 | Because patterns are processed as double quoted strings, the following |
a0d0e21e |
140 | also work: |
141 | |
0f36ee90 |
142 | \t tab (HT, TAB) |
143 | \n newline (LF, NL) |
144 | \r return (CR) |
145 | \f form feed (FF) |
146 | \a alarm (bell) (BEL) |
147 | \e escape (think troff) (ESC) |
cb1a09d0 |
148 | \033 octal char (think of a PDP-11) |
149 | \x1B hex char |
a0ed51b3 |
150 | \x{263a} wide hex char (Unicode SMILEY) |
a0d0e21e |
151 | \c[ control char |
4a2d328f |
152 | \N{name} named char |
cb1a09d0 |
153 | \l lowercase next char (think vi) |
154 | \u uppercase next char (think vi) |
155 | \L lowercase till \E (think vi) |
156 | \U uppercase till \E (think vi) |
157 | \E end case modification (think vi) |
5a964f20 |
158 | \Q quote (disable) pattern metacharacters till \E |
a0d0e21e |
159 | |
a034a98d |
160 | If C<use locale> is in effect, the case map used by C<\l>, C<\L>, C<\u> |
423cee85 |
161 | and C<\U> is taken from the current locale. See L<perllocale>. For |
4a2d328f |
162 | documentation of C<\N{name}>, see L<charnames>. |
a034a98d |
163 | |
1d2dff63 |
164 | You cannot include a literal C<$> or C<@> within a C<\Q> sequence. |
165 | An unescaped C<$> or C<@> interpolates the corresponding variable, |
166 | while escaping will cause the literal string C<\$> to be matched. |
167 | You'll need to write something like C<m/\Quser\E\@\Qhost/>. |
168 | |
a0d0e21e |
169 | In addition, Perl defines the following: |
170 | |
171 | \w Match a "word" character (alphanumeric plus "_") |
36bbe248 |
172 | \W Match a non-"word" character |
a0d0e21e |
173 | \s Match a whitespace character |
174 | \S Match a non-whitespace character |
175 | \d Match a digit character |
176 | \D Match a non-digit character |
a0ed51b3 |
177 | \pP Match P, named property. Use \p{Prop} for longer names. |
178 | \PP Match non-P |
f244e06d |
179 | \X Match eXtended Unicode "combining character sequence", |
180 | equivalent to C<(?:\PM\pM*)> |
4a2d328f |
181 | \C Match a single C char (octet) even under utf8. |
a0d0e21e |
182 | |
36bbe248 |
183 | A C<\w> matches a single alphanumeric character or C<_>, not a whole word. |
14218588 |
184 | Use C<\w+> to match a string of Perl-identifier characters (which isn't |
185 | the same as matching an English word). If C<use locale> is in effect, the |
186 | list of alphabetic characters generated by C<\w> is taken from the |
187 | current locale. See L<perllocale>. You may use C<\w>, C<\W>, C<\s>, C<\S>, |
1209ba90 |
188 | C<\d>, and C<\D> within character classes, but if you try to use them |
189 | as endpoints of a range, that's not a range, the "-" is understood literally. |
190 | See L<utf8> for details about C<\pP>, C<\PP>, and C<\X>. |
a0d0e21e |
191 | |
b8c5462f |
192 | The POSIX character class syntax |
193 | |
820475bd |
194 | [:class:] |
b8c5462f |
195 | |
26b44a0a |
196 | is also available. The available classes and their backslash |
197 | equivalents (if available) are as follows: |
b8c5462f |
198 | |
199 | alpha |
200 | alnum |
201 | ascii |
aaa51d5e |
202 | blank [1] |
b8c5462f |
203 | cntrl |
204 | digit \d |
205 | graph |
206 | lower |
207 | print |
208 | punct |
aaa51d5e |
209 | space \s [2] |
b8c5462f |
210 | upper |
aaa51d5e |
211 | word \w [3] |
b8c5462f |
212 | xdigit |
213 | |
aaa51d5e |
214 | [1] A GNU extension equivalent to C<[ \t]>, `all horizontal whitespace'. |
215 | [2] Not I<exactly equivalent> to C<\s> since the C<[[:space:]]> includes |
216 | also the (very rare) `vertical tabulator', "\ck", chr(11). |
217 | [3] A Perl extension. |
218 | |
26b44a0a |
219 | For example use C<[:upper:]> to match all the uppercase characters. |
aaa51d5e |
220 | Note that the C<[]> are part of the C<[::]> construct, not part of the |
221 | whole character class. For example: |
b8c5462f |
222 | |
820475bd |
223 | [01[:alpha:]%] |
b8c5462f |
224 | |
593df60c |
225 | matches zero, one, any alphabetic character, and the percentage sign. |
b8c5462f |
226 | |
26b44a0a |
227 | If the C<utf8> pragma is used, the following equivalences to Unicode |
b8c5462f |
228 | \p{} constructs hold: |
229 | |
230 | alpha IsAlpha |
231 | alnum IsAlnum |
232 | ascii IsASCII |
aaa51d5e |
233 | blank IsSpace |
b8c5462f |
234 | cntrl IsCntrl |
235 | digit IsDigit |
236 | graph IsGraph |
237 | lower IsLower |
238 | print IsPrint |
239 | punct IsPunct |
240 | space IsSpace |
241 | upper IsUpper |
242 | word IsWord |
243 | xdigit IsXDigit |
244 | |
26b44a0a |
245 | For example C<[:lower:]> and C<\p{IsLower}> are equivalent. |
b8c5462f |
246 | |
247 | If the C<utf8> pragma is not used but the C<locale> pragma is, the |
aaa51d5e |
248 | classes correlate with the usual isalpha(3) interface (except for |
249 | `word' and `blank'). |
b8c5462f |
250 | |
251 | The assumedly non-obviously named classes are: |
252 | |
253 | =over 4 |
254 | |
255 | =item cntrl |
256 | |
820475bd |
257 | Any control character. Usually characters that don't produce output as |
258 | such but instead control the terminal somehow: for example newline and |
259 | backspace are control characters. All characters with ord() less than |
593df60c |
260 | 32 are most often classified as control characters (assuming ASCII, |
261 | the ISO Latin character sets, and Unicode). |
b8c5462f |
262 | |
263 | =item graph |
264 | |
f1cbbd6e |
265 | Any alphanumeric or punctuation (special) character. |
b8c5462f |
266 | |
267 | =item print |
268 | |
f1cbbd6e |
269 | Any alphanumeric or punctuation (special) character or space. |
b8c5462f |
270 | |
271 | =item punct |
272 | |
f1cbbd6e |
273 | Any punctuation (special) character. |
b8c5462f |
274 | |
275 | =item xdigit |
276 | |
593df60c |
277 | Any hexadecimal digit. Though this may feel silly ([0-9A-Fa-f] would |
820475bd |
278 | work just fine) it is included for completeness. |
b8c5462f |
279 | |
b8c5462f |
280 | =back |
281 | |
282 | You can negate the [::] character classes by prefixing the class name |
283 | with a '^'. This is a Perl extension. For example: |
284 | |
93733859 |
285 | POSIX trad. Perl utf8 Perl |
286 | |
287 | [:^digit:] \D \P{IsDigit} |
288 | [:^space:] \S \P{IsSpace} |
289 | [:^word:] \W \P{IsWord} |
b8c5462f |
290 | |
26b44a0a |
291 | The POSIX character classes [.cc.] and [=cc=] are recognized but |
292 | B<not> supported and trying to use them will cause an error. |
b8c5462f |
293 | |
a0d0e21e |
294 | Perl defines the following zero-width assertions: |
295 | |
296 | \b Match a word boundary |
297 | \B Match a non-(word boundary) |
b85d18e9 |
298 | \A Match only at beginning of string |
299 | \Z Match only at end of string, or before newline at the end |
300 | \z Match only at end of string |
9da458fc |
301 | \G Match only at pos() (e.g. at the end-of-match position |
302 | of prior m//g) |
a0d0e21e |
303 | |
14218588 |
304 | A word boundary (C<\b>) is a spot between two characters |
19799a22 |
305 | that has a C<\w> on one side of it and a C<\W> on the other side |
306 | of it (in either order), counting the imaginary characters off the |
307 | beginning and end of the string as matching a C<\W>. (Within |
308 | character classes C<\b> represents backspace rather than a word |
309 | boundary, just as it normally does in any double-quoted string.) |
310 | The C<\A> and C<\Z> are just like "^" and "$", except that they |
311 | won't match multiple times when the C</m> modifier is used, while |
312 | "^" and "$" will match at every internal line boundary. To match |
313 | the actual end of the string and not ignore an optional trailing |
314 | newline, use C<\z>. |
315 | |
316 | The C<\G> assertion can be used to chain global matches (using |
317 | C<m//g>), as described in L<perlop/"Regexp Quote-Like Operators">. |
318 | It is also useful when writing C<lex>-like scanners, when you have |
319 | several patterns that you want to match against consequent substrings |
320 | of your string, see the previous reference. The actual location |
321 | where C<\G> will match can also be influenced by using C<pos()> as |
322 | an lvalue. See L<perlfunc/pos>. |
c47ff5f1 |
323 | |
14218588 |
324 | The bracketing construct C<( ... )> creates capture buffers. To |
c47ff5f1 |
325 | refer to the digit'th buffer use \<digit> within the |
14218588 |
326 | match. Outside the match use "$" instead of "\". (The |
c47ff5f1 |
327 | \<digit> notation works in certain circumstances outside |
14218588 |
328 | the match. See the warning below about \1 vs $1 for details.) |
329 | Referring back to another part of the match is called a |
330 | I<backreference>. |
331 | |
332 | There is no limit to the number of captured substrings that you may |
333 | use. However Perl also uses \10, \11, etc. as aliases for \010, |
334 | \011, etc. (Recall that 0 means octal, so \011 is the 9'th ASCII |
335 | character, a tab.) Perl resolves this ambiguity by interpreting |
336 | \10 as a backreference only if at least 10 left parentheses have |
337 | opened before it. Likewise \11 is a backreference only if at least |
338 | 11 left parentheses have opened before it. And so on. \1 through |
339 | \9 are always interpreted as backreferences." |
340 | |
341 | Examples: |
a0d0e21e |
342 | |
343 | s/^([^ ]*) *([^ ]*)/$2 $1/; # swap first two words |
344 | |
14218588 |
345 | if (/(.)\1/) { # find first doubled char |
346 | print "'$1' is the first doubled character\n"; |
347 | } |
c47ff5f1 |
348 | |
14218588 |
349 | if (/Time: (..):(..):(..)/) { # parse out values |
a0d0e21e |
350 | $hours = $1; |
351 | $minutes = $2; |
352 | $seconds = $3; |
353 | } |
c47ff5f1 |
354 | |
14218588 |
355 | Several special variables also refer back to portions of the previous |
356 | match. C<$+> returns whatever the last bracket match matched. |
357 | C<$&> returns the entire matched string. (At one point C<$0> did |
358 | also, but now it returns the name of the program.) C<$`> returns |
359 | everything before the matched string. And C<$'> returns everything |
360 | after the matched string. |
361 | |
362 | The numbered variables ($1, $2, $3, etc.) and the related punctuation |
262ffc8b |
363 | set (C<$+>, C<$&>, C<$`>, and C<$'>) are all dynamically scoped |
14218588 |
364 | until the end of the enclosing block or until the next successful |
365 | match, whichever comes first. (See L<perlsyn/"Compound Statements">.) |
366 | |
367 | B<WARNING>: Once Perl sees that you need one of C<$&>, C<$`>, or |
368 | C<$'> anywhere in the program, it has to provide them for every |
369 | pattern match. This may substantially slow your program. Perl |
370 | uses the same mechanism to produce $1, $2, etc, so you also pay a |
371 | price for each pattern that contains capturing parentheses. (To |
372 | avoid this cost while retaining the grouping behaviour, use the |
373 | extended regular expression C<(?: ... )> instead.) But if you never |
374 | use C<$&>, C<$`> or C<$'>, then patterns I<without> capturing |
375 | parentheses will not be penalized. So avoid C<$&>, C<$'>, and C<$`> |
376 | if you can, but if you can't (and some algorithms really appreciate |
377 | them), once you've used them once, use them at will, because you've |
378 | already paid the price. As of 5.005, C<$&> is not so costly as the |
379 | other two. |
68dc0745 |
380 | |
19799a22 |
381 | Backslashed metacharacters in Perl are alphanumeric, such as C<\b>, |
382 | C<\w>, C<\n>. Unlike some other regular expression languages, there |
383 | are no backslashed symbols that aren't alphanumeric. So anything |
c47ff5f1 |
384 | that looks like \\, \(, \), \<, \>, \{, or \} is always |
19799a22 |
385 | interpreted as a literal character, not a metacharacter. This was |
386 | once used in a common idiom to disable or quote the special meanings |
387 | of regular expression metacharacters in a string that you want to |
36bbe248 |
388 | use for a pattern. Simply quote all non-"word" characters: |
a0d0e21e |
389 | |
390 | $pattern =~ s/(\W)/\\$1/g; |
391 | |
f1cbbd6e |
392 | (If C<use locale> is set, then this depends on the current locale.) |
14218588 |
393 | Today it is more common to use the quotemeta() function or the C<\Q> |
394 | metaquoting escape sequence to disable all metacharacters' special |
395 | meanings like this: |
a0d0e21e |
396 | |
397 | /$unquoted\Q$quoted\E$unquoted/ |
398 | |
9da458fc |
399 | Beware that if you put literal backslashes (those not inside |
400 | interpolated variables) between C<\Q> and C<\E>, double-quotish |
401 | backslash interpolation may lead to confusing results. If you |
402 | I<need> to use literal backslashes within C<\Q...\E>, |
403 | consult L<perlop/"Gory details of parsing quoted constructs">. |
404 | |
19799a22 |
405 | =head2 Extended Patterns |
406 | |
14218588 |
407 | Perl also defines a consistent extension syntax for features not |
408 | found in standard tools like B<awk> and B<lex>. The syntax is a |
409 | pair of parentheses with a question mark as the first thing within |
410 | the parentheses. The character after the question mark indicates |
411 | the extension. |
19799a22 |
412 | |
14218588 |
413 | The stability of these extensions varies widely. Some have been |
414 | part of the core language for many years. Others are experimental |
415 | and may change without warning or be completely removed. Check |
416 | the documentation on an individual feature to verify its current |
417 | status. |
19799a22 |
418 | |
14218588 |
419 | A question mark was chosen for this and for the minimal-matching |
420 | construct because 1) question marks are rare in older regular |
421 | expressions, and 2) whenever you see one, you should stop and |
422 | "question" exactly what is going on. That's psychology... |
a0d0e21e |
423 | |
424 | =over 10 |
425 | |
cc6b7395 |
426 | =item C<(?#text)> |
a0d0e21e |
427 | |
14218588 |
428 | A comment. The text is ignored. If the C</x> modifier enables |
19799a22 |
429 | whitespace formatting, a simple C<#> will suffice. Note that Perl closes |
259138e3 |
430 | the comment as soon as it sees a C<)>, so there is no way to put a literal |
431 | C<)> in the comment. |
a0d0e21e |
432 | |
19799a22 |
433 | =item C<(?imsx-imsx)> |
434 | |
435 | One or more embedded pattern-match modifiers. This is particularly |
436 | useful for dynamic patterns, such as those read in from a configuration |
437 | file, read in as an argument, are specified in a table somewhere, |
438 | etc. Consider the case that some of which want to be case sensitive |
439 | and some do not. The case insensitive ones need to include merely |
440 | C<(?i)> at the front of the pattern. For example: |
441 | |
442 | $pattern = "foobar"; |
443 | if ( /$pattern/i ) { } |
444 | |
445 | # more flexible: |
446 | |
447 | $pattern = "(?i)foobar"; |
448 | if ( /$pattern/ ) { } |
449 | |
450 | Letters after a C<-> turn those modifiers off. These modifiers are |
451 | localized inside an enclosing group (if any). For example, |
452 | |
453 | ( (?i) blah ) \s+ \1 |
454 | |
455 | will match a repeated (I<including the case>!) word C<blah> in any |
14218588 |
456 | case, assuming C<x> modifier, and no C<i> modifier outside this |
19799a22 |
457 | group. |
458 | |
5a964f20 |
459 | =item C<(?:pattern)> |
a0d0e21e |
460 | |
ca9dfc88 |
461 | =item C<(?imsx-imsx:pattern)> |
462 | |
5a964f20 |
463 | This is for clustering, not capturing; it groups subexpressions like |
464 | "()", but doesn't make backreferences as "()" does. So |
a0d0e21e |
465 | |
5a964f20 |
466 | @fields = split(/\b(?:a|b|c)\b/) |
a0d0e21e |
467 | |
468 | is like |
469 | |
5a964f20 |
470 | @fields = split(/\b(a|b|c)\b/) |
a0d0e21e |
471 | |
19799a22 |
472 | but doesn't spit out extra fields. It's also cheaper not to capture |
473 | characters if you don't need to. |
a0d0e21e |
474 | |
19799a22 |
475 | Any letters between C<?> and C<:> act as flags modifiers as with |
476 | C<(?imsx-imsx)>. For example, |
ca9dfc88 |
477 | |
478 | /(?s-i:more.*than).*million/i |
479 | |
14218588 |
480 | is equivalent to the more verbose |
ca9dfc88 |
481 | |
482 | /(?:(?s-i)more.*than).*million/i |
483 | |
5a964f20 |
484 | =item C<(?=pattern)> |
a0d0e21e |
485 | |
19799a22 |
486 | A zero-width positive look-ahead assertion. For example, C</\w+(?=\t)/> |
a0d0e21e |
487 | matches a word followed by a tab, without including the tab in C<$&>. |
488 | |
5a964f20 |
489 | =item C<(?!pattern)> |
a0d0e21e |
490 | |
19799a22 |
491 | A zero-width negative look-ahead assertion. For example C</foo(?!bar)/> |
a0d0e21e |
492 | matches any occurrence of "foo" that isn't followed by "bar". Note |
19799a22 |
493 | however that look-ahead and look-behind are NOT the same thing. You cannot |
494 | use this for look-behind. |
7b8d334a |
495 | |
5a964f20 |
496 | If you are looking for a "bar" that isn't preceded by a "foo", C</(?!foo)bar/> |
7b8d334a |
497 | will not do what you want. That's because the C<(?!foo)> is just saying that |
498 | the next thing cannot be "foo"--and it's not, it's a "bar", so "foobar" will |
499 | match. You would have to do something like C</(?!foo)...bar/> for that. We |
500 | say "like" because there's the case of your "bar" not having three characters |
501 | before it. You could cover that this way: C</(?:(?!foo)...|^.{0,2})bar/>. |
502 | Sometimes it's still easier just to say: |
a0d0e21e |
503 | |
a3cb178b |
504 | if (/bar/ && $` !~ /foo$/) |
a0d0e21e |
505 | |
19799a22 |
506 | For look-behind see below. |
c277df42 |
507 | |
c47ff5f1 |
508 | =item C<(?<=pattern)> |
c277df42 |
509 | |
c47ff5f1 |
510 | A zero-width positive look-behind assertion. For example, C</(?<=\t)\w+/> |
19799a22 |
511 | matches a word that follows a tab, without including the tab in C<$&>. |
512 | Works only for fixed-width look-behind. |
c277df42 |
513 | |
5a964f20 |
514 | =item C<(?<!pattern)> |
c277df42 |
515 | |
19799a22 |
516 | A zero-width negative look-behind assertion. For example C</(?<!bar)foo/> |
517 | matches any occurrence of "foo" that does not follow "bar". Works |
518 | only for fixed-width look-behind. |
c277df42 |
519 | |
cc6b7395 |
520 | =item C<(?{ code })> |
c277df42 |
521 | |
19799a22 |
522 | B<WARNING>: This extended regular expression feature is considered |
523 | highly experimental, and may be changed or deleted without notice. |
c277df42 |
524 | |
19799a22 |
525 | This zero-width assertion evaluate any embedded Perl code. It |
526 | always succeeds, and its C<code> is not interpolated. Currently, |
527 | the rules to determine where the C<code> ends are somewhat convoluted. |
528 | |
529 | The C<code> is properly scoped in the following sense: If the assertion |
530 | is backtracked (compare L<"Backtracking">), all changes introduced after |
531 | C<local>ization are undone, so that |
b9ac3b5b |
532 | |
533 | $_ = 'a' x 8; |
534 | m< |
535 | (?{ $cnt = 0 }) # Initialize $cnt. |
536 | ( |
537 | a |
538 | (?{ |
539 | local $cnt = $cnt + 1; # Update $cnt, backtracking-safe. |
540 | }) |
541 | )* |
542 | aaaa |
543 | (?{ $res = $cnt }) # On success copy to non-localized |
544 | # location. |
545 | >x; |
546 | |
19799a22 |
547 | will set C<$res = 4>. Note that after the match, $cnt returns to the globally |
14218588 |
548 | introduced value, because the scopes that restrict C<local> operators |
b9ac3b5b |
549 | are unwound. |
550 | |
19799a22 |
551 | This assertion may be used as a C<(?(condition)yes-pattern|no-pattern)> |
552 | switch. If I<not> used in this way, the result of evaluation of |
553 | C<code> is put into the special variable C<$^R>. This happens |
554 | immediately, so C<$^R> can be used from other C<(?{ code })> assertions |
555 | inside the same regular expression. |
b9ac3b5b |
556 | |
19799a22 |
557 | The assignment to C<$^R> above is properly localized, so the old |
558 | value of C<$^R> is restored if the assertion is backtracked; compare |
559 | L<"Backtracking">. |
b9ac3b5b |
560 | |
19799a22 |
561 | For reasons of security, this construct is forbidden if the regular |
562 | expression involves run-time interpolation of variables, unless the |
563 | perilous C<use re 'eval'> pragma has been used (see L<re>), or the |
564 | variables contain results of C<qr//> operator (see |
565 | L<perlop/"qr/STRING/imosx">). |
871b0233 |
566 | |
14218588 |
567 | This restriction is because of the wide-spread and remarkably convenient |
19799a22 |
568 | custom of using run-time determined strings as patterns. For example: |
871b0233 |
569 | |
570 | $re = <>; |
571 | chomp $re; |
572 | $string =~ /$re/; |
573 | |
14218588 |
574 | Before Perl knew how to execute interpolated code within a pattern, |
575 | this operation was completely safe from a security point of view, |
576 | although it could raise an exception from an illegal pattern. If |
577 | you turn on the C<use re 'eval'>, though, it is no longer secure, |
578 | so you should only do so if you are also using taint checking. |
579 | Better yet, use the carefully constrained evaluation within a Safe |
580 | module. See L<perlsec> for details about both these mechanisms. |
871b0233 |
581 | |
14455d6c |
582 | =item C<(??{ code })> |
0f5d15d6 |
583 | |
19799a22 |
584 | B<WARNING>: This extended regular expression feature is considered |
585 | highly experimental, and may be changed or deleted without notice. |
9da458fc |
586 | A simplified version of the syntax may be introduced for commonly |
587 | used idioms. |
0f5d15d6 |
588 | |
19799a22 |
589 | This is a "postponed" regular subexpression. The C<code> is evaluated |
590 | at run time, at the moment this subexpression may match. The result |
591 | of evaluation is considered as a regular expression and matched as |
592 | if it were inserted instead of this construct. |
0f5d15d6 |
593 | |
428594d9 |
594 | The C<code> is not interpolated. As before, the rules to determine |
19799a22 |
595 | where the C<code> ends are currently somewhat convoluted. |
596 | |
597 | The following pattern matches a parenthesized group: |
0f5d15d6 |
598 | |
599 | $re = qr{ |
600 | \( |
601 | (?: |
602 | (?> [^()]+ ) # Non-parens without backtracking |
603 | | |
14455d6c |
604 | (??{ $re }) # Group with matching parens |
0f5d15d6 |
605 | )* |
606 | \) |
607 | }x; |
608 | |
c47ff5f1 |
609 | =item C<< (?>pattern) >> |
5a964f20 |
610 | |
19799a22 |
611 | B<WARNING>: This extended regular expression feature is considered |
612 | highly experimental, and may be changed or deleted without notice. |
613 | |
614 | An "independent" subexpression, one which matches the substring |
615 | that a I<standalone> C<pattern> would match if anchored at the given |
9da458fc |
616 | position, and it matches I<nothing other than this substring>. This |
19799a22 |
617 | construct is useful for optimizations of what would otherwise be |
618 | "eternal" matches, because it will not backtrack (see L<"Backtracking">). |
9da458fc |
619 | It may also be useful in places where the "grab all you can, and do not |
620 | give anything back" semantic is desirable. |
19799a22 |
621 | |
c47ff5f1 |
622 | For example: C<< ^(?>a*)ab >> will never match, since C<< (?>a*) >> |
19799a22 |
623 | (anchored at the beginning of string, as above) will match I<all> |
624 | characters C<a> at the beginning of string, leaving no C<a> for |
625 | C<ab> to match. In contrast, C<a*ab> will match the same as C<a+b>, |
626 | since the match of the subgroup C<a*> is influenced by the following |
627 | group C<ab> (see L<"Backtracking">). In particular, C<a*> inside |
628 | C<a*ab> will match fewer characters than a standalone C<a*>, since |
629 | this makes the tail match. |
630 | |
c47ff5f1 |
631 | An effect similar to C<< (?>pattern) >> may be achieved by writing |
19799a22 |
632 | C<(?=(pattern))\1>. This matches the same substring as a standalone |
633 | C<a+>, and the following C<\1> eats the matched string; it therefore |
c47ff5f1 |
634 | makes a zero-length assertion into an analogue of C<< (?>...) >>. |
19799a22 |
635 | (The difference between these two constructs is that the second one |
636 | uses a capturing group, thus shifting ordinals of backreferences |
637 | in the rest of a regular expression.) |
638 | |
639 | Consider this pattern: |
c277df42 |
640 | |
871b0233 |
641 | m{ \( |
642 | ( |
9da458fc |
643 | [^()]+ # x+ |
871b0233 |
644 | | |
645 | \( [^()]* \) |
646 | )+ |
647 | \) |
648 | }x |
5a964f20 |
649 | |
19799a22 |
650 | That will efficiently match a nonempty group with matching parentheses |
651 | two levels deep or less. However, if there is no such group, it |
652 | will take virtually forever on a long string. That's because there |
653 | are so many different ways to split a long string into several |
654 | substrings. This is what C<(.+)+> is doing, and C<(.+)+> is similar |
655 | to a subpattern of the above pattern. Consider how the pattern |
656 | above detects no-match on C<((()aaaaaaaaaaaaaaaaaa> in several |
657 | seconds, but that each extra letter doubles this time. This |
658 | exponential performance will make it appear that your program has |
14218588 |
659 | hung. However, a tiny change to this pattern |
5a964f20 |
660 | |
871b0233 |
661 | m{ \( |
662 | ( |
9da458fc |
663 | (?> [^()]+ ) # change x+ above to (?> x+ ) |
871b0233 |
664 | | |
665 | \( [^()]* \) |
666 | )+ |
667 | \) |
668 | }x |
c277df42 |
669 | |
c47ff5f1 |
670 | which uses C<< (?>...) >> matches exactly when the one above does (verifying |
5a964f20 |
671 | this yourself would be a productive exercise), but finishes in a fourth |
672 | the time when used on a similar string with 1000000 C<a>s. Be aware, |
673 | however, that this pattern currently triggers a warning message under |
9f1b1f2d |
674 | the C<use warnings> pragma or B<-w> switch saying it |
675 | C<"matches the null string many times">): |
c277df42 |
676 | |
c47ff5f1 |
677 | On simple groups, such as the pattern C<< (?> [^()]+ ) >>, a comparable |
19799a22 |
678 | effect may be achieved by negative look-ahead, as in C<[^()]+ (?! [^()] )>. |
c277df42 |
679 | This was only 4 times slower on a string with 1000000 C<a>s. |
680 | |
9da458fc |
681 | The "grab all you can, and do not give anything back" semantic is desirable |
682 | in many situations where on the first sight a simple C<()*> looks like |
683 | the correct solution. Suppose we parse text with comments being delimited |
684 | by C<#> followed by some optional (horizontal) whitespace. Contrary to |
4375e838 |
685 | its appearance, C<#[ \t]*> I<is not> the correct subexpression to match |
9da458fc |
686 | the comment delimiter, because it may "give up" some whitespace if |
687 | the remainder of the pattern can be made to match that way. The correct |
688 | answer is either one of these: |
689 | |
690 | (?>#[ \t]*) |
691 | #[ \t]*(?![ \t]) |
692 | |
693 | For example, to grab non-empty comments into $1, one should use either |
694 | one of these: |
695 | |
696 | / (?> \# [ \t]* ) ( .+ ) /x; |
697 | / \# [ \t]* ( [^ \t] .* ) /x; |
698 | |
699 | Which one you pick depends on which of these expressions better reflects |
700 | the above specification of comments. |
701 | |
5a964f20 |
702 | =item C<(?(condition)yes-pattern|no-pattern)> |
c277df42 |
703 | |
5a964f20 |
704 | =item C<(?(condition)yes-pattern)> |
c277df42 |
705 | |
19799a22 |
706 | B<WARNING>: This extended regular expression feature is considered |
707 | highly experimental, and may be changed or deleted without notice. |
708 | |
c277df42 |
709 | Conditional expression. C<(condition)> should be either an integer in |
710 | parentheses (which is valid if the corresponding pair of parentheses |
19799a22 |
711 | matched), or look-ahead/look-behind/evaluate zero-width assertion. |
c277df42 |
712 | |
19799a22 |
713 | For example: |
c277df42 |
714 | |
5a964f20 |
715 | m{ ( \( )? |
871b0233 |
716 | [^()]+ |
5a964f20 |
717 | (?(1) \) ) |
871b0233 |
718 | }x |
c277df42 |
719 | |
720 | matches a chunk of non-parentheses, possibly included in parentheses |
721 | themselves. |
a0d0e21e |
722 | |
a0d0e21e |
723 | =back |
724 | |
c07a80fd |
725 | =head2 Backtracking |
726 | |
35a734be |
727 | NOTE: This section presents an abstract approximation of regular |
728 | expression behavior. For a more rigorous (and complicated) view of |
729 | the rules involved in selecting a match among possible alternatives, |
730 | see L<Combining pieces together>. |
731 | |
c277df42 |
732 | A fundamental feature of regular expression matching involves the |
5a964f20 |
733 | notion called I<backtracking>, which is currently used (when needed) |
c277df42 |
734 | by all regular expression quantifiers, namely C<*>, C<*?>, C<+>, |
9da458fc |
735 | C<+?>, C<{n,m}>, and C<{n,m}?>. Backtracking is often optimized |
736 | internally, but the general principle outlined here is valid. |
c07a80fd |
737 | |
738 | For a regular expression to match, the I<entire> regular expression must |
739 | match, not just part of it. So if the beginning of a pattern containing a |
740 | quantifier succeeds in a way that causes later parts in the pattern to |
741 | fail, the matching engine backs up and recalculates the beginning |
742 | part--that's why it's called backtracking. |
743 | |
744 | Here is an example of backtracking: Let's say you want to find the |
745 | word following "foo" in the string "Food is on the foo table.": |
746 | |
747 | $_ = "Food is on the foo table."; |
748 | if ( /\b(foo)\s+(\w+)/i ) { |
749 | print "$2 follows $1.\n"; |
750 | } |
751 | |
752 | When the match runs, the first part of the regular expression (C<\b(foo)>) |
753 | finds a possible match right at the beginning of the string, and loads up |
754 | $1 with "Foo". However, as soon as the matching engine sees that there's |
755 | no whitespace following the "Foo" that it had saved in $1, it realizes its |
68dc0745 |
756 | mistake and starts over again one character after where it had the |
c07a80fd |
757 | tentative match. This time it goes all the way until the next occurrence |
758 | of "foo". The complete regular expression matches this time, and you get |
759 | the expected output of "table follows foo." |
760 | |
761 | Sometimes minimal matching can help a lot. Imagine you'd like to match |
762 | everything between "foo" and "bar". Initially, you write something |
763 | like this: |
764 | |
765 | $_ = "The food is under the bar in the barn."; |
766 | if ( /foo(.*)bar/ ) { |
767 | print "got <$1>\n"; |
768 | } |
769 | |
770 | Which perhaps unexpectedly yields: |
771 | |
772 | got <d is under the bar in the > |
773 | |
774 | That's because C<.*> was greedy, so you get everything between the |
14218588 |
775 | I<first> "foo" and the I<last> "bar". Here it's more effective |
c07a80fd |
776 | to use minimal matching to make sure you get the text between a "foo" |
777 | and the first "bar" thereafter. |
778 | |
779 | if ( /foo(.*?)bar/ ) { print "got <$1>\n" } |
780 | got <d is under the > |
781 | |
782 | Here's another example: let's say you'd like to match a number at the end |
783 | of a string, and you also want to keep the preceding part the match. |
784 | So you write this: |
785 | |
786 | $_ = "I have 2 numbers: 53147"; |
787 | if ( /(.*)(\d*)/ ) { # Wrong! |
788 | print "Beginning is <$1>, number is <$2>.\n"; |
789 | } |
790 | |
791 | That won't work at all, because C<.*> was greedy and gobbled up the |
792 | whole string. As C<\d*> can match on an empty string the complete |
793 | regular expression matched successfully. |
794 | |
8e1088bc |
795 | Beginning is <I have 2 numbers: 53147>, number is <>. |
c07a80fd |
796 | |
797 | Here are some variants, most of which don't work: |
798 | |
799 | $_ = "I have 2 numbers: 53147"; |
800 | @pats = qw{ |
801 | (.*)(\d*) |
802 | (.*)(\d+) |
803 | (.*?)(\d*) |
804 | (.*?)(\d+) |
805 | (.*)(\d+)$ |
806 | (.*?)(\d+)$ |
807 | (.*)\b(\d+)$ |
808 | (.*\D)(\d+)$ |
809 | }; |
810 | |
811 | for $pat (@pats) { |
812 | printf "%-12s ", $pat; |
813 | if ( /$pat/ ) { |
814 | print "<$1> <$2>\n"; |
815 | } else { |
816 | print "FAIL\n"; |
817 | } |
818 | } |
819 | |
820 | That will print out: |
821 | |
822 | (.*)(\d*) <I have 2 numbers: 53147> <> |
823 | (.*)(\d+) <I have 2 numbers: 5314> <7> |
824 | (.*?)(\d*) <> <> |
825 | (.*?)(\d+) <I have > <2> |
826 | (.*)(\d+)$ <I have 2 numbers: 5314> <7> |
827 | (.*?)(\d+)$ <I have 2 numbers: > <53147> |
828 | (.*)\b(\d+)$ <I have 2 numbers: > <53147> |
829 | (.*\D)(\d+)$ <I have 2 numbers: > <53147> |
830 | |
831 | As you see, this can be a bit tricky. It's important to realize that a |
832 | regular expression is merely a set of assertions that gives a definition |
833 | of success. There may be 0, 1, or several different ways that the |
834 | definition might succeed against a particular string. And if there are |
5a964f20 |
835 | multiple ways it might succeed, you need to understand backtracking to |
836 | know which variety of success you will achieve. |
c07a80fd |
837 | |
19799a22 |
838 | When using look-ahead assertions and negations, this can all get even |
54310121 |
839 | tricker. Imagine you'd like to find a sequence of non-digits not |
c07a80fd |
840 | followed by "123". You might try to write that as |
841 | |
871b0233 |
842 | $_ = "ABC123"; |
843 | if ( /^\D*(?!123)/ ) { # Wrong! |
844 | print "Yup, no 123 in $_\n"; |
845 | } |
c07a80fd |
846 | |
847 | But that isn't going to match; at least, not the way you're hoping. It |
848 | claims that there is no 123 in the string. Here's a clearer picture of |
849 | why it that pattern matches, contrary to popular expectations: |
850 | |
851 | $x = 'ABC123' ; |
852 | $y = 'ABC445' ; |
853 | |
854 | print "1: got $1\n" if $x =~ /^(ABC)(?!123)/ ; |
855 | print "2: got $1\n" if $y =~ /^(ABC)(?!123)/ ; |
856 | |
857 | print "3: got $1\n" if $x =~ /^(\D*)(?!123)/ ; |
858 | print "4: got $1\n" if $y =~ /^(\D*)(?!123)/ ; |
859 | |
860 | This prints |
861 | |
862 | 2: got ABC |
863 | 3: got AB |
864 | 4: got ABC |
865 | |
5f05dabc |
866 | You might have expected test 3 to fail because it seems to a more |
c07a80fd |
867 | general purpose version of test 1. The important difference between |
868 | them is that test 3 contains a quantifier (C<\D*>) and so can use |
869 | backtracking, whereas test 1 will not. What's happening is |
870 | that you've asked "Is it true that at the start of $x, following 0 or more |
5f05dabc |
871 | non-digits, you have something that's not 123?" If the pattern matcher had |
c07a80fd |
872 | let C<\D*> expand to "ABC", this would have caused the whole pattern to |
54310121 |
873 | fail. |
14218588 |
874 | |
c07a80fd |
875 | The search engine will initially match C<\D*> with "ABC". Then it will |
14218588 |
876 | try to match C<(?!123> with "123", which fails. But because |
c07a80fd |
877 | a quantifier (C<\D*>) has been used in the regular expression, the |
878 | search engine can backtrack and retry the match differently |
54310121 |
879 | in the hope of matching the complete regular expression. |
c07a80fd |
880 | |
5a964f20 |
881 | The pattern really, I<really> wants to succeed, so it uses the |
882 | standard pattern back-off-and-retry and lets C<\D*> expand to just "AB" this |
c07a80fd |
883 | time. Now there's indeed something following "AB" that is not |
14218588 |
884 | "123". It's "C123", which suffices. |
c07a80fd |
885 | |
14218588 |
886 | We can deal with this by using both an assertion and a negation. |
887 | We'll say that the first part in $1 must be followed both by a digit |
888 | and by something that's not "123". Remember that the look-aheads |
889 | are zero-width expressions--they only look, but don't consume any |
890 | of the string in their match. So rewriting this way produces what |
c07a80fd |
891 | you'd expect; that is, case 5 will fail, but case 6 succeeds: |
892 | |
893 | print "5: got $1\n" if $x =~ /^(\D*)(?=\d)(?!123)/ ; |
894 | print "6: got $1\n" if $y =~ /^(\D*)(?=\d)(?!123)/ ; |
895 | |
896 | 6: got ABC |
897 | |
5a964f20 |
898 | In other words, the two zero-width assertions next to each other work as though |
19799a22 |
899 | they're ANDed together, just as you'd use any built-in assertions: C</^$/> |
c07a80fd |
900 | matches only if you're at the beginning of the line AND the end of the |
901 | line simultaneously. The deeper underlying truth is that juxtaposition in |
902 | regular expressions always means AND, except when you write an explicit OR |
903 | using the vertical bar. C</ab/> means match "a" AND (then) match "b", |
904 | although the attempted matches are made at different positions because "a" |
905 | is not a zero-width assertion, but a one-width assertion. |
906 | |
19799a22 |
907 | B<WARNING>: particularly complicated regular expressions can take |
14218588 |
908 | exponential time to solve because of the immense number of possible |
9da458fc |
909 | ways they can use backtracking to try match. For example, without |
910 | internal optimizations done by the regular expression engine, this will |
911 | take a painfully long time to run: |
c07a80fd |
912 | |
e1901655 |
913 | 'aaaaaaaaaaaa' =~ /((a{0,5}){0,5})*[c]/ |
914 | |
915 | And if you used C<*>'s in the internal groups instead of limiting them |
916 | to 0 through 5 matches, then it would take forever--or until you ran |
917 | out of stack space. Moreover, these internal optimizations are not |
918 | always applicable. For example, if you put C<{0,5}> instead of C<*> |
919 | on the external group, no current optimization is applicable, and the |
920 | match takes a long time to finish. |
c07a80fd |
921 | |
9da458fc |
922 | A powerful tool for optimizing such beasts is what is known as an |
923 | "independent group", |
c47ff5f1 |
924 | which does not backtrack (see L<C<< (?>pattern) >>>). Note also that |
9da458fc |
925 | zero-length look-ahead/look-behind assertions will not backtrack to make |
14218588 |
926 | the tail match, since they are in "logical" context: only |
927 | whether they match is considered relevant. For an example |
9da458fc |
928 | where side-effects of look-ahead I<might> have influenced the |
c47ff5f1 |
929 | following match, see L<C<< (?>pattern) >>>. |
c277df42 |
930 | |
a0d0e21e |
931 | =head2 Version 8 Regular Expressions |
932 | |
5a964f20 |
933 | In case you're not familiar with the "regular" Version 8 regex |
a0d0e21e |
934 | routines, here are the pattern-matching rules not described above. |
935 | |
54310121 |
936 | Any single character matches itself, unless it is a I<metacharacter> |
a0d0e21e |
937 | with a special meaning described here or above. You can cause |
5a964f20 |
938 | characters that normally function as metacharacters to be interpreted |
5f05dabc |
939 | literally by prefixing them with a "\" (e.g., "\." matches a ".", not any |
a0d0e21e |
940 | character; "\\" matches a "\"). A series of characters matches that |
941 | series of characters in the target string, so the pattern C<blurfl> |
942 | would match "blurfl" in the target string. |
943 | |
944 | You can specify a character class, by enclosing a list of characters |
5a964f20 |
945 | in C<[]>, which will match any one character from the list. If the |
a0d0e21e |
946 | first character after the "[" is "^", the class matches any character not |
14218588 |
947 | in the list. Within a list, the "-" character specifies a |
5a964f20 |
948 | range, so that C<a-z> represents all characters between "a" and "z", |
8a4f6ac2 |
949 | inclusive. If you want either "-" or "]" itself to be a member of a |
950 | class, put it at the start of the list (possibly after a "^"), or |
951 | escape it with a backslash. "-" is also taken literally when it is |
952 | at the end of the list, just before the closing "]". (The |
84850974 |
953 | following all specify the same class of three characters: C<[-az]>, |
954 | C<[az-]>, and C<[a\-z]>. All are different from C<[a-z]>, which |
955 | specifies a class containing twenty-six characters.) |
1209ba90 |
956 | Also, if you try to use the character classes C<\w>, C<\W>, C<\s>, |
957 | C<\S>, C<\d>, or C<\D> as endpoints of a range, that's not a range, |
958 | the "-" is understood literally. |
a0d0e21e |
959 | |
8ada0baa |
960 | Note also that the whole range idea is rather unportable between |
961 | character sets--and even within character sets they may cause results |
962 | you probably didn't expect. A sound principle is to use only ranges |
963 | that begin from and end at either alphabets of equal case ([a-e], |
964 | [A-E]), or digits ([0-9]). Anything else is unsafe. If in doubt, |
965 | spell out the character sets in full. |
966 | |
54310121 |
967 | Characters may be specified using a metacharacter syntax much like that |
a0d0e21e |
968 | used in C: "\n" matches a newline, "\t" a tab, "\r" a carriage return, |
969 | "\f" a form feed, etc. More generally, \I<nnn>, where I<nnn> is a string |
970 | of octal digits, matches the character whose ASCII value is I<nnn>. |
0f36ee90 |
971 | Similarly, \xI<nn>, where I<nn> are hexadecimal digits, matches the |
a0d0e21e |
972 | character whose ASCII value is I<nn>. The expression \cI<x> matches the |
54310121 |
973 | ASCII character control-I<x>. Finally, the "." metacharacter matches any |
a0d0e21e |
974 | character except "\n" (unless you use C</s>). |
975 | |
976 | You can specify a series of alternatives for a pattern using "|" to |
977 | separate them, so that C<fee|fie|foe> will match any of "fee", "fie", |
5a964f20 |
978 | or "foe" in the target string (as would C<f(e|i|o)e>). The |
a0d0e21e |
979 | first alternative includes everything from the last pattern delimiter |
980 | ("(", "[", or the beginning of the pattern) up to the first "|", and |
981 | the last alternative contains everything from the last "|" to the next |
14218588 |
982 | pattern delimiter. That's why it's common practice to include |
983 | alternatives in parentheses: to minimize confusion about where they |
a3cb178b |
984 | start and end. |
985 | |
5a964f20 |
986 | Alternatives are tried from left to right, so the first |
a3cb178b |
987 | alternative found for which the entire expression matches, is the one that |
988 | is chosen. This means that alternatives are not necessarily greedy. For |
628afcb5 |
989 | example: when matching C<foo|foot> against "barefoot", only the "foo" |
a3cb178b |
990 | part will match, as that is the first alternative tried, and it successfully |
991 | matches the target string. (This might not seem important, but it is |
992 | important when you are capturing matched text using parentheses.) |
993 | |
5a964f20 |
994 | Also remember that "|" is interpreted as a literal within square brackets, |
a3cb178b |
995 | so if you write C<[fee|fie|foe]> you're really only matching C<[feio|]>. |
a0d0e21e |
996 | |
14218588 |
997 | Within a pattern, you may designate subpatterns for later reference |
998 | by enclosing them in parentheses, and you may refer back to the |
999 | I<n>th subpattern later in the pattern using the metacharacter |
1000 | \I<n>. Subpatterns are numbered based on the left to right order |
1001 | of their opening parenthesis. A backreference matches whatever |
1002 | actually matched the subpattern in the string being examined, not |
1003 | the rules for that subpattern. Therefore, C<(0|0x)\d*\s\1\d*> will |
1004 | match "0x1234 0x4321", but not "0x1234 01234", because subpattern |
1005 | 1 matched "0x", even though the rule C<0|0x> could potentially match |
1006 | the leading 0 in the second number. |
cb1a09d0 |
1007 | |
19799a22 |
1008 | =head2 Warning on \1 vs $1 |
cb1a09d0 |
1009 | |
5a964f20 |
1010 | Some people get too used to writing things like: |
cb1a09d0 |
1011 | |
1012 | $pattern =~ s/(\W)/\\\1/g; |
1013 | |
1014 | This is grandfathered for the RHS of a substitute to avoid shocking the |
1015 | B<sed> addicts, but it's a dirty habit to get into. That's because in |
5f05dabc |
1016 | PerlThink, the righthand side of a C<s///> is a double-quoted string. C<\1> in |
cb1a09d0 |
1017 | the usual double-quoted string means a control-A. The customary Unix |
1018 | meaning of C<\1> is kludged in for C<s///>. However, if you get into the habit |
1019 | of doing that, you get yourself into trouble if you then add an C</e> |
1020 | modifier. |
1021 | |
5a964f20 |
1022 | s/(\d+)/ \1 + 1 /eg; # causes warning under -w |
cb1a09d0 |
1023 | |
1024 | Or if you try to do |
1025 | |
1026 | s/(\d+)/\1000/; |
1027 | |
1028 | You can't disambiguate that by saying C<\{1}000>, whereas you can fix it with |
14218588 |
1029 | C<${1}000>. The operation of interpolation should not be confused |
cb1a09d0 |
1030 | with the operation of matching a backreference. Certainly they mean two |
1031 | different things on the I<left> side of the C<s///>. |
9fa51da4 |
1032 | |
c84d73f1 |
1033 | =head2 Repeated patterns matching zero-length substring |
1034 | |
19799a22 |
1035 | B<WARNING>: Difficult material (and prose) ahead. This section needs a rewrite. |
c84d73f1 |
1036 | |
1037 | Regular expressions provide a terse and powerful programming language. As |
1038 | with most other power tools, power comes together with the ability |
1039 | to wreak havoc. |
1040 | |
1041 | A common abuse of this power stems from the ability to make infinite |
628afcb5 |
1042 | loops using regular expressions, with something as innocuous as: |
c84d73f1 |
1043 | |
1044 | 'foo' =~ m{ ( o? )* }x; |
1045 | |
1046 | The C<o?> can match at the beginning of C<'foo'>, and since the position |
1047 | in the string is not moved by the match, C<o?> would match again and again |
14218588 |
1048 | because of the C<*> modifier. Another common way to create a similar cycle |
c84d73f1 |
1049 | is with the looping modifier C<//g>: |
1050 | |
1051 | @matches = ( 'foo' =~ m{ o? }xg ); |
1052 | |
1053 | or |
1054 | |
1055 | print "match: <$&>\n" while 'foo' =~ m{ o? }xg; |
1056 | |
1057 | or the loop implied by split(). |
1058 | |
1059 | However, long experience has shown that many programming tasks may |
14218588 |
1060 | be significantly simplified by using repeated subexpressions that |
1061 | may match zero-length substrings. Here's a simple example being: |
c84d73f1 |
1062 | |
1063 | @chars = split //, $string; # // is not magic in split |
1064 | ($whitewashed = $string) =~ s/()/ /g; # parens avoid magic s// / |
1065 | |
9da458fc |
1066 | Thus Perl allows such constructs, by I<forcefully breaking |
c84d73f1 |
1067 | the infinite loop>. The rules for this are different for lower-level |
1068 | loops given by the greedy modifiers C<*+{}>, and for higher-level |
1069 | ones like the C</g> modifier or split() operator. |
1070 | |
19799a22 |
1071 | The lower-level loops are I<interrupted> (that is, the loop is |
1072 | broken) when Perl detects that a repeated expression matched a |
1073 | zero-length substring. Thus |
c84d73f1 |
1074 | |
1075 | m{ (?: NON_ZERO_LENGTH | ZERO_LENGTH )* }x; |
1076 | |
1077 | is made equivalent to |
1078 | |
1079 | m{ (?: NON_ZERO_LENGTH )* |
1080 | | |
1081 | (?: ZERO_LENGTH )? |
1082 | }x; |
1083 | |
1084 | The higher level-loops preserve an additional state between iterations: |
1085 | whether the last match was zero-length. To break the loop, the following |
1086 | match after a zero-length match is prohibited to have a length of zero. |
1087 | This prohibition interacts with backtracking (see L<"Backtracking">), |
1088 | and so the I<second best> match is chosen if the I<best> match is of |
1089 | zero length. |
1090 | |
19799a22 |
1091 | For example: |
c84d73f1 |
1092 | |
1093 | $_ = 'bar'; |
1094 | s/\w??/<$&>/g; |
1095 | |
1096 | results in C<"<><b><><a><><r><>">. At each position of the string the best |
1097 | match given by non-greedy C<??> is the zero-length match, and the I<second |
1098 | best> match is what is matched by C<\w>. Thus zero-length matches |
1099 | alternate with one-character-long matches. |
1100 | |
1101 | Similarly, for repeated C<m/()/g> the second-best match is the match at the |
1102 | position one notch further in the string. |
1103 | |
19799a22 |
1104 | The additional state of being I<matched with zero-length> is associated with |
c84d73f1 |
1105 | the matched string, and is reset by each assignment to pos(). |
9da458fc |
1106 | Zero-length matches at the end of the previous match are ignored |
1107 | during C<split>. |
c84d73f1 |
1108 | |
35a734be |
1109 | =head2 Combining pieces together |
1110 | |
1111 | Each of the elementary pieces of regular expressions which were described |
1112 | before (such as C<ab> or C<\Z>) could match at most one substring |
1113 | at the given position of the input string. However, in a typical regular |
1114 | expression these elementary pieces are combined into more complicated |
1115 | patterns using combining operators C<ST>, C<S|T>, C<S*> etc |
1116 | (in these examples C<S> and C<T> are regular subexpressions). |
1117 | |
1118 | Such combinations can include alternatives, leading to a problem of choice: |
1119 | if we match a regular expression C<a|ab> against C<"abc">, will it match |
1120 | substring C<"a"> or C<"ab">? One way to describe which substring is |
1121 | actually matched is the concept of backtracking (see L<"Backtracking">). |
1122 | However, this description is too low-level and makes you think |
1123 | in terms of a particular implementation. |
1124 | |
1125 | Another description starts with notions of "better"/"worse". All the |
1126 | substrings which may be matched by the given regular expression can be |
1127 | sorted from the "best" match to the "worst" match, and it is the "best" |
1128 | match which is chosen. This substitutes the question of "what is chosen?" |
1129 | by the question of "which matches are better, and which are worse?". |
1130 | |
1131 | Again, for elementary pieces there is no such question, since at most |
1132 | one match at a given position is possible. This section describes the |
1133 | notion of better/worse for combining operators. In the description |
1134 | below C<S> and C<T> are regular subexpressions. |
1135 | |
13a2d996 |
1136 | =over 4 |
35a734be |
1137 | |
1138 | =item C<ST> |
1139 | |
1140 | Consider two possible matches, C<AB> and C<A'B'>, C<A> and C<A'> are |
1141 | substrings which can be matched by C<S>, C<B> and C<B'> are substrings |
1142 | which can be matched by C<T>. |
1143 | |
1144 | If C<A> is better match for C<S> than C<A'>, C<AB> is a better |
1145 | match than C<A'B'>. |
1146 | |
1147 | If C<A> and C<A'> coincide: C<AB> is a better match than C<AB'> if |
1148 | C<B> is better match for C<T> than C<B'>. |
1149 | |
1150 | =item C<S|T> |
1151 | |
1152 | When C<S> can match, it is a better match than when only C<T> can match. |
1153 | |
1154 | Ordering of two matches for C<S> is the same as for C<S>. Similar for |
1155 | two matches for C<T>. |
1156 | |
1157 | =item C<S{REPEAT_COUNT}> |
1158 | |
1159 | Matches as C<SSS...S> (repeated as many times as necessary). |
1160 | |
1161 | =item C<S{min,max}> |
1162 | |
1163 | Matches as C<S{max}|S{max-1}|...|S{min+1}|S{min}>. |
1164 | |
1165 | =item C<S{min,max}?> |
1166 | |
1167 | Matches as C<S{min}|S{min+1}|...|S{max-1}|S{max}>. |
1168 | |
1169 | =item C<S?>, C<S*>, C<S+> |
1170 | |
1171 | Same as C<S{0,1}>, C<S{0,BIG_NUMBER}>, C<S{1,BIG_NUMBER}> respectively. |
1172 | |
1173 | =item C<S??>, C<S*?>, C<S+?> |
1174 | |
1175 | Same as C<S{0,1}?>, C<S{0,BIG_NUMBER}?>, C<S{1,BIG_NUMBER}?> respectively. |
1176 | |
c47ff5f1 |
1177 | =item C<< (?>S) >> |
35a734be |
1178 | |
1179 | Matches the best match for C<S> and only that. |
1180 | |
1181 | =item C<(?=S)>, C<(?<=S)> |
1182 | |
1183 | Only the best match for C<S> is considered. (This is important only if |
1184 | C<S> has capturing parentheses, and backreferences are used somewhere |
1185 | else in the whole regular expression.) |
1186 | |
1187 | =item C<(?!S)>, C<(?<!S)> |
1188 | |
1189 | For this grouping operator there is no need to describe the ordering, since |
1190 | only whether or not C<S> can match is important. |
1191 | |
14455d6c |
1192 | =item C<(??{ EXPR })> |
35a734be |
1193 | |
1194 | The ordering is the same as for the regular expression which is |
1195 | the result of EXPR. |
1196 | |
1197 | =item C<(?(condition)yes-pattern|no-pattern)> |
1198 | |
1199 | Recall that which of C<yes-pattern> or C<no-pattern> actually matches is |
1200 | already determined. The ordering of the matches is the same as for the |
1201 | chosen subexpression. |
1202 | |
1203 | =back |
1204 | |
1205 | The above recipes describe the ordering of matches I<at a given position>. |
1206 | One more rule is needed to understand how a match is determined for the |
1207 | whole regular expression: a match at an earlier position is always better |
1208 | than a match at a later position. |
1209 | |
c84d73f1 |
1210 | =head2 Creating custom RE engines |
1211 | |
1212 | Overloaded constants (see L<overload>) provide a simple way to extend |
1213 | the functionality of the RE engine. |
1214 | |
1215 | Suppose that we want to enable a new RE escape-sequence C<\Y|> which |
1216 | matches at boundary between white-space characters and non-whitespace |
1217 | characters. Note that C<(?=\S)(?<!\S)|(?!\S)(?<=\S)> matches exactly |
1218 | at these positions, so we want to have each C<\Y|> in the place of the |
1219 | more complicated version. We can create a module C<customre> to do |
1220 | this: |
1221 | |
1222 | package customre; |
1223 | use overload; |
1224 | |
1225 | sub import { |
1226 | shift; |
1227 | die "No argument to customre::import allowed" if @_; |
1228 | overload::constant 'qr' => \&convert; |
1229 | } |
1230 | |
1231 | sub invalid { die "/$_[0]/: invalid escape '\\$_[1]'"} |
1232 | |
1233 | my %rules = ( '\\' => '\\', |
1234 | 'Y|' => qr/(?=\S)(?<!\S)|(?!\S)(?<=\S)/ ); |
1235 | sub convert { |
1236 | my $re = shift; |
1237 | $re =~ s{ |
1238 | \\ ( \\ | Y . ) |
1239 | } |
1240 | { $rules{$1} or invalid($re,$1) }sgex; |
1241 | return $re; |
1242 | } |
1243 | |
1244 | Now C<use customre> enables the new escape in constant regular |
1245 | expressions, i.e., those without any runtime variable interpolations. |
1246 | As documented in L<overload>, this conversion will work only over |
1247 | literal parts of regular expressions. For C<\Y|$re\Y|> the variable |
1248 | part of this regular expression needs to be converted explicitly |
1249 | (but only if the special meaning of C<\Y|> should be enabled inside $re): |
1250 | |
1251 | use customre; |
1252 | $re = <>; |
1253 | chomp $re; |
1254 | $re = customre::convert $re; |
1255 | /\Y|$re\Y|/; |
1256 | |
19799a22 |
1257 | =head1 BUGS |
1258 | |
9da458fc |
1259 | This document varies from difficult to understand to completely |
1260 | and utterly opaque. The wandering prose riddled with jargon is |
1261 | hard to fathom in several places. |
1262 | |
1263 | This document needs a rewrite that separates the tutorial content |
1264 | from the reference content. |
19799a22 |
1265 | |
1266 | =head1 SEE ALSO |
9fa51da4 |
1267 | |
9b599b2a |
1268 | L<perlop/"Regexp Quote-Like Operators">. |
1269 | |
1e66bd83 |
1270 | L<perlop/"Gory details of parsing quoted constructs">. |
1271 | |
14218588 |
1272 | L<perlfaq6>. |
1273 | |
9b599b2a |
1274 | L<perlfunc/pos>. |
1275 | |
1276 | L<perllocale>. |
1277 | |
14218588 |
1278 | I<Mastering Regular Expressions> by Jeffrey Friedl, published |
1279 | by O'Reilly and Associates. |