4 use File::Basename qw(&basename &dirname);
7 # List explicitly here the variables you want Configure to
8 # generate. Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries. Thus you write
12 # to ensure Configure will look for $Config{startperl}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 ($file = basename($0)) =~ s/\.PL$//;
19 $file =~ s/\.pl$// if ($^O eq 'os2' or $^O eq 'dos'); # "case-forgiving"
20 $file =~ s/\.pl$/.com/ if ($^O eq 'VMS'); # "case-forgiving"
22 open OUT,">$file" or die "Can't create $file: $!";
24 print "Extracting $file (with variable substitutions)\n";
26 # In this section, perl variables will be expanded during extraction.
27 # You can use $Config{...} to use Configure variables.
29 print OUT <<"!GROK!THIS!";
31 eval 'exec perl -S \$0 "\$@"'
35 # In the following, perl variables are not expanded during extraction.
37 print OUT <<'!NO!SUBS!';
42 # !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
43 # This file is autogenerated by buildtoc.PL.
44 # Edit that file and run it to effect changes.
46 # Builds perltoc.pod and sanity checks the list of pods against all
47 # of the MANIFEST, perl.pod, and ourselves.
54 @PODS = glob("*.pod");
59 die "$0: failed to chdir('pod'): $!\n" unless chdir("pod");
217 for (@ARCHPODS) { s/$/.pod/ }
218 @ARCHPODS{@ARCHPODS} = ();
220 for (@CJKPODS) { s/$/.pod/ }
221 @CJKPODS{@CJKPODS} = ();
223 for (@pods) { s/$/.pod/ }
227 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
229 if (m!^pod/([^.]+\.pod)\s+!i) {
234 @MANIPODS{@MANIPODS} = ();
236 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
238 if (/^For ease of access, /../^\(If you're intending /) {
239 if (/^\s+(perl\S*)\s+\w/) {
240 push @PERLPODS, "$1.pod";
245 die "$0: could not find the pod listing of perl.pod\n"
247 @PERLPODS{@PERLPODS} = ();
249 # Delete the CJK because we cannot mix their encodings.
250 delete @PERLPODS{@CJKPODS};
251 delete @PODS{@CJKPODS};
252 delete @pods{@CJKPODS};
254 # Cross-check against ourselves
255 # Cross-check against the MANIFEST
256 # Cross-check against the perl.pod
258 foreach my $i (sort keys %PODS) {
259 warn "$0: $i exists but is unknown by buildtoc\n"
260 unless exists $pods{$i};
261 warn "$0: $i exists but is unknown by ../MANIFEST\n"
262 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i} && !exists $CJKPODS{$i};
263 warn "$0: $i exists but is unknown by perl.pod\n"
264 unless exists $PERLPODS{$i};
266 foreach my $i (sort keys %pods) {
267 warn "$0: $i is known by buildtoc but does not exist\n"
268 unless exists $PODS{$i};
270 foreach my $i (sort keys %MANIPODS) {
271 warn "$0: $i is known by ../MANIFEST but does not exist\n"
272 unless exists $PODS{$i};
274 foreach my $i (sort keys %PERLPODS) {
275 warn "$0: $i is known by perl.pod but does not exist\n"
276 unless exists $PODS{$i};
279 # We are ready to rock.
280 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
285 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
289 perltoc - perl documentation table of contents
293 This page provides a brief table of contents for the rest of the Perl
294 documentation set. It is meant to be scanned quickly or grepped
295 through to locate the proper section you're looking for.
297 =head1 BASIC DOCUMENTATION
304 find \&getpods => qw(../lib ../ext);
308 my $file = $File::Find::name;
309 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
310 return if $file =~ m!lib/Attribute/Handlers/demo/!;
311 return if $file =~ m!lib/Net/FTP/.+\.pm!; # Hi, Graham! :-)
312 return if $file =~ m!lib/Math/BigInt/t/!;
313 return if $file =~ m!/Devel/PPPort/[Hh]arness|lib/Devel/Harness!i;
314 return if $file =~ m!XS/(?:APItest|Typemap)!;
315 die "tut $name" if $file =~ /TUT/;
316 unless (open (F, "< $_\0")) {
317 warn "bogus <$file>: $!";
318 system "ls", "-l", $file;
322 while ($line = <F>) {
323 if ($line =~ /^=head1\s+NAME\b/) {
324 push @modpods, $file;
325 #warn "GOOD $file\n";
329 warn "$0: $file: cannot find =head1 NAME\n";
334 die "no pods" unless @modpods;
337 #($name) = /(\w+)\.p(m|od)$/;
338 $name = path2modname($_);
339 if ($name =~ /^[a-z]/) {
342 if ($done{$name}++) {
343 # warn "already did $_\n";
347 push @modname, $name;
351 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
355 =head1 PRAGMA DOCUMENTATION
359 podset(sort @pragmata);
361 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
365 =head1 MODULE DOCUMENTATION
369 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
371 ($_= <<EOPOD2B) =~ s/^\t//gm;
374 =head1 AUXILIARY DOCUMENTATION
376 Here should be listed all the extra programs' documentation, but they
377 don't all have manual pages yet:
403 Larry Wall <F<larry\@wall.org>>, with the help of oodles
409 output "\n"; # flush $LINE
416 if (s/^=head1 (NAME)\s*/=head2 /) {
417 $pod = path2modname($ARGV);
419 output "\n \n\n=head2 ";
421 if ( /^\s*$pod\b/ ) {
422 s/$pod\.pm/$pod/; # '.pm' in NAME !?
430 if (s/^=head1 (.*)/=item $1/) {
432 output "=over 4\n\n" unless $inhead1;
434 output $_; nl(); next;
436 if (s/^=head2 (.*)/=item $1/) {
438 output "=over 4\n\n" unless $inhead2;
440 output $_; nl(); next;
442 if (s/^=item ([^=].*)/$1/) {
443 next if $pod eq 'perldiag';
444 s/^\s*\*\s*$// && next;
449 next if $pod eq 'perlmodlib' && /^ftp:/;
450 ##print "=over 4\n\n" unless $initem;
451 output ", " if $initem;
457 if (s/^=cut\s*\n//) {
476 output "\n\n=back\n\n";
484 output "\n\n=back\n\n";
492 ##print "\n\n=back\n\n";
501 my $NEWLINE; # how many newlines have we seen recently
502 my $LINE; # what remains to be printed
505 for (split /(\n)/, shift) {
508 print OUT wrap('', '', $LINE);
516 elsif (/\S/ && length) {
525 close OUT or die "Can't close $file: $!";
526 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
527 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';