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