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