This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PATCH: [perl #125291] perlreref misstatement
[perl5.git] / pod / perlreref.pod
1 =head1 NAME
2
3 perlreref - Perl Regular Expressions Reference
4
5 =head1 DESCRIPTION
6
7 This is a quick reference to Perl's regular expressions.
8 For full information see L<perlre> and L<perlop>, as well
9 as the L</"SEE ALSO"> section in this document.
10
11 =head2 OPERATORS
12
13 C<=~> determines to which variable the regex is applied.
14 In its absence, $_ is used.
15
16     $var =~ /foo/;
17
18 C<!~> determines to which variable the regex is applied,
19 and negates the result of the match; it returns
20 false if the match succeeds, and true if it fails.
21
22     $var !~ /foo/;
23
24 C<m/pattern/msixpogcdualn> searches a string for a pattern match,
25 applying the given options.
26
27     m  Multiline mode - ^ and $ match internal lines
28     s  match as a Single line - . matches \n
29     i  case-Insensitive
30     x  eXtended legibility - free whitespace and comments
31     p  Preserve a copy of the matched string -
32        ${^PREMATCH}, ${^MATCH}, ${^POSTMATCH} will be defined.
33     o  compile pattern Once
34     g  Global - all occurrences
35     c  don't reset pos on failed matches when using /g
36     a  restrict \d, \s, \w and [:posix:] to match ASCII only
37     aa (two a's) also /i matches exclude ASCII/non-ASCII
38     l  match according to current locale
39     u  match according to Unicode rules
40     d  match according to native rules unless something indicates
41        Unicode
42     n  Non-capture mode. Don't let () fill in $1, $2, etc...
43
44 If 'pattern' is an empty string, the last I<successfully> matched
45 regex is used. Delimiters other than '/' may be used for both this
46 operator and the following ones. The leading C<m> can be omitted
47 if the delimiter is '/'.
48
49 C<qr/pattern/msixpodualn> lets you store a regex in a variable,
50 or pass one around. Modifiers as for C<m//>, and are stored
51 within the regex.
52
53 C<s/pattern/replacement/msixpogcedual> substitutes matches of
54 'pattern' with 'replacement'. Modifiers as for C<m//>,
55 with two additions:
56
57     e  Evaluate 'replacement' as an expression
58     r  Return substitution and leave the original string untouched.
59
60 'e' may be specified multiple times. 'replacement' is interpreted
61 as a double quoted string unless a single-quote (C<'>) is the delimiter.
62
63 C<?pattern?> is like C<m/pattern/> but matches only once. No alternate
64 delimiters can be used.  Must be reset with reset().
65
66 =head2 SYNTAX
67
68  \       Escapes the character immediately following it
69  .       Matches any single character except a newline (unless /s is
70            used)
71  ^       Matches at the beginning of the string (or line, if /m is used)
72  $       Matches at the end of the string (or line, if /m is used)
73  *       Matches the preceding element 0 or more times
74  +       Matches the preceding element 1 or more times
75  ?       Matches the preceding element 0 or 1 times
76  {...}   Specifies a range of occurrences for the element preceding it
77  [...]   Matches any one of the characters contained within the brackets
78  (...)   Groups subexpressions for capturing to $1, $2...
79  (?:...) Groups subexpressions without capturing (cluster)
80  |       Matches either the subexpression preceding or following it
81  \g1 or \g{1}, \g2 ...    Matches the text from the Nth group
82  \1, \2, \3 ...           Matches the text from the Nth group
83  \g-1 or \g{-1}, \g-2 ... Matches the text from the Nth previous group
84  \g{name}     Named backreference
85  \k<name>     Named backreference
86  \k'name'     Named backreference
87  (?P=name)    Named backreference (python syntax)
88
89 =head2 ESCAPE SEQUENCES
90
91 These work as in normal strings.
92
93    \a       Alarm (beep)
94    \e       Escape
95    \f       Formfeed
96    \n       Newline
97    \r       Carriage return
98    \t       Tab
99    \037     Char whose ordinal is the 3 octal digits, max \777
100    \o{2307} Char whose ordinal is the octal number, unrestricted
101    \x7f     Char whose ordinal is the 2 hex digits, max \xFF
102    \x{263a} Char whose ordinal is the hex number, unrestricted
103    \cx      Control-x
104    \N{name} A named Unicode character or character sequence
105    \N{U+263D} A Unicode character by hex ordinal
106
107    \l  Lowercase next character
108    \u  Titlecase next character
109    \L  Lowercase until \E
110    \U  Uppercase until \E
111    \F  Foldcase until \E
112    \Q  Disable pattern metacharacters until \E
113    \E  End modification
114
115 For Titlecase, see L</Titlecase>.
116
117 This one works differently from normal strings:
118
119    \b  An assertion, not backspace, except in a character class
120
121 =head2 CHARACTER CLASSES
122
123    [amy]    Match 'a', 'm' or 'y'
124    [f-j]    Dash specifies "range"
125    [f-j-]   Dash escaped or at start or end means 'dash'
126    [^f-j]   Caret indicates "match any character _except_ these"
127
128 The following sequences (except C<\N>) work within or without a character class.
129 The first six are locale aware, all are Unicode aware. See L<perllocale>
130 and L<perlunicode> for details.
131
132    \d      A digit
133    \D      A nondigit
134    \w      A word character
135    \W      A non-word character
136    \s      A whitespace character
137    \S      A non-whitespace character
138    \h      An horizontal whitespace
139    \H      A non horizontal whitespace
140    \N      A non newline (when not followed by '{NAME}';;
141            not valid in a character class; equivalent to [^\n]; it's
142            like '.' without /s modifier)
143    \v      A vertical whitespace
144    \V      A non vertical whitespace
145    \R      A generic newline           (?>\v|\x0D\x0A)
146
147    \C      Match a byte (with Unicode, '.' matches a character)
148            (Deprecated.)
149    \pP     Match P-named (Unicode) property
150    \p{...} Match Unicode property with name longer than 1 character
151    \PP     Match non-P
152    \P{...} Match lack of Unicode property with name longer than 1 char
153    \X      Match Unicode extended grapheme cluster
154
155 POSIX character classes and their Unicode and Perl equivalents:
156
157             ASCII-         Full-
158    POSIX    range          range    backslash
159  [[:...:]]  \p{...}        \p{...}   sequence    Description
160
161  -----------------------------------------------------------------------
162  alnum   PosixAlnum       XPosixAlnum            'alpha' plus 'digit'
163  alpha   PosixAlpha       XPosixAlpha            Alphabetic characters
164  ascii   ASCII                                   Any ASCII character
165  blank   PosixBlank       XPosixBlank   \h       Horizontal whitespace;
166                                                    full-range also
167                                                    written as
168                                                    \p{HorizSpace} (GNU
169                                                    extension)
170  cntrl   PosixCntrl       XPosixCntrl            Control characters
171  digit   PosixDigit       XPosixDigit   \d       Decimal digits
172  graph   PosixGraph       XPosixGraph            'alnum' plus 'punct'
173  lower   PosixLower       XPosixLower            Lowercase characters
174  print   PosixPrint       XPosixPrint            'graph' plus 'space',
175                                                    but not any Controls
176  punct   PosixPunct       XPosixPunct            Punctuation and Symbols
177                                                    in ASCII-range; just
178                                                    punct outside it
179  space   PosixSpace       XPosixSpace   \s       Whitespace
180  upper   PosixUpper       XPosixUpper            Uppercase characters
181  word    PosixWord        XPosixWord    \w       'alnum' + Unicode marks
182                                                     + connectors, like
183                                                     '_' (Perl extension)
184  xdigit  ASCII_Hex_Digit  XPosixDigit            Hexadecimal digit,
185                                                     ASCII-range is
186                                                     [0-9A-Fa-f]
187
188 Also, various synonyms like C<\p{Alpha}> for C<\p{XPosixAlpha}>; all listed
189 in L<perluniprops/Properties accessible through \p{} and \P{}>
190
191 Within a character class:
192
193     POSIX      traditional   Unicode
194   [:digit:]       \d        \p{Digit}
195   [:^digit:]      \D        \P{Digit}
196
197 =head2 ANCHORS
198
199 All are zero-width assertions.
200
201    ^  Match string start (or line, if /m is used)
202    $  Match string end (or line, if /m is used) or before newline
203    \b{} Match boundary of type specified within the braces
204    \B{} Match wherever \b{} doesn't match
205    \b Match word boundary (between \w and \W)
206    \B Match except at word boundary (between \w and \w or \W and \W)
207    \A Match string start (regardless of /m)
208    \Z Match string end (before optional newline)
209    \z Match absolute string end
210    \G Match where previous m//g left off
211    \K Keep the stuff left of the \K, don't include it in $&
212
213 =head2 QUANTIFIERS
214
215 Quantifiers are greedy by default and match the B<longest> leftmost.
216
217    Maximal Minimal Possessive Allowed range
218    ------- ------- ---------- -------------
219    {n,m}   {n,m}?  {n,m}+     Must occur at least n times
220                               but no more than m times
221    {n,}    {n,}?   {n,}+      Must occur at least n times
222    {n}     {n}?    {n}+       Must occur exactly n times
223    *       *?      *+         0 or more times (same as {0,})
224    +       +?      ++         1 or more times (same as {1,})
225    ?       ??      ?+         0 or 1 time (same as {0,1})
226
227 The possessive forms (new in Perl 5.10) prevent backtracking: what gets
228 matched by a pattern with a possessive quantifier will not be backtracked
229 into, even if that causes the whole match to fail.
230
231 There is no quantifier C<{,n}>. That's interpreted as a literal string.
232
233 =head2 EXTENDED CONSTRUCTS
234
235    (?#text)          A comment
236    (?:...)           Groups subexpressions without capturing (cluster)
237    (?pimsx-imsx:...) Enable/disable option (as per m// modifiers)
238    (?=...)           Zero-width positive lookahead assertion
239    (?!...)           Zero-width negative lookahead assertion
240    (?<=...)          Zero-width positive lookbehind assertion
241    (?<!...)          Zero-width negative lookbehind assertion
242    (?>...)           Grab what we can, prohibit backtracking
243    (?|...)           Branch reset
244    (?<name>...)      Named capture
245    (?'name'...)      Named capture
246    (?P<name>...)     Named capture (python syntax)
247    (?[...])          Extended bracketed character class
248    (?{ code })       Embedded code, return value becomes $^R
249    (??{ code })      Dynamic regex, return value used as regex
250    (?N)              Recurse into subpattern number N
251    (?-N), (?+N)      Recurse into Nth previous/next subpattern
252    (?R), (?0)        Recurse at the beginning of the whole pattern
253    (?&name)          Recurse into a named subpattern
254    (?P>name)         Recurse into a named subpattern (python syntax)
255    (?(cond)yes|no)
256    (?(cond)yes)      Conditional expression, where "cond" can be:
257                      (?=pat)   look-ahead
258                      (?!pat)   negative look-ahead
259                      (?<=pat)  look-behind
260                      (?<!pat)  negative look-behind
261                      (N)       subpattern N has matched something
262                      (<name>)  named subpattern has matched something
263                      ('name')  named subpattern has matched something
264                      (?{code}) code condition
265                      (R)       true if recursing
266                      (RN)      true if recursing into Nth subpattern
267                      (R&name)  true if recursing into named subpattern
268                      (DEFINE)  always false, no no-pattern allowed
269
270 =head2 VARIABLES
271
272    $_    Default variable for operators to use
273
274    $`    Everything prior to matched string
275    $&    Entire matched string
276    $'    Everything after to matched string
277
278    ${^PREMATCH}   Everything prior to matched string
279    ${^MATCH}      Entire matched string
280    ${^POSTMATCH}  Everything after to matched string
281
282 Note to those still using Perl 5.18 or earlier:
283 The use of C<$`>, C<$&> or C<$'> will slow down B<all> regex use
284 within your program. Consult L<perlvar> for C<@->
285 to see equivalent expressions that won't cause slow down.
286 See also L<Devel::SawAmpersand>. Starting with Perl 5.10, you
287 can also use the equivalent variables C<${^PREMATCH}>, C<${^MATCH}>
288 and C<${^POSTMATCH}>, but for them to be defined, you have to
289 specify the C</p> (preserve) modifier on your regular expression.
290 In Perl 5.20, the use of C<$`>, C<$&> and C<$'> makes no speed difference.
291
292    $1, $2 ...  hold the Xth captured expr
293    $+    Last parenthesized pattern match
294    $^N   Holds the most recently closed capture
295    $^R   Holds the result of the last (?{...}) expr
296    @-    Offsets of starts of groups. $-[0] holds start of whole match
297    @+    Offsets of ends of groups. $+[0] holds end of whole match
298    %+    Named capture groups
299    %-    Named capture groups, as array refs
300
301 Captured groups are numbered according to their I<opening> paren.
302
303 =head2 FUNCTIONS
304
305    lc          Lowercase a string
306    lcfirst     Lowercase first char of a string
307    uc          Uppercase a string
308    ucfirst     Titlecase first char of a string
309    fc          Foldcase a string
310
311    pos         Return or set current match position
312    quotemeta   Quote metacharacters
313    reset       Reset ?pattern? status
314    study       Analyze string for optimizing matching
315
316    split       Use a regex to split a string into parts
317
318 The first five of these are like the escape sequences C<\L>, C<\l>,
319 C<\U>, C<\u>, and C<\F>.  For Titlecase, see L</Titlecase>; For
320 Foldcase, see L</Foldcase>.
321
322 =head2 TERMINOLOGY
323
324 =head3 Titlecase
325
326 Unicode concept which most often is equal to uppercase, but for
327 certain characters like the German "sharp s" there is a difference.
328
329 =head3 Foldcase
330
331 Unicode form that is useful when comparing strings regardless of case,
332 as certain characters have complex one-to-many case mappings. Primarily a
333 variant of lowercase.
334
335 =head1 AUTHOR
336
337 Iain Truskett. Updated by the Perl 5 Porters.
338
339 This document may be distributed under the same terms as Perl itself.
340
341 =head1 SEE ALSO
342
343 =over 4
344
345 =item *
346
347 L<perlretut> for a tutorial on regular expressions.
348
349 =item *
350
351 L<perlrequick> for a rapid tutorial.
352
353 =item *
354
355 L<perlre> for more details.
356
357 =item *
358
359 L<perlvar> for details on the variables.
360
361 =item *
362
363 L<perlop> for details on the operators.
364
365 =item *
366
367 L<perlfunc> for details on the functions.
368
369 =item *
370
371 L<perlfaq6> for FAQs on regular expressions.
372
373 =item *
374
375 L<perlrebackslash> for a reference on backslash sequences.
376
377 =item *
378
379 L<perlrecharclass> for a reference on character classes.
380
381 =item *
382
383 The L<re> module to alter behaviour and aid
384 debugging.
385
386 =item *
387
388 L<perldebug/"Debugging Regular Expressions">
389
390 =item *
391
392 L<perluniintro>, L<perlunicode>, L<charnames> and L<perllocale>
393 for details on regexes and internationalisation.
394
395 =item *
396
397 I<Mastering Regular Expressions> by Jeffrey Friedl
398 (F<http://oreilly.com/catalog/9780596528126/>) for a thorough grounding and
399 reference on the topic.
400
401 =back
402
403 =head1 THANKS
404
405 David P.C. Wollmann,
406 Richard Soderberg,
407 Sean M. Burke,
408 Tom Christiansen,
409 Jim Cromie,
410 and
411 Jeffrey Goff
412 for useful advice.
413
414 =cut