3 # Unconditionally regenerate:
8 # from information stored in
11 # plus all the .c and .h files listed in MANIFEST
13 # Has an optional arg, which is the directory to chdir to before reading
14 # MANIFEST and *.[ch].
16 # This script is normally invoked as part of 'make all', but is also
17 # called from from regen.pl.
22 # See database of global and static function prototypes in embed.fnc
23 # This is used to generate prototype headers under various configurations,
24 # export symbols lists for different platforms, and macros to provide an
25 # implicit interpreter context argument.
38 my $curheader = "Unknown section";
40 sub autodoc ($$) { # parse a file and extract documentation info
44 while (defined($in = <$fh>)) {
45 if ($in =~ /^#\s*define\s+([A-Za-z_][A-Za-z_0-9]+)\(/ &&
46 ($file ne 'embed.h' || $file ne 'proto.h')) {
50 if ($in=~ /^=head1 (.*)/) {
55 if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
57 $proto = "||$proto" unless $proto =~ /\|/;
58 my($flags, $ret, $name, @args) = split /\|/, $proto;
61 while (defined($doc = <$fh>)) {
63 last DOC if $doc =~ /^=\w+/;
64 if ($doc =~ m:^\*/$:) {
65 warn "=cut missing? $file:$line:$doc";;
70 $docs = "\n$docs" if $docs and $docs !~ /^\n/;
72 # Check the consistency of the flags
73 my ($embed_where, $inline_where);
74 my ($embed_may_change, $inline_may_change);
76 my $docref = delete $funcflags{$name};
77 if ($docref and %$docref) {
78 $embed_where = $docref->{flags} =~ /A/ ? 'api' : 'guts';
79 $embed_may_change = $docref->{flags} =~ /M/;
81 $missing{$name} = $file;
84 $inline_where = $flags =~ /A/ ? 'api' : 'guts';
85 $inline_may_change = $flags =~ /x/;
87 if (defined $embed_where && $inline_where ne $embed_where) {
88 warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
91 if (defined $embed_may_change
92 && $inline_may_change ne $embed_may_change) {
93 my $message = "Function '$name' inconsistency: ";
94 if ($embed_may_change) {
95 $message .= "embed.fnc says 'may change', Pod does not";
97 $message .= "Pod says 'may change', embed.fnc does not";
101 } elsif (!defined $embed_where) {
102 warn "Unable to place $name!\n";
105 $inline_where = $embed_where;
106 $flags .= 'x' if $embed_may_change;
107 @args = @{$docref->{args}};
108 $ret = $docref->{retval};
111 $docs{$inline_where}{$curheader}{$name}
112 = [$flags, $docs, $ret, $file, @args];
115 if ($doc =~ /^=(?:for|head)/) {
120 warn "$file:$line:$in";
126 sub docout ($$$) { # output the docs for one function
127 my($fh, $name, $docref) = @_;
128 my($flags, $docs, $ret, $file, @args) = @$docref;
131 $docs .= "NOTE: this function is experimental and may change or be
132 removed without notice.\n\n" if $flags =~ /x/;
133 $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
135 $docs .= "NOTE: this function must be explicitly called as Perl_$name with an aTHX_ parameter.\n\n"
138 print $fh "=item $name\nX<$name>\n$docs";
140 if ($flags =~ /U/) { # no usage
142 } elsif ($flags =~ /s/) { # semicolon ("dTHR;")
143 print $fh "\t\t$name;\n\n";
144 } elsif ($flags =~ /n/) { # no args
145 print $fh "\t$ret\t$name\n\n";
146 } elsif ($flags =~ /o/) { # no #define foo Perl_foo
147 print $fh "\t$ret\tPerl_$name";
148 print $fh "(" . (@args ? "pTHX_ " : "pTHX");
149 print $fh join(", ", @args) . ")\n\n";
150 } else { # full usage
151 print $fh "\t$ret\t$name";
152 print $fh "(" . join(", ", @args) . ")";
155 print $fh "=for hackers\nFound in file $file\n\n";
159 my ($podname, $header, $dochash, $missing, $footer) = @_;
160 my $filename = "pod/$podname.pod";
161 open my $fh, '>', $filename or die "Can't open $filename: $!";
163 print $fh <<"_EOH_", $header;
164 -*- buffer-read-only: t -*-
166 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
167 This file is built by $0 extracting documentation from the C source
173 # case insensitive sort, with fallback for determinacy
174 for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$dochash) {
175 my $section = $dochash->{$key};
176 print $fh "\n=head1 $key\n\n=over 8\n\n";
177 # Again, fallback for determinacy
178 for my $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$section) {
179 docout($fh, $key, $section->{$key});
181 print $fh "\n=back\n";
185 print $fh "\n=head1 Undocumented functions\n\n";
186 print $fh "These functions are currently undocumented:\n\n=over\n\n";
187 for my $missing (sort @$missing) {
188 print $fh "=item $missing\nX<$missing>\n\n";
190 print $fh "=back\n\n";
193 print $fh $footer, <<'_EOF_';
199 close $fh or die "Can't close $filename: $!";
205 or die "Couldn't chdir to '$workdir': $!";
208 open IN, "embed.fnc" or die $!;
220 my ($flags, $retval, $func, @args) = split /\s*\|\s*/, $_;
224 s/\b(NN|NULLOK)\b\s+//g for @args;
225 $func =~ s/\t//g; # clean up fields from embed.pl
228 $funcflags{$func} = {
236 # glob() picks up docs from extra .c or .h files that may be in unclean
240 open FH, "MANIFEST" or die "Can't open MANIFEST: $!";
244 for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) {
245 open F, "< $file" or die "Cannot open $file for docs: $!\n";
246 $curheader = "Functions in file $file\n";
248 close F or die "Error closing $file: $!\n";
251 for (sort keys %funcflags) {
252 next unless $funcflags{$_}{flags} =~ /d/;
253 warn "no docs for $_\n"
256 foreach (sort keys %missing) {
258 # Heuristics for known not-a-function macros:
262 warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
265 # walk table providing an array of components in each line to
266 # subroutine, printing the result
268 my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && !$docs{api}{$_}, keys %funcflags;
269 output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_');
272 perlapi - autogenerated documentation for the perl public API
275 X<Perl API> X<API> X<api>
277 This file contains the documentation of the perl public API generated by
278 embed.pl, specifically a listing of functions, macros, flags, and variables
279 that may be used by extension writers. The interfaces of any functions that
280 are not listed here are subject to change without notice. For this reason,
281 blindly using functions listed in proto.h is to be avoided when writing
284 Note that all Perl API global variables must be referenced with the C<PL_>
285 prefix. Some macros are provided for compatibility with the older,
286 unadorned names, but this support may be disabled in a future release.
288 Perl was originally written to handle US-ASCII only (that is characters
289 whose ordinal numbers are in the range 0 - 127).
290 And documentation and comments may still use the term ASCII, when
291 sometimes in fact the entire range from 0 - 255 is meant.
293 Note that Perl can be compiled and run under EBCDIC (See L<perlebcdic>)
294 or ASCII. Most of the documentation (and even comments in the code)
295 ignore the EBCDIC possibility.
296 For almost all purposes the differences are transparent.
297 As an example, under EBCDIC,
298 instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
299 whenever this documentation refers to C<utf8>
300 (and variants of that name, including in function names),
301 it also (essentially transparently) means C<UTF-EBCDIC>.
302 But the ordinals of characters differ between ASCII, EBCDIC, and
303 the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytes
306 Also, on some EBCDIC machines, functions that are documented as operating on
307 US-ASCII (or Basic Latin in Unicode terminology) may in fact operate on all
308 256 characters in the EBCDIC range, not just the subset corresponding to
311 The listing below is alphabetical, case insensitive.
317 Until May 1997, this document was maintained by Jeff Okamoto
318 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
320 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
321 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
322 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
323 Stephen McCamant, and Gurusamy Sarathy.
325 API Listing originally by Dean Roehrich <roehrich@cray.com>.
327 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
331 L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
335 my @missing_guts = grep $funcflags{$_}{flags} !~ /A/ && !$docs{guts}{$_}, keys %funcflags;
337 output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END');
340 perlintern - autogenerated documentation of purely B<internal>
344 X<internal Perl functions> X<interpreter functions>
346 This file is the autogenerated documentation of functions in the
347 Perl interpreter that are documented using Perl's internal documentation
348 format but are not marked as part of the Perl API. In other words,
349 B<they are not for use in extensions>!
355 The autodocumentation system was originally added to the Perl core by
356 Benjamin Stuhl. Documentation is by whoever was kind enough to
357 document their functions.
361 L<perlguts>, L<perlapi>