better diagnostics on read operations from write-only
[p5sagit/p5-mst-13.2.git] / pod / perldelta.pod
1 =head1 NAME
2
3 perldelta - what's new for perl5.006 (as of 5.005_56)
4
5 =head1 DESCRIPTION
6
7 This document describes differences between the 5.005 release and this one.
8
9 =head1 Incompatible Changes
10
11 =head2 Perl Source Incompatibilities
12
13 None known at this time.
14
15 =head2 C Source Incompatibilities
16
17 =over 4
18
19 =item C<PERL_POLLUTE>
20
21 Release 5.005 grandfathered old global symbol names by providing preprocessor
22 macros for extension source compatibility.  As of release 5.006, these
23 preprocessor definitions are not available by default.  You need to explicitly
24 compile perl with C<-DPERL_POLLUTE> to get these definitions.  For
25 extensions still using the old symbols, this option can be
26 specified via MakeMaker:
27
28     perl Makefile.PL POLLUTE=1
29
30 =item C<PERL_POLLUTE_MALLOC>
31
32 Enabling Perl's malloc in release 5.005 and earlier caused
33 the namespace of system versions of the malloc family of functions to
34 be usurped by the Perl versions, since by default they used the
35 same names.
36
37 Besides causing problems on platforms that do not allow these functions to
38 be cleanly replaced, this also meant that the system versions could not
39 be called in programs that used Perl's malloc.  Previous versions of Perl
40 have allowed this behaviour to be suppressed with the HIDEMYMALLOC and
41 EMBEDMYMALLOC preprocessor definitions.
42
43 As of release 5.006, Perl's malloc family of functions have default names
44 distinct from the system versions.  You need to explicitly compile perl with
45 C<-DPERL_POLLUTE_MALLOC> to get the older behaviour.  HIDEMYMALLOC
46 and EMBEDMYMALLOC have no effect, since the behaviour they enabled is now
47 the default.
48
49 Note that these functions do B<not> constitute Perl's memory allocation API.
50 See L<perlguts/"Memory Allocation"> for further information about that.
51
52 =item C<PL_na> and C<dTHR> Issues
53
54 The C<PL_na> global is now thread local, so a C<dTHR> declaration is needed
55 in the scope in which the global appears.  XSUBs should handle this automatically,
56 but if you have used C<PL_na> in support functions, you either need to
57 change the C<PL_na> to a local variable (which is recommended), or put in
58 a C<dTHR>.
59
60 =back
61
62 =head2 Compatible C Source API Changes
63
64 =over
65
66 =item C<PATCHLEVEL> is now C<PERL_VERSION>
67
68 The cpp macros C<PERL_REVISION>, C<PERL_VERSION>, and C<PERL_SUBVERSION>
69 are now available by default from perl.h, and reflect the base revision,
70 patchlevel, and subversion respectively.  C<PERL_REVISION> had no
71 prior equivalent, while C<PERL_VERSION> and C<PERL_SUBVERSION> were
72 previously available as C<PATCHLEVEL> and C<SUBVERSION>.
73
74 The new names cause less pollution of the B<cpp> namespace and reflect what
75 the numbers have come to stand for in common practice.  For compatibility,
76 the old names are still supported when F<patchlevel.h> is explicitly
77 included (as required before), so there is no source incompatibility
78 from the change.
79
80 =back
81
82 =head2 Binary Incompatibilities
83
84 This release is not binary compatible with the 5.005 release or its
85 maintenance versions.
86
87 =head1 Core Changes
88
89 =head2 Unicode and UTF-8 support
90
91 Perl can optionally use UTF-8 as its internal representation for character
92 strings.  The C<use utf8> pragma enables this support in the current lexical
93 scope.  See L<utf8> for more information.
94
95 =head2 Lexically scoped warning categories
96
97 You can now control the granularity of warnings emitted by perl at a finer
98 level using the C<use warning> pragma.  See L<warning> for details.
99
100 =head2 Binary numbers supported
101
102 Binary numbers are now supported as literals, in s?printf formats, and
103 C<oct()>:
104
105     $answer = 0b101010;
106     printf "The answer is: %b\n", oct("0b101010");
107
108 =head2 syswrite() ease-of-use
109
110 The length argument of C<syswrite()> is now optional.
111
112 =head2 64-bit support
113
114 Better 64-bit support -- but full support still a distant goal.  One
115 must Configure with -Duse64bits to get Configure to probe for the
116 extent of 64-bit support.  Depending on the platform (hints file) more
117 or less 64-awareness becomes available.  As of 5.005_54 at least
118 somewhat 64-bit aware platforms are HP-UX 11 or better, Solaris 2.6 or
119 better, IRIX 6.2 or better.  Naturally 64-bit platforms like Digital
120 Unix and UNICOS also have 64-bit support.
121
122 =head2 Better syntax checks on parenthesized unary operators
123
124 Expressions such as:
125
126     print defined(&foo,&bar,&baz);
127     print uc("foo","bar","baz");
128     undef($foo,&bar);
129
130 used to be accidentally allowed in earlier versions, and produced
131 unpredictable behaviour.  Some produced ancillary warnings
132 when used in this way; others silently did the wrong thing.
133
134 The parenthesized forms of most unary operators that expect a single
135 argument now ensure that they are not called with more than one
136 argument, making the cases shown above syntax errors.  The usual
137 behaviour of:
138
139     print defined &foo, &bar, &baz;
140     print uc "foo", "bar", "baz";
141     undef $foo, &bar;
142
143 remains unchanged.  See L<perlop>.
144
145 =head2 Improved C<qw//> operator
146
147 The C<qw//> operator is now evaluated at compile time into a true list
148 instead of being replaced with a run time call to C<split()>.  This
149 removes the confusing misbehaviour of C<qw//> in scalar context, which
150 had inherited that behaviour from split().
151
152 Thus:
153
154     $foo = ($bar) = qw(a b c); print "$foo|$bar\n";
155
156 now correctly prints "3|a", instead of "2|a".
157
158 =head2 pack() format 'Z' supported
159
160 The new format type 'Z' is useful for packing and unpacking null-terminated
161 strings.  See L<perlfunc/"pack">.
162
163 =head2 pack() format modifier '!' supported
164
165 The new format type modifier '!' is useful for packing and unpacking
166 native shorts, ints, and longs.  See L<perlfunc/"pack">.
167
168 =head2 $^X variables may now have names longer than one character
169
170 Formerly, $^X was synonymous with ${"\cX"}, but $^XY was a syntax
171 error.  Now variable names that begin with a control character may be
172 arbitrarily long.  However, for compatibility reasons, these variables
173 I<must> be written with explicit braces, as C<${^XY}> for example.
174 C<${^XYZ}> is synonymous with ${"\cXYZ"}.  Variable names with more
175 than one control character, such as C<${^XY^Z}>, are illegal.
176
177 The old syntax has not changed.  As before, `^X' may be either a
178 literal control-X character or the two-character sequence `caret' plus
179 `X'.  When braces are omitted, the variable name stops after the
180 control character.  Thus C<"$^XYZ"> continues to be synonymous with
181 C<$^X . "YZ"> as before.
182
183 As before, lexical variables may not have names beginning with control
184 characters.  As before, variables whose names begin with a control
185 character are always forced to be in package `main'.  All such variables
186 are reserved for future extensions, except those that begin with
187 C<^_>, which may be used by user programs and is guaranteed not to
188 acquire special meaning in any future version of Perl.
189
190 =head1 Significant bug fixes
191
192 =head2 E<lt>HANDLEE<gt> on empty files
193
194 With C<$/> set to C<undef>, slurping an empty file returns a string of
195 zero length (instead of C<undef>, as it used to) the first time the
196 HANDLE is read.  Further reads yield C<undef>.
197
198 This means that the following will append "foo" to an empty file (it used
199 to do nothing):
200
201     perl -0777 -pi -e 's/^/foo/' empty_file
202
203 The behaviour of:
204
205     perl -pi -e 's/^/foo/' empty_file
206
207 is unchanged (it continues to leave the file empty).
208
209 =head2 C<eval '...'> improvements
210
211 Line numbers (as reflected by caller() and most diagnostics) within
212 C<eval '...'> were often incorrect when here documents were involved.
213 This has been corrected.
214
215 Lexical lookups for variables appearing in C<eval '...'> within
216 functions that were themselves called within an C<eval '...'> were
217 searching the wrong place for lexicals.  The lexical search now
218 correctly ends at the subroutine's block boundary.
219
220 Parsing of here documents used to be flawed when they appeared as
221 the replacement expression in C<eval 's/.../.../e'>.  This has
222 been fixed.
223
224 =head2 Automatic flushing of output buffers
225
226 fork(), exec(), system(), qx//, and pipe open()s now flush buffers
227 of all files opened for output when the operation
228 was attempted.  This mostly eliminates confusing 
229 buffering mishaps suffered by users unaware of how Perl internally
230 handles I/O.
231
232 =head2 Better diagnostics on meaningless filehandle operations
233
234 Constructs such as C<open(E<lt>FHE<gt>)> and C<close(E<lt>FHE<gt>)>
235 are compile time errors.  Attempting to read from filehandles that
236 were opened only for writing will now produce warnings (just as
237 writing to read-only filehandles does).
238
239 =head1 Supported Platforms
240
241 =over 4
242
243 =item *
244
245 VM/ESA is now supported.
246
247 =item *
248
249 Siemens BS2000 is now supported under the POSIX Shell.
250
251 =item *
252
253 The Mach CThreads (NEXTSTEP, OPENSTEP) are now supported by the Thread
254 extension.
255
256 =item *
257
258 GNU/Hurd is now supported.
259
260 =item *
261
262 Rhapsody is now supported.
263
264 =back
265
266 =head1 New tests
267
268 =over 4
269
270 =item   op/io_const
271
272 IO constants (SEEK_*, _IO*).
273
274 =item   op/io_dir
275
276 Directory-related IO methods (new, read, close, rewind, tied delete).
277
278 =item   op/io_multihomed
279
280 INET sockets with multi-homed hosts.
281
282 =item   op/io_poll
283
284 IO poll().
285
286 =item   op/io_unix
287
288 UNIX sockets.
289
290 =item   op/filetest
291
292 File test operators.
293
294 =item   op/lex_assign
295
296 Verify operations that access pad objects (lexicals and temporaries).
297
298 =back
299
300 =head1 Modules and Pragmata
301
302 =head2 Modules
303
304 =over 4
305
306 =item Dumpvalue
307
308 Added Dumpvalue module provides screen dumps of Perl data.
309
310 =item Benchmark
311
312 You can now run tests for I<n> seconds instead of guessing the right
313 number of tests to run: e.g. timethese(-5, ...) will run each 
314 code for at least 5 CPU seconds.  Zero as the "number of repetitions"
315 means "for at least 3 CPU seconds".  The output format has also
316 changed.  For example:
317
318 use Benchmark;$x=3;timethese(-5,{a=>sub{$x*$x},b=>sub{$x**2}})
319
320 will now output something like this:
321
322 Benchmark: running a, b, each for at least 5 CPU seconds...
323          a:  5 wallclock secs ( 5.77 usr +  0.00 sys =  5.77 CPU) @ 200551.91/s (n=1156516)
324          b:  4 wallclock secs ( 5.00 usr +  0.02 sys =  5.02 CPU) @ 159605.18/s (n=800686)
325
326 New features: "each for at least N CPU seconds...", "wallclock secs",
327 and the "@ operations/CPU second (n=operations)".
328
329 =item Devel::Peek
330
331 The Devel::Peek module provides access to the internal representation
332 of Perl variables and data.  It is a data debugging tool for the XS programmer.
333
334 =item Fcntl
335
336 More Fcntl constants added: F_SETLK64, F_SETLKW64, O_LARGEFILE for
337 large (more than 4G) file access (64-bit support is not yet
338 working, though, so no need to get overly excited), Free/Net/OpenBSD
339 locking behaviour flags F_FLOCK, F_POSIX, Linux F_SHLCK, and
340 O_ACCMODE: the mask of O_RDONLY, O_WRONLY, and O_RDWR.
341
342 =item File::Spec
343
344 New methods have been added to the File::Spec module: devnull() returns
345 the name of the null device (/dev/null on Unix) and tmpdir() the name of
346 the temp directory (normally /tmp on Unix).  There are now also methods
347 to convert between absolute and relative filenames: abs2rel() and
348 rel2abs().  For compatibility with operating systems that specify volume
349 names in file paths, the splitpath(), splitdir(), and catdir() methods
350 have been added.
351
352 =item File::Spec::Functions
353
354 The new File::Spec::Functions modules provides a function interface
355 to the File::Spec module.  Allows shorthand
356
357     $fullname = catfile($dir1, $dir2, $file);
358
359 instead of
360
361     $fullname = File::Spec->catfile($dir1, $dir2, $file);
362
363 =item Math::BigInt
364
365 The logical operations C<E<lt>E<lt>>, C<E<gt>E<gt>>, C<&>, C<|>,
366 and C<~> are now supported on bigints.
367
368 =item Math::Complex
369
370 The accessor methods Re, Im, arg, abs, rho, and theta can now also
371 act as mutators (accessor $z->Re(), mutator $z->Re(3)).
372
373 =item Math::Trig
374
375 A little bit of radial trigonometry (cylindrical and spherical),
376 radial coordinate conversions, and the great circle distance were added.
377
378 =item SDBM_File
379
380 An EXISTS method has been added to this module (and sdbm_exists() has
381 been added to the underlying sdbm library), so one can now call exists
382 on an SDBM_File tied hash and get the correct result, rather than a
383 runtime error.
384
385 =item Time::Local
386
387 The timelocal() and timegm() functions used to silently return bogus
388 results when the date exceeded the machine's integer range.  They
389 now consistently croak() if the date falls in an unsupported range.
390
391 =item Win32
392
393 The error return value in list context has been changed for all functions
394 that return a list of values.  Previously these functions returned a list
395 with a single element C<undef> if an error occurred.  Now these functions
396 return the empty list in these situations.  This applies to the following
397 functions:
398
399     Win32::FsType
400     Win32::GetOSVersion
401
402 The remaining functions are unchanged and continue to return C<undef> on
403 error even in list context.
404
405 The Win32::SetLastError(ERROR) function has been added as a complement
406 to the Win32::GetLastError() function.
407
408 The new Win32::GetFullPathName(FILENAME) returns the full absolute
409 pathname for FILENAME in scalar context.  In list context it returns
410 a two-element list containing the fully qualified directory name and
411 the filename.
412
413 =item DBM Filters
414
415 A new feature called "DBM Filters" has been added to all the
416 DBM modules--DB_File, GDBM_File, NDBM_File, ODBM_File, and SDBM_File.
417 DBM Filters add four new methods to each DBM module:
418
419     filter_store_key
420     filter_store_value
421     filter_fetch_key
422     filter_fetch_value
423
424 These can be used to filter key-value pairs before the pairs are
425 written to the database or just after they are read from the database.
426 See L<perldbmfilter> for further information.
427
428 =back
429
430 =head2 Pragmata
431
432 C<use utf8> to enable UTF-8 and Unicode support.
433
434 C<use caller 'encoding'> allows modules to inherit pragmatic attributes
435 from the caller's context.  C<encoding> is currently the only supported
436 attribute.
437
438 Lexical warnings pragma, C<use warning;>, to control optional warnings.
439
440 C<use filetest> to control the behaviour of filetests (C<-r> C<-w> ...).
441 Currently only one subpragma implemented, "use filetest 'access';",
442 that enables the use of access(2) or equivalent to check
443 permissions instead of using stat(2) as usual.  This matters
444 in filesystems where there are ACLs (access control lists): the
445 stat(2) might lie, but access(2) knows better.
446
447 =head1 Utility Changes
448
449 Todo.
450
451 =head1 Documentation Changes
452
453 =over 4
454
455 =item perlopentut.pod
456
457 A tutorial on using open() effectively.
458
459 =item perlreftut.pod
460
461 A tutorial that introduces the essentials of references.
462
463 =item perltootc.pod
464
465 A tutorial on managing class data for object modules.
466
467 =back
468
469 =head1 New Diagnostics
470
471 =item /%s/: Unrecognized escape \\%c passed through
472
473 (W) You used a backslash-character combination which is not recognized
474 by Perl.  This combination appears in an interpolated variable or a
475 C<'>-delimited regular expression.
476
477 =item Filehandle %s opened only for output
478
479 (W) You tried to read from a filehandle opened only for writing.  If you
480 intended it to be a read-write filehandle, you needed to open it with
481 "+E<lt>" or "+E<gt>" or "+E<gt>E<gt>" instead of with "E<lt>" or nothing.  If
482 you intended only to read from the file, use "E<lt>".  See
483 L<perlfunc/open>.
484
485 =item Missing command in piped open
486
487 (W) You used the C<open(FH, "| command")> or C<open(FH, "command |")>
488 construction, but the command was missing or blank.
489
490 =item Unrecognized escape \\%c passed through
491
492 (W) You used a backslash-character combination which is not recognized
493 by Perl.
494
495 =item defined(@array) is deprecated
496
497 (D) defined() is not usually useful on arrays because it checks for an
498 undefined I<scalar> value.  If you want to see if the array is empty,
499 just use C<if (@array) { # not empty }> for example.  
500
501 =item defined(%hash) is deprecated
502
503 (D) defined() is not usually useful on hashes because it checks for an
504 undefined I<scalar> value.  If you want to see if the hash is empty,
505 just use C<if (%hash) { # not empty }> for example.  
506
507 =head1 Obsolete Diagnostics
508
509 Todo.
510
511 =head1 Configuration Changes
512
513 You can use "Configure -Uinstallusrbinperl" which causes installperl
514 to skip installing perl also as /usr/bin/perl.  This is useful if you
515 prefer not to modify /usr/bin for some reason or another but harmful
516 because many scripts assume to find Perl in /usr/bin/perl.
517
518 =head1 BUGS
519
520 If you find what you think is a bug, you might check the headers of
521 articles recently posted to the comp.lang.perl.misc newsgroup.
522 There may also be information at http://www.perl.com/perl/, the Perl
523 Home Page.
524
525 If you believe you have an unreported bug, please run the B<perlbug>
526 program included with your release.  Make sure to trim your bug down
527 to a tiny but sufficient test case.  Your bug report, along with the
528 output of C<perl -V>, will be sent off to perlbug@perl.com to be
529 analysed by the Perl porting team.
530
531 =head1 SEE ALSO
532
533 The F<Changes> file for exhaustive details on what changed.
534
535 The F<INSTALL> file for how to build Perl.
536
537 The F<README> file for general stuff.
538
539 The F<Artistic> and F<Copying> files for copyright information.
540
541 =head1 HISTORY
542
543 Written by Gurusamy Sarathy <F<gsar@umich.edu>>, with many contributions
544 from The Perl Porters.
545
546 Send omissions or corrections to <F<perlbug@perl.com>>.
547
548 =cut