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