This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Convert Pod::Html to lexical file handles.
[perl5.git] / intrpvar.h
index 5d583f0..febf037 100644 (file)
@@ -1,8 +1,7 @@
 /*   intrpvar.h 
  *
  *    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
- *    2006, 2007
- *    by Larry Wall and others
+ *    2006, 2007, 2008 by Larry Wall and others
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
@@ -16,7 +15,7 @@
 /* These variables are per-interpreter in threaded/multiplicity builds,
  * global otherwise.
 
- * Don't forget to re-run embed.pl to propagate changes! */
+ * Don't forget to re-run regen/embed.pl to propagate changes! */
 
 /* New variables must be added to the very end for binary compatibility.
  * XSUB.h provides wrapper functions via perlapi.h that make this
@@ -44,6 +43,9 @@ PERLVAR(Istack_base,  SV **)
 PERLVAR(Istack_max,    SV **)
 
 PERLVAR(Iscopestack,   I32 *)          /* scopes we've ENTERed */
+/* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
+   present always, as -DDEUBGGING must be binary compatible with non.  */
+PERLVARI(Iscopestack_name, const char * *, NULL)
 PERLVAR(Iscopestack_ix,        I32)
 PERLVAR(Iscopestack_max,I32)
 
@@ -56,7 +58,7 @@ PERLVAR(Itmps_stack,  SV **)          /* mortals we've made */
 PERLVARI(Itmps_ix,     I32,    -1)
 PERLVARI(Itmps_floor,  I32,    -1)
 PERLVAR(Itmps_max,     I32)
-PERLVAR(Imodcount,     I32)            /* how much mod()ification in
+PERLVAR(Imodcount,     I32)            /* how much op_lvalue()ification in
                                           assignment? */
 
 PERLVAR(Imarkstack,    I32 *)          /* stack_sp locations we're
@@ -103,16 +105,16 @@ The input record separator - C<$/> in Perl space.
 
 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
 
-=for apidoc mn|SV*|PL_ofs_sv
+=for apidoc mn|GV*|PL_ofsgv
 
-The output field separator - C<$,> in Perl space.
+The glob containing the output field separator - C<*,> in Perl space.
 
 =cut
 */
 
 PERLVAR(Irs,           SV *)           /* input record separator $/ */
 PERLVAR(Ilast_in_gv,   GV *)           /* GV used in last <FH> */
-PERLVAR(Iofs_sv,       SV *)           /* output field separator $, */
+PERLVAR(Iofsgv,                GV *)           /* GV of output field separator *, */
 PERLVAR(Idefoutgv,     GV *)           /* default FH for output */
 PERLVARI(Ichopset,     const char *, " \n-")   /* $: */
 PERLVAR(Iformtarget,   SV *)
@@ -124,7 +126,8 @@ PERLVAR(Idefstash,  HV *)           /* main symbol table */
 PERLVAR(Icurstash,     HV *)           /* symbol table for current package */
 
 PERLVAR(Irestartop,    OP *)           /* propagating an error from croak? */
-PERLVAR(Icurcop,       COP * VOL)
+PERLVAR(Irestartjmpenv,        JMPENV *)       /* target frame for longjmp in die */
+PERLVAR(Icurcop,       COP *)
 PERLVAR(Icurstack,     AV *)           /* THE STACK */
 PERLVAR(Icurstackinfo, PERL_SI *)      /* current stack + context */
 PERLVAR(Imainstack,    AV *)           /* the stack when nothing funny is
@@ -168,8 +171,66 @@ PERLVARI(Irehash_seed_set, bool, FALSE)    /* 582 hash initialized? */
 
 PERLVARA(Icolors,6,    char *)         /* from regcomp.c */
 
