pod/perlintern.pod

   1 =head1 NAME
   2
   3 perlintern - autogenerated documentation of purely B<internal>
   4                  Perl functions
   5
   6 =head1 DESCRIPTION
   7
   8 This file is the autogenerated documentation of functions in the
   9 Perl interpreter that are documented using Perl's internal documentation
  10 format but are not marked as part of the Perl API. In other words,
  11 B<they are not for use in extensions>!
  12
  13 =over 8
  14
  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
  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
  42 =item LVRET
  43
  44 True if this op will be the return value of an lvalue subroutine
  45
  46 =for hackers
  47 Found in file pp.h
  48
  49 =item start_glob
  50
  51 Function called by C<do_readline> to spawn a glob (or do the glob inside
  52 perl on VMS). This code used to be inline, but now perl uses C<File::Glob>
  53 this glob starter is only used by miniperl during the build proccess.
  54 Moving it away shrinks pp_hot.c; shrinking pp_hot.c helps speed perl up.
  55
  56         PerlIO* start_glob(SV* pattern, IO *io)
  57
  58 =for hackers
  59 Found in file doio.c
  60
  61 =back
  62
  63 =head1 AUTHORS
  64
  65 The autodocumentation system was originally added to the Perl core by
  66 Benjamin Stuhl. Documentation is by whoever was kind enough to
  67 document their functions.
  68
  69 =head1 SEE ALSO
  70
  71 perlguts(1), perlapi(1)
  72