This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update perldelta for all changes from v5.31.7 to v5.31.8
[perl5.git] / pod / perlop.pod
1 =head1 NAME
2 X<operator>
3
4 perlop - Perl operators and precedence
5
6 =head1 DESCRIPTION
7
8 In Perl, the operator determines what operation is performed,
9 independent of the type of the operands.  For example S<C<$x + $y>>
10 is always a numeric addition, and if C<$x> or C<$y> do not contain
11 numbers, an attempt is made to convert them to numbers first.
12
13 This is in contrast to many other dynamic languages, where the
14 operation is determined by the type of the first argument.  It also
15 means that Perl has two versions of some operators, one for numeric
16 and one for string comparison.  For example S<C<$x == $y>> compares
17 two numbers for equality, and S<C<$x eq $y>> compares two strings.
18
19 There are a few exceptions though: C<x> can be either string
20 repetition or list repetition, depending on the type of the left
21 operand, and C<&>, C<|>, C<^> and C<~> can be either string or numeric bit
22 operations.
23
24 =head2 Operator Precedence and Associativity
25 X<operator, precedence> X<precedence> X<associativity>
26
27 Operator precedence and associativity work in Perl more or less like
28 they do in mathematics.
29
30 I<Operator precedence> means some operators group more tightly than others.
31 For example, in C<2 + 4 * 5>, the multiplication has higher precedence, so C<4
32 * 5> is grouped together as the right-hand operand of the addition, rather
33 than C<2 + 4> being grouped together as the left-hand operand of the
34 multiplication. It is as if the expression were written C<2 + (4 * 5)>, not
35 C<(2 + 4) * 5>. So the expression yields C<2 + 20 == 22>, rather than
36 C<6 * 5 == 30>.
37
38 I<Operator associativity> defines what happens if a sequence of the same
39 operators is used one after another: whether they will be grouped at the left
40 or the right. For example, in C<9 - 3 - 2>, subtraction is left associative,
41 so C<9 - 3> is grouped together as the left-hand operand of the second
42 subtraction, rather than C<3 - 2> being grouped together as the right-hand
43 operand of the first subtraction. It is as if the expression were written
44 C<(9 - 3) - 2>, not C<9 - (3 - 2)>. So the expression yields C<6 - 2 == 4>,
45 rather than C<9 - 1 == 8>.
46
47 For simple operators that evaluate all their operands and then combine the
48 values in some way, precedence and associativity (and parentheses) imply some
49 ordering requirements on those combining operations. For example, in C<2 + 4 *
50 5>, the grouping implied by precedence means that the multiplication of 4 and
51 5 must be performed before the addition of 2 and 20, simply because the result
52 of that multiplication is required as one of the operands of the addition. But
53 the order of operations is not fully determined by this: in C<2 * 2 + 4 * 5>
54 both multiplications must be performed before the addition, but the grouping
55 does not say anything about the order in which the two multiplications are
56 performed. In fact Perl has a general rule that the operands of an operator
57 are evaluated in left-to-right order. A few operators such as C<&&=> have
58 special evaluation rules that can result in an operand not being evaluated at
59 all; in general, the top-level operator in an expression has control of
60 operand evaluation.
61
62 Perl operators have the following associativity and precedence,
63 listed from highest precedence to lowest.  Operators borrowed from
64 C keep the same precedence relationship with each other, even where
65 C's precedence is slightly screwy.  (This makes learning Perl easier
66 for C folks.)  With very few exceptions, these all operate on scalar
67 values only, not array values.
68
69     left        terms and list operators (leftward)
70     left        ->
71     nonassoc    ++ --
72     right       **
73     right       ! ~ \ and unary + and -
74     left        =~ !~
75     left        * / % x
76     left        + - .
77     left        << >>
78     nonassoc    named unary operators
79     nonassoc    < > <= >= lt gt le ge
80     nonassoc    == != <=> eq ne cmp ~~
81     nonassoc    isa
82     left        &
83     left        | ^
84     left        &&
85     left        || //
86     nonassoc    ..  ...
87     right       ?:
88     right       = += -= *= etc. goto last next redo dump
89     left        , =>
90     nonassoc    list operators (rightward)
91     right       not
92     left        and
93     left        or xor
94
95 In the following sections, these operators are covered in detail, in the
96 same order in which they appear in the table above.
97
98 Many operators can be overloaded for objects.  See L<overload>.
99
100 =head2 Terms and List Operators (Leftward)
101 X<list operator> X<operator, list> X<term>
102
103 A TERM has the highest precedence in Perl.  They include variables,
104 quote and quote-like operators, any expression in parentheses,
105 and any function whose arguments are parenthesized.  Actually, there
106 aren't really functions in this sense, just list operators and unary
107 operators behaving as functions because you put parentheses around
108 the arguments.  These are all documented in L<perlfunc>.
109
110 If any list operator (C<print()>, etc.) or any unary operator (C<chdir()>, etc.)
111 is followed by a left parenthesis as the next token, the operator and
112 arguments within parentheses are taken to be of highest precedence,
113 just like a normal function call.
114
115 In the absence of parentheses, the precedence of list operators such as
116 C<print>, C<sort>, or C<chmod> is either very high or very low depending on
117 whether you are looking at the left side or the right side of the operator.
118 For example, in
119
120     @ary = (1, 3, sort 4, 2);
121     print @ary;         # prints 1324
122
123 the commas on the right of the C<sort> are evaluated before the C<sort>,
124 but the commas on the left are evaluated after.  In other words,
125 list operators tend to gobble up all arguments that follow, and
126 then act like a simple TERM with regard to the preceding expression.
127 Be careful with parentheses:
128
129     # These evaluate exit before doing the print:
130     print($foo, exit);  # Obviously not what you want.
131     print $foo, exit;   # Nor is this.
132
133     # These do the print before evaluating exit:
134     (print $foo), exit; # This is what you want.
135     print($foo), exit;  # Or this.
136     print ($foo), exit; # Or even this.
137
138 Also note that
139
140     print ($foo & 255) + 1, "\n";
141
142 probably doesn't do what you expect at first glance.  The parentheses
143 enclose the argument list for C<print> which is evaluated (printing
144 the result of S<C<$foo & 255>>).  Then one is added to the return value
145 of C<print> (usually 1).  The result is something like this:
146
147     1 + 1, "\n";    # Obviously not what you meant.
148
149 To do what you meant properly, you must write:
150
151     print(($foo & 255) + 1, "\n");
152
153 See L</Named Unary Operators> for more discussion of this.
154
155 Also parsed as terms are the S<C<do {}>> and S<C<eval {}>> constructs, as
156 well as subroutine and method calls, and the anonymous
157 constructors C<[]> and C<{}>.
158
159 See also L</Quote and Quote-like Operators> toward the end of this section,
160 as well as L</"I/O Operators">.
161
162 =head2 The Arrow Operator
163 X<arrow> X<dereference> X<< -> >>
164
165 "C<< -> >>" is an infix dereference operator, just as it is in C
166 and C++.  If the right side is either a C<[...]>, C<{...}>, or a
167 C<(...)> subscript, then the left side must be either a hard or
168 symbolic reference to an array, a hash, or a subroutine respectively.
169 (Or technically speaking, a location capable of holding a hard
170 reference, if it's an array or hash reference being used for
171 assignment.)  See L<perlreftut> and L<perlref>.
172
173 Otherwise, the right side is a method name or a simple scalar
174 variable containing either the method name or a subroutine reference,
175 and the left side must be either an object (a blessed reference)
176 or a class name (that is, a package name).  See L<perlobj>.
177
178 The dereferencing cases (as opposed to method-calling cases) are
179 somewhat extended by the C<postderef> feature.  For the
180 details of that feature, consult L<perlref/Postfix Dereference Syntax>.
181
182 =head2 Auto-increment and Auto-decrement
183 X<increment> X<auto-increment> X<++> X<decrement> X<auto-decrement> X<-->
184
185 C<"++"> and C<"--"> work as in C.  That is, if placed before a variable,
186 they increment or decrement the variable by one before returning the
187 value, and if placed after, increment or decrement after returning the
188 value.
189
190     $i = 0;  $j = 0;
191     print $i++;  # prints 0
192     print ++$j;  # prints 1
193
194 Note that just as in C, Perl doesn't define B<when> the variable is
195 incremented or decremented.  You just know it will be done sometime
196 before or after the value is returned.  This also means that modifying
197 a variable twice in the same statement will lead to undefined behavior.
198 Avoid statements like:
199
200     $i = $i ++;
201     print ++ $i + $i ++;
202
203 Perl will not guarantee what the result of the above statements is.
204
205 The auto-increment operator has a little extra builtin magic to it.  If
206 you increment a variable that is numeric, or that has ever been used in
207 a numeric context, you get a normal increment.  If, however, the
208 variable has been used in only string contexts since it was set, and
209 has a value that is not the empty string and matches the pattern
210 C</^[a-zA-Z]*[0-9]*\z/>, the increment is done as a string, preserving each
211 character within its range, with carry:
212
213     print ++($foo = "99");      # prints "100"
214     print ++($foo = "a0");      # prints "a1"
215     print ++($foo = "Az");      # prints "Ba"
216     print ++($foo = "zz");      # prints "aaa"
217
218 C<undef> is always treated as numeric, and in particular is changed
219 to C<0> before incrementing (so that a post-increment of an undef value
220 will return C<0> rather than C<undef>).
221
222 The auto-decrement operator is not magical.
223
224 =head2 Exponentiation
225 X<**> X<exponentiation> X<power>
226
227 Binary C<"**"> is the exponentiation operator.  It binds even more
228 tightly than unary minus, so C<-2**4> is C<-(2**4)>, not C<(-2)**4>.
229 (This is
230 implemented using C's C<pow(3)> function, which actually works on doubles
231 internally.)
232
233 Note that certain exponentiation expressions are ill-defined:
234 these include C<0**0>, C<1**Inf>, and C<Inf**0>.  Do not expect
235 any particular results from these special cases, the results
236 are platform-dependent.
237
238 =head2 Symbolic Unary Operators
239 X<unary operator> X<operator, unary>
240
241 Unary C<"!"> performs logical negation, that is, "not".  See also
242 L<C<not>|/Logical Not> for a lower precedence version of this.
243 X<!>
244
245 Unary C<"-"> performs arithmetic negation if the operand is numeric,
246 including any string that looks like a number.  If the operand is
247 an identifier, a string consisting of a minus sign concatenated
248 with the identifier is returned.  Otherwise, if the string starts
249 with a plus or minus, a string starting with the opposite sign is
250 returned.  One effect of these rules is that C<-bareword> is equivalent
251 to the string C<"-bareword">.  If, however, the string begins with a
252 non-alphabetic character (excluding C<"+"> or C<"-">), Perl will attempt
253 to convert
254 the string to a numeric, and the arithmetic negation is performed.  If the
255 string cannot be cleanly converted to a numeric, Perl will give the warning
256 B<Argument "the string" isn't numeric in negation (-) at ...>.
257 X<-> X<negation, arithmetic>
258
259 Unary C<"~"> performs bitwise negation, that is, 1's complement.  For
260 example, S<C<0666 & ~027>> is 0640.  (See also L</Integer Arithmetic> and
261 L</Bitwise String Operators>.)  Note that the width of the result is
262 platform-dependent: C<~0> is 32 bits wide on a 32-bit platform, but 64
263 bits wide on a 64-bit platform, so if you are expecting a certain bit
264 width, remember to use the C<"&"> operator to mask off the excess bits.
265 X<~> X<negation, binary>
266
267 Starting in Perl 5.28, it is a fatal error to try to complement a string
268 containing a character with an ordinal value above 255.
269
270 If the "bitwise" feature is enabled via S<C<use
271 feature 'bitwise'>> or C<use v5.28>, then unary
272 C<"~"> always treats its argument as a number, and an
273 alternate form of the operator, C<"~.">, always treats its argument as a
274 string.  So C<~0> and C<~"0"> will both give 2**32-1 on 32-bit platforms,
275 whereas C<~.0> and C<~."0"> will both yield C<"\xff">.  Until Perl 5.28,
276 this feature produced a warning in the C<"experimental::bitwise"> category.
277
278 Unary C<"+"> has no effect whatsoever, even on strings.  It is useful
279 syntactically for separating a function name from a parenthesized expression
280 that would otherwise be interpreted as the complete list of function
281 arguments.  (See examples above under L</Terms and List Operators (Leftward)>.)
282 X<+>
283
284 Unary C<"\"> creates references.  If its operand is a single sigilled
285 thing, it creates a reference to that object.  If its operand is a
286 parenthesised list, then it creates references to the things mentioned
287 in the list.  Otherwise it puts its operand in list context, and creates
288 a list of references to the scalars in the list provided by the operand.
289 See L<perlreftut>
290 and L<perlref>.  Do not confuse this behavior with the behavior of
291 backslash within a string, although both forms do convey the notion
292 of protecting the next thing from interpolation.
293 X<\> X<reference> X<backslash>
294
295 =head2 Binding Operators
296 X<binding> X<operator, binding> X<=~> X<!~>
297
298 Binary C<"=~"> binds a scalar expression to a pattern match.  Certain operations
299 search or modify the string C<$_> by default.  This operator makes that kind
300 of operation work on some other string.  The right argument is a search
301 pattern, substitution, or transliteration.  The left argument is what is
302 supposed to be searched, substituted, or transliterated instead of the default
303 C<$_>.  When used in scalar context, the return value generally indicates the
304 success of the operation.  The exceptions are substitution (C<s///>)
305 and transliteration (C<y///>) with the C</r> (non-destructive) option,
306 which cause the B<r>eturn value to be the result of the substitution.
307 Behavior in list context depends on the particular operator.
308 See L</"Regexp Quote-Like Operators"> for details and L<perlretut> for
309 examples using these operators.
310
311 If the right argument is an expression rather than a search pattern,
312 substitution, or transliteration, it is interpreted as a search pattern at run
313 time.  Note that this means that its
314 contents will be interpolated twice, so
315
316     '\\' =~ q'\\';
317
318 is not ok, as the regex engine will end up trying to compile the
319 pattern C<\>, which it will consider a syntax error.
320
321 Binary C<"!~"> is just like C<"=~"> except the return value is negated in
322 the logical sense.
323
324 Binary C<"!~"> with a non-destructive substitution (C<s///r>) or transliteration
325 (C<y///r>) is a syntax error.
326
327 =head2 Multiplicative Operators
328 X<operator, multiplicative>
329
330 Binary C<"*"> multiplies two numbers.
331 X<*>
332
333 Binary C<"/"> divides two numbers.
334 X</> X<slash>
335
336 Binary C<"%"> is the modulo operator, which computes the division
337 remainder of its first argument with respect to its second argument.
338 Given integer
339 operands C<$m> and C<$n>: If C<$n> is positive, then S<C<$m % $n>> is
340 C<$m> minus the largest multiple of C<$n> less than or equal to
341 C<$m>.  If C<$n> is negative, then S<C<$m % $n>> is C<$m> minus the
342 smallest multiple of C<$n> that is not less than C<$m> (that is, the
343 result will be less than or equal to zero).  If the operands
344 C<$m> and C<$n> are floating point values and the absolute value of
345 C<$n> (that is C<abs($n)>) is less than S<C<(UV_MAX + 1)>>, only
346 the integer portion of C<$m> and C<$n> will be used in the operation
347 (Note: here C<UV_MAX> means the maximum of the unsigned integer type).
348 If the absolute value of the right operand (C<abs($n)>) is greater than
349 or equal to S<C<(UV_MAX + 1)>>, C<"%"> computes the floating-point remainder
350 C<$r> in the equation S<C<($r = $m - $i*$n)>> where C<$i> is a certain
351 integer that makes C<$r> have the same sign as the right operand
352 C<$n> (B<not> as the left operand C<$m> like C function C<fmod()>)
353 and the absolute value less than that of C<$n>.
354 Note that when S<C<use integer>> is in scope, C<"%"> gives you direct access
355 to the modulo operator as implemented by your C compiler.  This
356 operator is not as well defined for negative operands, but it will
357 execute faster.
358 X<%> X<remainder> X<modulo> X<mod>
359
360 Binary C<x> is the repetition operator.  In scalar context, or if the
361 left operand is neither enclosed in parentheses nor a C<qw//> list,
362 it performs a string repetition.  In that case it supplies scalar
363 context to the left operand, and returns a string consisting of the
364 left operand string repeated the number of times specified by the right
365 operand.  If the C<x> is in list context, and the left operand is either
366 enclosed in parentheses or a C<qw//> list, it performs a list repetition.
367 In that case it supplies list context to the left operand, and returns
368 a list consisting of the left operand list repeated the number of times
369 specified by the right operand.
370 If the right operand is zero or negative (raising a warning on
371 negative), it returns an empty string
372 or an empty list, depending on the context.
373 X<x>
374
375     print '-' x 80;             # print row of dashes
376
377     print "\t" x ($tab/8), ' ' x ($tab%8);      # tab over
378
379     @ones = (1) x 80;           # a list of 80 1's
380     @ones = (5) x @ones;        # set all elements to 5
381
382
383 =head2 Additive Operators
384 X<operator, additive>
385
386 Binary C<"+"> returns the sum of two numbers.
387 X<+>
388
389 Binary C<"-"> returns the difference of two numbers.
390 X<->
391
392 Binary C<"."> concatenates two strings.
393 X<string, concatenation> X<concatenation>
394 X<cat> X<concat> X<concatenate> X<.>
395
396 =head2 Shift Operators
397 X<shift operator> X<operator, shift> X<<< << >>>
398 X<<< >> >>> X<right shift> X<left shift> X<bitwise shift>
399 X<shl> X<shr> X<shift, right> X<shift, left>
400
401 Binary C<<< "<<" >>> returns the value of its left argument shifted left by the
402 number of bits specified by the right argument.  Arguments should be
403 integers.  (See also L</Integer Arithmetic>.)
404
405 Binary C<<< ">>" >>> returns the value of its left argument shifted right by
406 the number of bits specified by the right argument.  Arguments should
407 be integers.  (See also L</Integer Arithmetic>.)
408
409 If S<C<use integer>> (see L</Integer Arithmetic>) is in force then
410 signed C integers are used (I<arithmetic shift>), otherwise unsigned C
411 integers are used (I<logical shift>), even for negative shiftees.
412 In arithmetic right shift the sign bit is replicated on the left,
413 in logical shift zero bits come in from the left.
414
415 Either way, the implementation isn't going to generate results larger
416 than the size of the integer type Perl was built with (32 bits or 64 bits).
417
418 Shifting by negative number of bits means the reverse shift: left
419 shift becomes right shift, right shift becomes left shift.  This is
420 unlike in C, where negative shift is undefined.
421
422 Shifting by more bits than the size of the integers means most of the
423 time zero (all bits fall off), except that under S<C<use integer>>
424 right overshifting a negative shiftee results in -1.  This is unlike
425 in C, where shifting by too many bits is undefined.  A common C
426 behavior is "shift by modulo wordbits", so that for example
427
428     1 >> 64 == 1 >> (64 % 64) == 1 >> 0 == 1  # Common C behavior.
429
430 but that is completely accidental.
431
432 If you get tired of being subject to your platform's native integers,
433 the S<C<use bigint>> pragma neatly sidesteps the issue altogether:
434
435     print 20 << 20;  # 20971520
436     print 20 << 40;  # 5120 on 32-bit machines,
437                      # 21990232555520 on 64-bit machines
438     use bigint;
439     print 20 << 100; # 25353012004564588029934064107520
440
441 =head2 Named Unary Operators
442 X<operator, named unary>
443
444 The various named unary operators are treated as functions with one
445 argument, with optional parentheses.
446
447 If any list operator (C<print()>, etc.) or any unary operator (C<chdir()>, etc.)
448 is followed by a left parenthesis as the next token, the operator and
449 arguments within parentheses are taken to be of highest precedence,
450 just like a normal function call.  For example,
451 because named unary operators are higher precedence than C<||>:
452
453     chdir $foo    || die;       # (chdir $foo) || die
454     chdir($foo)   || die;       # (chdir $foo) || die
455     chdir ($foo)  || die;       # (chdir $foo) || die
456     chdir +($foo) || die;       # (chdir $foo) || die
457
458 but, because C<"*"> is higher precedence than named operators:
459
460     chdir $foo * 20;    # chdir ($foo * 20)
461     chdir($foo) * 20;   # (chdir $foo) * 20
462     chdir ($foo) * 20;  # (chdir $foo) * 20
463     chdir +($foo) * 20; # chdir ($foo * 20)
464
465     rand 10 * 20;       # rand (10 * 20)
466     rand(10) * 20;      # (rand 10) * 20
467     rand (10) * 20;     # (rand 10) * 20
468     rand +(10) * 20;    # rand (10 * 20)
469
470 Regarding precedence, the filetest operators, like C<-f>, C<-M>, etc. are
471 treated like named unary operators, but they don't follow this functional
472 parenthesis rule.  That means, for example, that C<-f($file).".bak"> is
473 equivalent to S<C<-f "$file.bak">>.
474 X<-X> X<filetest> X<operator, filetest>
475
476 See also L</"Terms and List Operators (Leftward)">.
477
478 =head2 Relational Operators
479 X<relational operator> X<operator, relational>
480
481 Perl operators that return true or false generally return values
482 that can be safely used as numbers.  For example, the relational
483 operators in this section and the equality operators in the next
484 one return C<1> for true and a special version of the defined empty
485 string, C<"">, which counts as a zero but is exempt from warnings
486 about improper numeric conversions, just as S<C<"0 but true">> is.
487
488 Binary C<< "<" >> returns true if the left argument is numerically less than
489 the right argument.
490 X<< < >>
491
492 Binary C<< ">" >> returns true if the left argument is numerically greater
493 than the right argument.
494 X<< > >>
495
496 Binary C<< "<=" >> returns true if the left argument is numerically less than
497 or equal to the right argument.
498 X<< <= >>
499
500 Binary C<< ">=" >> returns true if the left argument is numerically greater
501 than or equal to the right argument.
502 X<< >= >>
503
504 Binary C<"lt"> returns true if the left argument is stringwise less than
505 the right argument.
506 X<< lt >>
507
508 Binary C<"gt"> returns true if the left argument is stringwise greater
509 than the right argument.
510 X<< gt >>
511
512 Binary C<"le"> returns true if the left argument is stringwise less than
513 or equal to the right argument.
514 X<< le >>
515
516 Binary C<"ge"> returns true if the left argument is stringwise greater
517 than or equal to the right argument.
518 X<< ge >>
519
520 =head2 Equality Operators
521 X<equality> X<equal> X<equals> X<operator, equality>
522
523 Binary C<< "==" >> returns true if the left argument is numerically equal to
524 the right argument.
525 X<==>
526
527 Binary C<< "!=" >> returns true if the left argument is numerically not equal
528 to the right argument.
529 X<!=>
530
531 Binary C<< "<=>" >> returns -1, 0, or 1 depending on whether the left
532 argument is numerically less than, equal to, or greater than the right
533 argument.  If your platform supports C<NaN>'s (not-a-numbers) as numeric
534 values, using them with C<< "<=>" >> returns undef.  C<NaN> is not
535 C<< "<" >>, C<< "==" >>, C<< ">" >>, C<< "<=" >> or C<< ">=" >> anything
536 (even C<NaN>), so those 5 return false.  S<C<< NaN != NaN >>> returns
537 true, as does S<C<NaN !=> I<anything else>>.  If your platform doesn't
538 support C<NaN>'s then C<NaN> is just a string with numeric value 0.
539 X<< <=> >>
540 X<spaceship>
541
542     $ perl -le '$x = "NaN"; print "No NaN support here" if $x == $x'
543     $ perl -le '$x = "NaN"; print "NaN support here" if $x != $x'
544
545 (Note that the L<bigint>, L<bigrat>, and L<bignum> pragmas all
546 support C<"NaN">.)
547
548 Binary C<"eq"> returns true if the left argument is stringwise equal to
549 the right argument.
550 X<eq>
551
552 Binary C<"ne"> returns true if the left argument is stringwise not equal
553 to the right argument.
554 X<ne>
555
556 Binary C<"cmp"> returns -1, 0, or 1 depending on whether the left
557 argument is stringwise less than, equal to, or greater than the right
558 argument.
559 X<cmp>
560
561 Binary C<"~~"> does a smartmatch between its arguments.  Smart matching
562 is described in the next section.
563 X<~~>
564
565 C<"lt">, C<"le">, C<"ge">, C<"gt"> and C<"cmp"> use the collation (sort)
566 order specified by the current C<LC_COLLATE> locale if a S<C<use
567 locale>> form that includes collation is in effect.  See L<perllocale>.
568 Do not mix these with Unicode,
569 only use them with legacy 8-bit locale encodings.
570 The standard C<L<Unicode::Collate>> and
571 C<L<Unicode::Collate::Locale>> modules offer much more powerful
572 solutions to collation issues.
573
574 For case-insensitive comparisons, look at the L<perlfunc/fc> case-folding
575 function, available in Perl v5.16 or later:
576
577     if ( fc($x) eq fc($y) ) { ... }
578
579 =head2 Class Instance Operator
580 X<isa operator>
581
582 Binary C<isa> evaluates to true when left argument is an object instance of
583 the class (or a subclass derived from that class) given by the right argument.
584 If the left argument is not defined, not a blessed object instance, or does
585 not derive from the class given by the right argument, the operator evaluates
586 as false. The right argument may give the class either as a barename or a
587 scalar expression that yields a string class name:
588
589     if( $obj isa Some::Class ) { ... }
590
591     if( $obj isa "Different::Class" ) { ... }
592     if( $obj isa $name_of_class ) { ... }
593
594 This is an experimental feature and is available from Perl 5.31.6 when enabled
595 by C<use feature 'isa'>. It emits a warning in the C<experimental::isa>
596 category.
597
598 =head2 Smartmatch Operator
599
600 First available in Perl 5.10.1 (the 5.10.0 version behaved differently),
601 binary C<~~> does a "smartmatch" between its arguments.  This is mostly
602 used implicitly in the C<when> construct described in L<perlsyn>, although
603 not all C<when> clauses call the smartmatch operator.  Unique among all of
604 Perl's operators, the smartmatch operator can recurse.  The smartmatch
605 operator is L<experimental|perlpolicy/experimental> and its behavior is
606 subject to change.
607
608 It is also unique in that all other Perl operators impose a context
609 (usually string or numeric context) on their operands, autoconverting
610 those operands to those imposed contexts.  In contrast, smartmatch
611 I<infers> contexts from the actual types of its operands and uses that
612 type information to select a suitable comparison mechanism.
613
614 The C<~~> operator compares its operands "polymorphically", determining how
615 to compare them according to their actual types (numeric, string, array,
616 hash, etc.).  Like the equality operators with which it shares the same
617 precedence, C<~~> returns 1 for true and C<""> for false.  It is often best
618 read aloud as "in", "inside of", or "is contained in", because the left
619 operand is often looked for I<inside> the right operand.  That makes the
620 order of the operands to the smartmatch operand often opposite that of
621 the regular match operator.  In other words, the "smaller" thing is usually
622 placed in the left operand and the larger one in the right.
623
624 The behavior of a smartmatch depends on what type of things its arguments
625 are, as determined by the following table.  The first row of the table
626 whose types apply determines the smartmatch behavior.  Because what
627 actually happens is mostly determined by the type of the second operand,
628 the table is sorted on the right operand instead of on the left.
629
630  Left      Right      Description and pseudocode
631  ===============================================================
632  Any       undef      check whether Any is undefined
633                 like: !defined Any
634
635  Any       Object     invoke ~~ overloading on Object, or die
636
637  Right operand is an ARRAY:
638
639  Left      Right      Description and pseudocode
640  ===============================================================
641  ARRAY1    ARRAY2     recurse on paired elements of ARRAY1 and ARRAY2[2]
642                 like: (ARRAY1[0] ~~ ARRAY2[0])
643                         && (ARRAY1[1] ~~ ARRAY2[1]) && ...
644  HASH      ARRAY      any ARRAY elements exist as HASH keys
645                 like: grep { exists HASH->{$_} } ARRAY
646  Regexp    ARRAY      any ARRAY elements pattern match Regexp
647                 like: grep { /Regexp/ } ARRAY
648  undef     ARRAY      undef in ARRAY
649                 like: grep { !defined } ARRAY
650  Any       ARRAY      smartmatch each ARRAY element[3]
651                 like: grep { Any ~~ $_ } ARRAY
652
653  Right operand is a HASH:
654
655  Left      Right      Description and pseudocode
656  ===============================================================
657  HASH1     HASH2      all same keys in both HASHes
658                 like: keys HASH1 ==
659                          grep { exists HASH2->{$_} } keys HASH1
660  ARRAY     HASH       any ARRAY elements exist as HASH keys
661                 like: grep { exists HASH->{$_} } ARRAY
662  Regexp    HASH       any HASH keys pattern match Regexp
663                 like: grep { /Regexp/ } keys HASH
664  undef     HASH       always false (undef can't be a key)
665                 like: 0 == 1
666  Any       HASH       HASH key existence
667                 like: exists HASH->{Any}
668
669  Right operand is CODE:
670
671  Left      Right      Description and pseudocode
672  ===============================================================
673  ARRAY     CODE       sub returns true on all ARRAY elements[1]
674                 like: !grep { !CODE->($_) } ARRAY
675  HASH      CODE       sub returns true on all HASH keys[1]
676                 like: !grep { !CODE->($_) } keys HASH
677  Any       CODE       sub passed Any returns true
678                 like: CODE->(Any)
679
680 Right operand is a Regexp:
681
682  Left      Right      Description and pseudocode
683  ===============================================================
684  ARRAY     Regexp     any ARRAY elements match Regexp
685                 like: grep { /Regexp/ } ARRAY
686  HASH      Regexp     any HASH keys match Regexp
687                 like: grep { /Regexp/ } keys HASH
688  Any       Regexp     pattern match
689                 like: Any =~ /Regexp/
690
691  Other:
692
693  Left      Right      Description and pseudocode
694  ===============================================================
695  Object    Any        invoke ~~ overloading on Object,
696                       or fall back to...
697
698  Any       Num        numeric equality
699                  like: Any == Num
700  Num       nummy[4]    numeric equality
701                  like: Num == nummy
702  undef     Any        check whether undefined
703                  like: !defined(Any)
704  Any       Any        string equality
705                  like: Any eq Any
706
707
708 Notes:
709
710 =over
711
712 =item 1.
713 Empty hashes or arrays match.
714
715 =item 2.
716 That is, each element smartmatches the element of the same index in the other array.[3]
717
718 =item 3.
719 If a circular reference is found, fall back to referential equality.
720
721 =item 4.
722 Either an actual number, or a string that looks like one.
723
724 =back
725
726 The smartmatch implicitly dereferences any non-blessed hash or array
727 reference, so the C<I<HASH>> and C<I<ARRAY>> entries apply in those cases.
728 For blessed references, the C<I<Object>> entries apply.  Smartmatches
729 involving hashes only consider hash keys, never hash values.
730
731 The "like" code entry is not always an exact rendition.  For example, the
732 smartmatch operator short-circuits whenever possible, but C<grep> does
733 not.  Also, C<grep> in scalar context returns the number of matches, but
734 C<~~> returns only true or false.
735
736 Unlike most operators, the smartmatch operator knows to treat C<undef>
737 specially:
738
739     use v5.10.1;
740     @array = (1, 2, 3, undef, 4, 5);
741     say "some elements undefined" if undef ~~ @array;
742
743 Each operand is considered in a modified scalar context, the modification
744 being that array and hash variables are passed by reference to the
745 operator, which implicitly dereferences them.  Both elements
746 of each pair are the same:
747
748     use v5.10.1;
749
750     my %hash = (red    => 1, blue   => 2, green  => 3,
751                 orange => 4, yellow => 5, purple => 6,
752                 black  => 7, grey   => 8, white  => 9);
753
754     my @array = qw(red blue green);
755
756     say "some array elements in hash keys" if  @array ~~  %hash;
757     say "some array elements in hash keys" if \@array ~~ \%hash;
758
759     say "red in array" if "red" ~~  @array;
760     say "red in array" if "red" ~~ \@array;
761
762     say "some keys end in e" if /e$/ ~~  %hash;
763     say "some keys end in e" if /e$/ ~~ \%hash;
764
765 Two arrays smartmatch if each element in the first array smartmatches
766 (that is, is "in") the corresponding element in the second array,
767 recursively.
768
769     use v5.10.1;
770     my @little = qw(red blue green);
771     my @bigger = ("red", "blue", [ "orange", "green" ] );
772     if (@little ~~ @bigger) {  # true!
773         say "little is contained in bigger";
774     }
775
776 Because the smartmatch operator recurses on nested arrays, this
777 will still report that "red" is in the array.
778
779     use v5.10.1;
780     my @array = qw(red blue green);
781     my $nested_array = [[[[[[[ @array ]]]]]]];
782     say "red in array" if "red" ~~ $nested_array;
783
784 If two arrays smartmatch each other, then they are deep
785 copies of each others' values, as this example reports:
786
787     use v5.12.0;
788     my @a = (0, 1, 2, [3, [4, 5], 6], 7);
789     my @b = (0, 1, 2, [3, [4, 5], 6], 7);
790
791     if (@a ~~ @b && @b ~~ @a) {
792         say "a and b are deep copies of each other";
793     }
794     elsif (@a ~~ @b) {
795         say "a smartmatches in b";
796     }
797     elsif (@b ~~ @a) {
798         say "b smartmatches in a";
799     }
800     else {
801         say "a and b don't smartmatch each other at all";
802     }
803
804
805 If you were to set S<C<$b[3] = 4>>, then instead of reporting that "a and b
806 are deep copies of each other", it now reports that C<"b smartmatches in a">.
807 That's because the corresponding position in C<@a> contains an array that
808 (eventually) has a 4 in it.
809
810 Smartmatching one hash against another reports whether both contain the
811 same keys, no more and no less.  This could be used to see whether two
812 records have the same field names, without caring what values those fields
813 might have.  For example:
814
815     use v5.10.1;
816     sub make_dogtag {
817         state $REQUIRED_FIELDS = { name=>1, rank=>1, serial_num=>1 };
818
819         my ($class, $init_fields) = @_;
820
821         die "Must supply (only) name, rank, and serial number"
822             unless $init_fields ~~ $REQUIRED_FIELDS;
823
824         ...
825     }
826
827 However, this only does what you mean if C<$init_fields> is indeed a hash
828 reference. The condition C<$init_fields ~~ $REQUIRED_FIELDS> also allows the
829 strings C<"name">, C<"rank">, C<"serial_num"> as well as any array reference
830 that contains C<"name"> or C<"rank"> or C<"serial_num"> anywhere to pass
831 through.
832
833 The smartmatch operator is most often used as the implicit operator of a
834 C<when> clause.  See the section on "Switch Statements" in L<perlsyn>.
835
836 =head3 Smartmatching of Objects
837
838 To avoid relying on an object's underlying representation, if the
839 smartmatch's right operand is an object that doesn't overload C<~~>,
840 it raises the exception "C<Smartmatching a non-overloaded object
841 breaks encapsulation>".  That's because one has no business digging
842 around to see whether something is "in" an object.  These are all
843 illegal on objects without a C<~~> overload:
844
845     %hash ~~ $object
846        42 ~~ $object
847    "fred" ~~ $object
848
849 However, you can change the way an object is smartmatched by overloading
850 the C<~~> operator.  This is allowed to
851 extend the usual smartmatch semantics.
852 For objects that do have an C<~~> overload, see L<overload>.
853
854 Using an object as the left operand is allowed, although not very useful.
855 Smartmatching rules take precedence over overloading, so even if the
856 object in the left operand has smartmatch overloading, this will be
857 ignored.  A left operand that is a non-overloaded object falls back on a
858 string or numeric comparison of whatever the C<ref> operator returns.  That
859 means that
860
861     $object ~~ X
862
863 does I<not> invoke the overload method with C<I<X>> as an argument.
864 Instead the above table is consulted as normal, and based on the type of
865 C<I<X>>, overloading may or may not be invoked.  For simple strings or
866 numbers, "in" becomes equivalent to this:
867
868     $object ~~ $number          ref($object) == $number
869     $object ~~ $string          ref($object) eq $string
870
871 For example, this reports that the handle smells IOish
872 (but please don't really do this!):
873
874     use IO::Handle;
875     my $fh = IO::Handle->new();
876     if ($fh ~~ /\bIO\b/) {
877         say "handle smells IOish";
878     }
879
880 That's because it treats C<$fh> as a string like
881 C<"IO::Handle=GLOB(0x8039e0)">, then pattern matches against that.
882
883 =head2 Bitwise And
884 X<operator, bitwise, and> X<bitwise and> X<&>
885
886 Binary C<"&"> returns its operands ANDed together bit by bit.  Although no
887 warning is currently raised, the result is not well defined when this operation
888 is performed on operands that aren't either numbers (see
889 L</Integer Arithmetic>) nor bitstrings (see L</Bitwise String Operators>).
890
891 Note that C<"&"> has lower priority than relational operators, so for example
892 the parentheses are essential in a test like
893
894     print "Even\n" if ($x & 1) == 0;
895
896 If the "bitwise" feature is enabled via S<C<use feature 'bitwise'>> or
897 C<use v5.28>, then this operator always treats its operands as numbers.
898 Before Perl 5.28 this feature produced a warning in the
899 C<"experimental::bitwise"> category.
900
901 =head2 Bitwise Or and Exclusive Or
902 X<operator, bitwise, or> X<bitwise or> X<|> X<operator, bitwise, xor>
903 X<bitwise xor> X<^>
904
905 Binary C<"|"> returns its operands ORed together bit by bit.
906
907 Binary C<"^"> returns its operands XORed together bit by bit.
908
909 Although no warning is currently raised, the results are not well
910 defined when these operations are performed on operands that aren't either
911 numbers (see L</Integer Arithmetic>) nor bitstrings (see L</Bitwise String
912 Operators>).
913
914 Note that C<"|"> and C<"^"> have lower priority than relational operators, so
915 for example the parentheses are essential in a test like
916
917     print "false\n" if (8 | 2) != 10;
918
919 If the "bitwise" feature is enabled via S<C<use feature 'bitwise'>> or
920 C<use v5.28>, then this operator always treats its operands as numbers.
921 Before Perl 5.28. this feature produced a warning in the
922 C<"experimental::bitwise"> category.
923
924 =head2 C-style Logical And
925 X<&&> X<logical and> X<operator, logical, and>
926
927 Binary C<"&&"> performs a short-circuit logical AND operation.  That is,
928 if the left operand is false, the right operand is not even evaluated.
929 Scalar or list context propagates down to the right operand if it
930 is evaluated.
931
932 =head2 C-style Logical Or
933 X<||> X<operator, logical, or>
934
935 Binary C<"||"> performs a short-circuit logical OR operation.  That is,
936 if the left operand is true, the right operand is not even evaluated.
937 Scalar or list context propagates down to the right operand if it
938 is evaluated.
939
940 =head2 Logical Defined-Or
941 X<//> X<operator, logical, defined-or>
942
943 Although it has no direct equivalent in C, Perl's C<//> operator is related
944 to its C-style "or".  In fact, it's exactly the same as C<||>, except that it
945 tests the left hand side's definedness instead of its truth.  Thus,
946 S<C<< EXPR1 // EXPR2 >>> returns the value of C<< EXPR1 >> if it's defined,
947 otherwise, the value of C<< EXPR2 >> is returned.
948 (C<< EXPR1 >> is evaluated in scalar context, C<< EXPR2 >>
949 in the context of C<< // >> itself).  Usually,
950 this is the same result as S<C<< defined(EXPR1) ? EXPR1 : EXPR2 >>> (except that
951 the ternary-operator form can be used as a lvalue, while S<C<< EXPR1 // EXPR2 >>>
952 cannot).  This is very useful for
953 providing default values for variables.  If you actually want to test if
954 at least one of C<$x> and C<$y> is defined, use S<C<defined($x // $y)>>.
955
956 The C<||>, C<//> and C<&&> operators return the last value evaluated
957 (unlike C's C<||> and C<&&>, which return 0 or 1).  Thus, a reasonably
958 portable way to find out the home directory might be:
959
960     $home =  $ENV{HOME}
961           // $ENV{LOGDIR}
962           // (getpwuid($<))[7]
963           // die "You're homeless!\n";
964
965 In particular, this means that you shouldn't use this
966 for selecting between two aggregates for assignment:
967
968     @a = @b || @c;            # This doesn't do the right thing
969     @a = scalar(@b) || @c;    # because it really means this.
970     @a = @b ? @b : @c;        # This works fine, though.
971
972 As alternatives to C<&&> and C<||> when used for
973 control flow, Perl provides the C<and> and C<or> operators (see below).
974 The short-circuit behavior is identical.  The precedence of C<"and">
975 and C<"or"> is much lower, however, so that you can safely use them after a
976 list operator without the need for parentheses:
977
978     unlink "alpha", "beta", "gamma"
979             or gripe(), next LINE;
980
981 With the C-style operators that would have been written like this:
982
983     unlink("alpha", "beta", "gamma")
984             || (gripe(), next LINE);
985
986 It would be even more readable to write that this way:
987
988     unless(unlink("alpha", "beta", "gamma")) {
989         gripe();
990         next LINE;
991     }
992
993 Using C<"or"> for assignment is unlikely to do what you want; see below.
994
995 =head2 Range Operators
996 X<operator, range> X<range> X<..> X<...>
997
998 Binary C<".."> is the range operator, which is really two different
999 operators depending on the context.  In list context, it returns a
1000 list of values counting (up by ones) from the left value to the right
1001 value.  If the left value is greater than the right value then it
1002 returns the empty list.  The range operator is useful for writing
1003 S<C<foreach (1..10)>> loops and for doing slice operations on arrays.  In
1004 the current implementation, no temporary array is created when the
1005 range operator is used as the expression in C<foreach> loops, but older
1006 versions of Perl might burn a lot of memory when you write something
1007 like this:
1008
1009     for (1 .. 1_000_000) {
1010         # code
1011     }
1012
1013 The range operator also works on strings, using the magical
1014 auto-increment, see below.
1015
1016 In scalar context, C<".."> returns a boolean value.  The operator is
1017 bistable, like a flip-flop, and emulates the line-range (comma)
1018 operator of B<sed>, B<awk>, and various editors.  Each C<".."> operator
1019 maintains its own boolean state, even across calls to a subroutine
1020 that contains it.  It is false as long as its left operand is false.
1021 Once the left operand is true, the range operator stays true until the
1022 right operand is true, I<AFTER> which the range operator becomes false
1023 again.  It doesn't become false till the next time the range operator
1024 is evaluated.  It can test the right operand and become false on the
1025 same evaluation it became true (as in B<awk>), but it still returns
1026 true once.  If you don't want it to test the right operand until the
1027 next evaluation, as in B<sed>, just use three dots (C<"...">) instead of
1028 two.  In all other regards, C<"..."> behaves just like C<".."> does.
1029
1030 The right operand is not evaluated while the operator is in the
1031 "false" state, and the left operand is not evaluated while the
1032 operator is in the "true" state.  The precedence is a little lower
1033 than || and &&.  The value returned is either the empty string for
1034 false, or a sequence number (beginning with 1) for true.  The sequence
1035 number is reset for each range encountered.  The final sequence number
1036 in a range has the string C<"E0"> appended to it, which doesn't affect
1037 its numeric value, but gives you something to search for if you want
1038 to exclude the endpoint.  You can exclude the beginning point by
1039 waiting for the sequence number to be greater than 1.
1040
1041 If either operand of scalar C<".."> is a constant expression,
1042 that operand is considered true if it is equal (C<==>) to the current
1043 input line number (the C<$.> variable).
1044
1045 To be pedantic, the comparison is actually S<C<int(EXPR) == int(EXPR)>>,
1046 but that is only an issue if you use a floating point expression; when
1047 implicitly using C<$.> as described in the previous paragraph, the
1048 comparison is S<C<int(EXPR) == int($.)>> which is only an issue when C<$.>
1049 is set to a floating point value and you are not reading from a file.
1050 Furthermore, S<C<"span" .. "spat">> or S<C<2.18 .. 3.14>> will not do what
1051 you want in scalar context because each of the operands are evaluated
1052 using their integer representation.
1053
1054 Examples:
1055
1056 As a scalar operator:
1057
1058     if (101 .. 200) { print; } # print 2nd hundred lines, short for
1059                                #  if ($. == 101 .. $. == 200) { print; }
1060
1061     next LINE if (1 .. /^$/);  # skip header lines, short for
1062                                #   next LINE if ($. == 1 .. /^$/);
1063                                # (typically in a loop labeled LINE)
1064
1065     s/^/> / if (/^$/ .. eof());  # quote body
1066
1067     # parse mail messages
1068     while (<>) {
1069         $in_header =   1  .. /^$/;
1070         $in_body   = /^$/ .. eof;
1071         if ($in_header) {
1072             # do something
1073         } else { # in body
1074             # do something else
1075         }
1076     } continue {
1077         close ARGV if eof;             # reset $. each file
1078     }
1079
1080 Here's a simple example to illustrate the difference between
1081 the two range operators:
1082
1083     @lines = ("   - Foo",
1084               "01 - Bar",
1085               "1  - Baz",
1086               "   - Quux");
1087
1088     foreach (@lines) {
1089         if (/0/ .. /1/) {
1090             print "$_\n";
1091         }
1092     }
1093
1094 This program will print only the line containing "Bar".  If
1095 the range operator is changed to C<...>, it will also print the
1096 "Baz" line.
1097
1098 And now some examples as a list operator:
1099
1100     for (101 .. 200) { print }      # print $_ 100 times
1101     @foo = @foo[0 .. $#foo];        # an expensive no-op
1102     @foo = @foo[$#foo-4 .. $#foo];  # slice last 5 items
1103
1104 Because each operand is evaluated in integer form, S<C<2.18 .. 3.14>> will
1105 return two elements in list context.
1106
1107     @list = (2.18 .. 3.14); # same as @list = (2 .. 3);
1108
1109 The range operator in list context can make use of the magical
1110 auto-increment algorithm if both operands are strings, subject to the
1111 following rules:
1112
1113 =over
1114
1115 =item *
1116
1117 With one exception (below), if both strings look like numbers to Perl,
1118 the magic increment will not be applied, and the strings will be treated
1119 as numbers (more specifically, integers) instead.
1120
1121 For example, C<"-2".."2"> is the same as C<-2..2>, and
1122 C<"2.18".."3.14"> produces C<2, 3>.
1123
1124 =item *
1125
1126 The exception to the above rule is when the left-hand string begins with
1127 C<0> and is longer than one character, in this case the magic increment
1128 I<will> be applied, even though strings like C<"01"> would normally look
1129 like a number to Perl.
1130
1131 For example, C<"01".."04"> produces C<"01", "02", "03", "04">, and
1132 C<"00".."-1"> produces C<"00"> through C<"99"> - this may seem
1133 surprising, but see the following rules for why it works this way.
1134 To get dates with leading zeros, you can say:
1135
1136     @z2 = ("01" .. "31");
1137     print $z2[$mday];
1138
1139 If you want to force strings to be interpreted as numbers, you could say
1140
1141     @numbers = ( 0+$first .. 0+$last );
1142
1143 =item *
1144
1145 If the initial value specified isn't part of a magical increment
1146 sequence (that is, a non-empty string matching C</^[a-zA-Z]*[0-9]*\z/>),
1147 only the initial value will be returned.
1148
1149 For example, C<"ax".."az"> produces C<"ax", "ay", "az">, but
1150 C<"*x".."az"> produces only C<"*x">.
1151
1152 =item *
1153
1154 For other initial values that are strings that do follow the rules of the
1155 magical increment, the corresponding sequence will be returned.
1156
1157 For example, you can say
1158
1159     @alphabet = ("A" .. "Z");
1160
1161 to get all normal letters of the English alphabet, or
1162
1163     $hexdigit = (0 .. 9, "a" .. "f")[$num & 15];
1164
1165 to get a hexadecimal digit.
1166
1167 =item *
1168
1169 If the final value specified is not in the sequence that the magical
1170 increment would produce, the sequence goes until the next value would
1171 be longer than the final value specified. If the length of the final
1172 string is shorter than the first, the empty list is returned.
1173
1174 For example, C<"a".."--"> is the same as C<"a".."zz">, C<"0".."xx">
1175 produces C<"0"> through C<"99">, and C<"aaa".."--"> returns the empty
1176 list.
1177
1178 =back
1179
1180 As of Perl 5.26, the list-context range operator on strings works as expected
1181 in the scope of L<< S<C<"use feature 'unicode_strings">>|feature/The
1182 'unicode_strings' feature >>. In previous versions, and outside the scope of
1183 that feature, it exhibits L<perlunicode/The "Unicode Bug">: its behavior
1184 depends on the internal encoding of the range endpoint.
1185
1186 Because the magical increment only works on non-empty strings matching
1187 C</^[a-zA-Z]*[0-9]*\z/>, the following will only return an alpha:
1188
1189     use charnames "greek";
1190     my @greek_small =  ("\N{alpha}" .. "\N{omega}");
1191
1192 To get the 25 traditional lowercase Greek letters, including both sigmas,
1193 you could use this instead:
1194
1195     use charnames "greek";
1196     my @greek_small =  map { chr } ( ord("\N{alpha}")
1197                                         ..
1198                                      ord("\N{omega}")
1199                                    );
1200
1201 However, because there are I<many> other lowercase Greek characters than
1202 just those, to match lowercase Greek characters in a regular expression,
1203 you could use the pattern C</(?:(?=\p{Greek})\p{Lower})+/> (or the
1204 L<experimental feature|perlrecharclass/Extended Bracketed Character
1205 Classes> C<S</(?[ \p{Greek} & \p{Lower} ])+/>>).
1206
1207 =head2 Conditional Operator
1208 X<operator, conditional> X<operator, ternary> X<ternary> X<?:>
1209
1210 Ternary C<"?:"> is the conditional operator, just as in C.  It works much
1211 like an if-then-else.  If the argument before the C<?> is true, the
1212 argument before the C<:> is returned, otherwise the argument after the
1213 C<:> is returned.  For example:
1214
1215     printf "I have %d dog%s.\n", $n,
1216             ($n == 1) ? "" : "s";
1217
1218 Scalar or list context propagates downward into the 2nd
1219 or 3rd argument, whichever is selected.
1220
1221     $x = $ok ? $y : $z;  # get a scalar
1222     @x = $ok ? @y : @z;  # get an array
1223     $x = $ok ? @y : @z;  # oops, that's just a count!
1224
1225 The operator may be assigned to if both the 2nd and 3rd arguments are
1226 legal lvalues (meaning that you can assign to them):
1227
1228     ($x_or_y ? $x : $y) = $z;
1229
1230 Because this operator produces an assignable result, using assignments
1231 without parentheses will get you in trouble.  For example, this:
1232
1233     $x % 2 ? $x += 10 : $x += 2
1234
1235 Really means this:
1236
1237     (($x % 2) ? ($x += 10) : $x) += 2
1238
1239 Rather than this:
1240
1241     ($x % 2) ? ($x += 10) : ($x += 2)
1242
1243 That should probably be written more simply as:
1244
1245     $x += ($x % 2) ? 10 : 2;
1246
1247 =head2 Assignment Operators
1248 X<assignment> X<operator, assignment> X<=> X<**=> X<+=> X<*=> X<&=>
1249 X<<< <<= >>> X<&&=> X<-=> X</=> X<|=> X<<< >>= >>> X<||=> X<//=> X<.=>
1250 X<%=> X<^=> X<x=> X<&.=> X<|.=> X<^.=>
1251
1252 C<"="> is the ordinary assignment operator.
1253
1254 Assignment operators work as in C.  That is,
1255
1256     $x += 2;
1257
1258 is equivalent to
1259
1260     $x = $x + 2;
1261
1262 although without duplicating any side effects that dereferencing the lvalue
1263 might trigger, such as from C<tie()>.  Other assignment operators work similarly.
1264 The following are recognized:
1265
1266     **=    +=    *=    &=    &.=    <<=    &&=
1267            -=    /=    |=    |.=    >>=    ||=
1268            .=    %=    ^=    ^.=           //=
1269                  x=
1270
1271 Although these are grouped by family, they all have the precedence
1272 of assignment.  These combined assignment operators can only operate on
1273 scalars, whereas the ordinary assignment operator can assign to arrays,
1274 hashes, lists and even references.  (See L<"Context"|perldata/Context>
1275 and L<perldata/List value constructors>, and L<perlref/Assigning to
1276 References>.)
1277
1278 Unlike in C, the scalar assignment operator produces a valid lvalue.
1279 Modifying an assignment is equivalent to doing the assignment and
1280 then modifying the variable that was assigned to.  This is useful
1281 for modifying a copy of something, like this:
1282
1283     ($tmp = $global) =~ tr/13579/24680/;
1284
1285 Although as of 5.14, that can be also be accomplished this way:
1286
1287     use v5.14;
1288     $tmp = ($global =~  tr/13579/24680/r);
1289
1290 Likewise,
1291
1292     ($x += 2) *= 3;
1293
1294 is equivalent to
1295
1296     $x += 2;
1297     $x *= 3;
1298
1299 Similarly, a list assignment in list context produces the list of
1300 lvalues assigned to, and a list assignment in scalar context returns
1301 the number of elements produced by the expression on the right hand
1302 side of the assignment.
1303
1304 The three dotted bitwise assignment operators (C<&.=> C<|.=> C<^.=>) are new in
1305 Perl 5.22.  See L</Bitwise String Operators>.
1306
1307 =head2 Comma Operator
1308 X<comma> X<operator, comma> X<,>
1309
1310 Binary C<","> is the comma operator.  In scalar context it evaluates
1311 its left argument, throws that value away, then evaluates its right
1312 argument and returns that value.  This is just like C's comma operator.
1313
1314 In list context, it's just the list argument separator, and inserts
1315 both its arguments into the list.  These arguments are also evaluated
1316 from left to right.
1317
1318 The C<< => >> operator (sometimes pronounced "fat comma") is a synonym
1319 for the comma except that it causes a
1320 word on its left to be interpreted as a string if it begins with a letter
1321 or underscore and is composed only of letters, digits and underscores.
1322 This includes operands that might otherwise be interpreted as operators,
1323 constants, single number v-strings or function calls.  If in doubt about
1324 this behavior, the left operand can be quoted explicitly.
1325
1326 Otherwise, the C<< => >> operator behaves exactly as the comma operator
1327 or list argument separator, according to context.
1328
1329 For example:
1330
1331     use constant FOO => "something";
1332
1333     my %h = ( FOO => 23 );
1334
1335 is equivalent to:
1336
1337     my %h = ("FOO", 23);
1338
1339 It is I<NOT>:
1340
1341     my %h = ("something", 23);
1342
1343 The C<< => >> operator is helpful in documenting the correspondence
1344 between keys and values in hashes, and other paired elements in lists.
1345
1346     %hash = ( $key => $value );
1347     login( $username => $password );
1348
1349 The special quoting behavior ignores precedence, and hence may apply to
1350 I<part> of the left operand:
1351
1352     print time.shift => "bbb";
1353
1354 That example prints something like C<"1314363215shiftbbb">, because the
1355 C<< => >> implicitly quotes the C<shift> immediately on its left, ignoring
1356 the fact that C<time.shift> is the entire left operand.
1357
1358 =head2 List Operators (Rightward)
1359 X<operator, list, rightward> X<list operator>
1360
1361 On the right side of a list operator, the comma has very low precedence,
1362 such that it controls all comma-separated expressions found there.
1363 The only operators with lower precedence are the logical operators
1364 C<"and">, C<"or">, and C<"not">, which may be used to evaluate calls to list
1365 operators without the need for parentheses:
1366
1367     open HANDLE, "< :encoding(UTF-8)", "filename"
1368         or die "Can't open: $!\n";
1369
1370 However, some people find that code harder to read than writing
1371 it with parentheses:
1372
1373     open(HANDLE, "< :encoding(UTF-8)", "filename")
1374         or die "Can't open: $!\n";
1375
1376 in which case you might as well just use the more customary C<"||"> operator:
1377
1378     open(HANDLE, "< :encoding(UTF-8)", "filename")
1379         || die "Can't open: $!\n";
1380
1381 See also discussion of list operators in L</Terms and List Operators (Leftward)>.
1382
1383 =head2 Logical Not
1384 X<operator, logical, not> X<not>
1385
1386 Unary C<"not"> returns the logical negation of the expression to its right.
1387 It's the equivalent of C<"!"> except for the very low precedence.
1388
1389 =head2 Logical And
1390 X<operator, logical, and> X<and>
1391
1392 Binary C<"and"> returns the logical conjunction of the two surrounding
1393 expressions.  It's equivalent to C<&&> except for the very low
1394 precedence.  This means that it short-circuits: the right
1395 expression is evaluated only if the left expression is true.
1396
1397 =head2 Logical or and Exclusive Or
1398 X<operator, logical, or> X<operator, logical, xor>
1399 X<operator, logical, exclusive or>
1400 X<or> X<xor>
1401
1402 Binary C<"or"> returns the logical disjunction of the two surrounding
1403 expressions.  It's equivalent to C<||> except for the very low precedence.
1404 This makes it useful for control flow:
1405
1406     print FH $data              or die "Can't write to FH: $!";
1407
1408 This means that it short-circuits: the right expression is evaluated
1409 only if the left expression is false.  Due to its precedence, you must
1410 be careful to avoid using it as replacement for the C<||> operator.
1411 It usually works out better for flow control than in assignments:
1412
1413     $x = $y or $z;              # bug: this is wrong
1414     ($x = $y) or $z;            # really means this
1415     $x = $y || $z;              # better written this way
1416
1417 However, when it's a list-context assignment and you're trying to use
1418 C<||> for control flow, you probably need C<"or"> so that the assignment
1419 takes higher precedence.
1420
1421     @info = stat($file) || die;     # oops, scalar sense of stat!
1422     @info = stat($file) or die;     # better, now @info gets its due
1423
1424 Then again, you could always use parentheses.
1425
1426 Binary C<"xor"> returns the exclusive-OR of the two surrounding expressions.
1427 It cannot short-circuit (of course).
1428
1429 There is no low precedence operator for defined-OR.
1430
1431 =head2 C Operators Missing From Perl
1432 X<operator, missing from perl> X<&> X<*>
1433 X<typecasting> X<(TYPE)>
1434
1435 Here is what C has that Perl doesn't:
1436
1437 =over 8
1438
1439 =item unary &
1440
1441 Address-of operator.  (But see the C<"\"> operator for taking a reference.)
1442
1443 =item unary *
1444
1445 Dereference-address operator.  (Perl's prefix dereferencing
1446 operators are typed: C<$>, C<@>, C<%>, and C<&>.)
1447
1448 =item (TYPE)
1449
1450 Type-casting operator.
1451
1452 =back
1453
1454 =head2 Quote and Quote-like Operators
1455 X<operator, quote> X<operator, quote-like> X<q> X<qq> X<qx> X<qw> X<m>
1456 X<qr> X<s> X<tr> X<'> X<''> X<"> X<""> X<//> X<`> X<``> X<<< << >>>
1457 X<escape sequence> X<escape>
1458
1459 While we usually think of quotes as literal values, in Perl they
1460 function as operators, providing various kinds of interpolating and
1461 pattern matching capabilities.  Perl provides customary quote characters
1462 for these behaviors, but also provides a way for you to choose your
1463 quote character for any of them.  In the following table, a C<{}> represents
1464 any pair of delimiters you choose.
1465
1466     Customary  Generic        Meaning        Interpolates
1467         ''       q{}          Literal             no
1468         ""      qq{}          Literal             yes
1469         ``      qx{}          Command             yes*
1470                 qw{}         Word list            no
1471         //       m{}       Pattern match          yes*
1472                 qr{}          Pattern             yes*
1473                  s{}{}      Substitution          yes*
1474                 tr{}{}    Transliteration         no (but see below)
1475                  y{}{}    Transliteration         no (but see below)
1476         <<EOF                 here-doc            yes*
1477
1478         * unless the delimiter is ''.
1479
1480 Non-bracketing delimiters use the same character fore and aft, but the four
1481 sorts of ASCII brackets (round, angle, square, curly) all nest, which means
1482 that
1483
1484     q{foo{bar}baz}
1485
1486 is the same as
1487
1488     'foo{bar}baz'
1489
1490 Note, however, that this does not always work for quoting Perl code:
1491
1492     $s = q{ if($x eq "}") ... }; # WRONG
1493
1494 is a syntax error.  The C<L<Text::Balanced>> module (standard as of v5.8,
1495 and from CPAN before then) is able to do this properly.
1496
1497 There can (and in some cases, must) be whitespace between the operator
1498 and the quoting
1499 characters, except when C<#> is being used as the quoting character.
1500 C<q#foo#> is parsed as the string C<foo>, while S<C<q #foo#>> is the
1501 operator C<q> followed by a comment.  Its argument will be taken
1502 from the next line.  This allows you to write:
1503
1504     s {foo}  # Replace foo
1505       {bar}  # with bar.
1506
1507 The cases where whitespace must be used are when the quoting character
1508 is a word character (meaning it matches C</\w/>):
1509
1510     q XfooX # Works: means the string 'foo'
1511     qXfooX  # WRONG!
1512
1513 The following escape sequences are available in constructs that interpolate,
1514 and in transliterations whose delimiters aren't single quotes (C<"'">).
1515 X<\t> X<\n> X<\r> X<\f> X<\b> X<\a> X<\e> X<\x> X<\0> X<\c> X<\N> X<\N{}>
1516 X<\o{}>
1517
1518     Sequence     Note  Description
1519     \t                  tab               (HT, TAB)
1520     \n                  newline           (NL)
1521     \r                  return            (CR)
1522     \f                  form feed         (FF)
1523     \b                  backspace         (BS)
1524     \a                  alarm (bell)      (BEL)
1525     \e                  escape            (ESC)
1526     \x{263A}     [1,8]  hex char          (example shown: SMILEY)
1527     \x1b         [2,8]  restricted range hex char (example: ESC)
1528     \N{name}     [3]    named Unicode character or character sequence
1529     \N{U+263D}   [4,8]  Unicode character (example: FIRST QUARTER MOON)
1530     \c[          [5]    control char      (example: chr(27))
1531     \o{23072}    [6,8]  octal char        (example: SMILEY)
1532     \033         [7,8]  restricted range octal char  (example: ESC)
1533
1534 =over 4
1535
1536 =item [1]
1537
1538 The result is the character specified by the hexadecimal number between
1539 the braces.  See L</[8]> below for details on which character.
1540
1541 Only hexadecimal digits are valid between the braces.  If an invalid
1542 character is encountered, a warning will be issued and the invalid
1543 character and all subsequent characters (valid or invalid) within the
1544 braces will be discarded.
1545
1546 If there are no valid digits between the braces, the generated character is
1547 the NULL character (C<\x{00}>).  However, an explicit empty brace (C<\x{}>)
1548 will not cause a warning (currently).
1549
1550 =item [2]
1551
1552 The result is the character specified by the hexadecimal number in the range
1553 0x00 to 0xFF.  See L</[8]> below for details on which character.
1554
1555 Only hexadecimal digits are valid following C<\x>.  When C<\x> is followed
1556 by fewer than two valid digits, any valid digits will be zero-padded.  This
1557 means that C<\x7> will be interpreted as C<\x07>, and a lone C<"\x"> will be
1558 interpreted as C<\x00>.  Except at the end of a string, having fewer than
1559 two valid digits will result in a warning.  Note that although the warning
1560 says the illegal character is ignored, it is only ignored as part of the
1561 escape and will still be used as the subsequent character in the string.
1562 For example:
1563
1564   Original    Result    Warns?
1565   "\x7"       "\x07"    no
1566   "\x"        "\x00"    no
1567   "\x7q"      "\x07q"   yes
1568   "\xq"       "\x00q"   yes
1569
1570 =item [3]
1571
1572 The result is the Unicode character or character sequence given by I<name>.
1573 See L<charnames>.
1574
1575 =item [4]
1576
1577 S<C<\N{U+I<hexadecimal number>}>> means the Unicode character whose Unicode code
1578 point is I<hexadecimal number>.
1579
1580 =item [5]
1581
1582 The character following C<\c> is mapped to some other character as shown in the
1583 table:
1584
1585  Sequence   Value
1586    \c@      chr(0)
1587    \cA      chr(1)
1588    \ca      chr(1)
1589    \cB      chr(2)
1590    \cb      chr(2)
1591    ...
1592    \cZ      chr(26)
1593    \cz      chr(26)
1594    \c[      chr(27)
1595                      # See below for chr(28)
1596    \c]      chr(29)
1597    \c^      chr(30)
1598    \c_      chr(31)
1599    \c?      chr(127) # (on ASCII platforms; see below for link to
1600                      #  EBCDIC discussion)
1601
1602 In other words, it's the character whose code point has had 64 xor'd with
1603 its uppercase.  C<\c?> is DELETE on ASCII platforms because
1604 S<C<ord("?") ^ 64>> is 127, and
1605 C<\c@> is NULL because the ord of C<"@"> is 64, so xor'ing 64 itself produces 0.
1606
1607 Also, C<\c\I<X>> yields S<C< chr(28) . "I<X>">> for any I<X>, but cannot come at the
1608 end of a string, because the backslash would be parsed as escaping the end
1609 quote.
1610
1611 On ASCII platforms, the resulting characters from the list above are the
1612 complete set of ASCII controls.  This isn't the case on EBCDIC platforms; see
1613 L<perlebcdic/OPERATOR DIFFERENCES> for a full discussion of the
1614 differences between these for ASCII versus EBCDIC platforms.
1615
1616 Use of any other character following the C<"c"> besides those listed above is
1617 discouraged, and as of Perl v5.20, the only characters actually allowed
1618 are the printable ASCII ones, minus the left brace C<"{">.  What happens
1619 for any of the allowed other characters is that the value is derived by
1620 xor'ing with the seventh bit, which is 64, and a warning raised if
1621 enabled.  Using the non-allowed characters generates a fatal error.
1622
1623 To get platform independent controls, you can use C<\N{...}>.
1624
1625 =item [6]
1626
1627 The result is the character specified by the octal number between the braces.
1628 See L</[8]> below for details on which character.
1629
1630 If a character that isn't an octal digit is encountered, a warning is raised,
1631 and the value is based on the octal digits before it, discarding it and all
1632 following characters up to the closing brace.  It is a fatal error if there are
1633 no octal digits at all.
1634
1635 =item [7]
1636
1637 The result is the character specified by the three-digit octal number in the
1638 range 000 to 777 (but best to not use above 077, see next paragraph).  See
1639 L</[8]> below for details on which character.
1640
1641 Some contexts allow 2 or even 1 digit, but any usage without exactly
1642 three digits, the first being a zero, may give unintended results.  (For
1643 example, in a regular expression it may be confused with a backreference;
1644 see L<perlrebackslash/Octal escapes>.)  Starting in Perl 5.14, you may
1645 use C<\o{}> instead, which avoids all these problems.  Otherwise, it is best to
1646 use this construct only for ordinals C<\077> and below, remembering to pad to
1647 the left with zeros to make three digits.  For larger ordinals, either use
1648 C<\o{}>, or convert to something else, such as to hex and use C<\N{U+}>
1649 (which is portable between platforms with different character sets) or
1650 C<\x{}> instead.
1651
1652 =item [8]
1653
1654 Several constructs above specify a character by a number.  That number
1655 gives the character's position in the character set encoding (indexed from 0).
1656 This is called synonymously its ordinal, code position, or code point.  Perl
1657 works on platforms that have a native encoding currently of either ASCII/Latin1
1658 or EBCDIC, each of which allow specification of 256 characters.  In general, if
1659 the number is 255 (0xFF, 0377) or below, Perl interprets this in the platform's
1660 native encoding.  If the number is 256 (0x100, 0400) or above, Perl interprets
1661 it as a Unicode code point and the result is the corresponding Unicode
1662 character.  For example C<\x{50}> and C<\o{120}> both are the number 80 in
1663 decimal, which is less than 256, so the number is interpreted in the native
1664 character set encoding.  In ASCII the character in the 80th position (indexed
1665 from 0) is the letter C<"P">, and in EBCDIC it is the ampersand symbol C<"&">.
1666 C<\x{100}> and C<\o{400}> are both 256 in decimal, so the number is interpreted
1667 as a Unicode code point no matter what the native encoding is.  The name of the
1668 character in the 256th position (indexed by 0) in Unicode is
1669 C<LATIN CAPITAL LETTER A WITH MACRON>.
1670
1671 An exception to the above rule is that S<C<\N{U+I<hex number>}>> is
1672 always interpreted as a Unicode code point, so that C<\N{U+0050}> is C<"P"> even
1673 on EBCDIC platforms.
1674
1675 =back
1676
1677 B<NOTE>: Unlike C and other languages, Perl has no C<\v> escape sequence for
1678 the vertical tab (VT, which is 11 in both ASCII and EBCDIC), but you may
1679 use C<\N{VT}>, C<\ck>, C<\N{U+0b}>, or C<\x0b>.  (C<\v>
1680 does have meaning in regular expression patterns in Perl, see L<perlre>.)
1681
1682 The following escape sequences are available in constructs that interpolate,
1683 but not in transliterations.
1684 X<\l> X<\u> X<\L> X<\U> X<\E> X<\Q> X<\F>
1685
1686     \l          lowercase next character only
1687     \u          titlecase (not uppercase!) next character only
1688     \L          lowercase all characters till \E or end of string
1689     \U          uppercase all characters till \E or end of string
1690     \F          foldcase all characters till \E or end of string
1691     \Q          quote (disable) pattern metacharacters till \E or
1692                 end of string
1693     \E          end either case modification or quoted section
1694                 (whichever was last seen)
1695
1696 See L<perlfunc/quotemeta> for the exact definition of characters that
1697 are quoted by C<\Q>.
1698
1699 C<\L>, C<\U>, C<\F>, and C<\Q> can stack, in which case you need one
1700 C<\E> for each.  For example:
1701
1702  say"This \Qquoting \ubusiness \Uhere isn't quite\E done yet,\E is it?";
1703  This quoting\ Business\ HERE\ ISN\'T\ QUITE\ done\ yet\, is it?
1704
1705 If a S<C<use locale>> form that includes C<LC_CTYPE> is in effect (see
1706 L<perllocale>), the case map used by C<\l>, C<\L>, C<\u>, and C<\U> is
1707 taken from the current locale.  If Unicode (for example, C<\N{}> or code
1708 points of 0x100 or beyond) is being used, the case map used by C<\l>,
1709 C<\L>, C<\u>, and C<\U> is as defined by Unicode.  That means that
1710 case-mapping a single character can sometimes produce a sequence of
1711 several characters.
1712 Under S<C<use locale>>, C<\F> produces the same results as C<\L>
1713 for all locales but a UTF-8 one, where it instead uses the Unicode
1714 definition.
1715
1716 All systems use the virtual C<"\n"> to represent a line terminator,
1717 called a "newline".  There is no such thing as an unvarying, physical
1718 newline character.  It is only an illusion that the operating system,
1719 device drivers, C libraries, and Perl all conspire to preserve.  Not all
1720 systems read C<"\r"> as ASCII CR and C<"\n"> as ASCII LF.  For example,
1721 on the ancient Macs (pre-MacOS X) of yesteryear, these used to be reversed,
1722 and on systems without a line terminator,
1723 printing C<"\n"> might emit no actual data.  In general, use C<"\n"> when
1724 you mean a "newline" for your system, but use the literal ASCII when you
1725 need an exact character.  For example, most networking protocols expect
1726 and prefer a CR+LF (C<"\015\012"> or C<"\cM\cJ">) for line terminators,
1727 and although they often accept just C<"\012">, they seldom tolerate just
1728 C<"\015">.  If you get in the habit of using C<"\n"> for networking,
1729 you may be burned some day.
1730 X<newline> X<line terminator> X<eol> X<end of line>
1731 X<\n> X<\r> X<\r\n>
1732
1733 For constructs that do interpolate, variables beginning with "C<$>"
1734 or "C<@>" are interpolated.  Subscripted variables such as C<$a[3]> or
1735 C<< $href->{key}[0] >> are also interpolated, as are array and hash slices.
1736 But method calls such as C<< $obj->meth >> are not.
1737
1738 Interpolating an array or slice interpolates the elements in order,
1739 separated by the value of C<$">, so is equivalent to interpolating
1740 S<C<join $", @array>>.  "Punctuation" arrays such as C<@*> are usually
1741 interpolated only if the name is enclosed in braces C<@{*}>, but the
1742 arrays C<@_>, C<@+>, and C<@-> are interpolated even without braces.
1743
1744 For double-quoted strings, the quoting from C<\Q> is applied after
1745 interpolation and escapes are processed.
1746
1747     "abc\Qfoo\tbar$s\Exyz"
1748
1749 is equivalent to
1750
1751     "abc" . quotemeta("foo\tbar$s") . "xyz"
1752
1753 For the pattern of regex operators (C<qr//>, C<m//> and C<s///>),
1754 the quoting from C<\Q> is applied after interpolation is processed,
1755 but before escapes are processed.  This allows the pattern to match
1756 literally (except for C<$> and C<@>).  For example, the following matches:
1757
1758     '\s\t' =~ /\Q\s\t/
1759
1760 Because C<$> or C<@> trigger interpolation, you'll need to use something
1761 like C</\Quser\E\@\Qhost/> to match them literally.
1762
1763 Patterns are subject to an additional level of interpretation as a
1764 regular expression.  This is done as a second pass, after variables are
1765 interpolated, so that regular expressions may be incorporated into the
1766 pattern from the variables.  If this is not what you want, use C<\Q> to
1767 interpolate a variable literally.
1768
1769 Apart from the behavior described above, Perl does not expand
1770 multiple levels of interpolation.  In particular, contrary to the
1771 expectations of shell programmers, back-quotes do I<NOT> interpolate
1772 within double quotes, nor do single quotes impede evaluation of
1773 variables when used within double quotes.
1774
1775 =head2 Regexp Quote-Like Operators
1776 X<operator, regexp>
1777
1778 Here are the quote-like operators that apply to pattern
1779 matching and related activities.
1780
1781 =over 8
1782
1783 =item C<qr/I<STRING>/msixpodualn>
1784 X<qr> X</i> X</m> X</o> X</s> X</x> X</p>
1785
1786 This operator quotes (and possibly compiles) its I<STRING> as a regular
1787 expression.  I<STRING> is interpolated the same way as I<PATTERN>
1788 in C<m/I<PATTERN>/>.  If C<"'"> is used as the delimiter, no variable
1789 interpolation is done.  Returns a Perl value which may be used instead of the
1790 corresponding C</I<STRING>/msixpodualn> expression.  The returned value is a
1791 normalized version of the original pattern.  It magically differs from
1792 a string containing the same characters: C<ref(qr/x/)> returns "Regexp";
1793 however, dereferencing it is not well defined (you currently get the
1794 normalized version of the original pattern, but this may change).
1795
1796
1797 For example,
1798
1799     $rex = qr/my.STRING/is;
1800     print $rex;                 # prints (?si-xm:my.STRING)
1801     s/$rex/foo/;
1802
1803 is equivalent to
1804
1805     s/my.STRING/foo/is;
1806
1807 The result may be used as a subpattern in a match:
1808
1809     $re = qr/$pattern/;
1810     $string =~ /foo${re}bar/;   # can be interpolated in other
1811                                 # patterns
1812     $string =~ $re;             # or used standalone
1813     $string =~ /$re/;           # or this way
1814
1815 Since Perl may compile the pattern at the moment of execution of the C<qr()>
1816 operator, using C<qr()> may have speed advantages in some situations,
1817 notably if the result of C<qr()> is used standalone:
1818
1819     sub match {
1820         my $patterns = shift;
1821         my @compiled = map qr/$_/i, @$patterns;
1822         grep {
1823             my $success = 0;
1824             foreach my $pat (@compiled) {
1825                 $success = 1, last if /$pat/;
1826             }
1827             $success;
1828         } @_;
1829     }
1830
1831 Precompilation of the pattern into an internal representation at
1832 the moment of C<qr()> avoids the need to recompile the pattern every
1833 time a match C</$pat/> is attempted.  (Perl has many other internal
1834 optimizations, but none would be triggered in the above example if
1835 we did not use C<qr()> operator.)
1836
1837 Options (specified by the following modifiers) are:
1838
1839     m   Treat string as multiple lines.
1840     s   Treat string as single line. (Make . match a newline)
1841     i   Do case-insensitive pattern matching.
1842     x   Use extended regular expressions; specifying two
1843         x's means \t and the SPACE character are ignored within
1844         square-bracketed character classes
1845     p   When matching preserve a copy of the matched string so
1846         that ${^PREMATCH}, ${^MATCH}, ${^POSTMATCH} will be
1847         defined (ignored starting in v5.20) as these are always
1848         defined starting in that release
1849     o   Compile pattern only once.
1850     a   ASCII-restrict: Use ASCII for \d, \s, \w and [[:posix:]]
1851         character classes; specifying two a's adds the further
1852         restriction that no ASCII character will match a
1853         non-ASCII one under /i.
1854     l   Use the current run-time locale's rules.
1855     u   Use Unicode rules.
1856     d   Use Unicode or native charset, as in 5.12 and earlier.
1857     n   Non-capture mode. Don't let () fill in $1, $2, etc...
1858
1859 If a precompiled pattern is embedded in a larger pattern then the effect
1860 of C<"msixpluadn"> will be propagated appropriately.  The effect that the
1861 C</o> modifier has is not propagated, being restricted to those patterns
1862 explicitly using it.
1863
1864 The C</a>, C</d>, C</l>, and C</u> modifiers (added in Perl 5.14)
1865 control the character set rules, but C</a> is the only one you are likely
1866 to want to specify explicitly; the other three are selected
1867 automatically by various pragmas.
1868
1869 See L<perlre> for additional information on valid syntax for I<STRING>, and
1870 for a detailed look at the semantics of regular expressions.  In
1871 particular, all modifiers except the largely obsolete C</o> are further
1872 explained in L<perlre/Modifiers>.  C</o> is described in the next section.
1873
1874 =item C<m/I<PATTERN>/msixpodualngc>
1875 X<m> X<operator, match>
1876 X<regexp, options> X<regexp> X<regex, options> X<regex>
1877 X</m> X</s> X</i> X</x> X</p> X</o> X</g> X</c>
1878
1879 =item C</I<PATTERN>/msixpodualngc>
1880
1881 Searches a string for a pattern match, and in scalar context returns
1882 true if it succeeds, false if it fails.  If no string is specified
1883 via the C<=~> or C<!~> operator, the C<$_> string is searched.  (The
1884 string specified with C<=~> need not be an lvalue--it may be the
1885 result of an expression evaluation, but remember the C<=~> binds
1886 rather tightly.)  See also L<perlre>.
1887
1888 Options are as described in C<qr//> above; in addition, the following match
1889 process modifiers are available:
1890
1891  g  Match globally, i.e., find all occurrences.
1892  c  Do not reset search position on a failed match when /g is
1893     in effect.
1894
1895 If C<"/"> is the delimiter then the initial C<m> is optional.  With the C<m>
1896 you can use any pair of non-whitespace (ASCII) characters
1897 as delimiters.  This is particularly useful for matching path names
1898 that contain C<"/">, to avoid LTS (leaning toothpick syndrome).  If C<"?"> is
1899 the delimiter, then a match-only-once rule applies,
1900 described in C<m?I<PATTERN>?> below.  If C<"'"> (single quote) is the delimiter,
1901 no variable interpolation is performed on the I<PATTERN>.
1902 When using a delimiter character valid in an identifier, whitespace is required
1903 after the C<m>.
1904
1905 I<PATTERN> may contain variables, which will be interpolated
1906 every time the pattern search is evaluated, except
1907 for when the delimiter is a single quote.  (Note that C<$(>, C<$)>, and
1908 C<$|> are not interpolated because they look like end-of-string tests.)
1909 Perl will not recompile the pattern unless an interpolated
1910 variable that it contains changes.  You can force Perl to skip the
1911 test and never recompile by adding a C</o> (which stands for "once")
1912 after the trailing delimiter.
1913 Once upon a time, Perl would recompile regular expressions
1914 unnecessarily, and this modifier was useful to tell it not to do so, in the
1915 interests of speed.  But now, the only reasons to use C</o> are one of:
1916
1917 =over
1918
1919 =item 1
1920
1921 The variables are thousands of characters long and you know that they
1922 don't change, and you need to wring out the last little bit of speed by
1923 having Perl skip testing for that.  (There is a maintenance penalty for
1924 doing this, as mentioning C</o> constitutes a promise that you won't
1925 change the variables in the pattern.  If you do change them, Perl won't
1926 even notice.)
1927
1928 =item 2
1929
1930 you want the pattern to use the initial values of the variables
1931 regardless of whether they change or not.  (But there are saner ways
1932 of accomplishing this than using C</o>.)
1933
1934 =item 3
1935
1936 If the pattern contains embedded code, such as
1937
1938     use re 'eval';
1939     $code = 'foo(?{ $x })';
1940     /$code/
1941
1942 then perl will recompile each time, even though the pattern string hasn't
1943 changed, to ensure that the current value of C<$x> is seen each time.
1944 Use C</o> if you want to avoid this.
1945
1946 =back
1947
1948 The bottom line is that using C</o> is almost never a good idea.
1949
1950 =item The empty pattern C<//>
1951
1952 If the I<PATTERN> evaluates to the empty string, the last
1953 I<successfully> matched regular expression is used instead.  In this
1954 case, only the C<g> and C<c> flags on the empty pattern are honored;
1955 the other flags are taken from the original pattern.  If no match has
1956 previously succeeded, this will (silently) act instead as a genuine
1957 empty pattern (which will always match).
1958
1959 Note that it's possible to confuse Perl into thinking C<//> (the empty
1960 regex) is really C<//> (the defined-or operator).  Perl is usually pretty
1961 good about this, but some pathological cases might trigger this, such as
1962 C<$x///> (is that S<C<($x) / (//)>> or S<C<$x // />>?) and S<C<print $fh //>>
1963 (S<C<print $fh(//>> or S<C<print($fh //>>?).  In all of these examples, Perl
1964 will assume you meant defined-or.  If you meant the empty regex, just
1965 use parentheses or spaces to disambiguate, or even prefix the empty
1966 regex with an C<m> (so C<//> becomes C<m//>).
1967
1968 =item Matching in list context
1969
1970 If the C</g> option is not used, C<m//> in list context returns a
1971 list consisting of the subexpressions matched by the parentheses in the
1972 pattern, that is, (C<$1>, C<$2>, C<$3>...)  (Note that here C<$1> etc. are
1973 also set).  When there are no parentheses in the pattern, the return
1974 value is the list C<(1)> for success.
1975 With or without parentheses, an empty list is returned upon failure.
1976
1977 Examples:
1978
1979  open(TTY, "+</dev/tty")
1980     || die "can't access /dev/tty: $!";
1981
1982  <TTY> =~ /^y/i && foo();       # do foo if desired
1983
1984  if (/Version: *([0-9.]*)/) { $version = $1; }
1985
1986  next if m#^/usr/spool/uucp#;
1987
1988  # poor man's grep
1989  $arg = shift;
1990  while (<>) {
1991     print if /$arg/o; # compile only once (no longer needed!)
1992  }
1993
1994  if (($F1, $F2, $Etc) = ($foo =~ /^(\S+)\s+(\S+)\s*(.*)/))
1995
1996 This last example splits C<$foo> into the first two words and the
1997 remainder of the line, and assigns those three fields to C<$F1>, C<$F2>, and
1998 C<$Etc>.  The conditional is true if any variables were assigned; that is,
1999 if the pattern matched.
2000
2001 The C</g> modifier specifies global pattern matching--that is,
2002 matching as many times as possible within the string.  How it behaves
2003 depends on the context.  In list context, it returns a list of the
2004 substrings matched by any capturing parentheses in the regular
2005 expression.  If there are no parentheses, it returns a list of all
2006 the matched strings, as if there were parentheses around the whole
2007 pattern.
2008
2009 In scalar context, each execution of C<m//g> finds the next match,
2010 returning true if it matches, and false if there is no further match.
2011 The position after the last match can be read or set using the C<pos()>
2012 function; see L<perlfunc/pos>.  A failed match normally resets the
2013 search position to the beginning of the string, but you can avoid that
2014 by adding the C</c> modifier (for example, C<m//gc>).  Modifying the target
2015 string also resets the search position.
2016
2017 =item C<\G I<assertion>>
2018
2019 You can intermix C<m//g> matches with C<m/\G.../g>, where C<\G> is a
2020 zero-width assertion that matches the exact position where the
2021 previous C<m//g>, if any, left off.  Without the C</g> modifier, the
2022 C<\G> assertion still anchors at C<pos()> as it was at the start of
2023 the operation (see L<perlfunc/pos>), but the match is of course only
2024 attempted once.  Using C<\G> without C</g> on a target string that has
2025 not previously had a C</g> match applied to it is the same as using
2026 the C<\A> assertion to match the beginning of the string.  Note also
2027 that, currently, C<\G> is only properly supported when anchored at the
2028 very beginning of the pattern.
2029
2030 Examples:
2031
2032     # list context
2033     ($one,$five,$fifteen) = (`uptime` =~ /(\d+\.\d+)/g);
2034
2035     # scalar context
2036     local $/ = "";
2037     while ($paragraph = <>) {
2038         while ($paragraph =~ /\p{Ll}['")]*[.!?]+['")]*\s/g) {
2039             $sentences++;
2040         }
2041     }
2042     say $sentences;
2043
2044 Here's another way to check for sentences in a paragraph:
2045
2046  my $sentence_rx = qr{
2047     (?: (?<= ^ ) | (?<= \s ) )  # after start-of-string or
2048                                 # whitespace
2049     \p{Lu}                      # capital letter
2050     .*?                         # a bunch of anything
2051     (?<= \S )                   # that ends in non-
2052                                 # whitespace
2053     (?<! \b [DMS]r  )           # but isn't a common abbr.
2054     (?<! \b Mrs )
2055     (?<! \b Sra )
2056     (?<! \b St  )
2057     [.?!]                       # followed by a sentence
2058                                 # ender
2059     (?= $ | \s )                # in front of end-of-string
2060                                 # or whitespace
2061  }sx;
2062  local $/ = "";
2063  while (my $paragraph = <>) {
2064     say "NEW PARAGRAPH";
2065     my $count = 0;
2066     while ($paragraph =~ /($sentence_rx)/g) {
2067         printf "\tgot sentence %d: <%s>\n", ++$count, $1;
2068     }
2069  }
2070
2071 Here's how to use C<m//gc> with C<\G>:
2072
2073     $_ = "ppooqppqq";
2074     while ($i++ < 2) {
2075         print "1: '";
2076         print $1 while /(o)/gc; print "', pos=", pos, "\n";
2077         print "2: '";
2078         print $1 if /\G(q)/gc;  print "', pos=", pos, "\n";
2079         print "3: '";
2080         print $1 while /(p)/gc; print "', pos=", pos, "\n";
2081     }
2082     print "Final: '$1', pos=",pos,"\n" if /\G(.)/;
2083
2084 The last example should print:
2085
2086     1: 'oo', pos=4
2087     2: 'q', pos=5
2088     3: 'pp', pos=7
2089     1: '', pos=7
2090     2: 'q', pos=8
2091     3: '', pos=8
2092     Final: 'q', pos=8
2093
2094 Notice that the final match matched C<q> instead of C<p>, which a match
2095 without the C<\G> anchor would have done.  Also note that the final match
2096 did not update C<pos>.  C<pos> is only updated on a C</g> match.  If the
2097 final match did indeed match C<p>, it's a good bet that you're running an
2098 ancient (pre-5.6.0) version of Perl.
2099
2100 A useful idiom for C<lex>-like scanners is C</\G.../gc>.  You can
2101 combine several regexps like this to process a string part-by-part,
2102 doing different actions depending on which regexp matched.  Each
2103 regexp tries to match where the previous one leaves off.
2104
2105  $_ = <<'EOL';
2106     $url = URI::URL->new( "http://example.com/" );
2107     die if $url eq "xXx";
2108  EOL
2109
2110  LOOP: {
2111      print(" digits"),       redo LOOP if /\G\d+\b[,.;]?\s*/gc;
2112      print(" lowercase"),    redo LOOP
2113                                     if /\G\p{Ll}+\b[,.;]?\s*/gc;
2114      print(" UPPERCASE"),    redo LOOP
2115                                     if /\G\p{Lu}+\b[,.;]?\s*/gc;
2116      print(" Capitalized"),  redo LOOP
2117                               if /\G\p{Lu}\p{Ll}+\b[,.;]?\s*/gc;
2118      print(" MiXeD"),        redo LOOP if /\G\pL+\b[,.;]?\s*/gc;
2119      print(" alphanumeric"), redo LOOP
2120                             if /\G[\p{Alpha}\pN]+\b[,.;]?\s*/gc;
2121      print(" line-noise"),   redo LOOP if /\G\W+/gc;
2122      print ". That's all!\n";
2123  }
2124
2125 Here is the output (split into several lines):
2126
2127  line-noise lowercase line-noise UPPERCASE line-noise UPPERCASE
2128  line-noise lowercase line-noise lowercase line-noise lowercase
2129  lowercase line-noise lowercase lowercase line-noise lowercase
2130  lowercase line-noise MiXeD line-noise. That's all!
2131
2132 =item C<m?I<PATTERN>?msixpodualngc>
2133 X<?> X<operator, match-once>
2134
2135 This is just like the C<m/I<PATTERN>/> search, except that it matches
2136 only once between calls to the C<reset()> operator.  This is a useful
2137 optimization when you want to see only the first occurrence of
2138 something in each file of a set of files, for instance.  Only C<m??>
2139 patterns local to the current package are reset.
2140
2141     while (<>) {
2142         if (m?^$?) {
2143                             # blank line between header and body
2144         }
2145     } continue {
2146         reset if eof;       # clear m?? status for next file
2147     }
2148
2149 Another example switched the first "latin1" encoding it finds
2150 to "utf8" in a pod file:
2151
2152     s//utf8/ if m? ^ =encoding \h+ \K latin1 ?x;
2153
2154 The match-once behavior is controlled by the match delimiter being
2155 C<?>; with any other delimiter this is the normal C<m//> operator.
2156
2157 In the past, the leading C<m> in C<m?I<PATTERN>?> was optional, but omitting it
2158 would produce a deprecation warning.  As of v5.22.0, omitting it produces a
2159 syntax error.  If you encounter this construct in older code, you can just add
2160 C<m>.
2161
2162 =item C<s/I<PATTERN>/I<REPLACEMENT>/msixpodualngcer>
2163 X<s> X<substitute> X<substitution> X<replace> X<regexp, replace>
2164 X<regexp, substitute> X</m> X</s> X</i> X</x> X</p> X</o> X</g> X</c> X</e> X</r>
2165
2166 Searches a string for a pattern, and if found, replaces that pattern
2167 with the replacement text and returns the number of substitutions
2168 made.  Otherwise it returns false (a value that is both an empty string (C<"">)
2169 and numeric zero (C<0>) as described in L</Relational Operators>).
2170
2171 If the C</r> (non-destructive) option is used then it runs the
2172 substitution on a copy of the string and instead of returning the
2173 number of substitutions, it returns the copy whether or not a
2174 substitution occurred.  The original string is never changed when
2175 C</r> is used.  The copy will always be a plain string, even if the
2176 input is an object or a tied variable.
2177
2178 If no string is specified via the C<=~> or C<!~> operator, the C<$_>
2179 variable is searched and modified.  Unless the C</r> option is used,
2180 the string specified must be a scalar variable, an array element, a
2181 hash element, or an assignment to one of those; that is, some sort of
2182 scalar lvalue.
2183
2184 If the delimiter chosen is a single quote, no variable interpolation is
2185 done on either the I<PATTERN> or the I<REPLACEMENT>.  Otherwise, if the
2186 I<PATTERN> contains a C<$> that looks like a variable rather than an
2187 end-of-string test, the variable will be interpolated into the pattern
2188 at run-time.  If you want the pattern compiled only once the first time
2189 the variable is interpolated, use the C</o> option.  If the pattern
2190 evaluates to the empty string, the last successfully executed regular
2191 expression is used instead.  See L<perlre> for further explanation on these.
2192
2193 Options are as with C<m//> with the addition of the following replacement
2194 specific options:
2195
2196     e   Evaluate the right side as an expression.
2197     ee  Evaluate the right side as a string then eval the
2198         result.
2199     r   Return substitution and leave the original string
2200         untouched.
2201
2202 Any non-whitespace delimiter may replace the slashes.  Add space after
2203 the C<s> when using a character allowed in identifiers.  If single quotes
2204 are used, no interpretation is done on the replacement string (the C</e>
2205 modifier overrides this, however).  Note that Perl treats backticks
2206 as normal delimiters; the replacement text is not evaluated as a command.
2207 If the I<PATTERN> is delimited by bracketing quotes, the I<REPLACEMENT> has
2208 its own pair of quotes, which may or may not be bracketing quotes, for example,
2209 C<s(foo)(bar)> or C<< s<foo>/bar/ >>.  A C</e> will cause the
2210 replacement portion to be treated as a full-fledged Perl expression
2211 and evaluated right then and there.  It is, however, syntax checked at
2212 compile-time.  A second C<e> modifier will cause the replacement portion
2213 to be C<eval>ed before being run as a Perl expression.
2214
2215 Examples:
2216
2217     s/\bgreen\b/mauve/g;              # don't change wintergreen
2218
2219     $path =~ s|/usr/bin|/usr/local/bin|;
2220
2221     s/Login: $foo/Login: $bar/; # run-time pattern
2222
2223     ($foo = $bar) =~ s/this/that/;      # copy first, then
2224                                         # change
2225     ($foo = "$bar") =~ s/this/that/;    # convert to string,
2226                                         # copy, then change
2227     $foo = $bar =~ s/this/that/r;       # Same as above using /r
2228     $foo = $bar =~ s/this/that/r
2229                 =~ s/that/the other/r;  # Chained substitutes
2230                                         # using /r
2231     @foo = map { s/this/that/r } @bar   # /r is very useful in
2232                                         # maps
2233
2234     $count = ($paragraph =~ s/Mister\b/Mr./g);  # get change-cnt
2235
2236     $_ = 'abc123xyz';
2237     s/\d+/$&*2/e;               # yields 'abc246xyz'
2238     s/\d+/sprintf("%5d",$&)/e;  # yields 'abc  246xyz'
2239     s/\w/$& x 2/eg;             # yields 'aabbcc  224466xxyyzz'
2240
2241     s/%(.)/$percent{$1}/g;      # change percent escapes; no /e
2242     s/%(.)/$percent{$1} || $&/ge;       # expr now, so /e
2243     s/^=(\w+)/pod($1)/ge;       # use function call
2244
2245     $_ = 'abc123xyz';
2246     $x = s/abc/def/r;           # $x is 'def123xyz' and
2247                                 # $_ remains 'abc123xyz'.
2248
2249     # expand variables in $_, but dynamics only, using
2250     # symbolic dereferencing
2251     s/\$(\w+)/${$1}/g;
2252
2253     # Add one to the value of any numbers in the string
2254     s/(\d+)/1 + $1/eg;
2255
2256     # Titlecase words in the last 30 characters only
2257     substr($str, -30) =~ s/\b(\p{Alpha}+)\b/\u\L$1/g;
2258
2259     # This will expand any embedded scalar variable
2260     # (including lexicals) in $_ : First $1 is interpolated
2261     # to the variable name, and then evaluated
2262     s/(\$\w+)/$1/eeg;
2263
2264     # Delete (most) C comments.
2265     $program =~ s {
2266         /\*     # Match the opening delimiter.
2267         .*?     # Match a minimal number of characters.
2268         \*/     # Match the closing delimiter.
2269     } []gsx;
2270
2271     s/^\s*(.*?)\s*$/$1/;        # trim whitespace in $_,
2272                                 # expensively
2273
2274     for ($variable) {           # trim whitespace in $variable,
2275                                 # cheap
2276         s/^\s+//;
2277         s/\s+$//;
2278     }
2279
2280     s/([^ ]*) *([^ ]*)/$2 $1/;  # reverse 1st two fields
2281
2282     $foo !~ s/A/a/g;    # Lowercase all A's in $foo; return
2283                         # 0 if any were found and changed;
2284                         # otherwise return 1
2285
2286 Note the use of C<$> instead of C<\> in the last example.  Unlike
2287 B<sed>, we use the \<I<digit>> form only in the left hand side.
2288 Anywhere else it's $<I<digit>>.
2289
2290 Occasionally, you can't use just a C</g> to get all the changes
2291 to occur that you might want.  Here are two common cases:
2292
2293     # put commas in the right places in an integer
2294     1 while s/(\d)(\d\d\d)(?!\d)/$1,$2/g;
2295
2296     # expand tabs to 8-column spacing
2297     1 while s/\t+/' ' x (length($&)*8 - length($`)%8)/e;
2298
2299 X</c>While C<s///> accepts the C</c> flag, it has no effect beyond
2300 producing a warning if warnings are enabled.
2301
2302 =back
2303
2304 =head2 Quote-Like Operators
2305 X<operator, quote-like>
2306
2307 =over 4
2308
2309 =item C<q/I<STRING>/>
2310 X<q> X<quote, single> X<'> X<''>
2311
2312 =item C<'I<STRING>'>
2313
2314 A single-quoted, literal string.  A backslash represents a backslash
2315 unless followed by the delimiter or another backslash, in which case
2316 the delimiter or backslash is interpolated.
2317
2318     $foo = q!I said, "You said, 'She said it.'"!;
2319     $bar = q('This is it.');
2320     $baz = '\n';                # a two-character string
2321
2322 =item C<qq/I<STRING>/>
2323 X<qq> X<quote, double> X<"> X<"">
2324
2325 =item C<"I<STRING>">
2326
2327 A double-quoted, interpolated string.
2328
2329     $_ .= qq
2330      (*** The previous line contains the naughty word "$1".\n)
2331                 if /\b(tcl|java|python)\b/i;      # :-)
2332     $baz = "\n";                # a one-character string
2333
2334 =item C<qx/I<STRING>/>
2335 X<qx> X<`> X<``> X<backtick>
2336
2337 =item C<`I<STRING>`>
2338
2339 A string which is (possibly) interpolated and then executed as a
2340 system command with F</bin/sh> or its equivalent.  Shell wildcards,
2341 pipes, and redirections will be honored.  The collected standard
2342 output of the command is returned; standard error is unaffected.  In
2343 scalar context, it comes back as a single (potentially multi-line)
2344 string, or C<undef> if the command failed.  In list context, returns a
2345 list of lines (however you've defined lines with C<$/> or
2346 C<$INPUT_RECORD_SEPARATOR>), or an empty list if the command failed.
2347
2348 Because backticks do not affect standard error, use shell file descriptor
2349 syntax (assuming the shell supports this) if you care to address this.
2350 To capture a command's STDERR and STDOUT together:
2351
2352     $output = `cmd 2>&1`;
2353
2354 To capture a command's STDOUT but discard its STDERR:
2355
2356     $output = `cmd 2>/dev/null`;
2357
2358 To capture a command's STDERR but discard its STDOUT (ordering is
2359 important here):
2360
2361     $output = `cmd 2>&1 1>/dev/null`;
2362
2363 To exchange a command's STDOUT and STDERR in order to capture the STDERR
2364 but leave its STDOUT to come out the old STDERR:
2365
2366     $output = `cmd 3>&1 1>&2 2>&3 3>&-`;
2367
2368 To read both a command's STDOUT and its STDERR separately, it's easiest
2369 to redirect them separately to files, and then read from those files
2370 when the program is done:
2371
2372     system("program args 1>program.stdout 2>program.stderr");
2373
2374 The STDIN filehandle used by the command is inherited from Perl's STDIN.
2375 For example:
2376
2377     open(SPLAT, "stuff")   || die "can't open stuff: $!";
2378     open(STDIN, "<&SPLAT") || die "can't dupe SPLAT: $!";
2379     print STDOUT `sort`;
2380
2381 will print the sorted contents of the file named F<"stuff">.
2382
2383 Using single-quote as a delimiter protects the command from Perl's
2384 double-quote interpolation, passing it on to the shell instead:
2385
2386     $perl_info  = qx(ps $$);            # that's Perl's $$
2387     $shell_info = qx'ps $$';            # that's the new shell's $$
2388
2389 How that string gets evaluated is entirely subject to the command
2390 interpreter on your system.  On most platforms, you will have to protect
2391 shell metacharacters if you want them treated literally.  This is in
2392 practice difficult to do, as it's unclear how to escape which characters.
2393 See L<perlsec> for a clean and safe example of a manual C<fork()> and C<exec()>
2394 to emulate backticks safely.
2395
2396 On some platforms (notably DOS-like ones), the shell may not be
2397 capable of dealing with multiline commands, so putting newlines in
2398 the string may not get you what you want.  You may be able to evaluate
2399 multiple commands in a single line by separating them with the command
2400 separator character, if your shell supports that (for example, C<;> on
2401 many Unix shells and C<&> on the Windows NT C<cmd> shell).
2402
2403 Perl will attempt to flush all files opened for
2404 output before starting the child process, but this may not be supported
2405 on some platforms (see L<perlport>).  To be safe, you may need to set
2406 C<$|> (C<$AUTOFLUSH> in C<L<English>>) or call the C<autoflush()> method of
2407 C<L<IO::Handle>> on any open handles.
2408
2409 Beware that some command shells may place restrictions on the length
2410 of the command line.  You must ensure your strings don't exceed this
2411 limit after any necessary interpolations.  See the platform-specific
2412 release notes for more details about your particular environment.
2413
2414 Using this operator can lead to programs that are difficult to port,
2415 because the shell commands called vary between systems, and may in
2416 fact not be present at all.  As one example, the C<type> command under
2417 the POSIX shell is very different from the C<type> command under DOS.
2418 That doesn't mean you should go out of your way to avoid backticks
2419 when they're the right way to get something done.  Perl was made to be
2420 a glue language, and one of the things it glues together is commands.
2421 Just understand what you're getting yourself into.
2422
2423 Like C<system>, backticks put the child process exit code in C<$?>.
2424 If you'd like to manually inspect failure, you can check all possible
2425 failure modes by inspecting C<$?> like this:
2426
2427     if ($? == -1) {
2428         print "failed to execute: $!\n";
2429     }
2430     elsif ($? & 127) {
2431         printf "child died with signal %d, %s coredump\n",
2432             ($? & 127),  ($? & 128) ? 'with' : 'without';
2433     }
2434     else {
2435         printf "child exited with value %d\n", $? >> 8;
2436     }
2437
2438 Use the L<open> pragma to control the I/O layers used when reading the
2439 output of the command, for example:
2440
2441   use open IN => ":encoding(UTF-8)";
2442   my $x = `cmd-producing-utf-8`;
2443
2444 C<qx//> can also be called like a function with L<perlfunc/readpipe>.
2445
2446 See L</"I/O Operators"> for more discussion.
2447
2448 =item C<qw/I<STRING>/>
2449 X<qw> X<quote, list> X<quote, words>
2450
2451 Evaluates to a list of the words extracted out of I<STRING>, using embedded
2452 whitespace as the word delimiters.  It can be understood as being roughly
2453 equivalent to:
2454
2455     split(" ", q/STRING/);
2456
2457 the differences being that it only splits on ASCII whitespace,
2458 generates a real list at compile time, and
2459 in scalar context it returns the last element in the list.  So
2460 this expression:
2461
2462     qw(foo bar baz)
2463
2464 is semantically equivalent to the list:
2465
2466     "foo", "bar", "baz"
2467
2468 Some frequently seen examples:
2469
2470     use POSIX qw( setlocale localeconv )
2471     @EXPORT = qw( foo bar baz );
2472
2473 A common mistake is to try to separate the words with commas or to
2474 put comments into a multi-line C<qw>-string.  For this reason, the
2475 S<C<use warnings>> pragma and the B<-w> switch (that is, the C<$^W> variable)
2476 produces warnings if the I<STRING> contains the C<","> or the C<"#"> character.
2477
2478 =item C<tr/I<SEARCHLIST>/I<REPLACEMENTLIST>/cdsr>
2479 X<tr> X<y> X<transliterate> X</c> X</d> X</s>
2480
2481 =item C<y/I<SEARCHLIST>/I<REPLACEMENTLIST>/cdsr>
2482
2483 Transliterates all occurrences of the characters found (or not found
2484 if the C</c> modifier is specified) in the search list with the
2485 positionally corresponding character in the replacement list, possibly
2486 deleting some, depending on the modifiers specified.  It returns the
2487 number of characters replaced or deleted.  If no string is specified via
2488 the C<=~> or C<!~> operator, the C<$_> string is transliterated.
2489
2490 For B<sed> devotees, C<y> is provided as a synonym for C<tr>.
2491
2492 If the C</r> (non-destructive) option is present, a new copy of the string
2493 is made and its characters transliterated, and this copy is returned no
2494 matter whether it was modified or not: the original string is always
2495 left unchanged.  The new copy is always a plain string, even if the input
2496 string is an object or a tied variable.
2497
2498 Unless the C</r> option is used, the string specified with C<=~> must be a
2499 scalar variable, an array element, a hash element, or an assignment to one
2500 of those; in other words, an lvalue.
2501
2502 If the characters delimiting I<SEARCHLIST> and I<REPLACEMENTLIST>
2503 are single quotes (C<tr'I<SEARCHLIST>'I<REPLACEMENTLIST>'>), the only
2504 interpolation is removal of C<\> from pairs of C<\\>.
2505
2506 Otherwise, a character range may be specified with a hyphen, so
2507 C<tr/A-J/0-9/> does the same replacement as
2508 C<tr/ACEGIBDFHJ/0246813579/>.
2509
2510 If the I<SEARCHLIST> is delimited by bracketing quotes, the
2511 I<REPLACEMENTLIST> must have its own pair of quotes, which may or may
2512 not be bracketing quotes; for example, C<tr[aeiouy][yuoiea]> or
2513 C<tr(+\-*/)/ABCD/>.
2514
2515 Characters may be literals, or (if the delimiters aren't single quotes)
2516 any of the escape sequences accepted in double-quoted strings.  But
2517 there is never any variable interpolation, so C<"$"> and C<"@"> are
2518 always treated as literals.  A hyphen at the beginning or end, or
2519 preceded by a backslash is also always considered a literal.  Escape
2520 sequence details are in L<the table near the beginning of this
2521 section|/Quote and Quote-like Operators>.
2522
2523 Note that C<tr> does B<not> do regular expression character classes such as
2524 C<\d> or C<\pL>.  The C<tr> operator is not equivalent to the C<L<tr(1)>>
2525 utility.  C<tr[a-z][A-Z]> will uppercase the 26 letters "a" through "z",
2526 but for case changing not confined to ASCII, use
2527 L<C<lc>|perlfunc/lc>, L<C<uc>|perlfunc/uc>,
2528 L<C<lcfirst>|perlfunc/lcfirst>, L<C<ucfirst>|perlfunc/ucfirst>
2529 (all documented in L<perlfunc>), or the
2530 L<substitution operator C<sE<sol>I<PATTERN>E<sol>I<REPLACEMENT>E<sol>>|/sE<sol>PATTERNE<sol>REPLACEMENTE<sol>msixpodualngcer>
2531 (with C<\U>, C<\u>, C<\L>, and C<\l> string-interpolation escapes in the
2532 I<REPLACEMENT> portion).
2533
2534 Most ranges are unportable between character sets, but certain ones
2535 signal Perl to do special handling to make them portable.  There are two
2536 classes of portable ranges.  The first are any subsets of the ranges
2537 C<A-Z>, C<a-z>, and C<0-9>, when expressed as literal characters.
2538
2539   tr/h-k/H-K/
2540
2541 capitalizes the letters C<"h">, C<"i">, C<"j">, and C<"k"> and nothing
2542 else, no matter what the platform's character set is.  In contrast, all
2543 of
2544
2545   tr/\x68-\x6B/\x48-\x4B/
2546   tr/h-\x6B/H-\x4B/
2547   tr/\x68-k/\x48-K/
2548
2549 do the same capitalizations as the previous example when run on ASCII
2550 platforms, but something completely different on EBCDIC ones.
2551
2552 The second class of portable ranges is invoked when one or both of the
2553 range's end points are expressed as C<\N{...}>
2554
2555  $string =~ tr/\N{U+20}-\N{U+7E}//d;
2556
2557 removes from C<$string> all the platform's characters which are
2558 equivalent to any of Unicode U+0020, U+0021, ... U+007D, U+007E.  This
2559 is a portable range, and has the same effect on every platform it is
2560 run on.  In this example, these are the ASCII
2561 printable characters.  So after this is run, C<$string> has only
2562 controls and characters which have no ASCII equivalents.
2563
2564 But, even for portable ranges, it is not generally obvious what is
2565 included without having to look things up in the manual.  A sound
2566 principle is to use only ranges that both begin from, and end at, either
2567 ASCII alphabetics of equal case (C<b-e>, C<B-E>), or digits (C<1-4>).
2568 Anything else is unclear (and unportable unless C<\N{...}> is used).  If
2569 in doubt, spell out the character sets in full.
2570
2571 Options:
2572
2573     c   Complement the SEARCHLIST.
2574     d   Delete found but unreplaced characters.
2575     r   Return the modified string and leave the original string
2576         untouched.
2577     s   Squash duplicate replaced characters.
2578
2579 If the C</d> modifier is specified, any characters specified by
2580 I<SEARCHLIST>  not found in I<REPLACEMENTLIST> are deleted.  (Note that
2581 this is slightly more flexible than the behavior of some B<tr> programs,
2582 which delete anything they find in the I<SEARCHLIST>, period.)
2583
2584 If the C</s> modifier is specified, sequences of characters, all in a
2585 row, that were transliterated to the same character are squashed down to
2586 a single instance of that character.
2587
2588  my $a = "aaaba"
2589  $a =~ tr/a/a/s     # $a now is "aba"
2590
2591 If the C</d> modifier is used, the I<REPLACEMENTLIST> is always interpreted
2592 exactly as specified.  Otherwise, if the I<REPLACEMENTLIST> is shorter
2593 than the I<SEARCHLIST>, the final character, if any, is replicated until
2594 it is long enough.  There won't be a final character if and only if the
2595 I<REPLACEMENTLIST> is empty, in which case I<REPLACEMENTLIST> is
2596 copied from I<SEARCHLIST>.    An empty I<REPLACEMENTLIST> is useful
2597 for counting characters in a class, or for squashing character sequences
2598 in a class.
2599
2600     tr/abcd//            tr/abcd/abcd/
2601     tr/abcd/AB/          tr/abcd/ABBB/
2602     tr/abcd//d           s/[abcd]//g
2603     tr/abcd/AB/d         (tr/ab/AB/ + s/[cd]//g)  - but run together
2604
2605 If the C</c> modifier is specified, the characters to be transliterated
2606 are the ones NOT in I<SEARCHLIST>, that is, it is complemented.  If
2607 C</d> and/or C</s> are also specified, they apply to the complemented
2608 I<SEARCHLIST>.  Recall, that if I<REPLACEMENTLIST> is empty (except
2609 under C</d>) a copy of I<SEARCHLIST> is used instead.  That copy is made
2610 after complementing under C</c>.  I<SEARCHLIST> is sorted by code point
2611 order after complementing, and any I<REPLACEMENTLIST>  is applied to
2612 that sorted result.  This means that under C</c>, the order of the
2613 characters specified in I<SEARCHLIST> is irrelevant.  This can
2614 lead to different results on EBCDIC systems if I<REPLACEMENTLIST>
2615 contains more than one character, hence it is generally non-portable to
2616 use C</c> with such a I<REPLACEMENTLIST>.
2617
2618 Another way of describing the operation is this:
2619 If C</c> is specified, the I<SEARCHLIST> is sorted by code point order,
2620 then complemented.  If I<REPLACEMENTLIST> is empty and C</d> is not
2621 specified, I<REPLACEMENTLIST> is replaced by a copy of I<SEARCHLIST> (as
2622 modified under C</c>), and these potentially modified lists are used as
2623 the basis for what follows.  Any character in the target string that
2624 isn't in I<SEARCHLIST> is passed through unchanged.  Every other
2625 character in the target string is replaced by the character in
2626 I<REPLACEMENTLIST> that positionally corresponds to its mate in
2627 I<SEARCHLIST>, except that under C</s>, the 2nd and following characters
2628 are squeezed out in a sequence of characters in a row that all translate
2629 to the same character.  If I<SEARCHLIST> is longer than
2630 I<REPLACEMENTLIST>, characters in the target string that match a
2631 character in I<SEARCHLIST> that doesn't have a correspondence in
2632 I<REPLACEMENTLIST> are either deleted from the target string if C</d> is
2633 specified; or replaced by the final character in I<REPLACEMENTLIST> if
2634 C</d> isn't specified.
2635
2636 Some examples:
2637
2638  $ARGV[1] =~ tr/A-Z/a-z/;   # canonicalize to lower case ASCII
2639
2640  $cnt = tr/*/*/;            # count the stars in $_
2641  $cnt = tr/*//;             # same thing
2642
2643  $cnt = $sky =~ tr/*/*/;    # count the stars in $sky
2644  $cnt = $sky =~ tr/*//;     # same thing
2645
2646  $cnt = $sky =~ tr/*//c;    # count all the non-stars in $sky
2647  $cnt = $sky =~ tr/*/*/c;   # same, but transliterate each non-star
2648                             # into a star, leaving the already-stars
2649                             # alone.  Afterwards, everything in $sky
2650                             # is a star.
2651
2652  $cnt = tr/0-9//;           # count the ASCII digits in $_
2653
2654  tr/a-zA-Z//s;              # bookkeeper -> bokeper
2655  tr/o/o/s;                  # bookkeeper -> bokkeeper
2656  tr/oe/oe/s;                # bookkeeper -> bokkeper
2657  tr/oe//s;                  # bookkeeper -> bokkeper
2658  tr/oe/o/s;                 # bookkeeper -> bokkopor
2659
2660  ($HOST = $host) =~ tr/a-z/A-Z/;
2661   $HOST = $host  =~ tr/a-z/A-Z/r; # same thing
2662
2663  $HOST = $host =~ tr/a-z/A-Z/r   # chained with s///r
2664                =~ s/:/ -p/r;
2665
2666  tr/a-zA-Z/ /cs;                 # change non-alphas to single space
2667
2668  @stripped = map tr/a-zA-Z/ /csr, @original;
2669                                  # /r with map
2670
2671  tr [\200-\377]
2672     [\000-\177];                 # wickedly delete 8th bit
2673
2674  $foo !~ tr/A/a/    # transliterate all the A's in $foo to 'a',
2675                     # return 0 if any were found and changed.
2676                     # Otherwise return 1
2677
2678 If multiple transliterations are given for a character, only the
2679 first one is used:
2680
2681  tr/AAA/XYZ/
2682
2683 will transliterate any A to X.
2684
2685 Because the transliteration table is built at compile time, neither
2686 the I<SEARCHLIST> nor the I<REPLACEMENTLIST> are subjected to double quote
2687 interpolation.  That means that if you want to use variables, you
2688 must use an C<eval()>:
2689
2690  eval "tr/$oldlist/$newlist/";
2691  die $@ if $@;
2692
2693  eval "tr/$oldlist/$newlist/, 1" or die $@;
2694
2695 =item C<< <<I<EOF> >>
2696 X<here-doc> X<heredoc> X<here-document> X<<< << >>>
2697
2698 A line-oriented form of quoting is based on the shell "here-document"
2699 syntax.  Following a C<< << >> you specify a string to terminate
2700 the quoted material, and all lines following the current line down to
2701 the terminating string are the value of the item.
2702
2703 Prefixing the terminating string with a C<~> specifies that you
2704 want to use L</Indented Here-docs> (see below).
2705
2706 The terminating string may be either an identifier (a word), or some
2707 quoted text.  An unquoted identifier works like double quotes.
2708 There may not be a space between the C<< << >> and the identifier,
2709 unless the identifier is explicitly quoted.  The terminating string
2710 must appear by itself (unquoted and with no surrounding whitespace)
2711 on the terminating line.
2712
2713 If the terminating string is quoted, the type of quotes used determine
2714 the treatment of the text.
2715
2716 =over 4
2717
2718 =item Double Quotes
2719
2720 Double quotes indicate that the text will be interpolated using exactly
2721 the same rules as normal double quoted strings.
2722
2723        print <<EOF;
2724     The price is $Price.
2725     EOF
2726
2727        print << "EOF"; # same as above
2728     The price is $Price.
2729     EOF
2730
2731
2732 =item Single Quotes
2733
2734 Single quotes indicate the text is to be treated literally with no
2735 interpolation of its content.  This is similar to single quoted
2736 strings except that backslashes have no special meaning, with C<\\>
2737 being treated as two backslashes and not one as they would in every
2738 other quoting construct.
2739
2740 Just as in the shell, a backslashed bareword following the C<<< << >>>
2741 means the same thing as a single-quoted string does:
2742
2743         $cost = <<'VISTA';  # hasta la ...
2744     That'll be $10 please, ma'am.
2745     VISTA
2746
2747         $cost = <<\VISTA;   # Same thing!
2748     That'll be $10 please, ma'am.
2749     VISTA
2750
2751 This is the only form of quoting in perl where there is no need
2752 to worry about escaping content, something that code generators
2753 can and do make good use of.
2754
2755 =item Backticks
2756
2757 The content of the here doc is treated just as it would be if the
2758 string were embedded in backticks.  Thus the content is interpolated
2759 as though it were double quoted and then executed via the shell, with
2760 the results of the execution returned.
2761
2762        print << `EOC`; # execute command and get results
2763     echo hi there
2764     EOC
2765
2766 =back
2767
2768 =over 4
2769
2770 =item Indented Here-docs
2771
2772 The here-doc modifier C<~> allows you to indent your here-docs to make
2773 the code more readable:
2774
2775     if ($some_var) {
2776       print <<~EOF;
2777         This is a here-doc
2778         EOF
2779     }
2780
2781 This will print...
2782
2783     This is a here-doc
2784
2785 ...with no leading whitespace.
2786
2787 The delimiter is used to determine the B<exact> whitespace to
2788 remove from the beginning of each line.  All lines B<must> have
2789 at least the same starting whitespace (except lines only
2790 containing a newline) or perl will croak.  Tabs and spaces can
2791 be mixed, but are matched exactly.  One tab will not be equal to
2792 8 spaces!
2793
2794 Additional beginning whitespace (beyond what preceded the
2795 delimiter) will be preserved:
2796
2797     print <<~EOF;
2798       This text is not indented
2799         This text is indented with two spaces
2800                 This text is indented with two tabs
2801       EOF
2802
2803 Finally, the modifier may be used with all of the forms
2804 mentioned above:
2805
2806     <<~\EOF;
2807     <<~'EOF'
2808     <<~"EOF"
2809     <<~`EOF`
2810
2811 And whitespace may be used between the C<~> and quoted delimiters:
2812
2813     <<~ 'EOF'; # ... "EOF", `EOF`
2814
2815 =back
2816
2817 It is possible to stack multiple here-docs in a row:
2818
2819        print <<"foo", <<"bar"; # you can stack them
2820     I said foo.
2821     foo
2822     I said bar.
2823     bar
2824
2825        myfunc(<< "THIS", 23, <<'THAT');
2826     Here's a line
2827     or two.
2828     THIS
2829     and here's another.
2830     THAT
2831
2832 Just don't forget that you have to put a semicolon on the end
2833 to finish the statement, as Perl doesn't know you're not going to
2834 try to do this:
2835
2836        print <<ABC
2837     179231
2838     ABC
2839        + 20;
2840
2841 If you want to remove the line terminator from your here-docs,
2842 use C<chomp()>.
2843
2844     chomp($string = <<'END');
2845     This is a string.
2846     END
2847
2848 If you want your here-docs to be indented with the rest of the code,
2849 use the C<<< <<~FOO >>> construct described under L</Indented Here-docs>:
2850
2851     $quote = <<~'FINIS';
2852        The Road goes ever on and on,
2853        down from the door where it began.
2854        FINIS
2855
2856 If you use a here-doc within a delimited construct, such as in C<s///eg>,
2857 the quoted material must still come on the line following the
2858 C<<< <<FOO >>> marker, which means it may be inside the delimited
2859 construct:
2860
2861     s/this/<<E . 'that'
2862     the other
2863     E
2864      . 'more '/eg;
2865
2866 It works this way as of Perl 5.18.  Historically, it was inconsistent, and
2867 you would have to write
2868
2869     s/this/<<E . 'that'
2870      . 'more '/eg;
2871     the other
2872     E
2873
2874 outside of string evals.
2875
2876 Additionally, quoting rules for the end-of-string identifier are
2877 unrelated to Perl's quoting rules.  C<q()>, C<qq()>, and the like are not
2878 supported in place of C<''> and C<"">, and the only interpolation is for
2879 backslashing the quoting character:
2880
2881     print << "abc\"def";
2882     testing...
2883     abc"def
2884
2885 Finally, quoted strings cannot span multiple lines.  The general rule is
2886 that the identifier must be a string literal.  Stick with that, and you
2887 should be safe.
2888
2889 =back
2890
2891 =head2 Gory details of parsing quoted constructs
2892 X<quote, gory details>
2893
2894 When presented with something that might have several different
2895 interpretations, Perl uses the B<DWIM> (that's "Do What I Mean")
2896 principle to pick the most probable interpretation.  This strategy
2897 is so successful that Perl programmers often do not suspect the
2898 ambivalence of what they write.  But from time to time, Perl's
2899 notions differ substantially from what the author honestly meant.
2900
2901 This section hopes to clarify how Perl handles quoted constructs.
2902 Although the most common reason to learn this is to unravel labyrinthine
2903 regular expressions, because the initial steps of parsing are the
2904 same for all quoting operators, they are all discussed together.
2905
2906 The most important Perl parsing rule is the first one discussed
2907 below: when processing a quoted construct, Perl first finds the end
2908 of that construct, then interprets its contents.  If you understand
2909 this rule, you may skip the rest of this section on the first
2910 reading.  The other rules are likely to contradict the user's
2911 expectations much less frequently than this first one.
2912
2913 Some passes discussed below are performed concurrently, but because
2914 their results are the same, we consider them individually.  For different
2915 quoting constructs, Perl performs different numbers of passes, from
2916 one to four, but these passes are always performed in the same order.
2917
2918 =over 4
2919
2920 =item Finding the end
2921
2922 The first pass is finding the end of the quoted construct.  This results
2923 in saving to a safe location a copy of the text (between the starting
2924 and ending delimiters), normalized as necessary to avoid needing to know
2925 what the original delimiters were.
2926
2927 If the construct is a here-doc, the ending delimiter is a line
2928 that has a terminating string as the content.  Therefore C<<<EOF> is
2929 terminated by C<EOF> immediately followed by C<"\n"> and starting
2930 from the first column of the terminating line.
2931 When searching for the terminating line of a here-doc, nothing
2932 is skipped.  In other words, lines after the here-doc syntax
2933 are compared with the terminating string line by line.
2934
2935 For the constructs except here-docs, single characters are used as starting
2936 and ending delimiters.  If the starting delimiter is an opening punctuation
2937 (that is C<(>, C<[>, C<{>, or C<< < >>), the ending delimiter is the
2938 corresponding closing punctuation (that is C<)>, C<]>, C<}>, or C<< > >>).
2939 If the starting delimiter is an unpaired character like C</> or a closing
2940 punctuation, the ending delimiter is the same as the starting delimiter.
2941 Therefore a C</> terminates a C<qq//> construct, while a C<]> terminates
2942 both C<qq[]> and C<qq]]> constructs.
2943
2944 When searching for single-character delimiters, escaped delimiters
2945 and C<\\> are skipped.  For example, while searching for terminating C</>,
2946 combinations of C<\\> and C<\/> are skipped.  If the delimiters are
2947 bracketing, nested pairs are also skipped.  For example, while searching
2948 for a closing C<]> paired with the opening C<[>, combinations of C<\\>, C<\]>,
2949 and C<\[> are all skipped, and nested C<[> and C<]> are skipped as well.
2950 However, when backslashes are used as the delimiters (like C<qq\\> and
2951 C<tr\\\>), nothing is skipped.
2952 During the search for the end, backslashes that escape delimiters or
2953 other backslashes are removed (exactly speaking, they are not copied to the
2954 safe location).
2955
2956 For constructs with three-part delimiters (C<s///>, C<y///>, and
2957 C<tr///>), the search is repeated once more.
2958 If the first delimiter is not an opening punctuation, the three delimiters must
2959 be the same, such as C<s!!!> and C<tr)))>,
2960 in which case the second delimiter
2961 terminates the left part and starts the right part at once.
2962 If the left part is delimited by bracketing punctuation (that is C<()>,
2963 C<[]>, C<{}>, or C<< <> >>), the right part needs another pair of
2964 delimiters such as C<s(){}> and C<tr[]//>.  In these cases, whitespace
2965 and comments are allowed between the two parts, although the comment must follow
2966 at least one whitespace character; otherwise a character expected as the
2967 start of the comment may be regarded as the starting delimiter of the right part.
2968
2969 During this search no attention is paid to the semantics of the construct.
2970 Thus:
2971
2972     "$hash{"$foo/$bar"}"
2973
2974 or:
2975
2976     m/
2977       bar       # NOT a comment, this slash / terminated m//!
2978      /x
2979
2980 do not form legal quoted expressions.   The quoted part ends on the
2981 first C<"> and C</>, and the rest happens to be a syntax error.
2982 Because the slash that terminated C<m//> was followed by a C<SPACE>,
2983 the example above is not C<m//x>, but rather C<m//> with no C</x>
2984 modifier.  So the embedded C<#> is interpreted as a literal C<#>.
2985
2986 Also no attention is paid to C<\c\> (multichar control char syntax) during
2987 this search.  Thus the second C<\> in C<qq/\c\/> is interpreted as a part
2988 of C<\/>, and the following C</> is not recognized as a delimiter.
2989 Instead, use C<\034> or C<\x1c> at the end of quoted constructs.
2990
2991 =item Interpolation
2992 X<interpolation>
2993
2994 The next step is interpolation in the text obtained, which is now
2995 delimiter-independent.  There are multiple cases.
2996
2997 =over 4
2998
2999 =item C<<<'EOF'>
3000
3001 No interpolation is performed.
3002 Note that the combination C<\\> is left intact, since escaped delimiters
3003 are not available for here-docs.
3004
3005 =item  C<m''>, the pattern of C<s'''>
3006
3007 No interpolation is performed at this stage.
3008 Any backslashed sequences including C<\\> are treated at the stage
3009 to L</"parsing regular expressions">.
3010
3011 =item C<''>, C<q//>, C<tr'''>, C<y'''>, the replacement of C<s'''>
3012
3013 The only interpolation is removal of C<\> from pairs of C<\\>.
3014 Therefore C<"-"> in C<tr'''> and C<y'''> is treated literally
3015 as a hyphen and no character range is available.
3016 C<\1> in the replacement of C<s'''> does not work as C<$1>.
3017
3018 =item C<tr///>, C<y///>
3019
3020 No variable interpolation occurs.  String modifying combinations for
3021 case and quoting such as C<\Q>, C<\U>, and C<\E> are not recognized.
3022 The other escape sequences such as C<\200> and C<\t> and backslashed
3023 characters such as C<\\> and C<\-> are converted to appropriate literals.
3024 The character C<"-"> is treated specially and therefore C<\-> is treated
3025 as a literal C<"-">.
3026
3027 =item C<"">, C<``>, C<qq//>, C<qx//>, C<< <file*glob> >>, C<<<"EOF">
3028
3029 C<\Q>, C<\U>, C<\u>, C<\L>, C<\l>, C<\F> (possibly paired with C<\E>) are
3030 converted to corresponding Perl constructs.  Thus, C<"$foo\Qbaz$bar">
3031 is converted to S<C<$foo . (quotemeta("baz" . $bar))>> internally.
3032 The other escape sequences such as C<\200> and C<\t> and backslashed
3033 characters such as C<\\> and C<\-> are replaced with appropriate
3034 expansions.
3035
3036 Let it be stressed that I<whatever falls between C<\Q> and C<\E>>
3037 is interpolated in the usual way.  Something like C<"\Q\\E"> has
3038 no C<\E> inside.  Instead, it has C<\Q>, C<\\>, and C<E>, so the
3039 result is the same as for C<"\\\\E">.  As a general rule, backslashes
3040 between C<\Q> and C<\E> may lead to counterintuitive results.  So,
3041 C<"\Q\t\E"> is converted to C<quotemeta("\t")>, which is the same
3042 as C<"\\\t"> (since TAB is not alphanumeric).  Note also that:
3043
3044   $str = '\t';
3045   return "\Q$str";
3046
3047 may be closer to the conjectural I<intention> of the writer of C<"\Q\t\E">.
3048
3049 Interpolated scalars and arrays are converted internally to the C<join> and
3050 C<"."> catenation operations.  Thus, S<C<"$foo XXX '@arr'">> becomes:
3051
3052   $foo . " XXX '" . (join $", @arr) . "'";
3053
3054 All operations above are performed simultaneously, left to right.
3055
3056 Because the result of S<C<"\Q I<STRING> \E">> has all metacharacters
3057 quoted, there is no way to insert a literal C<$> or C<@> inside a
3058 C<\Q\E> pair.  If protected by C<\>, C<$> will be quoted to become
3059 C<"\\\$">; if not, it is interpreted as the start of an interpolated
3060 scalar.
3061
3062 Note also that the interpolation code needs to make a decision on
3063 where the interpolated scalar ends.  For instance, whether
3064 S<C<< "a $x -> {c}" >>> really means:
3065
3066   "a " . $x . " -> {c}";
3067
3068 or:
3069
3070   "a " . $x -> {c};
3071
3072 Most of the time, the longest possible text that does not include
3073 spaces between components and which contains matching braces or
3074 brackets.  because the outcome may be determined by voting based
3075 on heuristic estimators, the result is not strictly predictable.
3076 Fortunately, it's usually correct for ambiguous cases.
3077
3078 =item the replacement of C<s///>
3079
3080 Processing of C<\Q>, C<\U>, C<\u>, C<\L>, C<\l>, C<\F> and interpolation
3081 happens as with C<qq//> constructs.
3082
3083 It is at this step that C<\1> is begrudgingly converted to C<$1> in
3084 the replacement text of C<s///>, in order to correct the incorrigible
3085 I<sed> hackers who haven't picked up the saner idiom yet.  A warning
3086 is emitted if the S<C<use warnings>> pragma or the B<-w> command-line flag
3087 (that is, the C<$^W> variable) was set.
3088
3089 =item C<RE> in C<m?RE?>, C</RE/>, C<m/RE/>, C<s/RE/foo/>,
3090
3091 Processing of C<\Q>, C<\U>, C<\u>, C<\L>, C<\l>, C<\F>, C<\E>,
3092 and interpolation happens (almost) as with C<qq//> constructs.
3093
3094 Processing of C<\N{...}> is also done here, and compiled into an intermediate
3095 form for the regex compiler.  (This is because, as mentioned below, the regex
3096 compilation may be done at execution time, and C<\N{...}> is a compile-time
3097 construct.)
3098
3099 However any other combinations of C<\> followed by a character
3100 are not substituted but only skipped, in order to parse them
3101 as regular expressions at the following step.
3102 As C<\c> is skipped at this step, C<@> of C<\c@> in RE is possibly
3103 treated as an array symbol (for example C<@foo>),
3104 even though the same text in C<qq//> gives interpolation of C<\c@>.
3105
3106 Code blocks such as C<(?{BLOCK})> are handled by temporarily passing control
3107 back to the perl parser, in a similar way that an interpolated array
3108 subscript expression such as C<"foo$array[1+f("[xyz")]bar"> would be.
3109
3110 Moreover, inside C<(?{BLOCK})>, S<C<(?# comment )>>, and
3111 a C<#>-comment in a C</x>-regular expression, no processing is
3112 performed whatsoever.  This is the first step at which the presence
3113 of the C</x> modifier is relevant.
3114
3115 Interpolation in patterns has several quirks: C<$|>, C<$(>, C<$)>, C<@+>
3116 and C<@-> are not interpolated, and constructs C<$var[SOMETHING]> are
3117 voted (by several different estimators) to be either an array element
3118 or C<$var> followed by an RE alternative.  This is where the notation
3119 C<${arr[$bar]}> comes handy: C</${arr[0-9]}/> is interpreted as
3120 array element C<-9>, not as a regular expression from the variable
3121 C<$arr> followed by a digit, which would be the interpretation of
3122 C</$arr[0-9]/>.  Since voting among different estimators may occur,
3123 the result is not predictable.
3124
3125 The lack of processing of C<\\> creates specific restrictions on
3126 the post-processed text.  If the delimiter is C</>, one cannot get
3127 the combination C<\/> into the result of this step.  C</> will
3128 finish the regular expression, C<\/> will be stripped to C</> on
3129 the previous step, and C<\\/> will be left as is.  Because C</> is
3130 equivalent to C<\/> inside a regular expression, this does not
3131 matter unless the delimiter happens to be character special to the
3132 RE engine, such as in C<s*foo*bar*>, C<m[foo]>, or C<m?foo?>; or an
3133 alphanumeric char, as in:
3134
3135   m m ^ a \s* b mmx;
3136
3137 In the RE above, which is intentionally obfuscated for illustration, the
3138 delimiter is C<m>, the modifier is C<mx>, and after delimiter-removal the
3139 RE is the same as for S<C<m/ ^ a \s* b /mx>>.  There's more than one
3140 reason you're encouraged to restrict your delimiters to non-alphanumeric,
3141 non-whitespace choices.
3142
3143 =back
3144
3145 This step is the last one for all constructs except regular expressions,
3146 which are processed further.
3147
3148 =item parsing regular expressions
3149 X<regexp, parse>
3150
3151 Previous steps were performed during the compilation of Perl code,
3152 but this one happens at run time, although it may be optimized to
3153 be calculated at compile time if appropriate.  After preprocessing
3154 described above, and possibly after evaluation if concatenation,
3155 joining, casing translation, or metaquoting are involved, the
3156 resulting I<string> is passed to the RE engine for compilation.
3157
3158 Whatever happens in the RE engine might be better discussed in L<perlre>,
3159 but for the sake of continuity, we shall do so here.
3160
3161 This is another step where the presence of the C</x> modifier is
3162 relevant.  The RE engine scans the string from left to right and
3163 converts it into a finite automaton.
3164
3165 Backslashed characters are either replaced with corresponding
3166 literal strings (as with C<\{>), or else they generate special nodes
3167 in the finite automaton (as with C<\b>).  Characters special to the
3168 RE engine (such as C<|>) generate corresponding nodes or groups of
3169 nodes.  C<(?#...)> comments are ignored.  All the rest is either
3170 converted to literal strings to match, or else is ignored (as is
3171 whitespace and C<#>-style comments if C</x> is present).
3172
3173 Parsing of the bracketed character class construct, C<[...]>, is
3174 rather different than the rule used for the rest of the pattern.
3175 The terminator of this construct is found using the same rules as
3176 for finding the terminator of a C<{}>-delimited construct, the only
3177 exception being that C<]> immediately following C<[> is treated as
3178 though preceded by a backslash.
3179
3180 The terminator of runtime C<(?{...})> is found by temporarily switching
3181 control to the perl parser, which should stop at the point where the
3182 logically balancing terminating C<}> is found.
3183
3184 It is possible to inspect both the string given to RE engine and the
3185 resulting finite automaton.  See the arguments C<debug>/C<debugcolor>
3186 in the S<C<use L<re>>> pragma, as well as Perl's B<-Dr> command-line
3187 switch documented in L<perlrun/"Command Switches">.
3188
3189 =item Optimization of regular expressions
3190 X<regexp, optimization>
3191
3192 This step is listed for completeness only.  Since it does not change
3193 semantics, details of this step are not documented and are subject
3194 to change without notice.  This step is performed over the finite
3195 automaton that was generated during the previous pass.
3196
3197 It is at this stage that C<split()> silently optimizes C</^/> to
3198 mean C</^/m>.
3199
3200 =back
3201
3202 =head2 I/O Operators
3203 X<operator, i/o> X<operator, io> X<io> X<while> X<filehandle>
3204 X<< <> >> X<< <<>> >> X<@ARGV>
3205
3206 There are several I/O operators you should know about.
3207
3208 A string enclosed by backticks (grave accents) first undergoes
3209 double-quote interpolation.  It is then interpreted as an external
3210 command, and the output of that command is the value of the
3211 backtick string, like in a shell.  In scalar context, a single string
3212 consisting of all output is returned.  In list context, a list of
3213 values is returned, one per line of output.  (You can set C<$/> to use
3214 a different line terminator.)  The command is executed each time the
3215 pseudo-literal is evaluated.  The status value of the command is
3216 returned in C<$?> (see L<perlvar> for the interpretation of C<$?>).
3217 Unlike in B<csh>, no translation is done on the return data--newlines
3218 remain newlines.  Unlike in any of the shells, single quotes do not
3219 hide variable names in the command from interpretation.  To pass a
3220 literal dollar-sign through to the shell you need to hide it with a
3221 backslash.  The generalized form of backticks is C<qx//>, or you can
3222 call the L<perlfunc/readpipe> function.  (Because
3223 backticks always undergo shell expansion as well, see L<perlsec> for
3224 security concerns.)
3225 X<qx> X<`> X<``> X<backtick> X<glob>
3226
3227 In scalar context, evaluating a filehandle in angle brackets yields
3228 the next line from that file (the newline, if any, included), or
3229 C<undef> at end-of-file or on error.  When C<$/> is set to C<undef>
3230 (sometimes known as file-slurp mode) and the file is empty, it
3231 returns C<''> the first time, followed by C<undef> subsequently.
3232
3233 Ordinarily you must assign the returned value to a variable, but
3234 there is one situation where an automatic assignment happens.  If
3235 and only if the input symbol is the only thing inside the conditional
3236 of a C<while> statement (even if disguised as a C<for(;;)> loop),
3237 the value is automatically assigned to the global variable C<$_>,
3238 destroying whatever was there previously.  (This may seem like an
3239 odd thing to you, but you'll use the construct in almost every Perl
3240 script you write.)  The C<$_> variable is not implicitly localized.
3241 You'll have to put a S<C<local $_;>> before the loop if you want that
3242 to happen.  Furthermore, if the input symbol or an explicit assignment
3243 of the input symbol to a scalar is used as a C<while>/C<for> condition,
3244 then the condition actually tests for definedness of the expression's
3245 value, not for its regular truth value.
3246
3247 Thus the following lines are equivalent:
3248
3249     while (defined($_ = <STDIN>)) { print; }
3250     while ($_ = <STDIN>) { print; }
3251     while (<STDIN>) { print; }
3252     for (;<STDIN>;) { print; }
3253     print while defined($_ = <STDIN>);
3254     print while ($_ = <STDIN>);
3255     print while <STDIN>;
3256
3257 This also behaves similarly, but assigns to a lexical variable
3258 instead of to C<$_>:
3259
3260     while (my $line = <STDIN>) { print $line }
3261
3262 In these loop constructs, the assigned value (whether assignment
3263 is automatic or explicit) is then tested to see whether it is
3264 defined.  The defined test avoids problems where the line has a string
3265 value that would be treated as false by Perl; for example a "" or
3266 a C<"0"> with no trailing newline.  If you really mean for such values
3267 to terminate the loop, they should be tested for explicitly:
3268
3269     while (($_ = <STDIN>) ne '0') { ... }
3270     while (<STDIN>) { last unless $_; ... }
3271
3272 In other boolean contexts, C<< <I<FILEHANDLE>> >> without an
3273 explicit C<defined> test or comparison elicits a warning if the
3274 S<C<use warnings>> pragma or the B<-w>
3275 command-line switch (the C<$^W> variable) is in effect.
3276
3277 The filehandles STDIN, STDOUT, and STDERR are predefined.  (The
3278 filehandles C<stdin>, C<stdout>, and C<stderr> will also work except
3279 in packages, where they would be interpreted as local identifiers
3280 rather than global.)  Additional filehandles may be created with
3281 the C<open()> function, amongst others.  See L<perlopentut> and
3282 L<perlfunc/open> for details on this.
3283 X<stdin> X<stdout> X<sterr>
3284
3285 If a C<< <I<FILEHANDLE>> >> is used in a context that is looking for
3286 a list, a list comprising all input lines is returned, one line per
3287 list element.  It's easy to grow to a rather large data space this
3288 way, so use with care.
3289
3290 C<< <I<FILEHANDLE>> >>  may also be spelled C<readline(*I<FILEHANDLE>)>.
3291 See L<perlfunc/readline>.
3292
3293 The null filehandle C<< <> >> is special: it can be used to emulate the
3294 behavior of B<sed> and B<awk>, and any other Unix filter program
3295 that takes a list of filenames, doing the same to each line
3296 of input from all of them.  Input from C<< <> >> comes either from
3297 standard input, or from each file listed on the command line.  Here's
3298 how it works: the first time C<< <> >> is evaluated, the C<@ARGV> array is
3299 checked, and if it is empty, C<$ARGV[0]> is set to C<"-">, which when opened
3300 gives you standard input.  The C<@ARGV> array is then processed as a list
3301 of filenames.  The loop
3302
3303     while (<>) {
3304         ...                     # code for each line
3305     }
3306
3307 is equivalent to the following Perl-like pseudo code:
3308
3309     unshift(@ARGV, '-') unless @ARGV;
3310     while ($ARGV = shift) {
3311         open(ARGV, $ARGV);
3312         while (<ARGV>) {
3313             ...         # code for each line
3314         }
3315     }
3316
3317 except that it isn't so cumbersome to say, and will actually work.
3318 It really does shift the C<@ARGV> array and put the current filename
3319 into the C<$ARGV> variable.  It also uses filehandle I<ARGV>
3320 internally.  C<< <> >> is just a synonym for C<< <ARGV> >>, which
3321 is magical.  (The pseudo code above doesn't work because it treats
3322 C<< <ARGV> >> as non-magical.)
3323
3324 Since the null filehandle uses the two argument form of L<perlfunc/open>
3325 it interprets special characters, so if you have a script like this:
3326
3327     while (<>) {
3328         print;
3329     }
3330
3331 and call it with S<C<perl dangerous.pl 'rm -rfv *|'>>, it actually opens a
3332 pipe, executes the C<rm> command and reads C<rm>'s output from that pipe.
3333 If you want all items in C<@ARGV> to be interpreted as file names, you
3334 can use the module C<ARGV::readonly> from CPAN, or use the double bracket:
3335
3336     while (<<>>) {
3337         print;
3338     }
3339
3340 Using double angle brackets inside of a while causes the open to use the
3341 three argument form (with the second argument being C<< < >>), so all
3342 arguments in C<ARGV> are treated as literal filenames (including C<"-">).
3343 (Note that for convenience, if you use C<< <<>> >> and if C<@ARGV> is
3344 empty, it will still read from the standard input.)
3345
3346 You can modify C<@ARGV> before the first C<< <> >> as long as the array ends up
3347 containing the list of filenames you really want.  Line numbers (C<$.>)
3348 continue as though the input were one big happy file.  See the example
3349 in L<perlfunc/eof> for how to reset line numbers on each file.
3350
3351 If you want to set C<@ARGV> to your own list of files, go right ahead.
3352 This sets C<@ARGV> to all plain text files if no C<@ARGV> was given:
3353
3354     @ARGV = grep { -f && -T } glob('*') unless @ARGV;
3355
3356 You can even set them to pipe commands.  For example, this automatically
3357 filters compressed arguments through B<gzip>:
3358
3359     @ARGV = map { /\.(gz|Z)$/ ? "gzip -dc < $_ |" : $_ } @ARGV;
3360
3361 If you want to pass switches into your script, you can use one of the
3362 C<Getopts> modules or put a loop on the front like this:
3363
3364     while ($_ = $ARGV[0], /^-/) {
3365         shift;
3366         last if /^--$/;
3367         if (/^-D(.*)/) { $debug = $1 }
3368         if (/^-v/)     { $verbose++  }
3369         # ...           # other switches
3370     }
3371
3372     while (<>) {
3373         # ...           # code for each line
3374     }
3375
3376 The C<< <> >> symbol will return C<undef> for end-of-file only once.
3377 If you call it again after this, it will assume you are processing another
3378 C<@ARGV> list, and if you haven't set C<@ARGV>, will read input from STDIN.
3379
3380 If what the angle brackets contain is a simple scalar variable (for example,
3381 C<$foo>), then that variable contains the name of the
3382 filehandle to input from, or its typeglob, or a reference to the
3383 same.  For example:
3384
3385     $fh = \*STDIN;
3386     $line = <$fh>;
3387
3388 If what's within the angle brackets is neither a filehandle nor a simple
3389 scalar variable containing a filehandle name, typeglob, or typeglob
3390 reference, it is interpreted as a filename pattern to be globbed, and
3391 either a list of filenames or the next filename in the list is returned,
3392 depending on context.  This distinction is determined on syntactic
3393 grounds alone.  That means C<< <$x> >> is always a C<readline()> from
3394 an indirect handle, but C<< <$hash{key}> >> is always a C<glob()>.
3395 That's because C<$x> is a simple scalar variable, but C<$hash{key}> is
3396 not--it's a hash element.  Even C<< <$x > >> (note the extra space)
3397 is treated as C<glob("$x ")>, not C<readline($x)>.
3398
3399 One level of double-quote interpretation is done first, but you can't
3400 say C<< <$foo> >> because that's an indirect filehandle as explained
3401 in the previous paragraph.  (In older versions of Perl, programmers
3402 would insert curly brackets to force interpretation as a filename glob:
3403 C<< <${foo}> >>.  These days, it's considered cleaner to call the
3404 internal function directly as C<glob($foo)>, which is probably the right
3405 way to have done it in the first place.)  For example:
3406
3407     while (<*.c>) {
3408         chmod 0644, $_;
3409     }
3410
3411 is roughly equivalent to:
3412
3413     open(FOO, "echo *.c | tr -s ' \t\r\f' '\\012\\012\\012\\012'|");
3414     while (<FOO>) {
3415         chomp;
3416         chmod 0644, $_;
3417     }
3418
3419 except that the globbing is actually done internally using the standard
3420 C<L<File::Glob>> extension.  Of course, the shortest way to do the above is:
3421
3422     chmod 0644, <*.c>;
3423
3424 A (file)glob evaluates its (embedded) argument only when it is
3425 starting a new list.  All values must be read before it will start
3426 over.  In list context, this isn't important because you automatically
3427 get them all anyway.  However, in scalar context the operator returns
3428 the next value each time it's called, or C<undef> when the list has
3429 run out.  As with filehandle reads, an automatic C<defined> is
3430 generated when the glob occurs in the test part of a C<while>,
3431 because legal glob returns (for example,
3432 a file called F<0>) would otherwise
3433 terminate the loop.  Again, C<undef> is returned only once.  So if
3434 you're expecting a single value from a glob, it is much better to
3435 say
3436
3437     ($file) = <blurch*>;
3438
3439 than
3440
3441     $file = <blurch*>;
3442
3443 because the latter will alternate between returning a filename and
3444 returning false.
3445
3446 If you're trying to do variable interpolation, it's definitely better
3447 to use the C<glob()> function, because the older notation can cause people
3448 to become confused with the indirect filehandle notation.
3449
3450     @files = glob("$dir/*.[ch]");
3451     @files = glob($files[$i]);
3452
3453 If an angle-bracket-based globbing expression is used as the condition of
3454 a C<while> or C<for> loop, then it will be implicitly assigned to C<$_>.
3455 If either a globbing expression or an explicit assignment of a globbing
3456 expression to a scalar is used as a C<while>/C<for> condition, then
3457 the condition actually tests for definedness of the expression's value,
3458 not for its regular truth value.
3459
3460 =head2 Constant Folding
3461 X<constant folding> X<folding>
3462
3463 Like C, Perl does a certain amount of expression evaluation at
3464 compile time whenever it determines that all arguments to an
3465 operator are static and have no side effects.  In particular, string
3466 concatenation happens at compile time between literals that don't do
3467 variable substitution.  Backslash interpolation also happens at
3468 compile time.  You can say
3469
3470       'Now is the time for all'
3471     . "\n"
3472     .  'good men to come to.'
3473
3474 and this all reduces to one string internally.  Likewise, if
3475 you say
3476
3477     foreach $file (@filenames) {
3478         if (-s $file > 5 + 100 * 2**16) {  }
3479     }
3480
3481 the compiler precomputes the number which that expression
3482 represents so that the interpreter won't have to.
3483
3484 =head2 No-ops
3485 X<no-op> X<nop>
3486
3487 Perl doesn't officially have a no-op operator, but the bare constants
3488 C<0> and C<1> are special-cased not to produce a warning in void
3489 context, so you can for example safely do
3490
3491     1 while foo();
3492
3493 =head2 Bitwise String Operators
3494 X<operator, bitwise, string> X<&.> X<|.> X<^.> X<~.>
3495
3496 Bitstrings of any size may be manipulated by the bitwise operators
3497 (C<~ | & ^>).
3498
3499 If the operands to a binary bitwise op are strings of different
3500 sizes, B<|> and B<^> ops act as though the shorter operand had
3501 additional zero bits on the right, while the B<&> op acts as though
3502 the longer operand were truncated to the length of the shorter.
3503 The granularity for such extension or truncation is one or more
3504 bytes.
3505
3506     # ASCII-based examples
3507     print "j p \n" ^ " a h";            # prints "JAPH\n"
3508     print "JA" | "  ph\n";              # prints "japh\n"
3509     print "japh\nJunk" & '_____';       # prints "JAPH\n";
3510     print 'p N$' ^ " E<H\n";            # prints "Perl\n";
3511
3512 If you are intending to manipulate bitstrings, be certain that
3513 you're supplying bitstrings: If an operand is a number, that will imply
3514 a B<numeric> bitwise operation.  You may explicitly show which type of
3515 operation you intend by using C<""> or C<0+>, as in the examples below.
3516
3517     $foo =  150  |  105;        # yields 255  (0x96 | 0x69 is 0xFF)
3518     $foo = '150' |  105;        # yields 255
3519     $foo =  150  | '105';       # yields 255
3520     $foo = '150' | '105';       # yields string '155' (under ASCII)
3521
3522     $baz = 0+$foo & 0+$bar;     # both ops explicitly numeric
3523     $biz = "$foo" ^ "$bar";     # both ops explicitly stringy
3524
3525 This somewhat unpredictable behavior can be avoided with the "bitwise"
3526 feature, new in Perl 5.22.  You can enable it via S<C<use feature
3527 'bitwise'>> or C<use v5.28>.  Before Perl 5.28, it used to emit a warning
3528 in the C<"experimental::bitwise"> category.  Under this feature, the four
3529 standard bitwise operators (C<~ | & ^>) are always numeric.  Adding a dot
3530 after each operator (C<~. |. &. ^.>) forces it to treat its operands as
3531 strings:
3532
3533     use feature "bitwise";
3534     $foo =  150  |  105;        # yields 255  (0x96 | 0x69 is 0xFF)
3535     $foo = '150' |  105;        # yields 255
3536     $foo =  150  | '105';       # yields 255
3537     $foo = '150' | '105';       # yields 255
3538     $foo =  150  |. 105;        # yields string '155'
3539     $foo = '150' |. 105;        # yields string '155'
3540     $foo =  150  |.'105';       # yields string '155'
3541     $foo = '150' |.'105';       # yields string '155'
3542
3543     $baz = $foo &  $bar;        # both operands numeric
3544     $biz = $foo ^. $bar;        # both operands stringy
3545
3546 The assignment variants of these operators (C<&= |= ^= &.= |.= ^.=>)
3547 behave likewise under the feature.
3548
3549 It is a fatal error if an operand contains a character whose ordinal
3550 value is above 0xFF, and hence not expressible except in UTF-8.  The
3551 operation is performed on a non-UTF-8 copy for other operands encoded in
3552 UTF-8.  See L<perlunicode/Byte and Character Semantics>.
3553
3554 See L<perlfunc/vec> for information on how to manipulate individual bits
3555 in a bit vector.
3556
3557 =head2 Integer Arithmetic
3558 X<integer>
3559
3560 By default, Perl assumes that it must do most of its arithmetic in
3561 floating point.  But by saying
3562
3563     use integer;
3564
3565 you may tell the compiler to use integer operations
3566 (see L<integer> for a detailed explanation) from here to the end of
3567 the enclosing BLOCK.  An inner BLOCK may countermand this by saying
3568
3569     no integer;
3570
3571 which lasts until the end of that BLOCK.  Note that this doesn't
3572 mean everything is an integer, merely that Perl will use integer
3573 operations for arithmetic, comparison, and bitwise operators.  For
3574 example, even under S<C<use integer>>, if you take the C<sqrt(2)>, you'll
3575 still get C<1.4142135623731> or so.
3576
3577 Used on numbers, the bitwise operators (C<&> C<|> C<^> C<~> C<< << >>
3578 C<< >> >>) always produce integral results.  (But see also
3579 L</Bitwise String Operators>.)  However, S<C<use integer>> still has meaning for
3580 them.  By default, their results are interpreted as unsigned integers, but
3581 if S<C<use integer>> is in effect, their results are interpreted
3582 as signed integers.  For example, C<~0> usually evaluates to a large
3583 integral value.  However, S<C<use integer; ~0>> is C<-1> on two's-complement
3584 machines.
3585
3586 =head2 Floating-point Arithmetic
3587
3588 X<floating-point> X<floating point> X<float> X<real>
3589
3590 While S<C<use integer>> provides integer-only arithmetic, there is no
3591 analogous mechanism to provide automatic rounding or truncation to a
3592 certain number of decimal places.  For rounding to a certain number
3593 of digits, C<sprintf()> or C<printf()> is usually the easiest route.
3594 See L<perlfaq4>.
3595
3596 Floating-point numbers are only approximations to what a mathematician
3597 would call real numbers.  There are infinitely more reals than floats,
3598 so some corners must be cut.  For example:
3599
3600     printf "%.20g\n", 123456789123456789;
3601     #        produces 123456789123456784
3602
3603 Testing for exact floating-point equality or inequality is not a
3604 good idea.  Here's a (relatively expensive) work-around to compare
3605 whether two floating-point numbers are equal to a particular number of
3606 decimal places.  See Knuth, volume II, for a more robust treatment of
3607 this topic.
3608
3609     sub fp_equal {
3610         my ($X, $Y, $POINTS) = @_;
3611         my ($tX, $tY);
3612         $tX = sprintf("%.${POINTS}g", $X);
3613         $tY = sprintf("%.${POINTS}g", $Y);
3614         return $tX eq $tY;
3615     }
3616
3617 The POSIX module (part of the standard perl distribution) implements
3618 C<ceil()>, C<floor()>, and other mathematical and trigonometric functions.
3619 The C<L<Math::Complex>> module (part of the standard perl distribution)
3620 defines mathematical functions that work on both the reals and the
3621 imaginary numbers.  C<Math::Complex> is not as efficient as POSIX, but
3622 POSIX can't work with complex numbers.
3623
3624 Rounding in financial applications can have serious implications, and
3625 the rounding method used should be specified precisely.  In these
3626 cases, it probably pays not to trust whichever system rounding is
3627 being used by Perl, but to instead implement the rounding function you
3628 need yourself.
3629
3630 =head2 Bigger Numbers
3631 X<number, arbitrary precision>
3632
3633 The standard C<L<Math::BigInt>>, C<L<Math::BigRat>>, and
3634 C<L<Math::BigFloat>> modules,
3635 along with the C<bignum>, C<bigint>, and C<bigrat> pragmas, provide
3636 variable-precision arithmetic and overloaded operators, although
3637 they're currently pretty slow.  At the cost of some space and
3638 considerable speed, they avoid the normal pitfalls associated with
3639 limited-precision representations.
3640
3641         use 5.010;
3642         use bigint;  # easy interface to Math::BigInt
3643         $x = 123456789123456789;
3644         say $x * $x;
3645     +15241578780673678515622620750190521
3646
3647 Or with rationals:
3648
3649         use 5.010;
3650         use bigrat;
3651         $x = 3/22;
3652         $y = 4/6;
3653         say "x/y is ", $x/$y;
3654         say "x*y is ", $x*$y;
3655         x/y is 9/44
3656         x*y is 1/11
3657
3658 Several modules let you calculate with unlimited or fixed precision
3659 (bound only by memory and CPU time).  There
3660 are also some non-standard modules that
3661 provide faster implementations via external C libraries.
3662
3663 Here is a short, but incomplete summary:
3664
3665   Math::String           treat string sequences like numbers
3666   Math::FixedPrecision   calculate with a fixed precision
3667   Math::Currency         for currency calculations
3668   Bit::Vector            manipulate bit vectors fast (uses C)
3669   Math::BigIntFast       Bit::Vector wrapper for big numbers
3670   Math::Pari             provides access to the Pari C library
3671   Math::Cephes           uses the external Cephes C library (no
3672                          big numbers)
3673   Math::Cephes::Fraction fractions via the Cephes library
3674   Math::GMP              another one using an external C library
3675   Math::GMPz             an alternative interface to libgmp's big ints
3676   Math::GMPq             an interface to libgmp's fraction numbers
3677   Math::GMPf             an interface to libgmp's floating point numbers
3678
3679 Choose wisely.
3680
3681 =cut