PERLTRAP
NAME DESCRIPTION
perltrap - Perl traps for the unwary
The biggest trap of all is forgetting to use warnings or use the -w switch; see perllexwarn and perlrun. The second biggest trap is not making your entire program runnable under use strict. The third biggest trap is not reading the list of changes in this version of Perl; see perldelta.
Awk Traps
Accustomed awk users should take special note of the following:
The English module, loaded via
use English;
allows you to refer to special variables (like $/) with names (like $RS), as though they were in awk; see perlvar for details.
Semicolons are required after all simple statements in Perl (except at the end of a block). Newline is not a statement delimiter.
Curly brackets are required on ifs and whiles.
Variables begin with ``$, ``@ or ``%'' in Perl.
Arrays index from 0. Likewise string positions in substr() and index().
You have to decide whether your array has numeric or string indices.
Hash values do not spring into existence upon mere reference.
You have to decide whether you want to use string or numeric comparisons.
Reading an input line does not split it for you. You get to split it to an array yourself. And the split() operator has different arguments than awk's.
The current input line is normally in $_, not $0. It generally does not have the newline stripped. ($0 is the name of the program executed.) See perlvar.
$digit
The print() statement does not add field and record separators unless you set $, and $\. You can set $OFS and $ORS if you're using the English module.
You must open your files before you print to them.
The range operator is ``..'', not comma. The comma operator works as in C.
The match operator is ``='', not ``''. (``'' is the one's complement operator, as in C.)
The exponentiation operator is ``**, not ``^. ``^'' is the XOR operator, as in C. (You know, one could get the feeling that awk is basically incompatible with C.)
The concatenation operator is ``., not the null string. (Using the null string would render /pat/ /pat/ unparsable, because the third slash would be interpreted as a division operator--the tokenizer is in fact slightly context sensitive for operators like ``/, ``?'', and ``
The next, exit, and continue keywords work differently.
Awk Perl
ARGC scalar @ARGV (compare with $#ARGV) ARGV[0? $0 FILENAME $ARGV FNR $. - something FS (whatever you like) NF $#Fld, or some such NR $. OFMT $# OFS $, ORS $\ RLENGTH length($
You cannot set $RS to a pattern, only a string.
When in doubt, run the awk construct through a2p and see what it gives you.
C Traps
Cerebral C programmers should take note of the following:
Curly brackets are required on if's and while's.
You must use elsif rather than else if.
The break and continue keywords from C become in Perl last and next, respectively. Unlike in C, these do not work within a do { } while construct.
There's no switch statement. (But it's easy to build one on the fly.)
Variables begin with ``$, ``@ or ``%'' in Perl.
Comments begin with ``#, not ``/*.
You can't take the address of anything, although a similar operator in Perl is the backslash, which creates a reference.
ARGV must be capitalized. $ARGV[0? is C's argv[1?, and argv[0? ends up in $0.
System calls such as link(), unlink(), rename(), etc. return nonzero for success, not 0. (system(), however, returns zero for success.)
Signal handlers deal with signal names, not numbers. Use kill -l to find their names on your system.
Sed Traps
Seasoned sed programmers should take note of the following:
Backreferences in substitutions use ``$ rather than ``.
The pattern matching metacharacters ``(, ``), and ``'' do not have backslashes in front.
The range operator is ..., rather than comma.
Shell Traps
Sharp shell programmers should take note of the following:
The backtick operator does variable interpolation without regard to the presence of single quotes in the command.
The backtick operator does no translation of the return value, unlike csh.
Shells (especially csh) do several levels of substitution on each command line. Perl does substitution in only certain constructs such as double quotes, backticks, angle brackets, and search patterns.
Shells interpret scripts a little bit at a time. Perl compiles the entire program before executing it (except for BEGIN blocks, which execute at compile time).
The arguments are available via @ARGV, not $1, $2, etc.
The environment is not automatically made available as separate scalar variables.
Perl Traps
Practicing Perl Programmers should take note of the following:
Remember that many operations behave differently in a list context than they do in a scalar one. See perldata for details.
Avoid barewords if you can, especially all lowercase ones. You can't tell by just looking at it whether a bareword is a function or a string. By using quotes on strings and parentheses on function calls, you won't ever get them confused.
You cannot discern from mere inspection which builtins are unary operators (like chop() and chdir()) and which are list operators (like print() and unlink()). (Unless prototyped, user-defined subroutines can only be list operators, never unary ones.) See perlop and perlsub.
People have a hard time remembering that some functions default to $_, or @ARGV, or whatever, but that others which you might expect to do not.
The FH $_ only if the file
Remember not to use = when you need =;
$x = /foo/;
The do {} construct isn't a real loop that you can use loop control on.
Use my() for local variables whenever you can get away with it (but see perlform for where you can't). Using local() actually gives a local value to a global variable, which leaves you open to unforeseen side-effects of dynamic scoping.
If you localize an exported variable in a module, its exported value will not change. The local name becomes an alias to a new value but the external name is still an alias for the original.
Perl4 to Perl5 Traps
Practicing Perl4 Programmers should take note of the following Perl4-to-Perl5 specific traps.
They're crudely ordered according to the following list:
Discontinuance, Deprecation, and !BugFix? traps
Anything that's been fixed as a perl4 bug, removed as a perl4 feature or deprecated as a perl4 feature with the intent to encourage usage of some other perl5 feature.
Parsing Traps
Traps that appear to stem from the new parser.
Numerical Traps
Traps having to do with numerical or mathematical operators.
General data type traps
Traps involving perl standard data types.
Context Traps - scalar, list contexts
Traps related to context within lists, scalar statements/declarations.
Precedence Traps
Traps related to the precedence of parsing, evaluation, and execution of code.
General Regular Expression Traps using s///, etc.
Traps related to the use of pattern matching.
Subroutine, Signal, Sorting Traps
Traps related to the use of signals and signal handlers, general subroutines, and sorting, along with sorting subroutines.
OS Traps
OS-specific traps.
DBM Traps
Traps specific to the use of dbmopen(), and specific dbm implementations.
Unclassified Traps
Everything else.
If you find an example of a conversion trap that is not listed here, please submit it to perlbug@perl.org use warnings pragma or the -w switch.
Discontinuance, Deprecation, and !BugFix? traps
Anything that has been discontinued, deprecated, or fixed as a bug from perl4.
Discontinuance
Symbols starting with ``_'' are no longer forced into package main, except for $_ itself (and @_, etc.).
package test;
$_legacy = 1;
package main;
Deprecation
Double-colon is now a valid package separator in a variable name. Thus these behave differently in perl4 vs. perl5, because the packages don't exist.
$a=1;$b=2;$c=3;$var=4;
Given that :: is now the preferred package delimiter, it is debatable whether this should be classed as a bug or not. (The older package delimiter, ' ,is used here)
$x = 10 ;
print Also see precedence traps, for parsing $:.
The second and third arguments of splice() are now evaluated in scalar context (as the Camel says) rather than list context.
sub sub1{return(0,2) } # return a 2-element list
sub sub2{ return(1,2,3)} # return a 3-element list @a1 = (
Discontinuance
You can't do a goto into a block that is optimized away. Darn.
goto marker1; for(1)?{
marker1: print
Discontinuance
It is no longer syntactically legal to use whitespace as the name of a variable, or as a delimiter for any kind of quote construct. Double darn.
$a = (
- perl4 prints: a is foo bar, b is baz
Discontinuance
The archaic while/if BLOCK BLOCK syntax is no longer supported.
if { 1 } {
The ** operator now binds more tightly than unary minus. It was documented to work this way before, but didn't.
print -4**2,
- perl4 prints: 16
Discontinuance
The meaning of foreach{} has changed slightly when it is iterating over a list which is not an array. This used to assign the list to a temporary array, but no longer does so (for efficiency). This means that you'll now be iterating over the actual values, not over copies of the values. Modifications to the loop variable can change the original values.
@list = ('ab','abc','bcd','def');
foreach $var (grep(/ab/,@list)){ $var = 1; } print (join(':',@list));
To retain Perl4 semantics you need to assign your list explicitly to a temporary array and then iterate over that. For example, you might need to change
foreach $var (grep(/ab/,@list)){
to
foreach $var (@tmp = grep(/ab/,@list)){
Otherwise changing $var will clobber the values of @list. (This most often happens when you use $_ for the loop variable, and call subroutines in the loop that don't properly localize $_.)
Discontinuance
split with no arguments now behaves like split ' ' (which doesn't return an initial null field if $_ starts with whitespace), it used to behave like split /s+/ (which does).
$_ = ' hi mom';
print join(':', split);
Perl 4 would ignore any text which was attached to an -e switch, always taking the code snippet from the following arg. Additionally, it would silently accept an -e switch without a following arg. Both of these behaviors have been fixed.
perl -e'print
- perl4 prints: separate arg
perl5 prints: attached to -e
perl -e
- perl4 prints:
Discontinuance
In Perl 4 the return value of push was undocumented, but it was actually the last value being pushed onto the target list. In Perl 5 the return value of push is documented, but has changed, it is the number of elements in the resulting list.
@x = ('existing');
print push(@x, 'first new', 'second new');
Deprecation
Some error messages will be different.
Discontinuance
In Perl 4, if in list context the delimiters to the first argument of split() were ??, the result would be placed in @_ as well as being returned. Perl 5 has more respect for your subroutine arguments.
Discontinuance
Some bugs may have been inadvertently removed. :-)
Parsing Traps
Perl4-to-Perl5 traps from having to do with parsing.
Parsing
Note the space between . and =
$string . =
- perl4 prints: more string
Parsing
Better parsing in perl 5
sub foo {}
- perl4 prints: hello, world
Parsing
``if it looks like a function, it is a function'' rule.
($foo == 1) ?
Parsing
String interpolation of the $#array construct differs when braces are to used around the name.
@a = (1..3);
perl5 fails with syntax error
@ = (1..3);
Numerical Traps
Perl4-to-Perl5 traps having to do with numerical operators, operands, or output from same.
Numerical
Formatted output and significant digits
print 7.373504 - 0,
- Perl4 prints:
7.375039999999996141 7.37503999999999614
7.373504 7.37503999999999614
Numerical
This specific item has been deleted. It demonstrated how the auto-increment operator would not catch when a number went over the signed int limit. Fixed in version 5.003_04. But always be wary when using large integers. If in
Numerical
Assignment of return values from numeric equality tests does not work in perl5 when the test evaluates to false (0). Logical tests now return an null, instead of 0
$p = ($test == 1);
print $p,
Also see ``General Regular Expression Traps using s///, etc.'' for another example of this new feature...
Bitwise string ops
When bitwise operators which can operate upon either numbers or strings () are given only strings as arguments, perl4 would treat the operands as bitstrings so long as the program contained a call to the vec() function. perl5 treats the string operands as bitstrings. (See ``Bitwise String Operators'' in perlop for more details.)
$fred =
- Perl4 prints:
8
10
10
General data type traps
Perl4-to-Perl5 traps involving most data-types, and their usage within certain expressions and/or context.
(Arrays)
Negative array subscripts now count from the end of the array.
@a = (1, 2, 3, 4, 5);
(Arrays)
Setting $#array lower now discards array elements, and makes them impossible to recover.
@a = (a,b,c,d,e);
(Hashes)
Hashes get defined before use
local($s,@a,%h);
die
Perl will now generate a warning when it sees defined(@a) and defined(%h).
(Globs)
glob assignment from variable to variable will fail if the assigned variable is localized subsequent to the assignment
@a = (
- perl4 prints: This is Perl 4
(Globs)
Assigning undef to a glob has no effect in Perl 5. In Perl 4 it undefines the associated scalar (but may have other side effects including SEGVs). Perl 5 will also warn if undef is assigned to a typeglob. (Note that assigning undef to a typeglob is different than calling the undef function on a typeglob (undef
foo), which has quite a few effects.
$foo =
- perl4 prints:
(Scalar String)
Changes in unary negation (of strings) This change effects both the return value and what it does to auto(magic)increment.
$x =
- perl4 prints: aab : -0 : 1
(Constants)
$foo =
before: m after: m
(Scalars)
(Variable Suicide)
Variable suicide behavior is more consistent under Perl 5. Perl5 exhibits the same behavior for hashes and scalars, that perl4 exhibits for only scalars.
$aGlobal{ sub test {
local( *theArgument ) = @_; local( %aNewLocal ); # perl 4 != 5.001l,m $aNewLocal{
SUB: level 2
Context Traps - scalar, list contexts
(list context)
The elements of argument lists for formats are now evaluated in list context. This means you can interpolate list values now.
@fmt = (
- perl4 errors: Please use commas to separate fields in file
(scalar context)
The caller() function now returns a false value in a scalar context if there is no caller. This lets library files determine if they're being required.
caller() ? (print
- perl4 errors: There is no caller
(scalar context)
The comma operator in a scalar context is now guaranteed to give a scalar context to its arguments.
@y= ('a','b','c');
$x = (1, 2, @y); print
(list, builtin)
sprintf() is prototyped as ($;@), so its first argument is given scalar context. Thus, if passed an array, it will probably not do what you want, unlike Perl
$x = sprintf(@z); print $x;
printf STDOUT (@z);
Precedence Traps
Perl4-to-Perl5 traps involving precedence order.
Perl 4 has almost the same precedence rules as Perl 5 for the operators that they both have. Perl 4 however, seems to have had some inconsistencies that made the behavior differ from what was documented.
Precedence
LHS vs. RHS of any assignment operator. LHS is evaluated first in perl4, second in perl5; this can affect the relationship between side-effects in sub-expressions.
@arr = ( 'left', 'right' );
$a{shift @arr} = shift @arr; print join( ' ', keys %a );
Precedence
These are now semantic errors because of
%map = (
Precedence
The precedence of assignment operators is now the same as the precedence of assignment. Perl 4 mistakenly gave them the precedence of the associated operator. So you now must parenthesize them in expressions like
/foo/ ? ($a += 2) : ($a -= 2);
Otherwise
/foo/ ? $a += 2 : $a -= 2
would be erroneously parsed as
(/foo/ ? $a += 2 : $a) -= 2;
On the other hand,
$a += /foo/ ? 1 : 2;
now works as a C programmer would expect.
Precedence
open FOO die;
open(FOO die);
Precedence
perl4 gives the special variable, $: precedence, where perl5 treats $:: as main package
$a =
- perl 4 prints: -:a
Precedence
perl4 had buggy precedence for the file test operators vis-a-vis the assignment operators. Thus, although the precedence table for perl4 leads one to believe -e $foo .= should parse as ((-e $foo) .= , it actually parses as (-e ($foo .= . In perl5, the precedence is as documented.
Precedence
In perl4, keys(), each() and values() were special high-precedence operators that operated on a single hash, but in perl5, they are regular named unary operators. As documented, named unary operators have lower precedence than the arithmetic and concatenation operators
actually bind tighter than + - .. Thus,
print keys %foo - 1
The perl4 behavior was probably more useful, if less consistent.
General Regular Expression Traps using s///, etc.
All types of RE traps.
Regular Expression
s'$lhs'$rhs' now does no interpolation on either side. It used to interpolate $lhs but not $rhs. (And still does not match a literal '$' in string)
$a=1;$b=2;
$string = '1 2 $a $b'; $string = s'$a'$b'; print $string,
Regular Expression
m//g now attaches its state to the searched string rather than the regular expression. (Once the scope of a block is left for the sub, the state of the searched string is lost)
$_ =
- perl4 prints: Got blah Got blah Got blah Got blah
Regular Expression
Currently, if you use the m//o qualifier on a regular expression within an anonymous sub, all closures generated from that anonymous sub will use the regular expression as it was compiled when it was used the very first time in any such closure. For instance, if you say
sub build_match {
my($left,$right) = @_; return sub { $_[0? = /$left stuff $right/o; }; } $good = build_match('foo','bar'); $bad = build_match('baz','blarch'); print $good- For most builds of Perl5, this will print: ok not ok not ok
build_match() will always return a sub which matches the contents of $left and $right as they were the first time that build_match() was called, not as they are in the current call.
Regular Expression
If no parentheses are used in a match, Perl4 sets $+ to the whole match, just like $. Perl5 does not.
Regular Expression
substitution now returns the null string if it fails
$string =
- perl4 prints: 0
Also see ``Numerical Traps'' for another example of this new feature.
Regular Expression
s`lhs`rhs` (using backticks) is now a normal substitution, with no backtick expansion
$string =
- perl4 prints:
Regular Expression
Stricter parsing of variables used in regular expressions
s/^([^$grpc?*$grpc[$opt$plus$rep??)//o;
- perl4: compiles w/o error
an added component of this example, apparently from the same script, is the actual value of the s'd string after the substitution. [$opt? is a character class in perl4 and an array subscript in perl5
$grpc = 'a';
$opt = 'r'; $_ = 'bar'; s/^([^$grpc?*$grpc[$opt??)/foo/; print ;
Regular Expression
Under perl5, m?x? matches only once, like ?x?. Under perl4, it matched repeatedly, like /x/ or m!x!.
$test =
- perl4 prints: perl4
Subroutine, Signal, Sorting Traps
The general group of Perl4-to-Perl5 traps having to do with Signals, Sorting, and their related subroutines, as well as general subroutine traps. Includes some OS-Specific traps.
(Signals)
Barewords that used to look like strings to Perl will now look like subroutine calls if a subroutine by that name is defined before the compiler sees them.
sub !SeeYa? { warn
- perl4 prints: SIGTERM is now main'!SeeYa?
Use -w to catch this one
(Sort Subroutine)
reverse is no longer allowed as the name of a sort subroutine.
sub reverse{ print
- perl4 prints: yup yup 123
warn() won't let you specify a filehandle.
Although it always printed to STDERR , warn() would let you specify a filehandle in perl4. With perl5 it does not.
warn STDERR
- perl4 prints: Foo!
OS Traps
(SysV)
Under HPUX , and some other SysV OSes, one had to reset any signal handler, within the signal handler function, each time a signal was handled with perl4. With perl5, the reset is now done correctly. Any code relying on the handler not being reset will have to be reworked.
Since version 5.002, Perl uses sigaction() under SysV.
sub gotit {
$ = 1;
$pid = fork; if ($pid) { kill('INT', $pid); sleep(1); kill('INT', $pid); } else { while (1) {sleep(10);} }
(SysV)
Under SysV OSes, seek() on a file opened to append
now does the right thing w.r.t. the
fopen() manpage. e.g., - When a file is opened for append, it is impossible to overwrite information already in the file.
open(TEST,
- perl4 (solaris) seek.test has: 18 characters here
Interpolation Traps
Perl4-to-Perl5 traps having to do with how things get interpolated within certain expressions, statements, contexts, or whatever.
Interpolation
@ now always interpolates an array in double-quotish strings.
- perl4 prints: To:someone@somewhere.com
Interpolation
Double-quoted strings may no longer end with an unescaped $ or @.
$foo =
- perl4 prints: foo is foo$, bar is bar@
Note: perl5 DOES NOT error on the terminating @ in $bar
Interpolation
Perl now sometimes evaluates arbitrary expressions inside braces that occur within double quotes (usually when the opening brace is preceded by $ or @).
@www =
- perl4 prints: @{w.w.w}foo
Note that you can use strict; to ward off such trappiness under perl5.
Interpolation
The construct ``this is $$x'' used to interpolate the pid at that point, but now tries to dereference $x. $$ by itself still works fine, however.
$s =
- perl4 prints: this is XXXx (XXX is the current pid)
Interpolation
Creation of hashes on the fly with eval
now requires either both $'s
to be protected in the specification of the hash name, or both curlies to be protected. If both curlies are protected, the result will be compatible with perl4 and perl5. This is a very common practice, and should be changed to use the block form of eval{} if possible.
$hashname =
- perl4 prints: Yup
Changing
eval
to
eval
or, changing to
eval
Interpolation
perl4 programs which unconsciously rely on the bugs in earlier perl versions.
perl -e '$bar=q/not/; print
- perl4 prints: This is not perl5
Interpolation
You also have to be careful about array references.
print perl 4 prints: {
perl 5 prints: syntax error
Interpolation
$foo =
Perl 5 is looking for $foo{bar} which doesn't exist, but perl 4 is happy just to expand $foo to ``baz'' by itself. Watch out for this especially in eval's.
Interpolation
qq() string passed to eval
eval qq(
foreach $y (keys %$x) { $count++; } );
DBM Traps
General DBM traps.
DBM
Existing dbm databases created under perl4 (or any other dbm/ndbm tool) may cause the same script, run under perl5, to fail. The build of perl5 must have been linked with the same dbm/ndbm as the default for dbmopen() to function properly without tie'ing to an extension dbm implementation.
dbmopen (%dbm,
- perl4 prints: ok
DBM
Existing dbm databases created under perl4 (or any other dbm/ndbm tool) may cause the same script, run under perl5, to fail. The error generated when exceeding the limit on the key/value size will cause perl5 to exit immediately.
dbmopen(DB,
- perl4 prints:
dbm store returned -1, errno 28, key
dbm store returned -1, errno 28, key
Unclassified Traps
Everything else.
require/do trap using returned value
$rc = do
Same behavior if you replace do with require.
split on empty string with LIMIT specified
$string = '';
@list = split(/foo/, $string, 2) Perl4 returns a one element list containing the empty string but Perl5 returns an empty list.
As always, if any of these are ever officially declared as bugs, they'll be fixed and removed.
2 pages link to perltrap(1):