major pod update from Tom Christiansen
[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> in order to get these definitions. For
25 extensions that are 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 the use of 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 of these functions, since they used the
35 same names by default.
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 behavior 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> in order to get the older behavior.  HIDEMYMALLOC
46 and EMBEDMYMALLOC have no effect, since the behavior 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 it 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 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 patchlevel.h is explicitly
77 included (as required before), so there is no source incompatibility
78 due to the change.
79
80 =back
81
82 =head2 Binary Incompatibilities
83
84 This release is not binary compatible with the 5.005 release and 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 behavior.  Some of them produced ancillary warnings
132 when used in this way, while others silently did the wrong thing.
133
134 The parenthesized forms of most unary operators that expect a single
135 argument will now ensure that they are not called with more than one
136 argument, making the above cases syntax errors.  Note that the usual
137 behavior 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 behavior of C<qw//> in scalar context stemming from
150 the older implementation, which inherited the behavior 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 modifer '!' 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, the `^X' may either be a
178 literal control-X character or the two character sequence `caret' plus
179 `X'.  When the 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'.  These variables
186 are all reserved for future extensions, except the ones that begin
187 with C<^_>, which may be used by user programs and will not acquire a
188 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) for the first time the
196 HANDLE is read.  Subsequent reads yield C<undef>.
197
198 This means that the following will append "foo" to an empty file (it used
199 to not do anything before):
200
201     perl -0777 -pi -e 's/^/foo/' empty_file
202
203 Note that the behavior 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.  They now correctly terminate
218 the lexical search at the subroutine call 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 the buffers
227 of all files that were opened for output at the time the operation
228 was attempted.  This mostly eliminates the often confusing effects of
229 buffering mishaps suffered by users unaware of how Perl internally
230 handled I/O.
231
232 =head1 Supported Platforms
233
234 =over 4
235
236 =item *
237
238 VM/ESA is now supported.
239
240 =item *
241
242 Siemens BS2000 is now supported under the POSIX Shell.
243
244 =item *
245
246 The Mach CThreads (NEXTSTEP, OPENSTEP) are now supported by the Thread
247 extension.
248
249 =item *
250
251 GNU/Hurd is now supported.
252
253 =item *
254
255 Rhapsody is now supported.
256
257 =back
258
259 =head1 New tests
260
261 =over 4
262
263 =item   op/io_const
264
265 IO constants (SEEK_*, _IO*).
266         
267 =item   op/io_dir
268
269 Directory-related IO methods (new, read, close, rewind, tied delete).
270
271 =item   op/io_multihomed
272
273 INET sockets with multi-homed hosts.
274
275 =item   op/io_poll
276
277 IO poll().
278
279 =item   op/io_unix
280
281 UNIX sockets.
282
283 =item   op/filetest
284
285 File test operators.
286
287 =item   op/lex_assign
288
289 Verify operations that access pad objects (lexicals and temporaries).
290
291 =back
292
293 =head1 Modules and Pragmata
294
295 =head2 Modules
296
297 =over 4
298
299 =item Dumpvalue
300
301 Added Dumpvalue module provides screen dumps of Perl data.
302
303 =item Benchmark
304
305 You can now run tests for I<n> seconds instead of guessing the right
306 number of tests to run: e.g. timethese(-5, ...) will run each of the
307 codes for at least 5 CPU seconds.  Zero as the "number of repetitions"
308 means "for at least 3 CPU seconds".  The output format has also
309 changed.  For example: 
310
311 use Benchmark;$x=3;timethese(-5,{a=>sub{$x*$x},b=>sub{$x**2}})
312
313 will now output something like this:
314
315 Benchmark: running a, b, each for at least 5 CPU seconds...
316          a:  5 wallclock secs ( 5.77 usr +  0.00 sys =  5.77 CPU) @ 200551.91/s (n=1156516)
317          b:  4 wallclock secs ( 5.00 usr +  0.02 sys =  5.02 CPU) @ 159605.18/s (n=800686)
318
319 New features: "each for at least N CPU seconds...", "wallclock secs",
320 and the "@ operations/CPU second (n=operations)".
321
322 =item Devel::Peek
323
324 The Devel::Peek module provides access to the internal representation
325 of Perl variables. It is a data debugging tool for the XS programmer.
326
327 =item Fcntl
328
329 More Fcntl constants added: F_SETLK64, F_SETLKW64, O_LARGEFILE for
330 large (more than 4G) file access (the 64-bit support is not yet
331 working, though, so no need to get overly excited), Free/Net/OpenBSD
332 locking behaviour flags F_FLOCK, F_POSIX, Linux F_SHLCK, and
333 O_ACCMODE: the mask of O_RDONLY, O_WRONLY, and O_RDWR.
334
335 =item File::Spec
336
337 New methods have been added to the File::Spec module: devnull() returns
338 the name of the null device (/dev/null on Unix) and tmpdir() the name of
339 the temp directory (normally /tmp on Unix). There are now also methods
340 to convert between absolute and relative filenames: abs2rel() and
341 rel2abs(). For compatibility with operating systems that specify volume
342 names in file paths, the splitpath(), splitdir() and catdir() methods
343 have been added.
344
345 =item File::Spec::Functions
346
347 The new File::Spec::Functions modules provides a function interface
348 to the File::Spec module. Allows shorthand
349
350         $fullname = catfile($dir1, $dir2, $file);
351
352 instead of
353
354         $fullname = File::Spec->catfile($dir1, $dir2, $file);
355
356 =item Math::BigInt
357
358 The logical operations C<E<lt>E<lt>>, C<E<gt>E<gt>>, C<&>, C<|>
359 and C<~> are now supported on bigints.
360
361 =item Math::Complex
362
363 The accessor methods Re, Im, arg, abs, rho, and theta, can now also
364 act as mutators (accessor $z->Re(), mutator $z->Re(3)).
365
366 =item Math::Trig
367
368 A little bit of radial trigonometry (cylindrical and spherical) added,
369 radial coordinate conversions and the great circle distance.
370
371 =item SDBM_File
372
373 An EXISTS method has been added to this module (and sdbm_exists() has
374 been added to the underlying sdbm library), so one can now call exists
375 on an SDBM_File tied hash and get the correct result rather than a
376 runtime error.
377
378 =item Time::Local
379
380 The timelocal() and timegm() functions used to silently return bogus
381 results when the date exceeded the machine's integer range.  They
382 consistently croak() if the date falls in an unsupported range.
383
384 =item Win32
385
386 The error return value in list context has been changed for all functions
387 that return a list of values. Previously these functions returned a list
388 with a single element C<undef> in case an error occurred. Now these functions
389 return the empty list in these situations. This applies to the following
390 functions:
391
392         Win32::FsType
393         Win32::GetOSVersion
394
395 The remaining functions are unchanged and continue to return C<undef> on
396 error even in list context.
397
398 The Win32::SetLastError(ERROR) function has been added as a complement
399 to the Win32::GetLastError() function.
400
401 The new Win32::GetFullPathName(FILENAME) returns the full absolute
402 pathname for FILENAME in scalar context. In list context it returns
403 a two element list containing the fully qualified directory name and
404 the filename.
405
406 =item DBM Filters
407
408 A new feature called "DBM Filters" has been added to all the
409 DBM modules -- DB_File, GDBM_File, NDBM_File, ODBM_File and SDBM_File.
410 DBM Filters add four new methods to each of the DBM modules 
411
412     filter_store_key
413     filter_store_value
414     filter_fetch_key
415     filter_fetch_value
416
417 These can be used to filter the contents of keys/values before they are
418 written to the database or just after they are read from the database.
419 See L<perldbmfilter> for further information.
420
421 =back
422
423 =head2 Pragmata
424
425 C<use utf8;>, to enable UTF-8 and Unicode support.
426
427 Lexical warnings pragma, C<use warning;>, to control optional warnings.
428
429 C<use filetest;>, to control the behaviour of filetests (C<-r> C<-w> ...).
430 Currently only one subpragma implemented, "use filetest 'access';",
431 that enables the use of access(2) or equivalent to check the
432 permissions instead of using stat(2) as usual.  This matters
433 in filesystems where there are ACLs (access control lists), the
434 stat(2) might lie, while access(2) knows better.
435
436 =head1 Utility Changes
437
438 Todo.
439
440 =head1 Documentation Changes
441
442 =over 4
443
444 =item perlopentut.pod
445
446 A tutorial on using open() effectively.
447
448 =item perlreftut.pod
449
450 A tutorial that introduces the essentials of references.
451
452 =back
453
454 =head1 New Diagnostics
455
456 =item /%s/: Unrecognized escape \\%c passed through
457
458 (W) You used a backslash-character combination which is not recognized
459 by Perl.  This combination appears in an interpolated variable or a
460 C<'>-delimited regular expression.
461
462 =item Unrecognized escape \\%c passed through
463
464 (W) You used a backslash-character combination which is not recognized
465 by Perl.
466
467 =item Missing command in piped open
468
469 (W) You used the C<open(FH, "| command")> or C<open(FH, "command |")>
470 construction, but the command was missing or blank.
471
472 =head1 Obsolete Diagnostics
473
474 Todo.
475
476 =head1 Configuration Changes
477
478 You can use "Configure -Uinstallusrbinperl" which causes installperl
479 to skip installing perl also as /usr/bin/perl.  This is useful if you
480 prefer not to modify /usr/bin for some reason or another but harmful
481 because many scripts assume to find Perl in /usr/bin/perl.
482
483 =head1 BUGS
484
485 If you find what you think is a bug, you might check the headers of
486 recently posted articles in the comp.lang.perl.misc newsgroup.
487 There may also be information at http://www.perl.com/perl/, the Perl
488 Home Page.
489
490 If you believe you have an unreported bug, please run the B<perlbug>
491 program included with your release.  Make sure you trim your bug down
492 to a tiny but sufficient test case.  Your bug report, along with the
493 output of C<perl -V>, will be sent off to <F<perlbug@perl.com>> to be
494 analysed by the Perl porting team.
495
496 =head1 SEE ALSO
497
498 The F<Changes> file for exhaustive details on what changed.
499
500 The F<INSTALL> file for how to build Perl.
501
502 The F<README> file for general stuff.
503
504 The F<Artistic> and F<Copying> files for copyright information.
505
506 =head1 HISTORY
507
508 Written by Gurusamy Sarathy <F<gsar@umich.edu>>, with many contributions
509 from The Perl Porters.
510
511 Send omissions or corrections to <F<perlbug@perl.com>>.
512
513 =cut