This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
save old PL_curcop value in parser struct
[perl5.git] / thrdvar.h
index 20e79cc..cbde17d 100644 (file)
--- a/thrdvar.h
+++ b/thrdvar.h
@@ -1,3 +1,17 @@
+/*    thdrvar.h
+ *
+ *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
+ *    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.
+ *
+ */
+
+/*
+=head1 Global Variables
+*/
+
 /***********************************************/
 /* Global only to current thread               */
 /***********************************************/
 /* Don't forget to re-run embed.pl to propagate changes! */
 
 /* The 'T' prefix is only needed for vars that need appropriate #defines
- * generated when built with or without USE_THREADS.  It is also used
+ * generated when built with or without USE_5005THREADS.  It is also used
  * to generate the appropriate export list for win32.
  *
- * When building without USE_THREADS, these variables will be truly global.
- * When building without USE_THREADS but with MULTIPLICITY, these variables
- * will be global per-interpreter.
- *
- * Avoid build-specific #ifdefs here, like DEBUGGING.  That way,
- * we can keep binary compatibility of the curinterp structure */
+ * When building without USE_5005THREADS, these variables will be truly global.
+ * When building without USE_5005THREADS but with MULTIPLICITY, these variables
+ * will be global per-interpreter. */
 
 /* Important ones in the first cache line (if alignment is done right) */
 
@@ -41,38 +52,63 @@ PERLVAR(Ttmps_stack,        SV **)          /* mortals we've made */
 PERLVARI(Ttmps_ix,     I32,    -1)
 PERLVARI(Ttmps_floor,  I32,    -1)
 PERLVAR(Ttmps_max,     I32)
+PERLVAR(Tmodcount,     I32)            /* how much mod()ification in assignment? */
 
 PERLVAR(Tmarkstack,    I32 *)          /* stack_sp locations we're remembering */
 PERLVAR(Tmarkstack_ptr,        I32 *)
 PERLVAR(Tmarkstack_max,        I32 *)
 
-PERLVAR(Tretstack,     OP **)          /* OPs we have postponed executing */
-PERLVAR(Tretstack_ix,  I32)
-PERLVAR(Tretstack_max, I32)
-
 PERLVAR(TSv,           SV *)           /* used to hold temporary values */
 PERLVAR(TXpv,          XPV *)          /* used to hold temporary values */
 
+/*
+=for apidoc Amn|STRLEN|PL_na
+
+A convenience variable which is typically used with C<SvPV> when one
+doesn't care about the length of the string.  It is usually more efficient
+to either declare a local variable and use that instead or to use the
+C<SvPV_nolen> macro.
+
+=cut
+*/
+
+PERLVAR(Tna,           STRLEN)         /* for use in SvPV when length is
+                                          Not Applicable */
+
 /* stat stuff */
 PERLVAR(Tstatbuf,      Stat_t)
 PERLVAR(Tstatcache,    Stat_t)         /* _ */
 PERLVAR(Tstatgv,       GV *)
-PERLVARI(Tstatname,    SV *,   Nullsv)
+PERLVARI(Tstatname,    SV *,   NULL)
 
 #ifdef HAS_TIMES
 PERLVAR(Ttimesbuf,     struct tms)
 #endif
 
 /* Fields used by magic variables such as $@, $/ and so on */
-PERLVAR(Ttainted,      bool)           /* using variables controlled by $< */
 PERLVAR(Tcurpm,                PMOP *)         /* what to do \ interps in REs from */
-PERLVAR(Tnrs,          SV *)
+
+/*
+=for apidoc mn|SV*|PL_rs
+
+The input record separator - C<$/> in Perl space.
+
+=for apidoc mn|GV*|PL_last_in_gv
+
+The GV which was last used for a filehandle input operation. (C<< <FH> >>)
+
+=for apidoc mn|SV*|PL_ofs_sv
+
+The output field separator - C<$,> in Perl space.
+
+=cut
+*/
+
 PERLVAR(Trs,           SV *)           /* input record separator $/ */
 PERLVAR(Tlast_in_gv,   GV *)           /* GV used in last <FH> */
-PERLVAR(Tofs,          char *)         /* output field separator $, */
-PERLVAR(Tofslen,       STRLEN)
+PERLVAR(Tofs_sv,       SV *)           /* output field separator $, */
 PERLVAR(Tdefoutgv,     GV *)           /* default FH for output */
-PERLVARI(Tchopset,     char *, " \n-") /* $: */
+PERLVARI(Tchopset,     const char *,   " \n-") /* $: */
 PERLVAR(Tformtarget,   SV *)
 PERLVAR(Tbodytarget,   SV *)
 PERLVAR(Ttoptarget,    SV *)
