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