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