@@ -82,24 +118,20 @@ PERLVAR(Tdefstash, HV *)           /* main symbol table */
 PERLVAR(Tcurstash,     HV *)           /* symbol table for current package */
 
 PERLVAR(Trestartop,    OP *)           /* propagating an error from croak? */
-PERLVARI(Tcurcop,      COP * VOL,      &compiling)
-PERLVAR(Tin_eval,      VOL int)        /* trap "fatal" errors? */
-PERLVAR(Tdelaymagic,   int)            /* ($<,$>) = ... */
-PERLVAR(Tdirty,                bool)           /* in the middle of tearing things down? */
-PERLVAR(Tlocalizing,   int)            /* are we processing a local() list? */
-
+PERLVARI(Tcurcop,      COP * VOL,      &PL_compiling)
 PERLVAR(Tcurstack,     AV *)           /* THE STACK */
 PERLVAR(Tcurstackinfo, PERL_SI *)      /* current stack + context */
 PERLVAR(Tmainstack,    AV *)           /* the stack when nothing funny is happening */
+
 PERLVAR(Ttop_env,      JMPENV *)       /* ptr. to current sigjmp() environment */
 PERLVAR(Tstart_env,    JMPENV)         /* empty startup sigjmp() environment */
+PERLVARI(Terrors,      SV *, NULL)     /* outstanding queued errors */
 
 /* statics "owned" by various functions */
