This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade IO::Compress::* and Compress::Raw::* from 2.061 to 2.062
[perl5.git] / pod / perlsyn.pod
index 4b14309..84a0e2a 100644 (file)
@@ -72,7 +72,7 @@ X<subroutine, declaration>
 
 A bare declaration like that declares the function to be a list operator,
 not a unary operator, so you have to be careful to use parentheses (or
-C<or> instead of C<||>.) The C<||> operator binds too tightly to use after
+C<or> instead of C<||>.)  The C<||> operator binds too tightly to use after
 list operators; it becomes part of the last element.  You can always use
 parentheses around the list operators arguments to turn the list operator
 back into something that behaves more like a function call.  Alternatively,
@@ -84,7 +84,7 @@ operator:
 
 That now parses as you'd expect, but you still ought to get in the habit of
 using parentheses in that situation.  For more on prototypes, see
-L<perlsub>
+L<perlsub>.
 
 Subroutines declarations can also be loaded up with the C<require> statement
 or both loaded and imported into your namespace with a C<use> statement.
@@ -220,7 +220,7 @@ a C<next> from inside a C<foreach> and C<break> from inside a C<given>.
 Under the current implementation, the C<foreach> loop can be
 anywhere within the C<when> modifier's dynamic scope, but must be
 within the C<given> block's lexical scope.  This restricted may
-be relaxed in a future release.  See L<"Switch statements"> below.
+be relaxed in a future release.  See L<"Switch Statements"> below.
 
 =head2 Compound Statements
 X<statement, compound> X<block> X<bracket, curly> X<curly bracket> X<brace>
@@ -285,8 +285,8 @@ all do the same thing:
 The C<if> statement is straightforward.  Because BLOCKs are always
 bounded by curly brackets, there is never any ambiguity about which
 C<if> an C<else> goes with.  If you use C<unless> in place of C<if>,
-the sense of the test is reversed. Like C<if>, C<unless> can be followed
-by C<else>. C<unless> can even be followed by one or more C<elsif>
+the sense of the test is reversed.  Like C<if>, C<unless> can be followed
+by C<else>.  C<unless> can even be followed by one or more C<elsif>
 statements, though you may want to think twice before using that particular
 language construct, as everyone reading your code will have to think at least
 twice before they can understand what's going on.
@@ -370,7 +370,7 @@ which is Perl shorthand for the more explicitly written version:
 
 Note that if there were a C<continue> block on the above code, it would
 get executed only on lines discarded by the regex (since redo skips the
-continue block). A continue block is often used to reset line counters
+continue block).  A continue block is often used to reset line counters
 or C<m?pat?> one-time matches:
 
     # inspired by :1,$g/fred/s//WILMA/
@@ -393,7 +393,8 @@ they aren't loops.  You can double the braces to make them such, though.
 
     if (/pattern/) {{
        last if /fred/;
-       next if /barney/; # same effect as "last", but doesn't document as well
+       next if /barney/; # same effect as "last",
+                         # but doesn't document as well
        # do something here
     }}
 
@@ -532,6 +533,12 @@ rather than merely terminating the inner one.  And it's faster because
 Perl executes a C<foreach> statement more rapidly than it would the
 equivalent C<for> loop.
 
+Perceptive Perl hackers may have noticed that a C<for> loop has a return
+value, and that this value can be captured by wrapping the loop in a C<do>
+block.  The reward for this discovery is this cautionary advice:  The
+return value of a C<for> loop is unspecified and may change without notice.
+Do not rely on it.
+
 =head2 Basic BLOCKs
 X<block>
 
@@ -587,7 +594,8 @@ Under the "switch" feature, Perl gains the experimental keywords
 C<given>, C<when>, C<default>, C<continue>, and C<break>.
 Starting from Perl 5.16, one can prefix the switch
 keywords with C<CORE::> to access the feature without a C<use feature>
-statement. The keywords C<given> and C<when> are analogous to C<switch> and
+statement.  The keywords C<given> and
+C<when> are analogous to C<switch> and
 C<case> in other languages, so the code in the previous section could be
 rewritten as
 
