source: for-distributions/trunk/bin/windows/perl/lib/Pod/perlop.pod@ 14489

Last change on this file since 14489 was 14489, checked in by oranfry, 17 years ago

upgrading to perl 5.8

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