=head1 NAME
perlretut - Perl regular expressions tutorial
=head1 DESCRIPTION
This page provides a basic tutorial on understanding, creating and
using regular expressions in Perl. It serves as a complement to the
reference page on regular expressions L. Regular expressions
are an integral part of the C, C, C and C
operators and so this tutorial also overlaps with
L and L.
Perl is widely renowned for excellence in text processing, and regular
expressions are one of the big factors behind this fame. Perl regular
expressions display an efficiency and flexibility unknown in most
other computer languages. Mastering even the basics of regular
expressions will allow you to manipulate text with surprising ease.
What is a regular expression? At its most basic, a regular expression
is a template that is used to determine if a string has certain
characteristics. The string is most often some text, such as a line,
sentence, web page, or even a whole book, but less commonly it could be
some binary data as well.
Suppose we want to determine if the text in variable, C contains
the sequence of characters S>
(blanks added for legibility). We can write in Perl
$var =~ m/mushroom/
The value of this expression will be TRUE if C contains that
sequence of characters, and FALSE otherwise. The portion enclosed in
C'> characters denotes the characteristic we are looking for.
We use the term I for it. The process of looking to see if the
pattern occurs in the string is called I, and the C
operator along with the C tell Perl to try to match the pattern
against the string. Note that the pattern is also a string, but a very
special kind of one, as we will see. Patterns are in common use these
days;
examples are the patterns typed into a search engine to find web pages
and the patterns used to list files in a directory, I, "C"
or "C". In Perl, the patterns described by regular expressions
are used not only to search strings, but to also extract desired parts
of strings, and to do search and replace operations.
Regular expressions have the undeserved reputation of being abstract
and difficult to understand. This really stems simply because the
notation used to express them tends to be terse and dense, and not
because of inherent complexity. We recommend using the C regular
expression modifier (described below) along with plenty of white space
to make them less dense, and easier to read. Regular expressions are
constructed using
simple concepts like conditionals and loops and are no more difficult
to understand than the corresponding C conditionals and C
loops in the Perl language itself.
This tutorial flattens the learning curve by discussing regular
expression concepts, along with their notation, one at a time and with
many examples. The first part of the tutorial will progress from the
simplest word searches to the basic regular expression concepts. If
you master the first part, you will have all the tools needed to solve
about 98% of your needs. The second part of the tutorial is for those
comfortable with the basics and hungry for more power tools. It
discusses the more advanced regular expression operators and
introduces the latest cutting-edge innovations.
A note: to save time, "regular expression" is often abbreviated as
regexp or regex. Regexp is a more natural abbreviation than regex, but
is harder to pronounce. The Perl pod documentation is evenly split on
regexp vs regex; in Perl, there is more than one way to abbreviate it.
We'll use regexp in this tutorial.
New in v5.22, L|re/'strict' mode> applies stricter
rules than otherwise when compiling regular expression patterns. It can
find things that, while legal, may not be what you intended.
=head1 Part 1: The basics
=head2 Simple word matching
The simplest regexp is simply a word, or more generally, a string of
characters. A regexp consisting of just a word matches any string that
contains that word:
"Hello World" =~ /World/; # matches
What is this Perl statement all about? C is a simple
double-quoted string. C is the regular expression and the
C/> enclosing C tells Perl to search a string for a match.
The operator C associates the string with the regexp match and
produces a true value if the regexp matched, or false if the regexp
did not match. In our case, C matches the second word in
C, so the expression is true. Expressions like this
are useful in conditionals:
if ("Hello World" =~ /World/) {
print "It matches\n";
}
else {
print "It doesn't match\n";
}
There are useful variations on this theme. The sense of the match can
be reversed by using the C operator:
if ("Hello World" !~ /World/) {
print "It doesn't match\n";
}
else {
print "It matches\n";
}
The literal string in the regexp can be replaced by a variable:
my $greeting = "World";
if ("Hello World" =~ /$greeting/) {
print "It matches\n";
}
else {
print "It doesn't match\n";
}
If you're matching against the special default variable C, the
C part can be omitted:
$_ = "Hello World";
if (/World/) {
print "It matches\n";
}
else {
print "It doesn't match\n";
}
And finally, the C/> default delimiters for a match can be changed
to arbitrary delimiters by putting an C out front:
"Hello World" =~ m!World!; # matches, delimited by '!'
"Hello World" =~ m{World}; # matches, note the matching '{}'
"/usr/bin/perl" =~ m"/perl"; # matches after '/usr/bin',
# '/' becomes an ordinary char
C, C, and C all represent the
same thing. When, I, the quote (C) is used as a delimiter, the forward
slash C becomes an ordinary character and can be used in this regexp
without trouble.
Let's consider how different regexps would match C:
"Hello World" =~ /world/; # doesn't match
"Hello World" =~ /o W/; # matches
"Hello World" =~ /oW/; # doesn't match
"Hello World" =~ /World /; # doesn't match
The first regexp C doesn't match because regexps are
case-sensitive. The second regexp matches because the substring
S> occurs in the string S>. The space
character C is treated like any other character in a regexp and is
needed to match in this case. The lack of a space character is the
reason the third regexp C doesn't match. The fourth regexp
"C" doesn't match because there is a space at the end of the
regexp, but not at the end of the string. The lesson here is that
regexps must match a part of the string I in order for the
statement to be true.
If a regexp matches in more than one place in the string, Perl will
always match at the earliest possible point in the string:
"Hello World" =~ /o/; # matches 'o' in 'Hello'
"That hat is red" =~ /hat/; # matches 'hat' in 'That'
With respect to character matching, there are a few more points you
need to know about. First of all, not all characters can be used "as
is" in a match. Some characters, called I, are
generally reserved for use in regexp notation. The metacharacters are
{}[]()^$.|*+?-#\
This list is not as definitive as it may appear (or be claimed to be in
other documentation). For example, C is a metacharacter only when
the C pattern modifier (described below) is used, and both C
and C are metacharacters only when paired with opening C or
C respectively; other gotchas apply.
The significance of each of these will be explained
in the rest of the tutorial, but for now, it is important only to know
that a metacharacter can be matched as-is by putting a backslash before
it:
"2+2=4" =~ /2+2/; # doesn't match, + is a metacharacter
"2+2=4" =~ /2\+2/; # matches, \+ is treated like an ordinary +
"The interval is [0,1)." =~ /[0,1)./ # is a syntax error!
"The interval is [0,1)." =~ /\[0,1\)\./ # matches
"#!/usr/bin/perl" =~ /#!\/usr\/bin\/perl/; # matches
In the last regexp, the forward slash C is also backslashed,
because it is used to delimit the regexp. This can lead to LTS
(leaning toothpick syndrome), however, and it is often more readable
to change delimiters.
"#!/usr/bin/perl" =~ m!#\!/usr/bin/perl!; # easier to read
The backslash character C is a metacharacter itself and needs to
be backslashed:
'C:\WIN32' =~ /C:\\WIN/; # matches
In situations where it doesn't make sense for a particular metacharacter
to mean what it normally does, it automatically loses its
metacharacter-ness and becomes an ordinary character that is to be
matched literally. For example, the C is a metacharacter only when
it is the mate of a C metacharacter. Otherwise it is treated as a
literal RIGHT CURLY BRACKET. This may lead to unexpected results.
L|re/'strict' mode> can catch some of these.
In addition to the metacharacters, there are some ASCII characters
which don't have printable character equivalents and are instead
represented by I. Common examples are C for a
tab, C for a newline, C for a carriage return and C for a
bell (or alert). If your string is better thought of as a sequence of arbitrary
bytes, the octal escape sequence, I, C, or hexadecimal escape
sequence, I, C may be a more natural representation for your
bytes. Here are some examples of escapes:
"1000\t2000" =~ m(0\t2) # matches
"1000\n2000" =~ /0\n20/ # matches
"1000\t2000" =~ /\000\t2/ # doesn't match, "0" ne "\000"
"cat" =~ /\o{143}\x61\x74/ # matches in ASCII, but a weird way
# to spell cat
If you've been around Perl a while, all this talk of escape sequences
may seem familiar. Similar escape sequences are used in double-quoted
strings and in fact the regexps in Perl are mostly treated as
double-quoted strings. This means that variables can be used in
regexps as well. Just like double-quoted strings, the values of the
variables in the regexp will be substituted in before the regexp is
evaluated for matching purposes. So we have:
$foo = 'house';
'housecat' =~ /$foo/; # matches
'cathouse' =~ /cat$foo/; # matches
'housecat' =~ /${foo}cat/; # matches
So far, so good. With the knowledge above you can already perform
searches with just about any literal string regexp you can dream up.
Here is a I emulation of the Unix grep program:
% cat > simple_grep
#!/usr/bin/perl
$regexp = shift;
while () {
print if /$regexp/;
}
^D
% chmod +x simple_grep
% simple_grep abba /usr/dict/words
Babbage
cabbage
cabbages
sabbath
Sabbathize
Sabbathizes
sabbatical
scabbard
scabbards
This program is easy to understand. C is the standard
way to invoke a perl program from the shell.
S> saves the first command line argument as the
regexp to be used, leaving the rest of the command line arguments to
be treated as files. S) >>> loops over all the lines in
all the files. For each line, S> prints the
line if the regexp matches the line. In this line, both C and
C$regexp/> use the default variable C implicitly.
With all of the regexps above, if the regexp matched anywhere in the
string, it was considered a match. Sometimes, however, we'd like to
specify I in the string the regexp should try to match. To do
this, we would use the I metacharacters C and C. The
anchor C means match at the beginning of the string and the anchor
C means match at the end of the string, or before a newline at the
end of the string. Here is how they are used:
"housekeeper" =~ /keeper/; # matches
"housekeeper" =~ /^keeper/; # doesn't match
"housekeeper" =~ /keeper$/; # matches
"housekeeper\n" =~ /keeper$/; # matches
The second regexp doesn't match because C constrains C to
match only at the beginning of the string, but C has
keeper starting in the middle. The third regexp does match, since the
C constrains C to match only at the end of the string.
When both C and C are used at the same time, the regexp has to
match both the beginning and the end of the string, I, the regexp
matches the whole string. Consider
"keeper" =~ /^keep$/; # doesn't match
"keeper" =~ /^keeper$/; # matches
"" =~ /^$/; # ^$ matches an empty string
The first regexp doesn't match because the string has more to it than
C. Since the second regexp is exactly the string, it
matches. Using both C and C in a regexp forces the complete
string to match, so it gives you complete control over which strings
match and which don't. Suppose you are looking for a fellow named
bert, off in a string by himself:
"dogbert" =~ /bert/; # matches, but not what you want
"dilbert" =~ /^bert/; # doesn't match, but ..
"bertram" =~ /^bert/; # matches, so still not good enough
"bertram" =~ /^bert$/; # doesn't match, good
"dilbert" =~ /^bert$/; # doesn't match, good
"bert" =~ /^bert$/; # matches, perfect
Of course, in the case of a literal string, one could just as easily
use the string comparison S> and it would be
more efficient. The C regexp really becomes useful when we
add in the more powerful regexp tools below.
=head2 Using character classes
Although one can already do quite a lot with the literal string
regexps above, we've only scratched the surface of regular expression
technology. In this and subsequent sections we will introduce regexp
concepts (and associated metacharacter notations) that will allow a
regexp to represent not just a single character sequence, but a I of them.
One such concept is that of a I. A character class
allows a set of possible characters, rather than just a single
character, to match at a particular point in a regexp. You can define
your own custom character classes. These
are denoted by brackets C, with the set of characters
to be possibly matched inside. Here are some examples:
/cat/; # matches 'cat'
/[bcr]at/; # matches 'bat, 'cat', or 'rat'
/item[0123456789]/; # matches 'item0' or ... or 'item9'
"abc" =~ /[cab]/; # matches 'a'
In the last statement, even though C is the first character in
the class, C matches because the first character position in the
string is the earliest point at which the regexp can match.
/[yY][eE][sS]/; # match 'yes' in a case-insensitive way
# 'yes', 'Yes', 'YES', etc.
This regexp displays a common task: perform a case-insensitive
match. Perl provides a way of avoiding all those brackets by simply
appending an C to the end of the match. Then C[yY][eE][sS]/;>
can be rewritten as C. The C stands for
case-insensitive and is an example of a I of the matching
operation. We will meet other modifiers later in the tutorial.
We saw in the section above that there were ordinary characters, which
represented themselves, and special characters, which needed a
backslash C to represent themselves. The same is true in a
character class, but the sets of ordinary and special characters
inside a character class are different than those outside a character
class. The special characters for a character class are C (and
the pattern delimiter, whatever it is).
C is special because it denotes the end of a character class. C is
special because it denotes a scalar variable. C is special because
it is used in escape sequences, just like above. Here is how the
special characters C are handled:
/[\]c]def/; # matches ']def' or 'cdef'
$x = 'bcr';
/[$x]at/; # matches 'bat', 'cat', or 'rat'
/[\$x]at/; # matches '$at' or 'xat'
/[\\$x]at/; # matches '\at', 'bat, 'cat', or 'rat'
The last two are a little tricky. In C, the backslash protects
the dollar sign, so the character class has two members C and C.
In C, the backslash is protected, so C is treated as a
variable and substituted in double quote fashion.
The special character C acts as a range operator within character
classes, so that a contiguous set of characters can be written as a
range. With ranges, the unwieldy C and C
become the svelte C and C. Some examples are
/item[0-9]/; # matches 'item0' or ... or 'item9'
/[0-9bx-z]aa/; # matches '0aa', ..., '9aa',
# 'baa', 'xaa', 'yaa', or 'zaa'
/[0-9a-fA-F]/; # matches a hexadecimal digit
/[0-9a-zA-Z_]/; # matches a "word" character,
# like those in a Perl variable name
If C is the first or last character in a character class, it is
treated as an ordinary character; C, C and C are
all equivalent.
The special character C in the first position of a character class
denotes a I, which matches any character but
those in the brackets. Both C and C must match a
character, or the match fails. Then
/[^a]at/; # doesn't match 'aat' or 'at', but matches
# all other 'bat', 'cat, '0at', '%at', etc.
/[^0-9]/; # matches a non-numeric character
/[a^]at/; # matches 'aat' or '^at'; here '^' is ordinary
Now, even C can be a bother to write multiple times, so in the
interest of saving keystrokes and making regexps more readable, Perl
has several abbreviations for common character classes, as shown below.
Since the introduction of Unicode, unless the C modifier is in
effect, these character classes match more than just a few characters in
the ASCII range.
=over 4
=item *
C matches a digit, not just C but also digits from non-roman scripts
=item *
C matches a whitespace character, the set C and others
=item *
C matches a word character (alphanumeric or C), not just C
but also digits and characters from non-roman scripts
=item *
C is a negated C; it represents any other character than a digit, or C
=item *
C is a negated C; it represents any non-whitespace character C
=item *
C is a negated C; it represents any non-word character C
=item *
The period C matches any character but C (unless the modifier C is
in effect, as explained below).
=item *
C, like the period, matches any character but C, but it does so
regardless of whether the modifier C is in effect.
=back
The C modifier, available starting in Perl 5.14, is used to
restrict the matches of C, C, and C to just those in the ASCII range.
It is useful to keep your program from being needlessly exposed to full
Unicode (and its accompanying security considerations) when all you want
is to process English-like text. (The "a" may be doubled, C, to
provide even more restrictions, preventing case-insensitive matching of
ASCII with non-ASCII characters; otherwise a Unicode "Kelvin Sign"
would caselessly match a "k" or "K".)
The C abbreviations can be used both inside and outside
of bracketed character classes. Here are some in use:
/\d\d:\d\d:\d\d/; # matches a hh:mm:ss time format
/[\d\s]/; # matches any digit or whitespace character
/\w\W\w/; # matches a word char, followed by a
# non-word char, followed by a word char
/..rt/; # matches any two chars, followed by 'rt'
/end\./; # matches 'end.'
/end[.]/; # same thing, matches 'end.'
Because a period is a metacharacter, it needs to be escaped to match
as an ordinary period. Because, for example, C and C are sets
of characters, it is incorrect to think of C as C; in
fact C is the same as C, which is the same as
C. Think DeMorgan's laws.
In actuality, the period and C abbreviations are
themselves types of character classes, so the ones surrounded by
brackets are just one type of character class. When we need to make a
distinction, we refer to them as "bracketed character classes."
An anchor useful in basic regexps is the I
C. This matches a boundary between a word character and a non-word
character C or C:
$x = "Housecat catenates house and cat";
$x =~ /cat/; # matches cat in 'housecat'
$x =~ /\bcat/; # matches cat in 'catenates'
$x =~ /cat\b/; # matches cat in 'housecat'
$x =~ /\bcat\b/; # matches 'cat' at end of string
Note in the last example, the end of the string is considered a word
boundary.
For natural language processing (so that, for example, apostrophes are
included in words), use instead C
"don't" =~ / .+? \b{wb} /x; # matches the whole string
You might wonder why C matches everything but C - why not
every character? The reason is that often one is matching against
lines and would like to ignore the newline characters. For instance,
while the string C represents one line, we would like to think
of it as empty. Then
"" =~ /^$/; # matches
"\n" =~ /^$/; # matches, $ anchors before "\n"
"" =~ /./; # doesn't match; it needs a char
"" =~ /^.$/; # doesn't match; it needs a char
"\n" =~ /^.$/; # doesn't match; it needs a char other than "\n"
"a" =~ /^.$/; # matches
"a\n" =~ /^.$/; # matches, $ anchors before "\n"
This behavior is convenient, because we usually want to ignore
newlines when we count and match characters in a line. Sometimes,
however, we want to keep track of newlines. We might even want C
and C to anchor at the beginning and end of lines within the
string, rather than just the beginning and end of the string. Perl
allows us to choose between ignoring and paying attention to newlines
by using the C and C modifiers. C and C stand for
single line and multi-line and they determine whether a string is to
be treated as one continuous string, or as a set of lines. The two
modifiers affect two aspects of how the regexp is interpreted: 1) how
the C character class is defined, and 2) where the anchors C
and C are able to match. Here are the four possible combinations:
=over 4
=item *
no modifiers: Default behavior. C matches any character
except C. C matches only at the beginning of the string and
C matches only at the end or before a newline at the end.
=item *
s modifier (C): Treat string as a single long line. C matches
any character, even C. C matches only at the beginning of
the string and C matches only at the end or before a newline at the
end.
=item *
m modifier (C): Treat string as a set of multiple lines. C
matches any character except C. C and C are able to match
at the start or end of I line within the string.
=item *
both s and m modifiers (C): Treat string as a single long line, but
detect multiple lines. C matches any character, even
C. C and C, however, are able to match at the start or end
of I line within the string.
=back
Here are examples of C and C in action:
$x = "There once was a girl\nWho programmed in Perl\n";
$x =~ /^Who/; # doesn't match, "Who" not at start of string
$x =~ /^Who/s; # doesn't match, "Who" not at start of string
$x =~ /^Who/m; # matches, "Who" at start of second line
$x =~ /^Who/sm; # matches, "Who" at start of second line
$x =~ /girl.Who/; # doesn't match, "." doesn't match "\n"
$x =~ /girl.Who/s; # matches, "." matches "\n"
$x =~ /girl.Who/m; # doesn't match, "." doesn't match "\n"
$x =~ /girl.Who/sm; # matches, "." matches "\n"
Most of the time, the default behavior is what is wanted, but C and
C are occasionally very useful. If C is being used, the start
of the string can still be matched with C and the end of the string
can still be matched with the anchors C (matches both the end and
the newline before, like C), and C (matches only the end):
$x =~ /^Who/m; # matches, "Who" at start of second line
$x =~ /\AWho/m; # doesn't match, "Who" is not at start of string
$x =~ /girl$/m; # matches, "girl" at end of first line
$x =~ /girl\Z/m; # doesn't match, "girl" is not at end of string
$x =~ /Perl\Z/m; # matches, "Perl" is at newline before end
$x =~ /Perl\z/m; # doesn't match, "Perl" is not at end of string
We now know how to create choices among classes of characters in a
regexp. What about choices among words or character strings? Such
choices are described in the next section.
=head2 Matching this or that
Sometimes we would like our regexp to be able to match different
possible words or character strings. This is accomplished by using
the I metacharacter C. To match C or C, we
form the regexp C. As before, Perl will try to match the
regexp at the earliest possible point in the string. At each
character position, Perl will first try to match the first
alternative, C. If C doesn't match, Perl will then try the
next alternative, C. If C doesn't match either, then the
match fails and Perl moves to the next position in the string. Some
examples:
"cats and dogs" =~ /cat|dog|bird/; # matches "cat"
"cats and dogs" =~ /dog|cat|bird/; # matches "cat"
Even though C is the first alternative in the second regexp,
C is able to match earlier in the string.
"cats" =~ /c|ca|cat|cats/; # matches "c"
"cats" =~ /cats|cat|ca|c/; # matches "cats"
Here, all the alternatives match at the first string position, so the
first alternative is the one that matches. If some of the
alternatives are truncations of the others, put the longest ones first
to give them a chance to match.
"cab" =~ /a|b|c/ # matches "c"
# /a|b|c/ == /[abc]/
The last example points out that character classes are like
alternations of characters. At a given character position, the first
alternative that allows the regexp match to succeed will be the one
that matches.
=head2 Grouping things and hierarchical matching
Alternation allows a regexp to choose among alternatives, but by
itself it is unsatisfying. The reason is that each alternative is a whole
regexp, but sometime we want alternatives for just part of a
regexp. For instance, suppose we want to search for housecats or
housekeepers. The regexp C fits the bill, but is
inefficient because we had to type C twice. It would be nice to
have parts of the regexp be constant, like C, and some
parts have alternatives, like C.
The I metacharacters C solve this problem. Grouping
allows parts of a regexp to be treated as a single unit. Parts of a
regexp are grouped by enclosing them in parentheses. Thus we could solve
the C by forming the regexp as
C. The regexp C means match
C followed by either C or C. Some more examples
are
/(a|b)b/; # matches 'ab' or 'bb'
/(ac|b)b/; # matches 'acb' or 'bb'
/(^a|b)c/; # matches 'ac' at start of string or 'bc' anywhere
/(a|[bc])d/; # matches 'ad', 'bd', or 'cd'
/house(cat|)/; # matches either 'housecat' or 'house'
/house(cat(s|)|)/; # matches either 'housecats' or 'housecat' or
# 'house'. Note groups can be nested.
/(19|20|)\d\d/; # match years 19xx, 20xx, or the Y2K problem, xx
"20" =~ /(19|20|)\d\d/; # matches the null alternative '()\d\d',
# because '20\d\d' can't match
Alternations behave the same way in groups as out of them: at a given
string position, the leftmost alternative that allows the regexp to
match is taken. So in the last example at the first string position,
C matches the second alternative, but there is nothing left over
to match the next two digits C. So Perl moves on to the next
alternative, which is the null alternative and that works, since
C is two digits.
The process of trying one alternative, seeing if it matches, and
moving on to the next alternative, while going back in the string
from where the previous alternative was tried, if it doesn't, is called
I. The term "backtracking" comes from the idea that
matching a regexp is like a walk in the woods. Successfully matching
a regexp is like arriving at a destination. There are many possible
trailheads, one for each string position, and each one is tried in
order, left to right. From each trailhead there may be many paths,
some of which get you there, and some which are dead ends. When you
walk along a trail and hit a dead end, you have to backtrack along the
trail to an earlier point to try another trail. If you hit your
destination, you stop immediately and forget about trying all the
other trails. You are persistent, and only if you have tried all the
trails from all the trailheads and not arrived at your destination, do
you declare failure. To be concrete, here is a step-by-step analysis
of what Perl does when it tries to match the regexp
"abcde" =~ /(abd|abc)(df|d|de)/;
=over 4
=item Z0. Start with the first letter in the string C.
E
=item Z1. Try the first alternative in the first group C.
E
=item Z2. Match C followed by C. So far so good.
E
=item Z3. C in the regexp doesn't match C in the string - a
dead end. So backtrack two characters and pick the second alternative
in the first group C.
E
=item Z4. Match C followed by C followed by C. We are on a roll
and have satisfied the first group. Set C to C.
E
=item Z5 Move on to the second group and pick the first alternative C.
E
=item Z6 Match the C.
E
=item Z7. C in the regexp doesn't match C in the string, so a dead
end. Backtrack one character and pick the second alternative in the
second group C.
E
=item Z8. C matches. The second grouping is satisfied, so set
C to C.
E
=item Z9. We are at the end of the regexp, so we are done! We have
matched C out of the string C.
=back
There are a couple of things to note about this analysis. First, the
third alternative in the second group C also allows a match, but we
stopped before we got to it - at a given character position, leftmost
wins. Second, we were able to get a match at the first character
position of the string C. If there were no matches at the first
position, Perl would move to the second character position C and
attempt the match all over again. Only when all possible paths at all
possible character positions have been exhausted does Perl give
up and declare S> to be false.
Even with all this work, regexp matching happens remarkably fast. To
speed things up, Perl compiles the regexp into a compact sequence of
opcodes that can often fit inside a processor cache. When the code is
executed, these opcodes can then run at full throttle and search very
quickly.
=head2 Extracting matches
The grouping metacharacters C also serve another completely
different function: they allow the extraction of the parts of a string
that matched. This is very useful to find out what matched and for
text processing in general. For each grouping, the part that matched
inside goes into the special variables C, C, I. They can be
used just as ordinary variables:
# extract hours, minutes, seconds
if ($time =~ /(\d\d):(\d\d):(\d\d)/) { # match hh:mm:ss format
$hours = $1;
$minutes = $2;
$seconds = $3;
}
Now, we know that in scalar context,
S> returns a true or false
value. In list context, however, it returns the list of matched values
C. So we could write the code more compactly as
# extract hours, minutes, seconds
($hours, $minutes, $second) = ($time =~ /(\d\d):(\d\d):(\d\d)/);
If the groupings in a regexp are nested, C gets the group with the
leftmost opening parenthesis, C the next opening parenthesis,
I. Here is a regexp with nested groups:
/(ab(cd|ef)((gi)|j))/;
1 2 34
If this regexp matches, C contains a string starting with
C, C is either set to C or C, C equals either
C or C, and C is either set to C, just like C,
or it remains undefined.
For convenience, Perl sets C to the string held by the highest numbered
C, C,... that got assigned (and, somewhat related, C to the
value of the C, C,... most-recently assigned; I the C,
C,... associated with the rightmost closing parenthesis used in the
match).
=head2 Backreferences
Closely associated with the matching variables C, C, ... are
the I C, C,... Backreferences are simply
matching variables that can be used I a regexp. This is a
really nice feature; what matches later in a regexp is made to depend on
what matched earlier in the regexp. Suppose we wanted to look
for doubled words in a text, like "the the". The following regexp finds
all 3-letter doubles with a space in between:
/\b(\w\w\w)\s\g1\b/;
The grouping assigns a value to C, so that the same 3-letter sequence
is used for both parts.
A similar task is to find words consisting of two identical parts:
% simple_grep '^(\w\w\w\w|\w\w\w|\w\w|\w)\g1$' /usr/dict/words
beriberi
booboo
coco
mama
murmur
papa
The regexp has a single grouping which considers 4-letter
combinations, then 3-letter combinations, I., and uses C to look for
a repeat. Although C and C represent the same thing, care should be
taken to use matched variables C, C,... only I a regexp
and backreferences C, C,... only I a regexp; not doing
so may lead to surprising and unsatisfactory results.
=head2 Relative backreferences
Counting the opening parentheses to get the correct number for a
backreference is error-prone as soon as there is more than one
capturing group. A more convenient technique became available
with Perl 5.10: relative backreferences. To refer to the immediately
preceding capture group one now may write C, the next but
last is available via C, and so on.
Another good reason in addition to readability and maintainability
for using relative backreferences is illustrated by the following example,
where a simple pattern for matching peculiar strings is used:
$a99a = '([a-z])(\d)\g2\g1'; # matches a11a, g22g, x33x, etc.
Now that we have this pattern stored as a handy string, we might feel
tempted to use it as a part of some other pattern:
$line = "code=e99e";
if ($line =~ /^(\w+)=$a99a$/){ # unexpected behavior!
print "$1 is valid\n";
} else {
print "bad line: '$line'\n";
}
But this doesn't match, at least not the way one might expect. Only
after inserting the interpolated C and looking at the resulting
full text of the regexp is it obvious that the backreferences have
backfired. The subexpression C has snatched number 1 and
demoted the groups in C by one rank. This can be avoided by
using relative backreferences:
$a99a = '([a-z])(\d)\g{-1}\g{-2}'; # safe for being interpolated
=head2 Named backreferences
Perl 5.10 also introduced named capture groups and named backreferences.
To attach a name to a capturing group, you write either
C...) >> or C>. The backreference may
then be written as C. It is permissible to attach the
same name to more than one group, but then only the leftmost one of the
eponymous set can be referenced. Outside of the pattern a named
capture group is accessible through the C hash.
Assuming that we have to match calendar dates which may be given in one
of the three formats yyyy-mm-dd, mm/dd/yyyy or dd.mm.yyyy, we can write
three suitable patterns where we use C, C and C respectively as the
names of the groups capturing the pertaining components of a date. The
matching operation combines the three patterns as alternatives:
$fmt1 = '(?\d\d\d\d)-(?\d\d)-(?\d\d)';
$fmt2 = '(?\d\d)/(?\d\d)/(?\d\d\d\d)';
$fmt3 = '(?\d\d)\.(?\d\d)\.(?\d\d\d\d)';
for my $d (qw(2006-10-21 15.01.2007 10/31/2005)) {
if ( $d =~ m{$fmt1|$fmt2|$fmt3} ){
print "day=$+{d} month=$+{m} year=$+{y}\n";
}
}
If any of the alternatives matches, the hash C is bound to contain the
three key-value pairs.
=head2 Alternative capture group numbering
Yet another capturing group numbering technique (also as from Perl 5.10)
deals with the problem of referring to groups within a set of alternatives.
Consider a pattern for matching a time of the day, civil or military style:
if ( $time =~ /(\d\d|\d):(\d\d)|(\d\d)(\d\d)/ ){
# process hour and minute
}
Processing the results requires an additional if statement to determine
whether C and C or C and C contain the goodies. It would
be easier if we could use group numbers 1 and 2 in second alternative as
well, and this is exactly what the parenthesized construct C,
set around an alternative achieves. Here is an extended version of the
previous pattern:
if($time =~ /(?|(\d\d|\d):(\d\d)|(\d\d)(\d\d))\s+([A-Z][A-Z][A-Z])/){
print "hour=$1 minute=$2 zone=$3\n";
}
Within the alternative numbering group, group numbers start at the same
position for each alternative. After the group, numbering continues
with one higher than the maximum reached across all the alternatives.
=head2 Position information
In addition to what was matched, Perl also provides the
positions of what was matched as contents of the C and C
arrays. C is the position of the start of the entire match and
C is the position of the end. Similarly, C is the
position of the start of the C match and C is the position
of the end. If C is undefined, so are C and C. Then
this code
$x = "Mmm...donut, thought Homer";
$x =~ /^(Mmm|Yech)\.\.\.(donut|peas)/; # matches
foreach $exp (1..$#-) {
print "Match $exp: '${$exp}' at position ($-[$exp],$+[$exp])\n";
}
prints
Match 1: 'Mmm' at position (0,3)
Match 2: 'donut' at position (6,11)
Even if there are no groupings in a regexp, it is still possible to
find out what exactly matched in a string. If you use them, Perl
will set C to the part of the string before the match, will set C
to the part of the string that matched, and will set C to the part
of the string after the match. An example:
$x = "the cat caught the mouse";
$x =~ /cat/; # $` = 'the ', $& = 'cat', $' = ' caught the mouse'
$x =~ /the/; # $` = '', $& = 'the', $' = ' cat caught the mouse'
In the second match, C equals C because the regexp matched at the
first character position in the string and stopped; it never saw the
second "the".
If your code is to run on Perl versions earlier than
5.20, it is worthwhile to note that using C and C
slows down regexp matching quite a bit, while C slows it down to a
lesser extent, because if they are used in one regexp in a program,
they are generated for I regexps in the program. So if raw
performance is a goal of your application, they should be avoided.
If you need to extract the corresponding substrings, use C and
C instead:
$` is the same as substr( $x, 0, $-[0] )
$& is the same as substr( $x, $-[0], $+[0]-$-[0] )
$' is the same as substr( $x, $+[0] )
As of Perl 5.10, the C, C and C
variables may be used. These are only set if the C