-PERLVARI(Ipeepp,       peep_t, MEMBER_TO_FPTR(Perl_peep))
-                                       /* Pointer to peephole optimizer */
+/*
+=for apidoc Amn|peep_t|PL_peepp
+
+Pointer to the per-subroutine peephole optimiser.  This is a function
+that gets called at the end of compilation of a Perl subroutine (or
+equivalently independent piece of Perl code) to perform fixups of
+some ops and to perform small-scale optimisations.  The function is
+called once for each subroutine that is compiled, and is passed, as sole
+parameter, a pointer to the op that is the entry point to the subroutine.
+It modifies the op tree in place.
+
+The peephole optimiser should never be completely replaced.  Rather,
+add code to it by wrapping the existing optimiser.  The basic way to do
+this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
+If the new code wishes to operate on ops throughout the subroutine's
+structure, rather than just at the top level, it is likely to be more
+convenient to wrap the L</PL_rpeepp> hook.
+
+=cut
+*/
+
+PERLVARI(Ipeepp,       peep_t, Perl_peep)
+
+/*
+=for apidoc Amn|peep_t|PL_rpeepp
+
+Pointer to the recursive peephole optimiser.  This is a function
+that gets called at the end of compilation of a Perl subroutine (or
+equivalently independent piece of Perl code) to perform fixups of some
+ops and to perform small-scale optimisations.  The function is called
+once for each chain of ops linked through their C<op_next> fields;
+it is recursively called to handle each side chain.  It is passed, as
+sole parameter, a pointer to the op that is at the head of the chain.
+It modifies the op tree in place.
+
+The peephole optimiser should never be completely replaced.  Rather,
+add code to it by wrapping the existing optimiser.  The basic way to do
+this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
+If the new code wishes to operate only on ops at a subroutine's top level,
+rather than throughout the structure, it is likely to be more convenient
+to wrap the L</PL_peepp> hook.
+
+=cut
+*/
+
+PERLVARI(Irpeepp,      peep_t, Perl_rpeep)
+
+/*
+=for apidoc Amn|Perl_ophook_t|PL_opfreehook
+
+When non-C<NULL>, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument.
+This allows extensions to free any extra attribute they have locally attached to an OP.
+It is also assured to first fire for the parent OP and then for its kids.
+
+When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own.
+
+=cut
+*/
+
+PERLVARI(Iopfreehook,  Perl_ophook_t, 0) /* op_free() hook */
 
 PERLVARI(Imaxscream,   I32,    -1)
 PERLVARI(Ireginterp_cnt,I32,    0)     /* Whether "Regexp" was interpolated. */
@@ -187,14 +248,16 @@ PERLVAR(Iregmatch_state, regmatch_state *)
 PERLVAR(Idelaymagic,   U16)            /* ($<,$>) = ... */
 PERLVAR(Ilocalizing,   U8)             /* are we processing a local() list? */
 PERLVAR(Icolorset,     bool)           /* from regcomp.c */
-PERLVARI(Idirty,       bool, FALSE)    /* in the middle of tearing things
-                                          down? */
-PERLVAR(Iin_eval,      VOL U8)         /* trap "fatal" errors? */
+PERLVAR(Iin_eval,      U8)             /* trap "fatal" errors? */
 PERLVAR(Itainted,      bool)           /* using variables controlled by $< */
 
+/* current phase the interpreter is in */
+PERLVARI(Iphase,       enum perl_phase, PERL_PHASE_CONSTRUCT)
+
 /* This value may be set when embedding for full cleanup  */
 /* 0=none, 1=full, 2=full with checks */
-PERLVARI(Iperl_destruct_level, U8,     0)
+/* mod_perl is special, and also assigns a meaning -1 */
+PERLVARI(Iperl_destruct_level, signed char,    0)
 
 PERLVAR(Iperldb,       U32)
 
@@ -210,18 +273,17 @@ PERLVAR(Iwarnhook,        SV *)
 
 /* switches */
 PERLVAR(Ipatchlevel,   SV *)
+PERLVAR(Iapiversion,   SV *)
 PERLVAR(Ilocalpatches, const char * const *)
 PERLVARI(Isplitstr,    const char *, " ")
 
 PERLVAR(Iminus_c,      bool)
-PERLVAR(Ipreprocess,   bool)
 PERLVAR(Iminus_n,      bool)
 PERLVAR(Iminus_p,      bool)
 PERLVAR(Iminus_l,      bool)
 PERLVAR(Iminus_a,      bool)
 PERLVAR(Iminus_F,      bool)
 PERLVAR(Idoswitches,   bool)
-
 PERLVAR(Iminus_E,      bool)
 
 /*
@@ -234,13 +296,14 @@ The C variable which corresponds to Perl's $^W warning variable.
 */
 
 PERLVAR(Idowarn,       U8)
-PERLVAR(Idoextract,    bool)
+     /* Space for a U8  */
 PERLVAR(Isawampersand, bool)           /* must save all match strings */
 PERLVAR(Iunsafe,       bool)
 PERLVAR(Iexit_flags,   U8)             /* was exit() unexpected, etc. */
 PERLVAR(Isrand_called, bool)
 /* Part of internal state, but makes the 16th 1 byte variable in a row.  */
 PERLVAR(Itainting,     bool)           /* doing taint checks */
+PERLVARI(Iin_load_module, bool, FALSE) /* to prevent recursions in PerlIO_find_layer */
 PERLVAR(Iinplace,      char *)
 PERLVAR(Ie_script,     SV *)
 
