This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Refactor test code to remove duplication is a TODO.
[perl5.git] / pod / perltodo.pod
1 =head1 NAME
2
3 perltodo - Perl TO-DO List
4
5 =head1 DESCRIPTION
6
7 This is a list of wishes for Perl. The tasks we think are smaller or easier
8 are listed first. Anyone is welcome to work on any of these, but it's a good
9 idea to first contact I<perl5-porters@perl.org> to avoid duplication of
10 effort. By all means contact a pumpking privately first if you prefer.
11
12 Whilst patches to make the list shorter are most welcome, ideas to add to
13 the list are also encouraged. Check the perl5-porters archives for past
14 ideas, and any discussion about them. One set of archives may be found at:
15
16     http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/
17
18 What can we offer you in return? Fame, fortune, and everlasting glory? Maybe
19 not, but if your patch is incorporated, then we'll add your name to the
20 F<AUTHORS> file, which ships in the official distribution. How many other
21 programming languages offer you 1 line of immortality?
22
23 =head1 Tasks that only need Perl knowledge
24
25 =head2 Remove duplication of test setup.
26
27 Schwern notes, that there's duplication of code - lots and lots of tests have
28 some variation on the big block of C<$Is_Foo> checks.  We can safely put this
29 into a file, change it to build an C<%Is> hash and require it.  Maybe just put
30 it into F<test.pl>. Throw in the handy tainting subroutines.
31
32 =head2 merge common code in installperl and installman
33
34 There are some common subroutines and a common C<BEGIN> block in F<installperl>
35 and F<installman>. These should probably be merged. It would also be good to
36 check for duplication in all the utility scripts supplied in the source
37 tarball. It might be good to move them all to a subdirectory, but this would
38 require careful checking to find all places that call them, and change those
39 correctly.
40
41 =head2 common test code for timed bail out
42
43 Write portable self destruct code for tests to stop them burning CPU in
44 infinite loops. This needs to avoid using alarm, as some of the tests are
45 testing alarm/sleep or timers.
46
47 =head2 POD -E<gt> HTML conversion in the core still sucks
48
49 Which is crazy given just how simple POD purports to be, and how simple HTML
50 can be. It's not actually I<as> simple as it sounds, particularly with the
51 flexibility POD allows for C<=item>, but it would be good to improve the
52 visual appeal of the HTML generated, and to avoid it having any validation
53 errors. See also L</make HTML install work>, as the layout of installation tree
54 is needed to improve the cross-linking.
55
56 The addition of C<Pod::Simple> and its related modules may make this task
57 easier to complete.
58
59 =head2 merge checkpods and podchecker
60
61 F<pod/checkpods.PL> (and C<make check> in the F<pod/> subdirectory)
62 implements a very basic check for pod files, but the errors it discovers
63 aren't found by podchecker. Add this check to podchecker, get rid of
64 checkpods and have C<make check> use podchecker.
65
66 =head2 perlmodlib.PL rewrite
67
68 Currently perlmodlib.PL needs to be run from a source directory where perl
69 has been built, or some modules won't be found, and others will be
70 skipped. Make it run from a clean perl source tree (so it's reproducible).
71
72 =head2 Parallel testing
73
74 (This probably impacts much more than the core: also the Test::Harness
75 and TAP::* modules on CPAN.)
76
77 The core regression test suite is getting ever more comprehensive, which has
78 the side effect that it takes longer to run. This isn't so good. Investigate
79 whether it would be feasible to give the harness script the B<option> of
80 running sets of tests in parallel. This would be useful for tests in
81 F<t/op/*.t> and F<t/uni/*.t> and maybe some sets of tests in F<lib/>.
82
83 Questions to answer
84
85 =over 4
86
87 =item 1
88
89 How does screen layout work when you're running more than one test?
90
91 =item 2
92
93 How does the caller of test specify how many tests to run in parallel?
94
95 =item 3
96
97 How do setup/teardown tests identify themselves?
98
99 =back
100
101 Pugs already does parallel testing - can their approach be re-used?
102
103 =head2 Make Schwern poorer
104
105 We should have tests for everything. When all the core's modules are tested,
106 Schwern has promised to donate to $500 to TPF. We may need volunteers to
107 hold him upside down and shake vigorously in order to actually extract the
108 cash.
109
110 =head2 Improve the coverage of the core tests
111
112 Use Devel::Cover to ascertain the core modules's test coverage, then add
113 tests that are currently missing.
114
115 =head2 test B
116
117 A full test suite for the B module would be nice.
118
119 =head2 Deparse inlined constants
120
121 Code such as this
122
123     use constant PI => 4;
124     warn PI
125
126 will currently deparse as
127
128     use constant ('PI', 4);
129     warn 4;
130
131 because the tokenizer inlines the value of the constant subroutine C<PI>.
132 This allows various compile time optimisations, such as constant folding
133 and dead code elimination. Where these haven't happened (such as the example
134 above) it ought be possible to make B::Deparse work out the name of the
135 original constant, because just enough information survives in the symbol
136 table to do this. Specifically, the same scalar is used for the constant in
137 the optree as is used for the constant subroutine, so by iterating over all
138 symbol tables and generating a mapping of SV address to constant name, it
139 would be possible to provide B::Deparse with this functionality.
140
141 =head2 A decent benchmark
142
143 C<perlbench> seems impervious to any recent changes made to the perl core. It
144 would be useful to have a reasonable general benchmarking suite that roughly
145 represented what current perl programs do, and measurably reported whether
146 tweaks to the core improve, degrade or don't really affect performance, to
147 guide people attempting to optimise the guts of perl. Gisle would welcome
148 new tests for perlbench.
149
150 =head2 fix tainting bugs
151
152 Fix the bugs revealed by running the test suite with the C<-t> switch (via
153 C<make test.taintwarn>).
154
155 =head2 Dual life everything
156
157 As part of the "dists" plan, anything that doesn't belong in the smallest perl
158 distribution needs to be dual lifed. Anything else can be too. Figure out what
159 changes would be needed to package that module and its tests up for CPAN, and
160 do so. Test it with older perl releases, and fix the problems you find.
161
162 To make a minimal perl distribution, it's useful to look at
163 F<t/lib/commonsense.t>.
164
165 =head2 Improving C<threads::shared>
166
167 Investigate whether C<threads::shared> could share aggregates properly with
168 only Perl level changes to shared.pm
169
170 =head2 POSIX memory footprint
171
172 Ilya observed that use POSIX; eats memory like there's no tomorrow, and at
173 various times worked to cut it down. There is probably still fat to cut out -
174 for example POSIX passes Exporter some very memory hungry data structures.
175
176 =head2 embed.pl/makedef.pl
177
178 There is a script F<embed.pl> that generates several header files to prefix
179 all of Perl's symbols in a consistent way, to provide some semblance of
180 namespace support in C<C>. Functions are declared in F<embed.fnc>, variables
181 in F<interpvar.h>. Quite a few of the functions and variables
182 are conditionally declared there, using C<#ifdef>. However, F<embed.pl>
183 doesn't understand the C macros, so the rules about which symbols are present
184 when is duplicated in F<makedef.pl>. Writing things twice is bad, m'kay.
185 It would be good to teach C<embed.pl> to understand the conditional
186 compilation, and hence remove the duplication, and the mistakes it has caused.
187
188 =head2 use strict; and AutoLoad
189
190 Currently if you write
191
192     package Whack;
193     use AutoLoader 'AUTOLOAD';
194     use strict;
195     1;
196     __END__
197     sub bloop {
198         print join (' ', No, strict, here), "!\n";
199     }
200
201 then C<use strict;> isn't in force within the autoloaded subroutines. It would
202 be more consistent (and less surprising) to arrange for all lexical pragmas
203 in force at the __END__ block to be in force within each autoloaded subroutine.
204
205 There's a similar problem with SelfLoader.
206
207 =head1 Tasks that need a little sysadmin-type knowledge
208
209 Or if you prefer, tasks that you would learn from, and broaden your skills
210 base...
211
212 =head2 make HTML install work
213
214 There is an C<installhtml> target in the Makefile. It's marked as
215 "experimental". It would be good to get this tested, make it work reliably, and
216 remove the "experimental" tag. This would include
217
218 =over 4
219
220 =item 1
221
222 Checking that cross linking between various parts of the documentation works.
223 In particular that links work between the modules (files with POD in F<lib/>)
224 and the core documentation (files in F<pod/>)
225
226 =item 2
227
228 Work out how to split C<perlfunc> into chunks, preferably one per function
229 group, preferably with general case code that could be used elsewhere.
230 Challenges here are correctly identifying the groups of functions that go
231 together, and making the right named external cross-links point to the right
232 page. Things to be aware of are C<-X>, groups such as C<getpwnam> to
233 C<endservent>, two or more C<=items> giving the different parameter lists, such
234 as
235
236     =item substr EXPR,OFFSET,LENGTH,REPLACEMENT
237     =item substr EXPR,OFFSET,LENGTH
238     =item substr EXPR,OFFSET
239
240 and different parameter lists having different meanings. (eg C<select>)
241
242 =back
243
244 =head2 compressed man pages
245
246 Be able to install them. This would probably need a configure test to see how
247 the system does compressed man pages (same directory/different directory?
248 same filename/different filename), as well as tweaking the F<installman> script
249 to compress as necessary.
250
251 =head2 Add a code coverage target to the Makefile
252
253 Make it easy for anyone to run Devel::Cover on the core's tests. The steps
254 to do this manually are roughly
255
256 =over 4
257
258 =item *
259
260 do a normal C<Configure>, but include Devel::Cover as a module to install
261 (see F<INSTALL> for how to do this)
262
263 =item *
264
265     make perl
266
267 =item *
268
269     cd t; HARNESS_PERL_SWITCHES=-MDevel::Cover ./perl -I../lib harness
270
271 =item *
272
273 Process the resulting Devel::Cover database
274
275 =back
276
277 This just give you the coverage of the F<.pm>s. To also get the C level
278 coverage you need to
279
280 =over 4
281
282 =item *
283
284 Additionally tell C<Configure> to use the appropriate C compiler flags for
285 C<gcov>
286
287 =item *
288
289     make perl.gcov
290
291 (instead of C<make perl>)
292
293 =item *
294
295 After running the tests run C<gcov> to generate all the F<.gcov> files.
296 (Including down in the subdirectories of F<ext/>
297
298 =item *
299
300 (From the top level perl directory) run C<gcov2perl> on all the C<.gcov> files
301 to get their stats into the cover_db directory.
302
303 =item *
304
305 Then process the Devel::Cover database
306
307 =back
308
309 It would be good to add a single switch to C<Configure> to specify that you
310 wanted to perform perl level coverage, and another to specify C level
311 coverage, and have C<Configure> and the F<Makefile> do all the right things
312 automatically.
313
314 =head2 Make Config.pm cope with differences between built and installed perl
315
316 Quite often vendors ship a perl binary compiled with their (pay-for)
317 compilers.  People install a free compiler, such as gcc. To work out how to
318 build extensions, Perl interrogates C<%Config>, so in this situation
319 C<%Config> describes compilers that aren't there, and extension building
320 fails. This forces people into choosing between re-compiling perl themselves
321 using the compiler they have, or only using modules that the vendor ships.
322
323 It would be good to find a way teach C<Config.pm> about the installation setup,
324 possibly involving probing at install time or later, so that the C<%Config> in
325 a binary distribution better describes the installed machine, when the
326 installed machine differs from the build machine in some significant way.
327
328 =head2 linker specification files
329
330 Some platforms mandate that you provide a list of a shared library's external
331 symbols to the linker, so the core already has the infrastructure in place to
332 do this for generating shared perl libraries. My understanding is that the
333 GNU toolchain can accept an optional linker specification file, and restrict
334 visibility just to symbols declared in that file. It would be good to extend
335 F<makedef.pl> to support this format, and to provide a means within
336 C<Configure> to enable it. This would allow Unix users to test that the
337 export list is correct, and to build a perl that does not pollute the global
338 namespace with private symbols.
339
340 =head2 Cross-compile support
341
342 Currently C<Configure> understands C<-Dusecrosscompile> option. This option
343 arranges for building C<miniperl> for TARGET machine, so this C<miniperl> is
344 assumed then to be copied to TARGET machine and used as a replacement of full
345 C<perl> executable.
346
347 This could be done little differently. Namely C<miniperl> should be built for
348 HOST and then full C<perl> with extensions should be compiled for TARGET.
349 This, however, might require extra trickery for %Config: we have one config
350 first for HOST and then another for TARGET.  Tools like MakeMaker will be
351 mightily confused.  Having around two different types of executables and
352 libraries (HOST and TARGET) makes life interesting for Makefiles and
353 shell (and Perl) scripts.  There is $Config{run}, normally empty, which
354 can be used as an execution wrapper.  Also note that in some
355 cross-compilation/execution environments the HOST and the TARGET do
356 not see the same filesystem(s), the $Config{run} may need to do some
357 file/directory copying back and forth.
358
359 =head2 roffitall
360
361 Make F<pod/roffitall> be updated by F<pod/buildtoc>.
362
363 =head1 Tasks that need a little C knowledge
364
365 These tasks would need a little C knowledge, but don't need any specific
366 background or experience with XS, or how the Perl interpreter works
367
368 =head2 Exterminate PL_na!
369
370 C<PL_na> festers still in the darkest corners of various typemap files.
371 It needs to be exterminated, replaced by a local variable of type C<STRLEN>.
372
373 =head2 Modernize the order of directories in @INC
374
375 The way @INC is laid out by default, one cannot upgrade core (dual-life)
376 modules without overwriting files. This causes problems for binary
377 package builders.  One possible proposal is laid out in this
378 message:
379 L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2002-04/msg02380.html>.
380
381 =head2 -Duse32bit*
382
383 Natively 64-bit systems need neither -Duse64bitint nor -Duse64bitall.
384 On these systems, it might be the default compilation mode, and there
385 is currently no guarantee that passing no use64bitall option to the
386 Configure process will build a 32bit perl. Implementing -Duse32bit*
387 options would be nice for perl 5.12.
388
389 =head2 Make it clear from -v if this is the exact official release
390
391 Currently perl from C<p4>/C<rsync> ships with a F<patchlevel.h> file that
392 usually defines one local patch, of the form "MAINT12345" or "RC1". The output
393 of perl -v doesn't report that a perl isn't an official release, and this
394 information can get lost in bugs reports. Because of this, the minor version
395 isn't bumped up until RC time, to minimise the possibility of versions of perl
396 escaping that believe themselves to be newer than they actually are.
397
398 It would be useful to find an elegant way to have the "this is an interim
399 maintenance release" or "this is a release candidate" in the terse -v output,
400 and have it so that it's easy for the pumpking to remove this just as the
401 release tarball is rolled up. This way the version pulled out of rsync would
402 always say "I'm a development release" and it would be safe to bump the
403 reported minor version as soon as a release ships, which would aid perl
404 developers.
405
406 This task is really about thinking of an elegant way to arrange the C source
407 such that it's trivial for the Pumpking to flag "this is an official release"
408 when making a tarball, yet leave the default source saying "I'm not the
409 official release".
410
411 =head2 Profile Perl - am I hot or not?
412
413 The Perl source code is stable enough that it makes sense to profile it,
414 identify and optimise the hotspots. It would be good to measure the
415 performance of the Perl interpreter using free tools such as cachegrind,
416 gprof, and dtrace, and work to reduce the bottlenecks they reveal.
417
418 As part of this, the idea of F<pp_hot.c> is that it contains the I<hot> ops,
419 the ops that are most commonly used. The idea is that by grouping them, their
420 object code will be adjacent in the executable, so they have a greater chance
421 of already being in the CPU cache (or swapped in) due to being near another op
422 already in use.
423
424 Except that it's not clear if these really are the most commonly used ops. So
425 as part of exercising your skills with coverage and profiling tools you might
426 want to determine what ops I<really> are the most commonly used. And in turn
427 suggest evictions and promotions to achieve a better F<pp_hot.c>.
428
429 =head2 Allocate OPs from arenas
430
431 Currently all new OP structures are individually malloc()ed and free()d.
432 All C<malloc> implementations have space overheads, and are now as fast as
433 custom allocates so it would both use less memory and less CPU to allocate
434 the various OP structures from arenas. The SV arena code can probably be
435 re-used for this.
436
437 Note that Configuring perl with C<-Accflags=-DPL_OP_SLAB_ALLOC> will use
438 Perl_Slab_alloc() to pack optrees into a contiguous block, which is
439 probably superior to the use of OP arenas, esp. from a cache locality
440 standpoint.  See L<Profile Perl - am I hot or not?>.
441
442 =head2 Improve win32/wince.c
443
444 Currently, numerous functions look virtually, if not completely,
445 identical in both C<win32/wince.c> and C<win32/win32.c> files, which can't
446 be good.
447
448 =head2 Use secure CRT functions when building with VC8 on Win32
449
450 Visual C++ 2005 (VC++ 8.x) deprecated a number of CRT functions on the basis
451 that they were "unsafe" and introduced differently named secure versions of
452 them as replacements, e.g. instead of writing
453
454     FILE* f = fopen(__FILE__, "r");
455
456 one should now write
457
458     FILE* f;
459     errno_t err = fopen_s(&f, __FILE__, "r"); 
460
461 Currently, the warnings about these deprecations have been disabled by adding
462 -D_CRT_SECURE_NO_DEPRECATE to the CFLAGS. It would be nice to remove that
463 warning suppressant and actually make use of the new secure CRT functions.
464
465 There is also a similar issue with POSIX CRT function names like fileno having
466 been deprecated in favour of ISO C++ conformant names like _fileno. These
467 warnings are also currently suppressed by adding -D_CRT_NONSTDC_NO_DEPRECATE. It
468 might be nice to do as Microsoft suggest here too, although, unlike the secure
469 functions issue, there is presumably little or no benefit in this case.
470
471 =head2 __FUNCTION__ for MSVC-pre-7.0
472
473 Jarkko notes that one can things morally equivalent to C<__FUNCTION__>
474 (or C<__func__>) even in MSVC-pre-7.0, contrary to popular belief.
475 See L<http://www.codeproject.com/debug/extendedtrace.asp> if you feel like
476 making C<PERL_MEM_LOG> more useful on Win32.
477
478 =head2 strcat(), strcpy(), strncat(), strncpy(), sprintf(), vsprintf()
479
480 Maybe create a utility that checks after each libperl.a creation that
481 none of the above (nor sprintf(), vsprintf(), or *SHUDDER* gets())
482 ever creep back to libperl.a.
483
484   nm libperl.a | ./miniperl -alne '$o = $F[0] if /:$/; print "$o $F[1]" if $F[0] eq "U" && $F[1] =~ /^(?:strn?c(?:at|py)|v?sprintf|gets)$/'
485
486 Note, of course, that this will only tell whether B<your> platform
487 is using those naughty interfaces.
488
489
490 =head1 Tasks that need a knowledge of XS
491
492 These tasks would need C knowledge, and roughly the level of knowledge of
493 the perl API that comes from writing modules that use XS to interface to
494 C.
495
496 =head2 autovivification
497
498 Make all autovivification consistent w.r.t LVALUE/RVALUE and strict/no strict;
499
500 This task is incremental - even a little bit of work on it will help.
501
502 =head2 Unicode in Filenames
503
504 chdir, chmod, chown, chroot, exec, glob, link, lstat, mkdir, open,
505 opendir, qx, readdir, readlink, rename, rmdir, stat, symlink, sysopen,
506 system, truncate, unlink, utime, -X.  All these could potentially accept
507 Unicode filenames either as input or output (and in the case of system
508 and qx Unicode in general, as input or output to/from the shell).
509 Whether a filesystem - an operating system pair understands Unicode in
510 filenames varies.
511
512 Known combinations that have some level of understanding include
513 Microsoft NTFS, Apple HFS+ (In Mac OS 9 and X) and Apple UFS (in Mac
514 OS X), NFS v4 is rumored to be Unicode, and of course Plan 9.  How to
515 create Unicode filenames, what forms of Unicode are accepted and used
516 (UCS-2, UTF-16, UTF-8), what (if any) is the normalization form used,
517 and so on, varies.  Finding the right level of interfacing to Perl
518 requires some thought.  Remember that an OS does not implicate a
519 filesystem.
520
521 (The Windows -C command flag "wide API support" has been at least
522 temporarily retired in 5.8.1, and the -C has been repurposed, see
523 L<perlrun>.)
524
525 Most probably the right way to do this would be this:
526 L</"Virtualize operating system access">.
527
528 =head2 Unicode in %ENV
529
530 Currently the %ENV entries are always byte strings.
531 See L</"Virtualize operating system access">.
532
533 =head2 Unicode and glob()
534
535 Currently glob patterns and filenames returned from File::Glob::glob()
536 are always byte strings.  See L</"Virtualize operating system access">.
537
538 =head2 Unicode and lc/uc operators
539
540 Some built-in operators (C<lc>, C<uc>, etc.) behave differently, based on
541 what the internal encoding of their argument is. That should not be the
542 case. Maybe add a pragma to switch behaviour.
543
544 =head2 use less 'memory'
545
546 Investigate trade offs to switch out perl's choices on memory usage.
547 Particularly perl should be able to give memory back.
548
549 This task is incremental - even a little bit of work on it will help.
550
551 =head2 Re-implement C<:unique> in a way that is actually thread-safe
552
553 The old implementation made bad assumptions on several levels. A good 90%
554 solution might be just to make C<:unique> work to share the string buffer
555 of SvPVs. That way large constant strings can be shared between ithreads,
556 such as the configuration information in F<Config>.
557
558 =head2 Make tainting consistent
559
560 Tainting would be easier to use if it didn't take documented shortcuts and
561 allow taint to "leak" everywhere within an expression.
562
563 =head2 readpipe(LIST)
564
565 system() accepts a LIST syntax (and a PROGRAM LIST syntax) to avoid
566 running a shell. readpipe() (the function behind qx//) could be similarly
567 extended.
568
569 =head2 Audit the code for destruction ordering assumptions
570
571 Change 25773 notes
572
573     /* Need to check SvMAGICAL, as during global destruction it may be that
574        AvARYLEN(av) has been freed before av, and hence the SvANY() pointer
575        is now part of the linked list of SV heads, rather than pointing to
576        the original body.  */
577     /* FIXME - audit the code for other bugs like this one.  */
578
579 adding the C<SvMAGICAL> check to
580
581     if (AvARYLEN(av) && SvMAGICAL(AvARYLEN(av))) {
582         MAGIC *mg = mg_find (AvARYLEN(av), PERL_MAGIC_arylen);
583
584 Go through the core and look for similar assumptions that SVs have particular
585 types, as all bets are off during global destruction.
586
587 =head2 Extend PerlIO and PerlIO::Scalar
588
589 PerlIO::Scalar doesn't know how to truncate().  Implementing this
590 would require extending the PerlIO vtable.
591
592 Similarly the PerlIO vtable doesn't know about formats (write()), or
593 about stat(), or chmod()/chown(), utime(), or flock().
594
595 (For PerlIO::Scalar it's hard to see what e.g. mode bits or ownership
596 would mean.)
597
598 PerlIO doesn't do directories or symlinks, either: mkdir(), rmdir(),
599 opendir(), closedir(), seekdir(), rewinddir(), glob(); symlink(),
600 readlink().
601
602 See also L</"Virtualize operating system access">.
603
604 =head2 -C on the #! line
605
606 It should be possible to make -C work correctly if found on the #! line,
607 given that all perl command line options are strict ASCII, and -C changes
608 only the interpretation of non-ASCII characters, and not for the script file
609 handle. To make it work needs some investigation of the ordering of function
610 calls during startup, and (by implication) a bit of tweaking of that order.
611
612 =head2 Propagate const outwards from Perl_moreswitches()
613
614 Change 32057 changed the parameter and return value of C<Perl_moreswitches()>
615 from <char *> to <const char *>. It should now be possible to propagate
616 const-correctness outwards to C<S_parse_body()>, C<Perl_moreswitches()>
617 and C<Perl_yylex()>.
618
619 =head2 Duplicate logic in S_method_common() and Perl_gv_fetchmethod_autoload()
620
621 A comment in C<S_method_common> notes
622
623         /* This code tries to figure out just what went wrong with
624            gv_fetchmethod.  It therefore needs to duplicate a lot of
625            the internals of that function.  We can't move it inside
626            Perl_gv_fetchmethod_autoload(), however, since that would
627            cause UNIVERSAL->can("NoSuchPackage::foo") to croak, and we
628            don't want that.
629         */
630
631 If C<Perl_gv_fetchmethod_autoload> gets rewritten to take (more) flag bits,
632 then it ought to be possible to move the logic from C<S_method_common> to
633 the "right" place. When making this change it would probably be good to also
634 pass in at least the method name length, if not also pre-computed hash values
635 when known. (I'm contemplating a plan to pre-compute hash values for common
636 fixed strings such as C<ISA> and pass them in to functions.)
637
638 =head2 Organize error messages
639
640 Perl's diagnostics (error messages, see L<perldiag>) could use
641 reorganizing so that each error message has its
642 stable-for-all-eternity unique id, categorized by severity, type, and
643 subsystem.  (The error messages would be listed in a datafile outside
644 of the Perl source code, and the source code would only refer the
645 messages by the is.)  This clean-up and regularizing should apply
646 for all croak() messages.
647
648 This would enable all sorts of things: easier translation/localization
649 of the messages (though please do keep in mind the caveats of
650 L<Locale::Maketext> about too straightforward approaches to
651 translation), filtering by severity, and instead of grepping for a
652 particular error message one could look for a stable error id.  (Of
653 course, changing the error messages by default would break all the
654 existing software depending on some particular error message...)
655
656 This kind of functionality is known as I<message catalogs>.  Look for
657 inspiration for example in the catgets() system, possibly even use it
658 if available-- but B<only> if available, all platforms will B<not>
659 catgets().
660
661 For the really pure at heart, consider extending this item to cover
662 also the warning messages (see L<perllexwarn>, C<warnings.pl>).
663
664 =head1 Tasks that need a knowledge of the interpreter
665
666 These tasks would need C knowledge, and knowledge of how the interpreter works,
667 or a willingness to learn.
668
669 =head2 state variable initialization in list context
670
671 Currently this is illegal:
672
673     state ($a, $b) = foo(); 
674
675 The current Perl 6 design is that C<state ($a) = foo();> and
676 C<(state $a) = foo();> have different semantics, which is tricky to implement
677 in Perl 5 as currently the produce the same opcode trees. It would be useful
678 to clarify that the Perl 6 design is firm, and then implement the necessary
679 code in Perl 5. There are comments in C<Perl_newASSIGNOP()> that show the
680 code paths taken by various assignment constructions involving state variables.
681
682 =head2 Implement $value ~~ 0 .. $range
683
684 It would be nice to extend the syntax of the C<~~> operator to also
685 understand numeric (and maybe alphanumeric) ranges.
686
687 =head2 A does() built-in
688
689 Like ref(), only useful. It would call the C<DOES> method on objects; it
690 would also tell whether something can be dereferenced as an
691 array/hash/etc., or used as a regexp, etc.
692 L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-03/msg00481.html>
693
694 =head2 Tied filehandles and write() don't mix
695
696 There is no method on tied filehandles to allow them to be called back by
697 formats.
698
699 =head2 Attach/detach debugger from running program
700
701 The old perltodo notes "With C<gdb>, you can attach the debugger to a running
702 program if you pass the process ID. It would be good to do this with the Perl
703 debugger on a running Perl program, although I'm not sure how it would be
704 done." ssh and screen do this with named pipes in /tmp. Maybe we can too.
705
706 =head2 Optimize away empty destructors
707
708 Defining an empty DESTROY method might be useful (notably in
709 AUTOLOAD-enabled classes), but it's still a bit expensive to call. That
710 could probably be optimized.
711
712 =head2 LVALUE functions for lists
713
714 The old perltodo notes that lvalue functions don't work for list or hash
715 slices. This would be good to fix.
716
717 =head2 LVALUE functions in the debugger
718
719 The old perltodo notes that lvalue functions don't work in the debugger. This
720 would be good to fix.
721
722 =head2 regexp optimiser optional
723
724 The regexp optimiser is not optional. It should configurable to be, to allow
725 its performance to be measured, and its bugs to be easily demonstrated.
726
727 =head2 delete &function
728
729 Allow to delete functions. One can already undef them, but they're still
730 in the stash.
731
732 =head2 C</w> regex modifier
733
734 That flag would enable to match whole words, and also to interpolate
735 arrays as alternations. With it, C</P/w> would be roughly equivalent to:
736
737     do { local $"='|'; /\b(?:P)\b/ }
738
739 See L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-01/msg00400.html>
740 for the discussion.
741
742 =head2 optional optimizer
743
744 Make the peephole optimizer optional. Currently it performs two tasks as
745 it walks the optree - genuine peephole optimisations, and necessary fixups of
746 ops. It would be good to find an efficient way to switch out the
747 optimisations whilst keeping the fixups.
748
749 =head2 You WANT *how* many
750
751 Currently contexts are void, scalar and list. split has a special mechanism in
752 place to pass in the number of return values wanted. It would be useful to
753 have a general mechanism for this, backwards compatible and little speed hit.
754 This would allow proposals such as short circuiting sort to be implemented
755 as a module on CPAN.
756
757 =head2 lexical aliases
758
759 Allow lexical aliases (maybe via the syntax C<my \$alias = \$foo>.
760
761 =head2 entersub XS vs Perl
762
763 At the moment pp_entersub is huge, and has code to deal with entering both
764 perl and XS subroutines. Subroutine implementations rarely change between 
765 perl and XS at run time, so investigate using 2 ops to enter subs (one for
766 XS, one for perl) and swap between if a sub is redefined.
767
768 =head2 Self ties
769
770 self ties are currently illegal because they caused too many segfaults. Maybe
771 the causes of these could be tracked down and self-ties on all types re-
772 instated.
773
774 =head2 Optimize away @_
775
776 The old perltodo notes "Look at the "reification" code in C<av.c>".
777
778 =head2 Properly Unicode safe tokeniser and pads.
779
780 The tokeniser isn't actually very UTF-8 clean. C<use utf8;> is a hack -
781 variable names are stored in stashes as raw bytes, without the utf-8 flag
782 set. The pad API only takes a C<char *> pointer, so that's all bytes too. The
783 tokeniser ignores the UTF-8-ness of C<PL_rsfp>, or any SVs returned from
784 source filters.  All this could be fixed.
785
786 =head2 The yada yada yada operators
787
788 Perl 6's Synopsis 3 says:
789
790 I<The ... operator is the "yada, yada, yada" list operator, which is used as
791 the body in function prototypes. It complains bitterly (by calling fail)
792 if it is ever executed. Variant ??? calls warn, and !!! calls die.>
793
794 Those would be nice to add to Perl 5. That could be done without new ops.
795
796 =head2 Virtualize operating system access
797
798 Implement a set of "vtables" that virtualizes operating system access
799 (open(), mkdir(), unlink(), readdir(), getenv(), etc.)  At the very
800 least these interfaces should take SVs as "name" arguments instead of
801 bare char pointers; probably the most flexible and extensible way
802 would be for the Perl-facing interfaces to accept HVs.  The system
803 needs to be per-operating-system and per-file-system
804 hookable/filterable, preferably both from XS and Perl level
805 (L<perlport/"Files and Filesystems"> is good reading at this point,
806 in fact, all of L<perlport> is.)
807
808 This has actually already been implemented (but only for Win32),
809 take a look at F<iperlsys.h> and F<win32/perlhost.h>.  While all Win32
810 variants go through a set of "vtables" for operating system access,
811 non-Win32 systems currently go straight for the POSIX/UNIX-style
812 system/library call.  Similar system as for Win32 should be
813 implemented for all platforms.  The existing Win32 implementation
814 probably does not need to survive alongside this proposed new
815 implementation, the approaches could be merged.
816
817 What would this give us?  One often-asked-for feature this would
818 enable is using Unicode for filenames, and other "names" like %ENV,
819 usernames, hostnames, and so forth.
820 (See L<perlunicode/"When Unicode Does Not Happen">.)
821
822 But this kind of virtualization would also allow for things like
823 virtual filesystems, virtual networks, and "sandboxes" (though as long
824 as dynamic loading of random object code is allowed, not very safe
825 sandboxes since external code of course know not of Perl's vtables).
826 An example of a smaller "sandbox" is that this feature can be used to
827 implement per-thread working directories: Win32 already does this.
828
829 See also L</"Extend PerlIO and PerlIO::Scalar">.
830
831 =head2 Investigate PADTMP hash pessimisation
832
833 The peephole optimier converts constants used for hash key lookups to shared
834 hash key scalars. Under ithreads, something is undoing this work. See
835 See http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2007-09/msg00793.html
836
837 =head1 Big projects
838
839 Tasks that will get your name mentioned in the description of the "Highlights
840 of 5.12"
841
842 =head2 make ithreads more robust
843
844 Generally make ithreads more robust. See also L</iCOW>
845
846 This task is incremental - even a little bit of work on it will help, and
847 will be greatly appreciated.
848
849 One bit would be to write the missing code in sv.c:Perl_dirp_dup.
850
851 Fix Perl_sv_dup, et al so that threads can return objects.
852
853 =head2 iCOW
854
855 Sarathy and Arthur have a proposal for an improved Copy On Write which
856 specifically will be able to COW new ithreads. If this can be implemented
857 it would be a good thing.
858
859 =head2 (?{...}) closures in regexps
860
861 Fix (or rewrite) the implementation of the C</(?{...})/> closures.
862
863 =head2 A re-entrant regexp engine
864
865 This will allow the use of a regex from inside (?{ }), (??{ }) and
866 (?(?{ })|) constructs.
867
868 =head2 Add class set operations to regexp engine
869
870 Apparently these are quite useful. Anyway, Jeffery Friedl wants them.
871
872 demerphq has this on his todo list, but right at the bottom.