8 A Perl program consists of a sequence of declarations and statements
9 which run from the top to the bottom. Loops, subroutines and other
10 control structures allow you to jump around within the code.
12 Perl is a B<free-form> language, you can format and indent it however
13 you like. Whitespace mostly serves to separate tokens, unlike
14 languages like Python where it is an important part of the syntax.
16 Many of Perl's syntactic elements are B<optional>. Rather than
17 requiring you to put parentheses around every function call and
18 declare every variable, you can often leave such explicit elements off
19 and Perl will figure out what you meant. This is known as B<Do What I
20 Mean>, abbreviated B<DWIM>. It allows programmers to be B<lazy> and to
21 code in a style with which they are comfortable.
23 Perl B<borrows syntax> and concepts from many languages: awk, sed, C,
24 Bourne Shell, Smalltalk, Lisp and even English. Other
25 languages have borrowed syntax from Perl, particularly its regular
26 expression extensions. So if you have programmed in another language
27 you will see familiar pieces in Perl. They often work the same, but
28 see L<perltrap> for information about how they differ.
31 X<declaration> X<undef> X<undefined> X<uninitialized>
33 The only things you need to declare in Perl are report formats and
34 subroutines (and sometimes not even subroutines). A variable holds
35 the undefined value (C<undef>) until it has been assigned a defined
36 value, which is anything other than C<undef>. When used as a number,
37 C<undef> is treated as C<0>; when used as a string, it is treated as
38 the empty string, C<"">; and when used as a reference that isn't being
39 assigned to, it is treated as an error. If you enable warnings,
40 you'll be notified of an uninitialized value whenever you treat
41 C<undef> as a string or a number. Well, usually. Boolean contexts,
47 are exempt from warnings (because they care about truth rather than
48 definedness). Operators such as C<++>, C<-->, C<+=>,
49 C<-=>, and C<.=>, that operate on undefined left values such as:
54 are also always exempt from such warnings.
56 A declaration can be put anywhere a statement can, but has no effect on
57 the execution of the primary sequence of statements--declarations all
58 take effect at compile time. Typically all the declarations are put at
59 the beginning or the end of the script. However, if you're using
60 lexically-scoped private variables created with C<my()>, you'll
62 your format or subroutine definition is within the same block scope
63 as the my if you expect to be able to access those private variables.
65 Declaring a subroutine allows a subroutine name to be used as if it were a
66 list operator from that point forward in the program. You can declare a
67 subroutine without defining it by saying C<sub name>, thus:
68 X<subroutine, declaration>
71 $me = myname $0 or die "can't get myname";
73 Note that myname() functions as a list operator, not as a unary operator;
74 so be careful to use C<or> instead of C<||> in this case. However, if
75 you were to declare the subroutine as C<sub myname ($)>, then
76 C<myname> would function as a unary operator, so either C<or> or
79 Subroutines declarations can also be loaded up with the C<require> statement
80 or both loaded and imported into your namespace with a C<use> statement.
81 See L<perlmod> for details on this.
83 A statement sequence may contain declarations of lexically-scoped
84 variables, but apart from declaring a variable name, the declaration acts
85 like an ordinary statement, and is elaborated within the sequence of
86 statements as if it were an ordinary statement. That means it actually
87 has both compile-time and run-time effects.
92 Text from a C<"#"> character until the end of the line is a comment,
93 and is ignored. Exceptions include C<"#"> inside a string or regular
96 =head2 Simple Statements
97 X<statement> X<semicolon> X<expression> X<;>
99 The only kind of simple statement is an expression evaluated for its
100 side effects. Every simple statement must be terminated with a
101 semicolon, unless it is the final statement in a block, in which case
102 the semicolon is optional. (A semicolon is still encouraged if the
103 block takes up more than one line, because you may eventually add
104 another line.) Note that there are some operators like C<eval {}> and
105 C<do {}> that look like compound statements, but aren't (they're just
106 TERMs in an expression), and thus need an explicit termination if used
107 as the last item in a statement.
109 =head2 Truth and Falsehood
110 X<truth> X<falsehood> X<true> X<false> X<!> X<not> X<negation> X<0>
112 The number 0, the strings C<'0'> and C<''>, the empty list C<()>, and
113 C<undef> are all false in a boolean context. All other values are true.
114 Negation of a true value by C<!> or C<not> returns a special false value.
115 When evaluated as a string it is treated as C<''>, but as a number, it
118 =head2 Statement Modifiers
119 X<statement modifier> X<modifier> X<if> X<unless> X<while>
120 X<until> X<foreach> X<for>
122 Any simple statement may optionally be followed by a I<SINGLE> modifier,
123 just before the terminating semicolon (or block ending). The possible
132 The C<EXPR> following the modifier is referred to as the "condition".
133 Its truth or falsehood determines how the modifier will behave.
135 C<if> executes the statement once I<if> and only if the condition is
136 true. C<unless> is the opposite, it executes the statement I<unless>
137 the condition is true (i.e., if the condition is false).
139 print "Basset hounds got long ears" if length $ear >= 10;
140 go_outside() and play() unless $is_raining;
142 The C<foreach> modifier is an iterator: it executes the statement once
143 for each item in the LIST (with C<$_> aliased to each item in turn).
145 print "Hello $_!\n" foreach qw(world Dolly nurse);
147 C<while> repeats the statement I<while> the condition is true.
148 C<until> does the opposite, it repeats the statement I<until> the
149 condition is true (or while the condition is false):
151 # Both of these count from 0 to 10.
152 print $i++ while $i <= 10;
153 print $j++ until $j > 10;
155 The C<while> and C<until> modifiers have the usual "C<while> loop"
156 semantics (conditional evaluated first), except when applied to a
157 C<do>-BLOCK (or to the deprecated C<do>-SUBROUTINE statement), in
158 which case the block executes once before the conditional is
159 evaluated. This is so that you can write loops like:
164 } until $line eq ".\n";
166 See L<perlfunc/do>. Note also that the loop control statements described
167 later will I<NOT> work in this construct, because modifiers don't take
168 loop labels. Sorry. You can always put another block inside of it
169 (for C<next>) or around it (for C<last>) to do that sort of thing.
170 For C<next>, just double the braces:
171 X<next> X<last> X<redo>
178 For C<last>, you have to be more elaborate:
188 B<NOTE:> The behaviour of a C<my> statement modified with a statement
189 modifier conditional or loop construct (e.g. C<my $x if ...>) is
190 B<undefined>. The value of the C<my> variable may be C<undef>, any
191 previously assigned value, or possibly anything else. Don't rely on
192 it. Future versions of perl might do something different from the
193 version of perl you try it out on. Here be dragons.
196 =head2 Compound Statements
197 X<statement, compound> X<block> X<bracket, curly> X<curly bracket> X<brace>
198 X<{> X<}> X<if> X<unless> X<while> X<until> X<foreach> X<for> X<continue>
200 In Perl, a sequence of statements that defines a scope is called a block.
201 Sometimes a block is delimited by the file containing it (in the case
202 of a required file, or the program as a whole), and sometimes a block
203 is delimited by the extent of a string (in the case of an eval).
205 But generally, a block is delimited by curly brackets, also known as braces.
206 We will call this syntactic construct a BLOCK.
208 The following compound statements may be used to control flow:
211 if (EXPR) BLOCK else BLOCK
212 if (EXPR) BLOCK elsif (EXPR) BLOCK ... else BLOCK
213 LABEL while (EXPR) BLOCK
214 LABEL while (EXPR) BLOCK continue BLOCK
215 LABEL until (EXPR) BLOCK
216 LABEL until (EXPR) BLOCK continue BLOCK
217 LABEL for (EXPR; EXPR; EXPR) BLOCK
218 LABEL foreach VAR (LIST) BLOCK
219 LABEL foreach VAR (LIST) BLOCK continue BLOCK
220 LABEL BLOCK continue BLOCK
222 Note that, unlike C and Pascal, these are defined in terms of BLOCKs,
223 not statements. This means that the curly brackets are I<required>--no
224 dangling statements allowed. If you want to write conditionals without
225 curly brackets there are several other ways to do it. The following
226 all do the same thing:
228 if (!open(FOO)) { die "Can't open $FOO: $!"; }
229 die "Can't open $FOO: $!" unless open(FOO);
230 open(FOO) or die "Can't open $FOO: $!"; # FOO or bust!
231 open(FOO) ? 'hi mom' : die "Can't open $FOO: $!";
232 # a bit exotic, that last one
234 The C<if> statement is straightforward. Because BLOCKs are always
235 bounded by curly brackets, there is never any ambiguity about which
236 C<if> an C<else> goes with. If you use C<unless> in place of C<if>,
237 the sense of the test is reversed.
239 The C<while> statement executes the block as long as the expression is
240 L<true|/"Truth and Falsehood">.
241 The C<until> statement executes the block as long as the expression is
243 The LABEL is optional, and if present, consists of an identifier followed
244 by a colon. The LABEL identifies the loop for the loop control
245 statements C<next>, C<last>, and C<redo>.
246 If the LABEL is omitted, the loop control statement
247 refers to the innermost enclosing loop. This may include dynamically
248 looking back your call-stack at run time to find the LABEL. Such
249 desperate behavior triggers a warning if you use the C<use warnings>
250 pragma or the B<-w> flag.
252 If there is a C<continue> BLOCK, it is always executed just before the
253 conditional is about to be evaluated again. Thus it can be used to
254 increment a loop variable, even when the loop has been continued via
255 the C<next> statement.
258 X<loop control> X<loop, control> X<next> X<last> X<redo> X<continue>
260 The C<next> command starts the next iteration of the loop:
262 LINE: while (<STDIN>) {
263 next LINE if /^#/; # discard comments
267 The C<last> command immediately exits the loop in question. The
268 C<continue> block, if any, is not executed:
270 LINE: while (<STDIN>) {
271 last LINE if /^$/; # exit when done with header
275 The C<redo> command restarts the loop block without evaluating the
276 conditional again. The C<continue> block, if any, is I<not> executed.
277 This command is normally used by programs that want to lie to themselves
278 about what was just input.
280 For example, when processing a file like F</etc/termcap>.
281 If your input lines might end in backslashes to indicate continuation, you
282 want to skip ahead and get the next record.
293 which is Perl short-hand for the more explicitly written version:
295 LINE: while (defined($line = <ARGV>)) {
297 if ($line =~ s/\\$//) {
299 redo LINE unless eof(); # not eof(ARGV)!
304 Note that if there were a C<continue> block on the above code, it would
305 get executed only on lines discarded by the regex (since redo skips the
306 continue block). A continue block is often used to reset line counters
307 or C<?pat?> one-time matches:
309 # inspired by :1,$g/fred/s//WILMA/
311 ?(fred)? && s//WILMA $1 WILMA/;
312 ?(barney)? && s//BETTY $1 BETTY/;
313 ?(homer)? && s//MARGE $1 MARGE/;
315 print "$ARGV $.: $_";
316 close ARGV if eof(); # reset $.
317 reset if eof(); # reset ?pat?
320 If the word C<while> is replaced by the word C<until>, the sense of the
321 test is reversed, but the conditional is still tested before the first
324 The loop control statements don't work in an C<if> or C<unless>, since
325 they aren't loops. You can double the braces to make them such, though.
329 next if /barney/; # same effect as "last", but doesn't document as well
333 This is caused by the fact that a block by itself acts as a loop that
334 executes once, see L<"Basic BLOCKs">.
336 The form C<while/if BLOCK BLOCK>, available in Perl 4, is no longer
337 available. Replace any occurrence of C<if BLOCK> by C<if (do BLOCK)>.
342 Perl's C-style C<for> loop works like the corresponding C<while> loop;
343 that means that this:
345 for ($i = 1; $i < 10; $i++) {
358 There is one minor difference: if variables are declared with C<my>
359 in the initialization section of the C<for>, the lexical scope of
360 those variables is exactly the C<for> loop (the body of the loop
361 and the control sections).
364 Besides the normal array index looping, C<for> can lend itself
365 to many other interesting applications. Here's one that avoids the
366 problem you get into if you explicitly test for end-of-file on
367 an interactive file descriptor causing your program to appear to
369 X<eof> X<end-of-file> X<end of file>
371 $on_a_tty = -t STDIN && -t STDOUT;
372 sub prompt { print "yes? " if $on_a_tty }
373 for ( prompt(); <STDIN>; prompt() ) {
377 Using C<readline> (or the operator form, C<< <EXPR> >>) as the
378 conditional of a C<for> loop is shorthand for the following. This
379 behaviour is the same as a C<while> loop conditional.
380 X<readline> X<< <> >>
382 for ( prompt(); defined( $_ = <STDIN> ); prompt() ) {
389 The C<foreach> loop iterates over a normal list value and sets the
390 variable VAR to be each element of the list in turn. If the variable
391 is preceded with the keyword C<my>, then it is lexically scoped, and
392 is therefore visible only within the loop. Otherwise, the variable is
393 implicitly local to the loop and regains its former value upon exiting
394 the loop. If the variable was previously declared with C<my>, it uses
395 that variable instead of the global one, but it's still localized to
396 the loop. This implicit localisation occurs I<only> in a C<foreach>
400 The C<foreach> keyword is actually a synonym for the C<for> keyword, so
401 you can use C<foreach> for readability or C<for> for brevity. (Or because
402 the Bourne shell is more familiar to you than I<csh>, so writing C<for>
403 comes more naturally.) If VAR is omitted, C<$_> is set to each value.
406 If any element of LIST is an lvalue, you can modify it by modifying
407 VAR inside the loop. Conversely, if any element of LIST is NOT an
408 lvalue, any attempt to modify that element will fail. In other words,
409 the C<foreach> loop index variable is an implicit alias for each item
410 in the list that you're looping over.
413 If any part of LIST is an array, C<foreach> will get very confused if
414 you add or remove elements within the loop body, for example with
415 C<splice>. So don't do that.
418 C<foreach> probably won't do what you expect if VAR is a tied or other
419 special variable. Don't do that either.
423 for (@ary) { s/foo/bar/ }
425 for my $elem (@elements) {
429 for $count (10,9,8,7,6,5,4,3,2,1,'BOOM') {
430 print $count, "\n"; sleep(1);
433 for (1..15) { print "Merry Christmas\n"; }
435 foreach $item (split(/:[\\\n:]*/, $ENV{TERMCAP})) {
436 print "Item: $item\n";
439 Here's how a C programmer might code up a particular algorithm in Perl:
441 for (my $i = 0; $i < @ary1; $i++) {
442 for (my $j = 0; $j < @ary2; $j++) {
443 if ($ary1[$i] > $ary2[$j]) {
444 last; # can't go to outer :-(
446 $ary1[$i] += $ary2[$j];
448 # this is where that last takes me
451 Whereas here's how a Perl programmer more comfortable with the idiom might
454 OUTER: for my $wid (@ary1) {
455 INNER: for my $jet (@ary2) {
456 next OUTER if $wid > $jet;
461 See how much easier this is? It's cleaner, safer, and faster. It's
462 cleaner because it's less noisy. It's safer because if code gets added
463 between the inner and outer loops later on, the new code won't be
464 accidentally executed. The C<next> explicitly iterates the other loop
465 rather than merely terminating the inner one. And it's faster because
466 Perl executes a C<foreach> statement more rapidly than it would the
467 equivalent C<for> loop.
472 A BLOCK by itself (labeled or not) is semantically equivalent to a
473 loop that executes once. Thus you can use any of the loop control
474 statements in it to leave or restart the block. (Note that this is
475 I<NOT> true in C<eval{}>, C<sub{}>, or contrary to popular belief
476 C<do{}> blocks, which do I<NOT> count as loops.) The C<continue>
479 The BLOCK construct can be used to emulate case structures.
482 if (/^abc/) { $abc = 1; last SWITCH; }
483 if (/^def/) { $def = 1; last SWITCH; }
484 if (/^xyz/) { $xyz = 1; last SWITCH; }
488 Such constructs are quite frequently used, because older versions
489 of Perl had no official C<switch> statement.
491 =head2 Switch statements
492 X<switch> X<case> X<given> X<when> X<default>
494 Starting from Perl 5.10, you can say
496 use feature "switch";
498 which enables a switch feature that is closely based on the
501 The keywords C<given> and C<when> are analogous
502 to C<switch> and C<case> in other languages, so the code
503 above could be written as
506 when (/^abc/) { $abc = 1; }
507 when (/^def/) { $def = 1; }
508 when (/^xyz/) { $xyz = 1; }
509 default { $nothing = 1; }
512 This construct is very flexible and powerful. For example:
517 say '$foo is undefined';
520 say '$foo is the string "foo"';
523 say '$foo is an odd digit';
524 continue; # Fall through
527 say '$foo is numerically less than 100';
529 when (\&complicated_check) {
530 say 'a complicated check for $foo is true';
533 die q(I don't know what to do with $foo);
537 C<given(EXPR)> will assign the value of EXPR to C<$_>
538 within the lexical scope of the block, so it's similar to
540 do { my $_ = EXPR; ... }
542 except that the block is automatically broken out of by a
543 successful C<when> or an explicit C<break>.
545 Most of the power comes from implicit smart matching:
549 is exactly equivalent to
553 In fact C<when(EXPR)> is treated as an implicit smart match most of the
554 time. The exceptions are that when EXPR is:
560 a subroutine or method call
564 a regular expression match, i.e. C</REGEX/> or C<$foo =~ /REGEX/>,
565 or a negated regular expression match (C<!/REGEX/> or C<$foo !~ /REGEX/>).
569 a comparison such as C<$_ E<lt> 10> or C<$x eq "abc">
570 (or of course C<$_ ~~ $c>)
574 C<defined(...)>, C<exists(...)>, or C<eof(...)>
578 a negated expression C<!(...)> or C<not (...)>, or a logical
579 exclusive-or C<(...) xor (...)>.
583 a filetest operator, with the exception of C<-s>, C<-M>, C<-A>, and C<-C>,
584 that return numerical values, not boolean ones.
588 the C<...> flip-flop operator (but B<not> the two-dot version C<..>, which
589 is used to construct and test against numerical or string ranges).
593 In those cases the value of EXPR is used directly as a boolean.
601 If EXPR is C<... && ...> or C<... and ...>, the test
602 is applied recursively to both arguments. If I<both>
603 arguments pass the test, then the argument is treated
608 If EXPR is C<... || ...>, C<... // ...> or C<... or ...>, the test
609 is applied recursively to the first argument.
613 These rules look complicated, but usually they will do what
614 you want. For example you could write:
616 when (/^\d+$/ && $_ < 75) { ... }
618 Another useful shortcut is that, if you use a literal array
619 or hash as the argument to C<when>, it is turned into a
620 reference. So C<given(@foo)> is the same as C<given(\@foo)>,
623 C<default> behaves exactly like C<when(1 == 1)>, which is
624 to say that it always matches.
626 See L</"Smart matching in detail"> for more information
631 You can use the C<break> keyword to break out of the enclosing
632 C<given> block. Every C<when> block is implicitly ended with
637 You can use the C<continue> keyword to fall through from one
641 when (/x/) { say '$foo contains an x'; continue }
642 when (/y/) { say '$foo contains a y' }
643 default { say '$foo does not contain a y' }
646 =head3 Switching in a loop
648 Instead of using C<given()>, you can use a C<foreach()> loop.
649 For example, here's one way to count how many times a particular
650 string occurs in an array:
654 when ("foo") { ++$count }
656 print "\@array contains $count copies of 'foo'\n";
658 On exit from the C<when> block, there is an implicit C<next>.
659 You can override that with an explicit C<last> if you're only
660 interested in the first match.
662 This doesn't work if you explicitly specify a loop variable,
663 as in C<for $item (@array)>. You have to use the default
664 variable C<$_>. (You can use C<for my $_ (@array)>.)
666 =head3 Smart matching in detail
668 The behaviour of a smart match depends on what type of thing its arguments
669 are. The behaviour is determined by the following table: the first row
670 that applies determines the match behaviour (which is thus mostly
671 determined by the type of the right operand). Note that the smart match
672 implicitly dereferences any hash or array ref, so the "Hash" and "Array"
673 entries apply in those cases.
675 $a $b Type of Match Implied Matching Code
676 ====== ===== ===================== =============
677 Any undef undefined !defined $a
679 Any Object invokes ~~ overloading on $object, or dies
681 Hash CodeRef sub truth for each key[1] !grep { !$b->($_) } keys %$a
682 Array CodeRef sub truth for each elt[1] !grep { !$b->($_) } @$a
683 Any CodeRef scalar sub truth $b->($a)
685 Hash Hash hash keys identical [sort keys %$a]~~[sort keys %$b]
686 Array Hash hash slice existence grep { exists $b->{$_} } @$a
687 Regex Hash hash key grep grep /$a/, keys %$b
688 undef Hash always false (undef can't be a key)
689 Any Hash hash entry existence exists $b->{$a}
691 Hash Array hash slice existence grep { exists $a->{$_} } @$b
692 Array Array arrays are comparable[2]
693 Regex Array array grep grep /$a/, @$b
694 undef Array array contains undef grep !defined, @$b
695 Any Array match against an array element[3]
698 Hash Regex hash key grep grep /$b/, keys %$a
699 Array Regex array grep grep /$b/, @$a
700 Any Regex pattern match $a =~ /$b/
702 undef Range[4] always false
703 Any Range[4] in range
705 Any Num numeric equality $a == $b
706 Num numish[5] numeric equality $a == $b
707 Any Any string equality $a eq $b
710 1 - empty hashes or arrays will match.
711 2 - that is, each element smart-matches the element of same index in the
713 3 - If a circular reference is found, we fall back to referential equality.
714 4 - a range is written EXPR..EXPR (using the C<..> range operator, but
715 NOT the three-dot version C<...>, which will be treated as a boolean
716 operator). Numeric ranges will use numeric comparison: that is,
717 "4.5 ~~ 3..5" will be true.
718 5 - either a real number, or a string that looks like a number
720 The "matching code" doesn't represent the I<real> matching code,
721 of course: it's just there to explain the intended meaning. Unlike
722 C<grep>, the smart match operator will short-circuit whenever it can.
724 =head3 Custom matching via overloading
726 You can change the way that an object is matched by overloading
727 the C<~~> operator. This trumps the usual smart match semantics.
728 See L<overload>. Since smart matching dispatch is driven by the
729 right hand side argument, overloading applies only when the object
730 is on the right of C<~~>.
732 It should be noted that C<~~> will refuse to work on objects that
733 don't overload it (in order to avoid relying on the object's
734 underlying structure).
736 =head3 Differences from Perl 6
738 The Perl 5 smart match and C<given>/C<when> constructs are not
739 absolutely identical to their Perl 6 analogues. The most visible
740 difference is that, in Perl 5, parentheses are required around
741 the argument to C<given()> and C<when()>. Parentheses in Perl 6
742 are always optional in a control construct such as C<if()>,
743 C<while()>, or C<when()>; they can't be made optional in Perl
744 5 without a great deal of potential confusion, because Perl 5
745 would parse the expression
751 as though the argument to C<given> were an element of the hash
752 C<%foo>, interpreting the braces as hash-element syntax.
754 The table of smart matches is not identical to that proposed by the
755 Perl 6 specification, mainly due to the differences between Perl 6's
756 and Perl 5's data models.
758 In Perl 6, C<when()> will always do an implicit smart match
759 with its argument, whilst it is convenient in Perl 5 to
760 suppress this implicit smart match in certain situations,
761 as documented above. (The difference is largely because Perl 5
762 does not, even internally, have a boolean type.)
767 Although not for the faint of heart, Perl does support a C<goto>
768 statement. There are three forms: C<goto>-LABEL, C<goto>-EXPR, and
769 C<goto>-&NAME. A loop's LABEL is not actually a valid target for
770 a C<goto>; it's just the name of the loop.
772 The C<goto>-LABEL form finds the statement labeled with LABEL and resumes
773 execution there. It may not be used to go into any construct that
774 requires initialization, such as a subroutine or a C<foreach> loop. It
775 also can't be used to go into a construct that is optimized away. It
776 can be used to go almost anywhere else within the dynamic scope,
777 including out of subroutines, but it's usually better to use some other
778 construct such as C<last> or C<die>. The author of Perl has never felt the
779 need to use this form of C<goto> (in Perl, that is--C is another matter).
781 The C<goto>-EXPR form expects a label name, whose scope will be resolved
782 dynamically. This allows for computed C<goto>s per FORTRAN, but isn't
783 necessarily recommended if you're optimizing for maintainability:
785 goto(("FOO", "BAR", "GLARCH")[$i]);
787 The C<goto>-&NAME form is highly magical, and substitutes a call to the
788 named subroutine for the currently running subroutine. This is used by
789 C<AUTOLOAD()> subroutines that wish to load another subroutine and then
790 pretend that the other subroutine had been called in the first place
791 (except that any modifications to C<@_> in the current subroutine are
792 propagated to the other subroutine.) After the C<goto>, not even C<caller()>
793 will be able to tell that this routine was called first.
795 In almost all cases like this, it's usually a far, far better idea to use the
796 structured control flow mechanisms of C<next>, C<last>, or C<redo> instead of
797 resorting to a C<goto>. For certain applications, the catch and throw pair of
798 C<eval{}> and die() for exception processing can also be a prudent approach.
800 =head2 PODs: Embedded Documentation
801 X<POD> X<documentation>
803 Perl has a mechanism for intermixing documentation with source code.
804 While it's expecting the beginning of a new statement, if the compiler
805 encounters a line that begins with an equal sign and a word, like this
807 =head1 Here There Be Pods!
809 Then that text and all remaining text up through and including a line
810 beginning with C<=cut> will be ignored. The format of the intervening
811 text is described in L<perlpod>.
813 This allows you to intermix your source code
814 and your documentation text freely, as in
818 The snazzle() function will behave in the most spectacular
819 form that you can possibly imagine, not even excepting
820 cybernetic pyrotechnics.
822 =cut back to the compiler, nuff of this pod stuff!
829 Note that pod translators should look at only paragraphs beginning
830 with a pod directive (it makes parsing easier), whereas the compiler
831 actually knows to look for pod escapes even in the middle of a
832 paragraph. This means that the following secret stuff will be
833 ignored by both the compiler and the translators.
837 warn "Neither POD nor CODE!?"
841 You probably shouldn't rely upon the C<warn()> being podded out forever.
842 Not all pod translators are well-behaved in this regard, and perhaps
843 the compiler will become pickier.
845 One may also use pod directives to quickly comment out a section
848 =head2 Plain Old Comments (Not!)
849 X<comment> X<line> X<#> X<preprocessor> X<eval>
851 Perl can process line directives, much like the C preprocessor. Using
852 this, one can control Perl's idea of filenames and line numbers in
853 error or warning messages (especially for strings that are processed
854 with C<eval()>). The syntax for this mechanism is the same as for most
855 C preprocessors: it matches the regular expression
857 # example: '# line 42 "new_filename.plx"'
860 (?:\s("?)([^"]+)\2)? \s*
863 with C<$1> being the line number for the next line, and C<$3> being
864 the optional filename (specified with or without quotes).
866 There is a fairly obvious gotcha included with the line directive:
867 Debuggers and profilers will only show the last source line to appear
868 at a particular line number in a given file. Care should be taken not
869 to cause line number collisions in code you'd like to debug later.
871 Here are some examples that you should be able to type into your command
876 # the `#' on the previous line must be the first char on line
879 foo at bzzzt line 201.
883 eval qq[\n#line 2001 ""\ndie 'foo']; print $@;
888 eval qq[\n#line 200 "foo bar"\ndie 'foo']; print $@;
890 foo at foo bar line 200.
894 eval "\n#line " . __LINE__ . ' "' . __FILE__ ."\"\ndie 'foo'";
897 foo at goop line 345.