[differences between cumulative patch application and perl5.004]
[p5sagit/p5-mst-13.2.git] / pod / perlop.pod
index a075667..d853865 100644 (file)
@@ -8,7 +8,7 @@ Perl operators have the following associativity and precedence,
 listed from highest precedence to lowest.  Note that all operators
 borrowed from C keep the same precedence relationship with each other,
 even where C's precedence is slightly screwy.  (This makes learning
-Perl easier for C folks.)  With very few exceptions, these all 
+Perl easier for C folks.)  With very few exceptions, these all
 operate on scalar values only, not array values.
 
     left       terms and list operators (leftward)
@@ -16,7 +16,7 @@ operate on scalar values only, not array values.
     nonassoc   ++ --
     right      **
     right      ! ~ \ and unary + and -
-    left       =~ !~ 
+    left       =~ !~
     left       * / % x
     left       + - .
     left       << >>
@@ -27,7 +27,7 @@ operate on scalar values only, not array values.
     left       | ^
     left       &&
     left       ||
-    nonassoc   ..
+    nonassoc   ..  ...
     right      ?:
     right      = += -= *= etc.
     left       , =>
@@ -42,7 +42,7 @@ In the following sections, these operators are covered in precedence order.
 
 =head2 Terms and List Operators (Leftward)
 
-Any TERM is of highest precedence of Perl.  These includes variables,
+A TERM has the highest precedence in Perl.  They includes variables,
 quote and quote-like operators, any expression in parentheses,
 and any function whose arguments are parenthesized.  Actually, there
 aren't really functions in this sense, just list operators and unary
@@ -56,7 +56,7 @@ just like a normal function call.
 
 In the absence of parentheses, the precedence of list operators such as
 C<print>, C<sort>, or C<chmod> is either very high or very low depending on
-whether you look at the left side of operator or the right side of it.
+whether you are looking at the left side or the right side of the operator.
 For example, in
 
     @ary = (1, 3, sort 4, 2);
@@ -81,11 +81,11 @@ Also note that
 
     print ($foo & 255) + 1, "\n";
 
-probably doesn't do what you expect at first glance.  See 
+probably doesn't do what you expect at first glance.  See
 L<Named Unary Operators> for more discussion of this.
 
 Also parsed as terms are the C<do {}> and C<eval {}> constructs, as
-well as subroutine and method calls, and the anonymous 
+well as subroutine and method calls, and the anonymous
 constructors C<[]> and C<{}>.
 
 See also L<Quote and Quote-like Operators> toward the end of this section,
@@ -110,7 +110,7 @@ See L<perlobj>.
 increment or decrement the variable before returning the value, and if
 placed after, increment or decrement the variable after returning the value.
 
-The auto-increment operator has a little extra built-in magic to it.  If
+The auto-increment operator has a little extra builtin magic to it.  If
 you increment a variable that is numeric, or that has ever been used in
 a numeric context, you get a normal increment.  If, however, the
 variable has been used in only string contexts since it was set, and
@@ -179,7 +179,12 @@ Binary "*" multiplies two numbers.
 
 Binary "/" divides two numbers.
 
-Binary "%" computes the modulus of the two numbers.
+Binary "%" computes the modulus of two numbers.  Given integer
+operands C<$a> and C<$b>: If C<$b> is positive, then C<$a % $b> is
+C<$a> minus the largest multiple of C<$b> that is not greater than
+C<$a>.  If C<$b> is negative, then C<$a % $b> is C<$a> minus the
+smallest multiple of C<$b> that is not less than C<$a> (i.e. the
+result will be less than or equal to zero).
 
 Binary "x" is the repetition operator.  In a scalar context, it
 returns a string consisting of the left operand repeated the number of
@@ -347,12 +352,12 @@ operators depending on the context.  In a list context, it returns an
 array of values counting (by ones) from the left value to the right
 value.  This is useful for writing C<for (1..10)> loops and for doing
 slice operations on arrays.  Be aware that under the current implementation,
-a temporary array is created, so you'll burn a lot of memory if you 
+a temporary array is created, so you'll burn a lot of memory if you
 write something like this:
 
     for (1 .. 1_000_000) {
        # code
-    } 
+    }
 
 In a scalar context, ".." returns a boolean value.  The operator is
 bistable, like a flip-flop, and emulates the line-range (comma) operator
@@ -416,11 +421,11 @@ like an if-then-else.  If the argument before the ? is true, the
 argument before the : is returned, otherwise the argument after the :
 is returned.  For example:
 
