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