[perl5.git] / autodoc.pl

#!/usr/bin/perl -w
# 
# Unconditionally regenerate:
#
#    pod/perlintern.pod
#    pod/perlapi.pod
#
# from information stored in
#
#    embed.fnc
#    plus all the .c and .h files listed in MANIFEST
#
# Has an optional arg, which is the directory to chdir to before reading
# MANIFEST and *.[ch].
#
# This script is invoked as part of 'make all'
#
# '=head1' are the only headings looked for.  If the first non-blank line after
# the heading begins with a word character, it is considered to be the first 
# line of documentation that applies to the heading itself.  That is, it is 
# output immediately after the heading, before the first function, and not 
# indented. The next input line that is a pod directive terminates this 
# heading-level documentation.

use strict;

if (@ARGV) {
    my $workdir = shift;
    chdir $workdir
        or die "Couldn't chdir to '$workdir': $!";
}
require './regen/regen_lib.pl';
require './regen/embed_lib.pl';

#
# See database of global and static function prototypes in embed.fnc
# This is used to generate prototype headers under various configurations,
# export symbols lists for different platforms, and macros to provide an
# implicit interpreter context argument.
#

my %docs;
my %funcflags;
my %macro = (
	     ax => 1,
	     items => 1,
	     ix => 1,
	     svtype => 1,
	    );
my %missing;

my $curheader = "Unknown section";

sub autodoc ($$) { # parse a file and extract documentation info
    my($fh,$file) = @_;
    my($in, $doc, $line, $header_doc);

    # Count lines easier
    my $get_next_line = sub { $line++; return <$fh> };

FUNC:
    while (defined($in = $get_next_line->())) {
	if ($in =~ /^#\s*define\s+([A-Za-z_][A-Za-z_0-9]+)\(/ &&
	    ($file ne 'embed.h' || $file ne 'proto.h')) {
	    $macro{$1} = $file;
	    next FUNC;
	}
        if ($in=~ /^=head1 (.*)/) {
            $curheader = $1;

            # If the next non-space line begins with a word char, then it is
            # the start of heading-ldevel documentation.
	    if (defined($doc = $get_next_line->())) {
                # Skip over empty lines
                while ($doc =~ /^\s+$/) {
                    if (! defined($doc = $get_next_line->())) {
                        next FUNC;
                    }
                }

                if ($doc !~ /^\w/) {
                    $in = $doc;
                    redo FUNC;
                }
                $header_doc = $doc;

                # Continue getting the heading-level documentation until read
                # in any pod directive (or as a fail-safe, find a closing
                # comment to this pod in a C language file
HDR_DOC:
                while (defined($doc = $get_next_line->())) {
                    if ($doc =~ /^=\w/) {
                        $in = $doc;
                        redo FUNC;
                    }

                    if ($doc =~ m:^\s*\*/$:) {
                        warn "=cut missing? $file:$line:$doc";;
                        last HDR_DOC;
                    }
                    $header_doc .= $doc;
                }
            }
            next FUNC;
        }
	if ($in =~ /^=for\s+apidoc\s+(.*?)\s*\n/) {
	    my $proto = $1;
	    $proto = "||$proto" unless $proto =~ /\|/;
	    my($flags, $ret, $name, @args) = split /\|/, $proto;
	    my $docs = "";
DOC:
	    while (defined($doc = $get_next_line->())) {

                # Other pod commands are considered part of the current
                # function's docs, so can have lists, etc.
                last DOC if $doc =~ /^=(cut|for\s+apidoc|head)/;
		if ($doc =~ m:^\*/$:) {
		    warn "=cut missing? $file:$line:$doc";;
		    last DOC;
                }
		$docs .= $doc;
	    }
	    $docs = "\n$docs" if $docs and $docs !~ /^\n/;

	    # Check the consistency of the flags
	    my ($embed_where, $inline_where);
	    my ($embed_may_change, $inline_may_change);

	    my $docref = delete $funcflags{$name};
	    if ($docref and %$docref) {
		$embed_where = $docref->{flags} =~ /A/ ? 'api' : 'guts';
		$embed_may_change = $docref->{flags} =~ /M/;
                $flags .= 'D' if $docref->{flags} =~ /D/;
	    } else {
		$missing{$name} = $file;
	    }
	    if ($flags =~ /m/) {
		$inline_where = $flags =~ /A/ ? 'api' : 'guts';
		$inline_may_change = $flags =~ /x/;

		if (defined $embed_where && $inline_where ne $embed_where) {
		    warn "Function '$name' inconsistency: embed.fnc says $embed_where, Pod says $inline_where";
		}

		if (defined $embed_may_change
		    && $inline_may_change ne $embed_may_change) {
		    my $message = "Function '$name' inconsistency: ";
		    if ($embed_may_change) {
			$message .= "embed.fnc says 'may change', Pod does not";
		    } else {
			$message .= "Pod says 'may change', embed.fnc does not";
		    }
		    warn $message;
		}
	    } elsif (!defined $embed_where) {
		warn "Unable to place $name!\n";
		next;
	    } else {
		$inline_where = $embed_where;
		$flags .= 'x' if $embed_may_change;
		@args = @{$docref->{args}};
		$ret = $docref->{retval};
	    }

	    if (exists $docs{$inline_where}{$curheader}{$name}) {
                warn "$0: duplicate API entry for '$name' in $inline_where/$curheader\n";
                next;
            }
	    $docs{$inline_where}{$curheader}{$name}
		= [$flags, $docs, $ret, $file, @args];

            # Create a special entry with an empty-string name for the
            # heading-level documentation.
	    if (defined $header_doc) {
                $docs{$inline_where}{$curheader}{""} = $header_doc;
                undef $header_doc;
            }

	    if (defined $doc) {
		if ($doc =~ /^=(?:for|head)/) {
		    $in = $doc;
		    redo FUNC;
		}
	    } else {
		warn "$file:$line:$in";
	    }
	}
    }
}

