Commit | Line | Data |
5f05dabc |
1 | =head1 NAME |
2 | |
774d564b |
3 | perldelta - what's new for perl5.004 |
5f05dabc |
4 | |
5 | =head1 DESCRIPTION |
6 | |
7 | This document describes differences between the 5.003 release (as |
8 | documented in I<Programming Perl>, second edition--the Camel Book) and |
9 | this one. |
10 | |
11 | =head1 Supported Environments |
12 | |
13 | Perl5.004 builds out of the box on Unix, Plan9, LynxOS, VMS, OS/2, |
14 | QNX, and AmigaOS. |
15 | |
16 | =head1 Core Changes |
17 | |
18 | Most importantly, many bugs were fixed. See the F<Changes> |
19 | file in the distribution for details. |
20 | |
54310121 |
21 | =head2 Compilation option: Binary compatibility with 5.003 |
5f05dabc |
22 | |
23 | There is a new Configure question that asks if you want to maintain |
24 | binary compatibility with Perl 5.003. If you choose binary |
25 | compatibility, you do not have to recompile your extensions, but you |
44a8e56a |
26 | might have symbol conflicts if you embed Perl in another application, |
774d564b |
27 | just as in the 5.003 release. By default, binary compatibility |
28 | is preserved at the expense of symbol table pollution. |
5f05dabc |
29 | |
54310121 |
30 | =head2 $PERL5OPT environment variable |
31 | |
32 | You may now put Perl options in the $PERL5OPT environment variable. |
33 | Unless Perl is running with taint checks, it will interpret this |
34 | variable as if its contents had appeared on a "#!perl" line at the |
35 | beginning of your script, except that hyphens are optional. PERL5OPT |
36 | may only be used to set the following switches: B<-[DIMUdmw]>. |
37 | |
8cc95fdb |
38 | =head2 Limitations on B<-M>, and C<-m>, and B<-T> options |
39 | |
40 | The C<-M> and C<-m> options are no longer allowed on the C<#!> line of |
41 | a script. If a script needs a module, it should invoke it with the |
42 | C<use> pragma. |
43 | |
44 | The B<-T> option is also forbidden on the C<#!> line of a script, |
45 | unless it was present on the Perl command line. Due to the way C<#!> |
46 | works, this usually means that B<-T> must be in the first argument. |
47 | Thus: |
48 | |
49 | #!/usr/bin/perl -T -w |
50 | |
51 | will probably work for an executable script invoked as C<scriptname>, |
52 | while: |
53 | |
54 | #!/usr/bin/perl -w -T |
55 | |
56 | will probably fail under the same conditions. (Non-Unix systems will |
57 | probably not follow this rule.) But C<perl scriptname> is guaranteed |
58 | to fail, since then there is no chance of B<-T> being found on the |
59 | command line before it is found on the C<#!> line. |
60 | |
54310121 |
61 | =head2 More precise warnings |
62 | |
dc848c6f |
63 | If you removed the B<-w> option from your Perl 5.003 scripts because it |
54310121 |
64 | made Perl too verbose, we recommend that you try putting it back when |
65 | you upgrade to Perl 5.004. Each new perl version tends to remove some |
66 | undesirable warnings, while adding new warnings that may catch bugs in |
67 | your scripts. |
68 | |
dc848c6f |
69 | =head2 Deprecated: Inherited C<AUTOLOAD> for non-methods |
70 | |
71 | Before Perl 5.004, C<AUTOLOAD> functions were looked up as methods |
72 | (using the C<@ISA> hierarchy), even when the function to be autoloaded |
73 | was called as a plain function (e.g. C<Foo::bar()>), not a method |
74 | (e.g. C<Foo->bar()> or C<$obj->bar()>). |
75 | |
76 | Perl 5.005 will use method lookup only for methods' C<AUTOLOAD>s. |
77 | However, there is a significant base of existing code that may be using |
78 | the old behavior. So, as an interim step, Perl 5.004 issues an optional |
79 | warning when a non-method uses an inherited C<AUTOLOAD>. |
80 | |
81 | The simple rule is: Inheritance will not work when autoloading |
82 | non-methods. The simple fix for old code is: In any module that used to |
83 | depend on inheriting C<AUTOLOAD> for non-methods from a base class named |
84 | C<BaseClass>, execute C<*AUTOLOAD = \&BaseClass::AUTOLOAD> during startup. |
85 | |
3fe9a6f1 |
86 | =head2 Subroutine arguments created only when they're modified |
7cfe7857 |
87 | |
3fe9a6f1 |
88 | In Perl 5.004, nonexistent array and hash elements used as subroutine |
89 | parameters are brought into existence only if they are actually |
90 | assigned to (via C<@_>). |
2ae324a7 |
91 | |
3fe9a6f1 |
92 | Earlier versions of Perl vary in their handling of such arguments. |
93 | Perl versions 5.002 and 5.003 always brought them into existence. |
94 | Perl versions 5.000, 5.001, and 5.002 brought them into existence only |
95 | if they were not the first argument (which was almost certainly a |
96 | bug). Earlier versions of Perl never brought them into existence. |
97 | |
98 | For example, given this code: |
99 | |
100 | undef @a; undef %a; |
101 | sub show { print $_[0] }; |
102 | sub change { $_[0]++ }; |
103 | show($a[2]); |
104 | change($a{b}); |
105 | |
106 | After this code executes in Perl 5.004, $a{b} exists but $a[2] does |
107 | not. In Perl 5.002 and 5.003, both $a{b} and $a[2] would have existed |
108 | (but $a[2]'s value would have been undefined). |
7cfe7857 |
109 | |
8cc95fdb |
110 | =head2 Group vector changeable with C<$)> |
5cd24f17 |
111 | |
112 | The C<$)> special variable has always (well, in Perl 5, at least) |
8cc95fdb |
113 | reflected not only the current effective group, but also the group list |
114 | as returned by the C<getgroups()> C function (if there is one). |
115 | However, until this release, there has not been a way to call the |
116 | C<setgroups()> C function from Perl. |
5cd24f17 |
117 | |
8cc95fdb |
118 | In Perl 5.004, assigning to C<$)> is exactly symmetrical with examining |
119 | it: The first number in its string value is used as the effective gid; |
120 | if there are any numbers after the first one, they are passed to the |
121 | C<setgroups()> C function (if there is one). |
5cd24f17 |
122 | |
54310121 |
123 | =head2 Fixed parsing of $$<digit>, &$<digit>, etc. |
aa689395 |
124 | |
5cd24f17 |
125 | Perl versions before 5.004 misinterpreted any type marker followed by |
126 | "$" and a digit. For example, "$$0" was incorrectly taken to mean |
127 | "${$}0" instead of "${$0}". This bug is (mostly) fixed in Perl 5.004. |
128 | |
129 | However, the developers of Perl 5.004 could not fix this bug completely, |
130 | because at least two widely-used modules depend on the old meaning of |
131 | "$$0" in a string. So Perl 5.004 still interprets "$$<digit>" in the |
132 | old (broken) way inside strings; but it generates this message as a |
133 | warning. And in Perl 5.005, this special treatment will cease. |
aa689395 |
134 | |
54310121 |
135 | =head2 No resetting of $. on implicit close |
68dc0745 |
136 | |
137 | The documentation for Perl 5.0 has always stated that C<$.> is I<not> |
54310121 |
138 | reset when an already-open file handle is reopened with no intervening |
139 | call to C<close>. Due to a bug, perl versions 5.000 through 5.003 |
68dc0745 |
140 | I<did> reset C<$.> under that circumstance; Perl 5.004 does not. |
141 | |
54310121 |
142 | =head2 C<wantarray> may return undef |
143 | |
144 | The C<wantarray> operator returns true if a subroutine is expected to |
145 | return a list, and false otherwise. In Perl 5.004, C<wantarray> can |
146 | also return the undefined value if a subroutine's return value will |
147 | not be used at all, which allows subroutines to avoid a time-consuming |
148 | calculation of a return value if it isn't going to be used. |
149 | |
150 | =head2 Changes to tainting checks |
5f05dabc |
151 | |
9607fc9c |
152 | A bug in previous versions may have failed to detect some insecure |
8cc95fdb |
153 | conditions when taint checks are turned on. (Taint checks are used |
9607fc9c |
154 | in setuid or setgid scripts, or when explicitly turned on with the |
8cc95fdb |
155 | C<-T> invocation option.) Although it's unlikely, this may cause a |
9607fc9c |
156 | previously-working script to now fail -- which should be construed |
157 | as a blessing, since that indicates a potentially-serious security |
158 | hole was just plugged. |
159 | |
54310121 |
160 | =head2 New Opcode module and revised Safe module |
2ae324a7 |
161 | |
162 | A new Opcode module supports the creation, manipulation and |
163 | application of opcode masks. The revised Safe module has a new API |
164 | and is implemented using the new Opcode module. Please read the new |
165 | Opcode and Safe documentation. |
166 | |
54310121 |
167 | =head2 Embedding improvements |
68dc0745 |
168 | |
169 | In older versions of Perl it was not possible to create more than one |
170 | Perl interpreter instance inside a single process without leaking like a |
171 | sieve and/or crashing. The bugs that caused this behavior have all been |
172 | fixed. However, you still must take care when embedding Perl in a C |
173 | program. See the updated perlembed manpage for tips on how to manage |
174 | your interpreters. |
175 | |
54310121 |
176 | =head2 Internal change: FileHandle class based on IO::* classes |
9607fc9c |
177 | |
178 | File handles are now stored internally as type IO::Handle. The |
179 | FileHandle module is still supported for backwards compatibility, but |
180 | it is now merely a front end to the IO::* modules -- specifically, |
181 | IO::Handle, IO::Seekable, and IO::File. We suggest, but do not |
182 | require, that you use the IO::* modules in new code. |
183 | |
184 | In harmony with this change, C<*GLOB{FILEHANDLE}> is now a |
185 | backward-compatible synonym for C<*STDOUT{IO}>. |
5f05dabc |
186 | |
54310121 |
187 | =head2 Internal change: PerlIO abstraction interface |
5f05dabc |
188 | |
189 | It is now possible to build Perl with AT&T's sfio IO package |
190 | instead of stdio. See L<perlapio> for more details, and |
191 | the F<INSTALL> file for how to use it. |
192 | |
6da72b64 |
193 | =head2 New and changed syntax |
194 | |
195 | =over |
196 | |
197 | =item $coderef->(PARAMS) |
198 | |
199 | A subroutine reference may now be suffixed with an arrow and a |
200 | (possibly empty) parameter list. This syntax denotes a call of the |
201 | referenced subroutine, with the given parameters (if any). |
202 | |
203 | This new syntax follows the pattern of C<$hashref-E<gt>{FOO}> and |
204 | C<$aryref-E<gt>[$foo]>; now, C<&$subref($foo)> may now be written |
205 | C<$subref-E<gt>($foo)>. All of these arrow terms may be chained; |
206 | thus, C<&{$table-E<gt>{FOO}}($bar)> may now be written |
207 | C<$table-E<gt>{FOO}->($bar)>. |
208 | |
209 | =back |
210 | |
dd2afc7e |
211 | =head2 New and changed builtin constants |
212 | |
213 | =over |
214 | |
215 | =item __PACKAGE__ |
216 | |
217 | The current package name at compile time, or the undefined value if |
218 | there is no current package (due to a C<package;> directive). Like |
219 | C<__FILE__> and C<__LINE__>, C<__PACKAGE__> does I<not> interpolate |
220 | into strings. |
221 | |
222 | =back |
223 | |
54310121 |
224 | =head2 New and changed builtin variables |
5f05dabc |
225 | |
226 | =over |
227 | |
228 | =item $^E |
229 | |
f86702cc |
230 | Extended error message on some platforms. (Also known as |
231 | $EXTENDED_OS_ERROR if you C<use English>). |
5f05dabc |
232 | |
233 | =item $^H |
234 | |
235 | The current set of syntax checks enabled by C<use strict>. See the |
236 | documentation of C<strict> for more details. Not actually new, but |
237 | newly documented. |
238 | Because it is intended for internal use by Perl core components, |
239 | there is no C<use English> long name for this variable. |
240 | |
241 | =item $^M |
242 | |
243 | By default, running out of memory it is not trappable. However, if |
244 | compiled for this, Perl may use the contents of C<$^M> as an emergency |
245 | pool after die()ing with this message. Suppose that your Perl were |
246 | compiled with -DEMERGENCY_SBRK and used Perl's malloc. Then |
247 | |
248 | $^M = 'a' x (1<<16); |
249 | |
774d564b |
250 | would allocate a 64K buffer for use when in emergency. |
5f05dabc |
251 | See the F<INSTALL> file for information on how to enable this option. |
252 | As a disincentive to casual use of this advanced feature, |
253 | there is no C<use English> long name for this variable. |
254 | |
255 | =back |
256 | |
54310121 |
257 | =head2 New and changed builtin functions |
5f05dabc |
258 | |
259 | =over |
260 | |
261 | =item delete on slices |
262 | |
263 | This now works. (e.g. C<delete @ENV{'PATH', 'MANPATH'}>) |
264 | |
265 | =item flock |
266 | |
68dc0745 |
267 | is now supported on more platforms, prefers fcntl to lockf when |
268 | emulating, and always flushes before (un)locking. |
5f05dabc |
269 | |
046ff0ed |
270 | =item printf and sprintf |
271 | |
74a77017 |
272 | Perl now implements these functions itself; it doesn't use the C |
273 | library function sprintf() any more, except for floating-point |
274 | numbers, and even then only known flags are allowed. As a result, it |
275 | is now possible to know which conversions and flags will work, and |
276 | what they will do. |
277 | |
278 | The new conversions in Perl's sprintf() are: |
279 | |
280 | %i a synonym for %d |
281 | %p a pointer (the address of the Perl value, in hexadecimal) |
282 | %n special: B<stores> into the next variable in the parameter |
283 | list the number of characters printed so far |
284 | |
285 | The new flags that go between the C<%> and the conversion are: |
286 | |
287 | # prefix octal with "0", hex with "0x" |
288 | h interpret integer as C type "short" or "unsigned short" |
289 | V interpret integer as Perl's standard integer type |
290 | |
291 | Also, where a number would appear in the flags, an asterisk ("*") may |
292 | be used instead, in which case Perl uses the next item in the |
293 | parameter list as the given number (that is, as the field width or |
294 | precision). If a field width obtained through "*" is negative, it has |
295 | the same effect as the '-' flag: left-justification. |
296 | |
297 | See L<perlfunc/sprintf> for a complete list of conversion and flags. |
046ff0ed |
298 | |
5f05dabc |
299 | =item keys as an lvalue |
300 | |
301 | As an lvalue, C<keys> allows you to increase the number of hash buckets |
aa689395 |
302 | allocated for the given hash. This can gain you a measure of efficiency if |
303 | you know the hash is going to get big. (This is similar to pre-extending |
304 | an array by assigning a larger number to $#array.) If you say |
5f05dabc |
305 | |
306 | keys %hash = 200; |
307 | |
308 | then C<%hash> will have at least 200 buckets allocated for it. These |
309 | buckets will be retained even if you do C<%hash = ()>; use C<undef |
310 | %hash> if you want to free the storage while C<%hash> is still in scope. |
311 | You can't shrink the number of buckets allocated for the hash using |
312 | C<keys> in this way (but you needn't worry about doing this by accident, |
313 | as trying has no effect). |
314 | |
315 | =item my() in Control Structures |
316 | |
317 | You can now use my() (with or without the parentheses) in the control |
318 | expressions of control structures such as: |
319 | |
aa689395 |
320 | while (defined(my $line = <>)) { |
5f05dabc |
321 | $line = lc $line; |
322 | } continue { |
323 | print $line; |
324 | } |
325 | |
774d564b |
326 | if ((my $answer = <STDIN>) =~ /^y(es)?$/i) { |
5f05dabc |
327 | user_agrees(); |
774d564b |
328 | } elsif ($answer =~ /^n(o)?$/i) { |
5f05dabc |
329 | user_disagrees(); |
330 | } else { |
331 | chomp $answer; |
774d564b |
332 | die "`$answer' is neither `yes' nor `no'"; |
5f05dabc |
333 | } |
334 | |
335 | Also, you can declare a foreach loop control variable as lexical by |
336 | preceding it with the word "my". For example, in: |
337 | |
338 | foreach my $i (1, 2, 3) { |
339 | some_function(); |
340 | } |
341 | |
342 | $i is a lexical variable, and the scope of $i extends to the end of |
343 | the loop, but not beyond it. |
344 | |
345 | Note that you still cannot use my() on global punctuation variables |
346 | such as $_ and the like. |
347 | |
137443ea |
348 | =item pack() and unpack() |
5f05dabc |
349 | |
350 | A new format 'w' represents a BER compressed integer (as defined in |
351 | ASN.1). Its format is a sequence of one or more bytes, each of which |
352 | provides seven bits of the total value, with the most significant |
353 | first. Bit eight of each byte is set, except for the last byte, in |
354 | which bit eight is clear. |
355 | |
8903cb82 |
356 | Both pack() and unpack() now fail when their templates contain invalid |
357 | types. (Invalid types used to be ignored.) |
137443ea |
358 | |
8903cb82 |
359 | =item sysseek() |
360 | |
361 | The new sysseek() operator is a variant of seek() that sets and gets the |
362 | file's system read/write position, using the lseek(2) system call. It is |
363 | the only reliable way to seek before using sysread() or syswrite(). Its |
364 | return value is the new position, or the undefined value on failure. |
137443ea |
365 | |
5f05dabc |
366 | =item use VERSION |
367 | |
368 | If the first argument to C<use> is a number, it is treated as a version |
369 | number instead of a module name. If the version of the Perl interpreter |
370 | is less than VERSION, then an error message is printed and Perl exits |
774d564b |
371 | immediately. Because C<use> occurs at compile time, this check happens |
372 | immediately during the compilation process, unlike C<require VERSION>, |
54310121 |
373 | which waits until runtime for the check. This is often useful if you |
774d564b |
374 | need to check the current Perl version before C<use>ing library modules |
375 | which have changed in incompatible ways from older versions of Perl. |
376 | (We try not to do this more than we have to.) |
5f05dabc |
377 | |
378 | =item use Module VERSION LIST |
379 | |
380 | If the VERSION argument is present between Module and LIST, then the |
71be2cbc |
381 | C<use> will call the VERSION method in class Module with the given |
382 | version as an argument. The default VERSION method, inherited from |
dc848c6f |
383 | the UNIVERSAL class, croaks if the given version is larger than the |
71be2cbc |
384 | value of the variable $Module::VERSION. (Note that there is not a |
385 | comma after VERSION!) |
5f05dabc |
386 | |
7cfe7857 |
387 | This version-checking mechanism is similar to the one currently used |
388 | in the Exporter module, but it is faster and can be used with modules |
389 | that don't use the Exporter. It is the recommended method for new |
390 | code. |
391 | |
5f05dabc |
392 | =item prototype(FUNCTION) |
393 | |
394 | Returns the prototype of a function as a string (or C<undef> if the |
395 | function has no prototype). FUNCTION is a reference to or the name of the |
396 | function whose prototype you want to retrieve. |
397 | (Not actually new; just never documented before.) |
398 | |
9607fc9c |
399 | =item srand |
400 | |
401 | The default seed for C<srand>, which used to be C<time>, has been changed. |
402 | Now it's a heady mix of difficult-to-predict system-dependent values, |
403 | which should be sufficient for most everyday purposes. |
404 | |
405 | Previous to version 5.004, calling C<rand> without first calling C<srand> |
406 | would yield the same sequence of random numbers on most or all machines. |
407 | Now, when perl sees that you're calling C<rand> and haven't yet called |
408 | C<srand>, it calls C<srand> with the default seed. You should still call |
409 | C<srand> manually if your code might ever be run on a pre-5.004 system, |
2ae324a7 |
410 | of course, or if you want a seed other than the default. |
9607fc9c |
411 | |
5f05dabc |
412 | =item $_ as Default |
413 | |
414 | Functions documented in the Camel to default to $_ now in |
415 | fact do, and all those that do are so documented in L<perlfunc>. |
416 | |
a99df21c |
417 | =item C<m//g> does not reset search position on failure |
418 | |
419 | The C<m//g> match iteration construct used to reset its target string's |
420 | search position (which is visible through the C<pos> operator) when a |
421 | match failed; as a result, the next C<m//g> match would start at the |
422 | beginning of the string). With Perl 5.004, the search position must be |
423 | reset explicitly, as with C<pos $str = 0;>, or by modifying the target |
424 | string. This change in Perl makes it possible to chain matches together |
425 | in conjunction with the C<\G> zero-width assertion. See L<perlop> and |
426 | L<perlre>. |
427 | |
428 | Here is an illustration of what it takes to get the old behavior: |
429 | |
430 | for ( qw(this and that are not what you think you got) ) { |
431 | while ( /(\w*t\w*)/g ) { print "t word is: $1\n" } |
432 | pos = 0; # REQUIRED FOR 5.004 |
433 | while ( /(\w*a\w*)/g ) { print "a word is: $1\n" } |
434 | print "\n"; |
435 | } |
44a8e56a |
436 | |
3fe9a6f1 |
437 | =item C<m//x> ignores whitespace before ?*+{} |
438 | |
439 | The C<m//x> construct has always been intended to ignore all unescaped |
440 | whitespace. However, before Perl 5.004, whitespace had the effect of |
54310121 |
441 | escaping repeat modifiers like "*" or "?"; for example, C</a *b/x> was |
3fe9a6f1 |
442 | (mis)interpreted as C</a\*b/x>. This bug has been fixed in 5.004. |
443 | |
774d564b |
444 | =item nested C<sub{}> closures work now |
445 | |
2ae324a7 |
446 | Prior to the 5.004 release, nested anonymous functions didn't work |
447 | right. They do now. |
774d564b |
448 | |
449 | =item formats work right on changing lexicals |
450 | |
451 | Just like anonymous functions that contain lexical variables |
452 | that change (like a lexical index variable for a C<foreach> loop), |
453 | formats now work properly. For example, this silently failed |
454 | before, and is fine now: |
455 | |
456 | my $i; |
457 | foreach $i ( 1 .. 10 ) { |
458 | format = |
459 | my i is @# |
460 | $i |
461 | . |
462 | write; |
2ae324a7 |
463 | } |
774d564b |
464 | |
5f05dabc |
465 | =back |
466 | |
54310121 |
467 | =head2 New builtin methods |
5f05dabc |
468 | |
469 | The C<UNIVERSAL> package automatically contains the following methods that |
470 | are inherited by all other classes: |
471 | |
0a753a76 |
472 | =over |
5f05dabc |
473 | |
474 | =item isa(CLASS) |
475 | |
68dc0745 |
476 | C<isa> returns I<true> if its object is blessed into a subclass of C<CLASS> |
5f05dabc |
477 | |
478 | C<isa> is also exportable and can be called as a sub with two arguments. This |
479 | allows the ability to check what a reference points to. Example: |
480 | |
481 | use UNIVERSAL qw(isa); |
482 | |
483 | if(isa($ref, 'ARRAY')) { |
484 | ... |
485 | } |
486 | |
487 | =item can(METHOD) |
488 | |
489 | C<can> checks to see if its object has a method called C<METHOD>, |
490 | if it does then a reference to the sub is returned; if it does not then |
491 | I<undef> is returned. |
492 | |
493 | =item VERSION( [NEED] ) |
494 | |
71be2cbc |
495 | C<VERSION> returns the version number of the class (package). If the |
496 | NEED argument is given then it will check that the current version (as |
497 | defined by the $VERSION variable in the given package) not less than |
498 | NEED; it will die if this is not the case. This method is normally |
499 | called as a class method. This method is called automatically by the |
500 | C<VERSION> form of C<use>. |
5f05dabc |
501 | |
502 | use A 1.2 qw(some imported subs); |
71be2cbc |
503 | # implies: |
504 | A->VERSION(1.2); |
5f05dabc |
505 | |
5f05dabc |
506 | =back |
507 | |
508 | B<NOTE:> C<can> directly uses Perl's internal code for method lookup, and |
774d564b |
509 | C<isa> uses a very similar method and caching strategy. This may cause |
5f05dabc |
510 | strange effects if the Perl code dynamically changes @ISA in any package. |
511 | |
512 | You may add other methods to the UNIVERSAL class via Perl or XS code. |
513 | You do not need to C<use UNIVERSAL> in order to make these methods |
514 | available to your program. This is necessary only if you wish to |
515 | have C<isa> available as a plain subroutine in the current package. |
516 | |
54310121 |
517 | =head2 TIEHANDLE now supported |
5f05dabc |
518 | |
774d564b |
519 | See L<perltie> for other kinds of tie()s. |
520 | |
5f05dabc |
521 | =over |
522 | |
523 | =item TIEHANDLE classname, LIST |
524 | |
525 | This is the constructor for the class. That means it is expected to |
526 | return an object of some sort. The reference can be used to |
527 | hold some internal information. |
528 | |
2ae324a7 |
529 | sub TIEHANDLE { |
530 | print "<shout>\n"; |
531 | my $i; |
774d564b |
532 | return bless \$i, shift; |
533 | } |
5f05dabc |
534 | |
535 | =item PRINT this, LIST |
536 | |
537 | This method will be triggered every time the tied handle is printed to. |
538 | Beyond its self reference it also expects the list that was passed to |
539 | the print function. |
540 | |
2ae324a7 |
541 | sub PRINT { |
542 | $r = shift; |
543 | $$r++; |
774d564b |
544 | return print join( $, => map {uc} @_), $\; |
545 | } |
5f05dabc |
546 | |
46fc3d4c |
547 | =item PRINTF this, LIST |
548 | |
549 | This method will be triggered every time the tied handle is printed to |
550 | with the C<printf()> function. |
551 | Beyond its self reference it also expects the format and list that was |
552 | passed to the printf function. |
553 | |
554 | sub PRINTF { |
555 | shift; |
556 | my $fmt = shift; |
557 | print sprintf($fmt, @_)."\n"; |
558 | } |
559 | |
2ae324a7 |
560 | =item READ this LIST |
561 | |
562 | This method will be called when the handle is read from via the C<read> |
563 | or C<sysread> functions. |
564 | |
565 | sub READ { |
566 | $r = shift; |
567 | my($buf,$len,$offset) = @_; |
568 | print "READ called, \$buf=$buf, \$len=$len, \$offset=$offset"; |
569 | } |
570 | |
5f05dabc |
571 | =item READLINE this |
572 | |
573 | This method will be called when the handle is read from. The method |
574 | should return undef when there is no more data. |
575 | |
2ae324a7 |
576 | sub READLINE { |
577 | $r = shift; |
578 | return "PRINT called $$r times\n" |
774d564b |
579 | } |
5f05dabc |
580 | |
2ae324a7 |
581 | =item GETC this |
582 | |
583 | This method will be called when the C<getc> function is called. |
584 | |
585 | sub GETC { print "Don't GETC, Get Perl"; return "a"; } |
586 | |
5f05dabc |
587 | =item DESTROY this |
588 | |
589 | As with the other types of ties, this method will be called when the |
590 | tied handle is about to be destroyed. This is useful for debugging and |
591 | possibly for cleaning up. |
592 | |
2ae324a7 |
593 | sub DESTROY { |
774d564b |
594 | print "</shout>\n"; |
595 | } |
5f05dabc |
596 | |
597 | =back |
598 | |
54310121 |
599 | =head2 Malloc enhancements |
aa689395 |
600 | |
2ae324a7 |
601 | Four new compilation flags are recognized by malloc.c. (They have no |
602 | effect if perl is compiled with system malloc().) |
603 | |
604 | =over |
605 | |
606 | =item -DDEBUGGING_MSTATS |
607 | |
608 | If perl is compiled with C<DEBUGGING_MSTATS> defined, you can print |
609 | memory statistics at runtime by running Perl thusly: |
aa689395 |
610 | |
611 | env PERL_DEBUG_MSTATS=2 perl your_script_here |
612 | |
613 | The value of 2 means to print statistics after compilation and on |
614 | exit; with a value of 1, the statistics ares printed only on exit. |
615 | (If you want the statistics at an arbitrary time, you'll need to |
616 | install the optional module Devel::Peek.) |
617 | |
aa689395 |
618 | =item -DEMERGENCY_SBRK |
619 | |
620 | If this macro is defined, running out of memory need not be a fatal |
621 | error: a memory pool can allocated by assigning to the special |
622 | variable C<$^M>. See L<"$^M">. |
774d564b |
623 | |
aa689395 |
624 | =item -DPACK_MALLOC |
625 | |
626 | Perl memory allocation is by bucket with sizes close to powers of two. |
627 | Because of these malloc overhead may be big, especially for data of |
628 | size exactly a power of two. If C<PACK_MALLOC> is defined, perl uses |
629 | a slightly different algorithm for small allocations (up to 64 bytes |
630 | long), which makes it possible to have overhead down to 1 byte for |
631 | allocations which are powers of two (and appear quite often). |
632 | |
633 | Expected memory savings (with 8-byte alignment in C<alignbytes>) is |
634 | about 20% for typical Perl usage. Expected slowdown due to additional |
635 | malloc overhead is in fractions of a percent (hard to measure, because |
636 | of the effect of saved memory on speed). |
637 | |
638 | =item -DTWO_POT_OPTIMIZE |
639 | |
640 | Similarly to C<PACK_MALLOC>, this macro improves allocations of data |
641 | with size close to a power of two; but this works for big allocations |
642 | (starting with 16K by default). Such allocations are typical for big |
643 | hashes and special-purpose scripts, especially image processing. |
644 | |
645 | On recent systems, the fact that perl requires 2M from system for 1M |
646 | allocation will not affect speed of execution, since the tail of such |
647 | a chunk is not going to be touched (and thus will not require real |
648 | memory). However, it may result in a premature out-of-memory error. |
649 | So if you will be manipulating very large blocks with sizes close to |
650 | powers of two, it would be wise to define this macro. |
651 | |
652 | Expected saving of memory is 0-100% (100% in applications which |
653 | require most memory in such 2**n chunks); expected slowdown is |
654 | negligible. |
655 | |
656 | =back |
657 | |
54310121 |
658 | =head2 Miscellaneous efficiency enhancements |
774d564b |
659 | |
660 | Functions that have an empty prototype and that do nothing but return |
661 | a fixed value are now inlined (e.g. C<sub PI () { 3.14159 }>). |
662 | |
aa689395 |
663 | Each unique hash key is only allocated once, no matter how many hashes |
664 | have an entry with that key. So even if you have 100 copies of the |
68dc0745 |
665 | same hash, the hash keys never have to be reallocated. |
aa689395 |
666 | |
5f05dabc |
667 | =head1 Pragmata |
668 | |
54310121 |
669 | Six new pragmatic modules exist: |
5f05dabc |
670 | |
671 | =over |
672 | |
54310121 |
673 | =item use autouse MODULE => qw(sub1 sub2 sub3) |
674 | |
675 | Defers C<require MODULE> until someone calls one of the specified |
676 | subroutines (which must be exported by MODULE). This pragma should be |
677 | used with caution, and only when necessary. |
678 | |
5f05dabc |
679 | =item use blib |
680 | |
774d564b |
681 | =item use blib 'dir' |
682 | |
5f05dabc |
683 | Looks for MakeMaker-like I<'blib'> directory structure starting in |
684 | I<dir> (or current directory) and working back up to five levels of |
685 | parent directories. |
686 | |
687 | Intended for use on command line with B<-M> option as a way of testing |
688 | arbitrary scripts against an uninstalled version of a package. |
689 | |
54310121 |
690 | =item use constant NAME => VALUE |
691 | |
692 | Provides a convenient interface for creating compile-time constants, |
693 | See L<perlsub/"Constant Functions">. |
694 | |
5f05dabc |
695 | =item use locale |
696 | |
697 | Tells the compiler to enable (or disable) the use of POSIX locales for |
54310121 |
698 | builtin operations. |
5f05dabc |
699 | |
700 | When C<use locale> is in effect, the current LC_CTYPE locale is used |
701 | for regular expressions and case mapping; LC_COLLATE for string |
702 | ordering; and LC_NUMERIC for numeric formating in printf and sprintf |
703 | (but B<not> in print). LC_NUMERIC is always used in write, since |
704 | lexical scoping of formats is problematic at best. |
705 | |
706 | Each C<use locale> or C<no locale> affects statements to the end of |
707 | the enclosing BLOCK or, if not inside a BLOCK, to the end of the |
708 | current file. Locales can be switched and queried with |
709 | POSIX::setlocale(). |
710 | |
711 | See L<perllocale> for more information. |
712 | |
713 | =item use ops |
714 | |
7cfe7857 |
715 | Disable unsafe opcodes, or any named opcodes, when compiling Perl code. |
5f05dabc |
716 | |
ff0cee69 |
717 | =item use vmsish |
718 | |
719 | Enable VMS-specific language features. Currently, there are three |
aa689395 |
720 | VMS-specific features available: 'status', which makes C<$?> and |
ff0cee69 |
721 | C<system> return genuine VMS status values instead of emulating POSIX; |
722 | 'exit', which makes C<exit> take a genuine VMS status value instead of |
723 | assuming that C<exit 1> is an error; and 'time', which makes all times |
724 | relative to the local time zone, in the VMS tradition. |
725 | |
5f05dabc |
726 | =back |
727 | |
728 | =head1 Modules |
729 | |
5cd24f17 |
730 | =head2 Required Updates |
731 | |
732 | Though Perl 5.004 is compatible with almost all modules that work |
733 | with Perl 5.003, there are a few exceptions: |
734 | |
735 | Module Required Version for Perl 5.004 |
736 | ------ ------------------------------- |
137443ea |
737 | Filter Filter-1.12 |
738 | LWP libwww-perl-5.08 |
5cd24f17 |
739 | Tk Tk400.202 (-w makes noise) |
740 | |
137443ea |
741 | Also, the majordomo mailing list program, version 1.94.1, doesn't work |
742 | with Perl 5.004 (nor with perl 4), because it executes an invalid |
743 | regular expression. This bug is fixed in majordomo version 1.94.2. |
744 | |
54310121 |
745 | =head2 Installation directories |
f86702cc |
746 | |
747 | The I<installperl> script now places the Perl source files for |
748 | extensions in the architecture-specific library directory, which is |
749 | where the shared libraries for extensions have always been. This |
750 | change is intended to allow administrators to keep the Perl 5.004 |
751 | library directory unchanged from a previous version, without running |
752 | the risk of binary incompatibility between extensions' Perl source and |
753 | shared libraries. |
754 | |
54310121 |
755 | =head2 Module information summary |
5f05dabc |
756 | |
774d564b |
757 | Brand new modules, arranged by topic rather than strictly |
758 | alphabetically: |
759 | |
137443ea |
760 | CGI.pm Web server interface ("Common Gateway Interface") |
761 | CGI/Apache.pm Support for Apache's Perl module |
762 | CGI/Carp.pm Log server errors with helpful context |
763 | CGI/Fast.pm Support for FastCGI (persistent server process) |
764 | CGI/Push.pm Support for server push |
765 | CGI/Switch.pm Simple interface for multiple server types |
766 | |
767 | CPAN Interface to Comprehensive Perl Archive Network |
768 | CPAN::FirstTime Utility for creating CPAN configuration file |
769 | CPAN::Nox Runs CPAN while avoiding compiled extensions |
5f05dabc |
770 | |
771 | IO.pm Top-level interface to IO::* classes |
772 | IO/File.pm IO::File extension Perl module |
773 | IO/Handle.pm IO::Handle extension Perl module |
774 | IO/Pipe.pm IO::Pipe extension Perl module |
775 | IO/Seekable.pm IO::Seekable extension Perl module |
776 | IO/Select.pm IO::Select extension Perl module |
777 | IO/Socket.pm IO::Socket extension Perl module |
778 | |
779 | Opcode.pm Disable named opcodes when compiling Perl code |
780 | |
781 | ExtUtils/Embed.pm Utilities for embedding Perl in C programs |
782 | ExtUtils/testlib.pm Fixes up @INC to use just-built extension |
783 | |
5f05dabc |
784 | FindBin.pm Find path of currently executing program |
785 | |
8cc95fdb |
786 | Class/Struct.pm Declare struct-like datatypes as Perl classes |
46fc3d4c |
787 | File/stat.pm By-name interface to Perl's builtin stat |
788 | Net/hostent.pm By-name interface to Perl's builtin gethost* |
789 | Net/netent.pm By-name interface to Perl's builtin getnet* |
790 | Net/protoent.pm By-name interface to Perl's builtin getproto* |
791 | Net/servent.pm By-name interface to Perl's builtin getserv* |
792 | Time/gmtime.pm By-name interface to Perl's builtin gmtime |
793 | Time/localtime.pm By-name interface to Perl's builtin localtime |
8cc95fdb |
794 | Time/tm.pm Internal object for Time::{gm,local}time |
46fc3d4c |
795 | User/grent.pm By-name interface to Perl's builtin getgr* |
796 | User/pwent.pm By-name interface to Perl's builtin getpw* |
5f05dabc |
797 | |
774d564b |
798 | Tie/RefHash.pm Base class for tied hashes with references as keys |
7a4c00b4 |
799 | |
5f05dabc |
800 | UNIVERSAL.pm Base class for *ALL* classes |
801 | |
54310121 |
802 | =head2 Fcntl |
803 | |
804 | New constants in the existing Fcntl modules are now supported, |
805 | provided that your operating system happens to support them: |
806 | |
807 | F_GETOWN F_SETOWN |
808 | O_ASYNC O_DEFER O_DSYNC O_FSYNC O_SYNC |
809 | O_EXLOCK O_SHLOCK |
810 | |
811 | These constants are intended for use with the Perl operators sysopen() |
812 | and fcntl() and the basic database modules like SDBM_File. For the |
813 | exact meaning of these and other Fcntl constants please refer to your |
814 | operating system's documentation for fcntl() and open(). |
815 | |
816 | In addition, the Fcntl module now provides these constants for use |
817 | with the Perl operator flock(): |
818 | |
819 | LOCK_SH LOCK_EX LOCK_NB LOCK_UN |
820 | |
821 | These constants are defined in all environments (because where there is |
822 | no flock() system call, Perl emulates it). However, for historical |
823 | reasons, these constants are not exported unless they are explicitly |
824 | requested with the ":flock" tag (e.g. C<use Fcntl ':flock'>). |
825 | |
5f05dabc |
826 | =head2 IO |
827 | |
828 | The IO module provides a simple mechanism to load all of the IO modules at one |
829 | go. Currently this includes: |
830 | |
831 | IO::Handle |
832 | IO::Seekable |
833 | IO::File |
834 | IO::Pipe |
835 | IO::Socket |
836 | |
837 | For more information on any of these modules, please see its |
838 | respective documentation. |
839 | |
840 | =head2 Math::Complex |
841 | |
842 | The Math::Complex module has been totally rewritten, and now supports |
843 | more operations. These are overloaded: |
844 | |
845 | + - * / ** <=> neg ~ abs sqrt exp log sin cos atan2 "" (stringify) |
846 | |
847 | And these functions are now exported: |
848 | |
849 | pi i Re Im arg |
5cd24f17 |
850 | log10 logn ln cbrt root |
851 | tan |
852 | csc sec cot |
853 | asin acos atan |
854 | acsc asec acot |
855 | sinh cosh tanh |
856 | csch sech coth |
857 | asinh acosh atanh |
858 | acsch asech acoth |
5f05dabc |
859 | cplx cplxe |
860 | |
5aabfad6 |
861 | =head2 Math::Trig |
862 | |
5cd24f17 |
863 | This new module provides a simpler interface to parts of Math::Complex for |
5aabfad6 |
864 | those who need trigonometric functions only for real numbers. |
865 | |
0a753a76 |
866 | =head2 DB_File |
867 | |
868 | There have been quite a few changes made to DB_File. Here are a few of |
869 | the highlights: |
870 | |
871 | =over |
872 | |
873 | =item * |
874 | |
875 | Fixed a handful of bugs. |
876 | |
877 | =item * |
878 | |
879 | By public demand, added support for the standard hash function exists(). |
880 | |
881 | =item * |
882 | |
883 | Made it compatible with Berkeley DB 1.86. |
884 | |
885 | =item * |
886 | |
887 | Made negative subscripts work with RECNO interface. |
888 | |
889 | =item * |
890 | |
891 | Changed the default flags from O_RDWR to O_CREAT|O_RDWR and the default |
892 | mode from 0640 to 0666. |
893 | |
894 | =item * |
895 | |
896 | Made DB_File automatically import the open() constants (O_RDWR, |
897 | O_CREAT etc.) from Fcntl, if available. |
898 | |
899 | =item * |
900 | |
901 | Updated documentation. |
902 | |
903 | =back |
904 | |
905 | Refer to the HISTORY section in DB_File.pm for a complete list of |
906 | changes. Everything after DB_File 1.01 has been added since 5.003. |
907 | |
908 | =head2 Net::Ping |
909 | |
910 | Major rewrite - support added for both udp echo and real icmp pings. |
911 | |
54310121 |
912 | =head2 Object-oriented overrides for builtin operators |
5f05dabc |
913 | |
54310121 |
914 | Many of the Perl builtins returning lists now have |
5f05dabc |
915 | object-oriented overrides. These are: |
916 | |
917 | File::stat |
918 | Net::hostent |
919 | Net::netent |
920 | Net::protoent |
921 | Net::servent |
922 | Time::gmtime |
923 | Time::localtime |
924 | User::grent |
925 | User::pwent |
926 | |
927 | For example, you can now say |
928 | |
929 | use File::stat; |
930 | use User::pwent; |
931 | $his = (stat($filename)->st_uid == pwent($whoever)->pw_uid); |
932 | |
774d564b |
933 | =head1 Utility Changes |
5f05dabc |
934 | |
774d564b |
935 | =head2 xsubpp |
5f05dabc |
936 | |
0a753a76 |
937 | =over |
938 | |
774d564b |
939 | =item C<void> XSUBs now default to returning nothing |
940 | |
941 | Due to a documentation/implementation bug in previous versions of |
942 | Perl, XSUBs with a return type of C<void> have actually been |
943 | returning one value. Usually that value was the GV for the XSUB, |
944 | but sometimes it was some already freed or reused value, which would |
945 | sometimes lead to program failure. |
946 | |
947 | In Perl 5.004, if an XSUB is declared as returning C<void>, it |
948 | actually returns no value, i.e. an empty list (though there is a |
949 | backward-compatibility exception; see below). If your XSUB really |
950 | does return an SV, you should give it a return type of C<SV *>. |
951 | |
952 | For backward compatibility, I<xsubpp> tries to guess whether a |
953 | C<void> XSUB is really C<void> or if it wants to return an C<SV *>. |
954 | It does so by examining the text of the XSUB: if I<xsubpp> finds |
955 | what looks like an assignment to C<ST(0)>, it assumes that the |
956 | XSUB's return type is really C<SV *>. |
5f05dabc |
957 | |
0a753a76 |
958 | =back |
959 | |
960 | =head1 C Language API Changes |
961 | |
962 | =over |
963 | |
964 | =item C<gv_fetchmethod> and C<perl_call_sv> |
965 | |
966 | The C<gv_fetchmethod> function finds a method for an object, just like |
967 | in Perl 5.003. The GV it returns may be a method cache entry. |
968 | However, in Perl 5.004, method cache entries are not visible to users; |
969 | therefore, they can no longer be passed directly to C<perl_call_sv>. |
970 | Instead, you should use the C<GvCV> macro on the GV to extract its CV, |
971 | and pass the CV to C<perl_call_sv>. |
972 | |
973 | The most likely symptom of passing the result of C<gv_fetchmethod> to |
974 | C<perl_call_sv> is Perl's producing an "Undefined subroutine called" |
975 | error on the I<second> call to a given method (since there is no cache |
976 | on the first call). |
977 | |
137443ea |
978 | =item C<perl_eval_pv> |
979 | |
8903cb82 |
980 | A new function handy for eval'ing strings of Perl code inside C code. |
137443ea |
981 | This function returns the value from the eval statement, which can |
982 | be used instead of fetching globals from the symbol table. See |
983 | L<perlguts>, L<perlembed> and L<perlcall> for details and examples. |
984 | |
1e422769 |
985 | =item Extended API for manipulating hashes |
986 | |
987 | Internal handling of hash keys has changed. The old hashtable API is |
988 | still fully supported, and will likely remain so. The additions to the |
989 | API allow passing keys as C<SV*>s, so that C<tied> hashes can be given |
54310121 |
990 | real scalars as keys rather than plain strings (nontied hashes still |
1e422769 |
991 | can only use strings as keys). New extensions must use the new hash |
992 | access functions and macros if they wish to use C<SV*> keys. These |
993 | additions also make it feasible to manipulate C<HE*>s (hash entries), |
994 | which can be more efficient. See L<perlguts> for details. |
995 | |
0a753a76 |
996 | =back |
997 | |
5f05dabc |
998 | =head1 Documentation Changes |
999 | |
1000 | Many of the base and library pods were updated. These |
1001 | new pods are included in section 1: |
1002 | |
0a753a76 |
1003 | =over |
5f05dabc |
1004 | |
774d564b |
1005 | =item L<perldelta> |
5f05dabc |
1006 | |
71be2cbc |
1007 | This document. |
5f05dabc |
1008 | |
71be2cbc |
1009 | =item L<perllocale> |
5f05dabc |
1010 | |
71be2cbc |
1011 | Locale support (internationalization and localization). |
5f05dabc |
1012 | |
1013 | =item L<perltoot> |
1014 | |
1015 | Tutorial on Perl OO programming. |
1016 | |
71be2cbc |
1017 | =item L<perlapio> |
1018 | |
1019 | Perl internal IO abstraction interface. |
1020 | |
5f05dabc |
1021 | =item L<perldebug> |
1022 | |
1023 | Although not new, this has been massively updated. |
1024 | |
1025 | =item L<perlsec> |
1026 | |
1027 | Although not new, this has been massively updated. |
1028 | |
1029 | =back |
1030 | |
1031 | =head1 New Diagnostics |
1032 | |
1033 | Several new conditions will trigger warnings that were |
1034 | silent before. Some only affect certain platforms. |
2ae324a7 |
1035 | The following new warnings and errors outline these. |
774d564b |
1036 | These messages are classified as follows (listed in |
1037 | increasing order of desperation): |
1038 | |
1039 | (W) A warning (optional). |
1040 | (D) A deprecation (optional). |
1041 | (S) A severe warning (mandatory). |
1042 | (F) A fatal error (trappable). |
1043 | (P) An internal error you should never see (trappable). |
54310121 |
1044 | (X) A very fatal error (nontrappable). |
774d564b |
1045 | (A) An alien error message (not generated by Perl). |
5f05dabc |
1046 | |
0a753a76 |
1047 | =over |
5f05dabc |
1048 | |
1049 | =item "my" variable %s masks earlier declaration in same scope |
1050 | |
1051 | (S) A lexical variable has been redeclared in the same scope, effectively |
1052 | eliminating all access to the previous instance. This is almost always |
1053 | a typographical error. Note that the earlier variable will still exist |
1054 | until the end of the scope or until all closure referents to it are |
1055 | destroyed. |
1056 | |
774d564b |
1057 | =item %s argument is not a HASH element or slice |
1058 | |
1059 | (F) The argument to delete() must be either a hash element, such as |
1060 | |
1061 | $foo{$bar} |
1062 | $ref->[12]->{"susie"} |
1063 | |
1064 | or a hash slice, such as |
1065 | |
1066 | @foo{$bar, $baz, $xyzzy} |
1067 | @{$ref->[12]}{"susie", "queue"} |
1068 | |
5f05dabc |
1069 | =item Allocation too large: %lx |
1070 | |
54310121 |
1071 | (X) You can't allocate more than 64K on an MS-DOS machine. |
5f05dabc |
1072 | |
1073 | =item Allocation too large |
1074 | |
1075 | (F) You can't allocate more than 2^31+"small amount" bytes. |
1076 | |
54310121 |
1077 | =item Applying %s to %s will act on scalar(%s) |
1078 | |
1079 | (W) The pattern match (//), substitution (s///), and translation (tr///) |
1080 | operators work on scalar values. If you apply one of them to an array |
1081 | or a hash, it will convert the array or hash to a scalar value -- the |
1082 | length of an array, or the population info of a hash -- and then work on |
1083 | that scalar value. This is probably not what you meant to do. See |
1084 | L<perlfunc/grep> and L<perlfunc/map> for alternatives. |
1085 | |
1086 | =item Attempt to free nonexistent shared string |
5f05dabc |
1087 | |
1088 | (P) Perl maintains a reference counted internal table of strings to |
1089 | optimize the storage and access of hash keys and other strings. This |
1090 | indicates someone tried to decrement the reference count of a string |
1091 | that can no longer be found in the table. |
1092 | |
1093 | =item Attempt to use reference as lvalue in substr |
1094 | |
1095 | (W) You supplied a reference as the first argument to substr() used |
1096 | as an lvalue, which is pretty strange. Perhaps you forgot to |
1097 | dereference it first. See L<perlfunc/substr>. |
1098 | |
774d564b |
1099 | =item Can't use bareword ("%s") as %s ref while "strict refs" in use |
1100 | |
1101 | (F) Only hard references are allowed by "strict refs". Symbolic references |
1102 | are disallowed. See L<perlref>. |
1103 | |
54310121 |
1104 | =item Cannot resolve method `%s' overloading `%s' in package `%s' |
1105 | |
1106 | (P) Internal error trying to resolve overloading specified by a method |
1107 | name (as opposed to a subroutine reference). |
1108 | |
774d564b |
1109 | =item Constant subroutine %s redefined |
1110 | |
1111 | (S) You redefined a subroutine which had previously been eligible for |
dc848c6f |
1112 | inlining. See L<perlsub/"Constant Functions"> for commentary and |
54310121 |
1113 | workarounds. |
1114 | |
1115 | =item Constant subroutine %s undefined |
1116 | |
1117 | (S) You undefined a subroutine which had previously been eligible for |
774d564b |
1118 | inlining. See L<perlsub/"Constant Functions"> for commentary and |
1119 | workarounds. |
1120 | |
54310121 |
1121 | =item Copy method did not return a reference |
1122 | |
1123 | (F) The method which overloads "=" is buggy. See L<overload/Copy Constructor>. |
1124 | |
774d564b |
1125 | =item Died |
1126 | |
1127 | (F) You passed die() an empty string (the equivalent of C<die "">) or |
1128 | you called it with no args and both C<$@> and C<$_> were empty. |
1129 | |
54310121 |
1130 | =item Exiting pseudo-block via %s |
1131 | |
1132 | (W) You are exiting a rather special block construct (like a sort block or |
1133 | subroutine) by unconventional means, such as a goto, or a loop control |
1134 | statement. See L<perlfunc/sort>. |
1135 | |
8903cb82 |
1136 | =item Identifier too long |
1137 | |
1138 | (F) Perl limits identifiers (names for variables, functions, etc.) to |
1139 | 252 characters for simple names, somewhat more for compound names (like |
1140 | C<$A::B>). You've exceeded Perl's limits. Future versions of Perl are |
1141 | likely to eliminate these arbitrary limitations. |
1142 | |
54310121 |
1143 | =item Illegal character %s (carriage return) |
1144 | |
1145 | (F) A carriage return character was found in the input. This is an |
1146 | error, and not a warning, because carriage return characters can break |
1147 | multi-line strings, including here documents (e.g., C<print E<lt>E<lt>EOF;>). |
1148 | |
1149 | =item Illegal switch in PERL5OPT: %s |
1150 | |
1151 | (X) The PERL5OPT environment variable may only be used to set the |
1152 | following switches: B<-[DIMUdmw]>. |
1153 | |
5f05dabc |
1154 | =item Integer overflow in hex number |
1155 | |
1156 | (S) The literal hex number you have specified is too big for your |
1157 | architecture. On a 32-bit architecture the largest hex literal is |
1158 | 0xFFFFFFFF. |
1159 | |
1160 | =item Integer overflow in octal number |
1161 | |
1162 | (S) The literal octal number you have specified is too big for your |
1163 | architecture. On a 32-bit architecture the largest octal literal is |
1164 | 037777777777. |
1165 | |
5cd24f17 |
1166 | =item internal error: glob failed |
1167 | |
1168 | (P) Something went wrong with the external program(s) used for C<glob> |
1169 | and C<E<lt>*.cE<gt>>. This may mean that your csh (C shell) is |
1170 | broken. If so, you should change all of the csh-related variables in |
1171 | config.sh: If you have tcsh, make the variables refer to it as if it |
1172 | were csh (e.g. C<full_csh='/usr/bin/tcsh'>); otherwise, make them all |
1173 | empty (except that C<d_csh> should be C<'undef'>) so that Perl will |
1174 | think csh is missing. In either case, after editing config.sh, run |
1175 | C<./Configure -S> and rebuild Perl. |
1176 | |
8903cb82 |
1177 | =item Invalid type in pack: '%s' |
1178 | |
1179 | (F) The given character is not a valid pack type. See L<perlfunc/pack>. |
1180 | |
1181 | =item Invalid type in unpack: '%s' |
1182 | |
1183 | (F) The given character is not a valid unpack type. See L<perlfunc/unpack>. |
1184 | |
774d564b |
1185 | =item Name "%s::%s" used only once: possible typo |
1186 | |
1187 | (W) Typographical errors often show up as unique variable names. |
1188 | If you had a good reason for having a unique name, then just mention |
1189 | it again somehow to suppress the message (the C<use vars> pragma is |
1190 | provided for just this purpose). |
1191 | |
5f05dabc |
1192 | =item Null picture in formline |
1193 | |
1194 | (F) The first argument to formline must be a valid format picture |
1195 | specification. It was found to be empty, which probably means you |
1196 | supplied it an uninitialized value. See L<perlform>. |
1197 | |
1198 | =item Offset outside string |
1199 | |
1200 | (F) You tried to do a read/write/send/recv operation with an offset |
1201 | pointing outside the buffer. This is difficult to imagine. |
1202 | The sole exception to this is that C<sysread()>ing past the buffer |
1203 | will extend the buffer and zero pad the new area. |
1204 | |
1205 | =item Out of memory! |
1206 | |
1207 | (X|F) The malloc() function returned 0, indicating there was insufficient |
1208 | remaining memory (or virtual memory) to satisfy the request. |
1209 | |
1210 | The request was judged to be small, so the possibility to trap it |
1211 | depends on the way Perl was compiled. By default it is not trappable. |
1212 | However, if compiled for this, Perl may use the contents of C<$^M> as |
1213 | an emergency pool after die()ing with this message. In this case the |
1214 | error is trappable I<once>. |
1215 | |
1216 | =item Out of memory during request for %s |
1217 | |
1218 | (F) The malloc() function returned 0, indicating there was insufficient |
1219 | remaining memory (or virtual memory) to satisfy the request. However, |
1220 | the request was judged large enough (compile-time default is 64K), so |
1221 | a possibility to shut down by trapping this error is granted. |
1222 | |
1223 | =item Possible attempt to put comments in qw() list |
1224 | |
774d564b |
1225 | (W) qw() lists contain items separated by whitespace; as with literal |
1226 | strings, comment characters are not ignored, but are instead treated |
1227 | as literal data. (You may have used different delimiters than the |
1228 | exclamation marks parentheses shown here; braces are also frequently |
1229 | used.) |
1230 | |
1231 | You probably wrote something like this: |
5f05dabc |
1232 | |
2ae324a7 |
1233 | @list = qw( |
774d564b |
1234 | a # a comment |
5f05dabc |
1235 | b # another comment |
774d564b |
1236 | ); |
5f05dabc |
1237 | |
1238 | when you should have written this: |
1239 | |
774d564b |
1240 | @list = qw( |
2ae324a7 |
1241 | a |
5f05dabc |
1242 | b |
774d564b |
1243 | ); |
1244 | |
1245 | If you really want comments, build your list the |
1246 | old-fashioned way, with quotes and commas: |
1247 | |
1248 | @list = ( |
1249 | 'a', # a comment |
1250 | 'b', # another comment |
1251 | ); |
5f05dabc |
1252 | |
1253 | =item Possible attempt to separate words with commas |
1254 | |
774d564b |
1255 | (W) qw() lists contain items separated by whitespace; therefore commas |
1256 | aren't needed to separate the items. (You may have used different |
1257 | delimiters than the parentheses shown here; braces are also frequently |
1258 | used.) |
5f05dabc |
1259 | |
2ae324a7 |
1260 | You probably wrote something like this: |
5f05dabc |
1261 | |
774d564b |
1262 | qw! a, b, c !; |
1263 | |
1264 | which puts literal commas into some of the list items. Write it without |
1265 | commas if you don't want them to appear in your data: |
1266 | |
1267 | qw! a b c !; |
5f05dabc |
1268 | |
774d564b |
1269 | =item Scalar value @%s{%s} better written as $%s{%s} |
1270 | |
1271 | (W) You've used a hash slice (indicated by @) to select a single element of |
1272 | a hash. Generally it's better to ask for a scalar value (indicated by $). |
1273 | The difference is that C<$foo{&bar}> always behaves like a scalar, both when |
1274 | assigning to it and when evaluating its argument, while C<@foo{&bar}> behaves |
1275 | like a list when you assign to it, and provides a list context to its |
1276 | subscript, which can do weird things if you're expecting only one subscript. |
5f05dabc |
1277 | |
54310121 |
1278 | =item Stub found while resolving method `%s' overloading `%s' in package `%s' |
1279 | |
1280 | (P) Overloading resolution over @ISA tree may be broken by importing stubs. |
1281 | Stubs should never be implicitely created, but explicit calls to C<can> |
1282 | may break this. |
1283 | |
1284 | =item Too late for "B<-T>" option |
1285 | |
1286 | (X) The #! line (or local equivalent) in a Perl script contains the |
1287 | B<-T> option, but Perl was not invoked with B<-T> in its argument |
1288 | list. This is an error because, by the time Perl discovers a B<-T> in |
1289 | a script, it's too late to properly taint everything from the |
1290 | environment. So Perl gives up. |
1291 | |
5f05dabc |
1292 | =item untie attempted while %d inner references still exist |
1293 | |
1294 | (W) A copy of the object returned from C<tie> (or C<tied>) was still |
1295 | valid when C<untie> was called. |
1296 | |
54310121 |
1297 | =item Unrecognized character %s |
1298 | |
1299 | (F) The Perl parser has no idea what to do with the specified character |
1300 | in your Perl script (or eval). Perhaps you tried to run a compressed |
1301 | script, a binary program, or a directory as a Perl program. |
1302 | |
1303 | =item Unsupported function fork |
1304 | |
1305 | (F) Your version of executable does not support forking. |
1306 | |
1307 | Note that under some systems, like OS/2, there may be different flavors of |
1308 | Perl executables, some of which may support fork, some not. Try changing |
1309 | the name you call Perl by to C<perl_>, C<perl__>, and so on. |
1310 | |
5cd24f17 |
1311 | =item Use of "$$<digit>" to mean "${$}<digit>" is deprecated |
1312 | |
1313 | (D) Perl versions before 5.004 misinterpreted any type marker followed |
1314 | by "$" and a digit. For example, "$$0" was incorrectly taken to mean |
1315 | "${$}0" instead of "${$0}". This bug is (mostly) fixed in Perl 5.004. |
1316 | |
1317 | However, the developers of Perl 5.004 could not fix this bug completely, |
1318 | because at least two widely-used modules depend on the old meaning of |
1319 | "$$0" in a string. So Perl 5.004 still interprets "$$<digit>" in the |
1320 | old (broken) way inside strings; but it generates this message as a |
1321 | warning. And in Perl 5.005, this special treatment will cease. |
1322 | |
54310121 |
1323 | =item Value of %s can be "0"; test with defined() |
774d564b |
1324 | |
54310121 |
1325 | (W) In a conditional expression, you used <HANDLE>, <*> (glob), C<each()>, |
1326 | or C<readdir()> as a boolean value. Each of these constructs can return a |
1327 | value of "0"; that would make the conditional expression false, which is |
1328 | probably not what you intended. When using these constructs in conditional |
1329 | expressions, test their values with the C<defined> operator. |
774d564b |
1330 | |
1331 | =item Variable "%s" may be unavailable |
1332 | |
1333 | (W) An inner (nested) I<anonymous> subroutine is inside a I<named> |
1334 | subroutine, and outside that is another subroutine; and the anonymous |
1335 | (innermost) subroutine is referencing a lexical variable defined in |
1336 | the outermost subroutine. For example: |
1337 | |
1338 | sub outermost { my $a; sub middle { sub { $a } } } |
1339 | |
1340 | If the anonymous subroutine is called or referenced (directly or |
1341 | indirectly) from the outermost subroutine, it will share the variable |
1342 | as you would expect. But if the anonymous subroutine is called or |
1343 | referenced when the outermost subroutine is not active, it will see |
1344 | the value of the shared variable as it was before and during the |
1345 | *first* call to the outermost subroutine, which is probably not what |
1346 | you want. |
1347 | |
1348 | In these circumstances, it is usually best to make the middle |
1349 | subroutine anonymous, using the C<sub {}> syntax. Perl has specific |
1350 | support for shared variables in nested anonymous subroutines; a named |
1351 | subroutine in between interferes with this feature. |
1352 | |
1353 | =item Variable "%s" will not stay shared |
1354 | |
1355 | (W) An inner (nested) I<named> subroutine is referencing a lexical |
1356 | variable defined in an outer subroutine. |
1357 | |
1358 | When the inner subroutine is called, it will probably see the value of |
1359 | the outer subroutine's variable as it was before and during the |
1360 | *first* call to the outer subroutine; in this case, after the first |
1361 | call to the outer subroutine is complete, the inner and outer |
1362 | subroutines will no longer share a common value for the variable. In |
1363 | other words, the variable will no longer be shared. |
1364 | |
1365 | Furthermore, if the outer subroutine is anonymous and references a |
1366 | lexical variable outside itself, then the outer and inner subroutines |
1367 | will I<never> share the given variable. |
1368 | |
1369 | This problem can usually be solved by making the inner subroutine |
1370 | anonymous, using the C<sub {}> syntax. When inner anonymous subs that |
1371 | reference variables in outer subroutines are called or referenced, |
54310121 |
1372 | they are automatically rebound to the current values of such |
774d564b |
1373 | variables. |
1374 | |
1375 | =item Warning: something's wrong |
1376 | |
1377 | (W) You passed warn() an empty string (the equivalent of C<warn "">) or |
1378 | you called it with no args and C<$_> was empty. |
1379 | |
54310121 |
1380 | =item Ill-formed logical name |%s| in prime_env_iter |
1381 | |
1382 | (W) A warning peculiar to VMS. A logical name was encountered when preparing |
1383 | to iterate over %ENV which violates the syntactic rules governing logical |
1384 | names. Since it cannot be translated normally, it is skipped, and will not |
1385 | appear in %ENV. This may be a benign occurrence, as some software packages |
1386 | might directly modify logical name tables and introduce nonstandard names, |
1387 | or it may indicate that a logical name table has been corrupted. |
1388 | |
774d564b |
1389 | =item Got an error from DosAllocMem |
5f05dabc |
1390 | |
774d564b |
1391 | (P) An error peculiar to OS/2. Most probably you're using an obsolete |
1392 | version of Perl, and this should not happen anyway. |
5f05dabc |
1393 | |
1394 | =item Malformed PERLLIB_PREFIX |
1395 | |
dc848c6f |
1396 | (F) An error peculiar to OS/2. PERLLIB_PREFIX should be of the form |
5f05dabc |
1397 | |
1398 | prefix1;prefix2 |
1399 | |
1400 | or |
1401 | |
1402 | prefix1 prefix2 |
1403 | |
dc848c6f |
1404 | with nonempty prefix1 and prefix2. If C<prefix1> is indeed a prefix |
1405 | of a builtin library search path, prefix2 is substituted. The error |
1406 | may appear if components are not found, or are too long. See |
1407 | "PERLLIB_PREFIX" in F<README.os2>. |
5f05dabc |
1408 | |
1409 | =item PERL_SH_DIR too long |
1410 | |
1411 | (F) An error peculiar to OS/2. PERL_SH_DIR is the directory to find the |
dc848c6f |
1412 | C<sh>-shell in. See "PERL_SH_DIR" in F<README.os2>. |
5f05dabc |
1413 | |
1414 | =item Process terminated by SIG%s |
1415 | |
1416 | (W) This is a standard message issued by OS/2 applications, while *nix |
dc848c6f |
1417 | applications die in silence. It is considered a feature of the OS/2 |
1418 | port. One can easily disable this by appropriate sighandlers, see |
1419 | L<perlipc/"Signals">. See also "Process terminated by SIGTERM/SIGINT" |
1420 | in F<README.os2>. |
5f05dabc |
1421 | |
1422 | =back |
1423 | |
1424 | =head1 BUGS |
1425 | |
774d564b |
1426 | If you find what you think is a bug, you might check the headers of |
1427 | recently posted articles in the comp.lang.perl.misc newsgroup. |
1428 | There may also be information at http://www.perl.com/perl/, the Perl |
1429 | Home Page. |
5f05dabc |
1430 | |
1431 | If you believe you have an unreported bug, please run the B<perlbug> |
9607fc9c |
1432 | program included with your release. Make sure you trim your bug down |
1433 | to a tiny but sufficient test case. Your bug report, along with the |
1434 | output of C<perl -V>, will be sent off to <F<perlbug@perl.com>> to be |
1435 | analysed by the Perl porting team. |
5f05dabc |
1436 | |
1437 | =head1 SEE ALSO |
1438 | |
1439 | The F<Changes> file for exhaustive details on what changed. |
1440 | |
1441 | The F<INSTALL> file for how to build Perl. This file has been |
1442 | significantly updated for 5.004, so even veteran users should |
1443 | look through it. |
1444 | |
1445 | The F<README> file for general stuff. |
1446 | |
1447 | The F<Copying> file for copyright information. |
1448 | |
1449 | =head1 HISTORY |
1450 | |
1451 | Constructed by Tom Christiansen, grabbing material with permission |
1452 | from innumerable contributors, with kibitzing by more than a few Perl |
1453 | porters. |
1454 | |
2ae324a7 |
1455 | Last update: Sat Mar 8 19:51:26 EST 1997 |