This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
[perl #68640] Wrong error for undef constant name
[perl5.git] / autodoc.pl
diff --git a/autodoc.pl b/autodoc.pl
index c898c85..28ca96e 100644 (file)
--- a/autodoc.pl
+++ b/autodoc.pl
@@ -1,10 +1,22 @@
 #!/usr/bin/perl -w
 #!/usr/bin/perl -w
+# 
+# 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.
 
 
-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
-
+use strict;
 
 #
 # See database of global and static function prototypes in embed.fnc
 
 #
 # See database of global and static function prototypes in embed.fnc
@@ -13,49 +25,15 @@ BEGIN {  push @INC, 'lib' } # glob() below requires File::Glob
 # implicit interpreter context argument.
 #
 
 # implicit interpreter context argument.
 #
 
-open IN, "embed.fnc" or die $!;
-
-# walk table providing an array of components in each line to
-# subroutine, printing the result
-sub walk_table (&@) {
-    my $function = shift;
-    my $filename = shift || '-';
-    my $leader = shift;
-    my $trailer = shift;
-    my $F;
-    local *F;
-    if (ref $filename) {       # filehandle
-       $F = $filename;
-    }
-    else {
-       open F, ">$filename" or die "Can't open $filename: $!";
-       $F = \*F;
-    }
-    print $F $leader if $leader;
-    seek IN, 0, 0;             # so we may restart
-    while (<IN>) {
-       chomp;
-       next if /^:/;
-       while (s|\\\s*$||) {
-           $_ .= <IN>;
-           chomp;
-       }
-       my @args;
-       if (/^\s*(#|$)/) {
-           @args = $_;
-       }
-       else {
-           @args = split /\s*\|\s*/, $_;
-       }
-       print $F $function->(@args);
-    }
-    print $F $trailer if $trailer;
-    close $F unless ref $filename;
-}
-
-my %apidocs;
-my %gutsdocs;
-my %docfuncs;
+my %docs;
+my %funcflags;
+my %macro = (
+            ax => 1,
+            items => 1,
+            ix => 1,
+            svtype => 1,
+           );
+my %missing;
 
 my $curheader = "Unknown section";
 
 
 my $curheader = "Unknown section";
 
@@ -64,6 +42,11 @@ sub autodoc ($$) { # parse a file and extract documentation info
     my($in, $doc, $line);
 FUNC:
     while (defined($in = <$fh>)) {
     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;
         if ($in=~ /^=head1 (.*)/) {
             $curheader = $1;
             next FUNC;
@@ -76,10 +59,6 @@ FUNC:
            my $docs = "";
 DOC:
            while (defined($doc = <$fh>)) {
            my $docs = "";
 DOC:
            while (defined($doc = <$fh>)) {
-                if ($doc =~ /^=head1 (.*)/) {
-                    $curheader = $1;
-                    next DOC;
-                }
                $line++;
                last DOC if $doc =~ /^=\w+/;
                if ($doc =~ m:^\*/$:) {
                $line++;
                last DOC if $doc =~ /^=\w+/;
                if ($doc =~ m:^\*/$:) {
@@ -89,19 +68,51 @@ DOC:
                $docs .= $doc;
            }
            $docs = "\n$docs" if $docs and $docs !~ /^\n/;
                $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 =~ /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 (defined $doc) {
-               if ($doc =~ /^=for/) {
+               if ($doc =~ /^=(?:for|head)/) {
                    $in = $doc;
                    redo FUNC;
                }
                    $in = $doc;
                    redo FUNC;
                }
@@ -115,13 +126,14 @@ DOC:
 sub docout ($$$) { # output the docs for one function
     my($fh, $name, $docref) = @_;
     my($flags, $docs, $ret, $file, @args) = @$docref;
 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/;
 
 
     $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
 
     if ($flags =~ /U/) { # no usage
        # nothing
@@ -137,55 +149,114 @@ removed without notice.\n\n" if $flags =~ /x/;
     print $fh "=for hackers\nFound in file $file\n\n";
 }
 
     print $fh "=for hackers\nFound in file $file\n\n";
 }
 
+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   !!!!!!!
+This file is built by $0 extracting documentation from the C source
+files.
+
+_EOH_
+
+    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_
+
+    close $fh or die "Can't close $filename: $!";
+}
+
+if (@ARGV) {
+    my $workdir = shift;
+    chdir $workdir
+        or die "Couldn't chdir to '$workdir': $!";
+}
+
+open IN, "embed.fnc" or die $!;
+
+while (<IN>) {
+    chomp;
+    next if /^:/;
+    while (s|\\\s*$||) {
+       $_ .= <IN>;
+       chomp;
+    }
+    s/\s+$//;
+    next if /^\s*(#|$)/;
+
+    my ($flags, $retval, $func, @args) = split /\s*\|\s*/, $_;
+
+    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//;
+
+    $funcflags{$func} = {
+                        flags => $flags,
+                        retval => $retval,
+                        args => \@args,
+                       };
+}
+
 my $file;
 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: $!";
+  <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";
 }
 
     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";
-open (DOC, ">pod/perlapi.pod") or
-       die "Can't create pod/perlapi.pod: $!\n";
-
-walk_table {   # load documented functions into approriate 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};
-       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 $docref and @$docref;
-       }
-    }
-    return "";
-} \*DOC;
+for (sort keys %funcflags) {
+    next unless $funcflags{$_}{flags} =~ /d/;
+    warn "no docs for $_\n"
+}
 
 
-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";
+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";
 }
 
 }
 
-print DOC <<'_EOB_';
+# walk table providing an array of components in each line to
+# subroutine, printing the result
+
+output('perlapi', <<'_EOB_', $docs{api}, <<'_EOE_');
 =head1 NAME
 
 perlapi - autogenerated documentation for the perl public API
 
 =head1 DESCRIPTION
 =head1 NAME
 
 perlapi - autogenerated documentation for the perl public API
 
 =head1 DESCRIPTION
+X<Perl API> X<API> X<api>
 
 This file contains the documentation of the perl public API generated by
 embed.pl, specifically a listing of functions, macros, flags, and variables
 
 This file contains the documentation of the perl public API generated by
 embed.pl, specifically a listing of functions, macros, flags, and variables
@@ -198,22 +269,33 @@ Note that all Perl API global variables must be referenced with the C<PL_>
 prefix.  Some macros are provided for compatibility with the older,
 unadorned names, but this support may be disabled in a future release.
 
 prefix.  Some macros are provided for compatibility with the older,
 unadorned names, but this support may be disabled in a future release.
 
-The listing is alphabetical, case insensitive.
+Perl was originally written to handle US-ASCII only (that is characters
+whose ordinal numbers are in the range 0 - 127).
+And documentation and comments may still use the term ASCII, when
+sometimes in fact the entire range from 0 - 255 is meant.
+
+Note that Perl can be compiled and run under EBCDIC (See L<perlebcdic>)
+or ASCII.  Most of the documentation (and even comments in the code)
+ignore the EBCDIC possibility.  
+For almost all purposes the differences are transparent.
+As an example, under EBCDIC,
+instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
+whenever this documentation refers to C<utf8>
+(and variants of that name, including in function names),
+it also (essentially transparently) means C<UTF-EBCDIC>.
+But the ordinals of characters differ between ASCII, EBCDIC, and
+the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytes
+than in UTF-8.
+
+Also, on some EBCDIC machines, functions that are documented as operating on
+US-ASCII (or Basic Latin in Unicode terminology) may in fact operate on all
+256 characters in the EBCDIC range, not just the subset corresponding to
+US-ASCII.
+
+The listing below is alphabetical, case insensitive.
 
 _EOB_
 
 
 _EOB_
 
-my $key;
-for $key (sort { uc($a) cmp uc($b); } keys %apidocs) { # case insensitive sort
-    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) {
-        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
 =head1 AUTHORS
 
 Until May 1997, this document was maintained by Jeff Okamoto
@@ -234,18 +316,14 @@ perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
 
 _EOE_
 
 
 _EOE_
 
-
-close(DOC);
-
-open(GUTS, ">pod/perlintern.pod") or
-               die "Unable to create pod/perlintern.pod: $!\n";
-print GUTS <<'END';
+output('perlintern', <<'END', $docs{guts}, <<'END');
 =head1 NAME
 
 perlintern - autogenerated documentation of purely B<internal>
                 Perl functions
 
 =head1 DESCRIPTION
 =head1 NAME
 
 perlintern - autogenerated documentation of purely B<internal>
                 Perl functions
 
 =head1 DESCRIPTION
+X<internal Perl functions> X<interpreter functions>
 
 This file is the autogenerated documentation of functions in the
 Perl interpreter that are documented using Perl's internal documentation
 
 This file is the autogenerated documentation of functions in the
 Perl interpreter that are documented using Perl's internal documentation
@@ -254,17 +332,6 @@ B<they are not for use in extensions>!
 
 END
 
 
 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
 =head1 AUTHORS
 
 The autodocumentation system was originally added to the Perl core by
@@ -276,6 +343,3 @@ document their functions.
 perlguts(1), perlapi(1)
 
 END
 perlguts(1), perlapi(1)
 
 END
-
-close GUTS;
-
Unnamed repository; edit this file 'description' to name the repository.