X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/78c9d76351ef2d0f7047846bbf29e303753d3fda..c0bce9aa45a3d3e9c7a6fd9886d453d0ab22e69d:/autodoc.pl diff --git a/autodoc.pl b/autodoc.pl index c898c85..5317bc6 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -3,8 +3,12 @@ require 5.003; # keep this compatible, an old perl is all we may have before # we build the new one -BEGIN { push @INC, 'lib' } # glob() below requires File::Glob +BEGIN { + push @INC, 'lib'; + require 'regen_lib.pl'; +} +use strict; # # See database of global and static function prototypes in embed.fnc @@ -28,7 +32,9 @@ sub walk_table (&@) { $F = $filename; } else { + safer_unlink $filename; open F, ">$filename" or die "Can't open $filename: $!"; + binmode F; $F = \*F; } print $F $leader if $leader; @@ -40,6 +46,7 @@ sub walk_table (&@) { $_ .= ; chomp; } + s/\s+$//; my @args; if (/^\s*(#|$)/) { @args = $_; @@ -47,15 +54,19 @@ sub walk_table (&@) { else { @args = split /\s*\|\s*/, $_; } + s/\b(NN|NULLOK)\b\s+//g for @args; print $F $function->(@args); } print $F $trailer if $trailer; - close $F unless ref $filename; + unless (ref $filename) { + close $F or die "Error closing $filename: $!"; + } } my %apidocs; my %gutsdocs; my %docfuncs; +my %seenfuncs; my $curheader = "Unknown section"; @@ -76,10 +87,6 @@ FUNC: my $docs = ""; DOC: while (defined($doc = <$fh>)) { - if ($doc =~ /^=head1 (.*)/) { - $curheader = $1; - next DOC; - } $line++; last DOC if $doc =~ /^=\w+/; if ($doc =~ m:^\*/$:) { @@ -101,7 +108,7 @@ DOC: $docfuncs{$name} = [$flags, $docs, $ret, $file, $curheader, @args]; } if (defined $doc) { - if ($doc =~ /^=for/) { + if ($doc =~ /^=(?:for|head)/) { $in = $doc; redo FUNC; } @@ -115,13 +122,14 @@ DOC: sub docout ($$$) { # output the docs for one function my($fh, $name, $docref) = @_; my($flags, $docs, $ret, $file, @args) = @$docref; + $name =~ s/\s*$//; $docs .= "NOTE: this function is experimental and may change or be removed without notice.\n\n" if $flags =~ /x/; $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n" if $flags =~ /p/; - print $fh "=item $name\n$docs"; + print $fh "=item $name\nX<$name>\n$docs"; if ($flags =~ /U/) { # no usage # nothing @@ -137,38 +145,69 @@ removed without notice.\n\n" if $flags =~ /x/; print $fh "=for hackers\nFound in file $file\n\n"; } +sub readonly_header (*) { + my $fh = shift; + print $fh <<"_EOH_"; +-*- buffer-read-only: t -*- + +!!!!!!! DO NOT EDIT THIS FILE !!!!!!! +This file is built by $0 extracting documentation from the C source +files. + +_EOH_ +} + +sub readonly_footer (*) { + my $fh = shift; + print $fh <<'_EOF_'; +=cut + + ex: set ro: +_EOF_ +} + my $file; -for $file (glob('*.c'), glob('*.h')) { +# glob() picks up docs from extra .c or .h files that may be in unclean +# development trees. +my $MANIFEST = do { + local ($/, *FH); + open FH, "MANIFEST" or die "Can't open MANIFEST: $!"; + ; +}; + +for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) { open F, "< $file" or die "Cannot open $file for docs: $!\n"; $curheader = "Functions in file $file\n"; autodoc(\*F,$file); close F or die "Error closing $file: $!\n"; } -unlink "pod/perlapi.pod"; +safer_unlink "pod/perlapi.pod"; open (DOC, ">pod/perlapi.pod") or die "Can't create pod/perlapi.pod: $!\n"; +binmode DOC; -walk_table { # load documented functions into approriate hash +walk_table { # load documented functions into appropriate hash if (@_ > 1) { my($flags, $retval, $func, @args) = @_; return "" unless $flags =~ /d/; $func =~ s/\t//g; $flags =~ s/p//; # clean up fields from embed.pl $retval =~ s/\t//; my $docref = delete $docfuncs{$func}; + $seenfuncs{$func} = 1; if ($docref and @$docref) { if ($flags =~ /A/) { $docref->[0].="x" if $flags =~ /M/; - $apidocs{$docref->[4]}{$func} = - [$docref->[0] . 'A', $docref->[1], $retval, - $docref->[3], @args]; + $apidocs{$docref->[4]}{$func} = + [$docref->[0] . 'A', $docref->[1], $retval, $docref->[3], + @args]; } else { - $gutsdocs{$docref->[4]}{$func} = + $gutsdocs{$docref->[4]}{$func} = [$docref->[0], $docref->[1], $retval, $docref->[3], @args]; } } else { - warn "no docs for $func\n" unless $docref and @$docref; + warn "no docs for $func\n" unless $seenfuncs{$func}; } } return ""; @@ -180,12 +219,15 @@ for (sort keys %docfuncs) { warn "Unable to place $_!\n"; } +readonly_header(\*DOC); + print DOC <<'_EOB_'; =head1 NAME perlapi - autogenerated documentation for the perl public API =head1 DESCRIPTION +X X X This file contains the documentation of the perl public API generated by embed.pl, specifically a listing of functions, macros, flags, and variables @@ -203,10 +245,12 @@ The listing is alphabetical, case insensitive. _EOB_ my $key; -for $key (sort { uc($a) cmp uc($b); } keys %apidocs) { # case insensitive sort +# case insensitive sort, with fallback for determinacy +for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %apidocs) { my $section = $apidocs{$key}; print DOC "\n=head1 $key\n\n=over 8\n\n"; - for my $key (sort { uc($a) cmp uc($b); } keys %$section) { + # Again, fallback for determinacy + for my $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$section) { docout(\*DOC, $key, $section->{$key}); } print DOC "\n=back\n"; @@ -234,11 +278,15 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1) _EOE_ +readonly_footer(\*DOC); -close(DOC); +close(DOC) or die "Error closing pod/perlapi.pod: $!"; +safer_unlink "pod/perlintern.pod"; open(GUTS, ">pod/perlintern.pod") or die "Unable to create pod/perlintern.pod: $!\n"; +binmode GUTS; +readonly_header(\*GUTS); print GUTS <<'END'; =head1 NAME @@ -246,6 +294,7 @@ perlintern - autogenerated documentation of purely B Perl functions =head1 DESCRIPTION +X X This file is the autogenerated documentation of functions in the Perl interpreter that are documented using Perl's internal documentation @@ -276,6 +325,6 @@ document their functions. perlguts(1), perlapi(1) END +readonly_footer(\*GUTS); -close GUTS; - +close GUTS or die "Error closing pod/perlintern.pod: $!";