@@ -611,7 +619,7 @@ written like this:
        default       { $nothing = 1 }
     }
 
-As fo 5.14, that can also be written this way:
+As of 5.14, that can also be written this way:
 
     use v5.14;
     for ($var) {
@@ -636,24 +644,27 @@ and C<given> assigns the C<$_> variable its topic value.
 
 Exactly what the I<EXPR> argument to C<when> does is hard to describe
 precisely, but in general, it tries to guess what you want done.  Sometimes
-it is interpreted as C<< $_ ~~ I<EXPR> >>, and sometimes it does not.  It
+it is interpreted as C<< $_ ~~ I<EXPR> >>, and sometimes it is not.  It
 also behaves differently when lexically enclosed by a C<given> block than
 it does when dynamically enclosed by a C<foreach> loop.  The rules are far
 too difficult to understand to be described here.  See L</"Experimental Details
 on given and when"> later on.
 
 Due to an unfortunate bug in how C<given> was implemented between Perl 5.10
-and 5.14, under those implementations the version of C<$_> governed by
+and 5.16, under those implementations the version of C<$_> governed by
 C<given> is merely a lexically scoped copy of the original, not a
 dynamically scoped alias to the original, as it would be if it were a
 C<foreach> or under both the original and the current Perl 6 language
-specification.  This bug is expected to be addressed in a future release of
-Perl.  For forwards compatibility, if you really want a lexical C<$_>,
-specify that explicitly:
+specification.  This bug was fixed in Perl
+5.18.  If you really want a lexical C<$_>,
+specify that explicitly, but note that C<my $_>
+is now deprecated and will warn unless warnings
+have been disabled:
 
     given(my $_ = EXPR) { ... }
 
-In the meanwhile, stick to C<foreach> for your topicalizer and
+If your code still needs to run on older versions,
+stick to C<foreach> for your topicalizer and
 you will be less unhappy.
 
 =head2 Goto
@@ -700,6 +711,10 @@ X<elliptical statement>
 X<unimplemented statement>
 X<unimplemented operator>
 X<yada-yada>
+X<yada-yada operator>
+X<... operator>
+X<whatever operator>
+X<triple-dot operator>
 
 Beginning in Perl 5.12, Perl accepts an ellipsis, "C<...>", as a
 placeholder for code that you haven't implemented yet.  This form of
@@ -708,14 +723,14 @@ binary flip-flop C<...> operator.  One is a statement and the other an
 operator.  (Perl doesn't usually confuse them because usually Perl can tell
 whether it wants an operator or a statement, but see below for exceptions.)
 
-When Perl 5.12 or later encounters an ellipses statement, it parses this
+When Perl 5.12 or later encounters an ellipsis statement, it parses this
 without error, but if and when you should actually try to execute it, Perl
 throws an exception with the text C<Unimplemented>:
 
-    use v5.12
+    use v5.12;
     sub unimplemented { ... }
     eval { unimplemented() };
-    if ($@ eq "Unimplemented") {
+    if ($@ =~ /^Unimplemented at /) {
        say "I found an ellipsis!";
     }
 
@@ -761,14 +776,15 @@ expression instead of a statement:
     @transformed = map { ... } @input;  # syntax error
 
 You can use a C<;> inside your block to denote that the C<{ ...  }> is a
-block and not a hash reference constructor. Now the ellipsis works:
+block and not a hash reference constructor.  Now the ellipsis works:
 
     @transformed = map {; ... } @input; # ; disambiguates
 
     @transformed = map { ...; } @input; # ; disambiguates
 
 Note: Some folks colloquially refer to this bit of punctuation as a
-"yada-yada", but its true name is actually an ellipsis.  Perl does not yet
+"yada-yada" or "triple-dot", but its true name
+is actually an ellipsis.  Perl does not yet
 accept the Unicode version, U+2026 HORIZONTAL ELLIPSIS, as an alias for
 C<...>, but someday it may.
 
@@ -836,7 +852,7 @@ most C preprocessors: it matches the regular expression
      $/x
 
 with C<$1> being the line number for the next line, and C<$3> being
-the optional filename (specified with or without quotes). Note that
+the optional filename (specified with or without quotes).  Note that
 no whitespace may precede the C<< # >>, unlike modern C preprocessors.
 
 There is a fairly obvious gotcha included with the line directive:
@@ -876,9 +892,10 @@ shell:
 
 As previously mentioned, the "switch" feature is considered highly
 experimental; it is subject to change with little notice.  In particular,
-both C<given> and C<when> have tricky behaviours that are expected to
-change to become less tricky in the future.  Do not rely upon their
-current (mis)implementations.
+C<when> has tricky behaviours that are expected to change to become less
+tricky in the future.  Do not rely upon its current (mis)implementation.
+Before Perl 5.18, C<given> also had tricky behaviours that you should still
+beware of if your code must run on older versions of Perl.
 
 Here is a longer example of C<given>:
 
@@ -905,22 +922,22 @@ Here is a longer example of C<given>:
        }
     }
 
