[p5sagit/p5-mst-13.2.git] / pod / perlintern.pod

=head1 NAME

perlintern - autogenerated documentation of purely B<internal>
		 Perl functions

=head1 DESCRIPTION

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>!

=over 8

=item djSP

Declare Just C<SP>. This is actually identical to C<dSP>, and declares
a local copy of perl's stack pointer, available via the C<SP> macro.
See C<SP>.  (Available for backward source code compatibility with the
old (Perl 5.005) thread model.)

		djSP;

=for hackers
Found in file pp.h

=item is_gv_magical

Returns C<TRUE> if given the name of a magical GV.

Currently only useful internally when determining if a GV should be
created even in rvalue contexts.

C<flags> is not used at present but available for future extension to
allow selecting particular classes of magical variable.

	bool	is_gv_magical(char *name, STRLEN len, U32 flags)

=for hackers
Found in file gv.c

=item start_glob

Function called by C<do_readline> to spawn a glob (or do the glob inside
perl on VMS). This code used to be inline, but now perl uses C<File::Glob>
this glob starter is only used by miniperl during the build proccess.
Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up.

	PerlIO*	start_glob(SV* pattern, IO *io)

=for hackers
Found in file doio.c

=back

=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

perlguts(1), perlapi(1)
Commit	Line	Data
cb50131a	1	=head1 NAME
cb50131a	2
22d4bb9c	3	perlintern - autogenerated documentation of purely B<internal>
cb50131a	4	Perl functions
	5
	6	=head1 DESCRIPTION
	7
22d4bb9c	8	This file is the autogenerated documentation of functions in the
ee8c7f54	9	Perl interpreter that are documented using Perl's internal documentation
22d4bb9c	10	format but are not marked as part of the Perl API. In other words,
cb50131a	11	B<they are not for use in extensions>!
	12
	13	=over 8
	14
0e06870b	15	=item djSP
	16
	17	Declare Just C<SP>. This is actually identical to C<dSP>, and declares
	18	a local copy of perl's stack pointer, available via the C<SP> macro.
	19	See C<SP>. (Available for backward source code compatibility with the
	20	old (Perl 5.005) thread model.)
	21
	22	djSP;
	23
	24	=for hackers
	25	Found in file pp.h
	26
4b19af01	27	=item is_gv_magical
	28
	29	Returns C<TRUE> if given the name of a magical GV.
	30
	31	Currently only useful internally when determining if a GV should be
	32	created even in rvalue contexts.
	33
	34	C<flags> is not used at present but available for future extension to
	35	allow selecting particular classes of magical variable.
	36
	37	bool is_gv_magical(char *name, STRLEN len, U32 flags)
	38
	39	=for hackers
	40	Found in file gv.c
	41
0e06870b	42	=item start_glob
	43
	44	Function called by C<do_readline> to spawn a glob (or do the glob inside
	45	perl on VMS). This code used to be inline, but now perl uses C<File::Glob>
	46	this glob starter is only used by miniperl during the build proccess.
	47	Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up.
	48
	49	PerlIO* start_glob(SV* pattern, IO *io)
	50
	51	=for hackers
	52	Found in file doio.c
	53
cb50131a	54	=back
	55
	56	=head1 AUTHORS
	57
22d4bb9c	58	The autodocumentation system was originally added to the Perl core by
22d4bb9c	59	Benjamin Stuhl. Documentation is by whoever was kind enough to
cb50131a	60	document their functions.
	61
	62	=head1 SEE ALSO
	63
	64	perlguts(1), perlapi(1)
	65