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