-As currently implemented, C<given(EXPR)> assign the value of I<EXPR> to
+Before Perl 5.18, C<given(EXPR)> assigned the value of I<EXPR> to
 merely a lexically scoped I<B<copy>> (!) of C<$_>, not a dynamically
-scoped alias the way C<foreach> does.  That makes it similar to
+scoped alias the way C<foreach> does.  That made it similar to
 
        do { my $_ = EXPR; ... }
 
-except that the block is automatically broken out of by a
-successful C<when> or an explicit C<break>.  Because it is only a
-copy, and because it is only lexically scoped, not dynamically
-scoped, you cannot do the things with it that you are used to in
-a C<foreach> loop.  In particular, you probably cannot use
-arbitrary function calls.  Best stick to C<foreach> for that.
+except that the block was automatically broken out of by a successful
+C<when> or an explicit C<break>.  Because it was only a copy, and because
+it was only lexically scoped, not dynamically scoped, you could not do the
+things with it that you are used to in a C<foreach> loop.  In particular,
+it did not work for arbitrary function calls if those functions might try
+to access $_.  Best stick to C<foreach> for that.
 
 Most of the power comes from the implicit smartmatching that can
 sometimes apply.  Most of the time, C<when(EXPR)> is treated as an
-implicit smartmatch of C<$_>, that is, C<$_ ~~ EXPR>. (See
+implicit smartmatch of C<$_>, that is, C<$_ ~~ EXPR>.  (See
 L<perlop/"Smartmatch Operator"> for more information on smartmatching.)
 But when I<EXPR> is one of the 10 exceptional cases (or things like them)
 listed below, it is used directly as a boolean.
@@ -931,7 +948,7 @@ listed below, it is used directly as a boolean.
 
 A user-defined subroutine call or a method invocation.
 
-=item 3.
+=item 2.
 
 A regular expression match in the form of C</REGEX/>, C<$foo =~ /REGEX/>,
 or C<$foo =~ EXPR>.  Also, a negated regular expression match in
@@ -943,7 +960,7 @@ A smart match that uses an explicit C<~~> operator, such as C<EXPR ~~ EXPR>.
 
 =item 4.
 
-A boolean comparison operator such as C<$_ E<lt> 10> or C<$x eq "abc"> The
+A boolean comparison operator such as C<$_ E<lt> 10> or C<$x eq "abc"> The
 relational operators that this applies to are the six numeric comparisons
 (C<< < >>, C<< > >>, C<< <= >>, C<< >= >>, C<< == >>, and C<< != >>), and
 the six string comparisons (C<lt>, C<gt>, C<le>, C<ge>, C<eq>, and C<ne>).
@@ -955,7 +972,7 @@ the opposite of what you want.
 =item 5.
 
 At least the three builtin functions C<defined(...)>, C<exists(...)>, and
-C<eof(...)>. We might someday add more of these later if we think of them.
+C<eof(...)>.  We might someday add more of these later if we think of them.
 
 =item 6.
 
@@ -989,7 +1006,8 @@ above test to the operands:
 =item 9.
 
 If EXPR is C<EXPR1 && EXPR2> or C<EXPR1 and EXPR2>, the test is applied
-I<recursively> to both EXPR1 and EXPR2. Only if I<both> operands also pass the
+I<recursively> to both EXPR1 and EXPR2.
+Only if I<both> operands also pass the
 test, I<recursively>, will the expression be treated as boolean.  Otherwise,
 smartmatching is used.
 
@@ -998,7 +1016,7 @@ smartmatching is used.
 If EXPR is C<EXPR1 || EXPR2>, C<EXPR1 // EXPR2>, or C<EXPR1 or EXPR2>, the
 test is applied I<recursively> to EXPR1 only (which might itself be a
 higher-precedence AND operator, for example, and thus subject to the
-previous rule), not to EXPR2. If EXPR1 is to use smartmatching, then EXPR2
+previous rule), not to EXPR2.  If EXPR1 is to use smartmatching, then EXPR2
 also does so, no matter what EXPR2 contains.  But if EXPR2 does not get to
 use smartmatching, then the second argument will not be either.  This is
 quite different from the C<&&> case just described, so be careful.
