lib/perl5/5.6.1/pods/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 is_gv_magical
  16
  17 Returns C<TRUE> if given the name of a magical GV.
  18
  19 Currently only useful internally when determining if a GV should be
  20 created even in rvalue contexts.
  21
  22 C<flags> is not used at present but available for future extension to
  23 allow selecting particular classes of magical variable.
  24
  25         bool    is_gv_magical(char *name, STRLEN len, U32 flags)
  26
  27 =for hackers
  28 Found in file gv.c
  29
  30 =item LVRET
  31
  32 True if this op will be the return value of an lvalue subroutine
  33
  34 =for hackers
  35 Found in file pp.h
  36
  37 =item PL_DBsingle
  38
  39 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
  40 boolean which indicates whether subs are being single-stepped.
  41 Single-stepping is automatically turned on after every step.  This is the C
  42 variable which corresponds to Perl's $DB::single variable.  See
  43 C<PL_DBsub>.
  44
  45         SV *    PL_DBsingle
  46
  47 =for hackers
  48 Found in file intrpvar.h
  49
  50 =item PL_DBsub
  51
  52 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
  53 the SV which holds the name of the sub being debugged.  This is the C
  54 variable which corresponds to Perl's $DB::sub variable.  See
  55 C<PL_DBsingle>.
  56
  57         GV *    PL_DBsub
  58
  59 =for hackers
  60 Found in file intrpvar.h
  61
  62 =item PL_DBtrace
  63
  64 Trace variable used when Perl is run in debugging mode, with the B<-d>
  65 switch.  This is the C variable which corresponds to Perl's $DB::trace
  66 variable.  See C<PL_DBsingle>.
  67
  68         SV *    PL_DBtrace
  69
  70 =for hackers
  71 Found in file intrpvar.h
  72
  73 =item PL_dowarn
  74
  75 The C variable which corresponds to Perl's $^W warning variable.
  76
  77         bool    PL_dowarn
  78
  79 =for hackers
  80 Found in file intrpvar.h
  81
  82 =item PL_last_in_gv
  83
  84 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
  85
  86         GV*     PL_last_in_gv
  87
  88 =for hackers
  89 Found in file thrdvar.h
  90
  91 =item PL_ofs_sv
  92
  93 The output field separator - C<$,> in Perl space.
  94
  95         SV*     PL_ofs_sv
  96
  97 =for hackers
  98 Found in file thrdvar.h
  99
 100 =item PL_rs
 101
 102 The input record separator - C<$/> in Perl space.
 103
 104         SV*     PL_rs
 105
 106 =for hackers
 107 Found in file thrdvar.h
 108
 109 =back
 110
 111 =head1 AUTHORS
 112
 113 The autodocumentation system was originally added to the Perl core by
 114 Benjamin Stuhl. Documentation is by whoever was kind enough to
 115 document their functions.
 116
 117 =head1 SEE ALSO
 118
 119 perlguts(1), perlapi(1)
 120