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