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: $!";
38 print $F $leader if $leader;
39 seek IN, 0, 0; # so we may restart
52 @args = split /\s*\|\s*/, $_;
54 print $F $function->(@args);
56 print $F $trailer if $trailer;
57 unless (ref $filename) {
58 close $F or die "Error closing $filename: $!";
66 my $curheader = "Unknown section";
68 sub autodoc ($$) { # parse a file and extract documentation info
72 while (defined($in = <$fh>)) {
73 if ($in=~ /^=head1 (.*)/) {
78 if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
80 $proto = "||$proto" unless $proto =~ /\|/;
81 my($flags, $ret, $name, @args) = split /\|/, $proto;
84 while (defined($doc = <$fh>)) {
86 last DOC if $doc =~ /^=\w+/;
87 if ($doc =~ m:^\*/$:) {
88 warn "=cut missing? $file:$line:$doc";;
93 $docs = "\n$docs" if $docs and $docs !~ /^\n/;
96 $apidocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
99 $gutsdocs{$curheader}{$name} = [$flags, $docs, $ret, $file, @args];
103 $docfuncs{$name} = [$flags, $docs, $ret, $file, $curheader, @args];
106 if ($doc =~ /^=(?:for|head)/) {
111 warn "$file:$line:$in";
117 sub docout ($$$) { # output the docs for one function
118 my($fh, $name, $docref) = @_;
119 my($flags, $docs, $ret, $file, @args) = @$docref;
121 $docs .= "NOTE: this function is experimental and may change or be
122 removed without notice.\n\n" if $flags =~ /x/;
123 $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
126 print $fh "=item $name\n$docs";
128 if ($flags =~ /U/) { # no usage
130 } elsif ($flags =~ /s/) { # semicolon ("dTHR;")
131 print $fh "\t\t$name;\n\n";
132 } elsif ($flags =~ /n/) { # no args
133 print $fh "\t$ret\t$name\n\n";
134 } else { # full usage
135 print $fh "\t$ret\t$name";
136 print $fh "(" . join(", ", @args) . ")";
139 print $fh "=for hackers\nFound in file $file\n\n";
143 # glob() picks up docs from extra .c or .h files that may be in unclean
147 open FH, "MANIFEST" or die "Can't open MANIFEST: $!";
151 for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) {
152 open F, "< $file" or die "Cannot open $file for docs: $!\n";
153 $curheader = "Functions in file $file\n";
155 close F or die "Error closing $file: $!\n";
158 safer_unlink "pod/perlapi.pod";
159 open (DOC, ">pod/perlapi.pod") or
160 die "Can't create pod/perlapi.pod: $!\n";
162 walk_table { # load documented functions into approriate hash
164 my($flags, $retval, $func, @args) = @_;
165 return "" unless $flags =~ /d/;
166 $func =~ s/\t//g; $flags =~ s/p//; # clean up fields from embed.pl
168 my $docref = delete $docfuncs{$func};
169 if ($docref and @$docref) {
171 $docref->[0].="x" if $flags =~ /M/;
172 $apidocs{$docref->[4]}{$func} =
173 [$docref->[0] . 'A', $docref->[1], $retval,
174 $docref->[3], @args];
176 $gutsdocs{$docref->[4]}{$func} =
177 [$docref->[0], $docref->[1], $retval, $docref->[3], @args];
181 warn "no docs for $func\n" unless $docref and @$docref;
187 for (sort keys %docfuncs) {
188 # Have you used a full for apidoc or just a func name?
189 # Have you used Ap instead of Am in the for apidoc?
190 warn "Unable to place $_!\n";
196 perlapi - autogenerated documentation for the perl public API
200 This file contains the documentation of the perl public API generated by
201 embed.pl, specifically a listing of functions, macros, flags, and variables
202 that may be used by extension writers. The interfaces of any functions that
203 are not listed here are subject to change without notice. For this reason,
204 blindly using functions listed in proto.h is to be avoided when writing
207 Note that all Perl API global variables must be referenced with the C<PL_>
208 prefix. Some macros are provided for compatibility with the older,
209 unadorned names, but this support may be disabled in a future release.
211 The listing is alphabetical, case insensitive.
216 # case insensitive sort, with fallback for determinacy
217 for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %apidocs) {
218 my $section = $apidocs{$key};
219 print DOC "\n=head1 $key\n\n=over 8\n\n";
220 for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
221 docout(\*DOC, $key, $section->{$key});
223 print DOC "\n=back\n";
230 Until May 1997, this document was maintained by Jeff Okamoto
231 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
233 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
234 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
235 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
236 Stephen McCamant, and Gurusamy Sarathy.
238 API Listing originally by Dean Roehrich <roehrich@cray.com>.
240 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
244 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
249 close(DOC) or die "Error closing pod/perlapi.pod: $!";
251 safer_unlink "pod/perlintern.pod";
252 open(GUTS, ">pod/perlintern.pod") or
253 die "Unable to create pod/perlintern.pod: $!\n";
257 perlintern - autogenerated documentation of purely B<internal>
262 This file is the autogenerated documentation of functions in the
263 Perl interpreter that are documented using Perl's internal documentation
264 format but are not marked as part of the Perl API. In other words,
265 B<they are not for use in extensions>!
269 for $key (sort { uc($a) cmp uc($b); } keys %gutsdocs) {
270 my $section = $gutsdocs{$key};
271 print GUTS "\n=head1 $key\n\n=over 8\n\n";
272 for my $key (sort { uc($a) cmp uc($b); } keys %$section) {
273 docout(\*GUTS, $key, $section->{$key});
275 print GUTS "\n=back\n";
282 The autodocumentation system was originally added to the Perl core by
283 Benjamin Stuhl. Documentation is by whoever was kind enough to
284 document their functions.
288 perlguts(1), perlapi(1)
292 close GUTS or die "Error closing pod/perlintern.pod: $!";