@@ -262,22 +325,22 @@ PERLVARI(Isig_pending, int,0)           /* Number if highest signal pending */
 PERLVAR(Ipsig_pend, int *)             /* per-signal "count" of pending */
 
 /* shortcuts to various I/O objects */
-PERLVAR(Istdingv,      GV *)
-PERLVAR(Istderrgv,     GV *)
+PERLVAR(Istdingv,      GV *)           /*  *STDIN      */
+PERLVAR(Istderrgv,     GV *)           /*  *STDERR     */
 PERLVAR(Idefgv,                GV *)
-PERLVAR(Iargvgv,       GV *)
-PERLVAR(Iargvoutgv,    GV *)
+PERLVAR(Iargvgv,       GV *)           /*  *ARGV       */
+PERLVAR(Iargvoutgv,    GV *)           /*  *ARGVOUT    */
 PERLVAR(Iargvout_stack,        AV *)
 
 /* shortcuts to regexp stuff */
-PERLVAR(Ireplgv,       GV *)
+PERLVAR(Ireplgv,       GV *)           /*  *^R         */
 
 /* shortcuts to misc objects */
-PERLVAR(Ierrgv,                GV *)
+PERLVAR(Ierrgv,                GV *)           /*  *@          */
 
 /* shortcuts to debugging objects */
-PERLVAR(IDBgv,         GV *)
-PERLVAR(IDBline,       GV *)
+PERLVAR(IDBgv,         GV *)           /*  *DB::DB     */
+PERLVAR(IDBline,       GV *)           /*  *DB::line   */
 
 /*
 =for apidoc mn|GV *|PL_DBsub
@@ -301,10 +364,10 @@ variable.  See C<PL_DBsingle>.
 =cut
 */
 
-PERLVAR(IDBsub,                GV *)
-PERLVAR(IDBsingle,     SV *)
-PERLVAR(IDBtrace,      SV *)
-PERLVAR(IDBsignal,     SV *)
+PERLVAR(IDBsub,                GV *)           /*  *DB::sub    */
+PERLVAR(IDBsingle,     SV *)           /*  $DB::single */
+PERLVAR(IDBtrace,      SV *)           /*  $DB::trace  */
+PERLVAR(IDBsignal,     SV *)           /*  $DB::signal */
 PERLVAR(Idbargs,       AV *)           /* args to call listed by caller function */
 
 /* symbol tables */
@@ -347,7 +410,7 @@ PERLVARI(Icurcopdb, COP *,  NULL)
 PERLVAR(Ifilemode,     int)            /* so nextargv() can preserve mode */
 PERLVAR(Ilastfd,       int)            /* what to preserve mode on */
 PERLVAR(Ioldname,      char *)         /* what to preserve mode on */
-PERLVAR(IArgv,         char **)        /* stuff to free from do_aexec, vfork safe */
+PERLVAR(IArgv,         const char **)  /* stuff to free from do_aexec, vfork safe */
 PERLVAR(ICmd,          char *)         /* stuff to free from do_aexec, vfork safe */
 /* Elements in this array have ';' appended and are injected as a single line
    into the tokeniser. You can't put any (literal) newlines into any program
@@ -403,7 +466,7 @@ PERLVAR(IDBcv,              CV *)           /* from perl.c */
 PERLVARI(Igeneration,  int,    100)    /* from op.c */
 
 PERLVARI(Iin_clean_objs,bool,    FALSE)        /* from sv.c */
-PERLVARI(Iin_clean_all,        bool,    FALSE) /* from sv.c */
+PERLVARI(Iin_clean_all,        bool,    FALSE) /* ptrs to freed SVs now legal */
 PERLVAR(Inomemok,      bool)           /* let malloc context handle nomem */
 PERLVARI(Isavebegin,     bool, FALSE)  /* save BEGINs for compiler     */
 
