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.
19 # '=head1' are the only headings looked for. If the next line after the
20 # heading begins with a word character, it is considered to be the first line
21 # of documentation that applies to the heading itself. That is, it is output
22 # immediately after the heading, before the first function, and not indented.
23 # The next input line that is a pod directive terminates this heading-level
29 # See database of global and static function prototypes in embed.fnc
30 # This is used to generate prototype headers under various configurations,
31 # export symbols lists for different platforms, and macros to provide an
32 # implicit interpreter context argument.
45 my $curheader = "Unknown section";
47 sub autodoc ($$) { # parse a file and extract documentation info
49 my($in, $doc, $line, $header_doc);
51 while (defined($in = <$fh>)) {
52 if ($in =~ /^#\s*define\s+([A-Za-z_][A-Za-z_0-9]+)\(/ &&
53 ($file ne 'embed.h' || $file ne 'proto.h')) {
57 if ($in=~ /^=head1 (.*)/) {
60 # If the next line begins with a word char, then is the start of
61 # heading-level documentation.
62 if (defined($doc = <$fh>)) {
70 # Continue getting the heading-level documentation until read
71 # in any pod directive (or as a fail-safe, find a closing
72 # comment to this pod in a C language file
74 while (defined($doc = <$fh>)) {
81 if ($doc =~ m:^\s*\*/$:) {
82 warn "=cut missing? $file:$line:$doc";;
91 if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
93 $proto = "||$proto" unless $proto =~ /\|/;
94 my($flags, $ret, $name, @args) = split /\|/, $proto;
97 while (defined($doc = <$fh>)) {
99 last DOC if $doc =~ /^=\w+/;
100 if ($doc =~ m:^\*/$:) {
101 warn "=cut missing? $file:$line:$doc";;
106 $docs = "\n$docs" if $docs and $docs !~ /^\n/;
108 # Check the consistency of the flags
109 my ($embed_where, $inline_where);
110 my ($embed_may_change, $inline_may_change);
112 my $docref = delete $funcflags{$name};
113 if ($docref and %$docref) {
114 $embed_where = $docref->{flags} =~ /A/ ? 'api' : 'guts';
115 $embed_may_change = $docref->{flags} =~ /M/;
117 $missing{$name} = $file;
120 $inline_where = $flags =~ /A/ ? 'api' : 'guts';
121 $inline_may_change = $flags =~ /x/;
123 if (defined $embed_where && $inline_where ne $embed_where) {
124 warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
127 if (defined $embed_may_change
128 && $inline_may_change ne $embed_may_change) {
129 my $message = "Function '$name' inconsistency: ";
130 if ($embed_may_change) {
131 $message .= "embed.fnc says 'may change', Pod does not";
133 $message .= "Pod says 'may change', embed.fnc does not";
137 } elsif (!defined $embed_where) {
138 warn "Unable to place $name!\n";
141 $inline_where = $embed_where;
142 $flags .= 'x' if $embed_may_change;
143 @args = @{$docref->{args}};
144 $ret = $docref->{retval};
147 $docs{$inline_where}{$curheader}{$name}
148 = [$flags, $docs, $ret, $file, @args];
150 # Create a special entry with an empty-string name for the
151 # heading-level documentation.
152 if (defined $header_doc) {
153 $docs{$inline_where}{$curheader}{""} = $header_doc;
158 if ($doc =~ /^=(?:for|head)/) {
163 warn "$file:$line:$in";
169 sub docout ($$$) { # output the docs for one function
170 my($fh, $name, $docref) = @_;
171 my($flags, $docs, $ret, $file, @args) = @$docref;
174 $docs .= "NOTE: this function is experimental and may change or be
175 removed without notice.\n\n" if $flags =~ /x/;
176 $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
178 $docs .= "NOTE: this function must be explicitly called as Perl_$name with an aTHX_ parameter.\n\n"
181 print $fh "=item $name\nX<$name>\n$docs";
183 if ($flags =~ /U/) { # no usage
185 } elsif ($flags =~ /s/) { # semicolon ("dTHR;")
186 print $fh "\t\t$name;\n\n";
187 } elsif ($flags =~ /n/) { # no args
188 print $fh "\t$ret\t$name\n\n";
189 } elsif ($flags =~ /o/) { # no #define foo Perl_foo
190 print $fh "\t$ret\tPerl_$name";
191 print $fh "(" . (@args ? "pTHX_ " : "pTHX");
192 print $fh join(", ", @args) . ")\n\n";
193 } else { # full usage
194 print $fh "\t$ret\t$name";
195 print $fh "(" . join(", ", @args) . ")";
198 print $fh "=for hackers\nFound in file $file\n\n";
202 my ($podname, $header, $dochash, $missing, $footer) = @_;
203 my $filename = "pod/$podname.pod";
204 open my $fh, '>', $filename or die "Can't open $filename: $!";
206 print $fh <<"_EOH_", $header;
207 -*- buffer-read-only: t -*-
209 !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
210 This file is built by $0 extracting documentation from the C source
216 # case insensitive sort, with fallback for determinacy
217 for $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$dochash) {
218 my $section = $dochash->{$key};
219 print $fh "\n=head1 $key\n\n";
221 # Output any heading-level documentation and delete so won't get in
223 if (exists $section->{""}) {
224 print $fh $section->{""} . "\n";
225 delete $section->{""};
227 print $fh "=over 8\n\n";
229 # Again, fallback for determinacy
230 for my $key (sort { uc($a) cmp uc($b) || $a cmp $b } keys %$section) {
231 docout($fh, $key, $section->{$key});
233 print $fh "\n=back\n";
237 print $fh "\n=head1 Undocumented functions\n\n";
239 The following functions have been flagged as part of the public API,
240 but are currently undocumented. Use them at your own risk, as the
241 interfaces are subject to change.
243 If you use one of them, you may wish to consider creating and submitting
244 documentation for it. If your patch is accepted, this will indicate that
245 the interface is stable (unless it is explicitly marked otherwise).
250 for my $missing (sort @$missing) {
251 print $fh "=item $missing\nX<$missing>\n\n";
253 print $fh "=back\n\n";
256 print $fh $footer, <<'_EOF_';
262 close $fh or die "Can't close $filename: $!";
268 or die "Couldn't chdir to '$workdir': $!";
271 open IN, "embed.fnc" or die $!;
283 my ($flags, $retval, $func, @args) = split /\s*\|\s*/, $_;
287 s/\b(NN|NULLOK)\b\s+//g for @args;
288 $func =~ s/\t//g; # clean up fields from embed.pl
291 $funcflags{$func} = {
299 # glob() picks up docs from extra .c or .h files that may be in unclean
303 open FH, "MANIFEST" or die "Can't open MANIFEST: $!";
307 for $file (($MANIFEST =~ /^(\S+\.c)\t/gm), ($MANIFEST =~ /^(\S+\.h)\t/gm)) {
308 open F, "< $file" or die "Cannot open $file for docs: $!\n";
309 $curheader = "Functions in file $file\n";
311 close F or die "Error closing $file: $!\n";
314 for (sort keys %funcflags) {
315 next unless $funcflags{$_}{flags} =~ /d/;
316 warn "no docs for $_\n"
319 foreach (sort keys %missing) {
321 # Heuristics for known not-a-function macros:
325 warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
328 # walk table providing an array of components in each line to
329 # subroutine, printing the result
331 my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && !$docs{api}{$_}, keys %funcflags;
332 output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_');
335 perlapi - autogenerated documentation for the perl public API
338 X<Perl API> X<API> X<api>
340 This file contains the documentation of the perl public API generated by
341 embed.pl, specifically a listing of functions, macros, flags, and variables
342 that may be used by extension writers. L<At the end|/Undocumented functions>
343 is a list of functions which have yet to be documented. The interfaces of
344 those are subject to change without notice. Any functions not listed here are
345 not part of the public API, and should not be used by extension writers at
346 all. For these reasons, blindly using functions listed in proto.h is to be
347 avoided when writing extensions.
349 Note that all Perl API global variables must be referenced with the C<PL_>
350 prefix. Some macros are provided for compatibility with the older,
351 unadorned names, but this support may be disabled in a future release.
353 Perl was originally written to handle US-ASCII only (that is characters
354 whose ordinal numbers are in the range 0 - 127).
355 And documentation and comments may still use the term ASCII, when
356 sometimes in fact the entire range from 0 - 255 is meant.
358 Note that Perl can be compiled and run under EBCDIC (See L<perlebcdic>)
359 or ASCII. Most of the documentation (and even comments in the code)
360 ignore the EBCDIC possibility.
361 For almost all purposes the differences are transparent.
362 As an example, under EBCDIC,
363 instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
364 whenever this documentation refers to C<utf8>
365 (and variants of that name, including in function names),
366 it also (essentially transparently) means C<UTF-EBCDIC>.
367 But the ordinals of characters differ between ASCII, EBCDIC, and
368 the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytes
371 Also, on some EBCDIC machines, functions that are documented as operating on
372 US-ASCII (or Basic Latin in Unicode terminology) may in fact operate on all
373 256 characters in the EBCDIC range, not just the subset corresponding to
376 The listing below is alphabetical, case insensitive.
382 Until May 1997, this document was maintained by Jeff Okamoto
383 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
385 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
386 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
387 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
388 Stephen McCamant, and Gurusamy Sarathy.
390 API Listing originally by Dean Roehrich <roehrich@cray.com>.
392 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
396 L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
400 my @missing_guts = grep $funcflags{$_}{flags} !~ /A/ && !$docs{guts}{$_}, keys %funcflags;
402 output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END');
405 perlintern - autogenerated documentation of purely B<internal>
409 X<internal Perl functions> X<interpreter functions>
411 This file is the autogenerated documentation of functions in the
412 Perl interpreter that are documented using Perl's internal documentation
413 format but are not marked as part of the Perl API. In other words,
414 B<they are not for use in extensions>!
420 The autodocumentation system was originally added to the Perl core by
421 Benjamin Stuhl. Documentation is by whoever was kind enough to
422 document their functions.
426 L<perlguts>, L<perlapi>