This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pod/perlipc.pod patch
[perl5.git] / pod / perlsyn.pod
CommitLineData
a0d0e21e
LW
1=head1 NAME
2
3perlsyn - Perl syntax
4
5=head1 DESCRIPTION
6
7A Perl script consists of a sequence of declarations and statements.
8The only things that need to be declared in Perl are report formats
9and subroutines. See the sections below for more information on those
10declarations. All uninitialized user-created objects are assumed to
11start with a null or 0 value until they are defined by some explicit
12operation such as assignment. (Though you can get warnings about the
13use of undefined values if you like.) The sequence of statements is
14executed just once, unlike in B<sed> and B<awk> scripts, where the
15sequence of statements is executed for each input line. While this means
16that you must explicitly loop over the lines of your input file (or
17files), it also means you have much more control over which files and
18which lines you look at. (Actually, I'm lying--it is possible to do an
19implicit loop with either the B<-n> or B<-p> switch. It's just not the
20mandatory default like it is in B<sed> and B<awk>.)
21
4633a7c4
LW
22=head2 Declarations
23
a0d0e21e
LW
24Perl is, for the most part, a free-form language. (The only
25exception to this is format declarations, for obvious reasons.) Comments
26are indicated by the "#" character, and extend to the end of the line. If
27you attempt to use C</* */> C-style comments, it will be interpreted
28either as division or pattern matching, depending on the context, and C++
4633a7c4 29C<//> comments just look like a null regular expression, so don't do
a0d0e21e
LW
30that.
31
32A declaration can be put anywhere a statement can, but has no effect on
33the execution of the primary sequence of statements--declarations all
34take effect at compile time. Typically all the declarations are put at
4633a7c4
LW
35the beginning or the end of the script. However, if you're using
36lexically-scoped private variables created with my(), you'll have to make sure
37your format or subroutine definition is within the same block scope
38as the my if you expect to to be able to access those private variables.
a0d0e21e 39
4633a7c4
LW
40Declaring a subroutine allows a subroutine name to be used as if it were a
41list operator from that point forward in the program. You can declare a
c07a80fd 42subroutine (prototyped to take one scalar parameter) without defining it by saying just:
a0d0e21e 43
c07a80fd 44 sub myname ($);
a0d0e21e
LW
45 $me = myname $0 or die "can't get myname";
46
4633a7c4 47Note that it functions as a list operator though, not as a unary
a0d0e21e
LW
48operator, so be careful to use C<or> instead of C<||> there.
49
4633a7c4
LW
50Subroutines declarations can also be loaded up with the C<require> statement
51or both loaded and imported into your namespace with a C<use> statement.
52See L<perlmod> for details on this.
a0d0e21e 53
4633a7c4
LW
54A statement sequence may contain declarations of lexically-scoped
55variables, but apart from declaring a variable name, the declaration acts
56like an ordinary statement, and is elaborated within the sequence of
57statements as if it were an ordinary statement. That means it actually
58has both compile-time and run-time effects.
a0d0e21e
LW
59
60=head2 Simple statements
61
62The only kind of simple statement is an expression evaluated for its
63side effects. Every simple statement must be terminated with a
64semicolon, unless it is the final statement in a block, in which case
65the semicolon is optional. (A semicolon is still encouraged there if the
748a9306 66block takes up more than one line, since you may eventually add another line.)
a0d0e21e
LW
67Note that there are some operators like C<eval {}> and C<do {}> that look
68like compound statements, but aren't (they're just TERMs in an expression),
4633a7c4 69and thus need an explicit termination if used as the last item in a statement.
a0d0e21e
LW
70
71Any simple statement may optionally be followed by a I<SINGLE> modifier,
72just before the terminating semicolon (or block ending). The possible
73modifiers are:
74
75 if EXPR
76 unless EXPR
77 while EXPR
78 until EXPR
79
80The C<if> and C<unless> modifiers have the expected semantics,
81presuming you're a speaker of English. The C<while> and C<until>
82modifiers also have the usual "while loop" semantics (conditional
83evaluated first), except when applied to a do-BLOCK (or to the
84now-deprecated do-SUBROUTINE statement), in which case the block
85executes once before the conditional is evaluated. This is so that you
86can write loops like:
87
88 do {
4633a7c4 89 $line = <STDIN>;
a0d0e21e 90 ...
4633a7c4 91 } until $line eq ".\n";
a0d0e21e
LW
92
93See L<perlfunc/do>. Note also that the loop control
94statements described later will I<NOT> work in this construct, since
95modifiers don't take loop labels. Sorry. You can always wrap
4633a7c4 96another block around it to do that sort of thing.
a0d0e21e
LW
97
98=head2 Compound statements
99
100In Perl, a sequence of statements that defines a scope is called a block.
101Sometimes a block is delimited by the file containing it (in the case
102of a required file, or the program as a whole), and sometimes a block
103is delimited by the extent of a string (in the case of an eval).
104
105But generally, a block is delimited by curly brackets, also known as braces.
106We will call this syntactic construct a BLOCK.
107
108The following compound statements may be used to control flow:
109
110 if (EXPR) BLOCK
111 if (EXPR) BLOCK else BLOCK
112 if (EXPR) BLOCK elsif (EXPR) BLOCK ... else BLOCK
113 LABEL while (EXPR) BLOCK
114 LABEL while (EXPR) BLOCK continue BLOCK
115 LABEL for (EXPR; EXPR; EXPR) BLOCK
748a9306 116 LABEL foreach VAR (LIST) BLOCK
a0d0e21e
LW
117 LABEL BLOCK continue BLOCK
118
119Note that, unlike C and Pascal, these are defined in terms of BLOCKs,
120not statements. This means that the curly brackets are I<required>--no
121dangling statements allowed. If you want to write conditionals without
122curly brackets there are several other ways to do it. The following
123all do the same thing:
124
125 if (!open(FOO)) { die "Can't open $FOO: $!"; }
126 die "Can't open $FOO: $!" unless open(FOO);
127 open(FOO) or die "Can't open $FOO: $!"; # FOO or bust!
128 open(FOO) ? 'hi mom' : die "Can't open $FOO: $!";
129 # a bit exotic, that last one
130
131The C<if> statement is straightforward. Since BLOCKs are always
132bounded by curly brackets, there is never any ambiguity about which
133C<if> an C<else> goes with. If you use C<unless> in place of C<if>,
134the sense of the test is reversed.
135
136The C<while> statement executes the block as long as the expression is
137true (does not evaluate to the null string or 0 or "0"). The LABEL is
4633a7c4
LW
138optional, and if present, consists of an identifier followed by a colon.
139The LABEL identifies the loop for the loop control statements C<next>,
140C<last>, and C<redo>. If the LABEL is omitted, the loop control statement
141refers to the innermost enclosing loop. This may include dynamically
142looking back your call-stack at run time to find the LABEL. Such
143desperate behavior triggers a warning if you use the B<-w> flag.
144
145If there is a C<continue> BLOCK, it is always executed just before the
146conditional is about to be evaluated again, just like the third part of a
147C<for> loop in C. Thus it can be used to increment a loop variable, even
148when the loop has been continued via the C<next> statement (which is
149similar to the C C<continue> statement).
150
151=head2 Loop Control
152
153The C<next> command is like the C<continue> statement in C; it starts
154the next iteration of the loop:
155
156 LINE: while (<STDIN>) {
157 next LINE if /^#/; # discard comments
158 ...
159 }
160
161The C<last> command is like the C<break> statement in C (as used in
162loops); it immediately exits the loop in question. The
163C<continue> block, if any, is not executed:
164
165 LINE: while (<STDIN>) {
166 last LINE if /^$/; # exit when done with header
167 ...
168 }
169
170The C<redo> command restarts the loop block without evaluating the
171conditional again. The C<continue> block, if any, is I<not> executed.
172This command is normally used by programs that want to lie to themselves
173about what was just input.
174
175For example, when processing a file like F</etc/termcap>.
176If your input lines might end in backslashes to indicate continuation, you
177want to skip ahead and get the next record.
178
179 while (<>) {
180 chomp;
181 if (s/\\$//) {
182 $_ .= <>;
183 redo unless eof();
184 }
185 # now process $_
186 }
187
188which is Perl short-hand for the more explicitly written version:
189
190 LINE: while ($line = <ARGV>) {
191 chomp($line);
192 if ($line =~ s/\\$//) {
193 $line .= <ARGV>;
194 redo LINE unless eof(); # not eof(ARGV)!
195 }
196 # now process $line
197 }
198
184e9718 199Or here's a simpleminded Pascal comment stripper (warning: assumes no { or } in strings).
4633a7c4
LW
200
201 LINE: while (<STDIN>) {
202 while (s|({.*}.*){.*}|$1 |) {}
203 s|{.*}| |;
204 if (s|{.*| |) {
205 $front = $_;
206 while (<STDIN>) {
207 if (/}/) { # end of comment?
208 s|^|$front{|;
209 redo LINE;
210 }
211 }
212 }
213 print;
214 }
215
216Note that if there were a C<continue> block on the above code, it would get
217executed even on discarded lines.
a0d0e21e
LW
218
219If the word C<while> is replaced by the word C<until>, the sense of the
220test is reversed, but the conditional is still tested before the first
221iteration.
222
223In either the C<if> or the C<while> statement, you may replace "(EXPR)"
224with a BLOCK, and the conditional is true if the value of the last
4633a7c4
LW
225statement in that block is true. While this "feature" continues to work in
226version 5, it has been deprecated, so please change any occurrences of "if BLOCK" to
227"if (do BLOCK)".
228
cb1a09d0 229=head2 For Loops
a0d0e21e 230
cb1a09d0
AD
231Perl's C-style C<for> loop works exactly like the corresponding C<while> loop;
232that means that this:
a0d0e21e
LW
233
234 for ($i = 1; $i < 10; $i++) {
235 ...
236 }
237
cb1a09d0 238is the same as this:
a0d0e21e
LW
239
240 $i = 1;
241 while ($i < 10) {
242 ...
243 } continue {
244 $i++;
245 }
246
55497cff
PP
247(There is one minor difference: The first form implies a lexical scope
248for variables declared with C<my> in the initialization expression.)
249
cb1a09d0
AD
250Besides the normal array index looping, C<for> can lend itself
251to many other interesting applications. Here's one that avoids the
252problem you get into if you explicitly test for end-of-file on
253an interactive file descriptor causing your program to appear to
254hang.
255
256 $on_a_tty = -t STDIN && -t STDOUT;
257 sub prompt { print "yes? " if $on_a_tty }
258 for ( prompt(); <STDIN>; prompt() ) {
259 # do something
260 }
261
262=head2 Foreach Loops
263
4633a7c4 264The C<foreach> loop iterates over a normal list value and sets the
55497cff
PP
265variable VAR to be each element of the list in turn. If the variable
266is preceded with the keyword C<my>, then it is lexically scoped, and
267is therefore visible only within the loop. Otherwise, the variable is
268implicitly local to the loop and regains its former value upon exiting
269the loop. If the variable was previously declared with C<my>, it uses
270that variable instead of the global one, but it's still localized to
271the loop. (Note that a lexically scoped variable can cause problems
272with you have subroutine or format declarations.)
4633a7c4
LW
273
274The C<foreach> keyword is actually a synonym for the C<for> keyword, so
275you can use C<foreach> for readability or C<for> for brevity. If VAR is
276omitted, $_ is set to each value. If LIST is an actual array (as opposed
277to an expression returning a list value), you can modify each element of
278the array by modifying VAR inside the loop. That's because the C<foreach>
279loop index variable is an implicit alias for each item in the list that
280you're looping over.
281
748a9306 282Examples:
a0d0e21e 283
4633a7c4 284 for (@ary) { s/foo/bar/ }
a0d0e21e 285
55497cff 286 foreach my $elem (@elements) {
a0d0e21e
LW
287 $elem *= 2;
288 }
289
4633a7c4
LW
290 for $count (10,9,8,7,6,5,4,3,2,1,'BOOM') {
291 print $count, "\n"; sleep(1);
a0d0e21e
LW
292 }
293
294 for (1..15) { print "Merry Christmas\n"; }
295
4633a7c4 296 foreach $item (split(/:[\\\n:]*/, $ENV{TERMCAP})) {
a0d0e21e
LW
297 print "Item: $item\n";
298 }
299
4633a7c4
LW
300Here's how a C programmer might code up a particular algorithm in Perl:
301
55497cff
PP
302 for (my $i = 0; $i < @ary1; $i++) {
303 for (my $j = 0; $j < @ary2; $j++) {
4633a7c4
LW
304 if ($ary1[$i] > $ary2[$j]) {
305 last; # can't go to outer :-(
306 }
307 $ary1[$i] += $ary2[$j];
308 }
cb1a09d0 309 # this is where that last takes me
4633a7c4
LW
310 }
311
184e9718 312Whereas here's how a Perl programmer more comfortable with the idiom might
cb1a09d0 313do it:
4633a7c4 314
55497cff
PP
315 OUTER: foreach my $wid (@ary1) {
316 INNER: foreach my $jet (@ary2) {
cb1a09d0
AD
317 next OUTER if $wid > $jet;
318 $wid += $jet;
4633a7c4
LW
319 }
320 }
321
cb1a09d0
AD
322See how much easier this is? It's cleaner, safer, and faster. It's
323cleaner because it's less noisy. It's safer because if code gets added
c07a80fd 324between the inner and outer loops later on, the new code won't be
9b1b54d0 325accidentally executed, the C<next> explicitly iterates the other loop
c07a80fd
PP
326rather than merely terminating the inner one. And it's faster because
327Perl executes a C<foreach> statement more rapidly than it would the
328equivalent C<for> loop.
4633a7c4
LW
329
330=head2 Basic BLOCKs and Switch Statements
331
55497cff
PP
332A BLOCK by itself (labeled or not) is semantically equivalent to a
333loop that executes once. Thus you can use any of the loop control
334statements in it to leave or restart the block. (Note that this is
335I<NOT> true in C<eval{}>, C<sub{}>, or contrary to popular belief
336C<do{}> blocks, which do I<NOT> count as loops.) The C<continue>
337block is optional.
4633a7c4
LW
338
339The BLOCK construct is particularly nice for doing case
a0d0e21e
LW
340structures.
341
342 SWITCH: {
343 if (/^abc/) { $abc = 1; last SWITCH; }
344 if (/^def/) { $def = 1; last SWITCH; }
345 if (/^xyz/) { $xyz = 1; last SWITCH; }
346 $nothing = 1;
347 }
348
349There is no official switch statement in Perl, because there are
350already several ways to write the equivalent. In addition to the
351above, you could write
352
353 SWITCH: {
354 $abc = 1, last SWITCH if /^abc/;
355 $def = 1, last SWITCH if /^def/;
356 $xyz = 1, last SWITCH if /^xyz/;
357 $nothing = 1;
358 }
359
cb1a09d0 360(That's actually not as strange as it looks once you realize that you can
a0d0e21e
LW
361use loop control "operators" within an expression, That's just the normal
362C comma operator.)
363
364or
365
366 SWITCH: {
367 /^abc/ && do { $abc = 1; last SWITCH; };
368 /^def/ && do { $def = 1; last SWITCH; };
369 /^xyz/ && do { $xyz = 1; last SWITCH; };
370 $nothing = 1;
371 }
372
373or formatted so it stands out more as a "proper" switch statement:
374
375 SWITCH: {
376 /^abc/ && do {
377 $abc = 1;
378 last SWITCH;
379 };
380
381 /^def/ && do {
382 $def = 1;
383 last SWITCH;
384 };
385
386 /^xyz/ && do {
387 $xyz = 1;
388 last SWITCH;
389 };
390 $nothing = 1;
391 }
392
393or
394
395 SWITCH: {
396 /^abc/ and $abc = 1, last SWITCH;
397 /^def/ and $def = 1, last SWITCH;
398 /^xyz/ and $xyz = 1, last SWITCH;
399 $nothing = 1;
400 }
401
402or even, horrors,
403
404 if (/^abc/)
405 { $abc = 1 }
406 elsif (/^def/)
407 { $def = 1 }
408 elsif (/^xyz/)
409 { $xyz = 1 }
410 else
411 { $nothing = 1 }
412
4633a7c4
LW
413
414A common idiom for a switch statement is to use C<foreach>'s aliasing to make
415a temporary assignment to $_ for convenient matching:
416
417 SWITCH: for ($where) {
418 /In Card Names/ && do { push @flags, '-e'; last; };
419 /Anywhere/ && do { push @flags, '-h'; last; };
420 /In Rulings/ && do { last; };
421 die "unknown value for form variable where: `$where'";
422 }
423
cb1a09d0
AD
424Another interesting approach to a switch statement is arrange
425for a C<do> block to return the proper value:
426
427 $amode = do {
428 if ($flag & O_RDONLY) { "r" }
c07a80fd 429 elsif ($flag & O_WRONLY) { ($flag & O_APPEND) ? "a" : "w" }
cb1a09d0
AD
430 elsif ($flag & O_RDWR) {
431 if ($flag & O_CREAT) { "w+" }
c07a80fd 432 else { ($flag & O_APPEND) ? "a+" : "r+" }
cb1a09d0
AD
433 }
434 };
435
4633a7c4
LW
436=head2 Goto
437
438Although not for the faint of heart, Perl does support a C<goto> statement.
439A loop's LABEL is not actually a valid target for a C<goto>;
440it's just the name of the loop. There are three forms: goto-LABEL,
441goto-EXPR, and goto-&NAME.
442
443The goto-LABEL form finds the statement labeled with LABEL and resumes
444execution there. It may not be used to go into any construct that
445requires initialization, such as a subroutine or a foreach loop. It
446also can't be used to go into a construct that is optimized away. It
447can be used to go almost anywhere else within the dynamic scope,
448including out of subroutines, but it's usually better to use some other
449construct such as last or die. The author of Perl has never felt the
450need to use this form of goto (in Perl, that is--C is another matter).
451
452The goto-EXPR form expects a label name, whose scope will be resolved
453dynamically. This allows for computed gotos per FORTRAN, but isn't
454necessarily recommended if you're optimizing for maintainability:
455
456 goto ("FOO", "BAR", "GLARCH")[$i];
457
458The goto-&NAME form is highly magical, and substitutes a call to the
459named subroutine for the currently running subroutine. This is used by
460AUTOLOAD() subroutines that wish to load another subroutine and then
461pretend that the other subroutine had been called in the first place
462(except that any modifications to @_ in the current subroutine are
463propagated to the other subroutine.) After the C<goto>, not even caller()
464will be able to tell that this routine was called first.
465
c07a80fd
PP
466In almost all cases like this, it's usually a far, far better idea to use the
467structured control flow mechanisms of C<next>, C<last>, or C<redo> instead of
4633a7c4
LW
468resorting to a C<goto>. For certain applications, the catch and throw pair of
469C<eval{}> and die() for exception processing can also be a prudent approach.
cb1a09d0
AD
470
471=head2 PODs: Embedded Documentation
472
473Perl has a mechanism for intermixing documentation with source code.
c07a80fd 474While it's expecting the beginning of a new statement, if the compiler
cb1a09d0
AD
475encounters a line that begins with an equal sign and a word, like this
476
477 =head1 Here There Be Pods!
478
479Then that text and all remaining text up through and including a line
480beginning with C<=cut> will be ignored. The format of the intervening
481text is described in L<perlpod>.
482
483This allows you to intermix your source code
484and your documentation text freely, as in
485
486 =item snazzle($)
487
488 The snazzle() function will behave in the most spectacular
489 form that you can possibly imagine, not even excepting
490 cybernetic pyrotechnics.
491
492 =cut back to the compiler, nuff of this pod stuff!
493
494 sub snazzle($) {
495 my $thingie = shift;
496 .........
497 }
498
499Note that pod translators should only look at paragraphs beginning
184e9718 500with a pod directive (it makes parsing easier), whereas the compiler
cb1a09d0
AD
501actually knows to look for pod escapes even in the middle of a
502paragraph. This means that the following secret stuff will be
503ignored by both the compiler and the translators.
504
505 $a=3;
506 =secret stuff
507 warn "Neither POD nor CODE!?"
508 =cut back
509 print "got $a\n";
510
511You probably shouldn't rely upon the warn() being podded out forever.
512Not all pod translators are well-behaved in this regard, and perhaps
513the compiler will become pickier.