This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update IO-Compress to CPAN version 2.040
[perl5.git] / pod / perlop.pod
CommitLineData
a0d0e21e 1=head1 NAME
d74e8afc 2X<operator>
a0d0e21e
LW
3
4perlop - Perl operators and precedence
5
d042e63d
MS
6=head1 DESCRIPTION
7
89d205f2 8=head2 Operator Precedence and Associativity
d74e8afc 9X<operator, precedence> X<precedence> X<associativity>
d042e63d
MS
10
11Operator precedence and associativity work in Perl more or less like
12they do in mathematics.
13
14I<Operator precedence> means some operators are evaluated before
15others. For example, in C<2 + 4 * 5>, the multiplication has higher
16precedence so C<4 * 5> is evaluated first yielding C<2 + 20 ==
1722> and not C<6 * 5 == 30>.
18
19I<Operator associativity> defines what happens if a sequence of the
20same operators is used one after another: whether the evaluator will
21evaluate the left operations first or the right. For example, in C<8
22- 4 - 2>, subtraction is left associative so Perl evaluates the
23expression left to right. C<8 - 4> is evaluated first making the
24expression C<4 - 2 == 2> and not C<8 - 2 == 6>.
a0d0e21e
LW
25
26Perl operators have the following associativity and precedence,
19799a22
GS
27listed from highest precedence to lowest. Operators borrowed from
28C keep the same precedence relationship with each other, even where
29C's precedence is slightly screwy. (This makes learning Perl easier
30for C folks.) With very few exceptions, these all operate on scalar
31values only, not array values.
a0d0e21e
LW
32
33 left terms and list operators (leftward)
34 left ->
35 nonassoc ++ --
36 right **
37 right ! ~ \ and unary + and -
54310121 38 left =~ !~
a0d0e21e
LW
39 left * / % x
40 left + - .
41 left << >>
42 nonassoc named unary operators
43 nonassoc < > <= >= lt gt le ge
0d863452 44 nonassoc == != <=> eq ne cmp ~~
a0d0e21e
LW
45 left &
46 left | ^
47 left &&
c963b151 48 left || //
137443ea 49 nonassoc .. ...
a0d0e21e
LW
50 right ?:
51 right = += -= *= etc.
52 left , =>
53 nonassoc list operators (rightward)
a5f75d66 54 right not
a0d0e21e 55 left and
f23102e2 56 left or xor
a0d0e21e
LW
57
58In the following sections, these operators are covered in precedence order.
59
5a964f20
TC
60Many operators can be overloaded for objects. See L<overload>.
61
a0d0e21e 62=head2 Terms and List Operators (Leftward)
d74e8afc 63X<list operator> X<operator, list> X<term>
a0d0e21e 64
62c18ce2 65A TERM has the highest precedence in Perl. They include variables,
5f05dabc 66quote and quote-like operators, any expression in parentheses,
a0d0e21e
LW
67and any function whose arguments are parenthesized. Actually, there
68aren't really functions in this sense, just list operators and unary
69operators behaving as functions because you put parentheses around
70the arguments. These are all documented in L<perlfunc>.
71
72If any list operator (print(), etc.) or any unary operator (chdir(), etc.)
73is followed by a left parenthesis as the next token, the operator and
74arguments within parentheses are taken to be of highest precedence,
75just like a normal function call.
76
77In the absence of parentheses, the precedence of list operators such as
78C<print>, C<sort>, or C<chmod> is either very high or very low depending on
54310121 79whether you are looking at the left side or the right side of the operator.
a0d0e21e
LW
80For example, in
81
82 @ary = (1, 3, sort 4, 2);
83 print @ary; # prints 1324
84
19799a22
GS
85the commas on the right of the sort are evaluated before the sort,
86but the commas on the left are evaluated after. In other words,
87list operators tend to gobble up all arguments that follow, and
a0d0e21e 88then act like a simple TERM with regard to the preceding expression.
19799a22 89Be careful with parentheses:
a0d0e21e
LW
90
91 # These evaluate exit before doing the print:
92 print($foo, exit); # Obviously not what you want.
93 print $foo, exit; # Nor is this.
94
95 # These do the print before evaluating exit:
96 (print $foo), exit; # This is what you want.
97 print($foo), exit; # Or this.
98 print ($foo), exit; # Or even this.
99
100Also note that
101
102 print ($foo & 255) + 1, "\n";
103
d042e63d
MS
104probably doesn't do what you expect at first glance. The parentheses
105enclose the argument list for C<print> which is evaluated (printing
106the result of C<$foo & 255>). Then one is added to the return value
107of C<print> (usually 1). The result is something like this:
108
109 1 + 1, "\n"; # Obviously not what you meant.
110
111To do what you meant properly, you must write:
112
113 print(($foo & 255) + 1, "\n");
114
115See L<Named Unary Operators> for more discussion of this.
a0d0e21e
LW
116
117Also parsed as terms are the C<do {}> and C<eval {}> constructs, as
54310121 118well as subroutine and method calls, and the anonymous
a0d0e21e
LW
119constructors C<[]> and C<{}>.
120
2ae324a7 121See also L<Quote and Quote-like Operators> toward the end of this section,
da87341d 122as well as L</"I/O Operators">.
a0d0e21e
LW
123
124=head2 The Arrow Operator
d74e8afc 125X<arrow> X<dereference> X<< -> >>
a0d0e21e 126
35f2feb0 127"C<< -> >>" is an infix dereference operator, just as it is in C
19799a22
GS
128and C++. If the right side is either a C<[...]>, C<{...}>, or a
129C<(...)> subscript, then the left side must be either a hard or
130symbolic reference to an array, a hash, or a subroutine respectively.
131(Or technically speaking, a location capable of holding a hard
132reference, if it's an array or hash reference being used for
133assignment.) See L<perlreftut> and L<perlref>.
a0d0e21e 134
19799a22
GS
135Otherwise, the right side is a method name or a simple scalar
136variable containing either the method name or a subroutine reference,
137and the left side must be either an object (a blessed reference)
138or a class name (that is, a package name). See L<perlobj>.
a0d0e21e 139
5f05dabc 140=head2 Auto-increment and Auto-decrement
d74e8afc 141X<increment> X<auto-increment> X<++> X<decrement> X<auto-decrement> X<-->
a0d0e21e 142
d042e63d
MS
143"++" and "--" work as in C. That is, if placed before a variable,
144they increment or decrement the variable by one before returning the
145value, and if placed after, increment or decrement after returning the
146value.
147
148 $i = 0; $j = 0;
149 print $i++; # prints 0
150 print ++$j; # prints 1
a0d0e21e 151
b033823e 152Note that just as in C, Perl doesn't define B<when> the variable is
89d205f2 153incremented or decremented. You just know it will be done sometime
b033823e 154before or after the value is returned. This also means that modifying
c543c01b 155a variable twice in the same statement will lead to undefined behavior.
b033823e
A
156Avoid statements like:
157
158 $i = $i ++;
159 print ++ $i + $i ++;
160
161Perl will not guarantee what the result of the above statements is.
162
54310121 163The auto-increment operator has a little extra builtin magic to it. If
a0d0e21e
LW
164you increment a variable that is numeric, or that has ever been used in
165a numeric context, you get a normal increment. If, however, the
5f05dabc 166variable has been used in only string contexts since it was set, and
5a964f20 167has a value that is not the empty string and matches the pattern
9c0670e1 168C</^[a-zA-Z]*[0-9]*\z/>, the increment is done as a string, preserving each
a0d0e21e
LW
169character within its range, with carry:
170
c543c01b
TC
171 print ++($foo = "99"); # prints "100"
172 print ++($foo = "a0"); # prints "a1"
173 print ++($foo = "Az"); # prints "Ba"
174 print ++($foo = "zz"); # prints "aaa"
a0d0e21e 175
6a61d433
HS
176C<undef> is always treated as numeric, and in particular is changed
177to C<0> before incrementing (so that a post-increment of an undef value
178will return C<0> rather than C<undef>).
179
5f05dabc 180The auto-decrement operator is not magical.
a0d0e21e
LW
181
182=head2 Exponentiation
d74e8afc 183X<**> X<exponentiation> X<power>
a0d0e21e 184
19799a22 185Binary "**" is the exponentiation operator. It binds even more
cb1a09d0
AD
186tightly than unary minus, so -2**4 is -(2**4), not (-2)**4. (This is
187implemented using C's pow(3) function, which actually works on doubles
188internally.)
a0d0e21e
LW
189
190=head2 Symbolic Unary Operators
d74e8afc 191X<unary operator> X<operator, unary>
a0d0e21e 192
5f05dabc 193Unary "!" performs logical negation, i.e., "not". See also C<not> for a lower
a0d0e21e 194precedence version of this.
d74e8afc 195X<!>
a0d0e21e 196
da2f94c5
FC
197Unary "-" performs arithmetic negation if the operand is numeric,
198including any string that looks like a number. If the operand is
199an identifier, a string consisting of a minus sign concatenated
200with the identifier is returned. Otherwise, if the string starts
201with a plus or minus, a string starting with the opposite sign is
202returned. One effect of these rules is that -bareword is equivalent
8705167b 203to the string "-bareword". If, however, the string begins with a
353c6505 204non-alphabetic character (excluding "+" or "-"), Perl will attempt to convert
06705523
SP
205the string to a numeric and the arithmetic negation is performed. If the
206string cannot be cleanly converted to a numeric, Perl will give the warning
207B<Argument "the string" isn't numeric in negation (-) at ...>.
d74e8afc 208X<-> X<negation, arithmetic>
a0d0e21e 209
972b05a9
JH
210Unary "~" performs bitwise negation, i.e., 1's complement. For
211example, C<0666 & ~027> is 0640. (See also L<Integer Arithmetic> and
212L<Bitwise String Operators>.) Note that the width of the result is
213platform-dependent: ~0 is 32 bits wide on a 32-bit platform, but 64
214bits wide on a 64-bit platform, so if you are expecting a certain bit
f113cf86 215width, remember to use the "&" operator to mask off the excess bits.
d74e8afc 216X<~> X<negation, binary>
a0d0e21e 217
f113cf86
TC
218When complementing strings, if all characters have ordinal values under
219256, then their complements will, also. But if they do not, all
220characters will be in either 32- or 64-bit complements, depending on your
221architecture. So for example, C<~"\x{3B1}"> is C<"\x{FFFF_FC4E}"> on
22232-bit machines and C<"\x{FFFF_FFFF_FFFF_FC4E}"> on 64-bit machines.
223
a0d0e21e
LW
224Unary "+" has no effect whatsoever, even on strings. It is useful
225syntactically for separating a function name from a parenthesized expression
226that would otherwise be interpreted as the complete list of function
5ba421f6 227arguments. (See examples above under L<Terms and List Operators (Leftward)>.)
d74e8afc 228X<+>
a0d0e21e 229
19799a22
GS
230Unary "\" creates a reference to whatever follows it. See L<perlreftut>
231and L<perlref>. Do not confuse this behavior with the behavior of
232backslash within a string, although both forms do convey the notion
233of protecting the next thing from interpolation.
d74e8afc 234X<\> X<reference> X<backslash>
a0d0e21e
LW
235
236=head2 Binding Operators
d74e8afc 237X<binding> X<operator, binding> X<=~> X<!~>
a0d0e21e 238
c07a80fd 239Binary "=~" binds a scalar expression to a pattern match. Certain operations
cb1a09d0
AD
240search or modify the string $_ by default. This operator makes that kind
241of operation work on some other string. The right argument is a search
2c268ad5
TP
242pattern, substitution, or transliteration. The left argument is what is
243supposed to be searched, substituted, or transliterated instead of the default
f8bab1e9 244$_. When used in scalar context, the return value generally indicates the
8ff32507
FC
245success of the operation. The exceptions are substitution (s///)
246and transliteration (y///) with the C</r> (non-destructive) option,
247which cause the B<r>eturn value to be the result of the substitution.
248Behavior in list context depends on the particular operator.
000c65fc
DG
249See L</"Regexp Quote-Like Operators"> for details and L<perlretut> for
250examples using these operators.
f8bab1e9
GS
251
252If the right argument is an expression rather than a search pattern,
2c268ad5 253substitution, or transliteration, it is interpreted as a search pattern at run
89d205f2
YO
254time. Note that this means that its contents will be interpolated twice, so
255
256 '\\' =~ q'\\';
257
258is not ok, as the regex engine will end up trying to compile the
259pattern C<\>, which it will consider a syntax error.
a0d0e21e
LW
260
261Binary "!~" is just like "=~" except the return value is negated in
262the logical sense.
263
8ff32507
FC
264Binary "!~" with a non-destructive substitution (s///r) or transliteration
265(y///r) is a syntax error.
4f4d7508 266
a0d0e21e 267=head2 Multiplicative Operators
d74e8afc 268X<operator, multiplicative>
a0d0e21e
LW
269
270Binary "*" multiplies two numbers.
d74e8afc 271X<*>
a0d0e21e
LW
272
273Binary "/" divides two numbers.
d74e8afc 274X</> X<slash>
a0d0e21e 275
f7918450
KW
276Binary "%" is the modulo operator, which computes the division
277remainder of its first argument with respect to its second argument.
278Given integer
54310121 279operands C<$a> and C<$b>: If C<$b> is positive, then C<$a % $b> is
f7918450 280C<$a> minus the largest multiple of C<$b> less than or equal to
54310121 281C<$a>. If C<$b> is negative, then C<$a % $b> is C<$a> minus the
282smallest multiple of C<$b> that is not less than C<$a> (i.e. the
89b4f0ad 283result will be less than or equal to zero). If the operands
4848a83b
TS
284C<$a> and C<$b> are floating point values and the absolute value of
285C<$b> (that is C<abs($b)>) is less than C<(UV_MAX + 1)>, only
286the integer portion of C<$a> and C<$b> will be used in the operation
287(Note: here C<UV_MAX> means the maximum of the unsigned integer type).
288If the absolute value of the right operand (C<abs($b)>) is greater than
289or equal to C<(UV_MAX + 1)>, "%" computes the floating-point remainder
290C<$r> in the equation C<($r = $a - $i*$b)> where C<$i> is a certain
f7918450 291integer that makes C<$r> have the same sign as the right operand
4848a83b
TS
292C<$b> (B<not> as the left operand C<$a> like C function C<fmod()>)
293and the absolute value less than that of C<$b>.
0412d526 294Note that when C<use integer> is in scope, "%" gives you direct access
f7918450 295to the modulo operator as implemented by your C compiler. This
55d729e4
GS
296operator is not as well defined for negative operands, but it will
297execute faster.
f7918450 298X<%> X<remainder> X<modulo> X<mod>
55d729e4 299
62d10b70
GS
300Binary "x" is the repetition operator. In scalar context or if the left
301operand is not enclosed in parentheses, it returns a string consisting
302of the left operand repeated the number of times specified by the right
303operand. In list context, if the left operand is enclosed in
3585017f
YST
304parentheses or is a list formed by C<qw/STRING/>, it repeats the list.
305If the right operand is zero or negative, it returns an empty string
306or an empty list, depending on the context.
d74e8afc 307X<x>
a0d0e21e
LW
308
309 print '-' x 80; # print row of dashes
310
311 print "\t" x ($tab/8), ' ' x ($tab%8); # tab over
312
313 @ones = (1) x 80; # a list of 80 1's
314 @ones = (5) x @ones; # set all elements to 5
315
316
317=head2 Additive Operators
d74e8afc 318X<operator, additive>
a0d0e21e
LW
319
320Binary "+" returns the sum of two numbers.
d74e8afc 321X<+>
a0d0e21e
LW
322
323Binary "-" returns the difference of two numbers.
d74e8afc 324X<->
a0d0e21e
LW
325
326Binary "." concatenates two strings.
d74e8afc
ITB
327X<string, concatenation> X<concatenation>
328X<cat> X<concat> X<concatenate> X<.>
a0d0e21e
LW
329
330=head2 Shift Operators
d74e8afc
ITB
331X<shift operator> X<operator, shift> X<<< << >>>
332X<<< >> >>> X<right shift> X<left shift> X<bitwise shift>
333X<shl> X<shr> X<shift, right> X<shift, left>
a0d0e21e 334
55497cff 335Binary "<<" returns the value of its left argument shifted left by the
336number of bits specified by the right argument. Arguments should be
982ce180 337integers. (See also L<Integer Arithmetic>.)
a0d0e21e 338
55497cff 339Binary ">>" returns the value of its left argument shifted right by
340the number of bits specified by the right argument. Arguments should
982ce180 341be integers. (See also L<Integer Arithmetic>.)
a0d0e21e 342
b16cf6df
JH
343Note that both "<<" and ">>" in Perl are implemented directly using
344"<<" and ">>" in C. If C<use integer> (see L<Integer Arithmetic>) is
345in force then signed C integers are used, else unsigned C integers are
346used. Either way, the implementation isn't going to generate results
347larger than the size of the integer type Perl was built with (32 bits
348or 64 bits).
349
350The result of overflowing the range of the integers is undefined
351because it is undefined also in C. In other words, using 32-bit
352integers, C<< 1 << 32 >> is undefined. Shifting by a negative number
353of bits is also undefined.
354
a0d0e21e 355=head2 Named Unary Operators
d74e8afc 356X<operator, named unary>
a0d0e21e
LW
357
358The various named unary operators are treated as functions with one
568e6d8b 359argument, with optional parentheses.
a0d0e21e
LW
360
361If any list operator (print(), etc.) or any unary operator (chdir(), etc.)
362is followed by a left parenthesis as the next token, the operator and
363arguments within parentheses are taken to be of highest precedence,
3981b0eb
JA
364just like a normal function call. For example,
365because named unary operators are higher precedence than ||:
a0d0e21e
LW
366
367 chdir $foo || die; # (chdir $foo) || die
368 chdir($foo) || die; # (chdir $foo) || die
369 chdir ($foo) || die; # (chdir $foo) || die
370 chdir +($foo) || die; # (chdir $foo) || die
371
3981b0eb 372but, because * is higher precedence than named operators:
a0d0e21e
LW
373
374 chdir $foo * 20; # chdir ($foo * 20)
375 chdir($foo) * 20; # (chdir $foo) * 20
376 chdir ($foo) * 20; # (chdir $foo) * 20
377 chdir +($foo) * 20; # chdir ($foo * 20)
378
379 rand 10 * 20; # rand (10 * 20)
380 rand(10) * 20; # (rand 10) * 20
381 rand (10) * 20; # (rand 10) * 20
382 rand +(10) * 20; # rand (10 * 20)
383
568e6d8b
RGS
384Regarding precedence, the filetest operators, like C<-f>, C<-M>, etc. are
385treated like named unary operators, but they don't follow this functional
386parenthesis rule. That means, for example, that C<-f($file).".bak"> is
387equivalent to C<-f "$file.bak">.
d74e8afc 388X<-X> X<filetest> X<operator, filetest>
568e6d8b 389
5ba421f6 390See also L<"Terms and List Operators (Leftward)">.
a0d0e21e
LW
391
392=head2 Relational Operators
d74e8afc 393X<relational operator> X<operator, relational>
a0d0e21e 394
35f2feb0 395Binary "<" returns true if the left argument is numerically less than
a0d0e21e 396the right argument.
d74e8afc 397X<< < >>
a0d0e21e 398
35f2feb0 399Binary ">" returns true if the left argument is numerically greater
a0d0e21e 400than the right argument.
d74e8afc 401X<< > >>
a0d0e21e 402
35f2feb0 403Binary "<=" returns true if the left argument is numerically less than
a0d0e21e 404or equal to the right argument.
d74e8afc 405X<< <= >>
a0d0e21e 406
35f2feb0 407Binary ">=" returns true if the left argument is numerically greater
a0d0e21e 408than or equal to the right argument.
d74e8afc 409X<< >= >>
a0d0e21e
LW
410
411Binary "lt" returns true if the left argument is stringwise less than
412the right argument.
d74e8afc 413X<< lt >>
a0d0e21e
LW
414
415Binary "gt" returns true if the left argument is stringwise greater
416than the right argument.
d74e8afc 417X<< gt >>
a0d0e21e
LW
418
419Binary "le" returns true if the left argument is stringwise less than
420or equal to the right argument.
d74e8afc 421X<< le >>
a0d0e21e
LW
422
423Binary "ge" returns true if the left argument is stringwise greater
424than or equal to the right argument.
d74e8afc 425X<< ge >>
a0d0e21e
LW
426
427=head2 Equality Operators
d74e8afc 428X<equality> X<equal> X<equals> X<operator, equality>
a0d0e21e
LW
429
430Binary "==" returns true if the left argument is numerically equal to
431the right argument.
d74e8afc 432X<==>
a0d0e21e
LW
433
434Binary "!=" returns true if the left argument is numerically not equal
435to the right argument.
d74e8afc 436X<!=>
a0d0e21e 437
35f2feb0 438Binary "<=>" returns -1, 0, or 1 depending on whether the left
6ee5d4e7 439argument is numerically less than, equal to, or greater than the right
d4ad863d 440argument. If your platform supports NaNs (not-a-numbers) as numeric
7d3a9d88
NC
441values, using them with "<=>" returns undef. NaN is not "<", "==", ">",
442"<=" or ">=" anything (even NaN), so those 5 return false. NaN != NaN
443returns true, as does NaN != anything else. If your platform doesn't
444support NaNs then NaN is just a string with numeric value 0.
d74e8afc 445X<< <=> >> X<spaceship>
7d3a9d88 446
2b54f59f
YST
447 perl -le '$a = "NaN"; print "No NaN support here" if $a == $a'
448 perl -le '$a = "NaN"; print "NaN support here" if $a != $a'
a0d0e21e
LW
449
450Binary "eq" returns true if the left argument is stringwise equal to
451the right argument.
d74e8afc 452X<eq>
a0d0e21e
LW
453
454Binary "ne" returns true if the left argument is stringwise not equal
455to the right argument.
d74e8afc 456X<ne>
a0d0e21e 457
d4ad863d
JH
458Binary "cmp" returns -1, 0, or 1 depending on whether the left
459argument is stringwise less than, equal to, or greater than the right
460argument.
d74e8afc 461X<cmp>
a0d0e21e 462
0d863452 463Binary "~~" does a smart match between its arguments. Smart matching
0f7107a0 464is described in L<perlsyn/"Smart matching in detail">.
0d863452
RH
465X<~~>
466
a034a98d
DD
467"lt", "le", "ge", "gt" and "cmp" use the collation (sort) order specified
468by the current locale if C<use locale> is in effect. See L<perllocale>.
469
a0d0e21e 470=head2 Bitwise And
d74e8afc 471X<operator, bitwise, and> X<bitwise and> X<&>
a0d0e21e 472
2cdc098b 473Binary "&" returns its operands ANDed together bit by bit.
2c268ad5 474(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 475
2cdc098b
MG
476Note that "&" has lower priority than relational operators, so for example
477the brackets are essential in a test like
478
479 print "Even\n" if ($x & 1) == 0;
480
a0d0e21e 481=head2 Bitwise Or and Exclusive Or
d74e8afc
ITB
482X<operator, bitwise, or> X<bitwise or> X<|> X<operator, bitwise, xor>
483X<bitwise xor> X<^>
a0d0e21e 484
2cdc098b 485Binary "|" returns its operands ORed together bit by bit.
2c268ad5 486(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 487
2cdc098b 488Binary "^" returns its operands XORed together bit by bit.
2c268ad5 489(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 490
2cdc098b
MG
491Note that "|" and "^" have lower priority than relational operators, so
492for example the brackets are essential in a test like
493
494 print "false\n" if (8 | 2) != 10;
495
a0d0e21e 496=head2 C-style Logical And
d74e8afc 497X<&&> X<logical and> X<operator, logical, and>
a0d0e21e
LW
498
499Binary "&&" performs a short-circuit logical AND operation. That is,
500if the left operand is false, the right operand is not even evaluated.
501Scalar or list context propagates down to the right operand if it
502is evaluated.
503
504=head2 C-style Logical Or
d74e8afc 505X<||> X<operator, logical, or>
a0d0e21e
LW
506
507Binary "||" performs a short-circuit logical OR operation. That is,
508if the left operand is true, the right operand is not even evaluated.
509Scalar or list context propagates down to the right operand if it
510is evaluated.
511
c963b151 512=head2 C-style Logical Defined-Or
d74e8afc 513X<//> X<operator, logical, defined-or>
c963b151
BD
514
515Although it has no direct equivalent in C, Perl's C<//> operator is related
89d205f2 516to its C-style or. In fact, it's exactly the same as C<||>, except that it
95bee9ba
A
517tests the left hand side's definedness instead of its truth. Thus,
518C<< EXPR1 // EXPR2 >> returns the value of C<< EXPR1 >> if it's defined,
519otherwise, the value of C<< EXPR2 >> is returned. (C<< EXPR1 >> is evaluated
520in scalar context, C<< EXPR2 >> in the context of C<< // >> itself). Usually,
521this is the same result as C<< defined(EXPR1) ? EXPR1 : EXPR2 >> (except that
522the ternary-operator form can be used as a lvalue, while C<< EXPR1 // EXPR2 >>
523cannot). This is very useful for
bdc7923b
RGS
524providing default values for variables. If you actually want to test if
525at least one of C<$a> and C<$b> is defined, use C<defined($a // $b)>.
c963b151 526
d042e63d
MS
527The C<||>, C<//> and C<&&> operators return the last value evaluated
528(unlike C's C<||> and C<&&>, which return 0 or 1). Thus, a reasonably
529portable way to find out the home directory might be:
a0d0e21e 530
c543c01b
TC
531 $home = $ENV{HOME}
532 // $ENV{LOGDIR}
533 // (getpwuid($<))[7]
534 // die "You're homeless!\n";
a0d0e21e 535
5a964f20
TC
536In particular, this means that you shouldn't use this
537for selecting between two aggregates for assignment:
538
539 @a = @b || @c; # this is wrong
540 @a = scalar(@b) || @c; # really meant this
541 @a = @b ? @b : @c; # this works fine, though
542
f23102e2
RGS
543As more readable alternatives to C<&&> and C<||> when used for
544control flow, Perl provides the C<and> and C<or> operators (see below).
545The short-circuit behavior is identical. The precedence of "and"
c963b151 546and "or" is much lower, however, so that you can safely use them after a
5a964f20 547list operator without the need for parentheses:
a0d0e21e
LW
548
549 unlink "alpha", "beta", "gamma"
550 or gripe(), next LINE;
551
552With the C-style operators that would have been written like this:
553
554 unlink("alpha", "beta", "gamma")
555 || (gripe(), next LINE);
556
eeb6a2c9 557Using "or" for assignment is unlikely to do what you want; see below.
5a964f20
TC
558
559=head2 Range Operators
d74e8afc 560X<operator, range> X<range> X<..> X<...>
a0d0e21e
LW
561
562Binary ".." is the range operator, which is really two different
fb53bbb2 563operators depending on the context. In list context, it returns a
54ae734e 564list of values counting (up by ones) from the left value to the right
2cdbc966 565value. If the left value is greater than the right value then it
fb53bbb2 566returns the empty list. The range operator is useful for writing
54ae734e 567C<foreach (1..10)> loops and for doing slice operations on arrays. In
2cdbc966
JD
568the current implementation, no temporary array is created when the
569range operator is used as the expression in C<foreach> loops, but older
570versions of Perl might burn a lot of memory when you write something
571like this:
a0d0e21e
LW
572
573 for (1 .. 1_000_000) {
574 # code
54310121 575 }
a0d0e21e 576
8f0f46f8 577The range operator also works on strings, using the magical
578auto-increment, see below.
54ae734e 579
5a964f20 580In scalar context, ".." returns a boolean value. The operator is
8f0f46f8 581bistable, like a flip-flop, and emulates the line-range (comma)
582operator of B<sed>, B<awk>, and various editors. Each ".." operator
583maintains its own boolean state, even across calls to a subroutine
584that contains it. It is false as long as its left operand is false.
a0d0e21e
LW
585Once the left operand is true, the range operator stays true until the
586right operand is true, I<AFTER> which the range operator becomes false
8f0f46f8 587again. It doesn't become false till the next time the range operator
588is evaluated. It can test the right operand and become false on the
589same evaluation it became true (as in B<awk>), but it still returns
590true once. If you don't want it to test the right operand until the
591next evaluation, as in B<sed>, just use three dots ("...") instead of
19799a22
GS
592two. In all other regards, "..." behaves just like ".." does.
593
594The right operand is not evaluated while the operator is in the
595"false" state, and the left operand is not evaluated while the
596operator is in the "true" state. The precedence is a little lower
597than || and &&. The value returned is either the empty string for
8f0f46f8 598false, or a sequence number (beginning with 1) for true. The sequence
599number is reset for each range encountered. The final sequence number
600in a range has the string "E0" appended to it, which doesn't affect
601its numeric value, but gives you something to search for if you want
602to exclude the endpoint. You can exclude the beginning point by
603waiting for the sequence number to be greater than 1.
df5f8116
CW
604
605If either operand of scalar ".." is a constant expression,
606that operand is considered true if it is equal (C<==>) to the current
607input line number (the C<$.> variable).
608
609To be pedantic, the comparison is actually C<int(EXPR) == int(EXPR)>,
610but that is only an issue if you use a floating point expression; when
611implicitly using C<$.> as described in the previous paragraph, the
612comparison is C<int(EXPR) == int($.)> which is only an issue when C<$.>
613is set to a floating point value and you are not reading from a file.
614Furthermore, C<"span" .. "spat"> or C<2.18 .. 3.14> will not do what
615you want in scalar context because each of the operands are evaluated
616using their integer representation.
617
618Examples:
a0d0e21e
LW
619
620As a scalar operator:
621
df5f8116 622 if (101 .. 200) { print; } # print 2nd hundred lines, short for
950b09ed 623 # if ($. == 101 .. $. == 200) { print; }
9f10b797
RGS
624
625 next LINE if (1 .. /^$/); # skip header lines, short for
f343f960 626 # next LINE if ($. == 1 .. /^$/);
9f10b797
RGS
627 # (typically in a loop labeled LINE)
628
629 s/^/> / if (/^$/ .. eof()); # quote body
a0d0e21e 630
5a964f20
TC
631 # parse mail messages
632 while (<>) {
633 $in_header = 1 .. /^$/;
df5f8116
CW
634 $in_body = /^$/ .. eof;
635 if ($in_header) {
f343f960 636 # do something
df5f8116 637 } else { # in body
f343f960 638 # do something else
df5f8116 639 }
5a964f20 640 } continue {
df5f8116 641 close ARGV if eof; # reset $. each file
5a964f20
TC
642 }
643
acf31ca5
SF
644Here's a simple example to illustrate the difference between
645the two range operators:
646
647 @lines = (" - Foo",
648 "01 - Bar",
649 "1 - Baz",
650 " - Quux");
651
9f10b797
RGS
652 foreach (@lines) {
653 if (/0/ .. /1/) {
acf31ca5
SF
654 print "$_\n";
655 }
656 }
657
9f10b797
RGS
658This program will print only the line containing "Bar". If
659the range operator is changed to C<...>, it will also print the
acf31ca5
SF
660"Baz" line.
661
662And now some examples as a list operator:
a0d0e21e
LW
663
664 for (101 .. 200) { print; } # print $_ 100 times
3e3baf6d 665 @foo = @foo[0 .. $#foo]; # an expensive no-op
a0d0e21e
LW
666 @foo = @foo[$#foo-4 .. $#foo]; # slice last 5 items
667
5a964f20 668The range operator (in list context) makes use of the magical
5f05dabc 669auto-increment algorithm if the operands are strings. You
a0d0e21e
LW
670can say
671
c543c01b 672 @alphabet = ("A" .. "Z");
a0d0e21e 673
54ae734e 674to get all normal letters of the English alphabet, or
a0d0e21e 675
c543c01b 676 $hexdigit = (0 .. 9, "a" .. "f")[$num & 15];
a0d0e21e
LW
677
678to get a hexadecimal digit, or
679
c543c01b 680 @z2 = ("01" .. "31"); print $z2[$mday];
a0d0e21e 681
ea4f5703
YST
682to get dates with leading zeros.
683
684If the final value specified is not in the sequence that the magical
685increment would produce, the sequence goes until the next value would
686be longer than the final value specified.
687
688If the initial value specified isn't part of a magical increment
c543c01b 689sequence (that is, a non-empty string matching C</^[a-zA-Z]*[0-9]*\z/>),
ea4f5703
YST
690only the initial value will be returned. So the following will only
691return an alpha:
692
c543c01b 693 use charnames "greek";
ea4f5703
YST
694 my @greek_small = ("\N{alpha}" .. "\N{omega}");
695
c543c01b
TC
696To get the 25 traditional lowercase Greek letters, including both sigmas,
697you could use this instead:
ea4f5703 698
c543c01b
TC
699 use charnames "greek";
700 my @greek_small = map { chr }
701 ord "\N{alpha}" .. ord "\N{omega}";
702
703However, because there are I<many> other lowercase Greek characters than
704just those, to match lowercase Greek characters in a regular expression,
705you would use the pattern C</(?:(?=\p{Greek})\p{Lower})+/>.
a0d0e21e 706
df5f8116
CW
707Because each operand is evaluated in integer form, C<2.18 .. 3.14> will
708return two elements in list context.
709
710 @list = (2.18 .. 3.14); # same as @list = (2 .. 3);
711
a0d0e21e 712=head2 Conditional Operator
d74e8afc 713X<operator, conditional> X<operator, ternary> X<ternary> X<?:>
a0d0e21e
LW
714
715Ternary "?:" is the conditional operator, just as in C. It works much
716like an if-then-else. If the argument before the ? is true, the
717argument before the : is returned, otherwise the argument after the :
cb1a09d0
AD
718is returned. For example:
719
54310121 720 printf "I have %d dog%s.\n", $n,
c543c01b 721 ($n == 1) ? "" : "s";
cb1a09d0
AD
722
723Scalar or list context propagates downward into the 2nd
54310121 724or 3rd argument, whichever is selected.
cb1a09d0
AD
725
726 $a = $ok ? $b : $c; # get a scalar
727 @a = $ok ? @b : @c; # get an array
728 $a = $ok ? @b : @c; # oops, that's just a count!
729
730The operator may be assigned to if both the 2nd and 3rd arguments are
731legal lvalues (meaning that you can assign to them):
a0d0e21e
LW
732
733 ($a_or_b ? $a : $b) = $c;
734
5a964f20
TC
735Because this operator produces an assignable result, using assignments
736without parentheses will get you in trouble. For example, this:
737
738 $a % 2 ? $a += 10 : $a += 2
739
740Really means this:
741
742 (($a % 2) ? ($a += 10) : $a) += 2
743
744Rather than this:
745
746 ($a % 2) ? ($a += 10) : ($a += 2)
747
19799a22
GS
748That should probably be written more simply as:
749
750 $a += ($a % 2) ? 10 : 2;
751
4633a7c4 752=head2 Assignment Operators
d74e8afc 753X<assignment> X<operator, assignment> X<=> X<**=> X<+=> X<*=> X<&=>
5ac3b81c 754X<<< <<= >>> X<&&=> X<-=> X</=> X<|=> X<<< >>= >>> X<||=> X<//=> X<.=>
d74e8afc 755X<%=> X<^=> X<x=>
a0d0e21e
LW
756
757"=" is the ordinary assignment operator.
758
759Assignment operators work as in C. That is,
760
761 $a += 2;
762
763is equivalent to
764
765 $a = $a + 2;
766
767although without duplicating any side effects that dereferencing the lvalue
54310121 768might trigger, such as from tie(). Other assignment operators work similarly.
769The following are recognized:
a0d0e21e
LW
770
771 **= += *= &= <<= &&=
9f10b797
RGS
772 -= /= |= >>= ||=
773 .= %= ^= //=
774 x=
a0d0e21e 775
19799a22 776Although these are grouped by family, they all have the precedence
a0d0e21e
LW
777of assignment.
778
b350dd2f
GS
779Unlike in C, the scalar assignment operator produces a valid lvalue.
780Modifying an assignment is equivalent to doing the assignment and
781then modifying the variable that was assigned to. This is useful
782for modifying a copy of something, like this:
a0d0e21e 783
c543c01b 784 ($tmp = $global) =~ tr [0-9] [a-j];
a0d0e21e
LW
785
786Likewise,
787
788 ($a += 2) *= 3;
789
790is equivalent to
791
792 $a += 2;
793 $a *= 3;
794
b350dd2f
GS
795Similarly, a list assignment in list context produces the list of
796lvalues assigned to, and a list assignment in scalar context returns
797the number of elements produced by the expression on the right hand
798side of the assignment.
799
c543c01b
TC
800=head2 The Triple-Dot Operator
801X<...> X<... operator> X<yada-yada operator> X<whatever operator>
802X<triple-dot operator>
803
804The triple-dot operator, C<...>, sometimes called the "whatever operator", the
805"yada-yada operator", or the "I<et cetera>" operator, is a placeholder for
806code. Perl parses it without error, but when you try to execute a whatever,
807it throws an exception with the text C<Unimplemented>:
808
809 sub unimplemented { ... }
810
811 eval { unimplemented() };
812 if ($@ eq "Unimplemented" ) {
813 say "Oh look, an exception--whatever.";
814 }
815
816You can only use the triple-dot operator to stand in for a complete statement.
817These examples of the triple-dot work:
818
819 { ... }
820
821 sub foo { ... }
822
823 ...;
824
825 eval { ... };
826
827 sub foo {
828 my ($self) = shift;
829 ...;
830 }
831
832 do {
833 my $variable;
834 ...;
835 say "Hurrah!";
836 } while $cheering;
837
838The yada-yada--or whatever--cannot stand in for an expression that is
839part of a larger statement since the C<...> is also the three-dot version
840of the binary range operator (see L<Range Operators>). These examples of
841the whatever operator are still syntax errors:
842
843 print ...;
844
845 open(PASSWD, ">", "/dev/passwd") or ...;
846
847 if ($condition && ...) { say "Hello" }
848
849There are some cases where Perl can't immediately tell the difference
850between an expression and a statement. For instance, the syntax for a
851block and an anonymous hash reference constructor look the same unless
852there's something in the braces that give Perl a hint. The whatever
853is a syntax error if Perl doesn't guess that the C<{ ... }> is a
854block. In that case, it doesn't think the C<...> is the whatever
855because it's expecting an expression instead of a statement:
856
857 my @transformed = map { ... } @input; # syntax error
858
859You can use a C<;> inside your block to denote that the C<{ ... }> is
860a block and not a hash reference constructor. Now the whatever works:
861
862 my @transformed = map {; ... } @input; # ; disambiguates
863
864 my @transformed = map { ...; } @input; # ; disambiguates
865
748a9306 866=head2 Comma Operator
d74e8afc 867X<comma> X<operator, comma> X<,>
a0d0e21e 868
5a964f20 869Binary "," is the comma operator. In scalar context it evaluates
a0d0e21e
LW
870its left argument, throws that value away, then evaluates its right
871argument and returns that value. This is just like C's comma operator.
872
5a964f20 873In list context, it's just the list argument separator, and inserts
ed5c6d31
PJ
874both its arguments into the list. These arguments are also evaluated
875from left to right.
a0d0e21e 876
4e1988c6
FC
877The C<< => >> operator is a synonym for the comma except that it causes a
878word on its left to be interpreted as a string if it begins with a letter
344f2c40
IG
879or underscore and is composed only of letters, digits and underscores.
880This includes operands that might otherwise be interpreted as operators,
881constants, single number v-strings or function calls. If in doubt about
c543c01b 882this behavior, the left operand can be quoted explicitly.
344f2c40
IG
883
884Otherwise, the C<< => >> operator behaves exactly as the comma operator
885or list argument separator, according to context.
886
887For example:
a44e5664
MS
888
889 use constant FOO => "something";
890
891 my %h = ( FOO => 23 );
892
893is equivalent to:
894
895 my %h = ("FOO", 23);
896
897It is I<NOT>:
898
899 my %h = ("something", 23);
900
719b43e8
RGS
901The C<< => >> operator is helpful in documenting the correspondence
902between keys and values in hashes, and other paired elements in lists.
748a9306 903
a12b8f3c
FC
904 %hash = ( $key => $value );
905 login( $username => $password );
a44e5664 906
4e1988c6
FC
907The special quoting behavior ignores precedence, and hence may apply to
908I<part> of the left operand:
909
910 print time.shift => "bbb";
911
912That example prints something like "1314363215shiftbbb", because the
913C<< => >> implicitly quotes the C<shift> immediately on its left, ignoring
914the fact that C<time.shift> is the entire left operand.
915
a0d0e21e 916=head2 List Operators (Rightward)
d74e8afc 917X<operator, list, rightward> X<list operator>
a0d0e21e 918
c543c01b 919On the right side of a list operator, the comma has very low precedence,
a0d0e21e
LW
920such that it controls all comma-separated expressions found there.
921The only operators with lower precedence are the logical operators
922"and", "or", and "not", which may be used to evaluate calls to list
923operators without the need for extra parentheses:
924
c543c01b
TC
925 open HANDLE, "< $file"
926 or die "Can't open $file: $!\n";
a0d0e21e 927
5ba421f6 928See also discussion of list operators in L<Terms and List Operators (Leftward)>.
a0d0e21e
LW
929
930=head2 Logical Not
d74e8afc 931X<operator, logical, not> X<not>
a0d0e21e
LW
932
933Unary "not" returns the logical negation of the expression to its right.
934It's the equivalent of "!" except for the very low precedence.
935
936=head2 Logical And
d74e8afc 937X<operator, logical, and> X<and>
a0d0e21e
LW
938
939Binary "and" returns the logical conjunction of the two surrounding
c543c01b
TC
940expressions. It's equivalent to C<&&> except for the very low
941precedence. This means that it short-circuits: the right
a0d0e21e
LW
942expression is evaluated only if the left expression is true.
943
c963b151 944=head2 Logical or, Defined or, and Exclusive Or
f23102e2 945X<operator, logical, or> X<operator, logical, xor>
d74e8afc 946X<operator, logical, defined or> X<operator, logical, exclusive or>
f23102e2 947X<or> X<xor>
a0d0e21e
LW
948
949Binary "or" returns the logical disjunction of the two surrounding
c543c01b
TC
950expressions. It's equivalent to C<||> except for the very low precedence.
951This makes it useful for control flow:
5a964f20
TC
952
953 print FH $data or die "Can't write to FH: $!";
954
c543c01b
TC
955This means that it short-circuits: the right expression is evaluated
956only if the left expression is false. Due to its precedence, you must
957be careful to avoid using it as replacement for the C<||> operator.
958It usually works out better for flow control than in assignments:
5a964f20
TC
959
960 $a = $b or $c; # bug: this is wrong
961 ($a = $b) or $c; # really means this
962 $a = $b || $c; # better written this way
963
19799a22 964However, when it's a list-context assignment and you're trying to use
c543c01b 965C<||> for control flow, you probably need "or" so that the assignment
5a964f20
TC
966takes higher precedence.
967
968 @info = stat($file) || die; # oops, scalar sense of stat!
969 @info = stat($file) or die; # better, now @info gets its due
970
c963b151
BD
971Then again, you could always use parentheses.
972
a0d0e21e 973Binary "xor" returns the exclusive-OR of the two surrounding expressions.
c543c01b 974It cannot short-circuit (of course).
a0d0e21e
LW
975
976=head2 C Operators Missing From Perl
d74e8afc
ITB
977X<operator, missing from perl> X<&> X<*>
978X<typecasting> X<(TYPE)>
a0d0e21e
LW
979
980Here is what C has that Perl doesn't:
981
982=over 8
983
984=item unary &
985
986Address-of operator. (But see the "\" operator for taking a reference.)
987
988=item unary *
989
54310121 990Dereference-address operator. (Perl's prefix dereferencing
a0d0e21e
LW
991operators are typed: $, @, %, and &.)
992
993=item (TYPE)
994
19799a22 995Type-casting operator.
a0d0e21e
LW
996
997=back
998
5f05dabc 999=head2 Quote and Quote-like Operators
89d205f2 1000X<operator, quote> X<operator, quote-like> X<q> X<qq> X<qx> X<qw> X<m>
d74e8afc
ITB
1001X<qr> X<s> X<tr> X<'> X<''> X<"> X<""> X<//> X<`> X<``> X<<< << >>>
1002X<escape sequence> X<escape>
1003
a0d0e21e
LW
1004While we usually think of quotes as literal values, in Perl they
1005function as operators, providing various kinds of interpolating and
1006pattern matching capabilities. Perl provides customary quote characters
1007for these behaviors, but also provides a way for you to choose your
1008quote character for any of them. In the following table, a C<{}> represents
9f10b797 1009any pair of delimiters you choose.
a0d0e21e 1010
2c268ad5
TP
1011 Customary Generic Meaning Interpolates
1012 '' q{} Literal no
1013 "" qq{} Literal yes
af9219ee 1014 `` qx{} Command yes*
2c268ad5 1015 qw{} Word list no
af9219ee
MG
1016 // m{} Pattern match yes*
1017 qr{} Pattern yes*
1018 s{}{} Substitution yes*
2c268ad5 1019 tr{}{} Transliteration no (but see below)
c543c01b 1020 y{}{} Transliteration no (but see below)
7e3b091d 1021 <<EOF here-doc yes*
a0d0e21e 1022
af9219ee
MG
1023 * unless the delimiter is ''.
1024
87275199 1025Non-bracketing delimiters use the same character fore and aft, but the four
c543c01b 1026sorts of ASCII brackets (round, angle, square, curly) all nest, which means
9f10b797 1027that
87275199 1028
c543c01b 1029 q{foo{bar}baz}
35f2feb0 1030
9f10b797 1031is the same as
87275199 1032
c543c01b 1033 'foo{bar}baz'
87275199
GS
1034
1035Note, however, that this does not always work for quoting Perl code:
1036
c543c01b 1037 $s = q{ if($a eq "}") ... }; # WRONG
87275199 1038
c543c01b
TC
1039is a syntax error. The C<Text::Balanced> module (standard as of v5.8,
1040and from CPAN before then) is able to do this properly.
87275199 1041
19799a22 1042There can be whitespace between the operator and the quoting
fb73857a 1043characters, except when C<#> is being used as the quoting character.
19799a22
GS
1044C<q#foo#> is parsed as the string C<foo>, while C<q #foo#> is the
1045operator C<q> followed by a comment. Its argument will be taken
1046from the next line. This allows you to write:
fb73857a 1047
1048 s {foo} # Replace foo
1049 {bar} # with bar.
1050
c543c01b
TC
1051The following escape sequences are available in constructs that interpolate,
1052and in transliterations:
5691ca5f 1053X<\t> X<\n> X<\r> X<\f> X<\b> X<\a> X<\e> X<\x> X<\0> X<\c> X<\N> X<\N{}>
04341565 1054X<\o{}>
5691ca5f 1055
2c4c1ff2
KW
1056 Sequence Note Description
1057 \t tab (HT, TAB)
1058 \n newline (NL)
1059 \r return (CR)
1060 \f form feed (FF)
1061 \b backspace (BS)
1062 \a alarm (bell) (BEL)
1063 \e escape (ESC)
c543c01b 1064 \x{263A} [1,8] hex char (example: SMILEY)
2c4c1ff2 1065 \x1b [2,8] restricted range hex char (example: ESC)
fb121860 1066 \N{name} [3] named Unicode character or character sequence
2c4c1ff2
KW
1067 \N{U+263D} [4,8] Unicode character (example: FIRST QUARTER MOON)
1068 \c[ [5] control char (example: chr(27))
1069 \o{23072} [6,8] octal char (example: SMILEY)
1070 \033 [7,8] restricted range octal char (example: ESC)
5691ca5f
KW
1071
1072=over 4
1073
1074=item [1]
1075
2c4c1ff2
KW
1076The result is the character specified by the hexadecimal number between
1077the braces. See L</[8]> below for details on which character.
96448467
DG
1078
1079Only hexadecimal digits are valid between the braces. If an invalid
1080character is encountered, a warning will be issued and the invalid
1081character and all subsequent characters (valid or invalid) within the
1082braces will be discarded.
1083
1084If there are no valid digits between the braces, the generated character is
1085the NULL character (C<\x{00}>). However, an explicit empty brace (C<\x{}>)
c543c01b 1086will not cause a warning (currently).
40687185
KW
1087
1088=item [2]
1089
2c4c1ff2
KW
1090The result is the character specified by the hexadecimal number in the range
10910x00 to 0xFF. See L</[8]> below for details on which character.
96448467
DG
1092
1093Only hexadecimal digits are valid following C<\x>. When C<\x> is followed
2c4c1ff2 1094by fewer than two valid digits, any valid digits will be zero-padded. This
c543c01b 1095means that C<\x7> will be interpreted as C<\x07>, and a lone <\x> will be
2c4c1ff2 1096interpreted as C<\x00>. Except at the end of a string, having fewer than
c543c01b 1097two valid digits will result in a warning. Note that although the warning
96448467
DG
1098says the illegal character is ignored, it is only ignored as part of the
1099escape and will still be used as the subsequent character in the string.
1100For example:
1101
1102 Original Result Warns?
1103 "\x7" "\x07" no
1104 "\x" "\x00" no
1105 "\x7q" "\x07q" yes
1106 "\xq" "\x00q" yes
1107
40687185
KW
1108=item [3]
1109
fb121860 1110The result is the Unicode character or character sequence given by I<name>.
2c4c1ff2 1111See L<charnames>.
40687185
KW
1112
1113=item [4]
1114
2c4c1ff2
KW
1115C<\N{U+I<hexadecimal number>}> means the Unicode character whose Unicode code
1116point is I<hexadecimal number>.
40687185
KW
1117
1118=item [5]
1119
5691ca5f
KW
1120The character following C<\c> is mapped to some other character as shown in the
1121table:
1122
1123 Sequence Value
1124 \c@ chr(0)
1125 \cA chr(1)
1126 \ca chr(1)
1127 \cB chr(2)
1128 \cb chr(2)
1129 ...
1130 \cZ chr(26)
1131 \cz chr(26)
1132 \c[ chr(27)
1133 \c] chr(29)
1134 \c^ chr(30)
1135 \c? chr(127)
1136
d813941f
KW
1137In other words, it's the character whose code point has had 64 xor'd with
1138its uppercase. C<\c?> is DELETE because C<ord("@") ^ 64> is 127, and
1139C<\c@> is NULL because the ord of "@" is 64, so xor'ing 64 itself produces 0.
1140
5691ca5f
KW
1141Also, C<\c\I<X>> yields C< chr(28) . "I<X>"> for any I<X>, but cannot come at the
1142end of a string, because the backslash would be parsed as escaping the end
1143quote.
1144
1145On ASCII platforms, the resulting characters from the list above are the
1146complete set of ASCII controls. This isn't the case on EBCDIC platforms; see
1147L<perlebcdic/OPERATOR DIFFERENCES> for the complete list of what these
1148sequences mean on both ASCII and EBCDIC platforms.
1149
1150Use of any other character following the "c" besides those listed above is
17a3df4c
KW
1151discouraged, and some are deprecated with the intention of removing
1152those in Perl 5.16. What happens for any of these
d813941f
KW
1153other characters currently though, is that the value is derived by xor'ing
1154with the seventh bit, which is 64.
5691ca5f
KW
1155
1156To get platform independent controls, you can use C<\N{...}>.
1157
40687185
KW
1158=item [6]
1159
2c4c1ff2
KW
1160The result is the character specified by the octal number between the braces.
1161See L</[8]> below for details on which character.
04341565
DG
1162
1163If a character that isn't an octal digit is encountered, a warning is raised,
1164and the value is based on the octal digits before it, discarding it and all
1165following characters up to the closing brace. It is a fatal error if there are
1166no octal digits at all.
1167
1168=item [7]
1169
c543c01b 1170The result is the character specified by the three-digit octal number in the
2c4c1ff2
KW
1171range 000 to 777 (but best to not use above 077, see next paragraph). See
1172L</[8]> below for details on which character.
1173
1174Some contexts allow 2 or even 1 digit, but any usage without exactly
40687185 1175three digits, the first being a zero, may give unintended results. (For
5db3e519
FC
1176example, in a regular expression it may be confused with a backreference;
1177see L<perlrebackslash/Octal escapes>.) Starting in Perl 5.14, you may
c543c01b 1178use C<\o{}> instead, which avoids all these problems. Otherwise, it is best to
04341565
DG
1179use this construct only for ordinals C<\077> and below, remembering to pad to
1180the left with zeros to make three digits. For larger ordinals, either use
d90d5a38 1181C<\o{}> , or convert to something else, such as to hex and use C<\x{}>
04341565 1182instead.
40687185 1183
40687185
KW
1184Having fewer than 3 digits may lead to a misleading warning message that says
1185that what follows is ignored. For example, C<"\128"> in the ASCII character set
1186is equivalent to the two characters C<"\n8">, but the warning C<Illegal octal
5db3e519
FC
1187digit '8' ignored> will be thrown. If C<"\n8"> is what you want, you can
1188avoid this warning by padding your octal number with C<0>'s: C<"\0128">.
5691ca5f 1189
2c4c1ff2
KW
1190=item [8]
1191
c543c01b 1192Several constructs above specify a character by a number. That number
2c4c1ff2 1193gives the character's position in the character set encoding (indexed from 0).
c543c01b 1194This is called synonymously its ordinal, code position, or code point. Perl
2c4c1ff2
KW
1195works on platforms that have a native encoding currently of either ASCII/Latin1
1196or EBCDIC, each of which allow specification of 256 characters. In general, if
1197the number is 255 (0xFF, 0377) or below, Perl interprets this in the platform's
1198native encoding. If the number is 256 (0x100, 0400) or above, Perl interprets
c543c01b 1199it as a Unicode code point and the result is the corresponding Unicode
2c4c1ff2
KW
1200character. For example C<\x{50}> and C<\o{120}> both are the number 80 in
1201decimal, which is less than 256, so the number is interpreted in the native
1202character set encoding. In ASCII the character in the 80th position (indexed
1203from 0) is the letter "P", and in EBCDIC it is the ampersand symbol "&".
1204C<\x{100}> and C<\o{400}> are both 256 in decimal, so the number is interpreted
1205as a Unicode code point no matter what the native encoding is. The name of the
1206character in the 100th position (indexed by 0) in Unicode is
1207C<LATIN CAPITAL LETTER A WITH MACRON>.
1208
1209There are a couple of exceptions to the above rule. C<\N{U+I<hex number>}> is
1210always interpreted as a Unicode code point, so that C<\N{U+0050}> is "P" even
1211on EBCDIC platforms. And if L<C<S<use encoding>>|encoding> is in effect, the
1212number is considered to be in that encoding, and is translated from that into
1213the platform's native encoding if there is a corresponding native character;
1214otherwise to Unicode.
1215
5691ca5f 1216=back
4c77eaa2 1217
e526e8bb
KW
1218B<NOTE>: Unlike C and other languages, Perl has no C<\v> escape sequence for
1219the vertical tab (VT - ASCII 11), but you may use C<\ck> or C<\x0b>. (C<\v>
1220does have meaning in regular expression patterns in Perl, see L<perlre>.)
1221
1222The following escape sequences are available in constructs that interpolate,
904501ec 1223but not in transliterations.
d74e8afc 1224X<\l> X<\u> X<\L> X<\U> X<\E> X<\Q>
904501ec 1225
c543c01b
TC
1226 \l lowercase next character only
1227 \u titlecase (not uppercase!) next character only
1228 \L lowercase all characters till \E seen
1229 \U uppercase all characters till \E seen
1d2dff63 1230 \Q quote non-word characters till \E
7e31b643 1231 \E end either case modification or quoted section
c543c01b
TC
1232 (whichever was last seen)
1233
1234C<\L>, C<\U>, and C<\Q> can stack, in which case you need one
1235C<\E> for each. For example:
1236
1237 say "This \Qquoting \ubusiness \Uhere isn't quite\E done yet,\E is it?";
1238 This quoting\ Business\ HERE\ ISN\'T\ QUITE\ done\ yet\, is it?
a0d0e21e 1239
95cc3e0c 1240If C<use locale> is in effect, the case map used by C<\l>, C<\L>,
c543c01b 1241C<\u>, and C<\U> is taken from the current locale. See L<perllocale>.
b6538e4f 1242If Unicode (for example, C<\N{}> or code points of 0x100 or
c543c01b
TC
1243beyond) is being used, the case map used by C<\l>, C<\L>, C<\u>, and
1244C<\U> is as defined by Unicode. That means that case-mapping
1245a single character can sometimes produce several characters.
a034a98d 1246
5a964f20
TC
1247All systems use the virtual C<"\n"> to represent a line terminator,
1248called a "newline". There is no such thing as an unvarying, physical
19799a22 1249newline character. It is only an illusion that the operating system,
5a964f20
TC
1250device drivers, C libraries, and Perl all conspire to preserve. Not all
1251systems read C<"\r"> as ASCII CR and C<"\n"> as ASCII LF. For example,
c543c01b
TC
1252on the ancient Macs (pre-MacOS X) of yesteryear, these used to be reversed,
1253and on systems without line terminator,
1254printing C<"\n"> might emit no actual data. In general, use C<"\n"> when
5a964f20
TC
1255you mean a "newline" for your system, but use the literal ASCII when you
1256need an exact character. For example, most networking protocols expect
2a380090 1257and prefer a CR+LF (C<"\015\012"> or C<"\cM\cJ">) for line terminators,
5a964f20
TC
1258and although they often accept just C<"\012">, they seldom tolerate just
1259C<"\015">. If you get in the habit of using C<"\n"> for networking,
1260you may be burned some day.
d74e8afc
ITB
1261X<newline> X<line terminator> X<eol> X<end of line>
1262X<\n> X<\r> X<\r\n>
5a964f20 1263
904501ec
MG
1264For constructs that do interpolate, variables beginning with "C<$>"
1265or "C<@>" are interpolated. Subscripted variables such as C<$a[3]> or
ad0f383a
A
1266C<< $href->{key}[0] >> are also interpolated, as are array and hash slices.
1267But method calls such as C<< $obj->meth >> are not.
af9219ee
MG
1268
1269Interpolating an array or slice interpolates the elements in order,
1270separated by the value of C<$">, so is equivalent to interpolating
c543c01b
TC
1271C<join $", @array>. "Punctuation" arrays such as C<@*> are usually
1272interpolated only if the name is enclosed in braces C<@{*}>, but the
1273arrays C<@_>, C<@+>, and C<@-> are interpolated even without braces.
af9219ee 1274
bc7b91c6
EB
1275For double-quoted strings, the quoting from C<\Q> is applied after
1276interpolation and escapes are processed.
1277
1278 "abc\Qfoo\tbar$s\Exyz"
1279
1280is equivalent to
1281
1282 "abc" . quotemeta("foo\tbar$s") . "xyz"
1283
1284For the pattern of regex operators (C<qr//>, C<m//> and C<s///>),
1285the quoting from C<\Q> is applied after interpolation is processed,
1286but before escapes are processed. This allows the pattern to match
1287literally (except for C<$> and C<@>). For example, the following matches:
1288
1289 '\s\t' =~ /\Q\s\t/
1290
1291Because C<$> or C<@> trigger interpolation, you'll need to use something
1292like C</\Quser\E\@\Qhost/> to match them literally.
1d2dff63 1293
a0d0e21e
LW
1294Patterns are subject to an additional level of interpretation as a
1295regular expression. This is done as a second pass, after variables are
1296interpolated, so that regular expressions may be incorporated into the
1297pattern from the variables. If this is not what you want, use C<\Q> to
1298interpolate a variable literally.
1299
19799a22
GS
1300Apart from the behavior described above, Perl does not expand
1301multiple levels of interpolation. In particular, contrary to the
1302expectations of shell programmers, back-quotes do I<NOT> interpolate
1303within double quotes, nor do single quotes impede evaluation of
1304variables when used within double quotes.
a0d0e21e 1305
5f05dabc 1306=head2 Regexp Quote-Like Operators
d74e8afc 1307X<operator, regexp>
cb1a09d0 1308
5f05dabc 1309Here are the quote-like operators that apply to pattern
cb1a09d0
AD
1310matching and related activities.
1311
a0d0e21e
LW
1312=over 8
1313
b6fa137b 1314=item qr/STRING/msixpodual
01c6f5f4 1315X<qr> X</i> X</m> X</o> X</s> X</x> X</p>
a0d0e21e 1316
87e95b7f
YO
1317This operator quotes (and possibly compiles) its I<STRING> as a regular
1318expression. I<STRING> is interpolated the same way as I<PATTERN>
1319in C<m/PATTERN/>. If "'" is used as the delimiter, no interpolation
1320is done. Returns a Perl value which may be used instead of the
f6050459 1321corresponding C</STRING/msixpodual> expression. The returned value is a
85dd5c8b 1322normalized version of the original pattern. It magically differs from
1c8ee595
CO
1323a string containing the same characters: C<ref(qr/x/)> returns "Regexp";
1324however, dereferencing it is not well defined (you currently get the
1325normalized version of the original pattern, but this may change).
1326
a0d0e21e 1327
87e95b7f
YO
1328For example,
1329
1330 $rex = qr/my.STRING/is;
85dd5c8b 1331 print $rex; # prints (?si-xm:my.STRING)
87e95b7f
YO
1332 s/$rex/foo/;
1333
1334is equivalent to
1335
1336 s/my.STRING/foo/is;
1337
1338The result may be used as a subpattern in a match:
1339
1340 $re = qr/$pattern/;
1341 $string =~ /foo${re}bar/; # can be interpolated in other patterns
1342 $string =~ $re; # or used standalone
1343 $string =~ /$re/; # or this way
1344
f6050459 1345Since Perl may compile the pattern at the moment of execution of the qr()
87e95b7f
YO
1346operator, using qr() may have speed advantages in some situations,
1347notably if the result of qr() is used standalone:
1348
1349 sub match {
1350 my $patterns = shift;
1351 my @compiled = map qr/$_/i, @$patterns;
1352 grep {
1353 my $success = 0;
1354 foreach my $pat (@compiled) {
1355 $success = 1, last if /$pat/;
1356 }
1357 $success;
1358 } @_;
5a964f20
TC
1359 }
1360
87e95b7f
YO
1361Precompilation of the pattern into an internal representation at
1362the moment of qr() avoids a need to recompile the pattern every
1363time a match C</$pat/> is attempted. (Perl has many other internal
1364optimizations, but none would be triggered in the above example if
1365we did not use qr() operator.)
1366
765fa144 1367Options (specified by the following modifiers) are:
87e95b7f
YO
1368
1369 m Treat string as multiple lines.
1370 s Treat string as single line. (Make . match a newline)
1371 i Do case-insensitive pattern matching.
1372 x Use extended regular expressions.
1373 p When matching preserve a copy of the matched string so
1374 that ${^PREMATCH}, ${^MATCH}, ${^POSTMATCH} will be defined.
1375 o Compile pattern only once.
b5c53fdc
KW
1376 a ASCII-restrict: Use ASCII for \d, \s, \w; specifying two a's
1377 further restricts /i matching so that no ASCII character will
1378 match a non-ASCII one
18509dec
KW
1379 l Use the locale
1380 u Use Unicode rules
b6fa137b 1381 d Use Unicode or native charset, as in 5.12 and earlier
87e95b7f
YO
1382
1383If a precompiled pattern is embedded in a larger pattern then the effect
c543c01b 1384of "msixpluad" will be propagated appropriately. The effect the "o"
87e95b7f
YO
1385modifier has is not propagated, being restricted to those patterns
1386explicitly using it.
1387
b6fa137b 1388The last four modifiers listed above, added in Perl 5.14,
18509dec
KW
1389control the character set semantics, but C</a> is the only one you are likely
1390to want to specify explicitly; the other three are selected
1391automatically by various pragmas.
da392a17 1392
87e95b7f 1393See L<perlre> for additional information on valid syntax for STRING, and
5e2aa8f5 1394for a detailed look at the semantics of regular expressions. In
f6050459
KW
1395particular, all the modifiers execpt C</o> are further explained in
1396L<perlre/Modifiers>. C</o> is described in the next section.
a0d0e21e 1397
b6fa137b 1398=item m/PATTERN/msixpodualgc
89d205f2
YO
1399X<m> X<operator, match>
1400X<regexp, options> X<regexp> X<regex, options> X<regex>
01c6f5f4 1401X</m> X</s> X</i> X</x> X</p> X</o> X</g> X</c>
a0d0e21e 1402
b6fa137b 1403=item /PATTERN/msixpodualgc
a0d0e21e 1404
5a964f20 1405Searches a string for a pattern match, and in scalar context returns
19799a22
GS
1406true if it succeeds, false if it fails. If no string is specified
1407via the C<=~> or C<!~> operator, the $_ string is searched. (The
1408string specified with C<=~> need not be an lvalue--it may be the
1409result of an expression evaluation, but remember the C<=~> binds
006671a6 1410rather tightly.) See also L<perlre>.
a0d0e21e 1411
f6050459 1412Options are as described in C<qr//> above; in addition, the following match
01c6f5f4 1413process modifiers are available:
a0d0e21e 1414
950b09ed
KW
1415 g Match globally, i.e., find all occurrences.
1416 c Do not reset search position on a failed match when /g is in effect.
a0d0e21e 1417
725a61d7 1418If "/" is the delimiter then the initial C<m> is optional. With the C<m>
c543c01b 1419you can use any pair of non-whitespace (ASCII) characters
725a61d7
Z
1420as delimiters. This is particularly useful for matching path names
1421that contain "/", to avoid LTS (leaning toothpick syndrome). If "?" is
1422the delimiter, then a match-only-once rule applies,
1423described in C<m?PATTERN?> below.
19799a22 1424If "'" is the delimiter, no interpolation is performed on the PATTERN.
ed02a3bf
DN
1425When using a character valid in an identifier, whitespace is required
1426after the C<m>.
a0d0e21e 1427
532c9e80
KW
1428PATTERN may contain variables, which will be interpolated
1429every time the pattern search is evaluated, except
1f247705
GS
1430for when the delimiter is a single quote. (Note that C<$(>, C<$)>, and
1431C<$|> are not interpolated because they look like end-of-string tests.)
532c9e80
KW
1432Perl will not recompile the pattern unless an interpolated
1433variable that it contains changes. You can force Perl to skip the
1434test and never recompile by adding a C</o> (which stands for "once")
1435after the trailing delimiter.
1436Once upon a time, Perl would recompile regular expressions
1437unnecessarily, and this modifier was useful to tell it not to do so, in the
1438interests of speed. But now, the only reasons to use C</o> are either:
1439
1440=over
1441
1442=item 1
1443
1444The variables are thousands of characters long and you know that they
1445don't change, and you need to wring out the last little bit of speed by
1446having Perl skip testing for that. (There is a maintenance penalty for
1447doing this, as mentioning C</o> constitutes a promise that you won't
18509dec 1448change the variables in the pattern. If you do change them, Perl won't
532c9e80
KW
1449even notice.)
1450
1451=item 2
1452
1453you want the pattern to use the initial values of the variables
1454regardless of whether they change or not. (But there are saner ways
1455of accomplishing this than using C</o>.)
1456
1457=back
a0d0e21e 1458
18509dec
KW
1459The bottom line is that using C</o> is almost never a good idea.
1460
e9d89077
DN
1461=item The empty pattern //
1462
5a964f20 1463If the PATTERN evaluates to the empty string, the last
d65afb4b 1464I<successfully> matched regular expression is used instead. In this
c543c01b 1465case, only the C<g> and C<c> flags on the empty pattern are honored;
d65afb4b
HS
1466the other flags are taken from the original pattern. If no match has
1467previously succeeded, this will (silently) act instead as a genuine
1468empty pattern (which will always match).
a0d0e21e 1469
89d205f2
YO
1470Note that it's possible to confuse Perl into thinking C<//> (the empty
1471regex) is really C<//> (the defined-or operator). Perl is usually pretty
1472good about this, but some pathological cases might trigger this, such as
1473C<$a///> (is that C<($a) / (//)> or C<$a // />?) and C<print $fh //>
1474(C<print $fh(//> or C<print($fh //>?). In all of these examples, Perl
1475will assume you meant defined-or. If you meant the empty regex, just
1476use parentheses or spaces to disambiguate, or even prefix the empty
c963b151
BD
1477regex with an C<m> (so C<//> becomes C<m//>).
1478
e9d89077
DN
1479=item Matching in list context
1480
19799a22 1481If the C</g> option is not used, C<m//> in list context returns a
a0d0e21e 1482list consisting of the subexpressions matched by the parentheses in the
f7e33566
GS
1483pattern, i.e., (C<$1>, C<$2>, C<$3>...). (Note that here C<$1> etc. are
1484also set, and that this differs from Perl 4's behavior.) When there are
1485no parentheses in the pattern, the return value is the list C<(1)> for
1486success. With or without parentheses, an empty list is returned upon
1487failure.
a0d0e21e
LW
1488
1489Examples:
1490
c543c01b
TC
1491 open(TTY, "+>/dev/tty")
1492 || die "can't access /dev/tty: $!";
1493
a0d0e21e
LW
1494 <TTY> =~ /^y/i && foo(); # do foo if desired
1495
1496 if (/Version: *([0-9.]*)/) { $version = $1; }
1497
1498 next if m#^/usr/spool/uucp#;
1499
1500 # poor man's grep
1501 $arg = shift;
1502 while (<>) {
c543c01b 1503 print if /$arg/o; # compile only once (no longer needed!)
a0d0e21e
LW
1504 }
1505
1506 if (($F1, $F2, $Etc) = ($foo =~ /^(\S+)\s+(\S+)\s*(.*)/))
1507
1508This last example splits $foo into the first two words and the
5f05dabc 1509remainder of the line, and assigns those three fields to $F1, $F2, and
c543c01b
TC
1510$Etc. The conditional is true if any variables were assigned; that is,
1511if the pattern matched.
a0d0e21e 1512
19799a22 1513The C</g> modifier specifies global pattern matching--that is,
3dd93342 1514matching as many times as possible within the string. How it behaves
1515depends on the context. In list context, it returns a list of the
19799a22 1516substrings matched by any capturing parentheses in the regular
3dd93342 1517expression. If there are no parentheses, it returns a list of all
19799a22
GS
1518the matched strings, as if there were parentheses around the whole
1519pattern.
a0d0e21e 1520
7e86de3e 1521In scalar context, each execution of C<m//g> finds the next match,
19799a22 1522returning true if it matches, and false if there is no further match.
3dd93342 1523The position after the last match can be read or set using the C<pos()>
1524function; see L<perlfunc/pos>. A failed match normally resets the
7e86de3e 1525search position to the beginning of the string, but you can avoid that
3dd93342 1526by adding the C</c> modifier (e.g. C<m//gc>). Modifying the target
7e86de3e 1527string also resets the search position.
c90c0ff4 1528
e9d89077
DN
1529=item \G assertion
1530
c90c0ff4 1531You can intermix C<m//g> matches with C<m/\G.../g>, where C<\G> is a
3dd93342 1532zero-width assertion that matches the exact position where the
1533previous C<m//g>, if any, left off. Without the C</g> modifier, the
1534C<\G> assertion still anchors at C<pos()> as it was at the start of
1535the operation (see L<perlfunc/pos>), but the match is of course only
1536attempted once. Using C<\G> without C</g> on a target string that has
1537not previously had a C</g> match applied to it is the same as using
1538the C<\A> assertion to match the beginning of the string. Note also
1539that, currently, C<\G> is only properly supported when anchored at the
1540very beginning of the pattern.
c90c0ff4 1541
1542Examples:
a0d0e21e
LW
1543
1544 # list context
1545 ($one,$five,$fifteen) = (`uptime` =~ /(\d+\.\d+)/g);
1546
1547 # scalar context
c543c01b
TC
1548 local $/ = "";
1549 while ($paragraph = <>) {
1550 while ($paragraph =~ /\p{Ll}['")]*[.!?]+['")]*\s/g) {
19799a22 1551 $sentences++;
a0d0e21e
LW
1552 }
1553 }
c543c01b
TC
1554 say $sentences;
1555
1556Here's another way to check for sentences in a paragraph:
1557
1558 my $sentence_rx = qr{
1559 (?: (?<= ^ ) | (?<= \s ) ) # after start-of-string or whitespace
1560 \p{Lu} # capital letter
1561 .*? # a bunch of anything
1562 (?<= \S ) # that ends in non-whitespace
1563 (?<! \b [DMS]r ) # but isn't a common abbreviation
1564 (?<! \b Mrs )
1565 (?<! \b Sra )
1566 (?<! \b St )
1567 [.?!] # followed by a sentence ender
1568 (?= $ | \s ) # in front of end-of-string or whitespace
1569 }sx;
1570 local $/ = "";
1571 while (my $paragraph = <>) {
1572 say "NEW PARAGRAPH";
1573 my $count = 0;
1574 while ($paragraph =~ /($sentence_rx)/g) {
1575 printf "\tgot sentence %d: <%s>\n", ++$count, $1;
1576 }
1577 }
1578
1579Here's how to use C<m//gc> with C<\G>:
a0d0e21e 1580
137443ea 1581 $_ = "ppooqppqq";
44a8e56a 1582 while ($i++ < 2) {
1583 print "1: '";
c90c0ff4 1584 print $1 while /(o)/gc; print "', pos=", pos, "\n";
44a8e56a 1585 print "2: '";
c90c0ff4 1586 print $1 if /\G(q)/gc; print "', pos=", pos, "\n";
44a8e56a 1587 print "3: '";
c90c0ff4 1588 print $1 while /(p)/gc; print "', pos=", pos, "\n";
44a8e56a 1589 }
5d43e42d 1590 print "Final: '$1', pos=",pos,"\n" if /\G(.)/;
44a8e56a 1591
1592The last example should print:
1593
1594 1: 'oo', pos=4
137443ea 1595 2: 'q', pos=5
44a8e56a 1596 3: 'pp', pos=7
1597 1: '', pos=7
137443ea 1598 2: 'q', pos=8
1599 3: '', pos=8
5d43e42d
DC
1600 Final: 'q', pos=8
1601
1602Notice that the final match matched C<q> instead of C<p>, which a match
1603without the C<\G> anchor would have done. Also note that the final match
ac036724 1604did not update C<pos>. C<pos> is only updated on a C</g> match. If the
c543c01b
TC
1605final match did indeed match C<p>, it's a good bet that you're running a
1606very old (pre-5.6.0) version of Perl.
44a8e56a 1607
c90c0ff4 1608A useful idiom for C<lex>-like scanners is C</\G.../gc>. You can
e7ea3e70 1609combine several regexps like this to process a string part-by-part,
c90c0ff4 1610doing different actions depending on which regexp matched. Each
1611regexp tries to match where the previous one leaves off.
e7ea3e70 1612
3fe9a6f1 1613 $_ = <<'EOL';
950b09ed 1614 $url = URI::URL->new( "http://example.com/" ); die if $url eq "xXx";
3fe9a6f1 1615 EOL
c543c01b
TC
1616
1617 LOOP: {
950b09ed 1618 print(" digits"), redo LOOP if /\G\d+\b[,.;]?\s*/gc;
c543c01b
TC
1619 print(" lowercase"), redo LOOP if /\G\p{Ll}+\b[,.;]?\s*/gc;
1620 print(" UPPERCASE"), redo LOOP if /\G\p{Lu}+\b[,.;]?\s*/gc;
1621 print(" Capitalized"), redo LOOP if /\G\p{Lu}\p{Ll}+\b[,.;]?\s*/gc;
1622 print(" MiXeD"), redo LOOP if /\G\pL+\b[,.;]?\s*/gc;
1623 print(" alphanumeric"), redo LOOP if /\G[\p{Alpha}\pN]+\b[,.;]?\s*/gc;
1624 print(" line-noise"), redo LOOP if /\G\W+/gc;
950b09ed 1625 print ". That's all!\n";
c543c01b 1626 }
e7ea3e70
IZ
1627
1628Here is the output (split into several lines):
1629
c543c01b
TC
1630 line-noise lowercase line-noise UPPERCASE line-noise UPPERCASE
1631 line-noise lowercase line-noise lowercase line-noise lowercase
1632 lowercase line-noise lowercase lowercase line-noise lowercase
1633 lowercase line-noise MiXeD line-noise. That's all!
44a8e56a 1634
c543c01b 1635=item m?PATTERN?msixpodualgc
725a61d7 1636X<?> X<operator, match-once>
87e95b7f 1637
c543c01b 1638=item ?PATTERN?msixpodualgc
55d389e7 1639
725a61d7
Z
1640This is just like the C<m/PATTERN/> search, except that it matches
1641only once between calls to the reset() operator. This is a useful
87e95b7f 1642optimization when you want to see only the first occurrence of
ceb131e8 1643something in each file of a set of files, for instance. Only C<m??>
87e95b7f
YO
1644patterns local to the current package are reset.
1645
1646 while (<>) {
ceb131e8 1647 if (m?^$?) {
87e95b7f
YO
1648 # blank line between header and body
1649 }
1650 } continue {
725a61d7 1651 reset if eof; # clear m?? status for next file
87e95b7f
YO
1652 }
1653
c543c01b
TC
1654Another example switched the first "latin1" encoding it finds
1655to "utf8" in a pod file:
1656
1657 s//utf8/ if m? ^ =encoding \h+ \K latin1 ?x;
1658
1659The match-once behavior is controlled by the match delimiter being
725a61d7
Z
1660C<?>; with any other delimiter this is the normal C<m//> operator.
1661
1662For historical reasons, the leading C<m> in C<m?PATTERN?> is optional,
1663but the resulting C<?PATTERN?> syntax is deprecated, will warn on
c543c01b
TC
1664usage and might be removed from a future stable release of Perl (without
1665further notice!).
87e95b7f 1666
b6fa137b 1667=item s/PATTERN/REPLACEMENT/msixpodualgcer
87e95b7f 1668X<substitute> X<substitution> X<replace> X<regexp, replace>
4f4d7508 1669X<regexp, substitute> X</m> X</s> X</i> X</x> X</p> X</o> X</g> X</c> X</e> X</r>
87e95b7f
YO
1670
1671Searches a string for a pattern, and if found, replaces that pattern
1672with the replacement text and returns the number of substitutions
1673made. Otherwise it returns false (specifically, the empty string).
1674
c543c01b 1675If the C</r> (non-destructive) option is used then it runs the
679563bb
KW
1676substitution on a copy of the string and instead of returning the
1677number of substitutions, it returns the copy whether or not a
c543c01b
TC
1678substitution occurred. The original string is never changed when
1679C</r> is used. The copy will always be a plain string, even if the
1680input is an object or a tied variable.
4f4d7508 1681
87e95b7f 1682If no string is specified via the C<=~> or C<!~> operator, the C<$_>
c543c01b
TC
1683variable is searched and modified. Unless the C</r> option is used,
1684the string specified must be a scalar variable, an array element, a
1685hash element, or an assignment to one of those; that is, some sort of
1686scalar lvalue.
87e95b7f
YO
1687
1688If the delimiter chosen is a single quote, no interpolation is
1689done on either the PATTERN or the REPLACEMENT. Otherwise, if the
1690PATTERN contains a $ that looks like a variable rather than an
1691end-of-string test, the variable will be interpolated into the pattern
1692at run-time. If you want the pattern compiled only once the first time
1693the variable is interpolated, use the C</o> option. If the pattern
1694evaluates to the empty string, the last successfully executed regular
1695expression is used instead. See L<perlre> for further explanation on these.
87e95b7f
YO
1696
1697Options are as with m// with the addition of the following replacement
1698specific options:
1699
1700 e Evaluate the right side as an expression.
4f4d7508
DC
1701 ee Evaluate the right side as a string then eval the result.
1702 r Return substitution and leave the original string untouched.
87e95b7f 1703
ed02a3bf
DN
1704Any non-whitespace delimiter may replace the slashes. Add space after
1705the C<s> when using a character allowed in identifiers. If single quotes
1706are used, no interpretation is done on the replacement string (the C</e>
1707modifier overrides this, however). Unlike Perl 4, Perl 5 treats backticks
1708as normal delimiters; the replacement text is not evaluated as a command.
1709If the PATTERN is delimited by bracketing quotes, the REPLACEMENT has
1710its own pair of quotes, which may or may not be bracketing quotes, e.g.,
87e95b7f
YO
1711C<s(foo)(bar)> or C<< s<foo>/bar/ >>. A C</e> will cause the
1712replacement portion to be treated as a full-fledged Perl expression
1713and evaluated right then and there. It is, however, syntax checked at
1714compile-time. A second C<e> modifier will cause the replacement portion
1715to be C<eval>ed before being run as a Perl expression.
1716
1717Examples:
1718
1719 s/\bgreen\b/mauve/g; # don't change wintergreen
1720
1721 $path =~ s|/usr/bin|/usr/local/bin|;
1722
1723 s/Login: $foo/Login: $bar/; # run-time pattern
1724
1725 ($foo = $bar) =~ s/this/that/; # copy first, then change
4f4d7508
DC
1726 ($foo = "$bar") =~ s/this/that/; # convert to string, copy, then change
1727 $foo = $bar =~ s/this/that/r; # Same as above using /r
1728 $foo = $bar =~ s/this/that/r
1729 =~ s/that/the other/r; # Chained substitutes using /r
1730 @foo = map { s/this/that/r } @bar # /r is very useful in maps
87e95b7f
YO
1731
1732 $count = ($paragraph =~ s/Mister\b/Mr./g); # get change-count
1733
1734 $_ = 'abc123xyz';
1735 s/\d+/$&*2/e; # yields 'abc246xyz'
1736 s/\d+/sprintf("%5d",$&)/e; # yields 'abc 246xyz'
1737 s/\w/$& x 2/eg; # yields 'aabbcc 224466xxyyzz'
1738
1739 s/%(.)/$percent{$1}/g; # change percent escapes; no /e
1740 s/%(.)/$percent{$1} || $&/ge; # expr now, so /e
1741 s/^=(\w+)/pod($1)/ge; # use function call
1742
4f4d7508
DC
1743 $_ = 'abc123xyz';
1744 $a = s/abc/def/r; # $a is 'def123xyz' and
1745 # $_ remains 'abc123xyz'.
1746
87e95b7f
YO
1747 # expand variables in $_, but dynamics only, using
1748 # symbolic dereferencing
1749 s/\$(\w+)/${$1}/g;
1750
1751 # Add one to the value of any numbers in the string
1752 s/(\d+)/1 + $1/eg;
1753
c543c01b
TC
1754 # Titlecase words in the last 30 characters only
1755 substr($str, -30) =~ s/\b(\p{Alpha}+)\b/\u\L$1/g;
1756
87e95b7f
YO
1757 # This will expand any embedded scalar variable
1758 # (including lexicals) in $_ : First $1 is interpolated
1759 # to the variable name, and then evaluated
1760 s/(\$\w+)/$1/eeg;
1761
1762 # Delete (most) C comments.
1763 $program =~ s {
1764 /\* # Match the opening delimiter.
1765 .*? # Match a minimal number of characters.
1766 \*/ # Match the closing delimiter.
1767 } []gsx;
1768
1769 s/^\s*(.*?)\s*$/$1/; # trim whitespace in $_, expensively
1770
1771 for ($variable) { # trim whitespace in $variable, cheap
1772 s/^\s+//;
1773 s/\s+$//;
1774 }
1775
1776 s/([^ ]*) *([^ ]*)/$2 $1/; # reverse 1st two fields
1777
1778Note the use of $ instead of \ in the last example. Unlike
1779B<sed>, we use the \<I<digit>> form in only the left hand side.
1780Anywhere else it's $<I<digit>>.
1781
1782Occasionally, you can't use just a C</g> to get all the changes
1783to occur that you might want. Here are two common cases:
1784
1785 # put commas in the right places in an integer
1786 1 while s/(\d)(\d\d\d)(?!\d)/$1,$2/g;
1787
1788 # expand tabs to 8-column spacing
1789 1 while s/\t+/' ' x (length($&)*8 - length($`)%8)/e;
1790
1c424184
FC
1791C<s///le> is treated as a substitution followed by the C<le> operator, not
1792the C</le> flags. This may change in a future version of Perl. It
1793produces a warning if warnings are enabled. To disambiguate, use a space
1794or change the order of the flags:
1795
1796 s/foo/bar/ le 5; # "le" infix operator
1797 s/foo/bar/el; # "e" and "l" flags
1798
87e95b7f
YO
1799=back
1800
1801=head2 Quote-Like Operators
1802X<operator, quote-like>
1803
01c6f5f4
RGS
1804=over 4
1805
a0d0e21e 1806=item q/STRING/
5d44bfff 1807X<q> X<quote, single> X<'> X<''>
a0d0e21e 1808
5d44bfff 1809=item 'STRING'
a0d0e21e 1810
19799a22 1811A single-quoted, literal string. A backslash represents a backslash
68dc0745 1812unless followed by the delimiter or another backslash, in which case
1813the delimiter or backslash is interpolated.
a0d0e21e
LW
1814
1815 $foo = q!I said, "You said, 'She said it.'"!;
1816 $bar = q('This is it.');
68dc0745 1817 $baz = '\n'; # a two-character string
a0d0e21e
LW
1818
1819=item qq/STRING/
d74e8afc 1820X<qq> X<quote, double> X<"> X<"">
a0d0e21e
LW
1821
1822=item "STRING"
1823
1824A double-quoted, interpolated string.
1825
1826 $_ .= qq
1827 (*** The previous line contains the naughty word "$1".\n)
19799a22 1828 if /\b(tcl|java|python)\b/i; # :-)
68dc0745 1829 $baz = "\n"; # a one-character string
a0d0e21e
LW
1830
1831=item qx/STRING/
d74e8afc 1832X<qx> X<`> X<``> X<backtick>
a0d0e21e
LW
1833
1834=item `STRING`
1835
43dd4d21
JH
1836A string which is (possibly) interpolated and then executed as a
1837system command with C</bin/sh> or its equivalent. Shell wildcards,
1838pipes, and redirections will be honored. The collected standard
1839output of the command is returned; standard error is unaffected. In
1840scalar context, it comes back as a single (potentially multi-line)
1841string, or undef if the command failed. In list context, returns a
1842list of lines (however you've defined lines with $/ or
1843$INPUT_RECORD_SEPARATOR), or an empty list if the command failed.
5a964f20
TC
1844
1845Because backticks do not affect standard error, use shell file descriptor
1846syntax (assuming the shell supports this) if you care to address this.
1847To capture a command's STDERR and STDOUT together:
a0d0e21e 1848
5a964f20
TC
1849 $output = `cmd 2>&1`;
1850
1851To capture a command's STDOUT but discard its STDERR:
1852
1853 $output = `cmd 2>/dev/null`;
1854
1855To capture a command's STDERR but discard its STDOUT (ordering is
1856important here):
1857
1858 $output = `cmd 2>&1 1>/dev/null`;
1859
1860To exchange a command's STDOUT and STDERR in order to capture the STDERR
1861but leave its STDOUT to come out the old STDERR:
1862
1863 $output = `cmd 3>&1 1>&2 2>&3 3>&-`;
1864
1865To read both a command's STDOUT and its STDERR separately, it's easiest
2359510d
SD
1866to redirect them separately to files, and then read from those files
1867when the program is done:
5a964f20 1868
2359510d 1869 system("program args 1>program.stdout 2>program.stderr");
5a964f20 1870
30398227
SP
1871The STDIN filehandle used by the command is inherited from Perl's STDIN.
1872For example:
1873
c543c01b
TC
1874 open(SPLAT, "stuff") || die "can't open stuff: $!";
1875 open(STDIN, "<&SPLAT") || die "can't dupe SPLAT: $!";
40bbb707 1876 print STDOUT `sort`;
30398227 1877
40bbb707 1878will print the sorted contents of the file named F<"stuff">.
30398227 1879
5a964f20
TC
1880Using single-quote as a delimiter protects the command from Perl's
1881double-quote interpolation, passing it on to the shell instead:
1882
1883 $perl_info = qx(ps $$); # that's Perl's $$
1884 $shell_info = qx'ps $$'; # that's the new shell's $$
1885
19799a22 1886How that string gets evaluated is entirely subject to the command
5a964f20
TC
1887interpreter on your system. On most platforms, you will have to protect
1888shell metacharacters if you want them treated literally. This is in
1889practice difficult to do, as it's unclear how to escape which characters.
1890See L<perlsec> for a clean and safe example of a manual fork() and exec()
1891to emulate backticks safely.
a0d0e21e 1892
bb32b41a
GS
1893On some platforms (notably DOS-like ones), the shell may not be
1894capable of dealing with multiline commands, so putting newlines in
1895the string may not get you what you want. You may be able to evaluate
1896multiple commands in a single line by separating them with the command
1897separator character, if your shell supports that (e.g. C<;> on many Unix
1898shells; C<&> on the Windows NT C<cmd> shell).
1899
0f897271
GS
1900Beginning with v5.6.0, Perl will attempt to flush all files opened for
1901output before starting the child process, but this may not be supported
1902on some platforms (see L<perlport>). To be safe, you may need to set
1903C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method of
1904C<IO::Handle> on any open handles.
1905
bb32b41a
GS
1906Beware that some command shells may place restrictions on the length
1907of the command line. You must ensure your strings don't exceed this
1908limit after any necessary interpolations. See the platform-specific
1909release notes for more details about your particular environment.
1910
5a964f20
TC
1911Using this operator can lead to programs that are difficult to port,
1912because the shell commands called vary between systems, and may in
1913fact not be present at all. As one example, the C<type> command under
1914the POSIX shell is very different from the C<type> command under DOS.
1915That doesn't mean you should go out of your way to avoid backticks
1916when they're the right way to get something done. Perl was made to be
1917a glue language, and one of the things it glues together is commands.
1918Just understand what you're getting yourself into.
bb32b41a 1919
da87341d 1920See L</"I/O Operators"> for more discussion.
a0d0e21e 1921
945c54fd 1922=item qw/STRING/
d74e8afc 1923X<qw> X<quote, list> X<quote, words>
945c54fd
JH
1924
1925Evaluates to a list of the words extracted out of STRING, using embedded
1926whitespace as the word delimiters. It can be understood as being roughly
1927equivalent to:
1928
c543c01b 1929 split(" ", q/STRING/);
945c54fd 1930
efb1e162
CW
1931the differences being that it generates a real list at compile time, and
1932in scalar context it returns the last element in the list. So
945c54fd
JH
1933this expression:
1934
1935 qw(foo bar baz)
1936
1937is semantically equivalent to the list:
1938
c543c01b 1939 "foo", "bar", "baz"
945c54fd
JH
1940
1941Some frequently seen examples:
1942
1943 use POSIX qw( setlocale localeconv )
1944 @EXPORT = qw( foo bar baz );
1945
1946A common mistake is to try to separate the words with comma or to
1947put comments into a multi-line C<qw>-string. For this reason, the
89d205f2 1948C<use warnings> pragma and the B<-w> switch (that is, the C<$^W> variable)
945c54fd
JH
1949produces warnings if the STRING contains the "," or the "#" character.
1950
8ff32507 1951=item tr/SEARCHLIST/REPLACEMENTLIST/cdsr
d74e8afc 1952X<tr> X<y> X<transliterate> X</c> X</d> X</s>
a0d0e21e 1953
8ff32507 1954=item y/SEARCHLIST/REPLACEMENTLIST/cdsr
a0d0e21e 1955
2c268ad5 1956Transliterates all occurrences of the characters found in the search list
a0d0e21e
LW
1957with the corresponding character in the replacement list. It returns
1958the number of characters replaced or deleted. If no string is
c543c01b
TC
1959specified via the C<=~> or C<!~> operator, the $_ string is transliterated.
1960
1961If the C</r> (non-destructive) option is present, a new copy of the string
1962is made and its characters transliterated, and this copy is returned no
1963matter whether it was modified or not: the original string is always
1964left unchanged. The new copy is always a plain string, even if the input
1965string is an object or a tied variable.
8ada0baa 1966
c543c01b
TC
1967Unless the C</r> option is used, the string specified with C<=~> must be a
1968scalar variable, an array element, a hash element, or an assignment to one
1969of those; in other words, an lvalue.
8ff32507 1970
89d205f2 1971A character range may be specified with a hyphen, so C<tr/A-J/0-9/>
2c268ad5 1972does the same replacement as C<tr/ACEGIBDFHJ/0246813579/>.
54310121 1973For B<sed> devotees, C<y> is provided as a synonym for C<tr>. If the
1974SEARCHLIST is delimited by bracketing quotes, the REPLACEMENTLIST has
c543c01b
TC
1975its own pair of quotes, which may or may not be bracketing quotes;
1976for example, C<tr[aeiouy][yuoiea]> or C<tr(+\-*/)/ABCD/>.
1977
1978Note that C<tr> does B<not> do regular expression character classes such as
1979C<\d> or C<\pL>. The C<tr> operator is not equivalent to the tr(1)
1980utility. If you want to map strings between lower/upper cases, see
1981L<perlfunc/lc> and L<perlfunc/uc>, and in general consider using the C<s>
1982operator if you need regular expressions. The C<\U>, C<\u>, C<\L>, and
1983C<\l> string-interpolation escapes on the right side of a substitution
1984operator will perform correct case-mappings, but C<tr[a-z][A-Z]> will not
1985(except sometimes on legacy 7-bit data).
cc255d5f 1986
8ada0baa
JH
1987Note also that the whole range idea is rather unportable between
1988character sets--and even within character sets they may cause results
1989you probably didn't expect. A sound principle is to use only ranges
1990that begin from and end at either alphabets of equal case (a-e, A-E),
1991or digits (0-4). Anything else is unsafe. If in doubt, spell out the
1992character sets in full.
1993
a0d0e21e
LW
1994Options:
1995
1996 c Complement the SEARCHLIST.
1997 d Delete found but unreplaced characters.
1998 s Squash duplicate replaced characters.
8ff32507
FC
1999 r Return the modified string and leave the original string
2000 untouched.
a0d0e21e 2001
19799a22
GS
2002If the C</c> modifier is specified, the SEARCHLIST character set
2003is complemented. If the C</d> modifier is specified, any characters
2004specified by SEARCHLIST not found in REPLACEMENTLIST are deleted.
2005(Note that this is slightly more flexible than the behavior of some
2006B<tr> programs, which delete anything they find in the SEARCHLIST,
2007period.) If the C</s> modifier is specified, sequences of characters
2008that were transliterated to the same character are squashed down
2009to a single instance of the character.
a0d0e21e
LW
2010
2011If the C</d> modifier is used, the REPLACEMENTLIST is always interpreted
2012exactly as specified. Otherwise, if the REPLACEMENTLIST is shorter
2013than the SEARCHLIST, the final character is replicated till it is long
5a964f20 2014enough. If the REPLACEMENTLIST is empty, the SEARCHLIST is replicated.
a0d0e21e
LW
2015This latter is useful for counting characters in a class or for
2016squashing character sequences in a class.
2017
2018Examples:
2019
c543c01b 2020 $ARGV[1] =~ tr/A-Z/a-z/; # canonicalize to lower case ASCII
a0d0e21e
LW
2021
2022 $cnt = tr/*/*/; # count the stars in $_
2023
2024 $cnt = $sky =~ tr/*/*/; # count the stars in $sky
2025
2026 $cnt = tr/0-9//; # count the digits in $_
2027
2028 tr/a-zA-Z//s; # bookkeeper -> bokeper
2029
2030 ($HOST = $host) =~ tr/a-z/A-Z/;
c543c01b 2031 $HOST = $host =~ tr/a-z/A-Z/r; # same thing
8ff32507 2032
c543c01b 2033 $HOST = $host =~ tr/a-z/A-Z/r # chained with s///r
8ff32507 2034 =~ s/:/ -p/r;
a0d0e21e
LW
2035
2036 tr/a-zA-Z/ /cs; # change non-alphas to single space
2037
8ff32507
FC
2038 @stripped = map tr/a-zA-Z/ /csr, @original;
2039 # /r with map
2040
a0d0e21e 2041 tr [\200-\377]
c543c01b 2042 [\000-\177]; # wickedly delete 8th bit
a0d0e21e 2043
19799a22
GS
2044If multiple transliterations are given for a character, only the
2045first one is used:
748a9306
LW
2046
2047 tr/AAA/XYZ/
2048
2c268ad5 2049will transliterate any A to X.
748a9306 2050
19799a22 2051Because the transliteration table is built at compile time, neither
a0d0e21e 2052the SEARCHLIST nor the REPLACEMENTLIST are subjected to double quote
19799a22
GS
2053interpolation. That means that if you want to use variables, you
2054must use an eval():
a0d0e21e
LW
2055
2056 eval "tr/$oldlist/$newlist/";
2057 die $@ if $@;
2058
2059 eval "tr/$oldlist/$newlist/, 1" or die $@;
2060
7e3b091d 2061=item <<EOF
d74e8afc 2062X<here-doc> X<heredoc> X<here-document> X<<< << >>>
7e3b091d
DA
2063
2064A line-oriented form of quoting is based on the shell "here-document"
2065syntax. Following a C<< << >> you specify a string to terminate
2066the quoted material, and all lines following the current line down to
89d205f2
YO
2067the terminating string are the value of the item.
2068
2069The terminating string may be either an identifier (a word), or some
2070quoted text. An unquoted identifier works like double quotes.
2071There may not be a space between the C<< << >> and the identifier,
2072unless the identifier is explicitly quoted. (If you put a space it
2073will be treated as a null identifier, which is valid, and matches the
2074first empty line.) The terminating string must appear by itself
2075(unquoted and with no surrounding whitespace) on the terminating line.
2076
2077If the terminating string is quoted, the type of quotes used determine
2078the treatment of the text.
2079
2080=over 4
2081
2082=item Double Quotes
2083
2084Double quotes indicate that the text will be interpolated using exactly
2085the same rules as normal double quoted strings.
7e3b091d
DA
2086
2087 print <<EOF;
2088 The price is $Price.
2089 EOF
2090
2091 print << "EOF"; # same as above
2092 The price is $Price.
2093 EOF
2094
89d205f2
YO
2095
2096=item Single Quotes
2097
2098Single quotes indicate the text is to be treated literally with no
2099interpolation of its content. This is similar to single quoted
2100strings except that backslashes have no special meaning, with C<\\>
2101being treated as two backslashes and not one as they would in every
2102other quoting construct.
2103
c543c01b
TC
2104Just as in the shell, a backslashed bareword following the C<<< << >>>
2105means the same thing as a single-quoted string does:
2106
2107 $cost = <<'VISTA'; # hasta la ...
2108 That'll be $10 please, ma'am.
2109 VISTA
2110
2111 $cost = <<\VISTA; # Same thing!
2112 That'll be $10 please, ma'am.
2113 VISTA
2114
89d205f2
YO
2115This is the only form of quoting in perl where there is no need
2116to worry about escaping content, something that code generators
2117can and do make good use of.
2118
2119=item Backticks
2120
2121The content of the here doc is treated just as it would be if the
2122string were embedded in backticks. Thus the content is interpolated
2123as though it were double quoted and then executed via the shell, with
2124the results of the execution returned.
2125
2126 print << `EOC`; # execute command and get results
7e3b091d 2127 echo hi there
7e3b091d
DA
2128 EOC
2129
89d205f2
YO
2130=back
2131
2132It is possible to stack multiple here-docs in a row:
2133
7e3b091d
DA
2134 print <<"foo", <<"bar"; # you can stack them
2135 I said foo.
2136 foo
2137 I said bar.
2138 bar
2139
2140 myfunc(<< "THIS", 23, <<'THAT');
2141 Here's a line
2142 or two.
2143 THIS
2144 and here's another.
2145 THAT
2146
2147Just don't forget that you have to put a semicolon on the end
2148to finish the statement, as Perl doesn't know you're not going to
2149try to do this:
2150
2151 print <<ABC
2152 179231
2153 ABC
2154 + 20;
2155
872d7e53
TS
2156If you want to remove the line terminator from your here-docs,
2157use C<chomp()>.
2158
2159 chomp($string = <<'END');
2160 This is a string.
2161 END
2162
2163If you want your here-docs to be indented with the rest of the code,
2164you'll need to remove leading whitespace from each line manually:
7e3b091d
DA
2165
2166 ($quote = <<'FINIS') =~ s/^\s+//gm;
89d205f2 2167 The Road goes ever on and on,
7e3b091d
DA
2168 down from the door where it began.
2169 FINIS
2170
2171If you use a here-doc within a delimited construct, such as in C<s///eg>,
2172the quoted material must come on the lines following the final delimiter.
2173So instead of
2174
2175 s/this/<<E . 'that'
2176 the other
2177 E
2178 . 'more '/eg;
2179
2180you have to write
2181
89d205f2
YO
2182 s/this/<<E . 'that'
2183 . 'more '/eg;
2184 the other
2185 E
7e3b091d
DA
2186
2187If the terminating identifier is on the last line of the program, you
2188must be sure there is a newline after it; otherwise, Perl will give the
2189warning B<Can't find string terminator "END" anywhere before EOF...>.
2190
c543c01b
TC
2191Additionally, quoting rules for the end-of-string identifier are
2192unrelated to Perl's quoting rules. C<q()>, C<qq()>, and the like are not
89d205f2
YO
2193supported in place of C<''> and C<"">, and the only interpolation is for
2194backslashing the quoting character:
7e3b091d
DA
2195
2196 print << "abc\"def";
2197 testing...
2198 abc"def
2199
2200Finally, quoted strings cannot span multiple lines. The general rule is
2201that the identifier must be a string literal. Stick with that, and you
2202should be safe.
2203
a0d0e21e
LW
2204=back
2205
75e14d17 2206=head2 Gory details of parsing quoted constructs
d74e8afc 2207X<quote, gory details>
75e14d17 2208
19799a22
GS
2209When presented with something that might have several different
2210interpretations, Perl uses the B<DWIM> (that's "Do What I Mean")
2211principle to pick the most probable interpretation. This strategy
2212is so successful that Perl programmers often do not suspect the
2213ambivalence of what they write. But from time to time, Perl's
2214notions differ substantially from what the author honestly meant.
2215
2216This section hopes to clarify how Perl handles quoted constructs.
2217Although the most common reason to learn this is to unravel labyrinthine
2218regular expressions, because the initial steps of parsing are the
2219same for all quoting operators, they are all discussed together.
2220
2221The most important Perl parsing rule is the first one discussed
2222below: when processing a quoted construct, Perl first finds the end
2223of that construct, then interprets its contents. If you understand
2224this rule, you may skip the rest of this section on the first
2225reading. The other rules are likely to contradict the user's
2226expectations much less frequently than this first one.
2227
2228Some passes discussed below are performed concurrently, but because
2229their results are the same, we consider them individually. For different
2230quoting constructs, Perl performs different numbers of passes, from
6deea57f 2231one to four, but these passes are always performed in the same order.
75e14d17 2232
13a2d996 2233=over 4
75e14d17
IZ
2234
2235=item Finding the end
2236
6deea57f
TS
2237The first pass is finding the end of the quoted construct, where
2238the information about the delimiters is used in parsing.
2239During this search, text between the starting and ending delimiters
2240is copied to a safe location. The text copied gets delimiter-independent.
2241
2242If the construct is a here-doc, the ending delimiter is a line
2243that has a terminating string as the content. Therefore C<<<EOF> is
2244terminated by C<EOF> immediately followed by C<"\n"> and starting
2245from the first column of the terminating line.
2246When searching for the terminating line of a here-doc, nothing
2247is skipped. In other words, lines after the here-doc syntax
2248are compared with the terminating string line by line.
2249
2250For the constructs except here-docs, single characters are used as starting
2251and ending delimiters. If the starting delimiter is an opening punctuation
2252(that is C<(>, C<[>, C<{>, or C<< < >>), the ending delimiter is the
2253corresponding closing punctuation (that is C<)>, C<]>, C<}>, or C<< > >>).
2254If the starting delimiter is an unpaired character like C</> or a closing
2255punctuation, the ending delimiter is same as the starting delimiter.
2256Therefore a C</> terminates a C<qq//> construct, while a C<]> terminates
2257C<qq[]> and C<qq]]> constructs.
2258
2259When searching for single-character delimiters, escaped delimiters
2260and C<\\> are skipped. For example, while searching for terminating C</>,
2261combinations of C<\\> and C<\/> are skipped. If the delimiters are
2262bracketing, nested pairs are also skipped. For example, while searching
2263for closing C<]> paired with the opening C<[>, combinations of C<\\>, C<\]>,
2264and C<\[> are all skipped, and nested C<[> and C<]> are skipped as well.
2265However, when backslashes are used as the delimiters (like C<qq\\> and
2266C<tr\\\>), nothing is skipped.
2267During the search for the end, backslashes that escape delimiters
2268are removed (exactly speaking, they are not copied to the safe location).
75e14d17 2269
19799a22
GS
2270For constructs with three-part delimiters (C<s///>, C<y///>, and
2271C<tr///>), the search is repeated once more.
6deea57f
TS
2272If the first delimiter is not an opening punctuation, three delimiters must
2273be same such as C<s!!!> and C<tr)))>, in which case the second delimiter
2274terminates the left part and starts the right part at once.
b6538e4f 2275If the left part is delimited by bracketing punctuation (that is C<()>,
6deea57f 2276C<[]>, C<{}>, or C<< <> >>), the right part needs another pair of
b6538e4f 2277delimiters such as C<s(){}> and C<tr[]//>. In these cases, whitespace
6deea57f 2278and comments are allowed between both parts, though the comment must follow
b6538e4f
TC
2279at least one whitespace character; otherwise a character expected as the
2280start of the comment may be regarded as the starting delimiter of the right part.
75e14d17 2281
19799a22
GS
2282During this search no attention is paid to the semantics of the construct.
2283Thus:
75e14d17
IZ
2284
2285 "$hash{"$foo/$bar"}"
2286
2a94b7ce 2287or:
75e14d17 2288
89d205f2 2289 m/
2a94b7ce 2290 bar # NOT a comment, this slash / terminated m//!
75e14d17
IZ
2291 /x
2292
19799a22
GS
2293do not form legal quoted expressions. The quoted part ends on the
2294first C<"> and C</>, and the rest happens to be a syntax error.
2295Because the slash that terminated C<m//> was followed by a C<SPACE>,
2296the example above is not C<m//x>, but rather C<m//> with no C</x>
2297modifier. So the embedded C<#> is interpreted as a literal C<#>.
75e14d17 2298
89d205f2
YO
2299Also no attention is paid to C<\c\> (multichar control char syntax) during
2300this search. Thus the second C<\> in C<qq/\c\/> is interpreted as a part
2301of C<\/>, and the following C</> is not recognized as a delimiter.
0d594e51
TS
2302Instead, use C<\034> or C<\x1c> at the end of quoted constructs.
2303
75e14d17 2304=item Interpolation
d74e8afc 2305X<interpolation>
75e14d17 2306
19799a22 2307The next step is interpolation in the text obtained, which is now
89d205f2 2308delimiter-independent. There are multiple cases.
75e14d17 2309
13a2d996 2310=over 4
75e14d17 2311
89d205f2 2312=item C<<<'EOF'>
75e14d17
IZ
2313
2314No interpolation is performed.
6deea57f
TS
2315Note that the combination C<\\> is left intact, since escaped delimiters
2316are not available for here-docs.
75e14d17 2317
6deea57f 2318=item C<m''>, the pattern of C<s'''>
89d205f2 2319
6deea57f
TS
2320No interpolation is performed at this stage.
2321Any backslashed sequences including C<\\> are treated at the stage
2322to L</"parsing regular expressions">.
89d205f2 2323
6deea57f 2324=item C<''>, C<q//>, C<tr'''>, C<y'''>, the replacement of C<s'''>
75e14d17 2325
89d205f2 2326The only interpolation is removal of C<\> from pairs of C<\\>.
6deea57f
TS
2327Therefore C<-> in C<tr'''> and C<y'''> is treated literally
2328as a hyphen and no character range is available.
2329C<\1> in the replacement of C<s'''> does not work as C<$1>.
89d205f2
YO
2330
2331=item C<tr///>, C<y///>
2332
6deea57f
TS
2333No variable interpolation occurs. String modifying combinations for
2334case and quoting such as C<\Q>, C<\U>, and C<\E> are not recognized.
2335The other escape sequences such as C<\200> and C<\t> and backslashed
2336characters such as C<\\> and C<\-> are converted to appropriate literals.
89d205f2
YO
2337The character C<-> is treated specially and therefore C<\-> is treated
2338as a literal C<->.
75e14d17 2339
89d205f2 2340=item C<"">, C<``>, C<qq//>, C<qx//>, C<< <file*glob> >>, C<<<"EOF">
75e14d17 2341
19799a22
GS
2342C<\Q>, C<\U>, C<\u>, C<\L>, C<\l> (possibly paired with C<\E>) are
2343converted to corresponding Perl constructs. Thus, C<"$foo\Qbaz$bar">
2344is converted to C<$foo . (quotemeta("baz" . $bar))> internally.
6deea57f
TS
2345The other escape sequences such as C<\200> and C<\t> and backslashed
2346characters such as C<\\> and C<\-> are replaced with appropriate
2347expansions.
2a94b7ce 2348
19799a22
GS
2349Let it be stressed that I<whatever falls between C<\Q> and C<\E>>
2350is interpolated in the usual way. Something like C<"\Q\\E"> has
2351no C<\E> inside. instead, it has C<\Q>, C<\\>, and C<E>, so the
2352result is the same as for C<"\\\\E">. As a general rule, backslashes
2353between C<\Q> and C<\E> may lead to counterintuitive results. So,
2354C<"\Q\t\E"> is converted to C<quotemeta("\t")>, which is the same
2355as C<"\\\t"> (since TAB is not alphanumeric). Note also that:
2a94b7ce
IZ
2356
2357 $str = '\t';
2358 return "\Q$str";
2359
2360may be closer to the conjectural I<intention> of the writer of C<"\Q\t\E">.
2361
19799a22 2362Interpolated scalars and arrays are converted internally to the C<join> and
92d29cee 2363C<.> catenation operations. Thus, C<"$foo XXX '@arr'"> becomes:
75e14d17 2364
19799a22 2365 $foo . " XXX '" . (join $", @arr) . "'";
75e14d17 2366
19799a22 2367All operations above are performed simultaneously, left to right.
75e14d17 2368
19799a22
GS
2369Because the result of C<"\Q STRING \E"> has all metacharacters
2370quoted, there is no way to insert a literal C<$> or C<@> inside a
2371C<\Q\E> pair. If protected by C<\>, C<$> will be quoted to became
2372C<"\\\$">; if not, it is interpreted as the start of an interpolated
2373scalar.
75e14d17 2374
19799a22 2375Note also that the interpolation code needs to make a decision on
89d205f2 2376where the interpolated scalar ends. For instance, whether
35f2feb0 2377C<< "a $b -> {c}" >> really means:
75e14d17
IZ
2378
2379 "a " . $b . " -> {c}";
2380
2a94b7ce 2381or:
75e14d17
IZ
2382
2383 "a " . $b -> {c};
2384
19799a22
GS
2385Most of the time, the longest possible text that does not include
2386spaces between components and which contains matching braces or
2387brackets. because the outcome may be determined by voting based
2388on heuristic estimators, the result is not strictly predictable.
2389Fortunately, it's usually correct for ambiguous cases.
75e14d17 2390
6deea57f 2391=item the replacement of C<s///>
75e14d17 2392
19799a22 2393Processing of C<\Q>, C<\U>, C<\u>, C<\L>, C<\l>, and interpolation
6deea57f
TS
2394happens as with C<qq//> constructs.
2395
2396It is at this step that C<\1> is begrudgingly converted to C<$1> in
2397the replacement text of C<s///>, in order to correct the incorrigible
2398I<sed> hackers who haven't picked up the saner idiom yet. A warning
2399is emitted if the C<use warnings> pragma or the B<-w> command-line flag
2400(that is, the C<$^W> variable) was set.
2401
2402=item C<RE> in C<?RE?>, C</RE/>, C<m/RE/>, C<s/RE/foo/>,
2403
cc74c5bd
TS
2404Processing of C<\Q>, C<\U>, C<\u>, C<\L>, C<\l>, C<\E>,
2405and interpolation happens (almost) as with C<qq//> constructs.
2406
5d03b57c
KW
2407Processing of C<\N{...}> is also done here, and compiled into an intermediate
2408form for the regex compiler. (This is because, as mentioned below, the regex
2409compilation may be done at execution time, and C<\N{...}> is a compile-time
2410construct.)
2411
cc74c5bd
TS
2412However any other combinations of C<\> followed by a character
2413are not substituted but only skipped, in order to parse them
2414as regular expressions at the following step.
6deea57f 2415As C<\c> is skipped at this step, C<@> of C<\c@> in RE is possibly
1749ea0d 2416treated as an array symbol (for example C<@foo>),
6deea57f 2417even though the same text in C<qq//> gives interpolation of C<\c@>.
6deea57f
TS
2418
2419Moreover, inside C<(?{BLOCK})>, C<(?# comment )>, and
19799a22
GS
2420a C<#>-comment in a C<//x>-regular expression, no processing is
2421performed whatsoever. This is the first step at which the presence
2422of the C<//x> modifier is relevant.
2423
1749ea0d
TS
2424Interpolation in patterns has several quirks: C<$|>, C<$(>, C<$)>, C<@+>
2425and C<@-> are not interpolated, and constructs C<$var[SOMETHING]> are
2426voted (by several different estimators) to be either an array element
2427or C<$var> followed by an RE alternative. This is where the notation
19799a22
GS
2428C<${arr[$bar]}> comes handy: C</${arr[0-9]}/> is interpreted as
2429array element C<-9>, not as a regular expression from the variable
2430C<$arr> followed by a digit, which would be the interpretation of
2431C</$arr[0-9]/>. Since voting among different estimators may occur,
2432the result is not predictable.
2433
19799a22
GS
2434The lack of processing of C<\\> creates specific restrictions on
2435the post-processed text. If the delimiter is C</>, one cannot get
2436the combination C<\/> into the result of this step. C</> will
2437finish the regular expression, C<\/> will be stripped to C</> on
2438the previous step, and C<\\/> will be left as is. Because C</> is
2439equivalent to C<\/> inside a regular expression, this does not
2440matter unless the delimiter happens to be character special to the
2441RE engine, such as in C<s*foo*bar*>, C<m[foo]>, or C<?foo?>; or an
2442alphanumeric char, as in:
2a94b7ce
IZ
2443
2444 m m ^ a \s* b mmx;
2445
19799a22 2446In the RE above, which is intentionally obfuscated for illustration, the
6deea57f 2447delimiter is C<m>, the modifier is C<mx>, and after delimiter-removal the
89d205f2 2448RE is the same as for C<m/ ^ a \s* b /mx>. There's more than one
19799a22
GS
2449reason you're encouraged to restrict your delimiters to non-alphanumeric,
2450non-whitespace choices.
75e14d17
IZ
2451
2452=back
2453
19799a22 2454This step is the last one for all constructs except regular expressions,
75e14d17
IZ
2455which are processed further.
2456
6deea57f
TS
2457=item parsing regular expressions
2458X<regexp, parse>
75e14d17 2459
19799a22 2460Previous steps were performed during the compilation of Perl code,
ac036724 2461but this one happens at run time, although it may be optimized to
19799a22 2462be calculated at compile time if appropriate. After preprocessing
6deea57f 2463described above, and possibly after evaluation if concatenation,
19799a22
GS
2464joining, casing translation, or metaquoting are involved, the
2465resulting I<string> is passed to the RE engine for compilation.
2466
2467Whatever happens in the RE engine might be better discussed in L<perlre>,
2468but for the sake of continuity, we shall do so here.
2469
2470This is another step where the presence of the C<//x> modifier is
2471relevant. The RE engine scans the string from left to right and
2472converts it to a finite automaton.
2473
2474Backslashed characters are either replaced with corresponding
2475literal strings (as with C<\{>), or else they generate special nodes
2476in the finite automaton (as with C<\b>). Characters special to the
2477RE engine (such as C<|>) generate corresponding nodes or groups of
2478nodes. C<(?#...)> comments are ignored. All the rest is either
2479converted to literal strings to match, or else is ignored (as is
2480whitespace and C<#>-style comments if C<//x> is present).
2481
2482Parsing of the bracketed character class construct, C<[...]>, is
2483rather different than the rule used for the rest of the pattern.
2484The terminator of this construct is found using the same rules as
2485for finding the terminator of a C<{}>-delimited construct, the only
2486exception being that C<]> immediately following C<[> is treated as
2487though preceded by a backslash. Similarly, the terminator of
2488C<(?{...})> is found using the same rules as for finding the
2489terminator of a C<{}>-delimited construct.
2490
2491It is possible to inspect both the string given to RE engine and the
2492resulting finite automaton. See the arguments C<debug>/C<debugcolor>
2493in the C<use L<re>> pragma, as well as Perl's B<-Dr> command-line
4a4eefd0 2494switch documented in L<perlrun/"Command Switches">.
75e14d17
IZ
2495
2496=item Optimization of regular expressions
d74e8afc 2497X<regexp, optimization>
75e14d17 2498
7522fed5 2499This step is listed for completeness only. Since it does not change
75e14d17 2500semantics, details of this step are not documented and are subject
19799a22
GS
2501to change without notice. This step is performed over the finite
2502automaton that was generated during the previous pass.
2a94b7ce 2503
19799a22
GS
2504It is at this stage that C<split()> silently optimizes C</^/> to
2505mean C</^/m>.
75e14d17
IZ
2506
2507=back
2508
a0d0e21e 2509=head2 I/O Operators
d74e8afc
ITB
2510X<operator, i/o> X<operator, io> X<io> X<while> X<filehandle>
2511X<< <> >> X<@ARGV>
a0d0e21e 2512
54310121 2513There are several I/O operators you should know about.
fbad3eb5 2514
7b8d334a 2515A string enclosed by backticks (grave accents) first undergoes
19799a22
GS
2516double-quote interpolation. It is then interpreted as an external
2517command, and the output of that command is the value of the
e9c56f9b
JH
2518backtick string, like in a shell. In scalar context, a single string
2519consisting of all output is returned. In list context, a list of
2520values is returned, one per line of output. (You can set C<$/> to use
2521a different line terminator.) The command is executed each time the
2522pseudo-literal is evaluated. The status value of the command is
2523returned in C<$?> (see L<perlvar> for the interpretation of C<$?>).
2524Unlike in B<csh>, no translation is done on the return data--newlines
2525remain newlines. Unlike in any of the shells, single quotes do not
2526hide variable names in the command from interpretation. To pass a
2527literal dollar-sign through to the shell you need to hide it with a
2528backslash. The generalized form of backticks is C<qx//>. (Because
2529backticks always undergo shell expansion as well, see L<perlsec> for
2530security concerns.)
d74e8afc 2531X<qx> X<`> X<``> X<backtick> X<glob>
19799a22
GS
2532
2533In scalar context, evaluating a filehandle in angle brackets yields
2534the next line from that file (the newline, if any, included), or
2535C<undef> at end-of-file or on error. When C<$/> is set to C<undef>
2536(sometimes known as file-slurp mode) and the file is empty, it
2537returns C<''> the first time, followed by C<undef> subsequently.
2538
2539Ordinarily you must assign the returned value to a variable, but
2540there is one situation where an automatic assignment happens. If
2541and only if the input symbol is the only thing inside the conditional
2542of a C<while> statement (even if disguised as a C<for(;;)> loop),
2543the value is automatically assigned to the global variable $_,
2544destroying whatever was there previously. (This may seem like an
2545odd thing to you, but you'll use the construct in almost every Perl
17b829fa 2546script you write.) The $_ variable is not implicitly localized.
19799a22
GS
2547You'll have to put a C<local $_;> before the loop if you want that
2548to happen.
2549
2550The following lines are equivalent:
a0d0e21e 2551
748a9306 2552 while (defined($_ = <STDIN>)) { print; }
7b8d334a 2553 while ($_ = <STDIN>) { print; }
a0d0e21e
LW
2554 while (<STDIN>) { print; }
2555 for (;<STDIN>;) { print; }
748a9306 2556 print while defined($_ = <STDIN>);
7b8d334a 2557 print while ($_ = <STDIN>);
a0d0e21e
LW
2558 print while <STDIN>;
2559
19799a22 2560This also behaves similarly, but avoids $_ :
7b8d334a 2561
89d205f2 2562 while (my $line = <STDIN>) { print $line }
7b8d334a 2563
19799a22
GS
2564In these loop constructs, the assigned value (whether assignment
2565is automatic or explicit) is then tested to see whether it is
2566defined. The defined test avoids problems where line has a string
2567value that would be treated as false by Perl, for example a "" or
2568a "0" with no trailing newline. If you really mean for such values
2569to terminate the loop, they should be tested for explicitly:
7b8d334a
GS
2570
2571 while (($_ = <STDIN>) ne '0') { ... }
2572 while (<STDIN>) { last unless $_; ... }
2573
5ef4d93e 2574In other boolean contexts, C<< <filehandle> >> without an
2575explicit C<defined> test or comparison elicits a warning if the
9f1b1f2d 2576C<use warnings> pragma or the B<-w>
19799a22 2577command-line switch (the C<$^W> variable) is in effect.
7b8d334a 2578
5f05dabc 2579The filehandles STDIN, STDOUT, and STDERR are predefined. (The
19799a22
GS
2580filehandles C<stdin>, C<stdout>, and C<stderr> will also work except
2581in packages, where they would be interpreted as local identifiers
2582rather than global.) Additional filehandles may be created with
2583the open() function, amongst others. See L<perlopentut> and
2584L<perlfunc/open> for details on this.
d74e8afc 2585X<stdin> X<stdout> X<sterr>
a0d0e21e 2586
35f2feb0 2587If a <FILEHANDLE> is used in a context that is looking for
19799a22
GS
2588a list, a list comprising all input lines is returned, one line per
2589list element. It's easy to grow to a rather large data space this
2590way, so use with care.
a0d0e21e 2591
35f2feb0 2592<FILEHANDLE> may also be spelled C<readline(*FILEHANDLE)>.
19799a22 2593See L<perlfunc/readline>.
fbad3eb5 2594
35f2feb0
GS
2595The null filehandle <> is special: it can be used to emulate the
2596behavior of B<sed> and B<awk>. Input from <> comes either from
a0d0e21e 2597standard input, or from each file listed on the command line. Here's
35f2feb0 2598how it works: the first time <> is evaluated, the @ARGV array is
5a964f20 2599checked, and if it is empty, C<$ARGV[0]> is set to "-", which when opened
a0d0e21e
LW
2600gives you standard input. The @ARGV array is then processed as a list
2601of filenames. The loop
2602
2603 while (<>) {
2604 ... # code for each line
2605 }
2606
2607is equivalent to the following Perl-like pseudo code:
2608
3e3baf6d 2609 unshift(@ARGV, '-') unless @ARGV;
a0d0e21e
LW
2610 while ($ARGV = shift) {
2611 open(ARGV, $ARGV);
2612 while (<ARGV>) {
2613 ... # code for each line
2614 }
2615 }
2616
19799a22
GS
2617except that it isn't so cumbersome to say, and will actually work.
2618It really does shift the @ARGV array and put the current filename
2619into the $ARGV variable. It also uses filehandle I<ARGV>
ac036724 2620internally. <> is just a synonym for <ARGV>, which
19799a22 2621is magical. (The pseudo code above doesn't work because it treats
35f2feb0 2622<ARGV> as non-magical.)
a0d0e21e 2623
48ab5743
ML
2624Since the null filehandle uses the two argument form of L<perlfunc/open>
2625it interprets special characters, so if you have a script like this:
2626
2627 while (<>) {
2628 print;
2629 }
2630
2631and call it with C<perl dangerous.pl 'rm -rfv *|'>, it actually opens a
2632pipe, executes the C<rm> command and reads C<rm>'s output from that pipe.
2633If you want all items in C<@ARGV> to be interpreted as file names, you
2634can use the module C<ARGV::readonly> from CPAN.
2635
35f2feb0 2636You can modify @ARGV before the first <> as long as the array ends up
a0d0e21e 2637containing the list of filenames you really want. Line numbers (C<$.>)
19799a22
GS
2638continue as though the input were one big happy file. See the example
2639in L<perlfunc/eof> for how to reset line numbers on each file.
5a964f20 2640
89d205f2 2641If you want to set @ARGV to your own list of files, go right ahead.
5a964f20
TC
2642This sets @ARGV to all plain text files if no @ARGV was given:
2643
2644 @ARGV = grep { -f && -T } glob('*') unless @ARGV;
a0d0e21e 2645
5a964f20
TC
2646You can even set them to pipe commands. For example, this automatically
2647filters compressed arguments through B<gzip>:
2648
2649 @ARGV = map { /\.(gz|Z)$/ ? "gzip -dc < $_ |" : $_ } @ARGV;
2650
2651If you want to pass switches into your script, you can use one of the
a0d0e21e
LW
2652Getopts modules or put a loop on the front like this:
2653
2654 while ($_ = $ARGV[0], /^-/) {
2655 shift;
2656 last if /^--$/;
2657 if (/^-D(.*)/) { $debug = $1 }
2658 if (/^-v/) { $verbose++ }
5a964f20 2659 # ... # other switches
a0d0e21e 2660 }
5a964f20 2661
a0d0e21e 2662 while (<>) {
5a964f20 2663 # ... # code for each line
a0d0e21e
LW
2664 }
2665
89d205f2
YO
2666The <> symbol will return C<undef> for end-of-file only once.
2667If you call it again after this, it will assume you are processing another
19799a22 2668@ARGV list, and if you haven't set @ARGV, will read input from STDIN.
a0d0e21e 2669
b159ebd3 2670If what the angle brackets contain is a simple scalar variable (e.g.,
35f2feb0 2671<$foo>), then that variable contains the name of the
19799a22
GS
2672filehandle to input from, or its typeglob, or a reference to the
2673same. For example:
cb1a09d0
AD
2674
2675 $fh = \*STDIN;
2676 $line = <$fh>;
a0d0e21e 2677
5a964f20
TC
2678If what's within the angle brackets is neither a filehandle nor a simple
2679scalar variable containing a filehandle name, typeglob, or typeglob
2680reference, it is interpreted as a filename pattern to be globbed, and
2681either a list of filenames or the next filename in the list is returned,
19799a22 2682depending on context. This distinction is determined on syntactic
35f2feb0
GS
2683grounds alone. That means C<< <$x> >> is always a readline() from
2684an indirect handle, but C<< <$hash{key}> >> is always a glob().
5a964f20 2685That's because $x is a simple scalar variable, but C<$hash{key}> is
ef191992
YST
2686not--it's a hash element. Even C<< <$x > >> (note the extra space)
2687is treated as C<glob("$x ")>, not C<readline($x)>.
5a964f20
TC
2688
2689One level of double-quote interpretation is done first, but you can't
35f2feb0 2690say C<< <$foo> >> because that's an indirect filehandle as explained
5a964f20
TC
2691in the previous paragraph. (In older versions of Perl, programmers
2692would insert curly brackets to force interpretation as a filename glob:
35f2feb0 2693C<< <${foo}> >>. These days, it's considered cleaner to call the
5a964f20 2694internal function directly as C<glob($foo)>, which is probably the right
19799a22 2695way to have done it in the first place.) For example:
a0d0e21e
LW
2696
2697 while (<*.c>) {
2698 chmod 0644, $_;
2699 }
2700
3a4b19e4 2701is roughly equivalent to:
a0d0e21e
LW
2702
2703 open(FOO, "echo *.c | tr -s ' \t\r\f' '\\012\\012\\012\\012'|");
2704 while (<FOO>) {
5b3eff12 2705 chomp;
a0d0e21e
LW
2706 chmod 0644, $_;
2707 }
2708
3a4b19e4
GS
2709except that the globbing is actually done internally using the standard
2710C<File::Glob> extension. Of course, the shortest way to do the above is:
a0d0e21e
LW
2711
2712 chmod 0644, <*.c>;
2713
19799a22
GS
2714A (file)glob evaluates its (embedded) argument only when it is
2715starting a new list. All values must be read before it will start
2716over. In list context, this isn't important because you automatically
2717get them all anyway. However, in scalar context the operator returns
069e01df 2718the next value each time it's called, or C<undef> when the list has
19799a22
GS
2719run out. As with filehandle reads, an automatic C<defined> is
2720generated when the glob occurs in the test part of a C<while>,
2721because legal glob returns (e.g. a file called F<0>) would otherwise
2722terminate the loop. Again, C<undef> is returned only once. So if
2723you're expecting a single value from a glob, it is much better to
2724say
4633a7c4
LW
2725
2726 ($file) = <blurch*>;
2727
2728than
2729
2730 $file = <blurch*>;
2731
2732because the latter will alternate between returning a filename and
19799a22 2733returning false.
4633a7c4 2734
b159ebd3 2735If you're trying to do variable interpolation, it's definitely better
4633a7c4 2736to use the glob() function, because the older notation can cause people
e37d713d 2737to become confused with the indirect filehandle notation.
4633a7c4
LW
2738
2739 @files = glob("$dir/*.[ch]");
2740 @files = glob($files[$i]);
2741
a0d0e21e 2742=head2 Constant Folding
d74e8afc 2743X<constant folding> X<folding>
a0d0e21e
LW
2744
2745Like C, Perl does a certain amount of expression evaluation at
19799a22 2746compile time whenever it determines that all arguments to an
a0d0e21e
LW
2747operator are static and have no side effects. In particular, string
2748concatenation happens at compile time between literals that don't do
19799a22 2749variable substitution. Backslash interpolation also happens at
a0d0e21e
LW
2750compile time. You can say
2751
2752 'Now is the time for all' . "\n" .
2753 'good men to come to.'
2754
54310121 2755and this all reduces to one string internally. Likewise, if
a0d0e21e
LW
2756you say
2757
2758 foreach $file (@filenames) {
5a964f20 2759 if (-s $file > 5 + 100 * 2**16) { }
54310121 2760 }
a0d0e21e 2761
19799a22
GS
2762the compiler will precompute the number which that expression
2763represents so that the interpreter won't have to.
a0d0e21e 2764
fd1abbef 2765=head2 No-ops
d74e8afc 2766X<no-op> X<nop>
fd1abbef
DN
2767
2768Perl doesn't officially have a no-op operator, but the bare constants
2769C<0> and C<1> are special-cased to not produce a warning in a void
2770context, so you can for example safely do
2771
2772 1 while foo();
2773
2c268ad5 2774=head2 Bitwise String Operators
d74e8afc 2775X<operator, bitwise, string>
2c268ad5
TP
2776
2777Bitstrings of any size may be manipulated by the bitwise operators
2778(C<~ | & ^>).
2779
19799a22
GS
2780If the operands to a binary bitwise op are strings of different
2781sizes, B<|> and B<^> ops act as though the shorter operand had
2782additional zero bits on the right, while the B<&> op acts as though
2783the longer operand were truncated to the length of the shorter.
2784The granularity for such extension or truncation is one or more
2785bytes.
2c268ad5 2786
89d205f2 2787 # ASCII-based examples
2c268ad5
TP
2788 print "j p \n" ^ " a h"; # prints "JAPH\n"
2789 print "JA" | " ph\n"; # prints "japh\n"
2790 print "japh\nJunk" & '_____'; # prints "JAPH\n";
2791 print 'p N$' ^ " E<H\n"; # prints "Perl\n";
2792
19799a22 2793If you are intending to manipulate bitstrings, be certain that
2c268ad5 2794you're supplying bitstrings: If an operand is a number, that will imply
19799a22 2795a B<numeric> bitwise operation. You may explicitly show which type of
2c268ad5
TP
2796operation you intend by using C<""> or C<0+>, as in the examples below.
2797
4358a253
SS
2798 $foo = 150 | 105; # yields 255 (0x96 | 0x69 is 0xFF)
2799 $foo = '150' | 105; # yields 255
2c268ad5
TP
2800 $foo = 150 | '105'; # yields 255
2801 $foo = '150' | '105'; # yields string '155' (under ASCII)
2802
2803 $baz = 0+$foo & 0+$bar; # both ops explicitly numeric
2804 $biz = "$foo" ^ "$bar"; # both ops explicitly stringy
a0d0e21e 2805
1ae175c8
GS
2806See L<perlfunc/vec> for information on how to manipulate individual bits
2807in a bit vector.
2808
55497cff 2809=head2 Integer Arithmetic
d74e8afc 2810X<integer>
a0d0e21e 2811
19799a22 2812By default, Perl assumes that it must do most of its arithmetic in
a0d0e21e
LW
2813floating point. But by saying
2814
2815 use integer;
2816
3eab78e3
CW
2817you may tell the compiler to use integer operations
2818(see L<integer> for a detailed explanation) from here to the end of
2819the enclosing BLOCK. An inner BLOCK may countermand this by saying
a0d0e21e
LW
2820
2821 no integer;
2822
19799a22 2823which lasts until the end of that BLOCK. Note that this doesn't
3eab78e3
CW
2824mean everything is an integer, merely that Perl will use integer
2825operations for arithmetic, comparison, and bitwise operators. For
2826example, even under C<use integer>, if you take the C<sqrt(2)>, you'll
2827still get C<1.4142135623731> or so.
19799a22
GS
2828
2829Used on numbers, the bitwise operators ("&", "|", "^", "~", "<<",
89d205f2 2830and ">>") always produce integral results. (But see also
13a2d996 2831L<Bitwise String Operators>.) However, C<use integer> still has meaning for
19799a22
GS
2832them. By default, their results are interpreted as unsigned integers, but
2833if C<use integer> is in effect, their results are interpreted
2834as signed integers. For example, C<~0> usually evaluates to a large
0be96356 2835integral value. However, C<use integer; ~0> is C<-1> on two's-complement
19799a22 2836machines.
68dc0745 2837
2838=head2 Floating-point Arithmetic
06ce2fa3 2839
d74e8afc 2840X<floating-point> X<floating point> X<float> X<real>
68dc0745 2841
2842While C<use integer> provides integer-only arithmetic, there is no
19799a22
GS
2843analogous mechanism to provide automatic rounding or truncation to a
2844certain number of decimal places. For rounding to a certain number
2845of digits, sprintf() or printf() is usually the easiest route.
2846See L<perlfaq4>.
68dc0745 2847
5a964f20
TC
2848Floating-point numbers are only approximations to what a mathematician
2849would call real numbers. There are infinitely more reals than floats,
2850so some corners must be cut. For example:
2851
2852 printf "%.20g\n", 123456789123456789;
2853 # produces 123456789123456784
2854
8548cb57
RGS
2855Testing for exact floating-point equality or inequality is not a
2856good idea. Here's a (relatively expensive) work-around to compare
5a964f20
TC
2857whether two floating-point numbers are equal to a particular number of
2858decimal places. See Knuth, volume II, for a more robust treatment of
2859this topic.
2860
2861 sub fp_equal {
2862 my ($X, $Y, $POINTS) = @_;
2863 my ($tX, $tY);
2864 $tX = sprintf("%.${POINTS}g", $X);
2865 $tY = sprintf("%.${POINTS}g", $Y);
2866 return $tX eq $tY;
2867 }
2868
68dc0745 2869The POSIX module (part of the standard perl distribution) implements
19799a22
GS
2870ceil(), floor(), and other mathematical and trigonometric functions.
2871The Math::Complex module (part of the standard perl distribution)
2872defines mathematical functions that work on both the reals and the
2873imaginary numbers. Math::Complex not as efficient as POSIX, but
68dc0745 2874POSIX can't work with complex numbers.
2875
2876Rounding in financial applications can have serious implications, and
2877the rounding method used should be specified precisely. In these
2878cases, it probably pays not to trust whichever system rounding is
2879being used by Perl, but to instead implement the rounding function you
2880need yourself.
5a964f20
TC
2881
2882=head2 Bigger Numbers
d74e8afc 2883X<number, arbitrary precision>
5a964f20 2884
c543c01b
TC
2885The standard C<Math::BigInt>, C<Math::BigRat>, and C<Math::BigFloat> modules,
2886along with the C<bigint>, C<bigrat>, and C<bitfloat> pragmas, provide
19799a22 2887variable-precision arithmetic and overloaded operators, although
cd5c4fce 2888they're currently pretty slow. At the cost of some space and
19799a22
GS
2889considerable speed, they avoid the normal pitfalls associated with
2890limited-precision representations.
5a964f20 2891
c543c01b
TC
2892 use 5.010;
2893 use bigint; # easy interface to Math::BigInt
2894 $x = 123456789123456789;
2895 say $x * $x;
2896 +15241578780673678515622620750190521
2897
2898Or with rationals:
2899
2900 use 5.010;
2901 use bigrat;
2902 $a = 3/22;
2903 $b = 4/6;
2904 say "a/b is ", $a/$b;
2905 say "a*b is ", $a*$b;
2906 a/b is 9/44
2907 a*b is 1/11
2908
2909Several modules let you calculate with (bound only by memory and CPU time)
2910unlimited or fixed precision. There are also some non-standard modules that
2911provide faster implementations via external C libraries.
cd5c4fce
T
2912
2913Here is a short, but incomplete summary:
2914
950b09ed
KW
2915 Math::Fraction big, unlimited fractions like 9973 / 12967
2916 Math::String treat string sequences like numbers
2917 Math::FixedPrecision calculate with a fixed precision
2918 Math::Currency for currency calculations
2919 Bit::Vector manipulate bit vectors fast (uses C)
2920 Math::BigIntFast Bit::Vector wrapper for big numbers
2921 Math::Pari provides access to the Pari C library
2922 Math::BigInteger uses an external C library
2923 Math::Cephes uses external Cephes C library (no big numbers)
2924 Math::Cephes::Fraction fractions via the Cephes library
2925 Math::GMP another one using an external C library
cd5c4fce
T
2926
2927Choose wisely.
16070b82
GS
2928
2929=cut