This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
0b4ec201c844967874b35391a84d9004df3a8514
[perl5.git] / autodoc.pl
1 #!/usr/bin/perl -w
2
3 # Unconditionally regenerate:
4 #
5 #    pod/perlintern.pod
6 #    pod/perlapi.pod
7 #
8 # from information stored in
9 #
10 #    embed.fnc
11 #    plus all the .c and .h files listed in MANIFEST
12 #
13 # Has an optional arg, which is the directory to chdir to before reading
14 # MANIFEST and *.[ch].
15 #
16 # This script is invoked as part of 'make all'
17 #
18 # '=head1' are the only headings looked for.  If the first non-blank line after
19 # the heading begins with a word character, it is considered to be the first 
20 # line of documentation that applies to the heading itself.  That is, it is 
21 # output immediately after the heading, before the first function, and not 
22 # indented. The next input line that is a pod directive terminates this 
23 # heading-level documentation.
24
25 use strict;
26
27 if (@ARGV) {
28     my $workdir = shift;
29     chdir $workdir
30         or die "Couldn't chdir to '$workdir': $!";
31 }
32 require './regen/regen_lib.pl';
33 require './regen/embed_lib.pl';
34
35 #
36 # See database of global and static function prototypes in embed.fnc
37 # This is used to generate prototype headers under various configurations,
38 # export symbols lists for different platforms, and macros to provide an
39 # implicit interpreter context argument.
40 #
41
42 my %docs;
43 my %funcflags;
44 my %macro = (
45              ax => 1,
46              items => 1,
47              ix => 1,
48              svtype => 1,
49             );
50 my %missing;
51
52 my $curheader = "Unknown section";
53
54 sub autodoc ($$) { # parse a file and extract documentation info
55     my($fh,$file) = @_;
56     my($in, $doc, $line, $header_doc);
57
58     # Count lines easier
59     my $get_next_line = sub { $line++; return <$fh> };
60
61 FUNC:
62     while (defined($in = $get_next_line->())) {
63         if ($in =~ /^#\s*define\s+([A-Za-z_][A-Za-z_0-9]+)\(/ &&
64             ($file ne 'embed.h' || $file ne 'proto.h')) {
65             $macro{$1} = $file;
66             next FUNC;
67         }
68         if ($in=~ /^=head1 (.*)/) {
69             $curheader = $1;
70
71             # If the next non-space line begins with a word char, then it is
72             # the start of heading-ldevel documentation.
73             if (defined($doc = $get_next_line->())) {
74                 # Skip over empty lines
75                 while ($doc =~ /^\s+$/) {
76                     if (! defined($doc = $get_next_line->())) {
77                         next FUNC;
78                     }
79                 }
80
81                 if ($doc !~ /^\w/) {
82                     $in = $doc;
83                     redo FUNC;
84                 }
85                 $header_doc = $doc;
86
87                 # Continue getting the heading-level documentation until read
88                 # in any pod directive (or as a fail-safe, find a closing
89                 # comment to this pod in a C language file
90 HDR_DOC:
91                 while (defined($doc = $get_next_line->())) {
92                     if ($doc =~ /^=\w/) {
93                         $in = $doc;
94                         redo FUNC;
95                     }
96
97                     if ($doc =~ m:^\s*\*/$:) {
98                         warn "=cut missing? $file:$line:$doc";;
99                         last HDR_DOC;
100                     }
101                     $header_doc .= $doc;
102                 }
103             }
104             next FUNC;
105         }
106         if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
107             my $proto = $1;
108             $proto = "||$proto" unless $proto =~ /\|/;
109             my($flags, $ret, $name, @args) = split /\s*\|\s*/, $proto;
110             my $docs = "";
111 DOC:
112             while (defined($doc = $get_next_line->())) {
113
114                 # Other pod commands are considered part of the current
115                 # function's docs, so can have lists, etc.
116                 last DOC if $doc =~ /^=(cut|for\s+apidoc|head)/;
117                 if ($doc =~ m:^\*/$:) {
118                     warn "=cut missing? $file:$line:$doc";;
119                     last DOC;
120                 }
121                 $docs .= $doc;
122             }
123             $docs = "\n$docs" if $docs and $docs !~ /^\n/;
124
125             # Check the consistency of the flags
126             my ($embed_where, $inline_where);
127             my ($embed_may_change, $inline_may_change);
128
129             my $embed_docref = delete $funcflags{$name};
130             if ($embed_docref and %$embed_docref) {
131                 $embed_where = $embed_docref->{flags} =~ /A/ ? 'api' : 'guts';
132                 $embed_may_change = $embed_docref->{flags} =~ /x/;
133                 $flags .= 'D' if $embed_docref->{flags} =~ /D/;
134                 $flags .= 'O' if $embed_docref->{flags} =~ /O/;
135             } else {
136                 $missing{$name} = $file;
137             }
138             if ($flags =~ /m/) {
139                 $inline_where = $flags =~ /A/ ? 'api' : 'guts';
140                 $inline_may_change = $flags =~ /x/;
141
142                 if (defined $embed_where && $inline_where ne $embed_where) {
143                     warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
144                 }
145
146                 if (defined $embed_may_change
147                     && $inline_may_change ne $embed_may_change) {
148                     my $message = "Function '$name' inconsistency: ";
149                     if ($embed_may_change) {
150                         $message .= "embed.fnc says 'may change', Pod does not";
151                     } else {
152                         $message .= "Pod says 'may change', embed.fnc does not";
153                     }
154                     warn $message;
155                 }
156             } elsif (!defined $embed_where) {
157                 warn "Unable to place $name!\n";
158                 next;
159             } else {
160                 $inline_where = $embed_where;
161                 $flags .= 'x' if $embed_may_change;
162                 @args = @{$embed_docref->{args}};
163                 $ret = $embed_docref->{retval};
164             }
165
166             if (exists $docs{$inline_where}{$curheader}{$name}) {
167                 warn "$0: duplicate API entry for '$name' in $inline_where/$curheader\n";
168                 next;
169             }
170             $docs{$inline_where}{$curheader}{$name}
171                 = [$flags, $docs, $ret, $file, @args];
172
173             # Create a special entry with an empty-string name for the
174             # heading-level documentation.
175             if (defined $header_doc) {
176                 $docs{$inline_where}{$curheader}{""} = $header_doc;
177                 undef $header_doc;
178             }
179
180             if (defined $doc) {
181                 if ($doc =~ /^=(?:for|head)/) {
182                     $in = $doc;
183                     redo FUNC;
184                 }
185             } else {
186                 warn "$file:$line:$in";
187             }
188         }
189     }
190 }
191
192 sub docout ($$$) { # output the docs for one function
193     my($fh, $name, $docref) = @_;
194     my($flags, $docs, $ret, $file, @args) = @$docref;
195     $name =~ s/\s*$//;
196
197     if ($flags =~ /D/) {
198         $docs = "\n\nDEPRECATED!  It is planned to remove this function from a
199 future release of Perl.  Do not use it for new code; remove it from
200 existing code.\n\n$docs";
201     }
202     else {
203         $docs = "\n\nNOTE: this function is experimental and may change or be
204 removed without notice.\n\n$docs" if $flags =~ /x/;
205     }
206     $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
207         if $flags =~ /O/;
208     $docs .= "NOTE: this function must be explicitly called as Perl_$name with an aTHX_ parameter.\n\n"
209         if $flags =~ /o/;
210
211     print $fh "=item $name\nX<$name>\n$docs";
212
213     if ($flags =~ /U/) { # no usage
214         # nothing
215     } else {
216         if ($flags =~ /s/) { # semicolon ("dTHR;")
217             print $fh "\t\t$name;";
218         } elsif ($flags =~ /n/) { # no args
219             print $fh "\t$ret\t$name";
220         } else { # full usage
221             my $p            = $flags =~ /o/; # no #define foo Perl_foo
222             my $n            = "Perl_"x$p . $name;
223             my $large_ret    = length $ret > 7;
224             my $indent_size  = 7+8 # nroff: 7 under =head + 8 under =item
225                             +8+($large_ret ? 1 + length $ret : 8)
226                             +length($n) + 1;
227             my $indent;
228             print $fh "\t$ret" . ($large_ret ? ' ' : "\t") . "$n(";
229             my $long_args;
230             for (@args) {
231                 if ($indent_size + 2 + length > 79) {
232                     $long_args=1;
233                     $indent_size -= length($n) - 3;
234                     last;
235                 }
236             }
237             my $args = '';
238             if ($p) {
239                 $args = @args ? "pTHX_ " : "pTHX";
240                 if ($long_args) { print $fh $args; $args = '' }
241             }
242             $long_args and print $fh "\n";
243             my $first = !$long_args;
244             while () {
245                 if (!@args or
246                     length $args
247                     && $indent_size + 3 + length($args[0]) + length $args > 79
248                 ) {
249                     print $fh
250                     $first ? '' : (
251                         $indent //=
252                         "\t".($large_ret ? " " x (1+length $ret) : "\t")
253                         ." "x($long_args ? 4 : 1 + length $n)
254                     ),
255                     $args, (","x($args ne 'pTHX_ ') . "\n")x!!@args;
256                     $args = $first = '';
257                 }
258                 @args or last;
259                 $args .= ", "x!!(length $args && $args ne 'pTHX_ ')
260                     . shift @args;
261             }
262             if ($long_args) { print $fh "\n", substr $indent, 0, -4 }
263             print $fh ")";
264         }
265         print $fh "\n\n";
266     }
267     print $fh "=for hackers\nFound in file $file\n\n";
268 }
269
270 sub sort_helper {
271     # Do a case-insensitive dictionary sort, with only alphabetics
272     # significant, falling back to using everything for determinancy
273     return (uc($a =~ s/[[:^alpha:]]//r) cmp uc($b =~ s/[[:^alpha:]]//r))
274            || uc($a) cmp uc($b)
275            || $a cmp $b;
276 }
277
278 sub output {
279     my ($podname, $header, $dochash, $missing, $footer) = @_;
280     #
281     # strip leading '|' from each line which had been used to hide
282     # pod from pod checkers.
283     s/^\|//gm for $header, $footer;
284
285     my $fh = open_new("pod/$podname.pod", undef,
286                       {by => "$0 extracting documentation",
287                        from => 'the C source files'}, 1);
288
289     print $fh $header;
290
291     my $key;
292     for $key (sort sort_helper keys %$dochash) {
293         my $section = $dochash->{$key}; 
294         print $fh "\n=head1 $key\n\n";
295
296         # Output any heading-level documentation and delete so won't get in
297         # the way later
298         if (exists $section->{""}) {
299             print $fh $section->{""} . "\n";
300             delete $section->{""};
301         }
302         print $fh "=over 8\n\n";
303
304         for my $key (sort sort_helper keys %$section) {
305             docout($fh, $key, $section->{$key});
306         }
307         print $fh "\n=back\n";
308     }
309
310     if (@$missing) {
311         print $fh "\n=head1 Undocumented functions\n\n";
312     print $fh $podname eq 'perlapi' ? <<'_EOB_' : <<'_EOB_';
313 The following functions have been flagged as part of the public API,
314 but are currently undocumented.  Use them at your own risk, as the
315 interfaces are subject to change.  Functions that are not listed in this
316 document are not intended for public use, and should NOT be used under any
317 circumstances.
318
319 If you feel you need to use one of these functions, first send email to
320 L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>.  It may be
321 that there is a good reason for the function not being documented, and it
322 should be removed from this list; or it may just be that no one has gotten
323 around to documenting it.  In the latter case, you will be asked to submit a
324 patch to document the function.  Once your patch is accepted, it will indicate
325 that the interface is stable (unless it is explicitly marked otherwise) and
326 usable by you.
327 _EOB_
328 The following functions are currently undocumented.  If you use one of
329 them, you may wish to consider creating and submitting documentation for
330 it.
331 _EOB_
332     print $fh "\n=over\n\n";
333
334     for my $missing (sort @$missing) {
335         print $fh "=item $missing\nX<$missing>\n\n";
336     }
337     print $fh "=back\n\n";
338 }
339     print $fh $footer, "=cut\n";
340
341     read_only_bottom_close_and_rename($fh);
342 }
343
344 foreach (@{(setup_embed())[0]}) {
345     next if @$_ < 2;
346     my ($flags, $retval, $func, @args) = @$_;
347     s/\b(?:NN|NULLOK)\b\s+//g for @args;
348
349     $funcflags{$func} = {
350                          flags => $flags,
351                          retval => $retval,
352                          args => \@args,
353                         };
354 }
355
356 # glob() picks up docs from extra .c or .h files that may be in unclean
357 # development trees.
358 open my $fh, '<', 'MANIFEST'
359     or die "Can't open MANIFEST: $!";
360 while (my $line = <$fh>) {
361     next unless my ($file) = $line =~ /^(\S+\.[ch])\t/;
362
363     open F, '<', $file or die "Cannot open $file for docs: $!\n";
364     $curheader = "Functions in file $file\n";
365     autodoc(\*F,$file);
366     close F or die "Error closing $file: $!\n";
367 }
368 close $fh or die "Error whilst reading MANIFEST: $!";
369
370 for (sort keys %funcflags) {
371     next unless $funcflags{$_}{flags} =~ /d/;
372     warn "no docs for $_\n"
373 }
374
375 foreach (sort keys %missing) {
376     next if $macro{$_};
377     # Heuristics for known not-a-function macros:
378     next if /^[A-Z]/;
379     next if /^dj?[A-Z]/;
380
381     warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
382 }
383
384 # walk table providing an array of components in each line to
385 # subroutine, printing the result
386
387 # List of funcs in the public API that aren't also marked as experimental nor
388 # deprecated.
389 my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && $funcflags{$_}{flags} !~ /[xD]/ && !$docs{api}{$_}, keys %funcflags;
390 output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_');
391 |=encoding UTF-8
392 |
393 |=head1 NAME
394 |
395 |perlapi - autogenerated documentation for the perl public API
396 |
397 |=head1 DESCRIPTION
398 |X<Perl API> X<API> X<api>
399 |
400 |This file contains the documentation of the perl public API generated by
401 |F<embed.pl>, specifically a listing of functions, macros, flags, and variables
402 |that may be used by extension writers.  L<At the end|/Undocumented functions>
403 |is a list of functions which have yet to be documented.  The interfaces of
404 |those are subject to change without notice.  Anything not listed here is
405 |not part of the public API, and should not be used by extension writers at
406 |all.  For these reasons, blindly using functions listed in proto.h is to be
407 |avoided when writing extensions.
408 |
409 |In Perl, unlike C, a string of characters may generally contain embedded
410 |C<NUL> characters.  Sometimes in the documentation a Perl string is referred
411 |to as a "buffer" to distinguish it from a C string, but sometimes they are
412 |both just referred to as strings.
413 |
414 |Note that all Perl API global variables must be referenced with the C<PL_>
415 |prefix.  Again, those not listed here are not to be used by extension writers,
416 |and can be changed or removed without notice; same with macros.
417 |Some macros are provided for compatibility with the older,
418 |unadorned names, but this support may be disabled in a future release.
419 |
420 |Perl was originally written to handle US-ASCII only (that is characters
421 |whose ordinal numbers are in the range 0 - 127).
422 |And documentation and comments may still use the term ASCII, when
423 |sometimes in fact the entire range from 0 - 255 is meant.
424 |
425 |The non-ASCII characters below 256 can have various meanings, depending on
426 |various things.  (See, most notably, L<perllocale>.)  But usually the whole
427 |range can be referred to as ISO-8859-1.  Often, the term "Latin-1" (or
428 |"Latin1") is used as an equivalent for ISO-8859-1.  But some people treat
429 |"Latin1" as referring just to the characters in the range 128 through 255, or
430 |somethimes from 160 through 255.
431 |This documentation uses "Latin1" and "Latin-1" to refer to all 256 characters.
432 |
433 |Note that Perl can be compiled and run under either ASCII or EBCDIC (See
434 |L<perlebcdic>).  Most of the documentation (and even comments in the code)
435 |ignore the EBCDIC possibility.
436 |For almost all purposes the differences are transparent.
437 |As an example, under EBCDIC,
438 |instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
439 |whenever this documentation refers to C<utf8>
440 |(and variants of that name, including in function names),
441 |it also (essentially transparently) means C<UTF-EBCDIC>.
442 |But the ordinals of characters differ between ASCII, EBCDIC, and
443 |the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy a different
444 |number of bytes than in UTF-8.
445 |
446 |The listing below is alphabetical, case insensitive.
447 |
448 _EOB_
449 |
450 |=head1 AUTHORS
451 |
452 |Until May 1997, this document was maintained by Jeff Okamoto
453 |<okamoto@corp.hp.com>.  It is now maintained as part of Perl itself.
454 |
455 |With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
456 |Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
457 |Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
458 |Stephen McCamant, and Gurusamy Sarathy.
459 |
460 |API Listing originally by Dean Roehrich <roehrich@cray.com>.
461 |
462 |Updated to be autogenerated from comments in the source by Benjamin Stuhl.
463 |
464 |=head1 SEE ALSO
465 |
466 |L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
467 |
468 _EOE_
469
470 # List of non-static internal functions
471 my @missing_guts =
472  grep $funcflags{$_}{flags} !~ /[AS]/ && !$docs{guts}{$_}, keys %funcflags;
473
474 output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END');
475 |=head1 NAME
476 |
477 |perlintern - autogenerated documentation of purely B<internal>
478 |                Perl functions
479 |
480 |=head1 DESCRIPTION
481 |X<internal Perl functions> X<interpreter functions>
482 |
483 |This file is the autogenerated documentation of functions in the
484 |Perl interpreter that are documented using Perl's internal documentation
485 |format but are not marked as part of the Perl API.  In other words,
486 |B<they are not for use in extensions>!
487 |
488 END
489 |
490 |=head1 AUTHORS
491 |
492 |The autodocumentation system was originally added to the Perl core by
493 |Benjamin Stuhl.  Documentation is by whoever was kind enough to
494 |document their functions.
495 |
496 |=head1 SEE ALSO
497 |
498 |L<perlguts>, L<perlapi>
499 |
500 END