@@ -1030,17 +1048,18 @@ will use smart matching (only the first operand is considered), whereas
     when (/^baz/ || [qw(foo bar)]) { ... }
 
 will test only the regex, which causes both operands to be
-treated as boolean. Watch out for this one, then, because an
+treated as boolean.  Watch out for this one, then, because an
 arrayref is always a true value, which makes it effectively
 redundant.  Not a good idea.
 
 Tautologous boolean operators are still going to be optimized
-away. Don't be tempted to write
+away.  Don't be tempted to write
 
     when ("foo" or "bar") { ... }
 
 This will optimize down to C<"foo">, so C<"bar"> will never be considered (even
-though the rules say to use a smartmatch on C<"foo">). For an alternation like
+though the rules say to use a smartmatch
+on C<"foo">).  For an alternation like
 this, an array ref will work, because this will instigate smartmatching:
 
     when ([qw(foo bar)] { ... }
@@ -1051,7 +1070,7 @@ functionality--see below), wherein the same block is used for several
 C<case> statements.
 
 Another useful shortcut is that, if you use a literal array or hash as the
-argument to C<given>, it is turned into a reference. So C<given(@foo)> is
+argument to C<given>, it is turned into a reference.  So C<given(@foo)> is
 the same as C<given(\@foo)>, for example.
 
 C<default> behaves exactly like C<when(1 == 1)>, which is
@@ -1112,7 +1131,8 @@ evaluate to an empty list.
        }
     };
 
-Currently, C<given> blocks can't always be used as proper expressions. This
+Currently, C<given> blocks can't always
+be used as proper expressions.  This
 may be addressed in a future version of Perl.
 
 =head3 Switching in a loop
@@ -1142,7 +1162,7 @@ You can override that with an explicit C<last> if you're
 interested in only the first match alone.
 
 This doesn't work if you explicitly specify a loop variable, as
-in C<for $item (@array)>. You have to use the default variable C<$_>.
+in C<for $item (@array)>.  You have to use the default variable C<$_>.
 
 =head3 Differences from Perl 6
 
@@ -1179,7 +1199,7 @@ this works in Perl 5:
     say "that's all, folks!";
 
 But it doesn't work at all in Perl 6.  Instead, you should
-use the (parallelizable) C<any> operator instead:
+use the (parallelizable) C<any> operator:
 
    if any(@primary) eq "red" {
        say "primary smartmatches red";
@@ -1195,9 +1215,9 @@ differences between Perl 6's and Perl 5's data models, but also because
 the Perl 6 spec has changed since Perl 5 rushed into early adoption.
 
 In Perl 6, C<when()> will always do an implicit smartmatch with its
-argument, while in Perl 5 it is convenient albeit potentially confusing) to
+argument, while in Perl 5 it is convenient (albeit potentially confusing) to
 suppress this implicit smartmatch in various rather loosely-defined
-situations, as roughly outlined above. (The difference is largely because
+situations, as roughly outlined above.  (The difference is largely because
 Perl 5 does not have, even internally, a boolean type.)
 
 =cut