sub docout ($$$) { # output the docs for one function
    my($fh, $name, $docref) = @_;
    my($flags, $docs, $ret, $file, @args) = @$docref;
    $name =~ s/\s*$//;

    if ($flags =~ /D/) {
        $docs = "\n\nDEPRECATED!  It is planned to remove this function from a
future release of Perl.  Do not use it for new code; remove it from
existing code.\n\n$docs";
    }
    else {
        $docs = "\n\nNOTE: this function is experimental and may change or be
removed without notice.\n\n$docs" if $flags =~ /x/;
    }
    $docs .= "NOTE: the perl_ form of this function is deprecated.\n\n"
	if $flags =~ /p/;
    $docs .= "NOTE: this function must be explicitly called as Perl_$name with an aTHX_ parameter.\n\n"
        if $flags =~ /o/;

    print $fh "=item $name\nX<$name>\n$docs";

    if ($flags =~ /U/) { # no usage
	# nothing
    } elsif ($flags =~ /s/) { # semicolon ("dTHR;")
	print $fh "\t\t$name;\n\n";
    } elsif ($flags =~ /n/) { # no args
	print $fh "\t$ret\t$name\n\n";
    } else { # full usage
	my $p            = $flags =~ /o/; # no #define foo Perl_foo
	my $n            = "Perl_"x$p . $name;
	my $large_ret    = length $ret > 7;
	my $indent_size  = 7+8 # nroff: 7 under =head + 8 under =item
	                  +8+($large_ret ? 1 + length $ret : 8)
	                  +length($n) + 1;
	my $indent;
	print $fh "\t$ret" . ($large_ret ? ' ' : "\t") . "$n(";
	my $long_args;
	for (@args) {
	    if ($indent_size + 2 + length > 79) {
		$long_args=1;
		$indent_size -= length($n) - 3;
		last;
	    }
	}
	my $args = '';
	if ($p) {
	    $args = @args ? "pTHX_ " : "pTHX";
	    if ($long_args) { print $fh $args; $args = '' }
	}
	$long_args and print $fh "\n";
	my $first = !$long_args;
	while () {
	    if (!@args or
	         length $args
	         && $indent_size + 3 + length($args[0]) + length $args > 79
	    ) {
		print $fh
		  $first ? '' : (
		    $indent //=
		       "\t".($large_ret ? " " x (1+length $ret) : "\t")
		      ." "x($long_args ? 4 : 1 + length $n)
		  ),
		  $args, (","x($args ne 'pTHX_ ') . "\n")x!!@args;
		$args = $first = '';
	    }
	    @args or last;
	    $args .= ", "x!!(length $args && $args ne 'pTHX_ ')
	           . shift @args;
	}
	if ($long_args) { print $fh "\n", substr $indent, 0, -4 }
	print $fh ")\n\n";
    }
    print $fh "=for hackers\nFound in file $file\n\n";
}

