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