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