X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperlintern.pod;h=544b87887f9f929bc0adba6455136ab871896044;hb=6aa71d6ea27a640886ba2dcf7250d1be73560df8;hp=8afabd90f001e811a9ba914d6727218218695d6e;hpb=4b19af017623bfa3bb72bb164598a517f586e0d3;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perlintern.pod b/pod/perlintern.pod index 8afabd9..544b878 100644 --- a/pod/perlintern.pod +++ b/pod/perlintern.pod @@ -1,17 +1,29 @@ =head1 NAME -perlintern - autogenerated documentation of purely B +perlintern - autogenerated documentation of purely B Perl functions =head1 DESCRIPTION -This file is the autogenerated documentation of functions in the +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, +format but are not marked as part of the Perl API. In other words, B! =over 8 +=item djSP + +Declare Just C. This is actually identical to C, and declares +a local copy of perl's stack pointer, available via the C macro. +See C. (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 if given the name of a magical GV. @@ -27,12 +39,152 @@ allow selecting particular classes of magical variable. =for hackers Found in file gv.c +=item LVRET + +True if this op will be the return value of an lvalue subroutine + +=for hackers +Found in file pp.h + +=item PL_DBsingle + +When Perl is run in debugging mode, with the B<-d> switch, this SV is a +boolean which indicates whether subs are being single-stepped. +Single-stepping is automatically turned on after every step. This is the C +variable which corresponds to Perl's $DB::single variable. See +C. + + SV * PL_DBsingle + +=for hackers +Found in file intrpvar.h + +=item PL_DBsub + +When Perl is run in debugging mode, with the B<-d> switch, this GV contains +the SV which holds the name of the sub being debugged. This is the C +variable which corresponds to Perl's $DB::sub variable. See +C. + + GV * PL_DBsub + +=for hackers +Found in file intrpvar.h + +=item PL_DBtrace + +Trace variable used when Perl is run in debugging mode, with the B<-d> +switch. This is the C variable which corresponds to Perl's $DB::trace +variable. See C. + + SV * PL_DBtrace + +=for hackers +Found in file intrpvar.h + +=item PL_dowarn + +The C variable which corresponds to Perl's $^W warning variable. + + bool PL_dowarn + +=for hackers +Found in file intrpvar.h + +=item PL_last_in_gv + +The GV which was last used for a filehandle input operation. (C<< >>) + + GV* PL_last_in_gv + +=for hackers +Found in file thrdvar.h + +=item PL_ofs_sv + +The output field separator - C<$,> in Perl space. + + SV* PL_ofs_sv + +=for hackers +Found in file thrdvar.h + +=item PL_rs + +The input record separator - C<$/> in Perl space. + + SV* PL_rs + +=for hackers +Found in file thrdvar.h + +=item report_uninit + +Print appropriate "Use of uninitialized variable" warning + + void report_uninit() + +=for hackers +Found in file sv.c + +=item start_glob + +Function called by C to spawn a glob (or do the glob inside +perl on VMS). This code used to be inline, but now perl uses C +this glob starter is only used by miniperl during the build process. +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 + +=item sv_add_arena + +Given a chunk of memory, link it to the head of the list of arenas, +and split it into a list of free SVs. + + void sv_add_arena(char* ptr, U32 size, U32 flags) + +=for hackers +Found in file sv.c + +=item sv_clean_all + +Decrement the refcnt of each remaining SV, possibly triggering a +cleanup. This function may have to be called multiple times to free +SVs which are in complex self-referential hierarchies. + + I32 sv_clean_all() + +=for hackers +Found in file sv.c + +=item sv_clean_objs + +Attempt to destroy all objects not yet freed + + void sv_clean_objs() + +=for hackers +Found in file sv.c + +=item sv_free_arenas + +Deallocate the memory used by all arenas. Note that all the individual SV +heads and bodies within the arenas must already have been freed. + + void sv_free_arenas() + +=for hackers +Found in file sv.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 +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