xref: /openbsd/gnu/usr.bin/perl/pod/perltrap.pod (revision 78b63d65)
1=head1 NAME
2
3perltrap - Perl traps for the unwary
4
5=head1 DESCRIPTION
6
7The biggest trap of all is forgetting to C<use warnings> or use the B<-w>
8switch; see L<perllexwarn> and L<perlrun>. The second biggest trap is not
9making your entire program runnable under C<use strict>.  The third biggest
10trap is not reading the list of changes in this version of Perl; see
11L<perldelta>.
12
13=head2 Awk Traps
14
15Accustomed B<awk> users should take special note of the following:
16
17=over 4
18
19=item *
20
21The English module, loaded via
22
23    use English;
24
25allows you to refer to special variables (like C<$/>) with names (like
26$RS), as though they were in B<awk>; see L<perlvar> for details.
27
28=item *
29
30Semicolons are required after all simple statements in Perl (except
31at the end of a block).  Newline is not a statement delimiter.
32
33=item *
34
35Curly brackets are required on C<if>s and C<while>s.
36
37=item *
38
39Variables begin with "$", "@" or "%" in Perl.
40
41=item *
42
43Arrays index from 0.  Likewise string positions in substr() and
44index().
45
46=item *
47
48You have to decide whether your array has numeric or string indices.
49
50=item *
51
52Hash values do not spring into existence upon mere reference.
53
54=item *
55
56You have to decide whether you want to use string or numeric
57comparisons.
58
59=item *
60
61Reading an input line does not split it for you.  You get to split it
62to an array yourself.  And the split() operator has different
63arguments than B<awk>'s.
64
65=item *
66
67The current input line is normally in $_, not $0.  It generally does
68not have the newline stripped.  ($0 is the name of the program
69executed.)  See L<perlvar>.
70
71=item *
72
73$<I<digit>> does not refer to fields--it refers to substrings matched
74by the last match pattern.
75
76=item *
77
78The print() statement does not add field and record separators unless
79you set C<$,> and C<$\>.  You can set $OFS and $ORS if you're using
80the English module.
81
82=item *
83
84You must open your files before you print to them.
85
86=item *
87
88The range operator is "..", not comma.  The comma operator works as in
89C.
90
91=item *
92
93The match operator is "=~", not "~".  ("~" is the one's complement
94operator, as in C.)
95
96=item *
97
98The exponentiation operator is "**", not "^".  "^" is the XOR
99operator, as in C.  (You know, one could get the feeling that B<awk> is
100basically incompatible with C.)
101
102=item *
103
104The concatenation operator is ".", not the null string.  (Using the
105null string would render C</pat/ /pat/> unparsable, because the third slash
106would be interpreted as a division operator--the tokenizer is in fact
107slightly context sensitive for operators like "/", "?", and ">".
108And in fact, "." itself can be the beginning of a number.)
109
110=item *
111
112The C<next>, C<exit>, and C<continue> keywords work differently.
113
114=item *
115
116
117The following variables work differently:
118
119      Awk	Perl
120      ARGC	scalar @ARGV (compare with $#ARGV)
121      ARGV[0]	$0
122      FILENAME	$ARGV
123      FNR	$. - something
124      FS	(whatever you like)
125      NF	$#Fld, or some such
126      NR	$.
127      OFMT	$#
128      OFS	$,
129      ORS	$\
130      RLENGTH	length($&)
131      RS	$/
132      RSTART	length($`)
133      SUBSEP	$;
134
135=item *
136
137You cannot set $RS to a pattern, only a string.
138
139=item *
140
141When in doubt, run the B<awk> construct through B<a2p> and see what it
142gives you.
143
144=back
145
146=head2 C Traps
147
148Cerebral C programmers should take note of the following:
149
150=over 4
151
152=item *
153
154Curly brackets are required on C<if>'s and C<while>'s.
155
156=item *
157
158You must use C<elsif> rather than C<else if>.
159
160=item *
161
162The C<break> and C<continue> keywords from C become in
163Perl C<last> and C<next>, respectively.
164Unlike in C, these do I<not> work within a C<do { } while> construct.
165
166=item *
167
168There's no switch statement.  (But it's easy to build one on the fly.)
169
170=item *
171
172Variables begin with "$", "@" or "%" in Perl.
173
174=item *
175
176Comments begin with "#", not "/*".
177
178=item *
179
180You can't take the address of anything, although a similar operator
181in Perl is the backslash, which creates a reference.
182
183=item *
184
185C<ARGV> must be capitalized.  C<$ARGV[0]> is C's C<argv[1]>, and C<argv[0]>
186ends up in C<$0>.
187
188=item *
189
190System calls such as link(), unlink(), rename(), etc. return nonzero for
191success, not 0. (system(), however, returns zero for success.)
192
193=item *
194
195Signal handlers deal with signal names, not numbers.  Use C<kill -l>
196to find their names on your system.
197
198=back
199
200=head2 Sed Traps
201
202Seasoned B<sed> programmers should take note of the following:
203
204=over 4
205
206=item *
207
208Backreferences in substitutions use "$" rather than "\".
209
210=item *
211
212The pattern matching metacharacters "(", ")", and "|" do not have backslashes
213in front.
214
215=item *
216
217The range operator is C<...>, rather than comma.
218
219=back
220
221=head2 Shell Traps
222
223Sharp shell programmers should take note of the following:
224
225=over 4
226
227=item *
228
229The backtick operator does variable interpolation without regard to
230the presence of single quotes in the command.
231
232=item *
233
234The backtick operator does no translation of the return value, unlike B<csh>.
235
236=item *
237
238Shells (especially B<csh>) do several levels of substitution on each
239command line.  Perl does substitution in only certain constructs
240such as double quotes, backticks, angle brackets, and search patterns.
241
242=item *
243
244Shells interpret scripts a little bit at a time.  Perl compiles the
245entire program before executing it (except for C<BEGIN> blocks, which
246execute at compile time).
247
248=item *
249
250The arguments are available via @ARGV, not $1, $2, etc.
251
252=item *
253
254The environment is not automatically made available as separate scalar
255variables.
256
257=back
258
259=head2 Perl Traps
260
261Practicing Perl Programmers should take note of the following:
262
263=over 4
264
265=item *
266
267Remember that many operations behave differently in a list
268context than they do in a scalar one.  See L<perldata> for details.
269
270=item *
271
272Avoid barewords if you can, especially all lowercase ones.
273You can't tell by just looking at it whether a bareword is
274a function or a string.  By using quotes on strings and
275parentheses on function calls, you won't ever get them confused.
276
277=item *
278
279You cannot discern from mere inspection which builtins
280are unary operators (like chop() and chdir())
281and which are list operators (like print() and unlink()).
282(Unless prototyped, user-defined subroutines can B<only> be list
283operators, never unary ones.)  See L<perlop> and L<perlsub>.
284
285=item *
286
287People have a hard time remembering that some functions
288default to $_, or @ARGV, or whatever, but that others which
289you might expect to do not.
290
291=item *
292
293The <FH> construct is not the name of the filehandle, it is a readline
294operation on that handle.  The data read is assigned to $_ only if the
295file read is the sole condition in a while loop:
296
297    while (<FH>)      { }
298    while (defined($_ = <FH>)) { }..
299    <FH>;  # data discarded!
300
301=item *
302
303Remember not to use C<=> when you need C<=~>;
304these two constructs are quite different:
305
306    $x =  /foo/;
307    $x =~ /foo/;
308
309=item *
310
311The C<do {}> construct isn't a real loop that you can use
312loop control on.
313
314=item *
315
316Use C<my()> for local variables whenever you can get away with
317it (but see L<perlform> for where you can't).
318Using C<local()> actually gives a local value to a global
319variable, which leaves you open to unforeseen side-effects
320of dynamic scoping.
321
322=item *
323
324If you localize an exported variable in a module, its exported value will
325not change.  The local name becomes an alias to a new value but the
326external name is still an alias for the original.
327
328=back
329
330=head2 Perl4 to Perl5 Traps
331
332Practicing Perl4 Programmers should take note of the following
333Perl4-to-Perl5 specific traps.
334
335They're crudely ordered according to the following list:
336
337=over 4
338
339=item Discontinuance, Deprecation, and BugFix traps
340
341Anything that's been fixed as a perl4 bug, removed as a perl4 feature
342or deprecated as a perl4 feature with the intent to encourage usage of
343some other perl5 feature.
344
345=item Parsing Traps
346
347Traps that appear to stem from the new parser.
348
349=item Numerical Traps
350
351Traps having to do with numerical or mathematical operators.
352
353=item General data type traps
354
355Traps involving perl standard data types.
356
357=item Context Traps - scalar, list contexts
358
359Traps related to context within lists, scalar statements/declarations.
360
361=item Precedence Traps
362
363Traps related to the precedence of parsing, evaluation, and execution of
364code.
365
366=item General Regular Expression Traps using s///, etc.
367
368Traps related to the use of pattern matching.
369
370=item Subroutine, Signal, Sorting Traps
371
372Traps related to the use of signals and signal handlers, general subroutines,
373and sorting, along with sorting subroutines.
374
375=item OS Traps
376
377OS-specific traps.
378
379=item DBM Traps
380
381Traps specific to the use of C<dbmopen()>, and specific dbm implementations.
382
383=item Unclassified Traps
384
385Everything else.
386
387=back
388
389If you find an example of a conversion trap that is not listed here,
390please submit it to <F<perlbug@perl.org>> for inclusion.
391Also note that at least some of these can be caught with the
392C<use warnings> pragma or the B<-w> switch.
393
394=head2 Discontinuance, Deprecation, and BugFix traps
395
396Anything that has been discontinued, deprecated, or fixed as
397a bug from perl4.
398
399=over 4
400
401=item * Discontinuance
402
403Symbols starting with "_" are no longer forced into package main, except
404for C<$_> itself (and C<@_>, etc.).
405
406    package test;
407    $_legacy = 1;
408
409    package main;
410    print "\$_legacy is ",$_legacy,"\n";
411
412    # perl4 prints: $_legacy is 1
413    # perl5 prints: $_legacy is
414
415=item * Deprecation
416
417Double-colon is now a valid package separator in a variable name.  Thus these
418behave differently in perl4 vs. perl5, because the packages don't exist.
419
420    $a=1;$b=2;$c=3;$var=4;
421    print "$a::$b::$c ";
422    print "$var::abc::xyz\n";
423
424    # perl4 prints: 1::2::3 4::abc::xyz
425    # perl5 prints: 3
426
427Given that C<::> is now the preferred package delimiter, it is debatable
428whether this should be classed as a bug or not.
429(The older package delimiter, ' ,is used here)
430
431    $x = 10 ;
432    print "x=${'x}\n" ;
433
434    # perl4 prints: x=10
435    # perl5 prints: Can't find string terminator "'" anywhere before EOF
436
437You can avoid this problem, and remain compatible with perl4, if you
438always explicitly include the package name:
439
440    $x = 10 ;
441    print "x=${main'x}\n" ;
442
443Also see precedence traps, for parsing C<$:>.
444
445=item * BugFix
446
447The second and third arguments of C<splice()> are now evaluated in scalar
448context (as the Camel says) rather than list context.
449
450    sub sub1{return(0,2) }          # return a 2-element list
451    sub sub2{ return(1,2,3)}        # return a 3-element list
452    @a1 = ("a","b","c","d","e");
453    @a2 = splice(@a1,&sub1,&sub2);
454    print join(' ',@a2),"\n";
455
456    # perl4 prints: a b
457    # perl5 prints: c d e
458
459=item * Discontinuance
460
461You can't do a C<goto> into a block that is optimized away.  Darn.
462
463    goto marker1;
464
465    for(1){
466    marker1:
467        print "Here I is!\n";
468    }
469
470    # perl4 prints: Here I is!
471    # perl5 errors: Can't "goto" into the middle of a foreach loop
472
473=item * Discontinuance
474
475It is no longer syntactically legal to use whitespace as the name
476of a variable, or as a delimiter for any kind of quote construct.
477Double darn.
478
479    $a = ("foo bar");
480    $b = q baz ;
481    print "a is $a, b is $b\n";
482
483    # perl4 prints: a is foo bar, b is baz
484    # perl5 errors: Bareword found where operator expected
485
486=item * Discontinuance
487
488The archaic while/if BLOCK BLOCK syntax is no longer supported.
489
490    if { 1 } {
491        print "True!";
492    }
493    else {
494        print "False!";
495    }
496
497    # perl4 prints: True!
498    # perl5 errors: syntax error at test.pl line 1, near "if {"
499
500=item * BugFix
501
502The C<**> operator now binds more tightly than unary minus.
503It was documented to work this way before, but didn't.
504
505    print -4**2,"\n";
506
507    # perl4 prints: 16
508    # perl5 prints: -16
509
510=item * Discontinuance
511
512The meaning of C<foreach{}> has changed slightly when it is iterating over a
513list which is not an array.  This used to assign the list to a
514temporary array, but no longer does so (for efficiency).  This means
515that you'll now be iterating over the actual values, not over copies of
516the values.  Modifications to the loop variable can change the original
517values.
518
519    @list = ('ab','abc','bcd','def');
520    foreach $var (grep(/ab/,@list)){
521        $var = 1;
522    }
523    print (join(':',@list));
524
525    # perl4 prints: ab:abc:bcd:def
526    # perl5 prints: 1:1:bcd:def
527
528To retain Perl4 semantics you need to assign your list
529explicitly to a temporary array and then iterate over that.  For
530example, you might need to change
531
532    foreach $var (grep(/ab/,@list)){
533
534to
535
536    foreach $var (@tmp = grep(/ab/,@list)){
537
538Otherwise changing $var will clobber the values of @list.  (This most often
539happens when you use C<$_> for the loop variable, and call subroutines in
540the loop that don't properly localize C<$_>.)
541
542=item * Discontinuance
543
544C<split> with no arguments now behaves like C<split ' '> (which doesn't
545return an initial null field if $_ starts with whitespace), it used to
546behave like C<split /\s+/> (which does).
547
548    $_ = ' hi mom';
549    print join(':', split);
550
551    # perl4 prints: :hi:mom
552    # perl5 prints: hi:mom
553
554=item * BugFix
555
556Perl 4 would ignore any text which was attached to an B<-e> switch,
557always taking the code snippet from the following arg.  Additionally, it
558would silently accept an B<-e> switch without a following arg.  Both of
559these behaviors have been fixed.
560
561    perl -e'print "attached to -e"' 'print "separate arg"'
562
563    # perl4 prints: separate arg
564    # perl5 prints: attached to -e
565
566    perl -e
567
568    # perl4 prints:
569    # perl5 dies: No code specified for -e.
570
571=item * Discontinuance
572
573In Perl 4 the return value of C<push> was undocumented, but it was
574actually the last value being pushed onto the target list.  In Perl 5
575the return value of C<push> is documented, but has changed, it is the
576number of elements in the resulting list.
577
578    @x = ('existing');
579    print push(@x, 'first new', 'second new');
580
581    # perl4 prints: second new
582    # perl5 prints: 3
583
584=item * Deprecation
585
586Some error messages will be different.
587
588=item * Discontinuance
589
590In Perl 4, if in list context the delimiters to the first argument of
591C<split()> were C<??>, the result would be placed in C<@_> as well as
592being returned.   Perl 5 has more respect for your subroutine arguments.
593
594=item * Discontinuance
595
596Some bugs may have been inadvertently removed.  :-)
597
598=back
599
600=head2 Parsing Traps
601
602Perl4-to-Perl5 traps from having to do with parsing.
603
604=over 4
605
606=item * Parsing
607
608Note the space between . and =
609
610    $string . = "more string";
611    print $string;
612
613    # perl4 prints: more string
614    # perl5 prints: syntax error at - line 1, near ". ="
615
616=item * Parsing
617
618Better parsing in perl 5
619
620    sub foo {}
621    &foo
622    print("hello, world\n");
623
624    # perl4 prints: hello, world
625    # perl5 prints: syntax error
626
627=item * Parsing
628
629"if it looks like a function, it is a function" rule.
630
631  print
632    ($foo == 1) ? "is one\n" : "is zero\n";
633
634    # perl4 prints: is zero
635    # perl5 warns: "Useless use of a constant in void context" if using -w
636
637=item * Parsing
638
639String interpolation of the C<$#array> construct differs when braces
640are to used around the name.
641
642    @a = (1..3);
643    print "${#a}";
644
645    # perl4 prints: 2
646    # perl5 fails with syntax error
647
648    @ = (1..3);
649    print "$#{a}";
650
651    # perl4 prints: {a}
652    # perl5 prints: 2
653
654=back
655
656=head2 Numerical Traps
657
658Perl4-to-Perl5 traps having to do with numerical operators,
659operands, or output from same.
660
661=over 5
662
663=item * Numerical
664
665Formatted output and significant digits
666
667    print 7.373504 - 0, "\n";
668    printf "%20.18f\n", 7.373504 - 0;
669
670    # Perl4 prints:
671    7.375039999999996141
672    7.37503999999999614
673
674    # Perl5 prints:
675    7.373504
676    7.37503999999999614
677
678=item * Numerical
679
680This specific item has been deleted.  It demonstrated how the auto-increment
681operator would not catch when a number went over the signed int limit.  Fixed
682in version 5.003_04.  But always be wary when using large integers.
683If in doubt:
684
685   use Math::BigInt;
686
687=item * Numerical
688
689Assignment of return values from numeric equality tests
690does not work in perl5 when the test evaluates to false (0).
691Logical tests now return an null, instead of 0
692
693    $p = ($test == 1);
694    print $p,"\n";
695
696    # perl4 prints: 0
697    # perl5 prints:
698
699Also see L<"General Regular Expression Traps using s///, etc.">
700for another example of this new feature...
701
702=item * Bitwise string ops
703
704When bitwise operators which can operate upon either numbers or
705strings (C<& | ^ ~>) are given only strings as arguments, perl4 would
706treat the operands as bitstrings so long as the program contained a call
707to the C<vec()> function. perl5 treats the string operands as bitstrings.
708(See L<perlop/Bitwise String Operators> for more details.)
709
710    $fred = "10";
711    $barney = "12";
712    $betty = $fred & $barney;
713    print "$betty\n";
714    # Uncomment the next line to change perl4's behavior
715    # ($dummy) = vec("dummy", 0, 0);
716
717    # Perl4 prints:
718    8
719
720    # Perl5 prints:
721    10
722
723    # If vec() is used anywhere in the program, both print:
724    10
725
726=back
727
728=head2 General data type traps
729
730Perl4-to-Perl5 traps involving most data-types, and their usage
731within certain expressions and/or context.
732
733=over 5
734
735=item * (Arrays)
736
737Negative array subscripts now count from the end of the array.
738
739    @a = (1, 2, 3, 4, 5);
740    print "The third element of the array is $a[3] also expressed as $a[-2] \n";
741
742    # perl4 prints: The third element of the array is 4 also expressed as
743    # perl5 prints: The third element of the array is 4 also expressed as 4
744
745=item * (Arrays)
746
747Setting C<$#array> lower now discards array elements, and makes them
748impossible to recover.
749
750    @a = (a,b,c,d,e);
751    print "Before: ",join('',@a);
752    $#a =1;
753    print ", After: ",join('',@a);
754    $#a =3;
755    print ", Recovered: ",join('',@a),"\n";
756
757    # perl4 prints: Before: abcde, After: ab, Recovered: abcd
758    # perl5 prints: Before: abcde, After: ab, Recovered: ab
759
760=item * (Hashes)
761
762Hashes get defined before use
763
764    local($s,@a,%h);
765    die "scalar \$s defined" if defined($s);
766    die "array \@a defined" if defined(@a);
767    die "hash \%h defined" if defined(%h);
768
769    # perl4 prints:
770    # perl5 dies: hash %h defined
771
772Perl will now generate a warning when it sees defined(@a) and
773defined(%h).
774
775=item * (Globs)
776
777glob assignment from variable to variable will fail if the assigned
778variable is localized subsequent to the assignment
779
780    @a = ("This is Perl 4");
781    *b = *a;
782    local(@a);
783    print @b,"\n";
784
785    # perl4 prints: This is Perl 4
786    # perl5 prints:
787
788=item * (Globs)
789
790Assigning C<undef> to a glob has no effect in Perl 5.   In Perl 4
791it undefines the associated scalar (but may have other side effects
792including SEGVs). Perl 5 will also warn if C<undef> is assigned to a
793typeglob. (Note that assigning C<undef> to a typeglob is different
794than calling the C<undef> function on a typeglob (C<undef *foo>), which
795has quite a few effects.
796
797    $foo = "bar";
798    *foo = undef;
799    print $foo;
800
801    # perl4 prints:
802    # perl4 warns: "Use of uninitialized variable" if using -w
803    # perl5 prints: bar
804    # perl5 warns: "Undefined value assigned to typeglob" if using -w
805
806=item * (Scalar String)
807
808Changes in unary negation (of strings)
809This change effects both the return value and what it
810does to auto(magic)increment.
811
812    $x = "aaa";
813    print ++$x," : ";
814    print -$x," : ";
815    print ++$x,"\n";
816
817    # perl4 prints: aab : -0 : 1
818    # perl5 prints: aab : -aab : aac
819
820=item * (Constants)
821
822perl 4 lets you modify constants:
823
824    $foo = "x";
825    &mod($foo);
826    for ($x = 0; $x < 3; $x++) {
827        &mod("a");
828    }
829    sub mod {
830        print "before: $_[0]";
831        $_[0] = "m";
832        print "  after: $_[0]\n";
833    }
834
835    # perl4:
836    # before: x  after: m
837    # before: a  after: m
838    # before: m  after: m
839    # before: m  after: m
840
841    # Perl5:
842    # before: x  after: m
843    # Modification of a read-only value attempted at foo.pl line 12.
844    # before: a
845
846=item * (Scalars)
847
848The behavior is slightly different for:
849
850    print "$x", defined $x
851
852    # perl 4: 1
853    # perl 5: <no output, $x is not called into existence>
854
855=item * (Variable Suicide)
856
857Variable suicide behavior is more consistent under Perl 5.
858Perl5 exhibits the same behavior for hashes and scalars,
859that perl4 exhibits for only scalars.
860
861    $aGlobal{ "aKey" } = "global value";
862    print "MAIN:", $aGlobal{"aKey"}, "\n";
863    $GlobalLevel = 0;
864    &test( *aGlobal );
865
866    sub test {
867        local( *theArgument ) = @_;
868        local( %aNewLocal ); # perl 4 != 5.001l,m
869        $aNewLocal{"aKey"} = "this should never appear";
870        print "SUB: ", $theArgument{"aKey"}, "\n";
871        $aNewLocal{"aKey"} = "level $GlobalLevel";   # what should print
872        $GlobalLevel++;
873        if( $GlobalLevel<4 ) {
874            &test( *aNewLocal );
875        }
876    }
877
878    # Perl4:
879    # MAIN:global value
880    # SUB: global value
881    # SUB: level 0
882    # SUB: level 1
883    # SUB: level 2
884
885    # Perl5:
886    # MAIN:global value
887    # SUB: global value
888    # SUB: this should never appear
889    # SUB: this should never appear
890    # SUB: this should never appear
891
892=back
893
894=head2 Context Traps - scalar, list contexts
895
896=over 5
897
898=item * (list context)
899
900The elements of argument lists for formats are now evaluated in list
901context.  This means you can interpolate list values now.
902
903    @fmt = ("foo","bar","baz");
904    format STDOUT=
905    @<<<<< @||||| @>>>>>
906    @fmt;
907    .
908    write;
909
910    # perl4 errors:  Please use commas to separate fields in file
911    # perl5 prints: foo     bar      baz
912
913=item * (scalar context)
914
915The C<caller()> function now returns a false value in a scalar context
916if there is no caller.  This lets library files determine if they're
917being required.
918
919    caller() ? (print "You rang?\n") : (print "Got a 0\n");
920
921    # perl4 errors: There is no caller
922    # perl5 prints: Got a 0
923
924=item * (scalar context)
925
926The comma operator in a scalar context is now guaranteed to give a
927scalar context to its arguments.
928
929    @y= ('a','b','c');
930    $x = (1, 2, @y);
931    print "x = $x\n";
932
933    # Perl4 prints:  x = c   # Thinks list context interpolates list
934    # Perl5 prints:  x = 3   # Knows scalar uses length of list
935
936=item * (list, builtin)
937
938C<sprintf()> is prototyped as ($;@), so its first argument is given scalar
939context. Thus, if passed an array, it will probably not do what you want,
940unlike Perl 4:
941
942    @z = ('%s%s', 'foo', 'bar');
943    $x = sprintf(@z);
944    print $x;
945
946    # perl4 prints: foobar
947    # perl5 prints: 3
948
949C<printf()> works the same as it did in Perl 4, though:
950
951    @z = ('%s%s', 'foo', 'bar');
952    printf STDOUT (@z);
953
954    # perl4 prints: foobar
955    # perl5 prints: foobar
956
957=back
958
959=head2 Precedence Traps
960
961Perl4-to-Perl5 traps involving precedence order.
962
963Perl 4 has almost the same precedence rules as Perl 5 for the operators
964that they both have.  Perl 4 however, seems to have had some
965inconsistencies that made the behavior differ from what was documented.
966
967=over 5
968
969=item * Precedence
970
971LHS vs. RHS of any assignment operator.  LHS is evaluated first
972in perl4, second in perl5; this can affect the relationship
973between side-effects in sub-expressions.
974
975    @arr = ( 'left', 'right' );
976    $a{shift @arr} = shift @arr;
977    print join( ' ', keys %a );
978
979    # perl4 prints: left
980    # perl5 prints: right
981
982=item * Precedence
983
984These are now semantic errors because of precedence:
985
986    @list = (1,2,3,4,5);
987    %map = ("a",1,"b",2,"c",3,"d",4);
988    $n = shift @list + 2;   # first item in list plus 2
989    print "n is $n, ";
990    $m = keys %map + 2;     # number of items in hash plus 2
991    print "m is $m\n";
992
993    # perl4 prints: n is 3, m is 6
994    # perl5 errors and fails to compile
995
996=item * Precedence
997
998The precedence of assignment operators is now the same as the precedence
999of assignment.  Perl 4 mistakenly gave them the precedence of the associated
1000operator.  So you now must parenthesize them in expressions like
1001
1002    /foo/ ? ($a += 2) : ($a -= 2);
1003
1004Otherwise
1005
1006    /foo/ ? $a += 2 : $a -= 2
1007
1008would be erroneously parsed as
1009
1010    (/foo/ ? $a += 2 : $a) -= 2;
1011
1012On the other hand,
1013
1014    $a += /foo/ ? 1 : 2;
1015
1016now works as a C programmer would expect.
1017
1018=item * Precedence
1019
1020    open FOO || die;
1021
1022is now incorrect.  You need parentheses around the filehandle.
1023Otherwise, perl5 leaves the statement as its default precedence:
1024
1025    open(FOO || die);
1026
1027    # perl4 opens or dies
1028    # perl5 opens FOO, dying only if 'FOO' is false, i.e. never
1029
1030=item * Precedence
1031
1032perl4 gives the special variable, C<$:> precedence, where perl5
1033treats C<$::> as main C<package>
1034
1035    $a = "x"; print "$::a";
1036
1037    # perl 4 prints: -:a
1038    # perl 5 prints: x
1039
1040=item * Precedence
1041
1042perl4 had buggy precedence for the file test operators vis-a-vis
1043the assignment operators.  Thus, although the precedence table
1044for perl4 leads one to believe C<-e $foo .= "q"> should parse as
1045C<((-e $foo) .= "q")>, it actually parses as C<(-e ($foo .= "q"))>.
1046In perl5, the precedence is as documented.
1047
1048    -e $foo .= "q"
1049
1050    # perl4 prints: no output
1051    # perl5 prints: Can't modify -e in concatenation
1052
1053=item * Precedence
1054
1055In perl4, keys(), each() and values() were special high-precedence operators
1056that operated on a single hash, but in perl5, they are regular named unary
1057operators.  As documented, named unary operators have lower precedence
1058than the arithmetic and concatenation operators C<+ - .>, but the perl4
1059variants of these operators actually bind tighter than C<+ - .>.
1060Thus, for:
1061
1062    %foo = 1..10;
1063    print keys %foo - 1
1064
1065    # perl4 prints: 4
1066    # perl5 prints: Type of arg 1 to keys must be hash (not subtraction)
1067
1068The perl4 behavior was probably more useful, if less consistent.
1069
1070=back
1071
1072=head2 General Regular Expression Traps using s///, etc.
1073
1074All types of RE traps.
1075
1076=over 5
1077
1078=item * Regular Expression
1079
1080C<s'$lhs'$rhs'> now does no interpolation on either side.  It used to
1081interpolate $lhs but not $rhs.  (And still does not match a literal
1082'$' in string)
1083
1084    $a=1;$b=2;
1085    $string = '1 2 $a $b';
1086    $string =~ s'$a'$b';
1087    print $string,"\n";
1088
1089    # perl4 prints: $b 2 $a $b
1090    # perl5 prints: 1 2 $a $b
1091
1092=item * Regular Expression
1093
1094C<m//g> now attaches its state to the searched string rather than the
1095regular expression.  (Once the scope of a block is left for the sub, the
1096state of the searched string is lost)
1097
1098    $_ = "ababab";
1099    while(m/ab/g){
1100        &doit("blah");
1101    }
1102    sub doit{local($_) = shift; print "Got $_ "}
1103
1104    # perl4 prints: Got blah Got blah Got blah Got blah
1105    # perl5 prints: infinite loop blah...
1106
1107=item * Regular Expression
1108
1109Currently, if you use the C<m//o> qualifier on a regular expression
1110within an anonymous sub, I<all> closures generated from that anonymous
1111sub will use the regular expression as it was compiled when it was used
1112the very first time in any such closure.  For instance, if you say
1113
1114    sub build_match {
1115        my($left,$right) = @_;
1116        return sub { $_[0] =~ /$left stuff $right/o; };
1117    }
1118    $good = build_match('foo','bar');
1119    $bad = build_match('baz','blarch');
1120    print $good->('foo stuff bar') ? "ok\n" : "not ok\n";
1121    print $bad->('baz stuff blarch') ? "ok\n" : "not ok\n";
1122    print $bad->('foo stuff bar') ? "not ok\n" : "ok\n";
1123
1124For most builds of Perl5, this will print:
1125ok
1126not ok
1127not ok
1128
1129build_match() will always return a sub which matches the contents of
1130$left and $right as they were the I<first> time that build_match()
1131was called, not as they are in the current call.
1132
1133=item * Regular Expression
1134
1135If no parentheses are used in a match, Perl4 sets C<$+> to
1136the whole match, just like C<$&>. Perl5 does not.
1137
1138    "abcdef" =~ /b.*e/;
1139    print "\$+ = $+\n";
1140
1141    # perl4 prints: bcde
1142    # perl5 prints:
1143
1144=item * Regular Expression
1145
1146substitution now returns the null string if it fails
1147
1148    $string = "test";
1149    $value = ($string =~ s/foo//);
1150    print $value, "\n";
1151
1152    # perl4 prints: 0
1153    # perl5 prints:
1154
1155Also see L<Numerical Traps> for another example of this new feature.
1156
1157=item * Regular Expression
1158
1159C<s`lhs`rhs`> (using backticks) is now a normal substitution, with no
1160backtick expansion
1161
1162    $string = "";
1163    $string =~ s`^`hostname`;
1164    print $string, "\n";
1165
1166    # perl4 prints: <the local hostname>
1167    # perl5 prints: hostname
1168
1169=item * Regular Expression
1170
1171Stricter parsing of variables used in regular expressions
1172
1173    s/^([^$grpc]*$grpc[$opt$plus$rep]?)//o;
1174
1175    # perl4: compiles w/o error
1176    # perl5: with Scalar found where operator expected ..., near "$opt$plus"
1177
1178an added component of this example, apparently from the same script, is
1179the actual value of the s'd string after the substitution.
1180C<[$opt]> is a character class in perl4 and an array subscript in perl5
1181
1182    $grpc = 'a';
1183    $opt  = 'r';
1184    $_ = 'bar';
1185    s/^([^$grpc]*$grpc[$opt]?)/foo/;
1186    print ;
1187
1188    # perl4 prints: foo
1189    # perl5 prints: foobar
1190
1191=item * Regular Expression
1192
1193Under perl5, C<m?x?> matches only once, like C<?x?>. Under perl4, it matched
1194repeatedly, like C</x/> or C<m!x!>.
1195
1196    $test = "once";
1197    sub match { $test =~ m?once?; }
1198    &match();
1199    if( &match() ) {
1200        # m?x? matches more then once
1201        print "perl4\n";
1202    } else {
1203        # m?x? matches only once
1204        print "perl5\n";
1205    }
1206
1207    # perl4 prints: perl4
1208    # perl5 prints: perl5
1209
1210
1211=back
1212
1213=head2 Subroutine, Signal, Sorting Traps
1214
1215The general group of Perl4-to-Perl5 traps having to do with
1216Signals, Sorting, and their related subroutines, as well as
1217general subroutine traps.  Includes some OS-Specific traps.
1218
1219=over 5
1220
1221=item * (Signals)
1222
1223Barewords that used to look like strings to Perl will now look like subroutine
1224calls if a subroutine by that name is defined before the compiler sees them.
1225
1226    sub SeeYa { warn"Hasta la vista, baby!" }
1227    $SIG{'TERM'} = SeeYa;
1228    print "SIGTERM is now $SIG{'TERM'}\n";
1229
1230    # perl4 prints: SIGTERM is now main'SeeYa
1231    # perl5 prints: SIGTERM is now main::1 (and warns "Hasta la vista, baby!")
1232
1233Use B<-w> to catch this one
1234
1235=item * (Sort Subroutine)
1236
1237reverse is no longer allowed as the name of a sort subroutine.
1238
1239    sub reverse{ print "yup "; $a <=> $b }
1240    print sort reverse (2,1,3);
1241
1242    # perl4 prints: yup yup 123
1243    # perl5 prints: 123
1244    # perl5 warns (if using -w): Ambiguous call resolved as CORE::reverse()
1245
1246=item * warn() won't let you specify a filehandle.
1247
1248Although it _always_ printed to STDERR, warn() would let you specify a
1249filehandle in perl4.  With perl5 it does not.
1250
1251    warn STDERR "Foo!";
1252
1253    # perl4 prints: Foo!
1254    # perl5 prints: String found where operator expected
1255
1256=back
1257
1258=head2 OS Traps
1259
1260=over 5
1261
1262=item * (SysV)
1263
1264Under HPUX, and some other SysV OSes, one had to reset any signal handler,
1265within  the signal handler function, each time a signal was handled with
1266perl4.  With perl5, the reset is now done correctly.  Any code relying
1267on the handler _not_ being reset will have to be reworked.
1268
1269Since version 5.002, Perl uses sigaction() under SysV.
1270
1271    sub gotit {
1272        print "Got @_... ";
1273    }
1274    $SIG{'INT'} = 'gotit';
1275
1276    $| = 1;
1277    $pid = fork;
1278    if ($pid) {
1279        kill('INT', $pid);
1280        sleep(1);
1281        kill('INT', $pid);
1282    } else {
1283        while (1) {sleep(10);}
1284    }
1285
1286    # perl4 (HPUX) prints: Got INT...
1287    # perl5 (HPUX) prints: Got INT... Got INT...
1288
1289=item * (SysV)
1290
1291Under SysV OSes, C<seek()> on a file opened to append C<<< >> >>> now does
1292the right thing w.r.t. the fopen() manpage. e.g., - When a file is opened
1293for append,  it  is  impossible to overwrite information already in
1294the file.
1295
1296    open(TEST,">>seek.test");
1297    $start = tell TEST ;
1298    foreach(1 .. 9){
1299        print TEST "$_ ";
1300    }
1301    $end = tell TEST ;
1302    seek(TEST,$start,0);
1303    print TEST "18 characters here";
1304
1305    # perl4 (solaris) seek.test has: 18 characters here
1306    # perl5 (solaris) seek.test has: 1 2 3 4 5 6 7 8 9 18 characters here
1307
1308
1309
1310=back
1311
1312=head2 Interpolation Traps
1313
1314Perl4-to-Perl5 traps having to do with how things get interpolated
1315within certain expressions, statements, contexts, or whatever.
1316
1317=over 5
1318
1319=item * Interpolation
1320
1321@ now always interpolates an array in double-quotish strings.
1322
1323    print "To: someone@somewhere.com\n";
1324
1325    # perl4 prints: To:someone@somewhere.com
1326    # perl < 5.6.1, error : In string, @somewhere now must be written as \@somewhere
1327    # perl >= 5.6.1, warning : Possible unintended interpolation of @somewhere in string
1328
1329=item * Interpolation
1330
1331Double-quoted strings may no longer end with an unescaped $ or @.
1332
1333    $foo = "foo$";
1334    $bar = "bar@";
1335    print "foo is $foo, bar is $bar\n";
1336
1337    # perl4 prints: foo is foo$, bar is bar@
1338    # perl5 errors: Final $ should be \$ or $name
1339
1340Note: perl5 DOES NOT error on the terminating @ in $bar
1341
1342=item * Interpolation
1343
1344Perl now sometimes evaluates arbitrary expressions inside braces that occur
1345within double quotes (usually when the opening brace is preceded by C<$>
1346or C<@>).
1347
1348    @www = "buz";
1349    $foo = "foo";
1350    $bar = "bar";
1351    sub foo { return "bar" };
1352    print "|@{w.w.w}|${main'foo}|";
1353
1354    # perl4 prints: |@{w.w.w}|foo|
1355    # perl5 prints: |buz|bar|
1356
1357Note that you can C<use strict;> to ward off such trappiness under perl5.
1358
1359=item * Interpolation
1360
1361The construct "this is $$x" used to interpolate the pid at that point, but
1362now tries to dereference $x.  C<$$> by itself still works fine, however.
1363
1364    $s = "a reference";
1365    $x = *s;
1366    print "this is $$x\n";
1367
1368    # perl4 prints: this is XXXx   (XXX is the current pid)
1369    # perl5 prints: this is a reference
1370
1371=item * Interpolation
1372
1373Creation of hashes on the fly with C<eval "EXPR"> now requires either both
1374C<$>'s to be protected in the specification of the hash name, or both curlies
1375to be protected.  If both curlies are protected, the result will be compatible
1376with perl4 and perl5.  This is a very common practice, and should be changed
1377to use the block form of C<eval{}>  if possible.
1378
1379    $hashname = "foobar";
1380    $key = "baz";
1381    $value = 1234;
1382    eval "\$$hashname{'$key'} = q|$value|";
1383    (defined($foobar{'baz'})) ?  (print "Yup") : (print "Nope");
1384
1385    # perl4 prints: Yup
1386    # perl5 prints: Nope
1387
1388Changing
1389
1390    eval "\$$hashname{'$key'} = q|$value|";
1391
1392to
1393
1394    eval "\$\$hashname{'$key'} = q|$value|";
1395
1396causes the following result:
1397
1398    # perl4 prints: Nope
1399    # perl5 prints: Yup
1400
1401or, changing to
1402
1403    eval "\$$hashname\{'$key'\} = q|$value|";
1404
1405causes the following result:
1406
1407    # perl4 prints: Yup
1408    # perl5 prints: Yup
1409    # and is compatible for both versions
1410
1411
1412=item * Interpolation
1413
1414perl4 programs which unconsciously rely on the bugs in earlier perl versions.
1415
1416    perl -e '$bar=q/not/; print "This is $foo{$bar} perl5"'
1417
1418    # perl4 prints: This is not perl5
1419    # perl5 prints: This is perl5
1420
1421=item * Interpolation
1422
1423You also have to be careful about array references.
1424
1425    print "$foo{"
1426
1427    perl 4 prints: {
1428    perl 5 prints: syntax error
1429
1430=item * Interpolation
1431
1432Similarly, watch out for:
1433
1434    $foo = "baz";
1435    print "\$$foo{bar}\n";
1436
1437    # perl4 prints: $baz{bar}
1438    # perl5 prints: $
1439
1440Perl 5 is looking for C<$foo{bar}> which doesn't exist, but perl 4 is
1441happy just to expand $foo to "baz" by itself.  Watch out for this
1442especially in C<eval>'s.
1443
1444=item * Interpolation
1445
1446C<qq()> string passed to C<eval>
1447
1448    eval qq(
1449        foreach \$y (keys %\$x\) {
1450            \$count++;
1451        }
1452    );
1453
1454    # perl4 runs this ok
1455    # perl5 prints: Can't find string terminator ")"
1456
1457=back
1458
1459=head2 DBM Traps
1460
1461General DBM traps.
1462
1463=over 5
1464
1465=item * DBM
1466
1467Existing dbm databases created under perl4 (or any other dbm/ndbm tool)
1468may cause the same script, run under perl5, to fail.  The build of perl5
1469must have been linked with the same dbm/ndbm as the default for C<dbmopen()>
1470to function properly without C<tie>'ing to an extension dbm implementation.
1471
1472    dbmopen (%dbm, "file", undef);
1473    print "ok\n";
1474
1475    # perl4 prints: ok
1476    # perl5 prints: ok (IFF linked with -ldbm or -lndbm)
1477
1478
1479=item * DBM
1480
1481Existing dbm databases created under perl4 (or any other dbm/ndbm tool)
1482may cause the same script, run under perl5, to fail.  The error generated
1483when exceeding the limit on the key/value size will cause perl5 to exit
1484immediately.
1485
1486    dbmopen(DB, "testdb",0600) || die "couldn't open db! $!";
1487    $DB{'trap'} = "x" x 1024;  # value too large for most dbm/ndbm
1488    print "YUP\n";
1489
1490    # perl4 prints:
1491    dbm store returned -1, errno 28, key "trap" at - line 3.
1492    YUP
1493
1494    # perl5 prints:
1495    dbm store returned -1, errno 28, key "trap" at - line 3.
1496
1497=back
1498
1499=head2 Unclassified Traps
1500
1501Everything else.
1502
1503=over 5
1504
1505=item * C<require>/C<do> trap using returned value
1506
1507If the file doit.pl has:
1508
1509    sub foo {
1510        $rc = do "./do.pl";
1511        return 8;
1512    }
1513    print &foo, "\n";
1514
1515And the do.pl file has the following single line:
1516
1517    return 3;
1518
1519Running doit.pl gives the following:
1520
1521    # perl 4 prints: 3 (aborts the subroutine early)
1522    # perl 5 prints: 8
1523
1524Same behavior if you replace C<do> with C<require>.
1525
1526=item * C<split> on empty string with LIMIT specified
1527
1528    $string = '';
1529    @list = split(/foo/, $string, 2)
1530
1531Perl4 returns a one element list containing the empty string but Perl5
1532returns an empty list.
1533
1534=back
1535
1536As always, if any of these are ever officially declared as bugs,
1537they'll be fixed and removed.
1538
1539