This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Removed unnecessary pointers checks
[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
d74e8afc
ITB
8=head2 Operator Precedence and Associativity
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
c963b151 56 left or xor err
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,
c07a80fd 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
A
152Note that just as in C, Perl doesn't define B<when> the variable is
153incremented or decremented. You just know it will be done sometime
154before or after the value is returned. This also means that modifying
155a variable twice in the same statement will lead to undefined behaviour.
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
171 print ++($foo = '99'); # prints '100'
172 print ++($foo = 'a0'); # prints 'a1'
173 print ++($foo = 'Az'); # prints 'Ba'
174 print ++($foo = 'zz'); # prints 'aaa'
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
LW
196
197Unary "-" performs arithmetic negation if the operand is numeric. If
198the operand is an identifier, a string consisting of a minus sign
199concatenated with the identifier is returned. Otherwise, if the string
200starts with a plus or minus, a string starting with the opposite sign
bff5667c 201is returned. One effect of these rules is that -bareword is equivalent
8705167b 202to the string "-bareword". If, however, the string begins with a
06705523
SP
203non-alphabetic character (exluding "+" or "-"), Perl will attempt to convert
204the string to a numeric and the arithmetic negation is performed. If the
205string cannot be cleanly converted to a numeric, Perl will give the warning
206B<Argument "the string" isn't numeric in negation (-) at ...>.
d74e8afc 207X<-> X<negation, arithmetic>
a0d0e21e 208
972b05a9
JH
209Unary "~" performs bitwise negation, i.e., 1's complement. For
210example, C<0666 & ~027> is 0640. (See also L<Integer Arithmetic> and
211L<Bitwise String Operators>.) Note that the width of the result is
212platform-dependent: ~0 is 32 bits wide on a 32-bit platform, but 64
213bits wide on a 64-bit platform, so if you are expecting a certain bit
d042e63d 214width, remember to use the & operator to mask off the excess bits.
d74e8afc 215X<~> X<negation, binary>
a0d0e21e
LW
216
217Unary "+" has no effect whatsoever, even on strings. It is useful
218syntactically for separating a function name from a parenthesized expression
219that would otherwise be interpreted as the complete list of function
5ba421f6 220arguments. (See examples above under L<Terms and List Operators (Leftward)>.)
d74e8afc 221X<+>
a0d0e21e 222
19799a22
GS
223Unary "\" creates a reference to whatever follows it. See L<perlreftut>
224and L<perlref>. Do not confuse this behavior with the behavior of
225backslash within a string, although both forms do convey the notion
226of protecting the next thing from interpolation.
d74e8afc 227X<\> X<reference> X<backslash>
a0d0e21e
LW
228
229=head2 Binding Operators
d74e8afc 230X<binding> X<operator, binding> X<=~> X<!~>
a0d0e21e 231
c07a80fd 232Binary "=~" binds a scalar expression to a pattern match. Certain operations
cb1a09d0
AD
233search or modify the string $_ by default. This operator makes that kind
234of operation work on some other string. The right argument is a search
2c268ad5
TP
235pattern, substitution, or transliteration. The left argument is what is
236supposed to be searched, substituted, or transliterated instead of the default
f8bab1e9
GS
237$_. When used in scalar context, the return value generally indicates the
238success of the operation. Behavior in list context depends on the particular
d7782e69
SP
239operator. See L</"Regexp Quote-Like Operators"> for details and
240L<perlretut> for examples using these operators.
f8bab1e9
GS
241
242If the right argument is an expression rather than a search pattern,
2c268ad5 243substitution, or transliteration, it is interpreted as a search pattern at run
573e01ca 244time.
a0d0e21e
LW
245
246Binary "!~" is just like "=~" except the return value is negated in
247the logical sense.
248
249=head2 Multiplicative Operators
d74e8afc 250X<operator, multiplicative>
a0d0e21e
LW
251
252Binary "*" multiplies two numbers.
d74e8afc 253X<*>
a0d0e21e
LW
254
255Binary "/" divides two numbers.
d74e8afc 256X</> X<slash>
a0d0e21e 257
54310121 258Binary "%" computes the modulus of two numbers. Given integer
259operands C<$a> and C<$b>: If C<$b> is positive, then C<$a % $b> is
260C<$a> minus the largest multiple of C<$b> that is not greater than
261C<$a>. If C<$b> is negative, then C<$a % $b> is C<$a> minus the
262smallest multiple of C<$b> that is not less than C<$a> (i.e. the
6bb4e6d4 263result will be less than or equal to zero).
0412d526 264Note that when C<use integer> is in scope, "%" gives you direct access
55d729e4
GS
265to the modulus operator as implemented by your C compiler. This
266operator is not as well defined for negative operands, but it will
267execute faster.
d74e8afc 268X<%> X<remainder> X<modulus> X<mod>
55d729e4 269
62d10b70
GS
270Binary "x" is the repetition operator. In scalar context or if the left
271operand is not enclosed in parentheses, it returns a string consisting
272of the left operand repeated the number of times specified by the right
273operand. In list context, if the left operand is enclosed in
3585017f
YST
274parentheses or is a list formed by C<qw/STRING/>, it repeats the list.
275If the right operand is zero or negative, it returns an empty string
276or an empty list, depending on the context.
d74e8afc 277X<x>
a0d0e21e
LW
278
279 print '-' x 80; # print row of dashes
280
281 print "\t" x ($tab/8), ' ' x ($tab%8); # tab over
282
283 @ones = (1) x 80; # a list of 80 1's
284 @ones = (5) x @ones; # set all elements to 5
285
286
287=head2 Additive Operators
d74e8afc 288X<operator, additive>
a0d0e21e
LW
289
290Binary "+" returns the sum of two numbers.
d74e8afc 291X<+>
a0d0e21e
LW
292
293Binary "-" returns the difference of two numbers.
d74e8afc 294X<->
a0d0e21e
LW
295
296Binary "." concatenates two strings.
d74e8afc
ITB
297X<string, concatenation> X<concatenation>
298X<cat> X<concat> X<concatenate> X<.>
a0d0e21e
LW
299
300=head2 Shift Operators
d74e8afc
ITB
301X<shift operator> X<operator, shift> X<<< << >>>
302X<<< >> >>> X<right shift> X<left shift> X<bitwise shift>
303X<shl> X<shr> X<shift, right> X<shift, left>
a0d0e21e 304
55497cff 305Binary "<<" returns the value of its left argument shifted left by the
306number of bits specified by the right argument. Arguments should be
982ce180 307integers. (See also L<Integer Arithmetic>.)
a0d0e21e 308
55497cff 309Binary ">>" returns the value of its left argument shifted right by
310the number of bits specified by the right argument. Arguments should
982ce180 311be integers. (See also L<Integer Arithmetic>.)
a0d0e21e 312
b16cf6df
JH
313Note that both "<<" and ">>" in Perl are implemented directly using
314"<<" and ">>" in C. If C<use integer> (see L<Integer Arithmetic>) is
315in force then signed C integers are used, else unsigned C integers are
316used. Either way, the implementation isn't going to generate results
317larger than the size of the integer type Perl was built with (32 bits
318or 64 bits).
319
320The result of overflowing the range of the integers is undefined
321because it is undefined also in C. In other words, using 32-bit
322integers, C<< 1 << 32 >> is undefined. Shifting by a negative number
323of bits is also undefined.
324
a0d0e21e 325=head2 Named Unary Operators
d74e8afc 326X<operator, named unary>
a0d0e21e
LW
327
328The various named unary operators are treated as functions with one
568e6d8b 329argument, with optional parentheses.
a0d0e21e
LW
330
331If any list operator (print(), etc.) or any unary operator (chdir(), etc.)
332is followed by a left parenthesis as the next token, the operator and
333arguments within parentheses are taken to be of highest precedence,
3981b0eb
JA
334just like a normal function call. For example,
335because named unary operators are higher precedence than ||:
a0d0e21e
LW
336
337 chdir $foo || die; # (chdir $foo) || die
338 chdir($foo) || die; # (chdir $foo) || die
339 chdir ($foo) || die; # (chdir $foo) || die
340 chdir +($foo) || die; # (chdir $foo) || die
341
3981b0eb 342but, because * is higher precedence than named operators:
a0d0e21e
LW
343
344 chdir $foo * 20; # chdir ($foo * 20)
345 chdir($foo) * 20; # (chdir $foo) * 20
346 chdir ($foo) * 20; # (chdir $foo) * 20
347 chdir +($foo) * 20; # chdir ($foo * 20)
348
349 rand 10 * 20; # rand (10 * 20)
350 rand(10) * 20; # (rand 10) * 20
351 rand (10) * 20; # (rand 10) * 20
352 rand +(10) * 20; # rand (10 * 20)
353
568e6d8b
RGS
354Regarding precedence, the filetest operators, like C<-f>, C<-M>, etc. are
355treated like named unary operators, but they don't follow this functional
356parenthesis rule. That means, for example, that C<-f($file).".bak"> is
357equivalent to C<-f "$file.bak">.
d74e8afc 358X<-X> X<filetest> X<operator, filetest>
568e6d8b 359
5ba421f6 360See also L<"Terms and List Operators (Leftward)">.
a0d0e21e
LW
361
362=head2 Relational Operators
d74e8afc 363X<relational operator> X<operator, relational>
a0d0e21e 364
35f2feb0 365Binary "<" returns true if the left argument is numerically less than
a0d0e21e 366the right argument.
d74e8afc 367X<< < >>
a0d0e21e 368
35f2feb0 369Binary ">" returns true if the left argument is numerically greater
a0d0e21e 370than the right argument.
d74e8afc 371X<< > >>
a0d0e21e 372
35f2feb0 373Binary "<=" returns true if the left argument is numerically less than
a0d0e21e 374or equal to the right argument.
d74e8afc 375X<< <= >>
a0d0e21e 376
35f2feb0 377Binary ">=" returns true if the left argument is numerically greater
a0d0e21e 378than or equal to the right argument.
d74e8afc 379X<< >= >>
a0d0e21e
LW
380
381Binary "lt" returns true if the left argument is stringwise less than
382the right argument.
d74e8afc 383X<< lt >>
a0d0e21e
LW
384
385Binary "gt" returns true if the left argument is stringwise greater
386than the right argument.
d74e8afc 387X<< gt >>
a0d0e21e
LW
388
389Binary "le" returns true if the left argument is stringwise less than
390or equal to the right argument.
d74e8afc 391X<< le >>
a0d0e21e
LW
392
393Binary "ge" returns true if the left argument is stringwise greater
394than or equal to the right argument.
d74e8afc 395X<< ge >>
a0d0e21e
LW
396
397=head2 Equality Operators
d74e8afc 398X<equality> X<equal> X<equals> X<operator, equality>
a0d0e21e
LW
399
400Binary "==" returns true if the left argument is numerically equal to
401the right argument.
d74e8afc 402X<==>
a0d0e21e
LW
403
404Binary "!=" returns true if the left argument is numerically not equal
405to the right argument.
d74e8afc 406X<!=>
a0d0e21e 407
35f2feb0 408Binary "<=>" returns -1, 0, or 1 depending on whether the left
6ee5d4e7 409argument is numerically less than, equal to, or greater than the right
d4ad863d 410argument. If your platform supports NaNs (not-a-numbers) as numeric
7d3a9d88
NC
411values, using them with "<=>" returns undef. NaN is not "<", "==", ">",
412"<=" or ">=" anything (even NaN), so those 5 return false. NaN != NaN
413returns true, as does NaN != anything else. If your platform doesn't
414support NaNs then NaN is just a string with numeric value 0.
d74e8afc 415X<< <=> >> X<spaceship>
7d3a9d88 416
2b54f59f
YST
417 perl -le '$a = "NaN"; print "No NaN support here" if $a == $a'
418 perl -le '$a = "NaN"; print "NaN support here" if $a != $a'
a0d0e21e
LW
419
420Binary "eq" returns true if the left argument is stringwise equal to
421the right argument.
d74e8afc 422X<eq>
a0d0e21e
LW
423
424Binary "ne" returns true if the left argument is stringwise not equal
425to the right argument.
d74e8afc 426X<ne>
a0d0e21e 427
d4ad863d
JH
428Binary "cmp" returns -1, 0, or 1 depending on whether the left
429argument is stringwise less than, equal to, or greater than the right
430argument.
d74e8afc 431X<cmp>
a0d0e21e 432
0d863452
RH
433Binary "~~" does a smart match between its arguments. Smart matching
434is described in L<perlsyn/"Smart Matching in Detail">.
435This operator is only available if you enable the "~~" feature:
436see L<feature> for more information.
437X<~~>
438
a034a98d
DD
439"lt", "le", "ge", "gt" and "cmp" use the collation (sort) order specified
440by the current locale if C<use locale> is in effect. See L<perllocale>.
441
a0d0e21e 442=head2 Bitwise And
d74e8afc 443X<operator, bitwise, and> X<bitwise and> X<&>
a0d0e21e 444
2cdc098b 445Binary "&" returns its operands ANDed together bit by bit.
2c268ad5 446(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 447
2cdc098b
MG
448Note that "&" has lower priority than relational operators, so for example
449the brackets are essential in a test like
450
451 print "Even\n" if ($x & 1) == 0;
452
a0d0e21e 453=head2 Bitwise Or and Exclusive Or
d74e8afc
ITB
454X<operator, bitwise, or> X<bitwise or> X<|> X<operator, bitwise, xor>
455X<bitwise xor> X<^>
a0d0e21e 456
2cdc098b 457Binary "|" returns its operands ORed together bit by bit.
2c268ad5 458(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 459
2cdc098b 460Binary "^" returns its operands XORed together bit by bit.
2c268ad5 461(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 462
2cdc098b
MG
463Note that "|" and "^" have lower priority than relational operators, so
464for example the brackets are essential in a test like
465
466 print "false\n" if (8 | 2) != 10;
467
a0d0e21e 468=head2 C-style Logical And
d74e8afc 469X<&&> X<logical and> X<operator, logical, and>
a0d0e21e
LW
470
471Binary "&&" performs a short-circuit logical AND operation. That is,
472if the left operand is false, the right operand is not even evaluated.
473Scalar or list context propagates down to the right operand if it
474is evaluated.
475
476=head2 C-style Logical Or
d74e8afc 477X<||> X<operator, logical, or>
a0d0e21e
LW
478
479Binary "||" performs a short-circuit logical OR operation. That is,
480if the left operand is true, the right operand is not even evaluated.
481Scalar or list context propagates down to the right operand if it
482is evaluated.
483
c963b151 484=head2 C-style Logical Defined-Or
d74e8afc 485X<//> X<operator, logical, defined-or>
c963b151
BD
486
487Although it has no direct equivalent in C, Perl's C<//> operator is related
488to its C-style or. In fact, it's exactly the same as C<||>, except that it
489tests the left hand side's definedness instead of its truth. Thus, C<$a // $b>
490is similar to C<defined($a) || $b> (except that it returns the value of C<$a>
491rather than the value of C<defined($a)>) and is exactly equivalent to
492C<defined($a) ? $a : $b>. This is very useful for providing default values
d042e63d
MS
493for variables. If you actually want to test if at least one of C<$a> and
494C<$b> is defined, use C<defined($a // $b)>.
c963b151 495
d042e63d
MS
496The C<||>, C<//> and C<&&> operators return the last value evaluated
497(unlike C's C<||> and C<&&>, which return 0 or 1). Thus, a reasonably
498portable way to find out the home directory might be:
a0d0e21e 499
c963b151
BD
500 $home = $ENV{'HOME'} // $ENV{'LOGDIR'} //
501 (getpwuid($<))[7] // die "You're homeless!\n";
a0d0e21e 502
5a964f20
TC
503In particular, this means that you shouldn't use this
504for selecting between two aggregates for assignment:
505
506 @a = @b || @c; # this is wrong
507 @a = scalar(@b) || @c; # really meant this
508 @a = @b ? @b : @c; # this works fine, though
509
c963b151
BD
510As more readable alternatives to C<&&>, C<//> and C<||> when used for
511control flow, Perl provides C<and>, C<err> and C<or> operators (see below).
512The short-circuit behavior is identical. The precedence of "and", "err"
513and "or" is much lower, however, so that you can safely use them after a
5a964f20 514list operator without the need for parentheses:
a0d0e21e
LW
515
516 unlink "alpha", "beta", "gamma"
517 or gripe(), next LINE;
518
519With the C-style operators that would have been written like this:
520
521 unlink("alpha", "beta", "gamma")
522 || (gripe(), next LINE);
523
eeb6a2c9 524Using "or" for assignment is unlikely to do what you want; see below.
5a964f20
TC
525
526=head2 Range Operators
d74e8afc 527X<operator, range> X<range> X<..> X<...>
a0d0e21e
LW
528
529Binary ".." is the range operator, which is really two different
fb53bbb2 530operators depending on the context. In list context, it returns a
54ae734e 531list of values counting (up by ones) from the left value to the right
2cdbc966 532value. If the left value is greater than the right value then it
fb53bbb2 533returns the empty list. The range operator is useful for writing
54ae734e 534C<foreach (1..10)> loops and for doing slice operations on arrays. In
2cdbc966
JD
535the current implementation, no temporary array is created when the
536range operator is used as the expression in C<foreach> loops, but older
537versions of Perl might burn a lot of memory when you write something
538like this:
a0d0e21e
LW
539
540 for (1 .. 1_000_000) {
541 # code
54310121 542 }
a0d0e21e 543
54ae734e
MG
544The range operator also works on strings, using the magical auto-increment,
545see below.
546
5a964f20 547In scalar context, ".." returns a boolean value. The operator is
a0d0e21e
LW
548bistable, like a flip-flop, and emulates the line-range (comma) operator
549of B<sed>, B<awk>, and various editors. Each ".." operator maintains its
550own boolean state. It is false as long as its left operand is false.
551Once the left operand is true, the range operator stays true until the
552right operand is true, I<AFTER> which the range operator becomes false
19799a22 553again. It doesn't become false till the next time the range operator is
a0d0e21e
LW
554evaluated. It can test the right operand and become false on the same
555evaluation it became true (as in B<awk>), but it still returns true once.
19799a22
GS
556If you don't want it to test the right operand till the next
557evaluation, as in B<sed>, just use three dots ("...") instead of
558two. In all other regards, "..." behaves just like ".." does.
559
560The right operand is not evaluated while the operator is in the
561"false" state, and the left operand is not evaluated while the
562operator is in the "true" state. The precedence is a little lower
563than || and &&. The value returned is either the empty string for
564false, or a sequence number (beginning with 1) for true. The
565sequence number is reset for each range encountered. The final
566sequence number in a range has the string "E0" appended to it, which
567doesn't affect its numeric value, but gives you something to search
568for if you want to exclude the endpoint. You can exclude the
569beginning point by waiting for the sequence number to be greater
df5f8116
CW
570than 1.
571
572If either operand of scalar ".." is a constant expression,
573that operand is considered true if it is equal (C<==>) to the current
574input line number (the C<$.> variable).
575
576To be pedantic, the comparison is actually C<int(EXPR) == int(EXPR)>,
577but that is only an issue if you use a floating point expression; when
578implicitly using C<$.> as described in the previous paragraph, the
579comparison is C<int(EXPR) == int($.)> which is only an issue when C<$.>
580is set to a floating point value and you are not reading from a file.
581Furthermore, C<"span" .. "spat"> or C<2.18 .. 3.14> will not do what
582you want in scalar context because each of the operands are evaluated
583using their integer representation.
584
585Examples:
a0d0e21e
LW
586
587As a scalar operator:
588
df5f8116
CW
589 if (101 .. 200) { print; } # print 2nd hundred lines, short for
590 # if ($. == 101 .. $. == 200) ...
9f10b797
RGS
591
592 next LINE if (1 .. /^$/); # skip header lines, short for
df5f8116 593 # ... if ($. == 1 .. /^$/);
9f10b797
RGS
594 # (typically in a loop labeled LINE)
595
596 s/^/> / if (/^$/ .. eof()); # quote body
a0d0e21e 597
5a964f20
TC
598 # parse mail messages
599 while (<>) {
600 $in_header = 1 .. /^$/;
df5f8116
CW
601 $in_body = /^$/ .. eof;
602 if ($in_header) {
603 # ...
604 } else { # in body
605 # ...
606 }
5a964f20 607 } continue {
df5f8116 608 close ARGV if eof; # reset $. each file
5a964f20
TC
609 }
610
acf31ca5
SF
611Here's a simple example to illustrate the difference between
612the two range operators:
613
614 @lines = (" - Foo",
615 "01 - Bar",
616 "1 - Baz",
617 " - Quux");
618
9f10b797
RGS
619 foreach (@lines) {
620 if (/0/ .. /1/) {
acf31ca5
SF
621 print "$_\n";
622 }
623 }
624
9f10b797
RGS
625This program will print only the line containing "Bar". If
626the range operator is changed to C<...>, it will also print the
acf31ca5
SF
627"Baz" line.
628
629And now some examples as a list operator:
a0d0e21e
LW
630
631 for (101 .. 200) { print; } # print $_ 100 times
3e3baf6d 632 @foo = @foo[0 .. $#foo]; # an expensive no-op
a0d0e21e
LW
633 @foo = @foo[$#foo-4 .. $#foo]; # slice last 5 items
634
5a964f20 635The range operator (in list context) makes use of the magical
5f05dabc 636auto-increment algorithm if the operands are strings. You
a0d0e21e
LW
637can say
638
639 @alphabet = ('A' .. 'Z');
640
54ae734e 641to get all normal letters of the English alphabet, or
a0d0e21e
LW
642
643 $hexdigit = (0 .. 9, 'a' .. 'f')[$num & 15];
644
645to get a hexadecimal digit, or
646
647 @z2 = ('01' .. '31'); print $z2[$mday];
648
649to get dates with leading zeros. If the final value specified is not
650in the sequence that the magical increment would produce, the sequence
651goes until the next value would be longer than the final value
652specified.
653
df5f8116
CW
654Because each operand is evaluated in integer form, C<2.18 .. 3.14> will
655return two elements in list context.
656
657 @list = (2.18 .. 3.14); # same as @list = (2 .. 3);
658
a0d0e21e 659=head2 Conditional Operator
d74e8afc 660X<operator, conditional> X<operator, ternary> X<ternary> X<?:>
a0d0e21e
LW
661
662Ternary "?:" is the conditional operator, just as in C. It works much
663like an if-then-else. If the argument before the ? is true, the
664argument before the : is returned, otherwise the argument after the :
cb1a09d0
AD
665is returned. For example:
666
54310121 667 printf "I have %d dog%s.\n", $n,
cb1a09d0
AD
668 ($n == 1) ? '' : "s";
669
670Scalar or list context propagates downward into the 2nd
54310121 671or 3rd argument, whichever is selected.
cb1a09d0
AD
672
673 $a = $ok ? $b : $c; # get a scalar
674 @a = $ok ? @b : @c; # get an array
675 $a = $ok ? @b : @c; # oops, that's just a count!
676
677The operator may be assigned to if both the 2nd and 3rd arguments are
678legal lvalues (meaning that you can assign to them):
a0d0e21e
LW
679
680 ($a_or_b ? $a : $b) = $c;
681
5a964f20
TC
682Because this operator produces an assignable result, using assignments
683without parentheses will get you in trouble. For example, this:
684
685 $a % 2 ? $a += 10 : $a += 2
686
687Really means this:
688
689 (($a % 2) ? ($a += 10) : $a) += 2
690
691Rather than this:
692
693 ($a % 2) ? ($a += 10) : ($a += 2)
694
19799a22
GS
695That should probably be written more simply as:
696
697 $a += ($a % 2) ? 10 : 2;
698
4633a7c4 699=head2 Assignment Operators
d74e8afc 700X<assignment> X<operator, assignment> X<=> X<**=> X<+=> X<*=> X<&=>
5ac3b81c 701X<<< <<= >>> X<&&=> X<-=> X</=> X<|=> X<<< >>= >>> X<||=> X<//=> X<.=>
d74e8afc 702X<%=> X<^=> X<x=>
a0d0e21e
LW
703
704"=" is the ordinary assignment operator.
705
706Assignment operators work as in C. That is,
707
708 $a += 2;
709
710is equivalent to
711
712 $a = $a + 2;
713
714although without duplicating any side effects that dereferencing the lvalue
54310121 715might trigger, such as from tie(). Other assignment operators work similarly.
716The following are recognized:
a0d0e21e
LW
717
718 **= += *= &= <<= &&=
9f10b797
RGS
719 -= /= |= >>= ||=
720 .= %= ^= //=
721 x=
a0d0e21e 722
19799a22 723Although these are grouped by family, they all have the precedence
a0d0e21e
LW
724of assignment.
725
b350dd2f
GS
726Unlike in C, the scalar assignment operator produces a valid lvalue.
727Modifying an assignment is equivalent to doing the assignment and
728then modifying the variable that was assigned to. This is useful
729for modifying a copy of something, like this:
a0d0e21e
LW
730
731 ($tmp = $global) =~ tr [A-Z] [a-z];
732
733Likewise,
734
735 ($a += 2) *= 3;
736
737is equivalent to
738
739 $a += 2;
740 $a *= 3;
741
b350dd2f
GS
742Similarly, a list assignment in list context produces the list of
743lvalues assigned to, and a list assignment in scalar context returns
744the number of elements produced by the expression on the right hand
745side of the assignment.
746
748a9306 747=head2 Comma Operator
d74e8afc 748X<comma> X<operator, comma> X<,>
a0d0e21e 749
5a964f20 750Binary "," is the comma operator. In scalar context it evaluates
a0d0e21e
LW
751its left argument, throws that value away, then evaluates its right
752argument and returns that value. This is just like C's comma operator.
753
5a964f20 754In list context, it's just the list argument separator, and inserts
a0d0e21e
LW
755both its arguments into the list.
756
d042e63d 757The C<< => >> operator is a synonym for the comma, but forces any word
719b43e8 758(consisting entirely of word characters) to its left to be interpreted
a44e5664
MS
759as a string (as of 5.001). This includes words that might otherwise be
760considered a constant or function call.
761
762 use constant FOO => "something";
763
764 my %h = ( FOO => 23 );
765
766is equivalent to:
767
768 my %h = ("FOO", 23);
769
770It is I<NOT>:
771
772 my %h = ("something", 23);
773
774If the argument on the left is not a word, it is first interpreted as
775an expression, and then the string value of that is used.
719b43e8
RGS
776
777The C<< => >> operator is helpful in documenting the correspondence
778between keys and values in hashes, and other paired elements in lists.
748a9306 779
a44e5664
MS
780 %hash = ( $key => $value );
781 login( $username => $password );
782
a0d0e21e 783=head2 List Operators (Rightward)
d74e8afc 784X<operator, list, rightward> X<list operator>
a0d0e21e
LW
785
786On the right side of a list operator, it has very low precedence,
787such that it controls all comma-separated expressions found there.
788The only operators with lower precedence are the logical operators
789"and", "or", and "not", which may be used to evaluate calls to list
790operators without the need for extra parentheses:
791
792 open HANDLE, "filename"
793 or die "Can't open: $!\n";
794
5ba421f6 795See also discussion of list operators in L<Terms and List Operators (Leftward)>.
a0d0e21e
LW
796
797=head2 Logical Not
d74e8afc 798X<operator, logical, not> X<not>
a0d0e21e
LW
799
800Unary "not" returns the logical negation of the expression to its right.
801It's the equivalent of "!" except for the very low precedence.
802
803=head2 Logical And
d74e8afc 804X<operator, logical, and> X<and>
a0d0e21e
LW
805
806Binary "and" returns the logical conjunction of the two surrounding
807expressions. It's equivalent to && except for the very low
5f05dabc 808precedence. This means that it short-circuits: i.e., the right
a0d0e21e
LW
809expression is evaluated only if the left expression is true.
810
c963b151 811=head2 Logical or, Defined or, and Exclusive Or
d74e8afc
ITB
812X<operator, logical, or> X<operator, logical, xor> X<operator, logical, err>
813X<operator, logical, defined or> X<operator, logical, exclusive or>
814X<or> X<xor> X<err>
a0d0e21e
LW
815
816Binary "or" returns the logical disjunction of the two surrounding
5a964f20
TC
817expressions. It's equivalent to || except for the very low precedence.
818This makes it useful for control flow
819
820 print FH $data or die "Can't write to FH: $!";
821
822This means that it short-circuits: i.e., the right expression is evaluated
823only if the left expression is false. Due to its precedence, you should
824probably avoid using this for assignment, only for control flow.
825
826 $a = $b or $c; # bug: this is wrong
827 ($a = $b) or $c; # really means this
828 $a = $b || $c; # better written this way
829
19799a22 830However, when it's a list-context assignment and you're trying to use
5a964f20
TC
831"||" for control flow, you probably need "or" so that the assignment
832takes higher precedence.
833
834 @info = stat($file) || die; # oops, scalar sense of stat!
835 @info = stat($file) or die; # better, now @info gets its due
836
c963b151
BD
837Then again, you could always use parentheses.
838
9f10b797
RGS
839Binary "err" is equivalent to C<//>--it's just like binary "or", except it
840tests its left argument's definedness instead of its truth. There are two
841ways to remember "err": either because many functions return C<undef> on
842an B<err>or, or as a sort of correction: C<$a = ($b err 'default')>. This
843keyword is only available when the 'err' feature is enabled: see
844L<feature> for more information.
a0d0e21e
LW
845
846Binary "xor" returns the exclusive-OR of the two surrounding expressions.
847It cannot short circuit, of course.
848
849=head2 C Operators Missing From Perl
d74e8afc
ITB
850X<operator, missing from perl> X<&> X<*>
851X<typecasting> X<(TYPE)>
a0d0e21e
LW
852
853Here is what C has that Perl doesn't:
854
855=over 8
856
857=item unary &
858
859Address-of operator. (But see the "\" operator for taking a reference.)
860
861=item unary *
862
54310121 863Dereference-address operator. (Perl's prefix dereferencing
a0d0e21e
LW
864operators are typed: $, @, %, and &.)
865
866=item (TYPE)
867
19799a22 868Type-casting operator.
a0d0e21e
LW
869
870=back
871
5f05dabc 872=head2 Quote and Quote-like Operators
d74e8afc
ITB
873X<operator, quote> X<operator, quote-like> X<q> X<qq> X<qx> X<qw> X<m>
874X<qr> X<s> X<tr> X<'> X<''> X<"> X<""> X<//> X<`> X<``> X<<< << >>>
875X<escape sequence> X<escape>
876
a0d0e21e
LW
877
878While we usually think of quotes as literal values, in Perl they
879function as operators, providing various kinds of interpolating and
880pattern matching capabilities. Perl provides customary quote characters
881for these behaviors, but also provides a way for you to choose your
882quote character for any of them. In the following table, a C<{}> represents
9f10b797 883any pair of delimiters you choose.
a0d0e21e 884
2c268ad5
TP
885 Customary Generic Meaning Interpolates
886 '' q{} Literal no
887 "" qq{} Literal yes
af9219ee 888 `` qx{} Command yes*
2c268ad5 889 qw{} Word list no
af9219ee
MG
890 // m{} Pattern match yes*
891 qr{} Pattern yes*
892 s{}{} Substitution yes*
2c268ad5 893 tr{}{} Transliteration no (but see below)
7e3b091d 894 <<EOF here-doc yes*
a0d0e21e 895
af9219ee
MG
896 * unless the delimiter is ''.
897
87275199
GS
898Non-bracketing delimiters use the same character fore and aft, but the four
899sorts of brackets (round, angle, square, curly) will all nest, which means
9f10b797 900that
87275199 901
9f10b797 902 q{foo{bar}baz}
35f2feb0 903
9f10b797 904is the same as
87275199
GS
905
906 'foo{bar}baz'
907
908Note, however, that this does not always work for quoting Perl code:
909
910 $s = q{ if($a eq "}") ... }; # WRONG
911
83df6a1d
JH
912is a syntax error. The C<Text::Balanced> module (from CPAN, and
913starting from Perl 5.8 part of the standard distribution) is able
914to do this properly.
87275199 915
19799a22 916There can be whitespace between the operator and the quoting
fb73857a 917characters, except when C<#> is being used as the quoting character.
19799a22
GS
918C<q#foo#> is parsed as the string C<foo>, while C<q #foo#> is the
919operator C<q> followed by a comment. Its argument will be taken
920from the next line. This allows you to write:
fb73857a 921
922 s {foo} # Replace foo
923 {bar} # with bar.
924
904501ec
MG
925The following escape sequences are available in constructs that interpolate
926and in transliterations.
d74e8afc 927X<\t> X<\n> X<\r> X<\f> X<\b> X<\a> X<\e> X<\x> X<\0> X<\c> X<\N>
a0d0e21e 928
6ee5d4e7 929 \t tab (HT, TAB)
5a964f20 930 \n newline (NL)
6ee5d4e7 931 \r return (CR)
932 \f form feed (FF)
933 \b backspace (BS)
934 \a alarm (bell) (BEL)
935 \e escape (ESC)
a0ed51b3
LW
936 \033 octal char (ESC)
937 \x1b hex char (ESC)
938 \x{263a} wide hex char (SMILEY)
19799a22 939 \c[ control char (ESC)
95cc3e0c 940 \N{name} named Unicode character
2c268ad5 941
4c77eaa2
AE
942B<NOTE>: Unlike C and other languages, Perl has no \v escape sequence for
943the vertical tab (VT - ASCII 11).
944
904501ec
MG
945The following escape sequences are available in constructs that interpolate
946but not in transliterations.
d74e8afc 947X<\l> X<\u> X<\L> X<\U> X<\E> X<\Q>
904501ec 948
a0d0e21e
LW
949 \l lowercase next char
950 \u uppercase next char
951 \L lowercase till \E
952 \U uppercase till \E
953 \E end case modification
1d2dff63 954 \Q quote non-word characters till \E
a0d0e21e 955
95cc3e0c
JH
956If C<use locale> is in effect, the case map used by C<\l>, C<\L>,
957C<\u> and C<\U> is taken from the current locale. See L<perllocale>.
958If Unicode (for example, C<\N{}> or wide hex characters of 0x100 or
959beyond) is being used, the case map used by C<\l>, C<\L>, C<\u> and
960C<\U> is as defined by Unicode. For documentation of C<\N{name}>,
961see L<charnames>.
a034a98d 962
5a964f20
TC
963All systems use the virtual C<"\n"> to represent a line terminator,
964called a "newline". There is no such thing as an unvarying, physical
19799a22 965newline character. It is only an illusion that the operating system,
5a964f20
TC
966device drivers, C libraries, and Perl all conspire to preserve. Not all
967systems read C<"\r"> as ASCII CR and C<"\n"> as ASCII LF. For example,
968on a Mac, these are reversed, and on systems without line terminator,
969printing C<"\n"> may emit no actual data. In general, use C<"\n"> when
970you mean a "newline" for your system, but use the literal ASCII when you
971need an exact character. For example, most networking protocols expect
2a380090 972and prefer a CR+LF (C<"\015\012"> or C<"\cM\cJ">) for line terminators,
5a964f20
TC
973and although they often accept just C<"\012">, they seldom tolerate just
974C<"\015">. If you get in the habit of using C<"\n"> for networking,
975you may be burned some day.
d74e8afc
ITB
976X<newline> X<line terminator> X<eol> X<end of line>
977X<\n> X<\r> X<\r\n>
5a964f20 978
904501ec
MG
979For constructs that do interpolate, variables beginning with "C<$>"
980or "C<@>" are interpolated. Subscripted variables such as C<$a[3]> or
ad0f383a
A
981C<< $href->{key}[0] >> are also interpolated, as are array and hash slices.
982But method calls such as C<< $obj->meth >> are not.
af9219ee
MG
983
984Interpolating an array or slice interpolates the elements in order,
985separated by the value of C<$">, so is equivalent to interpolating
904501ec
MG
986C<join $", @array>. "Punctuation" arrays such as C<@+> are only
987interpolated if the name is enclosed in braces C<@{+}>.
af9219ee 988
1d2dff63
GS
989You cannot include a literal C<$> or C<@> within a C<\Q> sequence.
990An unescaped C<$> or C<@> interpolates the corresponding variable,
991while escaping will cause the literal string C<\$> to be inserted.
992You'll need to write something like C<m/\Quser\E\@\Qhost/>.
993
a0d0e21e
LW
994Patterns are subject to an additional level of interpretation as a
995regular expression. This is done as a second pass, after variables are
996interpolated, so that regular expressions may be incorporated into the
997pattern from the variables. If this is not what you want, use C<\Q> to
998interpolate a variable literally.
999
19799a22
GS
1000Apart from the behavior described above, Perl does not expand
1001multiple levels of interpolation. In particular, contrary to the
1002expectations of shell programmers, back-quotes do I<NOT> interpolate
1003within double quotes, nor do single quotes impede evaluation of
1004variables when used within double quotes.
a0d0e21e 1005
5f05dabc 1006=head2 Regexp Quote-Like Operators
d74e8afc 1007X<operator, regexp>
cb1a09d0 1008
5f05dabc 1009Here are the quote-like operators that apply to pattern
cb1a09d0
AD
1010matching and related activities.
1011
a0d0e21e
LW
1012=over 8
1013
1014=item ?PATTERN?
d74e8afc 1015X<?>
a0d0e21e
LW
1016
1017This is just like the C</pattern/> search, except that it matches only
1018once between calls to the reset() operator. This is a useful
5f05dabc 1019optimization when you want to see only the first occurrence of
a0d0e21e
LW
1020something in each file of a set of files, for instance. Only C<??>
1021patterns local to the current package are reset.
1022
5a964f20
TC
1023 while (<>) {
1024 if (?^$?) {
1025 # blank line between header and body
1026 }
1027 } continue {
1028 reset if eof; # clear ?? status for next file
1029 }
1030
483b4840 1031This usage is vaguely deprecated, which means it just might possibly
19799a22
GS
1032be removed in some distant future version of Perl, perhaps somewhere
1033around the year 2168.
a0d0e21e 1034
fb73857a 1035=item m/PATTERN/cgimosx
d74e8afc
ITB
1036X<m> X<operator, match>
1037X<regexp, options> X<regexp> X<regex, options> X<regex>
1038X</c> X</i> X</m> X</o> X</s> X</x>
a0d0e21e 1039
fb73857a 1040=item /PATTERN/cgimosx
a0d0e21e 1041
5a964f20 1042Searches a string for a pattern match, and in scalar context returns
19799a22
GS
1043true if it succeeds, false if it fails. If no string is specified
1044via the C<=~> or C<!~> operator, the $_ string is searched. (The
1045string specified with C<=~> need not be an lvalue--it may be the
1046result of an expression evaluation, but remember the C<=~> binds
1047rather tightly.) See also L<perlre>. See L<perllocale> for
1048discussion of additional considerations that apply when C<use locale>
1049is in effect.
a0d0e21e
LW
1050
1051Options are:
1052
fb73857a 1053 c Do not reset search position on a failed match when /g is in effect.
5f05dabc 1054 g Match globally, i.e., find all occurrences.
a0d0e21e
LW
1055 i Do case-insensitive pattern matching.
1056 m Treat string as multiple lines.
5f05dabc 1057 o Compile pattern only once.
a0d0e21e
LW
1058 s Treat string as single line.
1059 x Use extended regular expressions.
1060
1061If "/" is the delimiter then the initial C<m> is optional. With the C<m>
01ae956f 1062you can use any pair of non-alphanumeric, non-whitespace characters
19799a22
GS
1063as delimiters. This is particularly useful for matching path names
1064that contain "/", to avoid LTS (leaning toothpick syndrome). If "?" is
7bac28a0 1065the delimiter, then the match-only-once rule of C<?PATTERN?> applies.
19799a22 1066If "'" is the delimiter, no interpolation is performed on the PATTERN.
a0d0e21e
LW
1067
1068PATTERN may contain variables, which will be interpolated (and the
f70b4f9c 1069pattern recompiled) every time the pattern search is evaluated, except
1f247705
GS
1070for when the delimiter is a single quote. (Note that C<$(>, C<$)>, and
1071C<$|> are not interpolated because they look like end-of-string tests.)
f70b4f9c
AB
1072If you want such a pattern to be compiled only once, add a C</o> after
1073the trailing delimiter. This avoids expensive run-time recompilations,
1074and is useful when the value you are interpolating won't change over
1075the life of the script. However, mentioning C</o> constitutes a promise
1076that you won't change the variables in the pattern. If you change them,
13a2d996 1077Perl won't even notice. See also L<"qr/STRING/imosx">.
a0d0e21e 1078
5a964f20 1079If the PATTERN evaluates to the empty string, the last
d65afb4b
HS
1080I<successfully> matched regular expression is used instead. In this
1081case, only the C<g> and C<c> flags on the empty pattern is honoured -
1082the other flags are taken from the original pattern. If no match has
1083previously succeeded, this will (silently) act instead as a genuine
1084empty pattern (which will always match).
a0d0e21e 1085
c963b151
BD
1086Note that it's possible to confuse Perl into thinking C<//> (the empty
1087regex) is really C<//> (the defined-or operator). Perl is usually pretty
1088good about this, but some pathological cases might trigger this, such as
1089C<$a///> (is that C<($a) / (//)> or C<$a // />?) and C<print $fh //>
1090(C<print $fh(//> or C<print($fh //>?). In all of these examples, Perl
1091will assume you meant defined-or. If you meant the empty regex, just
1092use parentheses or spaces to disambiguate, or even prefix the empty
1093regex with an C<m> (so C<//> becomes C<m//>).
1094
19799a22 1095If the C</g> option is not used, C<m//> in list context returns a
a0d0e21e 1096list consisting of the subexpressions matched by the parentheses in the
f7e33566
GS
1097pattern, i.e., (C<$1>, C<$2>, C<$3>...). (Note that here C<$1> etc. are
1098also set, and that this differs from Perl 4's behavior.) When there are
1099no parentheses in the pattern, the return value is the list C<(1)> for
1100success. With or without parentheses, an empty list is returned upon
1101failure.
a0d0e21e
LW
1102
1103Examples:
1104
1105 open(TTY, '/dev/tty');
1106 <TTY> =~ /^y/i && foo(); # do foo if desired
1107
1108 if (/Version: *([0-9.]*)/) { $version = $1; }
1109
1110 next if m#^/usr/spool/uucp#;
1111
1112 # poor man's grep
1113 $arg = shift;
1114 while (<>) {
1115 print if /$arg/o; # compile only once
1116 }
1117
1118 if (($F1, $F2, $Etc) = ($foo =~ /^(\S+)\s+(\S+)\s*(.*)/))
1119
1120This last example splits $foo into the first two words and the
5f05dabc 1121remainder of the line, and assigns those three fields to $F1, $F2, and
1122$Etc. The conditional is true if any variables were assigned, i.e., if
a0d0e21e
LW
1123the pattern matched.
1124
19799a22
GS
1125The C</g> modifier specifies global pattern matching--that is,
1126matching as many times as possible within the string. How it behaves
1127depends on the context. In list context, it returns a list of the
1128substrings matched by any capturing parentheses in the regular
1129expression. If there are no parentheses, it returns a list of all
1130the matched strings, as if there were parentheses around the whole
1131pattern.
a0d0e21e 1132
7e86de3e 1133In scalar context, each execution of C<m//g> finds the next match,
19799a22 1134returning true if it matches, and false if there is no further match.
7e86de3e
MG
1135The position after the last match can be read or set using the pos()
1136function; see L<perlfunc/pos>. A failed match normally resets the
1137search position to the beginning of the string, but you can avoid that
1138by adding the C</c> modifier (e.g. C<m//gc>). Modifying the target
1139string also resets the search position.
c90c0ff4 1140
1141You can intermix C<m//g> matches with C<m/\G.../g>, where C<\G> is a
1142zero-width assertion that matches the exact position where the previous
5d43e42d
DC
1143C<m//g>, if any, left off. Without the C</g> modifier, the C<\G> assertion
1144still anchors at pos(), but the match is of course only attempted once.
1145Using C<\G> without C</g> on a target string that has not previously had a
1146C</g> match applied to it is the same as using the C<\A> assertion to match
fe4b3f22
RGS
1147the beginning of the string. Note also that, currently, C<\G> is only
1148properly supported when anchored at the very beginning of the pattern.
c90c0ff4 1149
1150Examples:
a0d0e21e
LW
1151
1152 # list context
1153 ($one,$five,$fifteen) = (`uptime` =~ /(\d+\.\d+)/g);
1154
1155 # scalar context
5d43e42d 1156 $/ = "";
19799a22
GS
1157 while (defined($paragraph = <>)) {
1158 while ($paragraph =~ /[a-z]['")]*[.!?]+['")]*\s/g) {
1159 $sentences++;
a0d0e21e
LW
1160 }
1161 }
1162 print "$sentences\n";
1163
c90c0ff4 1164 # using m//gc with \G
137443ea 1165 $_ = "ppooqppqq";
44a8e56a 1166 while ($i++ < 2) {
1167 print "1: '";
c90c0ff4 1168 print $1 while /(o)/gc; print "', pos=", pos, "\n";
44a8e56a 1169 print "2: '";
c90c0ff4 1170 print $1 if /\G(q)/gc; print "', pos=", pos, "\n";
44a8e56a 1171 print "3: '";
c90c0ff4 1172 print $1 while /(p)/gc; print "', pos=", pos, "\n";
44a8e56a 1173 }
5d43e42d 1174 print "Final: '$1', pos=",pos,"\n" if /\G(.)/;
44a8e56a 1175
1176The last example should print:
1177
1178 1: 'oo', pos=4
137443ea 1179 2: 'q', pos=5
44a8e56a 1180 3: 'pp', pos=7
1181 1: '', pos=7
137443ea 1182 2: 'q', pos=8
1183 3: '', pos=8
5d43e42d
DC
1184 Final: 'q', pos=8
1185
1186Notice that the final match matched C<q> instead of C<p>, which a match
1187without the C<\G> anchor would have done. Also note that the final match
1188did not update C<pos> -- C<pos> is only updated on a C</g> match. If the
1189final match did indeed match C<p>, it's a good bet that you're running an
1190older (pre-5.6.0) Perl.
44a8e56a 1191
c90c0ff4 1192A useful idiom for C<lex>-like scanners is C</\G.../gc>. You can
e7ea3e70 1193combine several regexps like this to process a string part-by-part,
c90c0ff4 1194doing different actions depending on which regexp matched. Each
1195regexp tries to match where the previous one leaves off.
e7ea3e70 1196
3fe9a6f1 1197 $_ = <<'EOL';
e7ea3e70 1198 $url = new URI::URL "http://www/"; die if $url eq "xXx";
3fe9a6f1 1199 EOL
1200 LOOP:
e7ea3e70 1201 {
c90c0ff4 1202 print(" digits"), redo LOOP if /\G\d+\b[,.;]?\s*/gc;
1203 print(" lowercase"), redo LOOP if /\G[a-z]+\b[,.;]?\s*/gc;
1204 print(" UPPERCASE"), redo LOOP if /\G[A-Z]+\b[,.;]?\s*/gc;
1205 print(" Capitalized"), redo LOOP if /\G[A-Z][a-z]+\b[,.;]?\s*/gc;
1206 print(" MiXeD"), redo LOOP if /\G[A-Za-z]+\b[,.;]?\s*/gc;
1207 print(" alphanumeric"), redo LOOP if /\G[A-Za-z0-9]+\b[,.;]?\s*/gc;
1208 print(" line-noise"), redo LOOP if /\G[^A-Za-z0-9]+/gc;
e7ea3e70
IZ
1209 print ". That's all!\n";
1210 }
1211
1212Here is the output (split into several lines):
1213
1214 line-noise lowercase line-noise lowercase UPPERCASE line-noise
1215 UPPERCASE line-noise lowercase line-noise lowercase line-noise
1216 lowercase lowercase line-noise lowercase lowercase line-noise
1217 MiXeD line-noise. That's all!
44a8e56a 1218
a0d0e21e 1219=item q/STRING/
d74e8afc 1220X<q> X<quote, double> X<'> X<''>
a0d0e21e
LW
1221
1222=item C<'STRING'>
1223
19799a22 1224A single-quoted, literal string. A backslash represents a backslash
68dc0745 1225unless followed by the delimiter or another backslash, in which case
1226the delimiter or backslash is interpolated.
a0d0e21e
LW
1227
1228 $foo = q!I said, "You said, 'She said it.'"!;
1229 $bar = q('This is it.');
68dc0745 1230 $baz = '\n'; # a two-character string
a0d0e21e
LW
1231
1232=item qq/STRING/
d74e8afc 1233X<qq> X<quote, double> X<"> X<"">
a0d0e21e
LW
1234
1235=item "STRING"
1236
1237A double-quoted, interpolated string.
1238
1239 $_ .= qq
1240 (*** The previous line contains the naughty word "$1".\n)
19799a22 1241 if /\b(tcl|java|python)\b/i; # :-)
68dc0745 1242 $baz = "\n"; # a one-character string
a0d0e21e 1243
eec2d3df 1244=item qr/STRING/imosx
d74e8afc 1245X<qr> X</i> X</m> X</o> X</s> X</x>
eec2d3df 1246
322edccd 1247This operator quotes (and possibly compiles) its I<STRING> as a regular
19799a22
GS
1248expression. I<STRING> is interpolated the same way as I<PATTERN>
1249in C<m/PATTERN/>. If "'" is used as the delimiter, no interpolation
1250is done. Returns a Perl value which may be used instead of the
1251corresponding C</STRING/imosx> expression.
4b6a7270
IZ
1252
1253For example,
1254
1255 $rex = qr/my.STRING/is;
1256 s/$rex/foo/;
1257
1258is equivalent to
1259
1260 s/my.STRING/foo/is;
1261
1262The result may be used as a subpattern in a match:
eec2d3df
GS
1263
1264 $re = qr/$pattern/;
0a92e3a8
GS
1265 $string =~ /foo${re}bar/; # can be interpolated in other patterns
1266 $string =~ $re; # or used standalone
4b6a7270
IZ
1267 $string =~ /$re/; # or this way
1268
1269Since Perl may compile the pattern at the moment of execution of qr()
19799a22 1270operator, using qr() may have speed advantages in some situations,
4b6a7270
IZ
1271notably if the result of qr() is used standalone:
1272
1273 sub match {
1274 my $patterns = shift;
1275 my @compiled = map qr/$_/i, @$patterns;
1276 grep {
1277 my $success = 0;
a7665c5e 1278 foreach my $pat (@compiled) {
4b6a7270
IZ
1279 $success = 1, last if /$pat/;
1280 }
1281 $success;
1282 } @_;
1283 }
1284
19799a22
GS
1285Precompilation of the pattern into an internal representation at
1286the moment of qr() avoids a need to recompile the pattern every
1287time a match C</$pat/> is attempted. (Perl has many other internal
1288optimizations, but none would be triggered in the above example if
1289we did not use qr() operator.)
eec2d3df
GS
1290
1291Options are:
1292
1293 i Do case-insensitive pattern matching.
1294 m Treat string as multiple lines.
1295 o Compile pattern only once.
1296 s Treat string as single line.
1297 x Use extended regular expressions.
1298
0a92e3a8
GS
1299See L<perlre> for additional information on valid syntax for STRING, and
1300for a detailed look at the semantics of regular expressions.
1301
a0d0e21e 1302=item qx/STRING/
d74e8afc 1303X<qx> X<`> X<``> X<backtick>
a0d0e21e
LW
1304
1305=item `STRING`
1306
43dd4d21
JH
1307A string which is (possibly) interpolated and then executed as a
1308system command with C</bin/sh> or its equivalent. Shell wildcards,
1309pipes, and redirections will be honored. The collected standard
1310output of the command is returned; standard error is unaffected. In
1311scalar context, it comes back as a single (potentially multi-line)
1312string, or undef if the command failed. In list context, returns a
1313list of lines (however you've defined lines with $/ or
1314$INPUT_RECORD_SEPARATOR), or an empty list if the command failed.
5a964f20
TC
1315
1316Because backticks do not affect standard error, use shell file descriptor
1317syntax (assuming the shell supports this) if you care to address this.
1318To capture a command's STDERR and STDOUT together:
a0d0e21e 1319
5a964f20
TC
1320 $output = `cmd 2>&1`;
1321
1322To capture a command's STDOUT but discard its STDERR:
1323
1324 $output = `cmd 2>/dev/null`;
1325
1326To capture a command's STDERR but discard its STDOUT (ordering is
1327important here):
1328
1329 $output = `cmd 2>&1 1>/dev/null`;
1330
1331To exchange a command's STDOUT and STDERR in order to capture the STDERR
1332but leave its STDOUT to come out the old STDERR:
1333
1334 $output = `cmd 3>&1 1>&2 2>&3 3>&-`;
1335
1336To read both a command's STDOUT and its STDERR separately, it's easiest
2359510d
SD
1337to redirect them separately to files, and then read from those files
1338when the program is done:
5a964f20 1339
2359510d 1340 system("program args 1>program.stdout 2>program.stderr");
5a964f20
TC
1341
1342Using single-quote as a delimiter protects the command from Perl's
1343double-quote interpolation, passing it on to the shell instead:
1344
1345 $perl_info = qx(ps $$); # that's Perl's $$
1346 $shell_info = qx'ps $$'; # that's the new shell's $$
1347
19799a22 1348How that string gets evaluated is entirely subject to the command
5a964f20
TC
1349interpreter on your system. On most platforms, you will have to protect
1350shell metacharacters if you want them treated literally. This is in
1351practice difficult to do, as it's unclear how to escape which characters.
1352See L<perlsec> for a clean and safe example of a manual fork() and exec()
1353to emulate backticks safely.
a0d0e21e 1354
bb32b41a
GS
1355On some platforms (notably DOS-like ones), the shell may not be
1356capable of dealing with multiline commands, so putting newlines in
1357the string may not get you what you want. You may be able to evaluate
1358multiple commands in a single line by separating them with the command
1359separator character, if your shell supports that (e.g. C<;> on many Unix
1360shells; C<&> on the Windows NT C<cmd> shell).
1361
0f897271
GS
1362Beginning with v5.6.0, Perl will attempt to flush all files opened for
1363output before starting the child process, but this may not be supported
1364on some platforms (see L<perlport>). To be safe, you may need to set
1365C<$|> ($AUTOFLUSH in English) or call the C<autoflush()> method of
1366C<IO::Handle> on any open handles.
1367
bb32b41a
GS
1368Beware that some command shells may place restrictions on the length
1369of the command line. You must ensure your strings don't exceed this
1370limit after any necessary interpolations. See the platform-specific
1371release notes for more details about your particular environment.
1372
5a964f20
TC
1373Using this operator can lead to programs that are difficult to port,
1374because the shell commands called vary between systems, and may in
1375fact not be present at all. As one example, the C<type> command under
1376the POSIX shell is very different from the C<type> command under DOS.
1377That doesn't mean you should go out of your way to avoid backticks
1378when they're the right way to get something done. Perl was made to be
1379a glue language, and one of the things it glues together is commands.
1380Just understand what you're getting yourself into.
bb32b41a 1381
dc848c6f 1382See L<"I/O Operators"> for more discussion.
a0d0e21e 1383
945c54fd 1384=item qw/STRING/
d74e8afc 1385X<qw> X<quote, list> X<quote, words>
945c54fd
JH
1386
1387Evaluates to a list of the words extracted out of STRING, using embedded
1388whitespace as the word delimiters. It can be understood as being roughly
1389equivalent to:
1390
1391 split(' ', q/STRING/);
1392
efb1e162
CW
1393the differences being that it generates a real list at compile time, and
1394in scalar context it returns the last element in the list. So
945c54fd
JH
1395this expression:
1396
1397 qw(foo bar baz)
1398
1399is semantically equivalent to the list:
1400
1401 'foo', 'bar', 'baz'
1402
1403Some frequently seen examples:
1404
1405 use POSIX qw( setlocale localeconv )
1406 @EXPORT = qw( foo bar baz );
1407
1408A common mistake is to try to separate the words with comma or to
1409put comments into a multi-line C<qw>-string. For this reason, the
1410C<use warnings> pragma and the B<-w> switch (that is, the C<$^W> variable)
1411produces warnings if the STRING contains the "," or the "#" character.
1412
a0d0e21e 1413=item s/PATTERN/REPLACEMENT/egimosx
d74e8afc
ITB
1414X<substitute> X<substitution> X<replace> X<regexp, replace>
1415X<regexp, substitute> X</e> X</g> X</i> X</m> X</o> X</s> X</x>
a0d0e21e
LW
1416
1417Searches a string for a pattern, and if found, replaces that pattern
1418with the replacement text and returns the number of substitutions
e37d713d 1419made. Otherwise it returns false (specifically, the empty string).
a0d0e21e
LW
1420
1421If no string is specified via the C<=~> or C<!~> operator, the C<$_>
1422variable is searched and modified. (The string specified with C<=~> must
5a964f20 1423be scalar variable, an array element, a hash element, or an assignment
5f05dabc 1424to one of those, i.e., an lvalue.)
a0d0e21e 1425
19799a22 1426If the delimiter chosen is a single quote, no interpolation is
a0d0e21e
LW
1427done on either the PATTERN or the REPLACEMENT. Otherwise, if the
1428PATTERN contains a $ that looks like a variable rather than an
1429end-of-string test, the variable will be interpolated into the pattern
5f05dabc 1430at run-time. If you want the pattern compiled only once the first time
a0d0e21e 1431the variable is interpolated, use the C</o> option. If the pattern
5a964f20 1432evaluates to the empty string, the last successfully executed regular
a0d0e21e 1433expression is used instead. See L<perlre> for further explanation on these.
5a964f20 1434See L<perllocale> for discussion of additional considerations that apply
a034a98d 1435when C<use locale> is in effect.
a0d0e21e
LW
1436
1437Options are:
1438
1439 e Evaluate the right side as an expression.
5f05dabc 1440 g Replace globally, i.e., all occurrences.
a0d0e21e
LW
1441 i Do case-insensitive pattern matching.
1442 m Treat string as multiple lines.
5f05dabc 1443 o Compile pattern only once.
a0d0e21e
LW
1444 s Treat string as single line.
1445 x Use extended regular expressions.
1446
1447Any non-alphanumeric, non-whitespace delimiter may replace the
1448slashes. If single quotes are used, no interpretation is done on the
e37d713d 1449replacement string (the C</e> modifier overrides this, however). Unlike
54310121 1450Perl 4, Perl 5 treats backticks as normal delimiters; the replacement
e37d713d 1451text is not evaluated as a command. If the
a0d0e21e 1452PATTERN is delimited by bracketing quotes, the REPLACEMENT has its own
5f05dabc 1453pair of quotes, which may or may not be bracketing quotes, e.g.,
35f2feb0 1454C<s(foo)(bar)> or C<< s<foo>/bar/ >>. A C</e> will cause the
cec88af6
GS
1455replacement portion to be treated as a full-fledged Perl expression
1456and evaluated right then and there. It is, however, syntax checked at
1457compile-time. A second C<e> modifier will cause the replacement portion
1458to be C<eval>ed before being run as a Perl expression.
a0d0e21e
LW
1459
1460Examples:
1461
1462 s/\bgreen\b/mauve/g; # don't change wintergreen
1463
1464 $path =~ s|/usr/bin|/usr/local/bin|;
1465
1466 s/Login: $foo/Login: $bar/; # run-time pattern
1467
5a964f20 1468 ($foo = $bar) =~ s/this/that/; # copy first, then change
a0d0e21e 1469
5a964f20 1470 $count = ($paragraph =~ s/Mister\b/Mr./g); # get change-count
a0d0e21e
LW
1471
1472 $_ = 'abc123xyz';
1473 s/\d+/$&*2/e; # yields 'abc246xyz'
1474 s/\d+/sprintf("%5d",$&)/e; # yields 'abc 246xyz'
1475 s/\w/$& x 2/eg; # yields 'aabbcc 224466xxyyzz'
1476
1477 s/%(.)/$percent{$1}/g; # change percent escapes; no /e
1478 s/%(.)/$percent{$1} || $&/ge; # expr now, so /e
1479 s/^=(\w+)/&pod($1)/ge; # use function call
1480
5a964f20
TC
1481 # expand variables in $_, but dynamics only, using
1482 # symbolic dereferencing
1483 s/\$(\w+)/${$1}/g;
1484
cec88af6
GS
1485 # Add one to the value of any numbers in the string
1486 s/(\d+)/1 + $1/eg;
1487
1488 # This will expand any embedded scalar variable
1489 # (including lexicals) in $_ : First $1 is interpolated
1490 # to the variable name, and then evaluated
a0d0e21e
LW
1491 s/(\$\w+)/$1/eeg;
1492
5a964f20 1493 # Delete (most) C comments.
a0d0e21e 1494 $program =~ s {
4633a7c4
LW
1495 /\* # Match the opening delimiter.
1496 .*? # Match a minimal number of characters.
1497 \*/ # Match the closing delimiter.
a0d0e21e
LW
1498 } []gsx;
1499
6b0ac556 1500 s/^\s*(.*?)\s*$/$1/; # trim whitespace in $_, expensively
5a964f20 1501
6b0ac556 1502 for ($variable) { # trim whitespace in $variable, cheap
5a964f20
TC
1503 s/^\s+//;
1504 s/\s+$//;
1505 }
a0d0e21e
LW
1506
1507 s/([^ ]*) *([^ ]*)/$2 $1/; # reverse 1st two fields
1508
54310121 1509Note the use of $ instead of \ in the last example. Unlike
35f2feb0
GS
1510B<sed>, we use the \<I<digit>> form in only the left hand side.
1511Anywhere else it's $<I<digit>>.
a0d0e21e 1512
5f05dabc 1513Occasionally, you can't use just a C</g> to get all the changes
19799a22 1514to occur that you might want. Here are two common cases:
a0d0e21e
LW
1515
1516 # put commas in the right places in an integer
19799a22 1517 1 while s/(\d)(\d\d\d)(?!\d)/$1,$2/g;
a0d0e21e
LW
1518
1519 # expand tabs to 8-column spacing
1520 1 while s/\t+/' ' x (length($&)*8 - length($`)%8)/e;
1521
6940069f 1522=item tr/SEARCHLIST/REPLACEMENTLIST/cds
d74e8afc 1523X<tr> X<y> X<transliterate> X</c> X</d> X</s>
a0d0e21e 1524
6940069f 1525=item y/SEARCHLIST/REPLACEMENTLIST/cds
a0d0e21e 1526
2c268ad5 1527Transliterates all occurrences of the characters found in the search list
a0d0e21e
LW
1528with the corresponding character in the replacement list. It returns
1529the number of characters replaced or deleted. If no string is
2c268ad5 1530specified via the =~ or !~ operator, the $_ string is transliterated. (The
54310121 1531string specified with =~ must be a scalar variable, an array element, a
1532hash element, or an assignment to one of those, i.e., an lvalue.)
8ada0baa 1533
2c268ad5
TP
1534A character range may be specified with a hyphen, so C<tr/A-J/0-9/>
1535does the same replacement as C<tr/ACEGIBDFHJ/0246813579/>.
54310121 1536For B<sed> devotees, C<y> is provided as a synonym for C<tr>. If the
1537SEARCHLIST is delimited by bracketing quotes, the REPLACEMENTLIST has
1538its own pair of quotes, which may or may not be bracketing quotes,
2c268ad5 1539e.g., C<tr[A-Z][a-z]> or C<tr(+\-*/)/ABCD/>.
a0d0e21e 1540
cc255d5f
JH
1541Note that C<tr> does B<not> do regular expression character classes
1542such as C<\d> or C<[:lower:]>. The <tr> operator is not equivalent to
1543the tr(1) utility. If you want to map strings between lower/upper
1544cases, see L<perlfunc/lc> and L<perlfunc/uc>, and in general consider
1545using the C<s> operator if you need regular expressions.
1546
8ada0baa
JH
1547Note also that the whole range idea is rather unportable between
1548character sets--and even within character sets they may cause results
1549you probably didn't expect. A sound principle is to use only ranges
1550that begin from and end at either alphabets of equal case (a-e, A-E),
1551or digits (0-4). Anything else is unsafe. If in doubt, spell out the
1552character sets in full.
1553
a0d0e21e
LW
1554Options:
1555
1556 c Complement the SEARCHLIST.
1557 d Delete found but unreplaced characters.
1558 s Squash duplicate replaced characters.
1559
19799a22
GS
1560If the C</c> modifier is specified, the SEARCHLIST character set
1561is complemented. If the C</d> modifier is specified, any characters
1562specified by SEARCHLIST not found in REPLACEMENTLIST are deleted.
1563(Note that this is slightly more flexible than the behavior of some
1564B<tr> programs, which delete anything they find in the SEARCHLIST,
1565period.) If the C</s> modifier is specified, sequences of characters
1566that were transliterated to the same character are squashed down
1567to a single instance of the character.
a0d0e21e
LW
1568
1569If the C</d> modifier is used, the REPLACEMENTLIST is always interpreted
1570exactly as specified. Otherwise, if the REPLACEMENTLIST is shorter
1571than the SEARCHLIST, the final character is replicated till it is long
5a964f20 1572enough. If the REPLACEMENTLIST is empty, the SEARCHLIST is replicated.
a0d0e21e
LW
1573This latter is useful for counting characters in a class or for
1574squashing character sequences in a class.
1575
1576Examples:
1577
1578 $ARGV[1] =~ tr/A-Z/a-z/; # canonicalize to lower case
1579
1580 $cnt = tr/*/*/; # count the stars in $_
1581
1582 $cnt = $sky =~ tr/*/*/; # count the stars in $sky
1583
1584 $cnt = tr/0-9//; # count the digits in $_
1585
1586 tr/a-zA-Z//s; # bookkeeper -> bokeper
1587
1588 ($HOST = $host) =~ tr/a-z/A-Z/;
1589
1590 tr/a-zA-Z/ /cs; # change non-alphas to single space
1591
1592 tr [\200-\377]
1593 [\000-\177]; # delete 8th bit
1594
19799a22
GS
1595If multiple transliterations are given for a character, only the
1596first one is used:
748a9306
LW
1597
1598 tr/AAA/XYZ/
1599
2c268ad5 1600will transliterate any A to X.
748a9306 1601
19799a22 1602Because the transliteration table is built at compile time, neither
a0d0e21e 1603the SEARCHLIST nor the REPLACEMENTLIST are subjected to double quote
19799a22
GS
1604interpolation. That means that if you want to use variables, you
1605must use an eval():
a0d0e21e
LW
1606
1607 eval "tr/$oldlist/$newlist/";
1608 die $@ if $@;
1609
1610 eval "tr/$oldlist/$newlist/, 1" or die $@;
1611
7e3b091d 1612=item <<EOF
d74e8afc 1613X<here-doc> X<heredoc> X<here-document> X<<< << >>>
7e3b091d
DA
1614
1615A line-oriented form of quoting is based on the shell "here-document"
1616syntax. Following a C<< << >> you specify a string to terminate
1617the quoted material, and all lines following the current line down to
1618the terminating string are the value of the item. The terminating
1619string may be either an identifier (a word), or some quoted text. If
1620quoted, the type of quotes you use determines the treatment of the
1621text, just as in regular quoting. An unquoted identifier works like
1622double quotes. There must be no space between the C<< << >> and
1623the identifier, unless the identifier is quoted. (If you put a space it
1624will be treated as a null identifier, which is valid, and matches the first
1625empty line.) The terminating string must appear by itself (unquoted and
1626with no surrounding whitespace) on the terminating line.
1627
1628 print <<EOF;
1629 The price is $Price.
1630 EOF
1631
1632 print << "EOF"; # same as above
1633 The price is $Price.
1634 EOF
1635
1636 print << `EOC`; # execute commands
1637 echo hi there
1638 echo lo there
1639 EOC
1640
1641 print <<"foo", <<"bar"; # you can stack them
1642 I said foo.
1643 foo
1644 I said bar.
1645 bar
1646
1647 myfunc(<< "THIS", 23, <<'THAT');
1648 Here's a line
1649 or two.
1650 THIS
1651 and here's another.
1652 THAT
1653
1654Just don't forget that you have to put a semicolon on the end
1655to finish the statement, as Perl doesn't know you're not going to
1656try to do this:
1657
1658 print <<ABC
1659 179231
1660 ABC
1661 + 20;
1662
1663If you want your here-docs to be indented with the
1664rest of the code, you'll need to remove leading whitespace
1665from each line manually:
1666
1667 ($quote = <<'FINIS') =~ s/^\s+//gm;
1668 The Road goes ever on and on,
1669 down from the door where it began.
1670 FINIS
1671
1672If you use a here-doc within a delimited construct, such as in C<s///eg>,
1673the quoted material must come on the lines following the final delimiter.
1674So instead of
1675
1676 s/this/<<E . 'that'
1677 the other
1678 E
1679 . 'more '/eg;
1680
1681you have to write
1682
1683 s/this/<<E . 'that'
1684 . 'more '/eg;
1685 the other
1686 E
1687
1688If the terminating identifier is on the last line of the program, you
1689must be sure there is a newline after it; otherwise, Perl will give the
1690warning B<Can't find string terminator "END" anywhere before EOF...>.
1691
1692Additionally, the quoting rules for the identifier are not related to
1693Perl's quoting rules -- C<q()>, C<qq()>, and the like are not supported
1694in place of C<''> and C<"">, and the only interpolation is for backslashing
1695the quoting character:
1696
1697 print << "abc\"def";
1698 testing...
1699 abc"def
1700
1701Finally, quoted strings cannot span multiple lines. The general rule is
1702that the identifier must be a string literal. Stick with that, and you
1703should be safe.
1704
a0d0e21e
LW
1705=back
1706
75e14d17 1707=head2 Gory details of parsing quoted constructs
d74e8afc 1708X<quote, gory details>
75e14d17 1709
19799a22
GS
1710When presented with something that might have several different
1711interpretations, Perl uses the B<DWIM> (that's "Do What I Mean")
1712principle to pick the most probable interpretation. This strategy
1713is so successful that Perl programmers often do not suspect the
1714ambivalence of what they write. But from time to time, Perl's
1715notions differ substantially from what the author honestly meant.
1716
1717This section hopes to clarify how Perl handles quoted constructs.
1718Although the most common reason to learn this is to unravel labyrinthine
1719regular expressions, because the initial steps of parsing are the
1720same for all quoting operators, they are all discussed together.
1721
1722The most important Perl parsing rule is the first one discussed
1723below: when processing a quoted construct, Perl first finds the end
1724of that construct, then interprets its contents. If you understand
1725this rule, you may skip the rest of this section on the first
1726reading. The other rules are likely to contradict the user's
1727expectations much less frequently than this first one.
1728
1729Some passes discussed below are performed concurrently, but because
1730their results are the same, we consider them individually. For different
1731quoting constructs, Perl performs different numbers of passes, from
1732one to five, but these passes are always performed in the same order.
75e14d17 1733
13a2d996 1734=over 4
75e14d17
IZ
1735
1736=item Finding the end
1737
19799a22
GS
1738The first pass is finding the end of the quoted construct, whether
1739it be a multicharacter delimiter C<"\nEOF\n"> in the C<<<EOF>
1740construct, a C</> that terminates a C<qq//> construct, a C<]> which
35f2feb0
GS
1741terminates C<qq[]> construct, or a C<< > >> which terminates a
1742fileglob started with C<< < >>.
75e14d17 1743
19799a22
GS
1744When searching for single-character non-pairing delimiters, such
1745as C</>, combinations of C<\\> and C<\/> are skipped. However,
1746when searching for single-character pairing delimiter like C<[>,
1747combinations of C<\\>, C<\]>, and C<\[> are all skipped, and nested
1748C<[>, C<]> are skipped as well. When searching for multicharacter
1749delimiters, nothing is skipped.
75e14d17 1750
19799a22
GS
1751For constructs with three-part delimiters (C<s///>, C<y///>, and
1752C<tr///>), the search is repeated once more.
75e14d17 1753
19799a22
GS
1754During this search no attention is paid to the semantics of the construct.
1755Thus:
75e14d17
IZ
1756
1757 "$hash{"$foo/$bar"}"
1758
2a94b7ce 1759or:
75e14d17
IZ
1760
1761 m/
2a94b7ce 1762 bar # NOT a comment, this slash / terminated m//!
75e14d17
IZ
1763 /x
1764
19799a22
GS
1765do not form legal quoted expressions. The quoted part ends on the
1766first C<"> and C</>, and the rest happens to be a syntax error.
1767Because the slash that terminated C<m//> was followed by a C<SPACE>,
1768the example above is not C<m//x>, but rather C<m//> with no C</x>
1769modifier. So the embedded C<#> is interpreted as a literal C<#>.
75e14d17 1770
0d594e51
TS
1771Also no attention is paid to C<\c\> during this search.
1772Thus the second C<\> in C<qq/\c\/> is interpreted as a part of C<\/>,
1773and the following C</> is not recognized as a delimiter.
1774Instead, use C<\034> or C<\x1c> at the end of quoted constructs.
1775
75e14d17
IZ
1776=item Removal of backslashes before delimiters
1777
19799a22
GS
1778During the second pass, text between the starting and ending
1779delimiters is copied to a safe location, and the C<\> is removed
1780from combinations consisting of C<\> and delimiter--or delimiters,
1781meaning both starting and ending delimiters will should these differ.
1782This removal does not happen for multi-character delimiters.
1783Note that the combination C<\\> is left intact, just as it was.
75e14d17 1784
19799a22
GS
1785Starting from this step no information about the delimiters is
1786used in parsing.
75e14d17
IZ
1787
1788=item Interpolation
d74e8afc 1789X<interpolation>
75e14d17 1790
19799a22
GS
1791The next step is interpolation in the text obtained, which is now
1792delimiter-independent. There are four different cases.
75e14d17 1793
13a2d996 1794=over 4
75e14d17
IZ
1795
1796=item C<<<'EOF'>, C<m''>, C<s'''>, C<tr///>, C<y///>
1797
1798No interpolation is performed.
1799
1800=item C<''>, C<q//>
1801
1802The only interpolation is removal of C<\> from pairs C<\\>.
1803
35f2feb0 1804=item C<"">, C<``>, C<qq//>, C<qx//>, C<< <file*glob> >>
75e14d17 1805
19799a22
GS
1806C<\Q>, C<\U>, C<\u>, C<\L>, C<\l> (possibly paired with C<\E>) are
1807converted to corresponding Perl constructs. Thus, C<"$foo\Qbaz$bar">
1808is converted to C<$foo . (quotemeta("baz" . $bar))> internally.
1809The other combinations are replaced with appropriate expansions.
2a94b7ce 1810
19799a22
GS
1811Let it be stressed that I<whatever falls between C<\Q> and C<\E>>
1812is interpolated in the usual way. Something like C<"\Q\\E"> has
1813no C<\E> inside. instead, it has C<\Q>, C<\\>, and C<E>, so the
1814result is the same as for C<"\\\\E">. As a general rule, backslashes
1815between C<\Q> and C<\E> may lead to counterintuitive results. So,
1816C<"\Q\t\E"> is converted to C<quotemeta("\t")>, which is the same
1817as C<"\\\t"> (since TAB is not alphanumeric). Note also that:
2a94b7ce
IZ
1818
1819 $str = '\t';
1820 return "\Q$str";
1821
1822may be closer to the conjectural I<intention> of the writer of C<"\Q\t\E">.
1823
19799a22 1824Interpolated scalars and arrays are converted internally to the C<join> and
92d29cee 1825C<.> catenation operations. Thus, C<"$foo XXX '@arr'"> becomes:
75e14d17 1826
19799a22 1827 $foo . " XXX '" . (join $", @arr) . "'";
75e14d17 1828
19799a22 1829All operations above are performed simultaneously, left to right.
75e14d17 1830
19799a22
GS
1831Because the result of C<"\Q STRING \E"> has all metacharacters
1832quoted, there is no way to insert a literal C<$> or C<@> inside a
1833C<\Q\E> pair. If protected by C<\>, C<$> will be quoted to became
1834C<"\\\$">; if not, it is interpreted as the start of an interpolated
1835scalar.
75e14d17 1836
19799a22
GS
1837Note also that the interpolation code needs to make a decision on
1838where the interpolated scalar ends. For instance, whether
35f2feb0 1839C<< "a $b -> {c}" >> really means:
75e14d17
IZ
1840
1841 "a " . $b . " -> {c}";
1842
2a94b7ce 1843or:
75e14d17
IZ
1844
1845 "a " . $b -> {c};
1846
19799a22
GS
1847Most of the time, the longest possible text that does not include
1848spaces between components and which contains matching braces or
1849brackets. because the outcome may be determined by voting based
1850on heuristic estimators, the result is not strictly predictable.
1851Fortunately, it's usually correct for ambiguous cases.
75e14d17
IZ
1852
1853=item C<?RE?>, C</RE/>, C<m/RE/>, C<s/RE/foo/>,
1854
19799a22
GS
1855Processing of C<\Q>, C<\U>, C<\u>, C<\L>, C<\l>, and interpolation
1856happens (almost) as with C<qq//> constructs, but the substitution
1857of C<\> followed by RE-special chars (including C<\>) is not
1858performed. Moreover, inside C<(?{BLOCK})>, C<(?# comment )>, and
1859a C<#>-comment in a C<//x>-regular expression, no processing is
1860performed whatsoever. This is the first step at which the presence
1861of the C<//x> modifier is relevant.
1862
1863Interpolation has several quirks: C<$|>, C<$(>, and C<$)> are not
1864interpolated, and constructs C<$var[SOMETHING]> are voted (by several
1865different estimators) to be either an array element or C<$var>
1866followed by an RE alternative. This is where the notation
1867C<${arr[$bar]}> comes handy: C</${arr[0-9]}/> is interpreted as
1868array element C<-9>, not as a regular expression from the variable
1869C<$arr> followed by a digit, which would be the interpretation of
1870C</$arr[0-9]/>. Since voting among different estimators may occur,
1871the result is not predictable.
1872
1873It is at this step that C<\1> is begrudgingly converted to C<$1> in
1874the replacement text of C<s///> to correct the incorrigible
1875I<sed> hackers who haven't picked up the saner idiom yet. A warning
9f1b1f2d
GS
1876is emitted if the C<use warnings> pragma or the B<-w> command-line flag
1877(that is, the C<$^W> variable) was set.
19799a22
GS
1878
1879The lack of processing of C<\\> creates specific restrictions on
1880the post-processed text. If the delimiter is C</>, one cannot get
1881the combination C<\/> into the result of this step. C</> will
1882finish the regular expression, C<\/> will be stripped to C</> on
1883the previous step, and C<\\/> will be left as is. Because C</> is
1884equivalent to C<\/> inside a regular expression, this does not
1885matter unless the delimiter happens to be character special to the
1886RE engine, such as in C<s*foo*bar*>, C<m[foo]>, or C<?foo?>; or an
1887alphanumeric char, as in:
2a94b7ce
IZ
1888
1889 m m ^ a \s* b mmx;
1890
19799a22 1891In the RE above, which is intentionally obfuscated for illustration, the
2a94b7ce 1892delimiter is C<m>, the modifier is C<mx>, and after backslash-removal the
aa863641 1893RE is the same as for C<m/ ^ a \s* b /mx>. There's more than one
19799a22
GS
1894reason you're encouraged to restrict your delimiters to non-alphanumeric,
1895non-whitespace choices.
75e14d17
IZ
1896
1897=back
1898
19799a22 1899This step is the last one for all constructs except regular expressions,
75e14d17
IZ
1900which are processed further.
1901
1902=item Interpolation of regular expressions
d74e8afc 1903X<regexp, interpolation>
75e14d17 1904
19799a22
GS
1905Previous steps were performed during the compilation of Perl code,
1906but this one happens at run time--although it may be optimized to
1907be calculated at compile time if appropriate. After preprocessing
1908described above, and possibly after evaluation if catenation,
1909joining, casing translation, or metaquoting are involved, the
1910resulting I<string> is passed to the RE engine for compilation.
1911
1912Whatever happens in the RE engine might be better discussed in L<perlre>,
1913but for the sake of continuity, we shall do so here.
1914
1915This is another step where the presence of the C<//x> modifier is
1916relevant. The RE engine scans the string from left to right and
1917converts it to a finite automaton.
1918
1919Backslashed characters are either replaced with corresponding
1920literal strings (as with C<\{>), or else they generate special nodes
1921in the finite automaton (as with C<\b>). Characters special to the
1922RE engine (such as C<|>) generate corresponding nodes or groups of
1923nodes. C<(?#...)> comments are ignored. All the rest is either
1924converted to literal strings to match, or else is ignored (as is
1925whitespace and C<#>-style comments if C<//x> is present).
1926
1927Parsing of the bracketed character class construct, C<[...]>, is
1928rather different than the rule used for the rest of the pattern.
1929The terminator of this construct is found using the same rules as
1930for finding the terminator of a C<{}>-delimited construct, the only
1931exception being that C<]> immediately following C<[> is treated as
1932though preceded by a backslash. Similarly, the terminator of
1933C<(?{...})> is found using the same rules as for finding the
1934terminator of a C<{}>-delimited construct.
1935
1936It is possible to inspect both the string given to RE engine and the
1937resulting finite automaton. See the arguments C<debug>/C<debugcolor>
1938in the C<use L<re>> pragma, as well as Perl's B<-Dr> command-line
4a4eefd0 1939switch documented in L<perlrun/"Command Switches">.
75e14d17
IZ
1940
1941=item Optimization of regular expressions
d74e8afc 1942X<regexp, optimization>
75e14d17 1943
7522fed5 1944This step is listed for completeness only. Since it does not change
75e14d17 1945semantics, details of this step are not documented and are subject
19799a22
GS
1946to change without notice. This step is performed over the finite
1947automaton that was generated during the previous pass.
2a94b7ce 1948
19799a22
GS
1949It is at this stage that C<split()> silently optimizes C</^/> to
1950mean C</^/m>.
75e14d17
IZ
1951
1952=back
1953
a0d0e21e 1954=head2 I/O Operators
d74e8afc
ITB
1955X<operator, i/o> X<operator, io> X<io> X<while> X<filehandle>
1956X<< <> >> X<@ARGV>
a0d0e21e 1957
54310121 1958There are several I/O operators you should know about.
fbad3eb5 1959
7b8d334a 1960A string enclosed by backticks (grave accents) first undergoes
19799a22
GS
1961double-quote interpolation. It is then interpreted as an external
1962command, and the output of that command is the value of the
e9c56f9b
JH
1963backtick string, like in a shell. In scalar context, a single string
1964consisting of all output is returned. In list context, a list of
1965values is returned, one per line of output. (You can set C<$/> to use
1966a different line terminator.) The command is executed each time the
1967pseudo-literal is evaluated. The status value of the command is
1968returned in C<$?> (see L<perlvar> for the interpretation of C<$?>).
1969Unlike in B<csh>, no translation is done on the return data--newlines
1970remain newlines. Unlike in any of the shells, single quotes do not
1971hide variable names in the command from interpretation. To pass a
1972literal dollar-sign through to the shell you need to hide it with a
1973backslash. The generalized form of backticks is C<qx//>. (Because
1974backticks always undergo shell expansion as well, see L<perlsec> for
1975security concerns.)
d74e8afc 1976X<qx> X<`> X<``> X<backtick> X<glob>
19799a22
GS
1977
1978In scalar context, evaluating a filehandle in angle brackets yields
1979the next line from that file (the newline, if any, included), or
1980C<undef> at end-of-file or on error. When C<$/> is set to C<undef>
1981(sometimes known as file-slurp mode) and the file is empty, it
1982returns C<''> the first time, followed by C<undef> subsequently.
1983
1984Ordinarily you must assign the returned value to a variable, but
1985there is one situation where an automatic assignment happens. If
1986and only if the input symbol is the only thing inside the conditional
1987of a C<while> statement (even if disguised as a C<for(;;)> loop),
1988the value is automatically assigned to the global variable $_,
1989destroying whatever was there previously. (This may seem like an
1990odd thing to you, but you'll use the construct in almost every Perl
17b829fa 1991script you write.) The $_ variable is not implicitly localized.
19799a22
GS
1992You'll have to put a C<local $_;> before the loop if you want that
1993to happen.
1994
1995The following lines are equivalent:
a0d0e21e 1996
748a9306 1997 while (defined($_ = <STDIN>)) { print; }
7b8d334a 1998 while ($_ = <STDIN>) { print; }
a0d0e21e
LW
1999 while (<STDIN>) { print; }
2000 for (;<STDIN>;) { print; }
748a9306 2001 print while defined($_ = <STDIN>);
7b8d334a 2002 print while ($_ = <STDIN>);
a0d0e21e
LW
2003 print while <STDIN>;
2004
19799a22 2005This also behaves similarly, but avoids $_ :
7b8d334a
GS
2006
2007 while (my $line = <STDIN>) { print $line }
2008
19799a22
GS
2009In these loop constructs, the assigned value (whether assignment
2010is automatic or explicit) is then tested to see whether it is
2011defined. The defined test avoids problems where line has a string
2012value that would be treated as false by Perl, for example a "" or
2013a "0" with no trailing newline. If you really mean for such values
2014to terminate the loop, they should be tested for explicitly:
7b8d334a
GS
2015
2016 while (($_ = <STDIN>) ne '0') { ... }
2017 while (<STDIN>) { last unless $_; ... }
2018
35f2feb0 2019In other boolean contexts, C<< <I<filehandle>> >> without an
9f1b1f2d
GS
2020explicit C<defined> test or comparison elicit a warning if the
2021C<use warnings> pragma or the B<-w>
19799a22 2022command-line switch (the C<$^W> variable) is in effect.
7b8d334a 2023
5f05dabc 2024The filehandles STDIN, STDOUT, and STDERR are predefined. (The
19799a22
GS
2025filehandles C<stdin>, C<stdout>, and C<stderr> will also work except
2026in packages, where they would be interpreted as local identifiers
2027rather than global.) Additional filehandles may be created with
2028the open() function, amongst others. See L<perlopentut> and
2029L<perlfunc/open> for details on this.
d74e8afc 2030X<stdin> X<stdout> X<sterr>
a0d0e21e 2031
35f2feb0 2032If a <FILEHANDLE> is used in a context that is looking for
19799a22
GS
2033a list, a list comprising all input lines is returned, one line per
2034list element. It's easy to grow to a rather large data space this
2035way, so use with care.
a0d0e21e 2036
35f2feb0 2037<FILEHANDLE> may also be spelled C<readline(*FILEHANDLE)>.
19799a22 2038See L<perlfunc/readline>.
fbad3eb5 2039
35f2feb0
GS
2040The null filehandle <> is special: it can be used to emulate the
2041behavior of B<sed> and B<awk>. Input from <> comes either from
a0d0e21e 2042standard input, or from each file listed on the command line. Here's
35f2feb0 2043how it works: the first time <> is evaluated, the @ARGV array is
5a964f20 2044checked, and if it is empty, C<$ARGV[0]> is set to "-", which when opened
a0d0e21e
LW
2045gives you standard input. The @ARGV array is then processed as a list
2046of filenames. The loop
2047
2048 while (<>) {
2049 ... # code for each line
2050 }
2051
2052is equivalent to the following Perl-like pseudo code:
2053
3e3baf6d 2054 unshift(@ARGV, '-') unless @ARGV;
a0d0e21e
LW
2055 while ($ARGV = shift) {
2056 open(ARGV, $ARGV);
2057 while (<ARGV>) {
2058 ... # code for each line
2059 }
2060 }
2061
19799a22
GS
2062except that it isn't so cumbersome to say, and will actually work.
2063It really does shift the @ARGV array and put the current filename
2064into the $ARGV variable. It also uses filehandle I<ARGV>
35f2feb0 2065internally--<> is just a synonym for <ARGV>, which
19799a22 2066is magical. (The pseudo code above doesn't work because it treats
35f2feb0 2067<ARGV> as non-magical.)
a0d0e21e 2068
35f2feb0 2069You can modify @ARGV before the first <> as long as the array ends up
a0d0e21e 2070containing the list of filenames you really want. Line numbers (C<$.>)
19799a22
GS
2071continue as though the input were one big happy file. See the example
2072in L<perlfunc/eof> for how to reset line numbers on each file.
5a964f20
TC
2073
2074If you want to set @ARGV to your own list of files, go right ahead.
2075This sets @ARGV to all plain text files if no @ARGV was given:
2076
2077 @ARGV = grep { -f && -T } glob('*') unless @ARGV;
a0d0e21e 2078
5a964f20
TC
2079You can even set them to pipe commands. For example, this automatically
2080filters compressed arguments through B<gzip>:
2081
2082 @ARGV = map { /\.(gz|Z)$/ ? "gzip -dc < $_ |" : $_ } @ARGV;
2083
2084If you want to pass switches into your script, you can use one of the
a0d0e21e
LW
2085Getopts modules or put a loop on the front like this:
2086
2087 while ($_ = $ARGV[0], /^-/) {
2088 shift;
2089 last if /^--$/;
2090 if (/^-D(.*)/) { $debug = $1 }
2091 if (/^-v/) { $verbose++ }
5a964f20 2092 # ... # other switches
a0d0e21e 2093 }
5a964f20 2094
a0d0e21e 2095 while (<>) {
5a964f20 2096 # ... # code for each line
a0d0e21e
LW
2097 }
2098
35f2feb0 2099The <> symbol will return C<undef> for end-of-file only once.
19799a22
GS
2100If you call it again after this, it will assume you are processing another
2101@ARGV list, and if you haven't set @ARGV, will read input from STDIN.
a0d0e21e 2102
b159ebd3 2103If what the angle brackets contain is a simple scalar variable (e.g.,
35f2feb0 2104<$foo>), then that variable contains the name of the
19799a22
GS
2105filehandle to input from, or its typeglob, or a reference to the
2106same. For example:
cb1a09d0
AD
2107
2108 $fh = \*STDIN;
2109 $line = <$fh>;
a0d0e21e 2110
5a964f20
TC
2111If what's within the angle brackets is neither a filehandle nor a simple
2112scalar variable containing a filehandle name, typeglob, or typeglob
2113reference, it is interpreted as a filename pattern to be globbed, and
2114either a list of filenames or the next filename in the list is returned,
19799a22 2115depending on context. This distinction is determined on syntactic
35f2feb0
GS
2116grounds alone. That means C<< <$x> >> is always a readline() from
2117an indirect handle, but C<< <$hash{key}> >> is always a glob().
5a964f20 2118That's because $x is a simple scalar variable, but C<$hash{key}> is
ef191992
YST
2119not--it's a hash element. Even C<< <$x > >> (note the extra space)
2120is treated as C<glob("$x ")>, not C<readline($x)>.
5a964f20
TC
2121
2122One level of double-quote interpretation is done first, but you can't
35f2feb0 2123say C<< <$foo> >> because that's an indirect filehandle as explained
5a964f20
TC
2124in the previous paragraph. (In older versions of Perl, programmers
2125would insert curly brackets to force interpretation as a filename glob:
35f2feb0 2126C<< <${foo}> >>. These days, it's considered cleaner to call the
5a964f20 2127internal function directly as C<glob($foo)>, which is probably the right
19799a22 2128way to have done it in the first place.) For example:
a0d0e21e
LW
2129
2130 while (<*.c>) {
2131 chmod 0644, $_;
2132 }
2133
3a4b19e4 2134is roughly equivalent to:
a0d0e21e
LW
2135
2136 open(FOO, "echo *.c | tr -s ' \t\r\f' '\\012\\012\\012\\012'|");
2137 while (<FOO>) {
5b3eff12 2138 chomp;
a0d0e21e
LW
2139 chmod 0644, $_;
2140 }
2141
3a4b19e4
GS
2142except that the globbing is actually done internally using the standard
2143C<File::Glob> extension. Of course, the shortest way to do the above is:
a0d0e21e
LW
2144
2145 chmod 0644, <*.c>;
2146
19799a22
GS
2147A (file)glob evaluates its (embedded) argument only when it is
2148starting a new list. All values must be read before it will start
2149over. In list context, this isn't important because you automatically
2150get them all anyway. However, in scalar context the operator returns
069e01df 2151the next value each time it's called, or C<undef> when the list has
19799a22
GS
2152run out. As with filehandle reads, an automatic C<defined> is
2153generated when the glob occurs in the test part of a C<while>,
2154because legal glob returns (e.g. a file called F<0>) would otherwise
2155terminate the loop. Again, C<undef> is returned only once. So if
2156you're expecting a single value from a glob, it is much better to
2157say
4633a7c4
LW
2158
2159 ($file) = <blurch*>;
2160
2161than
2162
2163 $file = <blurch*>;
2164
2165because the latter will alternate between returning a filename and
19799a22 2166returning false.
4633a7c4 2167
b159ebd3 2168If you're trying to do variable interpolation, it's definitely better
4633a7c4 2169to use the glob() function, because the older notation can cause people
e37d713d 2170to become confused with the indirect filehandle notation.
4633a7c4
LW
2171
2172 @files = glob("$dir/*.[ch]");
2173 @files = glob($files[$i]);
2174
a0d0e21e 2175=head2 Constant Folding
d74e8afc 2176X<constant folding> X<folding>
a0d0e21e
LW
2177
2178Like C, Perl does a certain amount of expression evaluation at
19799a22 2179compile time whenever it determines that all arguments to an
a0d0e21e
LW
2180operator are static and have no side effects. In particular, string
2181concatenation happens at compile time between literals that don't do
19799a22 2182variable substitution. Backslash interpolation also happens at
a0d0e21e
LW
2183compile time. You can say
2184
2185 'Now is the time for all' . "\n" .
2186 'good men to come to.'
2187
54310121 2188and this all reduces to one string internally. Likewise, if
a0d0e21e
LW
2189you say
2190
2191 foreach $file (@filenames) {
5a964f20 2192 if (-s $file > 5 + 100 * 2**16) { }
54310121 2193 }
a0d0e21e 2194
19799a22
GS
2195the compiler will precompute the number which that expression
2196represents so that the interpreter won't have to.
a0d0e21e 2197
fd1abbef 2198=head2 No-ops
d74e8afc 2199X<no-op> X<nop>
fd1abbef
DN
2200
2201Perl doesn't officially have a no-op operator, but the bare constants
2202C<0> and C<1> are special-cased to not produce a warning in a void
2203context, so you can for example safely do
2204
2205 1 while foo();
2206
2c268ad5 2207=head2 Bitwise String Operators
d74e8afc 2208X<operator, bitwise, string>
2c268ad5
TP
2209
2210Bitstrings of any size may be manipulated by the bitwise operators
2211(C<~ | & ^>).
2212
19799a22
GS
2213If the operands to a binary bitwise op are strings of different
2214sizes, B<|> and B<^> ops act as though the shorter operand had
2215additional zero bits on the right, while the B<&> op acts as though
2216the longer operand were truncated to the length of the shorter.
2217The granularity for such extension or truncation is one or more
2218bytes.
2c268ad5
TP
2219
2220 # ASCII-based examples
2221 print "j p \n" ^ " a h"; # prints "JAPH\n"
2222 print "JA" | " ph\n"; # prints "japh\n"
2223 print "japh\nJunk" & '_____'; # prints "JAPH\n";
2224 print 'p N$' ^ " E<H\n"; # prints "Perl\n";
2225
19799a22 2226If you are intending to manipulate bitstrings, be certain that
2c268ad5 2227you're supplying bitstrings: If an operand is a number, that will imply
19799a22 2228a B<numeric> bitwise operation. You may explicitly show which type of
2c268ad5
TP
2229operation you intend by using C<""> or C<0+>, as in the examples below.
2230
4358a253
SS
2231 $foo = 150 | 105; # yields 255 (0x96 | 0x69 is 0xFF)
2232 $foo = '150' | 105; # yields 255
2c268ad5
TP
2233 $foo = 150 | '105'; # yields 255
2234 $foo = '150' | '105'; # yields string '155' (under ASCII)
2235
2236 $baz = 0+$foo & 0+$bar; # both ops explicitly numeric
2237 $biz = "$foo" ^ "$bar"; # both ops explicitly stringy
a0d0e21e 2238
1ae175c8
GS
2239See L<perlfunc/vec> for information on how to manipulate individual bits
2240in a bit vector.
2241
55497cff 2242=head2 Integer Arithmetic
d74e8afc 2243X<integer>
a0d0e21e 2244
19799a22 2245By default, Perl assumes that it must do most of its arithmetic in
a0d0e21e
LW
2246floating point. But by saying
2247
2248 use integer;
2249
2250you may tell the compiler that it's okay to use integer operations
19799a22
GS
2251(if it feels like it) from here to the end of the enclosing BLOCK.
2252An inner BLOCK may countermand this by saying
a0d0e21e
LW
2253
2254 no integer;
2255
19799a22
GS
2256which lasts until the end of that BLOCK. Note that this doesn't
2257mean everything is only an integer, merely that Perl may use integer
2258operations if it is so inclined. For example, even under C<use
2259integer>, if you take the C<sqrt(2)>, you'll still get C<1.4142135623731>
2260or so.
2261
2262Used on numbers, the bitwise operators ("&", "|", "^", "~", "<<",
13a2d996
SP
2263and ">>") always produce integral results. (But see also
2264L<Bitwise String Operators>.) However, C<use integer> still has meaning for
19799a22
GS
2265them. By default, their results are interpreted as unsigned integers, but
2266if C<use integer> is in effect, their results are interpreted
2267as signed integers. For example, C<~0> usually evaluates to a large
0be96356 2268integral value. However, C<use integer; ~0> is C<-1> on two's-complement
19799a22 2269machines.
68dc0745 2270
2271=head2 Floating-point Arithmetic
d74e8afc 2272X<floating-point> X<floating point> X<float> X<real>
68dc0745 2273
2274While C<use integer> provides integer-only arithmetic, there is no
19799a22
GS
2275analogous mechanism to provide automatic rounding or truncation to a
2276certain number of decimal places. For rounding to a certain number
2277of digits, sprintf() or printf() is usually the easiest route.
2278See L<perlfaq4>.
68dc0745 2279
5a964f20
TC
2280Floating-point numbers are only approximations to what a mathematician
2281would call real numbers. There are infinitely more reals than floats,
2282so some corners must be cut. For example:
2283
2284 printf "%.20g\n", 123456789123456789;
2285 # produces 123456789123456784
2286
2287Testing for exact equality of floating-point equality or inequality is
2288not a good idea. Here's a (relatively expensive) work-around to compare
2289whether two floating-point numbers are equal to a particular number of
2290decimal places. See Knuth, volume II, for a more robust treatment of
2291this topic.
2292
2293 sub fp_equal {
2294 my ($X, $Y, $POINTS) = @_;
2295 my ($tX, $tY);
2296 $tX = sprintf("%.${POINTS}g", $X);
2297 $tY = sprintf("%.${POINTS}g", $Y);
2298 return $tX eq $tY;
2299 }
2300
68dc0745 2301The POSIX module (part of the standard perl distribution) implements
19799a22
GS
2302ceil(), floor(), and other mathematical and trigonometric functions.
2303The Math::Complex module (part of the standard perl distribution)
2304defines mathematical functions that work on both the reals and the
2305imaginary numbers. Math::Complex not as efficient as POSIX, but
68dc0745 2306POSIX can't work with complex numbers.
2307
2308Rounding in financial applications can have serious implications, and
2309the rounding method used should be specified precisely. In these
2310cases, it probably pays not to trust whichever system rounding is
2311being used by Perl, but to instead implement the rounding function you
2312need yourself.
5a964f20
TC
2313
2314=head2 Bigger Numbers
d74e8afc 2315X<number, arbitrary precision>
5a964f20
TC
2316
2317The standard Math::BigInt and Math::BigFloat modules provide
19799a22 2318variable-precision arithmetic and overloaded operators, although
cd5c4fce 2319they're currently pretty slow. At the cost of some space and
19799a22
GS
2320considerable speed, they avoid the normal pitfalls associated with
2321limited-precision representations.
5a964f20
TC
2322
2323 use Math::BigInt;
2324 $x = Math::BigInt->new('123456789123456789');
2325 print $x * $x;
2326
2327 # prints +15241578780673678515622620750190521
19799a22 2328
cd5c4fce
T
2329There are several modules that let you calculate with (bound only by
2330memory and cpu-time) unlimited or fixed precision. There are also
2331some non-standard modules that provide faster implementations via
2332external C libraries.
2333
2334Here is a short, but incomplete summary:
2335
2336 Math::Fraction big, unlimited fractions like 9973 / 12967
2337 Math::String treat string sequences like numbers
2338 Math::FixedPrecision calculate with a fixed precision
2339 Math::Currency for currency calculations
2340 Bit::Vector manipulate bit vectors fast (uses C)
2341 Math::BigIntFast Bit::Vector wrapper for big numbers
2342 Math::Pari provides access to the Pari C library
2343 Math::BigInteger uses an external C library
2344 Math::Cephes uses external Cephes C library (no big numbers)
2345 Math::Cephes::Fraction fractions via the Cephes library
2346 Math::GMP another one using an external C library
2347
2348Choose wisely.
16070b82
GS
2349
2350=cut