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