-PERLVAR(Tav_fetch_sv,  SV *)           /* owned by av_fetch() */
-PERLVAR(Thv_fetch_sv,  SV *)           /* owned by hv_fetch() */
-PERLVAR(Thv_fetch_ent_mh, HE         /* owned by hv_fetch_ent() */
+PERLVAR(Tav_fetch_sv,  SV *)           /* unused as of change #19268 */
+PERLVAR(Thv_fetch_sv,  SV *)           /* unused as of change #19268 */
+PERLVAR(Thv_fetch_ent_mh, HE*)         /* owned by hv_fetch_ent() */
 
-PERLVAR(Tmodcount,     I32)            /* how much mod()ification in assignment? */
 
 PERLVAR(Tlastgotoprobe,        OP*)            /* from pp_ctl.c */
 
@@ -108,85 +140,54 @@ PERLVAR(Tsortcop, OP *)           /* user defined sort routine */
 PERLVAR(Tsortstash,    HV *)           /* which is in some package or other */
 PERLVAR(Tfirstgv,      GV *)           /* $a */
 PERLVAR(Tsecondgv,     GV *)           /* $b */
-PERLVAR(Tsortcxix,     I32)            /* from pp_ctl.c */
+
+/* float buffer */
+PERLVAR(Tefloatbuf,    char*)
+PERLVAR(Tefloatsize,   STRLEN)
 
 /* regex stuff */
 
 PERLVAR(Tscreamfirst,  I32 *)
 PERLVAR(Tscreamnext,   I32 *)
-PERLVARI(Tmaxscream,   I32,    -1)
 PERLVAR(Tlastscream,   SV *)
 
+PERLVAR(Treg_state,    struct re_save_state)
 PERLVAR(Tregdummy,     regnode)        /* from regcomp.c */
-PERLVAR(Tregcomp_parse,        char*)          /* Input-scan pointer. */
-PERLVAR(Tregxend,      char*)          /* End of input for compile */
-PERLVAR(Tregcode,      regnode*)       /* Code-emit pointer; &regdummy = don't */
-PERLVAR(Tregnaughty,   I32)            /* How bad is this pattern? */
-PERLVAR(Tregsawback,   I32)            /* Did we see \1, ...? */
-PERLVAR(Tregprecomp,   char *)         /* uncompiled string. */
-PERLVAR(Tregnpar,      I32)            /* () count. */
-PERLVAR(Tregsize,      I32)            /* Code size. */
-PERLVAR(Tregflags,     U16)            /* are we folding, multilining? */
-PERLVAR(Tregseen,      U32)            /* from regcomp.c */
-PERLVAR(Tseen_zerolen, I32)            /* from regcomp.c */
-PERLVAR(Tseen_evals,   I32)            /* from regcomp.c */
-PERLVAR(Tregcomp_rx,   regexp *)       /* from regcomp.c */
-PERLVAR(Textralen,     I32)            /* from regcomp.c */
-PERLVAR(Tcolorset,     int)            /* from regcomp.c */
-PERLVAR(Tcolors[4],    char *)         /* from regcomp.c */
-PERLVAR(Treginput,     char *)         /* String-input pointer. */
-PERLVAR(Tregbol,       char *)         /* Beginning of input, for ^ check. */
-PERLVAR(Tregeol,       char *)         /* End of input, for $ check. */
-PERLVAR(Tregstartp,    char **)        /* Pointer to startp array. */
-PERLVAR(Tregendp,      char **)        /* Ditto for endp. */
-PERLVAR(Treglastparen, U32 *)          /* Similarly for lastparen. */
-PERLVAR(Tregtill,      char *)         /* How far we are required to go. */
-PERLVAR(Tregprev,      char)           /* char before regbol, \n if none */
-PERLVAR(Treg_start_tmp,        char **)        /* from regexec.c */
-PERLVAR(Treg_start_tmpl,U32)           /* from regexec.c */
-PERLVAR(Tregdata,      struct reg_data *)
-                                       /* from regexec.c renamed was data */
-PERLVAR(Tbostr,                char *)         /* from regexec.c */
-PERLVAR(Treg_flags,    U32)            /* from regexec.c */
-PERLVAR(Treg_eval_set, I32)            /* from regexec.c */
-PERLVAR(Tregnarrate,   I32)            /* from regexec.c */
-PERLVAR(Tregprogram,   regnode *)      /* from regexec.c */
-PERLVARI(Tregindent,   int,        0)  /* from regexec.c */
-PERLVAR(Tregcc,                CURCUR *)       /* from regexec.c */
-
-PERLVARI(Tregcompp,    regcomp_t, FUNC_NAME_TO_PTR(pregcomp))
-                                       /* Pointer to RE compiler */
-PERLVARI(Tregexecp,    regexec_t, FUNC_NAME_TO_PTR(regexec_flags))
-                                       /* Pointer to RE executer */
-PERLVARI(Treginterp_cnt,int,       0)  /* Whether `Regexp'
-                                                  was interpolated. */
+PERLVARA(Tcolors,6,    char *)         /* from regcomp.c */
 
+PERLVARI(Tpeepp,       peep_t, MEMBER_TO_FPTR(Perl_peep))
+                                       /* Pointer to peephole optimizer */
+
+PERLVARI(Tmaxscream,   I32,    -1)
+PERLVARI(Treginterp_cnt,I32,       0)  /* Whether "Regexp" was interpolated. */
+PERLVARI(Twatchaddr,   char **,    0)
+PERLVAR(Twatchok,      char *)
 
 /* Note that the variables below are all explicitly referenced in the code
  * as thr->whatever and therefore don't need the 'T' prefix. */
 
-#ifdef USE_THREADS
-
-PERLVAR(oursv,         SV *)
-PERLVAR(cvcache,       HV *)
-PERLVAR(self,          perl_os_thread) /* Underlying thread object */
-PERLVAR(flags,         U32)
-PERLVAR(threadsv,      AV *)           /* Per-thread SVs ($_, $@ etc.) */
-PERLVAR(threadsvp,     SV **)          /* AvARRAY(threadsv) */
-PERLVAR(specific,      AV *)           /* Thread-specific user data */
-PERLVAR(errsv,         SV *)           /* Backing SV for $@ */
-PERLVAR(errhv,         HV *)           /* HV for what was %@ in pp_ctl.c */
-PERLVAR(mutex,         perl_mutex)     /* For the fields others can change */
-PERLVAR(tid,           U32)
-PERLVAR(prev,          struct perl_thread *)
-PERLVAR(next,          struct perl_thread *)
-                                       /* Circular linked list of threads */
-
-#ifdef HAVE_THREAD_INTERN
-PERLVAR(i,             struct thread_intern)
-                                       /* Platform-dependent internals */
-#endif
+/* the currently active slab in a chain of slabs of regmatch states,
+ * and the currently active state within that slab */
+
+PERLVARI(Tregmatch_slab,       regmatch_slab *, NULL)
+PERLVAR(Tregmatch_state,       regmatch_state *)
+
+PERLVARI(Tdumpindent,  U16, 4)         /* # of blanks per dump indentation level */
+
+PERLVARI(Tdelayedisa,  HV*, NULL)      /* stash for PL_delaymagic for magic_setisa */
+
+/* Put anything new that is pointer aligned here. */
+
+PERLVAR(Tdelaymagic,   U16)            /* ($<,$>) = ... */
+PERLVAR(Tlocalizing,   U8)             /* are we processing a local() list? */
+PERLVAR(Tcolorset,     bool)           /* from regcomp.c */
+PERLVARI(Tdirty,       bool, FALSE)    /* in the middle of tearing things down? */
+PERLVAR(Tin_eval,      VOL U8) /* trap "fatal" errors? */
+PERLVAR(Ttainted,      bool)           /* using variables controlled by $< */
 
-PERLVAR(trailing_nul,  char)           /* For the sake of thrsv and oursv */
+/* Put new things UP THERE ^^^  */
 
-#endif /* USE_THREADS */
+/* For historical reasons this file is followed by intrpvar.h in the
+   interpreter struct. As this file currently ends with 7 bytes of variables,
+   intrpvar.h starts with one single U8, to avoid structure padding space
+   wastage.  */