3 require 5.003; # keep this compatible, an old perl is all we may have before
8 require 'regen_lib.pl';
13 # See database of global and static function prototypes in embed.fnc
14 # This is used to generate prototype headers under various configurations,
15 # export symbols lists for different platforms, and macros to provide an
16 # implicit interpreter context argument.
19 open IN, "embed.fnc" or die $!;
21 # walk table providing an array of components in each line to
22 # subroutine, printing the result
25 my $filename = shift || '-';
30 if (ref $filename) { # filehandle
34 safer_unlink $filename;
35 open F, ">$filename" or die "Can't open $filename: $!";
39 print $F $leader if $leader;
40 seek IN, 0, 0; # so we may restart
54 @args = split /\s*\|\s*/, $_;
56 print $F $function->(@args);
58 print $F $trailer if $trailer;
59 unless (ref $filename) {
60 close $F or die "Error closing $filename: $!";
68 my $curheader = "Unknown section";
70 sub autodoc ($$) { # parse a file and extract documentation info
74 while (defined($in = <$fh>)) {
75 if ($in=~ /^=head1 (.*)/) {
80 if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
82 $proto = "||$proto" unless $proto =~ /\|/;
83 my($flags, $ret, $name, @args) = split /\|/, $proto;
86 while (defined($doc = <$fh>)) {
88 last DOC if $doc =~ /^=\w+/;
89 if ($doc =~ m:^\*/$:) {
90 warn "=cut missing? $file:$line:$doc";;
95 $docs = "\n$docs" if $docs and $docs !~ /^\n/;
98 $apidocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
101 $gutsdocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
105 $docfuncs{$name} = [$flags, $docs, $ret, $file, $curheader, @args];
108 if ($doc =~ /^=(?:for|head)/) {
113 warn "$file:$line:$in";
119 sub docout ($$$) { # output the docs for one function
120 my($fh, $name, $docref) = @_;
121 my($flags, $docs, $ret, $file, @args) = @$docref;
123 $docs .= "NOTE: this function is experimental and may change or be
124 removed without notice.\n\n" if $flags =~ /x/;
125 $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
128 print $fh "=item $name\n$docs";
130 if ($flags =~ /U/) { # no usage
132 } elsif ($flags =~ /s/) { # semicolon ("dTHR;")
133 print $fh "\t\t$name;\n\n";
134 } elsif ($flags =~ /n/) { # no args
135 print $fh "\t$ret\t$name\n\n";
136 } else { # full usage
137 print $fh "\t$ret\t$name";
138 print $fh "(" . join(", ", @args) . ")";
141 print $fh "=for hackers\nFound in file $file\n\n";
145 # glob() picks up docs from extra .c or .h files that may be in unclean
149 open FH, "MANIFEST" or die "Can't open MANIFEST: $!";
153 for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) {
154 open F, "< $file" or die "Cannot open $file for docs: $!\n";
155 $curheader = "Functions in file $file\n";
157 close F or die "Error closing $file: $!\n";
160 safer_unlink "pod/perlapi.pod";
161 open (DOC, ">pod/perlapi.pod") or
162 die "Can't create pod/perlapi.pod: $!\n";
165 walk_table { # load documented functions into approriate hash
167 my($flags, $retval, $func, @args) = @_;
168 return "" unless $flags =~ /d/;
169 $func =~ s/\t//g; $flags =~ s/p//; # clean up fields from embed.pl
171 my $docref = delete $docfuncs{$func};
172 if ($docref and @$docref) {
174 $docref->[0].="x" if $flags =~ /M/;
175 $apidocs{$docref->[4]}{$func} =
176 [$docref->[0] . 'A', $docref->[1], $retval,
177 $docref->[3], @args];
179 $gutsdocs{$docref->[4]}{$func} =
180 [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
184 warn "no docs for $func\n" unless $docref and @$docref;
190 for (sort keys %docfuncs) {
191 # Have you used a full for apidoc or just a func name?
192 # Have you used Ap instead of Am in the for apidoc?
193 warn "Unable to place $_!\n";
199 perlapi - autogenerated documentation for the perl public API
203 This file contains the documentation of the perl public API generated by
204 embed.pl, specifically a listing of functions, macros, flags, and variables
205 that may be used by extension writers. The interfaces of any functions that
206 are not listed here are subject to change without notice. For this reason,
207 blindly using functions listed in proto.h is to be avoided when writing
210 Note that all Perl API global variables must be referenced with the C<PL_>
211 prefix. Some macros are provided for compatibility with the older,
212 unadorned names, but this support may be disabled in a future release.
214 The listing is alphabetical, case insensitive.
219 # case insensitive sort, with fallback for determinacy
220 for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %apidocs) {
221 my $section = $apidocs{$key};
222 print DOC "\n=head1 $key\n\n=over 8\n\n";
223 for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
224 docout(\*DOC, $key, $section->{$key});
226 print DOC "\n=back\n";
233 Until May 1997, this document was maintained by Jeff Okamoto
234 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
236 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
237 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
238 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
239 Stephen McCamant, and Gurusamy Sarathy.
241 API Listing originally by Dean Roehrich <roehrich@cray.com>.
243 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
247 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
252 close(DOC) or die "Error closing pod/perlapi.pod: $!";
254 safer_unlink "pod/perlintern.pod";
255 open(GUTS, ">pod/perlintern.pod") or
256 die "Unable to create pod/perlintern.pod: $!\n";
261 perlintern - autogenerated documentation of purely B<internal>
266 This file is the autogenerated documentation of functions in the
267 Perl interpreter that are documented using Perl's internal documentation
268 format but are not marked as part of the Perl API. In other words,
269 B<they are not for use in extensions>!
273 for $key (sort { uc($a) cmp uc($b); } keys %gutsdocs) {
274 my $section = $gutsdocs{$key};
275 print GUTS "\n=head1 $key\n\n=over 8\n\n";
276 for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
277 docout(\*GUTS, $key, $section->{$key});
279 print GUTS "\n=back\n";
286 The autodocumentation system was originally added to the Perl core by
287 Benjamin Stuhl. Documentation is by whoever was kind enough to
288 document their functions.
292 perlguts(1), perlapi(1)
296 close GUTS or die "Error closing pod/perlintern.pod: $!";