sub sort_helper {
    # Do a case-insensitive dictionary sort, with only alphabetics
    # significant, falling back to using everything for determinancy
    return (uc($a =~ s/[[:^alpha:]]//r) cmp uc($b =~ s/[[:^alpha:]]//r))
           || uc($a) cmp uc($b)
           || $a cmp $b;
}

sub output {
    my ($podname, $header, $dochash, $missing, $footer) = @_;
    #
    # strip leading '|' from each line which had been used to hide
    # pod from pod checkers.
    s/^\|//gm for $header, $footer;

    my $fh = open_new("pod/$podname.pod", undef,
		      {by => "$0 extracting documentation",
                       from => 'the C source files'}, 1);

    print $fh $header;

    my $key;
    for $key (sort sort_helper keys %$dochash) {
	my $section = $dochash->{$key}; 
	print $fh "\n=head1 $key\n\n";

        # Output any heading-level documentation and delete so won't get in
        # the way later
        if (exists $section->{""}) {
            print $fh $section->{""} . "\n";
            delete $section->{""};
        }
	print $fh "=over 8\n\n";

	for my $key (sort sort_helper keys %$section) {
	    docout($fh, $key, $section->{$key});
	}
	print $fh "\n=back\n";
    }

    if (@$missing) {
        print $fh "\n=head1 Undocumented functions\n\n";
    print $fh $podname eq 'perlapi' ? <<'_EOB_' : <<'_EOB_';
The following functions have been flagged as part of the public API,
but are currently undocumented.  Use them at your own risk, as the
interfaces are subject to change.  Functions that are not listed in this
document are not intended for public use, and should NOT be used under any
circumstances.

If you feel you need to use one of these functions, first send email to
L<perl5-porters@perl.org|mailto:perl5-porters@perl.org>.  It may be
that there is a good reason for the function not being documented, and it
should be removed from this list; or it may just be that no one has gotten
around to documenting it.  In the latter case, you will be asked to submit a
patch to document the function.  Once your patch is accepted, it will indicate
that the interface is stable (unless it is explicitly marked otherwise) and
usable by you.
_EOB_
The following functions are currently undocumented.  If you use one of
them, you may wish to consider creating and submitting documentation for
it.
_EOB_
    print $fh "\n=over\n\n";

    for my $missing (sort @$missing) {
        print $fh "=item $missing\nX<$missing>\n\n";
    }
    print $fh "=back\n\n";
}
    print $fh $footer, "=cut\n";

    read_only_bottom_close_and_rename($fh);
}

foreach (@{(setup_embed())[0]}) {
    next if @$_ < 2;
    my ($flags, $retval, $func, @args) = @$_;
    s/\b(?:NN|NULLOK)\b\s+//g for @args;

    $funcflags{$func} = {
			 flags => $flags,
			 retval => $retval,
			 args => \@args,
			};
}

# glob() picks up docs from extra .c or .h files that may be in unclean
# development trees.
open my $fh, '<', 'MANIFEST'
    or die "Can't open MANIFEST: $!";
while (my $line = <$fh>) {
    next unless my ($file) = $line =~ /^(\S+\.[ch])\t/;

    open F, '<', $file or die "Cannot open $file for docs: $!\n";
    $curheader = "Functions in file $file\n";
    autodoc(\*F,$file);
    close F or die "Error closing $file: $!\n";
}
close $fh or die "Error whilst reading MANIFEST: $!";

for (sort keys %funcflags) {
    next unless $funcflags{$_}{flags} =~ /d/;
    warn "no docs for $_\n"
}

foreach (sort keys %missing) {
    next if $macro{$_};
    # Heuristics for known not-a-function macros:
    next if /^[A-Z]/;
    next if /^dj?[A-Z]/;

    warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";
}

# walk table providing an array of components in each line to
# subroutine, printing the result

# List of funcs in the public API that aren't also marked as experimental nor
# deprecated.
my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && $funcflags{$_}{flags} !~ /[MD]/ && !$docs{api}{$_}, keys %funcflags;
output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_');
|=encoding UTF-8
|
|=head1 NAME
|
|perlapi - autogenerated documentation for the perl public API
|
|=head1 DESCRIPTION
|X<Perl API> X<API> X<api>
|
|This file contains the documentation of the perl public API generated by
|F<embed.pl>, specifically a listing of functions, macros, flags, and variables
|that may be used by extension writers.  L<At the end|/Undocumented functions>
|is a list of functions which have yet to be documented.  The interfaces of
|those are subject to change without notice.  Anything not listed here is
|not part of the public API, and should not be used by extension writers at
|all.  For these reasons, blindly using functions listed in proto.h is to be
|avoided when writing extensions.
|
|In Perl, unlike C, a string of characters may generally contain embedded
|C<NUL> characters.  Sometimes in the documentation a Perl string is referred
|to as a "buffer" to distinguish it from a C string, but sometimes they are
|both just referred to as strings.
|
|Note that all Perl API global variables must be referenced with the C<PL_>
|prefix.  Again, those not listed here are not to be used by extension writers,
|and can be changed or removed without notice; same with macros.
|Some macros are provided for compatibility with the older,
|unadorned names, but this support may be disabled in a future release.
|
|Perl was originally written to handle US-ASCII only (that is characters
|whose ordinal numbers are in the range 0 - 127).
|And documentation and comments may still use the term ASCII, when
|sometimes in fact the entire range from 0 - 255 is meant.
|
|The non-ASCII characters below 256 can have various meanings, depending on
|various things.  (See, most notably, L<perllocale>.)  But usually the whole
|range can be referred to as ISO-8859-1.  Often, the term "Latin-1" (or
|"Latin1") is used as an equivalent for ISO-8859-1.  But some people treat
|"Latin1" as referring just to the characters in the range 128 through 255, or
|somethimes from 160 through 255.
|This documentation uses "Latin1" and "Latin-1" to refer to all 256 characters.
|
|Note that Perl can be compiled and run under either ASCII or EBCDIC (See
|L<perlebcdic>).  Most of the documentation (and even comments in the code)
|ignore the EBCDIC possibility.
|For almost all purposes the differences are transparent.
|As an example, under EBCDIC,
|instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so
|whenever this documentation refers to C<utf8>
|(and variants of that name, including in function names),
|it also (essentially transparently) means C<UTF-EBCDIC>.
|But the ordinals of characters differ between ASCII, EBCDIC, and
|the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy a different
|number of bytes than in UTF-8.
|
|The listing below is alphabetical, case insensitive.
|
_EOB_
|
|=head1 AUTHORS
|
|Until May 1997, this document was maintained by Jeff Okamoto
|<okamoto@corp.hp.com>.  It is now maintained as part of Perl itself.
|
|With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
|Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
|Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
|Stephen McCamant, and Gurusamy Sarathy.
|
|API Listing originally by Dean Roehrich <roehrich@cray.com>.
|
|Updated to be autogenerated from comments in the source by Benjamin Stuhl.
|
|=head1 SEE ALSO
|
|L<perlguts>, L<perlxs>, L<perlxstut>, L<perlintern>
|
_EOE_

# List of non-static internal functions
my @missing_guts =
 grep $funcflags{$_}{flags} !~ /[As]/ && !$docs{guts}{$_}, keys %funcflags;

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