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