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 invoked as part of 'make all'
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.
30 or die "Couldn't chdir to '$workdir': $!";
32 require 'regen/regen_lib.pl';
33 require 'regen/embed_lib.pl';
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.
52 my $curheader = "Unknown section";
54 sub autodoc ($$) { # parse a file and extract documentation info
56 my($in, $doc, $line, $header_doc);
59 my $get_next_line = sub { $line++; return <$fh> };
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')) {
68 if ($in=~ /^=head1 (.*)/) {
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->())) {
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
91 while (defined($doc = $get_next_line->())) {
97 if ($doc =~ m:^\s*\*/$:) {
98 warn "=cut missing? $file:$line:$doc";;
106 if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
108 $proto = "||$proto" unless $proto =~ /\|/;
109 my($flags, $ret, $name, @args) = split /\|/, $proto;
112 while (defined($doc = $get_next_line->())) {
113 last DOC if $doc =~ /^=\w+/;
114 if ($doc =~ m:^\*/$:) {
115 warn "=cut missing? $file:$line:$doc";;
120 $docs = "\n$docs" if $docs and $docs !~ /^\n/;
122 # Check the consistency of the flags
123 my ($embed_where, $inline_where);
124 my ($embed_may_change, $inline_may_change);
126 my $docref = delete $funcflags{$name};
127 if ($docref and %$docref) {
128 $embed_where = $docref->{flags} =~ /A/ ? 'api' : 'guts';
129 $embed_may_change = $docref->{flags} =~ /M/;
130 $flags .= 'D' if $docref->{flags} =~ /D/;
132 $missing{$name} = $file;
135 $inline_where = $flags =~ /A/ ? 'api' : 'guts';
136 $inline_may_change = $flags =~ /x/;
138 if (defined $embed_where && $inline_where ne $embed_where) {
139 warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
142 if (defined $embed_may_change
143 && $inline_may_change ne $embed_may_change) {
144 my $message = "Function '$name' inconsistency: ";
145 if ($embed_may_change) {
146 $message .= "embed.fnc says 'may change', Pod does not";
148 $message .= "Pod says 'may change', embed.fnc does not";
152 } elsif (!defined $embed_where) {
153 warn "Unable to place $name!\n";
156 $inline_where = $embed_where;
157 $flags .= 'x' if $embed_may_change;
158 @args = @{$docref->{args}};
159 $ret = $docref->{retval};
162 if (exists $docs{$inline_where}{$curheader}{$name}) {
163 warn "$0: duplicate API entry for '$name' in $inline_where/$curheader\n";
166 $docs{$inline_where}{$curheader}{$name}
167 = [$flags, $docs, $ret, $file, @args];
169 # Create a special entry with an empty-string name for the
170 # heading-level documentation.
171 if (defined $header_doc) {
172 $docs{$inline_where}{$curheader}{""} = $header_doc;
177 if ($doc =~ /^=(?:for|head)/) {
182 warn "$file:$line:$in";
188 sub docout ($$$) { # output the docs for one function
189 my($fh, $name, $docref) = @_;
190 my($flags, $docs, $ret, $file, @args) = @$docref;
194 $docs = "\n\nDEPRECATED! It is planned to remove this function from a
195 future release of Perl. Do not use it for new code; remove it from
196 existing code.\n\n$docs";
199 $docs = "\n\nNOTE: this function is experimental and may change or be
200 removed without notice.\n\n$docs" if $flags =~ /x/;
202 $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
204 $docs .= "NOTE: this function must be explicitly called as Perl_$name with an aTHX_ parameter.\n\n"
207 print $fh "=item $name\nX<$name>\n$docs";
209 if ($flags =~ /U/) { # no usage
211 } elsif ($flags =~ /s/) { # semicolon ("dTHR;")
212 print $fh "\t\t$name;\n\n";
213 } elsif ($flags =~ /n/) { # no args
214 print $fh "\t$ret\t$name\n\n";
215 } else { # full usage
216 my $p = $flags =~ /o/; # no #define foo Perl_foo
217 my $n = "Perl_"x$p . $name;
218 my $large_ret = length $ret > 7;
219 my $indent_size = 7+8 # nroff: 7 under =head + 8 under =item
220 +8+($large_ret ? 1 + length $ret : 8)
223 print $fh "\t$ret" . ($large_ret ? ' ' : "\t") . "$n(";
226 if ($indent_size + 2 + length > 79) {
228 $indent_size -= length($n) - 3;
234 $args = @args ? "pTHX_ " : "pTHX";
235 if ($long_args) { print $fh $args; $args = '' }
237 $long_args and print $fh "\n";
238 my $first = !$long_args;
242 && $indent_size + 3 + length($args[0]) + length $args > 79
247 "\t".($large_ret ? " " x (1+length $ret) : "\t")
248 ." "x($long_args ? 4 : 1 + length $n)
250 $args, (","x($args ne 'pTHX_ ') . "\n")x!!@args;
254 $args .= ", "x!!(length $args && $args ne 'pTHX_ ')
257 if ($long_args) { print $fh "\n", substr $indent, 0, -4 }
260 print $fh "=for hackers\nFound in file $file\n\n";
264 # Do a case-insensitive dictionary sort, with only alphabetics
265 # significant, falling back to using everything for determinancy
266 return (uc($a =~ s/[[^:alpha]]//r) cmp uc($b =~ s/[[^:alpha]]//r))
272 my ($podname, $header, $dochash, $missing, $footer) = @_;
273 my $fh = open_new("pod/$podname.pod", undef,
274 {by => "$0 extracting documentation",
275 from => 'the C source files'}, 1);
280 for $key (sort sort_helper keys %$dochash) {
281 my $section = $dochash->{$key};
282 print $fh "\n=head1 $key\n\n";
284 # Output any heading-level documentation and delete so won't get in
286 if (exists $section->{""}) {
287 print $fh $section->{""} . "\n";
288 delete $section->{""};
290 print $fh "=over 8\n\n";
292 for my $key (sort sort_helper keys %$section) {
293 docout($fh, $key, $section->{$key});
295 print $fh "\n=back\n";
299 print $fh "\n=head1 Undocumented functions\n\n";
300 print $fh $podname eq 'perlapi' ? <<'_EOB_' : <<'_EOB_';
301 The following functions have been flagged as part of the public API,
302 but are currently undocumented. Use them at your own risk, as the
303 interfaces are subject to change. Functions that are not listed in this
304 document are not intended for public use, and should NOT be used under any
307 If you feel you need to use one of these functions, first send email to
308 L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>. It may be
309 that there is a good reason for the function not being documented, and it
310 should be removed from this list; or it may just be that no one has gotten
311 around to documenting it. In the latter case, you will be asked to submit a
312 patch to document the function. Once your patch is accepted, it will indicate
313 that the interface is stable (unless it is explicitly marked otherwise) and
319 The following functions are currently undocumented. If you use one of
320 them, you may wish to consider creating and submitting documentation for
326 for my $missing (sort @$missing) {
327 print $fh "=item $missing\nX<$missing>\n\n";
329 print $fh "=back\n\n";
331 print $fh $footer, "=cut\n";
333 read_only_bottom_close_and_rename($fh);
336 foreach (@{(setup_embed())[0]}) {
338 my ($flags, $retval, $func, @args) = @$_;
339 s/\b(?:NN|NULLOK)\b\s+//g for @args;
341 $funcflags{$func} = {
348 # glob() picks up docs from extra .c or .h files that may be in unclean
350 open my $fh, '<', 'MANIFEST'
351 or die "Can't open MANIFEST: $!";
352 while (my $line = <$fh>) {
353 next unless my ($file) = $line =~ /^(\S+\.[ch])\t/;
355 open F, "< $file" or die "Cannot open $file for docs: $!\n";
356 $curheader = "Functions in file $file\n";
358 close F or die "Error closing $file: $!\n";
360 close $fh or die "Error whilst reading MANIFEST: $!";
362 for (sort keys %funcflags) {
363 next unless $funcflags{$_}{flags} =~ /d/;
364 warn "no docs for $_\n"
367 foreach (sort keys %missing) {
369 # Heuristics for known not-a-function macros:
373 warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
376 # walk table providing an array of components in each line to
377 # subroutine, printing the result
379 # List of funcs in the public API that aren't also marked as experimental nor
381 my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && $funcflags{$_}{flags} !~ /[MD]/ && !$docs{api}{$_}, keys %funcflags;
382 output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_');
385 perlapi - autogenerated documentation for the perl public API
388 X<Perl API> X<API> X<api>
390 This file contains the documentation of the perl public API generated by
391 F<embed.pl>, specifically a listing of functions, macros, flags, and variables
392 that may be used by extension writers. L<At the end|/Undocumented functions>
393 is a list of functions which have yet to be documented. The interfaces of
394 those are subject to change without notice. Anything not listed here is
395 not part of the public API, and should not be used by extension writers at
396 all. For these reasons, blindly using functions listed in proto.h is to be
397 avoided when writing extensions.
399 Note that all Perl API global variables must be referenced with the C<PL_>
400 prefix. Again, those not listed here are not to be used by extension writers,
401 and can be changed or removed without notice; same with macros.
402 Some macros are provided for compatibility with the older,
403 unadorned names, but this support may be disabled in a future release.
405 Perl was originally written to handle US-ASCII only (that is characters
406 whose ordinal numbers are in the range 0 - 127).
407 And documentation and comments may still use the term ASCII, when
408 sometimes in fact the entire range from 0 - 255 is meant.
410 Note that Perl can be compiled and run under either ASCII or EBCDIC (See
411 L<perlebcdic>). Most of the documentation (and even comments in the code)
412 ignore the EBCDIC possibility.
413 For almost all purposes the differences are transparent.
414 As an example, under EBCDIC,
415 instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
416 whenever this documentation refers to C<utf8>
417 (and variants of that name, including in function names),
418 it also (essentially transparently) means C<UTF-EBCDIC>.
419 But the ordinals of characters differ between ASCII, EBCDIC, and
420 the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytes
423 The listing below is alphabetical, case insensitive.
429 Until May 1997, this document was maintained by Jeff Okamoto
430 <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
432 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
433 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
434 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
435 Stephen McCamant, and Gurusamy Sarathy.
437 API Listing originally by Dean Roehrich <roehrich@cray.com>.
439 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
443 L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
447 # List of non-static internal functions
449 grep $funcflags{$_}{flags} !~ /[As]/ && !$docs{guts}{$_}, keys %funcflags;
451 output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END');
454 perlintern - autogenerated documentation of purely B<internal>
458 X<internal Perl functions> X<interpreter functions>
460 This file is the autogenerated documentation of functions in the
461 Perl interpreter that are documented using Perl's internal documentation
462 format but are not marked as part of the Perl API. In other words,
463 B<they are not for use in extensions>!
469 The autodocumentation system was originally added to the Perl core by
470 Benjamin Stuhl. Documentation is by whoever was kind enough to
471 document their functions.
475 L<perlguts>, L<perlapi>