This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
eliminate PL_regprecomp, PL_regprogram, PL_regnpar and PL_regdata
[perl5.git] / thrdvar.h
index d228ee2..c626f5f 100644 (file)
--- a/thrdvar.h
+++ b/thrdvar.h
@@ -1,3 +1,16 @@
+/*    thdrvar.h
+ *
+ *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 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) */
 
-#ifdef USE_THREADS
-PERLVAR(interp,                PerlInterpreter*)       /* thread owner */
-#endif
-
 PERLVAR(Tstack_sp,     SV **)          /* top of the stack */
 #ifdef OP_IN_REGISTER
 PERLVAR(Topsave,       OP *)
@@ -50,12 +56,20 @@ 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 */
 
@@ -63,7 +77,7 @@ PERLVAR(Tna,          STRLEN)         /* for use in SvPV when length is
 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)
@@ -72,13 +86,29 @@ PERLVAR(Ttimesbuf,  struct tms)
 /* 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 *)
+PERLVAR(Tnrs,          SV *)           /* was placeholder: unused since 5.8.0 (5.7.2 patch #12027 for bug ID 20010815.012). Used to save rx->saved_copy */
+
+/*
+=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 *)
@@ -100,13 +130,12 @@ 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(Tprotect,     protect_proc_t, MEMBER_TO_FPTR(Perl_default_protect))
-PERLVARI(Terrors,      SV *, Nullsv)   /* outstanding queued errors */
+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? */
 
@@ -118,7 +147,6 @@ 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*)
@@ -132,42 +160,25 @@ PERLVARI(Tmaxscream,      I32,    -1)
 PERLVAR(Tlastscream,   SV *)
 
 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 */
 PERLVARA(Tcolors,6,    char *)         /* from regcomp.c */
-PERLVAR(Treg_whilem_seen, I32)         /* number of WHILEM in this expr */
 PERLVAR(Treginput,     char *)         /* String-input pointer. */
 PERLVAR(Tregbol,       char *)         /* Beginning of input, for ^ check. */
 PERLVAR(Tregeol,       char *)         /* End of input, for $ check. */
 PERLVAR(Tregstartp,    I32 *)          /* Pointer to startp array. */
 PERLVAR(Tregendp,      I32 *)          /* Ditto for endp. */
 PERLVAR(Treglastparen, U32 *)          /* Similarly for lastparen. */
+PERLVAR(Treglastcloseparen, U32 *)     /* Similarly for lastcloseparen. */
 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 */
 PERLVAR(Treg_call_cc,  struct re_cc_state *)   /* from regexec.c */
 PERLVAR(Treg_re,       regexp *)       /* from regexec.c */
 PERLVAR(Treg_ganch,    char *)         /* position of \G */
@@ -180,9 +191,11 @@ PERLVAR(Treg_oldsaved,     char*)          /* old saved substr during match */
 PERLVAR(Treg_oldsavedlen, STRLEN)      /* old length of saved substr during match */
 PERLVAR(Treg_maxiter,  I32)            /* max wait until caching pos */
 PERLVAR(Treg_leftiter, I32)            /* wait until caching pos */
-PERLVARI(Treg_poscache, char *, Nullch)        /* cache of pos of WHILEM */
+PERLVARI(Treg_poscache, char *, NULL)  /* cache of pos of WHILEM */
 PERLVAR(Treg_poscache_size, STRLEN)    /* size of pos cache of WHILEM */
 
+PERLVARI(Tpeepp,       peep_t, MEMBER_TO_FPTR(Perl_peep))
+                                       /* Pointer to peephole optimizer */
 PERLVARI(Tregcompp,    regcomp_t, MEMBER_TO_FPTR(Perl_pregcomp))
                                        /* Pointer to REx compiler */
 PERLVARI(Tregexecp,    regexec_t, MEMBER_TO_FPTR(Perl_regexec_flags))
@@ -194,8 +207,7 @@ PERLVARI(Tregint_string,re_intuit_string_t, MEMBER_TO_FPTR(Perl_re_intuit_string
 PERLVARI(Tregfree,     regfree_t, MEMBER_TO_FPTR(Perl_pregfree))
                                        /* Pointer to REx free()er */
 
-PERLVARI(Treginterp_cnt,int,       0)  /* Whether `Regexp'
-                                                  was interpolated. */
+PERLVARI(Treginterp_cnt,int,       0)  /* Whether "Regexp" was interpolated. */
 PERLVARI(Treg_starttry,        char *,     0)  /* -Dr: where regtry was called. */
 PERLVARI(Twatchaddr,   char **,    0)
 PERLVAR(Twatchok,      char *)
@@ -203,27 +215,10 @@ 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(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
+PERLVAR(Treg_match_utf8,       bool)           /* was what we matched against utf8 */
 
-PERLVAR(trailing_nul,  char)           /* For the sake of thrsv and oursv */
+/* the currently active slab in a chain of slabs of regmatch states,
+ * and the currently active state within that slab */
 
-#endif /* USE_THREADS */
+PERLVARI(Tregmatch_slab,       regmatch_slab *, NULL)
+PERLVAR(Tregmatch_state,       regmatch_state *)