[perl5.004_71] Patch: change MakeMaker default compress --> gzip
[p5sagit/p5-mst-13.2.git] / pod / perlop.pod
CommitLineData
a0d0e21e 1=head1 NAME
2
3perlop - Perl operators and precedence
4
5=head1 SYNOPSIS
6
7Perl operators have the following associativity and precedence,
8listed from highest precedence to lowest. Note that all operators
9borrowed from C keep the same precedence relationship with each other,
10even where C's precedence is slightly screwy. (This makes learning
54310121 11Perl easier for C folks.) With very few exceptions, these all
c07a80fd 12operate on scalar values only, not array values.
a0d0e21e 13
14 left terms and list operators (leftward)
15 left ->
16 nonassoc ++ --
17 right **
18 right ! ~ \ and unary + and -
54310121 19 left =~ !~
a0d0e21e 20 left * / % x
21 left + - .
22 left << >>
23 nonassoc named unary operators
24 nonassoc < > <= >= lt gt le ge
25 nonassoc == != <=> eq ne cmp
26 left &
27 left | ^
28 left &&
29 left ||
137443ea 30 nonassoc .. ...
a0d0e21e 31 right ?:
32 right = += -= *= etc.
33 left , =>
34 nonassoc list operators (rightward)
a5f75d66 35 right not
a0d0e21e 36 left and
37 left or xor
38
39In the following sections, these operators are covered in precedence order.
40
5a964f20 41Many operators can be overloaded for objects. See L<overload>.
42
cb1a09d0 43=head1 DESCRIPTION
a0d0e21e 44
45=head2 Terms and List Operators (Leftward)
46
54310121 47A TERM has the highest precedence in Perl. They includes variables,
5f05dabc 48quote and quote-like operators, any expression in parentheses,
a0d0e21e 49and any function whose arguments are parenthesized. Actually, there
50aren't really functions in this sense, just list operators and unary
51operators behaving as functions because you put parentheses around
52the arguments. These are all documented in L<perlfunc>.
53
54If any list operator (print(), etc.) or any unary operator (chdir(), etc.)
55is followed by a left parenthesis as the next token, the operator and
56arguments within parentheses are taken to be of highest precedence,
57just like a normal function call.
58
59In the absence of parentheses, the precedence of list operators such as
60C<print>, C<sort>, or C<chmod> is either very high or very low depending on
54310121 61whether you are looking at the left side or the right side of the operator.
a0d0e21e 62For example, in
63
64 @ary = (1, 3, sort 4, 2);
65 print @ary; # prints 1324
66
67the commas on the right of the sort are evaluated before the sort, but
68the commas on the left are evaluated after. In other words, list
69operators tend to gobble up all the arguments that follow them, and
70then act like a simple TERM with regard to the preceding expression.
5f05dabc 71Note that you have to be careful with parentheses:
a0d0e21e 72
73 # These evaluate exit before doing the print:
74 print($foo, exit); # Obviously not what you want.
75 print $foo, exit; # Nor is this.
76
77 # These do the print before evaluating exit:
78 (print $foo), exit; # This is what you want.
79 print($foo), exit; # Or this.
80 print ($foo), exit; # Or even this.
81
82Also note that
83
84 print ($foo & 255) + 1, "\n";
85
54310121 86probably doesn't do what you expect at first glance. See
a0d0e21e 87L<Named Unary Operators> for more discussion of this.
88
89Also parsed as terms are the C<do {}> and C<eval {}> constructs, as
54310121 90well as subroutine and method calls, and the anonymous
a0d0e21e 91constructors C<[]> and C<{}>.
92
2ae324a7 93See also L<Quote and Quote-like Operators> toward the end of this section,
c07a80fd 94as well as L<"I/O Operators">.
a0d0e21e 95
96=head2 The Arrow Operator
97
98Just as in C and C++, "C<-E<gt>>" is an infix dereference operator. If the
99right side is either a C<[...]> or C<{...}> subscript, then the left side
100must be either a hard or symbolic reference to an array or hash (or
101a location capable of holding a hard reference, if it's an lvalue (assignable)).
102See L<perlref>.
103
104Otherwise, the right side is a method name or a simple scalar variable
105containing the method name, and the left side must either be an object
106(a blessed reference) or a class name (that is, a package name).
107See L<perlobj>.
108
5f05dabc 109=head2 Auto-increment and Auto-decrement
a0d0e21e 110
111"++" and "--" work as in C. That is, if placed before a variable, they
112increment or decrement the variable before returning the value, and if
113placed after, increment or decrement the variable after returning the value.
114
54310121 115The auto-increment operator has a little extra builtin magic to it. If
a0d0e21e 116you increment a variable that is numeric, or that has ever been used in
117a numeric context, you get a normal increment. If, however, the
5f05dabc 118variable has been used in only string contexts since it was set, and
5a964f20 119has a value that is not the empty string and matches the pattern
a0d0e21e 120C</^[a-zA-Z]*[0-9]*$/>, the increment is done as a string, preserving each
121character within its range, with carry:
122
123 print ++($foo = '99'); # prints '100'
124 print ++($foo = 'a0'); # prints 'a1'
125 print ++($foo = 'Az'); # prints 'Ba'
126 print ++($foo = 'zz'); # prints 'aaa'
127
5f05dabc 128The auto-decrement operator is not magical.
a0d0e21e 129
130=head2 Exponentiation
131
132Binary "**" is the exponentiation operator. Note that it binds even more
cb1a09d0 133tightly than unary minus, so -2**4 is -(2**4), not (-2)**4. (This is
134implemented using C's pow(3) function, which actually works on doubles
135internally.)
a0d0e21e 136
137=head2 Symbolic Unary Operators
138
5f05dabc 139Unary "!" performs logical negation, i.e., "not". See also C<not> for a lower
a0d0e21e 140precedence version of this.
141
142Unary "-" performs arithmetic negation if the operand is numeric. If
143the operand is an identifier, a string consisting of a minus sign
144concatenated with the identifier is returned. Otherwise, if the string
145starts with a plus or minus, a string starting with the opposite sign
146is returned. One effect of these rules is that C<-bareword> is equivalent
147to C<"-bareword">.
148
5a964f20 149Unary "~" performs bitwise negation, i.e., 1's complement. For example,
150C<0666 &~ 027> is 0640. (See also L<Integer Arithmetic> and L<Bitwise
151String Operators>.)
a0d0e21e 152
153Unary "+" has no effect whatsoever, even on strings. It is useful
154syntactically for separating a function name from a parenthesized expression
155that would otherwise be interpreted as the complete list of function
5ba421f6 156arguments. (See examples above under L<Terms and List Operators (Leftward)>.)
a0d0e21e 157
158Unary "\" creates a reference to whatever follows it. See L<perlref>.
159Do not confuse this behavior with the behavior of backslash within a
160string, although both forms do convey the notion of protecting the next
161thing from interpretation.
162
163=head2 Binding Operators
164
c07a80fd 165Binary "=~" binds a scalar expression to a pattern match. Certain operations
cb1a09d0 166search or modify the string $_ by default. This operator makes that kind
167of operation work on some other string. The right argument is a search
2c268ad5 168pattern, substitution, or transliteration. The left argument is what is
169supposed to be searched, substituted, or transliterated instead of the default
cb1a09d0 170$_. The return value indicates the success of the operation. (If the
171right argument is an expression rather than a search pattern,
2c268ad5 172substitution, or transliteration, it is interpreted as a search pattern at run
aa689395 173time. This can be is less efficient than an explicit search, because the
174pattern must be compiled every time the expression is evaluated.
a0d0e21e 175
176Binary "!~" is just like "=~" except the return value is negated in
177the logical sense.
178
179=head2 Multiplicative Operators
180
181Binary "*" multiplies two numbers.
182
183Binary "/" divides two numbers.
184
54310121 185Binary "%" computes the modulus of two numbers. Given integer
186operands C<$a> and C<$b>: If C<$b> is positive, then C<$a % $b> is
187C<$a> minus the largest multiple of C<$b> that is not greater than
188C<$a>. If C<$b> is negative, then C<$a % $b> is C<$a> minus the
189smallest multiple of C<$b> that is not less than C<$a> (i.e. the
5a964f20 190result will be less than or equal to zero). If C<use integer> is
191in effect, the native hardware will be used instead of this rule,
192which may be construed a bug that will be fixed at some point.
a0d0e21e 193
5a964f20 194Note than when C<use integer> is in scope, "%" give you direct access
55d729e4 195to the modulus operator as implemented by your C compiler. This
196operator is not as well defined for negative operands, but it will
197execute faster.
198
5a964f20 199Binary "x" is the repetition operator. In scalar context, it
a0d0e21e 200returns a string consisting of the left operand repeated the number of
5a964f20 201times specified by the right operand. In list context, if the left
5f05dabc 202operand is a list in parentheses, it repeats the list.
a0d0e21e 203
204 print '-' x 80; # print row of dashes
205
206 print "\t" x ($tab/8), ' ' x ($tab%8); # tab over
207
208 @ones = (1) x 80; # a list of 80 1's
209 @ones = (5) x @ones; # set all elements to 5
210
211
212=head2 Additive Operators
213
214Binary "+" returns the sum of two numbers.
215
216Binary "-" returns the difference of two numbers.
217
218Binary "." concatenates two strings.
219
220=head2 Shift Operators
221
55497cff 222Binary "<<" returns the value of its left argument shifted left by the
223number of bits specified by the right argument. Arguments should be
224integers. (See also L<Integer Arithmetic>.)
a0d0e21e 225
55497cff 226Binary ">>" returns the value of its left argument shifted right by
227the number of bits specified by the right argument. Arguments should
228be integers. (See also L<Integer Arithmetic>.)
a0d0e21e 229
230=head2 Named Unary Operators
231
232The various named unary operators are treated as functions with one
233argument, with optional parentheses. These include the filetest
234operators, like C<-f>, C<-M>, etc. See L<perlfunc>.
235
236If any list operator (print(), etc.) or any unary operator (chdir(), etc.)
237is followed by a left parenthesis as the next token, the operator and
238arguments within parentheses are taken to be of highest precedence,
239just like a normal function call. Examples:
240
241 chdir $foo || die; # (chdir $foo) || die
242 chdir($foo) || die; # (chdir $foo) || die
243 chdir ($foo) || die; # (chdir $foo) || die
244 chdir +($foo) || die; # (chdir $foo) || die
245
246but, because * is higher precedence than ||:
247
248 chdir $foo * 20; # chdir ($foo * 20)
249 chdir($foo) * 20; # (chdir $foo) * 20
250 chdir ($foo) * 20; # (chdir $foo) * 20
251 chdir +($foo) * 20; # chdir ($foo * 20)
252
253 rand 10 * 20; # rand (10 * 20)
254 rand(10) * 20; # (rand 10) * 20
255 rand (10) * 20; # (rand 10) * 20
256 rand +(10) * 20; # rand (10 * 20)
257
5ba421f6 258See also L<"Terms and List Operators (Leftward)">.
a0d0e21e 259
260=head2 Relational Operators
261
6ee5d4e7 262Binary "E<lt>" returns true if the left argument is numerically less than
a0d0e21e 263the right argument.
264
6ee5d4e7 265Binary "E<gt>" returns true if the left argument is numerically greater
a0d0e21e 266than the right argument.
267
6ee5d4e7 268Binary "E<lt>=" returns true if the left argument is numerically less than
a0d0e21e 269or equal to the right argument.
270
6ee5d4e7 271Binary "E<gt>=" returns true if the left argument is numerically greater
a0d0e21e 272than or equal to the right argument.
273
274Binary "lt" returns true if the left argument is stringwise less than
275the right argument.
276
277Binary "gt" returns true if the left argument is stringwise greater
278than the right argument.
279
280Binary "le" returns true if the left argument is stringwise less than
281or equal to the right argument.
282
283Binary "ge" returns true if the left argument is stringwise greater
284than or equal to the right argument.
285
286=head2 Equality Operators
287
288Binary "==" returns true if the left argument is numerically equal to
289the right argument.
290
291Binary "!=" returns true if the left argument is numerically not equal
292to the right argument.
293
6ee5d4e7 294Binary "E<lt>=E<gt>" returns -1, 0, or 1 depending on whether the left
295argument is numerically less than, equal to, or greater than the right
296argument.
a0d0e21e 297
298Binary "eq" returns true if the left argument is stringwise equal to
299the right argument.
300
301Binary "ne" returns true if the left argument is stringwise not equal
302to the right argument.
303
304Binary "cmp" returns -1, 0, or 1 depending on whether the left argument is stringwise
305less than, equal to, or greater than the right argument.
306
a034a98d 307"lt", "le", "ge", "gt" and "cmp" use the collation (sort) order specified
308by the current locale if C<use locale> is in effect. See L<perllocale>.
309
a0d0e21e 310=head2 Bitwise And
311
312Binary "&" returns its operators ANDed together bit by bit.
2c268ad5 313(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 314
315=head2 Bitwise Or and Exclusive Or
316
317Binary "|" returns its operators ORed together bit by bit.
2c268ad5 318(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 319
320Binary "^" returns its operators XORed together bit by bit.
2c268ad5 321(See also L<Integer Arithmetic> and L<Bitwise String Operators>.)
a0d0e21e 322
323=head2 C-style Logical And
324
325Binary "&&" performs a short-circuit logical AND operation. That is,
326if the left operand is false, the right operand is not even evaluated.
327Scalar or list context propagates down to the right operand if it
328is evaluated.
329
330=head2 C-style Logical Or
331
332Binary "||" performs a short-circuit logical OR operation. That is,
333if the left operand is true, the right operand is not even evaluated.
334Scalar or list context propagates down to the right operand if it
335is evaluated.
336
337The C<||> and C<&&> operators differ from C's in that, rather than returning
3380 or 1, they return the last value evaluated. Thus, a reasonably portable
339way to find out the home directory (assuming it's not "0") might be:
340
341 $home = $ENV{'HOME'} || $ENV{'LOGDIR'} ||
342 (getpwuid($<))[7] || die "You're homeless!\n";
343
5a964f20 344In particular, this means that you shouldn't use this
345for selecting between two aggregates for assignment:
346
347 @a = @b || @c; # this is wrong
348 @a = scalar(@b) || @c; # really meant this
349 @a = @b ? @b : @c; # this works fine, though
350
351As more readable alternatives to C<&&> and C<||> when used for
352control flow, Perl provides C<and> and C<or> operators (see below).
353The short-circuit behavior is identical. The precedence of "and" and
354"or" is much lower, however, so that you can safely use them after a
355list operator without the need for parentheses:
a0d0e21e 356
357 unlink "alpha", "beta", "gamma"
358 or gripe(), next LINE;
359
360With the C-style operators that would have been written like this:
361
362 unlink("alpha", "beta", "gamma")
363 || (gripe(), next LINE);
364
5a964f20 365Use "or" for assignment is unlikely to do what you want; see below.
366
367=head2 Range Operators
a0d0e21e 368
369Binary ".." is the range operator, which is really two different
5a964f20 370operators depending on the context. In list context, it returns an
a0d0e21e 371array of values counting (by ones) from the left value to the right
89ea2908 372value. This is useful for writing C<foreach (1..10)> loops and for
373doing slice operations on arrays. In the current implementation, no
374temporary array is created when the range operator is used as the
375expression in C<foreach> loops, but older versions of Perl might burn
376a lot of memory when you write something like this:
a0d0e21e 377
378 for (1 .. 1_000_000) {
379 # code
54310121 380 }
a0d0e21e 381
5a964f20 382In scalar context, ".." returns a boolean value. The operator is
a0d0e21e 383bistable, like a flip-flop, and emulates the line-range (comma) operator
384of B<sed>, B<awk>, and various editors. Each ".." operator maintains its
385own boolean state. It is false as long as its left operand is false.
386Once the left operand is true, the range operator stays true until the
387right operand is true, I<AFTER> which the range operator becomes false
388again. (It doesn't become false till the next time the range operator is
389evaluated. It can test the right operand and become false on the same
390evaluation it became true (as in B<awk>), but it still returns true once.
391If you don't want it to test the right operand till the next evaluation
392(as in B<sed>), use three dots ("...") instead of two.) The right
393operand is not evaluated while the operator is in the "false" state, and
394the left operand is not evaluated while the operator is in the "true"
395state. The precedence is a little lower than || and &&. The value
5a964f20 396returned is either the empty string for false, or a sequence number
a0d0e21e 397(beginning with 1) for true. The sequence number is reset for each range
398encountered. The final sequence number in a range has the string "E0"
399appended to it, which doesn't affect its numeric value, but gives you
400something to search for if you want to exclude the endpoint. You can
401exclude the beginning point by waiting for the sequence number to be
0a528a35 402greater than 1. If either operand of scalar ".." is a constant expression,
a0d0e21e 403that operand is implicitly compared to the C<$.> variable, the current
404line number. Examples:
405
406As a scalar operator:
407
408 if (101 .. 200) { print; } # print 2nd hundred lines
409 next line if (1 .. /^$/); # skip header lines
410 s/^/> / if (/^$/ .. eof()); # quote body
411
5a964f20 412 # parse mail messages
413 while (<>) {
414 $in_header = 1 .. /^$/;
415 $in_body = /^$/ .. eof();
416 # do something based on those
417 } continue {
418 close ARGV if eof; # reset $. each file
419 }
420
a0d0e21e 421As a list operator:
422
423 for (101 .. 200) { print; } # print $_ 100 times
3e3baf6d 424 @foo = @foo[0 .. $#foo]; # an expensive no-op
a0d0e21e 425 @foo = @foo[$#foo-4 .. $#foo]; # slice last 5 items
426
5a964f20 427The range operator (in list context) makes use of the magical
5f05dabc 428auto-increment algorithm if the operands are strings. You
a0d0e21e 429can say
430
431 @alphabet = ('A' .. 'Z');
432
433to get all the letters of the alphabet, or
434
435 $hexdigit = (0 .. 9, 'a' .. 'f')[$num & 15];
436
437to get a hexadecimal digit, or
438
439 @z2 = ('01' .. '31'); print $z2[$mday];
440
441to get dates with leading zeros. If the final value specified is not
442in the sequence that the magical increment would produce, the sequence
443goes until the next value would be longer than the final value
444specified.
445
446=head2 Conditional Operator
447
448Ternary "?:" is the conditional operator, just as in C. It works much
449like an if-then-else. If the argument before the ? is true, the
450argument before the : is returned, otherwise the argument after the :
cb1a09d0 451is returned. For example:
452
54310121 453 printf "I have %d dog%s.\n", $n,
cb1a09d0 454 ($n == 1) ? '' : "s";
455
456Scalar or list context propagates downward into the 2nd
54310121 457or 3rd argument, whichever is selected.
cb1a09d0 458
459 $a = $ok ? $b : $c; # get a scalar
460 @a = $ok ? @b : @c; # get an array
461 $a = $ok ? @b : @c; # oops, that's just a count!
462
463The operator may be assigned to if both the 2nd and 3rd arguments are
464legal lvalues (meaning that you can assign to them):
a0d0e21e 465
466 ($a_or_b ? $a : $b) = $c;
467
cb1a09d0 468This is not necessarily guaranteed to contribute to the readability of your program.
a0d0e21e 469
5a964f20 470Because this operator produces an assignable result, using assignments
471without parentheses will get you in trouble. For example, this:
472
473 $a % 2 ? $a += 10 : $a += 2
474
475Really means this:
476
477 (($a % 2) ? ($a += 10) : $a) += 2
478
479Rather than this:
480
481 ($a % 2) ? ($a += 10) : ($a += 2)
482
4633a7c4 483=head2 Assignment Operators
a0d0e21e 484
485"=" is the ordinary assignment operator.
486
487Assignment operators work as in C. That is,
488
489 $a += 2;
490
491is equivalent to
492
493 $a = $a + 2;
494
495although without duplicating any side effects that dereferencing the lvalue
54310121 496might trigger, such as from tie(). Other assignment operators work similarly.
497The following are recognized:
a0d0e21e 498
499 **= += *= &= <<= &&=
500 -= /= |= >>= ||=
501 .= %= ^=
502 x=
503
504Note that while these are grouped by family, they all have the precedence
505of assignment.
506
507Unlike in C, the assignment operator produces a valid lvalue. Modifying
508an assignment is equivalent to doing the assignment and then modifying
509the variable that was assigned to. This is useful for modifying
510a copy of something, like this:
511
512 ($tmp = $global) =~ tr [A-Z] [a-z];
513
514Likewise,
515
516 ($a += 2) *= 3;
517
518is equivalent to
519
520 $a += 2;
521 $a *= 3;
522
748a9306 523=head2 Comma Operator
a0d0e21e 524
5a964f20 525Binary "," is the comma operator. In scalar context it evaluates
a0d0e21e 526its left argument, throws that value away, then evaluates its right
527argument and returns that value. This is just like C's comma operator.
528
5a964f20 529In list context, it's just the list argument separator, and inserts
a0d0e21e 530both its arguments into the list.
531
6ee5d4e7 532The =E<gt> digraph is mostly just a synonym for the comma operator. It's useful for
cb1a09d0 533documenting arguments that come in pairs. As of release 5.001, it also forces
4633a7c4 534any word to the left of it to be interpreted as a string.
748a9306 535
a0d0e21e 536=head2 List Operators (Rightward)
537
538On the right side of a list operator, it has very low precedence,
539such that it controls all comma-separated expressions found there.
540The only operators with lower precedence are the logical operators
541"and", "or", and "not", which may be used to evaluate calls to list
542operators without the need for extra parentheses:
543
544 open HANDLE, "filename"
545 or die "Can't open: $!\n";
546
5ba421f6 547See also discussion of list operators in L<Terms and List Operators (Leftward)>.
a0d0e21e 548
549=head2 Logical Not
550
551Unary "not" returns the logical negation of the expression to its right.
552It's the equivalent of "!" except for the very low precedence.
553
554=head2 Logical And
555
556Binary "and" returns the logical conjunction of the two surrounding
557expressions. It's equivalent to && except for the very low
5f05dabc 558precedence. This means that it short-circuits: i.e., the right
a0d0e21e 559expression is evaluated only if the left expression is true.
560
561=head2 Logical or and Exclusive Or
562
563Binary "or" returns the logical disjunction of the two surrounding
5a964f20 564expressions. It's equivalent to || except for the very low precedence.
565This makes it useful for control flow
566
567 print FH $data or die "Can't write to FH: $!";
568
569This means that it short-circuits: i.e., the right expression is evaluated
570only if the left expression is false. Due to its precedence, you should
571probably avoid using this for assignment, only for control flow.
572
573 $a = $b or $c; # bug: this is wrong
574 ($a = $b) or $c; # really means this
575 $a = $b || $c; # better written this way
576
577However, when it's a list context assignment and you're trying to use
578"||" for control flow, you probably need "or" so that the assignment
579takes higher precedence.
580
581 @info = stat($file) || die; # oops, scalar sense of stat!
582 @info = stat($file) or die; # better, now @info gets its due
583
584Then again, you could always use parentheses.
a0d0e21e 585
586Binary "xor" returns the exclusive-OR of the two surrounding expressions.
587It cannot short circuit, of course.
588
589=head2 C Operators Missing From Perl
590
591Here is what C has that Perl doesn't:
592
593=over 8
594
595=item unary &
596
597Address-of operator. (But see the "\" operator for taking a reference.)
598
599=item unary *
600
54310121 601Dereference-address operator. (Perl's prefix dereferencing
a0d0e21e 602operators are typed: $, @, %, and &.)
603
604=item (TYPE)
605
54310121 606Type casting operator.
a0d0e21e 607
608=back
609
5f05dabc 610=head2 Quote and Quote-like Operators
a0d0e21e 611
612While we usually think of quotes as literal values, in Perl they
613function as operators, providing various kinds of interpolating and
614pattern matching capabilities. Perl provides customary quote characters
615for these behaviors, but also provides a way for you to choose your
616quote character for any of them. In the following table, a C<{}> represents
617any pair of delimiters you choose. Non-bracketing delimiters use
54310121 618the same character fore and aft, but the 4 sorts of brackets
a0d0e21e 619(round, angle, square, curly) will all nest.
620
2c268ad5 621 Customary Generic Meaning Interpolates
622 '' q{} Literal no
623 "" qq{} Literal yes
01ae956f 624 `` qx{} Command yes (unless '' is delimiter)
2c268ad5 625 qw{} Word list no
626 // m{} Pattern match yes
627 s{}{} Substitution yes
628 tr{}{} Transliteration no (but see below)
a0d0e21e 629
fb73857a 630Note that there can be whitespace between the operator and the quoting
631characters, except when C<#> is being used as the quoting character.
a3cb178b 632C<q#foo#> is parsed as being the string C<foo>, while C<q #foo#> is the
fb73857a 633operator C<q> followed by a comment. Its argument will be taken from the
634next line. This allows you to write:
635
636 s {foo} # Replace foo
637 {bar} # with bar.
638
2c268ad5 639For constructs that do interpolation, variables beginning with "C<$>"
640or "C<@>" are interpolated, as are the following sequences. Within
641a transliteration, the first ten of these sequences may be used.
a0d0e21e 642
6ee5d4e7 643 \t tab (HT, TAB)
5a964f20 644 \n newline (NL)
6ee5d4e7 645 \r return (CR)
646 \f form feed (FF)
647 \b backspace (BS)
648 \a alarm (bell) (BEL)
649 \e escape (ESC)
a0d0e21e 650 \033 octal char
651 \x1b hex char
652 \c[ control char
2c268ad5 653
a0d0e21e 654 \l lowercase next char
655 \u uppercase next char
656 \L lowercase till \E
657 \U uppercase till \E
658 \E end case modification
1d2dff63 659 \Q quote non-word characters till \E
a0d0e21e 660
a034a98d 661If C<use locale> is in effect, the case map used by C<\l>, C<\L>, C<\u>
7b8d334a 662and C<\U> is taken from the current locale. See L<perllocale>.
a034a98d 663
5a964f20 664All systems use the virtual C<"\n"> to represent a line terminator,
665called a "newline". There is no such thing as an unvarying, physical
666newline character. It is an illusion that the operating system,
667device drivers, C libraries, and Perl all conspire to preserve. Not all
668systems read C<"\r"> as ASCII CR and C<"\n"> as ASCII LF. For example,
669on a Mac, these are reversed, and on systems without line terminator,
670printing C<"\n"> may emit no actual data. In general, use C<"\n"> when
671you mean a "newline" for your system, but use the literal ASCII when you
672need an exact character. For example, most networking protocols expect
673and prefer a CR+LF (C<"\012\015"> or C<"\cJ\cM">) for line terminators,
674and although they often accept just C<"\012">, they seldom tolerate just
675C<"\015">. If you get in the habit of using C<"\n"> for networking,
676you may be burned some day.
677
1d2dff63 678You cannot include a literal C<$> or C<@> within a C<\Q> sequence.
679An unescaped C<$> or C<@> interpolates the corresponding variable,
680while escaping will cause the literal string C<\$> to be inserted.
681You'll need to write something like C<m/\Quser\E\@\Qhost/>.
682
a0d0e21e 683Patterns are subject to an additional level of interpretation as a
684regular expression. This is done as a second pass, after variables are
685interpolated, so that regular expressions may be incorporated into the
686pattern from the variables. If this is not what you want, use C<\Q> to
687interpolate a variable literally.
688
689Apart from the above, there are no multiple levels of interpolation. In
5f05dabc 690particular, contrary to the expectations of shell programmers, back-quotes
a0d0e21e 691do I<NOT> interpolate within double quotes, nor do single quotes impede
692evaluation of variables when used within double quotes.
693
5f05dabc 694=head2 Regexp Quote-Like Operators
cb1a09d0 695
5f05dabc 696Here are the quote-like operators that apply to pattern
cb1a09d0 697matching and related activities.
698
75e14d17 699Most of this section is related to use of regular expressions from Perl.
700Such a use may be considered from two points of view: Perl handles a
701a string and a "pattern" to RE (regular expression) engine to match,
702RE engine finds (or does not find) the match, and Perl uses the findings
703of RE engine for its operation, possibly asking the engine for other matches.
704
705RE engine has no idea what Perl is going to do with what it finds,
706similarly, the rest of Perl has no idea what a particular regular expression
707means to RE engine. This creates a clean separation, and in this section
708we discuss matching from Perl point of view only. The other point of
709view may be found in L<perlre>.
710
a0d0e21e 711=over 8
712
713=item ?PATTERN?
714
715This is just like the C</pattern/> search, except that it matches only
716once between calls to the reset() operator. This is a useful
5f05dabc 717optimization when you want to see only the first occurrence of
a0d0e21e 718something in each file of a set of files, for instance. Only C<??>
719patterns local to the current package are reset.
720
5a964f20 721 while (<>) {
722 if (?^$?) {
723 # blank line between header and body
724 }
725 } continue {
726 reset if eof; # clear ?? status for next file
727 }
728
a0d0e21e 729This usage is vaguely deprecated, and may be removed in some future
730version of Perl.
731
fb73857a 732=item m/PATTERN/cgimosx
a0d0e21e 733
fb73857a 734=item /PATTERN/cgimosx
a0d0e21e 735
5a964f20 736Searches a string for a pattern match, and in scalar context returns
a0d0e21e 737true (1) or false (''). If no string is specified via the C<=~> or
738C<!~> operator, the $_ string is searched. (The string specified with
739C<=~> need not be an lvalue--it may be the result of an expression
740evaluation, but remember the C<=~> binds rather tightly.) See also
741L<perlre>.
5a964f20 742See L<perllocale> for discussion of additional considerations that apply
a034a98d 743when C<use locale> is in effect.
a0d0e21e 744
745Options are:
746
fb73857a 747 c Do not reset search position on a failed match when /g is in effect.
5f05dabc 748 g Match globally, i.e., find all occurrences.
a0d0e21e 749 i Do case-insensitive pattern matching.
750 m Treat string as multiple lines.
5f05dabc 751 o Compile pattern only once.
a0d0e21e 752 s Treat string as single line.
753 x Use extended regular expressions.
754
755If "/" is the delimiter then the initial C<m> is optional. With the C<m>
01ae956f 756you can use any pair of non-alphanumeric, non-whitespace characters
757as delimiters (if single quotes are used, no interpretation is done
758on the replacement string. Unlike Perl 4, Perl 5 treats backticks as normal
759delimiters; the replacement text is not evaluated as a command).
760This is particularly useful for matching Unix path names
7bac28a0 761that contain "/", to avoid LTS (leaning toothpick syndrome). If "?" is
762the delimiter, then the match-only-once rule of C<?PATTERN?> applies.
a0d0e21e 763
764PATTERN may contain variables, which will be interpolated (and the
765pattern recompiled) every time the pattern search is evaluated. (Note
766that C<$)> and C<$|> might not be interpolated because they look like
767end-of-string tests.) If you want such a pattern to be compiled only
768once, add a C</o> after the trailing delimiter. This avoids expensive
769run-time recompilations, and is useful when the value you are
770interpolating won't change over the life of the script. However, mentioning
771C</o> constitutes a promise that you won't change the variables in the pattern.
772If you change them, Perl won't even notice.
773
5a964f20 774If the PATTERN evaluates to the empty string, the last
775I<successfully> matched regular expression is used instead.
a0d0e21e 776
a2008d6d 777If the C</g> option is not used, C<m//> in a list context returns a
a0d0e21e 778list consisting of the subexpressions matched by the parentheses in the
a2008d6d 779pattern, i.e., (C<$1>, C<$2>, C<$3>...). (Note that here
780C<$1> etc. are also set, and
1d2dff63 781that this differs from Perl 4's behavior.) If there are no parentheses,
782the return value is the list C<(1)> for success or C<('')> upon failure.
783With parentheses, C<()> is returned upon failure.
a0d0e21e 784
785Examples:
786
787 open(TTY, '/dev/tty');
788 <TTY> =~ /^y/i && foo(); # do foo if desired
789
790 if (/Version: *([0-9.]*)/) { $version = $1; }
791
792 next if m#^/usr/spool/uucp#;
793
794 # poor man's grep
795 $arg = shift;
796 while (<>) {
797 print if /$arg/o; # compile only once
798 }
799
800 if (($F1, $F2, $Etc) = ($foo =~ /^(\S+)\s+(\S+)\s*(.*)/))
801
802This last example splits $foo into the first two words and the
5f05dabc 803remainder of the line, and assigns those three fields to $F1, $F2, and
804$Etc. The conditional is true if any variables were assigned, i.e., if
a0d0e21e 805the pattern matched.
806
807The C</g> modifier specifies global pattern matching--that is, matching
808as many times as possible within the string. How it behaves depends on
5a964f20 809the context. In list context, it returns a list of all the
a0d0e21e 810substrings matched by all the parentheses in the regular expression.
811If there are no parentheses, it returns a list of all the matched
812strings, as if there were parentheses around the whole pattern.
813
7e86de3e 814In scalar context, each execution of C<m//g> finds the next match,
815returning TRUE if it matches, and FALSE if there is no further match.
816The position after the last match can be read or set using the pos()
817function; see L<perlfunc/pos>. A failed match normally resets the
818search position to the beginning of the string, but you can avoid that
819by adding the C</c> modifier (e.g. C<m//gc>). Modifying the target
820string also resets the search position.
c90c0ff4 821
822You can intermix C<m//g> matches with C<m/\G.../g>, where C<\G> is a
823zero-width assertion that matches the exact position where the previous
824C<m//g>, if any, left off. The C<\G> assertion is not supported without
825the C</g> modifier; currently, without C</g>, C<\G> behaves just like
826C<\A>, but that's accidental and may change in the future.
827
828Examples:
a0d0e21e 829
830 # list context
831 ($one,$five,$fifteen) = (`uptime` =~ /(\d+\.\d+)/g);
832
833 # scalar context
5f05dabc 834 $/ = ""; $* = 1; # $* deprecated in modern perls
54310121 835 while (defined($paragraph = <>)) {
a0d0e21e 836 while ($paragraph =~ /[a-z]['")]*[.!?]+['")]*\s/g) {
837 $sentences++;
838 }
839 }
840 print "$sentences\n";
841
c90c0ff4 842 # using m//gc with \G
137443ea 843 $_ = "ppooqppqq";
44a8e56a 844 while ($i++ < 2) {
845 print "1: '";
c90c0ff4 846 print $1 while /(o)/gc; print "', pos=", pos, "\n";
44a8e56a 847 print "2: '";
c90c0ff4 848 print $1 if /\G(q)/gc; print "', pos=", pos, "\n";
44a8e56a 849 print "3: '";
c90c0ff4 850 print $1 while /(p)/gc; print "', pos=", pos, "\n";
44a8e56a 851 }
852
853The last example should print:
854
855 1: 'oo', pos=4
137443ea 856 2: 'q', pos=5
44a8e56a 857 3: 'pp', pos=7
858 1: '', pos=7
137443ea 859 2: 'q', pos=8
860 3: '', pos=8
44a8e56a 861
c90c0ff4 862A useful idiom for C<lex>-like scanners is C</\G.../gc>. You can
e7ea3e70 863combine several regexps like this to process a string part-by-part,
c90c0ff4 864doing different actions depending on which regexp matched. Each
865regexp tries to match where the previous one leaves off.
e7ea3e70 866
3fe9a6f1 867 $_ = <<'EOL';
e7ea3e70 868 $url = new URI::URL "http://www/"; die if $url eq "xXx";
3fe9a6f1 869 EOL
870 LOOP:
e7ea3e70 871 {
c90c0ff4 872 print(" digits"), redo LOOP if /\G\d+\b[,.;]?\s*/gc;
873 print(" lowercase"), redo LOOP if /\G[a-z]+\b[,.;]?\s*/gc;
874 print(" UPPERCASE"), redo LOOP if /\G[A-Z]+\b[,.;]?\s*/gc;
875 print(" Capitalized"), redo LOOP if /\G[A-Z][a-z]+\b[,.;]?\s*/gc;
876 print(" MiXeD"), redo LOOP if /\G[A-Za-z]+\b[,.;]?\s*/gc;
877 print(" alphanumeric"), redo LOOP if /\G[A-Za-z0-9]+\b[,.;]?\s*/gc;
878 print(" line-noise"), redo LOOP if /\G[^A-Za-z0-9]+/gc;
e7ea3e70 879 print ". That's all!\n";
880 }
881
882Here is the output (split into several lines):
883
884 line-noise lowercase line-noise lowercase UPPERCASE line-noise
885 UPPERCASE line-noise lowercase line-noise lowercase line-noise
886 lowercase lowercase line-noise lowercase lowercase line-noise
887 MiXeD line-noise. That's all!
44a8e56a 888
a0d0e21e 889=item q/STRING/
890
891=item C<'STRING'>
892
68dc0745 893A single-quoted, literal string. A backslash represents a backslash
894unless followed by the delimiter or another backslash, in which case
895the delimiter or backslash is interpolated.
a0d0e21e 896
897 $foo = q!I said, "You said, 'She said it.'"!;
898 $bar = q('This is it.');
68dc0745 899 $baz = '\n'; # a two-character string
a0d0e21e 900
901=item qq/STRING/
902
903=item "STRING"
904
905A double-quoted, interpolated string.
906
907 $_ .= qq
908 (*** The previous line contains the naughty word "$1".\n)
909 if /(tcl|rexx|python)/; # :-)
68dc0745 910 $baz = "\n"; # a one-character string
a0d0e21e 911
912=item qx/STRING/
913
914=item `STRING`
915
5a964f20 916A string which is (possibly) interpolated and then executed as a system
917command with C</bin/sh> or its equivalent. Shell wildcards, pipes,
918and redirections will be honored. The collected standard output of the
919command is returned; standard error is unaffected. In scalar context,
920it comes back as a single (potentially multi-line) string. In list
921context, returns a list of lines (however you've defined lines with $/
922or $INPUT_RECORD_SEPARATOR).
923
924Because backticks do not affect standard error, use shell file descriptor
925syntax (assuming the shell supports this) if you care to address this.
926To capture a command's STDERR and STDOUT together:
a0d0e21e 927
5a964f20 928 $output = `cmd 2>&1`;
929
930To capture a command's STDOUT but discard its STDERR:
931
932 $output = `cmd 2>/dev/null`;
933
934To capture a command's STDERR but discard its STDOUT (ordering is
935important here):
936
937 $output = `cmd 2>&1 1>/dev/null`;
938
939To exchange a command's STDOUT and STDERR in order to capture the STDERR
940but leave its STDOUT to come out the old STDERR:
941
942 $output = `cmd 3>&1 1>&2 2>&3 3>&-`;
943
944To read both a command's STDOUT and its STDERR separately, it's easiest
945and safest to redirect them separately to files, and then read from those
946files when the program is done:
947
948 system("program args 1>/tmp/program.stdout 2>/tmp/program.stderr");
949
950Using single-quote as a delimiter protects the command from Perl's
951double-quote interpolation, passing it on to the shell instead:
952
953 $perl_info = qx(ps $$); # that's Perl's $$
954 $shell_info = qx'ps $$'; # that's the new shell's $$
955
956Note that how the string gets evaluated is entirely subject to the command
957interpreter on your system. On most platforms, you will have to protect
958shell metacharacters if you want them treated literally. This is in
959practice difficult to do, as it's unclear how to escape which characters.
960See L<perlsec> for a clean and safe example of a manual fork() and exec()
961to emulate backticks safely.
a0d0e21e 962
bb32b41a 963On some platforms (notably DOS-like ones), the shell may not be
964capable of dealing with multiline commands, so putting newlines in
965the string may not get you what you want. You may be able to evaluate
966multiple commands in a single line by separating them with the command
967separator character, if your shell supports that (e.g. C<;> on many Unix
968shells; C<&> on the Windows NT C<cmd> shell).
969
970Beware that some command shells may place restrictions on the length
971of the command line. You must ensure your strings don't exceed this
972limit after any necessary interpolations. See the platform-specific
973release notes for more details about your particular environment.
974
5a964f20 975Using this operator can lead to programs that are difficult to port,
976because the shell commands called vary between systems, and may in
977fact not be present at all. As one example, the C<type> command under
978the POSIX shell is very different from the C<type> command under DOS.
979That doesn't mean you should go out of your way to avoid backticks
980when they're the right way to get something done. Perl was made to be
981a glue language, and one of the things it glues together is commands.
982Just understand what you're getting yourself into.
bb32b41a 983
dc848c6f 984See L<"I/O Operators"> for more discussion.
a0d0e21e 985
986=item qw/STRING/
987
988Returns a list of the words extracted out of STRING, using embedded
989whitespace as the word delimiters. It is exactly equivalent to
990
991 split(' ', q/STRING/);
992
5a964f20 993This equivalency means that if used in scalar context, you'll get split's
994(unfortunate) scalar context behavior, complete with mysterious warnings.
995
a0d0e21e 996Some frequently seen examples:
997
998 use POSIX qw( setlocale localeconv )
999 @EXPORT = qw( foo bar baz );
1000
7bac28a0 1001A common mistake is to try to separate the words with comma or to put
5a964f20 1002comments into a multi-line C<qw>-string. For this reason the C<-w>
7bac28a0 1003switch produce warnings if the STRING contains the "," or the "#"
1004character.
1005
a0d0e21e 1006=item s/PATTERN/REPLACEMENT/egimosx
1007
1008Searches a string for a pattern, and if found, replaces that pattern
1009with the replacement text and returns the number of substitutions
e37d713d 1010made. Otherwise it returns false (specifically, the empty string).
a0d0e21e 1011
1012If no string is specified via the C<=~> or C<!~> operator, the C<$_>
1013variable is searched and modified. (The string specified with C<=~> must
5a964f20 1014be scalar variable, an array element, a hash element, or an assignment
5f05dabc 1015to one of those, i.e., an lvalue.)
a0d0e21e 1016
1017If the delimiter chosen is single quote, no variable interpolation is
1018done on either the PATTERN or the REPLACEMENT. Otherwise, if the
1019PATTERN contains a $ that looks like a variable rather than an
1020end-of-string test, the variable will be interpolated into the pattern
5f05dabc 1021at run-time. If you want the pattern compiled only once the first time
a0d0e21e 1022the variable is interpolated, use the C</o> option. If the pattern
5a964f20 1023evaluates to the empty string, the last successfully executed regular
a0d0e21e 1024expression is used instead. See L<perlre> for further explanation on these.
5a964f20 1025See L<perllocale> for discussion of additional considerations that apply
a034a98d 1026when C<use locale> is in effect.
a0d0e21e 1027
1028Options are:
1029
1030 e Evaluate the right side as an expression.
5f05dabc 1031 g Replace globally, i.e., all occurrences.
a0d0e21e 1032 i Do case-insensitive pattern matching.
1033 m Treat string as multiple lines.
5f05dabc 1034 o Compile pattern only once.
a0d0e21e 1035 s Treat string as single line.
1036 x Use extended regular expressions.
1037
1038Any non-alphanumeric, non-whitespace delimiter may replace the
1039slashes. If single quotes are used, no interpretation is done on the
e37d713d 1040replacement string (the C</e> modifier overrides this, however). Unlike
54310121 1041Perl 4, Perl 5 treats backticks as normal delimiters; the replacement
e37d713d 1042text is not evaluated as a command. If the
a0d0e21e 1043PATTERN is delimited by bracketing quotes, the REPLACEMENT has its own
5f05dabc 1044pair of quotes, which may or may not be bracketing quotes, e.g.,
a0d0e21e 1045C<s(foo)(bar)> or C<sE<lt>fooE<gt>/bar/>. A C</e> will cause the
7b8d334a 1046replacement portion to be interpreted as a full-fledged Perl expression
a0d0e21e 1047and eval()ed right then and there. It is, however, syntax checked at
1048compile-time.
1049
1050Examples:
1051
1052 s/\bgreen\b/mauve/g; # don't change wintergreen
1053
1054 $path =~ s|/usr/bin|/usr/local/bin|;
1055
1056 s/Login: $foo/Login: $bar/; # run-time pattern
1057
5a964f20 1058 ($foo = $bar) =~ s/this/that/; # copy first, then change
a0d0e21e 1059
5a964f20 1060 $count = ($paragraph =~ s/Mister\b/Mr./g); # get change-count
a0d0e21e 1061
1062 $_ = 'abc123xyz';
1063 s/\d+/$&*2/e; # yields 'abc246xyz'
1064 s/\d+/sprintf("%5d",$&)/e; # yields 'abc 246xyz'
1065 s/\w/$& x 2/eg; # yields 'aabbcc 224466xxyyzz'
1066
1067 s/%(.)/$percent{$1}/g; # change percent escapes; no /e
1068 s/%(.)/$percent{$1} || $&/ge; # expr now, so /e
1069 s/^=(\w+)/&pod($1)/ge; # use function call
1070
5a964f20 1071 # expand variables in $_, but dynamics only, using
1072 # symbolic dereferencing
1073 s/\$(\w+)/${$1}/g;
1074
a0d0e21e 1075 # /e's can even nest; this will expand
5a964f20 1076 # any embedded scalar variable (including lexicals) in $_
a0d0e21e 1077 s/(\$\w+)/$1/eeg;
1078
5a964f20 1079 # Delete (most) C comments.
a0d0e21e 1080 $program =~ s {
4633a7c4 1081 /\* # Match the opening delimiter.
1082 .*? # Match a minimal number of characters.
1083 \*/ # Match the closing delimiter.
a0d0e21e 1084 } []gsx;
1085
5a964f20 1086 s/^\s*(.*?)\s*$/$1/; # trim white space in $_, expensively
1087
1088 for ($variable) { # trim white space in $variable, cheap
1089 s/^\s+//;
1090 s/\s+$//;
1091 }
a0d0e21e 1092
1093 s/([^ ]*) *([^ ]*)/$2 $1/; # reverse 1st two fields
1094
54310121 1095Note the use of $ instead of \ in the last example. Unlike
5f05dabc 1096B<sed>, we use the \E<lt>I<digit>E<gt> form in only the left hand side.
6ee5d4e7 1097Anywhere else it's $E<lt>I<digit>E<gt>.
a0d0e21e 1098
5f05dabc 1099Occasionally, you can't use just a C</g> to get all the changes
a0d0e21e 1100to occur. Here are two common cases:
1101
1102 # put commas in the right places in an integer
1103 1 while s/(.*\d)(\d\d\d)/$1,$2/g; # perl4
1104 1 while s/(\d)(\d\d\d)(?!\d)/$1,$2/g; # perl5
1105
1106 # expand tabs to 8-column spacing
1107 1 while s/\t+/' ' x (length($&)*8 - length($`)%8)/e;
1108
1109
1110=item tr/SEARCHLIST/REPLACEMENTLIST/cds
1111
1112=item y/SEARCHLIST/REPLACEMENTLIST/cds
1113
2c268ad5 1114Transliterates all occurrences of the characters found in the search list
a0d0e21e 1115with the corresponding character in the replacement list. It returns
1116the number of characters replaced or deleted. If no string is
2c268ad5 1117specified via the =~ or !~ operator, the $_ string is transliterated. (The
54310121 1118string specified with =~ must be a scalar variable, an array element, a
1119hash element, or an assignment to one of those, i.e., an lvalue.)
2c268ad5 1120A character range may be specified with a hyphen, so C<tr/A-J/0-9/>
1121does the same replacement as C<tr/ACEGIBDFHJ/0246813579/>.
54310121 1122For B<sed> devotees, C<y> is provided as a synonym for C<tr>. If the
1123SEARCHLIST is delimited by bracketing quotes, the REPLACEMENTLIST has
1124its own pair of quotes, which may or may not be bracketing quotes,
2c268ad5 1125e.g., C<tr[A-Z][a-z]> or C<tr(+\-*/)/ABCD/>.
a0d0e21e 1126
1127Options:
1128
1129 c Complement the SEARCHLIST.
1130 d Delete found but unreplaced characters.
1131 s Squash duplicate replaced characters.
1132
1133If the C</c> modifier is specified, the SEARCHLIST character set is
1134complemented. If the C</d> modifier is specified, any characters specified
1135by SEARCHLIST not found in REPLACEMENTLIST are deleted. (Note
1136that this is slightly more flexible than the behavior of some B<tr>
1137programs, which delete anything they find in the SEARCHLIST, period.)
1138If the C</s> modifier is specified, sequences of characters that were
2c268ad5 1139transliterated to the same character are squashed down to a single instance of the
a0d0e21e 1140character.
1141
1142If the C</d> modifier is used, the REPLACEMENTLIST is always interpreted
1143exactly as specified. Otherwise, if the REPLACEMENTLIST is shorter
1144than the SEARCHLIST, the final character is replicated till it is long
5a964f20 1145enough. If the REPLACEMENTLIST is empty, the SEARCHLIST is replicated.
a0d0e21e 1146This latter is useful for counting characters in a class or for
1147squashing character sequences in a class.
1148
1149Examples:
1150
1151 $ARGV[1] =~ tr/A-Z/a-z/; # canonicalize to lower case
1152
1153 $cnt = tr/*/*/; # count the stars in $_
1154
1155 $cnt = $sky =~ tr/*/*/; # count the stars in $sky
1156
1157 $cnt = tr/0-9//; # count the digits in $_
1158
1159 tr/a-zA-Z//s; # bookkeeper -> bokeper
1160
1161 ($HOST = $host) =~ tr/a-z/A-Z/;
1162
1163 tr/a-zA-Z/ /cs; # change non-alphas to single space
1164
1165 tr [\200-\377]
1166 [\000-\177]; # delete 8th bit
1167
2c268ad5 1168If multiple transliterations are given for a character, only the first one is used:
748a9306 1169
1170 tr/AAA/XYZ/
1171
2c268ad5 1172will transliterate any A to X.
748a9306 1173
2c268ad5 1174Note that because the transliteration table is built at compile time, neither
a0d0e21e 1175the SEARCHLIST nor the REPLACEMENTLIST are subjected to double quote
1176interpolation. That means that if you want to use variables, you must use
1177an eval():
1178
1179 eval "tr/$oldlist/$newlist/";
1180 die $@ if $@;
1181
1182 eval "tr/$oldlist/$newlist/, 1" or die $@;
1183
1184=back
1185
75e14d17 1186=head2 Gory details of parsing quoted constructs
1187
1188When presented with something which may have several different
1189interpretations, Perl uses the principle B<DWIM> (expanded to Do What I Mean
1190- not what I wrote) to pick up the most probable interpretation of the
1191source. This strategy is so successful that Perl users usually do not
1192suspect ambivalence of what they write. However, time to time Perl's ideas
1193differ from what the author meant.
1194
1195The target of this section is to clarify the Perl's way of interpreting
1196quoted constructs. The most frequent reason one may have to want to know the
1197details discussed in this section is hairy regular expressions. However, the
1198first steps of parsing are the same for all Perl quoting operators, so here
1199they are discussed together.
1200
1201Some of the passes discussed below are performed concurrently, but as
1202far as results are the same, we consider them one-by-one. For different
1203quoting constructs Perl performs different number of passes, from
1204one to five, but they are always performed in the same order.
1205
1206=over
1207
1208=item Finding the end
1209
1210First pass is finding the end of the quoted construct, be it multichar ender
1211C<"\nEOF\n"> of C<<<EOF> construct, C</> which terminates C<qq/> construct,
1212C<E<]>> which terminates C<qq[> construct, or C<E<gt>> which terminates a
1213fileglob started with C<<>.
1214
1215When searching for multichar construct no skipping is performed. When
1216searching for one-char non-matching delimiter, such as C</>, combinations
1217C<\\> and C<\/> are skipped. When searching for one-char matching delimiter,
1218such as C<]>, combinations C<\\>, C<\]> and C<\[> are skipped, and
1219nested C<[>, C<]> are skipped as well.
1220
1221For 3-parts constructs C<s///> etc. the search is repeated once more.
1222
1223During this search no attension is paid to the semantic of the construct, thus
1224
1225 "$hash{"$foo/$bar"}"
1226
1227or
1228
1229 m/
1230 bar # This is not a comment, this slash / terminated m//!
1231 /x
1232
1233do not form legal quoted expressions. Note that since the slash which
1234terminated C<m//> was followed by a C<SPACE>, this is not C<m//x>,
1235thus C<#> was interpreted as a literal C<#>.
1236
1237=item Removal of backslashes before delimiters
1238
1239During the second pass the text between the starting delimiter and
1240the ending delimiter is copied to a safe location, and the C<\> is
1241removed from combinations consisting of C<\> and delimiter(s) (both starting
1242and ending delimiter if they differ).
1243
1244The removal does not happen for multi-char delimiters.
1245
1246Note that the combination C<\\> is left as it was!
1247
1248Starting from this step no information about the delimiter(s) is used in the
1249parsing.
1250
1251=item Interpolation
1252
1253Next step is interpolation in the obtained delimiter-independent text.
1254There are many different cases.
1255
1256=over
1257
1258=item C<<<'EOF'>, C<m''>, C<s'''>, C<tr///>, C<y///>
1259
1260No interpolation is performed.
1261
1262=item C<''>, C<q//>
1263
1264The only interpolation is removal of C<\> from pairs C<\\>.
1265
1266=item C<"">, C<``>, C<qq//>, C<qx//>, C<<file*globE<gt>>
1267
1268C<\Q>, C<\U>, C<\u>, C<\L>, C<\l> (possibly paired with C<\E>) are converted
1269to corresponding Perl constructs, thus C<"$foo\Qbaz$bar"> is converted to
1270
1271 $foo . (quotemeta("baz" . $bar));
1272
1273Other combinations of C<\> with following chars are substituted with
1274appropriate expansions.
1275
1276Interpolated scalars and arrays are converted to C<join> and C<.> Perl
1277constructs, thus C<"'@arr'"> becomes
1278
1279 "'" . (join $", @arr) . "'";
1280
1281Since all three above steps are performed simultaneously left-to-right,
1282the is no way to insert a literal C<$> or C<@> inside C<\Q\E> pair: it
1283cannot be protected by C<\>, since any C<\> (except in C<\E>) is
1284interpreted as a literal inside C<\Q\E>, and any $ is
1285interpreted as starting an interpolated scalar.
1286
1287Note also that the interpolating code needs to make decision where the
1288interpolated scalar ends, say, whether C<"a $b -> {c}"> means
1289
1290 "a " . $b . " -> {c}";
1291
1292or
1293
1294 "a " . $b -> {c};
1295
1296Most the time the decision is to take the longest possible text which does
1297not include spaces between components and contains matching braces/brackets.
1298
1299=item C<?RE?>, C</RE/>, C<m/RE/>, C<s/RE/foo/>,
1300
1301Processing of C<\Q>, C<\U>, C<\u>, C<\L>, C<\l> and interpolation happens
1302(almost) as with qq// constructs, but I<the substitution of C<\> followed by
1303other chars is not performed>! Moreover, inside C<(?{BLOCK})> no processing
1304is performed at all.
1305
1306Interpolation has several quirks: $|, $( and $) are not interpolated, and
1307constructs C<$var[SOMETHING]> are I<voted> (by several different estimators)
1308to be an array element or $var followed by a RE alternative. This is
1309the place where the notation C<${arr[$bar]}> comes handy: C</${arr[0-9]}/>
1310is interpreted as an array element -9, not as a regular expression from
1311variable $arr followed by a digit, which is the interpretation of
1312C</$arr[0-9]/>.
1313
1314Note that absense of processing of C<\\> creates specific restrictions on the
1315post-processed text: if the delimeter is C</>, one cannot get the combination
1316C<\/> into the result of this step: C</> will finish the regular expression,
1317C<\/> will be stripped to C</> on the previous step, and C<\\/> will be left
1318as is. Since C</> is equivalent to C<\/> inside a regular expression, this
1319does not matter unless the delimiter is special character for RE engine, as
1320in C<s*foo*bar*>, C<m[foo]>, or C<?foo?>.
1321
1322=back
1323
1324This step is the last one for all the constructs except regular expressions,
1325which are processed further.
1326
1327=item Interpolation of regular expressions
1328
1329All the previous steps were performed during the compilation of Perl code,
1330this one happens in run time (though it may be optimized to be calculated
1331at compile time if appropriate). After all the preprocessing performed
1332above (and possibly after evaluation if catenation, joining, up/down-casing
1333and quotemeta()ing are involved) the resulting I<string> is passed to RE
1334engine for compilation.
1335
1336Whatever happens in the RE engine is better be discussed in L<perlre>,
1337but for the sake of continuity let us do it here.
1338
1339This is the first step where presense of the C<//x> switch is relevant.
1340RE engine scans the string left-to-right, and converts it to a finite
1341automaton.
1342
1343Backslashed chars are either substituted by corresponding literal
1344strings, or generate special nodes of the finite automaton. Characters
1345which are special to RE engine generate corresponding nodes. C<(?#...)>
1346comments are ignored. All the rest is either converted to literal strings
1347to match, or is ignored (as is whitespace and C<#>-style comments if
1348C<//x> is present).
1349
1350Note that the parsing of the construct C<[...]> is performed using
1351absolutely different rules than the rest of the regular expression.
1352Similarly, the C<(?{...})> is only checked for matching braces.
1353
1354=item Optimization of regular expressions
1355
1356This step is listed for compeleteness only. Since it does not change
1357semantics, details of this step are not documented and are subject
1358to change.
1359
1360=back
1361
a0d0e21e 1362=head2 I/O Operators
1363
54310121 1364There are several I/O operators you should know about.
7b8d334a 1365A string enclosed by backticks (grave accents) first undergoes
a0d0e21e 1366variable substitution just like a double quoted string. It is then
1367interpreted as a command, and the output of that command is the value
5a964f20 1368of the pseudo-literal, like in a shell. In scalar context, a single
1369string consisting of all the output is returned. In list context,
a0d0e21e 1370a list of values is returned, one for each line of output. (You can
1371set C<$/> to use a different line terminator.) The command is executed
1372each time the pseudo-literal is evaluated. The status value of the
1373command is returned in C<$?> (see L<perlvar> for the interpretation
1374of C<$?>). Unlike in B<csh>, no translation is done on the return
1375data--newlines remain newlines. Unlike in any of the shells, single
1376quotes do not hide variable names in the command from interpretation.
1377To pass a $ through to the shell you need to hide it with a backslash.
54310121 1378The generalized form of backticks is C<qx//>. (Because backticks
1379always undergo shell expansion as well, see L<perlsec> for
cb1a09d0 1380security concerns.)
a0d0e21e 1381
1382Evaluating a filehandle in angle brackets yields the next line from
aa689395 1383that file (newline, if any, included), or C<undef> at end of file.
1384Ordinarily you must assign that value to a variable, but there is one
1385situation where an automatic assignment happens. I<If and ONLY if> the
1386input symbol is the only thing inside the conditional of a C<while> or
1387C<for(;;)> loop, the value is automatically assigned to the variable
7b8d334a 1388C<$_>. In these loop constructs, the assigned value (whether assignment
5a964f20 1389is automatic or explicit) is then tested to see if it is defined.
7b8d334a 1390The defined test avoids problems where line has a string value
1391that would be treated as false by perl e.g. "" or "0" with no trailing
1392newline. (This may seem like an odd thing to you, but you'll use the
1393construct in almost every Perl script you write.) Anyway, the following
1394lines are equivalent to each other:
a0d0e21e 1395
748a9306 1396 while (defined($_ = <STDIN>)) { print; }
7b8d334a 1397 while ($_ = <STDIN>) { print; }
a0d0e21e 1398 while (<STDIN>) { print; }
1399 for (;<STDIN>;) { print; }
748a9306 1400 print while defined($_ = <STDIN>);
7b8d334a 1401 print while ($_ = <STDIN>);
a0d0e21e 1402 print while <STDIN>;
1403
7b8d334a 1404and this also behaves similarly, but avoids the use of $_ :
1405
1406 while (my $line = <STDIN>) { print $line }
1407
1408If you really mean such values to terminate the loop they should be
5a964f20 1409tested for explicitly:
7b8d334a 1410
1411 while (($_ = <STDIN>) ne '0') { ... }
1412 while (<STDIN>) { last unless $_; ... }
1413
5a964f20 1414In other boolean contexts, C<E<lt>I<filehandle>E<gt>> without explicit C<defined>
7b8d334a 1415test or comparison will solicit a warning if C<-w> is in effect.
1416
5f05dabc 1417The filehandles STDIN, STDOUT, and STDERR are predefined. (The
1418filehandles C<stdin>, C<stdout>, and C<stderr> will also work except in
a0d0e21e 1419packages, where they would be interpreted as local identifiers rather
1420than global.) Additional filehandles may be created with the open()
cb1a09d0 1421function. See L<perlfunc/open()> for details on this.
a0d0e21e 1422
6ee5d4e7 1423If a E<lt>FILEHANDLEE<gt> is used in a context that is looking for a list, a
a0d0e21e 1424list consisting of all the input lines is returned, one line per list
1425element. It's easy to make a I<LARGE> data space this way, so use with
1426care.
1427
d28ebecd 1428The null filehandle E<lt>E<gt> is special and can be used to emulate the
1429behavior of B<sed> and B<awk>. Input from E<lt>E<gt> comes either from
a0d0e21e 1430standard input, or from each file listed on the command line. Here's
d28ebecd 1431how it works: the first time E<lt>E<gt> is evaluated, the @ARGV array is
5a964f20 1432checked, and if it is empty, C<$ARGV[0]> is set to "-", which when opened
a0d0e21e 1433gives you standard input. The @ARGV array is then processed as a list
1434of filenames. The loop
1435
1436 while (<>) {
1437 ... # code for each line
1438 }
1439
1440is equivalent to the following Perl-like pseudo code:
1441
3e3baf6d 1442 unshift(@ARGV, '-') unless @ARGV;
a0d0e21e 1443 while ($ARGV = shift) {
1444 open(ARGV, $ARGV);
1445 while (<ARGV>) {
1446 ... # code for each line
1447 }
1448 }
1449
1450except that it isn't so cumbersome to say, and will actually work. It
1451really does shift array @ARGV and put the current filename into variable
5f05dabc 1452$ARGV. It also uses filehandle I<ARGV> internally--E<lt>E<gt> is just a
1453synonym for E<lt>ARGVE<gt>, which is magical. (The pseudo code above
1454doesn't work because it treats E<lt>ARGVE<gt> as non-magical.)
a0d0e21e 1455
d28ebecd 1456You can modify @ARGV before the first E<lt>E<gt> as long as the array ends up
a0d0e21e 1457containing the list of filenames you really want. Line numbers (C<$.>)
1458continue as if the input were one big happy file. (But see example
5a964f20 1459under C<eof> for how to reset line numbers on each file.)
1460
1461If you want to set @ARGV to your own list of files, go right ahead.
1462This sets @ARGV to all plain text files if no @ARGV was given:
1463
1464 @ARGV = grep { -f && -T } glob('*') unless @ARGV;
a0d0e21e 1465
5a964f20 1466You can even set them to pipe commands. For example, this automatically
1467filters compressed arguments through B<gzip>:
1468
1469 @ARGV = map { /\.(gz|Z)$/ ? "gzip -dc < $_ |" : $_ } @ARGV;
1470
1471If you want to pass switches into your script, you can use one of the
a0d0e21e 1472Getopts modules or put a loop on the front like this:
1473
1474 while ($_ = $ARGV[0], /^-/) {
1475 shift;
1476 last if /^--$/;
1477 if (/^-D(.*)/) { $debug = $1 }
1478 if (/^-v/) { $verbose++ }
5a964f20 1479 # ... # other switches
a0d0e21e 1480 }
5a964f20 1481
a0d0e21e 1482 while (<>) {
5a964f20 1483 # ... # code for each line
a0d0e21e 1484 }
1485
7b8d334a 1486The E<lt>E<gt> symbol will return C<undef> for end-of-file only once.
1487If you call it again after this it will assume you are processing another
1488@ARGV list, and if you haven't set @ARGV, will input from STDIN.
a0d0e21e 1489
1490If the string inside the angle brackets is a reference to a scalar
5f05dabc 1491variable (e.g., E<lt>$fooE<gt>), then that variable contains the name of the
5a964f20 1492filehandle to input from, or its typeglob, or a reference to the same. For example:
cb1a09d0 1493
1494 $fh = \*STDIN;
1495 $line = <$fh>;
a0d0e21e 1496
5a964f20 1497If what's within the angle brackets is neither a filehandle nor a simple
1498scalar variable containing a filehandle name, typeglob, or typeglob
1499reference, it is interpreted as a filename pattern to be globbed, and
1500either a list of filenames or the next filename in the list is returned,
1501depending on context. This distinction is determined on syntactic
1502grounds alone. That means C<E<lt>$xE<gt>> is always a readline from
1503an indirect handle, but C<E<lt>$hash{key}E<gt>> is always a glob.
1504That's because $x is a simple scalar variable, but C<$hash{key}> is
1505not--it's a hash element.
1506
1507One level of double-quote interpretation is done first, but you can't
1508say C<E<lt>$fooE<gt>> because that's an indirect filehandle as explained
1509in the previous paragraph. (In older versions of Perl, programmers
1510would insert curly brackets to force interpretation as a filename glob:
1511C<E<lt>${foo}E<gt>>. These days, it's considered cleaner to call the
1512internal function directly as C<glob($foo)>, which is probably the right
1513way to have done it in the first place.) Example:
a0d0e21e 1514
1515 while (<*.c>) {
1516 chmod 0644, $_;
1517 }
1518
1519is equivalent to
1520
1521 open(FOO, "echo *.c | tr -s ' \t\r\f' '\\012\\012\\012\\012'|");
1522 while (<FOO>) {
1523 chop;
1524 chmod 0644, $_;
1525 }
1526
1527In fact, it's currently implemented that way. (Which means it will not
1528work on filenames with spaces in them unless you have csh(1) on your
1529machine.) Of course, the shortest way to do the above is:
1530
1531 chmod 0644, <*.c>;
1532
1533Because globbing invokes a shell, it's often faster to call readdir() yourself
5f05dabc 1534and do your own grep() on the filenames. Furthermore, due to its current
54310121 1535implementation of using a shell, the glob() routine may get "Arg list too
a0d0e21e 1536long" errors (unless you've installed tcsh(1L) as F</bin/csh>).
1537
5f05dabc 1538A glob evaluates its (embedded) argument only when it is starting a new
4633a7c4 1539list. All values must be read before it will start over. In a list
1540context this isn't important, because you automatically get them all
5a964f20 1541anyway. In scalar context, however, the operator returns the next value
7b8d334a 1542each time it is called, or a C<undef> value if you've just run out. As
1543for filehandles an automatic C<defined> is generated when the glob
1544occurs in the test part of a C<while> or C<for> - because legal glob returns
1545(e.g. a file called F<0>) would otherwise terminate the loop.
1546Again, C<undef> is returned only once. So if you're expecting a single value
1547from a glob, it is much better to say
4633a7c4 1548
1549 ($file) = <blurch*>;
1550
1551than
1552
1553 $file = <blurch*>;
1554
1555because the latter will alternate between returning a filename and
54310121 1556returning FALSE.
4633a7c4 1557
1558It you're trying to do variable interpolation, it's definitely better
1559to use the glob() function, because the older notation can cause people
e37d713d 1560to become confused with the indirect filehandle notation.
4633a7c4 1561
1562 @files = glob("$dir/*.[ch]");
1563 @files = glob($files[$i]);
1564
a0d0e21e 1565=head2 Constant Folding
1566
1567Like C, Perl does a certain amount of expression evaluation at
5a964f20 1568compile time, whenever it determines that all arguments to an
a0d0e21e 1569operator are static and have no side effects. In particular, string
1570concatenation happens at compile time between literals that don't do
1571variable substitution. Backslash interpretation also happens at
1572compile time. You can say
1573
1574 'Now is the time for all' . "\n" .
1575 'good men to come to.'
1576
54310121 1577and this all reduces to one string internally. Likewise, if
a0d0e21e 1578you say
1579
1580 foreach $file (@filenames) {
5a964f20 1581 if (-s $file > 5 + 100 * 2**16) { }
54310121 1582 }
a0d0e21e 1583
54310121 1584the compiler will precompute the number that
a0d0e21e 1585expression represents so that the interpreter
1586won't have to.
1587
2c268ad5 1588=head2 Bitwise String Operators
1589
1590Bitstrings of any size may be manipulated by the bitwise operators
1591(C<~ | & ^>).
1592
1593If the operands to a binary bitwise op are strings of different sizes,
1594B<or> and B<xor> ops will act as if the shorter operand had additional
1595zero bits on the right, while the B<and> op will act as if the longer
1596operand were truncated to the length of the shorter.
1597
1598 # ASCII-based examples
1599 print "j p \n" ^ " a h"; # prints "JAPH\n"
1600 print "JA" | " ph\n"; # prints "japh\n"
1601 print "japh\nJunk" & '_____'; # prints "JAPH\n";
1602 print 'p N$' ^ " E<H\n"; # prints "Perl\n";
1603
1604If you are intending to manipulate bitstrings, you should be certain that
1605you're supplying bitstrings: If an operand is a number, that will imply
1606a B<numeric> bitwise operation. You may explicitly show which type of
1607operation you intend by using C<""> or C<0+>, as in the examples below.
1608
1609 $foo = 150 | 105 ; # yields 255 (0x96 | 0x69 is 0xFF)
1610 $foo = '150' | 105 ; # yields 255
1611 $foo = 150 | '105'; # yields 255
1612 $foo = '150' | '105'; # yields string '155' (under ASCII)
1613
1614 $baz = 0+$foo & 0+$bar; # both ops explicitly numeric
1615 $biz = "$foo" ^ "$bar"; # both ops explicitly stringy
a0d0e21e 1616
55497cff 1617=head2 Integer Arithmetic
a0d0e21e 1618
1619By default Perl assumes that it must do most of its arithmetic in
1620floating point. But by saying
1621
1622 use integer;
1623
1624you may tell the compiler that it's okay to use integer operations
1625from here to the end of the enclosing BLOCK. An inner BLOCK may
54310121 1626countermand this by saying
a0d0e21e 1627
1628 no integer;
1629
1630which lasts until the end of that BLOCK.
1631
55497cff 1632The bitwise operators ("&", "|", "^", "~", "<<", and ">>") always
2c268ad5 1633produce integral results. (But see also L<Bitwise String Operators>.)
1634However, C<use integer> still has meaning
55497cff 1635for them. By default, their results are interpreted as unsigned
1636integers. However, if C<use integer> is in effect, their results are
5f05dabc 1637interpreted as signed integers. For example, C<~0> usually evaluates
5a964f20 1638to a large integral value. However, C<use integer; ~0> is -1 on twos-complement machines.
68dc0745 1639
1640=head2 Floating-point Arithmetic
1641
1642While C<use integer> provides integer-only arithmetic, there is no
1643similar ways to provide rounding or truncation at a certain number of
1644decimal places. For rounding to a certain number of digits, sprintf()
1645or printf() is usually the easiest route.
1646
5a964f20 1647Floating-point numbers are only approximations to what a mathematician
1648would call real numbers. There are infinitely more reals than floats,
1649so some corners must be cut. For example:
1650
1651 printf "%.20g\n", 123456789123456789;
1652 # produces 123456789123456784
1653
1654Testing for exact equality of floating-point equality or inequality is
1655not a good idea. Here's a (relatively expensive) work-around to compare
1656whether two floating-point numbers are equal to a particular number of
1657decimal places. See Knuth, volume II, for a more robust treatment of
1658this topic.
1659
1660 sub fp_equal {
1661 my ($X, $Y, $POINTS) = @_;
1662 my ($tX, $tY);
1663 $tX = sprintf("%.${POINTS}g", $X);
1664 $tY = sprintf("%.${POINTS}g", $Y);
1665 return $tX eq $tY;
1666 }
1667
68dc0745 1668The POSIX module (part of the standard perl distribution) implements
1669ceil(), floor(), and a number of other mathematical and trigonometric
1670functions. The Math::Complex module (part of the standard perl
1671distribution) defines a number of mathematical functions that can also
1672work on real numbers. Math::Complex not as efficient as POSIX, but
1673POSIX can't work with complex numbers.
1674
1675Rounding in financial applications can have serious implications, and
1676the rounding method used should be specified precisely. In these
1677cases, it probably pays not to trust whichever system rounding is
1678being used by Perl, but to instead implement the rounding function you
1679need yourself.
5a964f20 1680
1681=head2 Bigger Numbers
1682
1683The standard Math::BigInt and Math::BigFloat modules provide
1684variable precision arithmetic and overloaded operators.
1685At the cost of some space and considerable speed, they
1686avoid the normal pitfalls associated with limited-precision
1687representations.
1688
1689 use Math::BigInt;
1690 $x = Math::BigInt->new('123456789123456789');
1691 print $x * $x;
1692
1693 # prints +15241578780673678515622620750190521