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