@@ -425,12 +488,11 @@ PERLVAR(Isighandlerp,     Sighandler_t)
 
 PERLVARA(Ibody_roots,  PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
 
-PERLVAR(Inice_chunk,   char *)         /* a nice chunk of memory to reuse */
-PERLVAR(Inice_chunk_size,      U32)    /* how nice the chunk of memory is */
+PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
 
 PERLVARI(Imaxo,        int,    MAXO)           /* maximum number of ops */
 
-PERLVARI(Irunops,      runops_proc_t,  MEMBER_TO_FPTR(RUNOPS_DEFAULT))
+PERLVARI(Irunops,      runops_proc_t,  RUNOPS_DEFAULT)
 
 /*
 =for apidoc Amn|SV|PL_sv_undef
@@ -460,12 +522,14 @@ PERLVAR(Imax_intro_pending,       I32)    /* end of vars to introduce */
 PERLVAR(Ipadix,                I32)            /* max used index in current "register" pad */
 
 PERLVAR(Ipadix_floor,  I32)            /* how low may inner block reset padix */
-PERLVAR(Ipad_reset_pending,    I32)    /* reset pad on next attempted alloc */
 
 PERLVAR(Ihints,                U32)            /* pragma-tic compile-time flags */
 
 PERLVAR(Idebug,                VOL U32)        /* flags given to -D switch */
 
+/* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
+PERLVARI(Ibreakable_sub_gen, U32, 0)
+
 PERLVARI(Iamagic_generation,   long,   0)
 
 #ifdef USE_LOCALE_COLLATE
@@ -498,10 +562,12 @@ PERLVAR(Inumeric_name,    char *)         /* Name of current numeric locale */
 
 /* utf8 character classes */
 PERLVAR(Iutf8_alnum,   SV *)
-PERLVAR(Iutf8_alnumc,  SV *)
 PERLVAR(Iutf8_ascii,   SV *)
 PERLVAR(Iutf8_alpha,   SV *)
 PERLVAR(Iutf8_space,   SV *)
+PERLVAR(Iutf8_perl_space,      SV *)
+PERLVAR(Iutf8_perl_word,       SV *)
+PERLVAR(Iutf8_posix_digit,     SV *)
 PERLVAR(Iutf8_cntrl,   SV *)
 PERLVAR(Iutf8_graph,   SV *)
 PERLVAR(Iutf8_digit,   SV *)
@@ -511,6 +577,16 @@ PERLVAR(Iutf8_print,       SV *)
 PERLVAR(Iutf8_punct,   SV *)
 PERLVAR(Iutf8_xdigit,  SV *)
 PERLVAR(Iutf8_mark,    SV *)
+PERLVAR(Iutf8_X_begin, SV *)
+PERLVAR(Iutf8_X_extend,        SV *)
+PERLVAR(Iutf8_X_prepend,       SV *)
+PERLVAR(Iutf8_X_non_hangul,    SV *)
+PERLVAR(Iutf8_X_L,     SV *)
+PERLVAR(Iutf8_X_LV,    SV *)
+PERLVAR(Iutf8_X_LVT,   SV *)
+PERLVAR(Iutf8_X_T,     SV *)
+PERLVAR(Iutf8_X_V,     SV *)
+PERLVAR(Iutf8_X_LV_LVT_V,      SV *)
 PERLVAR(Iutf8_toupper, SV *)
 PERLVAR(Iutf8_totitle, SV *)
 PERLVAR(Iutf8_tolower, SV *)
@@ -525,15 +601,20 @@ PERLVAR(Ilast_swash_klen, U8)     /* Only needs to store 0-10  */
 PERLVARI(Icryptseen,   bool,   FALSE)  /* has fast crypt() been initialized? */
 #endif
 
+PERLVAR(Ipad_reset_pending,    bool)   /* reset pad on next attempted alloc */
+
 PERLVARI(Iglob_index,  int,    0)
 
 
 PERLVAR(Iparser,       yy_parser *)    /* current parser state */
 
-PERLVAR(Ibitcount,     char *)
-
+/* Array of signal handlers, indexed by signal number, through which the C
+   signal handler dispatches.  */
 PERLVAR(Ipsig_ptr, SV**)
-PERLVAR(Ipsig_name, SV**)
+/* Array of names of signals, indexed by signal number, for (re)use as the first
+   argument to a signal handler.   Only one block of memory is allocated for
+   both psig_name and psig_ptr.  */
+PERLVAR(Ipsig_name, SV**)              
 
 #if defined(PERL_IMPLICIT_SYS)
 PERLVAR(IMem,          struct IPerlMem*)
@@ -560,9 +641,13 @@ PERLVAR(Inumeric_radix_sv, SV *)   /* The radix separator if not '.' */
 #endif
 
 #if defined(USE_ITHREADS)
-PERLVAR(Iregex_pad,     SV**)          /* All regex objects */
-PERLVAR(Iregex_padav,   AV*)           /* All regex objects */
-
+PERLVAR(Iregex_pad,     SV**)          /* Shortcut into the array of
+                                          regex_padav */
+PERLVAR(Iregex_padav,   AV*)           /* All regex objects, indexed via the
+                                          values in op_pmoffset of pmop.
+                                          Entry 0 is an SV whose PV is a
+                                          "packed" list of IVs listing
+                                          the now-free slots in the array */
 #endif
 
 #ifdef USE_REENTRANT_API
@@ -573,7 +658,7 @@ PERLVAR(Icustom_op_names, HV*)  /* Names of user defined ops */
 PERLVAR(Icustom_op_descs, HV*)  /* Descriptions of user defined ops */
 
 #ifdef PERLIO_LAYERS
-PERLVARI(Iperlio, PerlIO *,NULL)
+PERLVARI(Iperlio, PerlIOl *,NULL)
 PERLVARI(Iknown_layers, PerlIO_list_t *,NULL)
 PERLVARI(Idef_layerlist, PerlIO_list_t *,NULL)
 #endif
@@ -592,10 +677,6 @@ PERLVARI(Iunitcheckav_save, AV*, NULL)     /* save UNITCHECK{}s when compiling */
 
 PERLVARI(Iclocktick, long, 0)  /* this many times() ticks in a second */
 
-PERLVARI(Iin_load_module, int, 0)      /* to prevent recursions in PerlIO_find_layer */
-
-PERLVAR(Iunicode, U32) /* Unicode features: $ENV{PERL_UNICODE} or -C */
-
 PERLVAR(Isignals, U32) /* Using which pre-5.8 signals */
 
 PERLVAR(Ireentrant_retint, int)        /* Integer return value from reentrant functions */
@@ -603,21 +684,21 @@ PERLVAR(Ireentrant_retint, int)   /* Integer return value from reentrant functions
 PERLVAR(Istashcache,   HV *)           /* Cache to speed up S_method_common */
 
 /* Hooks to shared SVs and locks. */
-PERLVARI(Isharehook,   share_proc_t,   MEMBER_TO_FPTR(Perl_sv_nosharing))
-PERLVARI(Ilockhook,    share_proc_t,   MEMBER_TO_FPTR(Perl_sv_nosharing))
+PERLVARI(Isharehook,   share_proc_t,   Perl_sv_nosharing)
+PERLVARI(Ilockhook,    share_proc_t,   Perl_sv_nosharing)
 #ifdef NO_MATHOMS
 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
 #else
 /* This reference ensures that the mathoms are linked with perl */
 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
 #endif
-PERLVARI(Iunlockhook,  share_proc_t,   MEMBER_TO_FPTR(PERL_UNLOCK_HOOK))
+PERLVARI(Iunlockhook,  share_proc_t,   PERL_UNLOCK_HOOK)
 
-PERLVARI(Ithreadhook,  thrhook_proc_t, MEMBER_TO_FPTR(Perl_nothreadhook))
+PERLVARI(Ithreadhook,  thrhook_proc_t, Perl_nothreadhook)
 
-PERLVARI(Ihash_seed, UV, 0)            /* Hash initializer */
+PERLVARI(Isignalhook,  despatch_signals_proc_t, Perl_despatch_signals)
 
-PERLVAR(IDBassertion,   SV *)
+PERLVARI(Ihash_seed, UV, 0)            /* Hash initializer */
 
 PERLVARI(Irehash_seed, UV, 0)          /* 582 hash initializer */
 
@@ -669,6 +750,33 @@ PERLVARI(Islabs, I32**, NULL)      /* Array of slabs that have been allocated */
 PERLVARI(Islab_count, U32, 0)  /* Size of the array */
 #endif
 
+/* Can shared object be destroyed */
+PERLVARI(Idestroyhook, destroyable_proc_t, Perl_sv_destroyable)
+
+#ifdef DEBUG_LEAKING_SCALARS
+PERLVARI(Isv_serial, U32, 0) /* SV serial number, used in sv.c */
+#endif
+
+/* Register of known Method Resolution Orders.
+   What this actually points to is an implementation detail (it may change to
+   a structure incorporating a reference count - use mro_get_from_name to
+   retrieve a C<struct mro_alg *>  */
+PERLVAR(Iregistered_mros, HV *)
+
+/* Compile-time block start/end hooks */
+PERLVAR(Iblockhooks, AV *)
+
+
+/* Everything that folds to a given character, for case insensitivity regex
+ * matching */
+PERLVARI(Iutf8_foldclosures,   HV *, NULL)
+
+/* List of characters that participate in folds (except marks, etc in
+ * multi-char folds) */
+PERLVAR(Iutf8_foldable,        HV *)
+
+PERLVAR(Icustom_ops, HV *)      /* custom op registrations */
+
 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
  * above on where there are gaps which currently will be structure padding.  */