home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 June / PCWorld_2005-06_cd.bin / software / vyzkuste / firewally / firewally.exe / framework-2.3.exe / perlop.pod < prev    next >
Text File  |  2003-11-07  |  82KB  |  2,141 lines

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