-    printf "I have %d dog%s.\n", $n, 
+    printf "I have %d dog%s.\n", $n,
            ($n == 1) ? '' : "s";
 
 Scalar or list context propagates downward into the 2nd
-or 3rd argument, whichever is selected.  
+or 3rd argument, whichever is selected.
 
     $a = $ok ? $b : $c;  # get a scalar
     @a = $ok ? @b : @c;  # get an array
@@ -446,8 +451,8 @@ is equivalent to
     $a = $a + 2;
 
 although without duplicating any side effects that dereferencing the lvalue
-might trigger, such as from tie().  Other assignment operators work similarly.  
-The following are recognized: 
+might trigger, such as from tie().  Other assignment operators work similarly.
+The following are recognized:
 
     **=    +=    *=    &=    <<=    &&=
            -=    /=    |=    >>=    ||=
@@ -533,12 +538,12 @@ Address-of operator.  (But see the "\" operator for taking a reference.)
 
 =item unary *
 
-Dereference-address operator. (Perl's prefix dereferencing 
+Dereference-address operator. (Perl's prefix dereferencing
 operators are typed: $, @, %, and &.)
 
 =item (TYPE)
 
-Type casting operator.  
+Type casting operator.
 
 =back
 
@@ -550,7 +555,7 @@ pattern matching capabilities.  Perl provides customary quote characters
 for these behaviors, but also provides a way for you to choose your
 quote character for any of them.  In the following table, a C<{}> represents
 any pair of delimiters you choose.  Non-bracketing delimiters use
-the same character fore and aft, but the 4 sorts of brackets 
+the same character fore and aft, but the 4 sorts of brackets
 (round, angle, square, curly) will all nest.
 
     Customary  Generic     Meaning    Interpolates
@@ -639,7 +644,8 @@ Options are:
 If "/" is the delimiter then the initial C<m> is optional.  With the C<m>
 you can use any pair of non-alphanumeric, non-whitespace characters as
 delimiters.  This is particularly useful for matching Unix path names
-that contain "/", to avoid LTS (leaning toothpick syndrome).
+that contain "/", to avoid LTS (leaning toothpick syndrome).  If "?" is
+the delimiter, then the match-only-once rule of C<?PATTERN?> applies.
 
 PATTERN may contain variables, which will be interpolated (and the
 pattern recompiled) every time the pattern search is evaluated.  (Note
@@ -691,68 +697,72 @@ If there are no parentheses, it returns a list of all the matched
 strings, as if there were parentheses around the whole pattern.
 
 In a scalar context, C<m//g> iterates through the string, returning TRUE
-each time it matches, and FALSE when it eventually runs out of
-matches.  (In other words, it remembers where it left off last time and
-restarts the search at that point.  You can actually find the current
-match position of a string or set it using the pos() function--see
-L<perlfunc/pos>.)  Note that you can use this feature to stack C<m//g>
-matches or intermix C<m//g> matches with C<m/\G.../>.
+each time it matches, and FALSE when it eventually runs out of matches.
+(In other words, it remembers where it left off last time and restarts
+the search at that point.  You can actually find the current match
+position of a string or set it using the pos() function; see
+L<perlfunc/pos>.)  A failed match normally resets the search position to
+the beginning of the string, but you can avoid that by adding the "c"
+modifier (e.g. C<m//gc>).  Modifying the target string also resets the
+search position.
+
+You can intermix C<m//g> matches with C<m/\G.../g>, where C<\G> is a
+zero-width assertion that matches the exact position where the previous
+C<m//g>, if any, left off.  The C<\G> assertion is not supported without
+the C</g> modifier; currently, without C</g>, C<\G> behaves just like
+C<\A>, but that's accidental and may change in the future.
 
-If you modify the string in any way, the match position is reset to the
-beginning.  Examples:
+Examples:
 
     # list context
     ($one,$five,$fifteen) = (`uptime` =~ /(\d+\.\d+)/g);
 
     # scalar context
     $/ = ""; $* = 1;  # $* deprecated in modern perls
-    while ($paragraph = <>) {
+    while (defined($paragraph = <>)) {
        while ($paragraph =~ /[a-z]['")]*[.!?]+['")]*\s/g) {
            $sentences++;
        }
     }
     print "$sentences\n";
 
-    # using m//g with \G
-    $_ = "ppooqppq";
+    # using m//gc with \G
+    $_ = "ppooqppqq";
     while ($i++ < 2) {
         print "1: '";
-        print $1 while /(o)/g; print "', pos=", pos, "\n";
+        print $1 while /(o)/gc; print "', pos=", pos, "\n";
         print "2: '";
-        print $1 if /\G(q)/;   print "', pos=", pos, "\n";
+        print $1 if /\G(q)/gc;  print "', pos=", pos, "\n";
         print "3: '";
-        print $1 while /(p)/g; print "', pos=", pos, "\n";
+        print $1 while /(p)/gc; print "', pos=", pos, "\n";
     }
 
 The last example should print:
 
     1: 'oo', pos=4
-    2: 'q', pos=4
+    2: 'q', pos=5
     3: 'pp', pos=7
     1: '', pos=7
-    2: 'q', pos=7
-    3: '', pos=7
-
-Note how C<m//g> matches change the value reported by C<pos()>, but the
-non-global match doesn't.
+    2: 'q', pos=8
+    3: '', pos=8
 
-A useful idiom for C<lex>-like scanners is C</\G.../g>. You can
+A useful idiom for C<lex>-like scanners is C</\G.../gc>.  You can
 combine several regexps like this to process a string part-by-part,
-doing different actions depending on which regexp matched.  The next
-regexp would step in at the place the previous one left off.
+doing different actions depending on which regexp matched.  Each
+regexp tries to match where the previous one leaves off.
 
  $_ = <<'EOL';
       $url = new URI::URL "http://www/";   die if $url eq "xXx";
  EOL
  LOOP:
     {
-      print(" digits"),                redo LOOP if /\G\d+\b[,.;]?\s*/g;
-      print(" lowercase"),     redo LOOP if /\G[a-z]+\b[,.;]?\s*/g;
-      print(" UPPERCASE"),     redo LOOP if /\G[A-Z]+\b[,.;]?\s*/g;
-      print(" Capitalized"),   redo LOOP if /\G[A-Z][a-z]+\b[,.;]?\s*/g;
-      print(" MiXeD"),         redo LOOP if /\G[A-Za-z]+\b[,.;]?\s*/g;
-      print(" alphanumeric"),  redo LOOP if /\G[A-Za-z0-9]+\b[,.;]?\s*/g;
-      print(" line-noise"),    redo LOOP if /\G[^A-Za-z0-9]+/g;
+      print(" digits"),                redo LOOP if /\G\d+\b[,.;]?\s*/gc;
+      print(" lowercase"),     redo LOOP if /\G[a-z]+\b[,.;]?\s*/gc;
+      print(" UPPERCASE"),     redo LOOP if /\G[A-Z]+\b[,.;]?\s*/gc;
+      print(" Capitalized"),   redo LOOP if /\G[A-Z][a-z]+\b[,.;]?\s*/gc;
+      print(" MiXeD"),         redo LOOP if /\G[A-Za-z]+\b[,.;]?\s*/gc;
+      print(" alphanumeric"),  redo LOOP if /\G[A-Za-z0-9]+\b[,.;]?\s*/gc;
+      print(" line-noise"),    redo LOOP if /\G[^A-Za-z0-9]+/gc;
       print ". That's all!\n";
     }
 
@@ -798,7 +808,7 @@ with $/ or $INPUT_RECORD_SEPARATOR).
 
     $today = qx{ date };
 
-See L<I/O Operators> for more discussion.
+See L<"I/O Operators"> for more discussion.
 
 =item qw/STRING/
 
@@ -812,6 +822,11 @@ Some frequently seen examples:
     use POSIX qw( setlocale localeconv )
     @EXPORT = qw( foo bar baz );
 
+A common mistake is to try to separate the words with comma or to put
+comments into a multi-line qw-string.  For this reason the C<-w>
+switch produce warnings if the STRING contains the "," or the "#"
+character.
+
 =item s/PATTERN/REPLACEMENT/egimosx
 
 Searches a string for a pattern, and if found, replaces that pattern
@@ -847,7 +862,7 @@ Options are:
 Any non-alphanumeric, non-whitespace delimiter may replace the
 slashes.  If single quotes are used, no interpretation is done on the
 replacement string (the C</e> modifier overrides this, however).  Unlike
-Perl 4, Perl 5 treats back-ticks as normal delimiters; the replacement
+Perl 4, Perl 5 treats backticks as normal delimiters; the replacement
 text is not evaluated as a command.  If the
 PATTERN is delimited by bracketing quotes, the REPLACEMENT has its own
 pair of quotes, which may or may not be bracketing quotes, e.g.,
@@ -892,7 +907,7 @@ Examples:
 
     s/([^ ]*) *([^ ]*)/$2 $1/; # reverse 1st two fields
 
-Note the use of $ instead of \ in the last example.  Unlike 
+Note the use of $ instead of \ in the last example.  Unlike
 B<sed>, we use the \E<lt>I<digit>E<gt> form in only the left hand side.
 Anywhere else it's $E<lt>I<digit>E<gt>.
 
@@ -915,12 +930,12 @@ Translates all occurrences of the characters found in the search list
 with the corresponding character in the replacement list.  It returns
 the number of characters replaced or deleted.  If no string is
 specified via the =~ or !~ operator, the $_ string is translated.  (The
-string specified with =~ must be a scalar variable, an array element,
-or an assignment to one of those, i.e., an lvalue.)  For B<sed> devotees,
-C<y> is provided as a synonym for C<tr>.  If the SEARCHLIST is
-delimited by bracketing quotes, the REPLACEMENTLIST has its own pair of
-quotes, which may or may not be bracketing quotes, e.g., C<tr[A-Z][a-z]>
-or C<tr(+-*/)/ABCD/>.
+string specified with =~ must be a scalar variable, an array element, a
+hash element, or an assignment to one of those, i.e., an lvalue.)
+For B<sed> devotees, C<y> is provided as a synonym for C<tr>.  If the
+SEARCHLIST is delimited by bracketing quotes, the REPLACEMENTLIST has
+its own pair of quotes, which may or may not be bracketing quotes,
+e.g., C<tr[A-Z][a-z]> or C<tr(+-*/)/ABCD/>.
 
 Options:
 
@@ -983,8 +998,8 @@ an eval():
 
 =head2 I/O Operators
 
-There are several I/O operators you should know about.  
-A string is enclosed by back-ticks (grave accents) first undergoes
+There are several I/O operators you should know about.
+A string is enclosed by backticks (grave accents) first undergoes
 variable substitution just like a double quoted string.  It is then
 interpreted as a command, and the output of that command is the value
 of the pseudo-literal, like in a shell.  In a scalar context, a single
@@ -997,8 +1012,8 @@ of C<$?>).  Unlike in B<csh>, no translation is done on the return
 data--newlines remain newlines.  Unlike in any of the shells, single
 quotes do not hide variable names in the command from interpretation.
 To pass a $ through to the shell you need to hide it with a backslash.
-The generalized form of back-ticks is C<qx//>.  (Because back-ticks
-always undergo shell expansion as well, see L<perlsec> for 
+The generalized form of backticks is C<qx//>.  (Because backticks
+always undergo shell expansion as well, see L<perlsec> for
 security concerns.)
 
 Evaluating a filehandle in angle brackets yields the next line from
@@ -1063,7 +1078,7 @@ continue as if the input were one big happy file.  (But see example
 under eof() for how to reset line numbers on each file.)
 
 If you want to set @ARGV to your own list of files, go right ahead.  If
-you want to pass switches into your script, you can use one of the 
+you want to pass switches into your script, you can use one of the
 Getopts modules or put a loop on the front like this:
 
     while ($_ = $ARGV[0], /^-/) {
@@ -1120,7 +1135,7 @@ machine.)  Of course, the shortest way to do the above is:
 
 Because globbing invokes a shell, it's often faster to call readdir() yourself
 and do your own grep() on the filenames.  Furthermore, due to its current
-implementation of using a shell, the glob() routine may get "Arg list too 
+implementation of using a shell, the glob() routine may get "Arg list too
 long" errors (unless you've installed tcsh(1L) as F</bin/csh>).
 
 A glob evaluates its (embedded) argument only when it is starting a new
@@ -1138,7 +1153,7 @@ than
     $file = <blurch*>;
 
 because the latter will alternate between returning a filename and
-returning FALSE.  
+returning FALSE.
 
 It you're trying to do variable interpolation, it's definitely better
 to use the glob() function, because the older notation can cause people
@@ -1159,14 +1174,14 @@ compile time.  You can say
     'Now is the time for all' . "\n" .
        'good men to come to.'
 
-and this all reduces to one string internally.  Likewise, if 
+and this all reduces to one string internally.  Likewise, if
 you say
 
     foreach $file (@filenames) {
        if (-s $file > 5 + 100 * 2**16) { ... }
-    } 
+    }
 
-the compiler will pre-compute the number that
+the compiler will precompute the number that
 expression represents so that the interpreter
 won't have to.
 
@@ -1180,7 +1195,7 @@ floating point.  But by saying
 
 you may tell the compiler that it's okay to use integer operations
 from here to the end of the enclosing BLOCK.  An inner BLOCK may
-countermand this by saying 
+countermand this by saying
 
     no integer;