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