#!/usr/bin/perl -w
-
-require 5.003; # keep this compatible, an old perl is all we may have before
- # we build the new one
-
-BEGIN {
- push @INC, 'lib';
- require 'regen_lib.pl';
-}
+#
+# Unconditionally regenerate:
+#
+# pod/perlintern.pod
+# pod/perlapi.pod
+#
+# from information stored in
+#
+# embed.fnc
+# plus all the .c and .h files listed in MANIFEST
+#
+# Has an optional arg, which is the directory to chdir to before reading
+# MANIFEST and *.[ch].
+#
+# This script is normally invoked as part of 'make all', but is also
+# called from from regen.pl.
use strict;
# implicit interpreter context argument.
#
-my %apidocs;
-my %gutsdocs;
-my %docfuncs;
-my %seenfuncs;
+my %docs;
+my %funcflags;
+my %macro = (
+ ax => 1,
+ items => 1,
+ ix => 1,
+ svtype => 1,
+ );
+my %missing;
my $curheader = "Unknown section";
my($in, $doc, $line);
FUNC:
while (defined($in = <$fh>)) {
+ if ($in =~ /^#\s*define\s+([A-Za-z_][A-Za-z_0-9]+)\(/ &&
+ ($file ne 'embed.h' || $file ne 'proto.h')) {
+ $macro{$1} = $file;
+ next FUNC;
+ }
if ($in=~ /^=head1 (.*)/) {
$curheader = $1;
next FUNC;
$docs .= $doc;
}
$docs = "\n$docs" if $docs and $docs !~ /^\n/;
+
+ # Check the consistency of the flags
+ my ($embed_where, $inline_where);
+ my ($embed_may_change, $inline_may_change);
+
+ my $docref = delete $funcflags{$name};
+ if ($docref and %$docref) {
+ $embed_where = $docref->{flags} =~ /A/ ? 'api' : 'guts';
+ $embed_may_change = $docref->{flags} =~ /M/;
+ } else {
+ $missing{$name} = $file;
+ }
if ($flags =~ /m/) {
- if ($flags =~ /A/) {
- $apidocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
+ $inline_where = $flags =~ /A/ ? 'api' : 'guts';
+ $inline_may_change = $flags =~ /x/;
+
+ if (defined $embed_where && $inline_where ne $embed_where) {
+ warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
}
- else {
- $gutsdocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
+
+ if (defined $embed_may_change
+ && $inline_may_change ne $embed_may_change) {
+ my $message = "Function '$name' inconsistency: ";
+ if ($embed_may_change) {
+ $message .= "embed.fnc says 'may change', Pod does not";
+ } else {
+ $message .= "Pod says 'may change', embed.fnc does not";
+ }
+ warn $message;
}
+ } elsif (!defined $embed_where) {
+ warn "Unable to place $name!\n";
+ next;
+ } else {
+ $inline_where = $embed_where;
+ $flags .= 'x' if $embed_may_change;
+ @args = @{$docref->{args}};
+ $ret = $docref->{retval};
}
- else {
- $docfuncs{$name} = [$flags, $docs, $ret, $file, $curheader, @args];
- }
+
+ $docs{$inline_where}{$curheader}{$name}
+ = [$flags, $docs, $ret, $file, @args];
+
if (defined $doc) {
if ($doc =~ /^=(?:for|head)/) {
$in = $doc;
print $fh "=for hackers\nFound in file $file\n\n";
}
-sub readonly_header (*) {
- my $fh = shift;
- print $fh <<"_EOH_";
+sub output {
+ my ($podname, $header, $dochash, $footer) = @_;
+ my $filename = "pod/$podname.pod";
+ open my $fh, '>', $filename or die "Can't open $filename: $!";
+
+ print $fh <<"_EOH_", $header;
-*- buffer-read-only: t -*-
!!!!!!! DO NOT EDIT THIS FILE !!!!!!!
files.
_EOH_
-}
-sub readonly_footer (*) {
- my $fh = shift;
- print $fh <<'_EOF_';
+ my $key;
+ # case insensitive sort, with fallback for determinacy
+ for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$dochash) {
+ my $section = $dochash->{$key};
+ print $fh "\n=head1 $key\n\n=over 8\n\n";
+ # Again, fallback for determinacy
+ for my $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$section) {
+ docout($fh, $key, $section->{$key});
+ }
+ print $fh "\n=back\n";
+ }
+
+ print $fh $footer, <<'_EOF_';
=cut
ex: set ro:
_EOF_
-}
-my $file;
-# 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: $!";
- <FH>;
-};
-
-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";
+ close $fh or die "Can't close $filename: $!";
}
-safer_unlink "pod/perlapi.pod";
-my $doc = safer_open("pod/perlapi.pod");
+if (@ARGV) {
+ my $workdir = shift;
+ chdir $workdir
+ or die "Couldn't chdir to '$workdir': $!";
+}
open IN, "embed.fnc" or die $!;
-# walk table providing an array of components in each line to
-# subroutine, printing the result
-
while (<IN>) {
chomp;
next if /^:/;
my ($flags, $retval, $func, @args) = split /\s*\|\s*/, $_;
- next unless $flags =~ /d/;
next unless $func;
s/\b(NN|NULLOK)\b\s+//g for @args;
$func =~ s/\t//g; # 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];
- } else {
- $gutsdocs{$docref->[4]}{$func} =
- [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
- }
- }
- else {
- warn "no docs for $func\n" unless $seenfuncs{$func};
- }
+ $funcflags{$func} = {
+ flags => $flags,
+ retval => $retval,
+ args => \@args,
+ };
}
-for (sort keys %docfuncs) {
- # Have you used a full for apidoc or just a func name?
- # Have you used Ap instead of Am in the for apidoc?
- warn "Unable to place $_!\n";
+my $file;
+# 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: $!";
+ <FH>;
+};
+
+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";
+}
+
+for (sort keys %funcflags) {
+ next unless $funcflags{$_}{flags} =~ /d/;
+ warn "no docs for $_\n"
+}
+
+foreach (sort keys %missing) {
+ next if $macro{$_};
+ # Heuristics for known not-a-function macros:
+ next if /^[A-Z]/;
+ next if /^dj?[A-Z]/;
+
+ warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
}
-readonly_header($doc);
+# walk table providing an array of components in each line to
+# subroutine, printing the result
-print $doc <<'_EOB_';
+output('perlapi', <<'_EOB_', $docs{api}, <<'_EOE_');
=head1 NAME
perlapi - autogenerated documentation for the perl public API
_EOB_
-my $key;
-# 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";
- # 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";
-}
-
-print $doc <<'_EOE_';
-
=head1 AUTHORS
Until May 1997, this document was maintained by Jeff Okamoto
_EOE_
-readonly_footer($doc);
-
-safer_close($doc);
-
-safer_unlink "pod/perlintern.pod";
-my $guts = safer_open("pod/perlintern.pod");
-readonly_header($guts);
-print $guts <<'END';
+output('perlintern', <<'END', $docs{guts}, <<'END');
=head1 NAME
perlintern - autogenerated documentation of purely B<internal>
END
-for $key (sort { uc($a) cmp uc($b); } keys %gutsdocs) {
- my $section = $gutsdocs{$key};
- print $guts "\n=head1 $key\n\n=over 8\n\n";
- for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
- docout($guts, $key, $section->{$key});
- }
- print $guts "\n=back\n";
-}
-
-print $guts <<'END';
-
=head1 AUTHORS
The autodocumentation system was originally added to the Perl core by
perlguts(1), perlapi(1)
END
-readonly_footer($guts);
-
-safer_close($guts);
https://perl5.git.perl.org / perl5.git / blobdiff