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
CommitLineData
d6376244
JH
1/* thdrvar.h
2 *
1d325971 3 * Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
d6376244
JH
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
8 */
9
ccfc67b7
JH
10/*
11=head1 Global Variables
12*/
13
cb68f92d
GS
14/***********************************************/
15/* Global only to current thread */
16/***********************************************/
17
8b3be1d1
JP
18/* Don't forget to re-run embed.pl to propagate changes! */
19
cb68f92d 20/* The 'T' prefix is only needed for vars that need appropriate #defines
4d1ff10f 21 * generated when built with or without USE_5005THREADS. It is also used
cb68f92d
GS
22 * to generate the appropriate export list for win32.
23 *
4d1ff10f
AB
24 * When building without USE_5005THREADS, these variables will be truly global.
25 * When building without USE_5005THREADS but with MULTIPLICITY, these variables
14dd3ad8 26 * will be global per-interpreter. */
8b3be1d1 27
49f531da 28/* Important ones in the first cache line (if alignment is done right) */
d4cce5f1 29
cb68f92d 30PERLVAR(Tstack_sp, SV **) /* top of the stack */
49f531da 31#ifdef OP_IN_REGISTER
cb68f92d 32PERLVAR(Topsave, OP *)
49f531da 33#else
cb68f92d 34PERLVAR(Top, OP *) /* currently executing op */
49f531da 35#endif
cb68f92d
GS
36PERLVAR(Tcurpad, SV **) /* active pad (lexicals+tmps) */
37
38PERLVAR(Tstack_base, SV **)
39PERLVAR(Tstack_max, SV **)
40
41PERLVAR(Tscopestack, I32 *) /* scopes we've ENTERed */
42PERLVAR(Tscopestack_ix, I32)
43PERLVAR(Tscopestack_max,I32)
49f531da 44
cb68f92d
GS
45PERLVAR(Tsavestack, ANY *) /* items that need to be restored
46 when LEAVEing scopes we've ENTERed */
47PERLVAR(Tsavestack_ix, I32)
48PERLVAR(Tsavestack_max, I32)
49f531da 49
cb68f92d
GS
50PERLVAR(Ttmps_stack, SV **) /* mortals we've made */
51PERLVARI(Ttmps_ix, I32, -1)
52PERLVARI(Ttmps_floor, I32, -1)
53PERLVAR(Ttmps_max, I32)
49f531da 54
cb68f92d
GS
55PERLVAR(Tmarkstack, I32 *) /* stack_sp locations we're remembering */
56PERLVAR(Tmarkstack_ptr, I32 *)
57PERLVAR(Tmarkstack_max, I32 *)
49f531da 58
cb68f92d
GS
59PERLVAR(TSv, SV *) /* used to hold temporary values */
60PERLVAR(TXpv, XPV *) /* used to hold temporary values */
954c1994
GS
61
62/*
63=for apidoc Amn|STRLEN|PL_na
64
65A convenience variable which is typically used with C<SvPV> when one
66doesn't care about the length of the string. It is usually more efficient
67to either declare a local variable and use that instead or to use the
68C<SvPV_nolen> macro.
69
70=cut
71*/
72
b099ddc0
GS
73PERLVAR(Tna, STRLEN) /* for use in SvPV when length is
74 Not Applicable */
49f531da 75
5c0ca799 76/* stat stuff */
cb68f92d 77PERLVAR(Tstatbuf, Stat_t)
5c0ca799
GS
78PERLVAR(Tstatcache, Stat_t) /* _ */
79PERLVAR(Tstatgv, GV *)
a0714e2c 80PERLVARI(Tstatname, SV *, NULL)
5c0ca799 81
49f531da 82#ifdef HAS_TIMES
cb68f92d 83PERLVAR(Ttimesbuf, struct tms)
49f531da 84#endif
49f531da
NIS
85
86/* Fields used by magic variables such as $@, $/ and so on */
d4cce5f1 87PERLVAR(Ttainted, bool) /* using variables controlled by $< */
cb68f92d 88PERLVAR(Tcurpm, PMOP *) /* what to do \ interps in REs from */
ed252734 89PERLVAR(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 */
c155e47c
SC
90
91/*
2eb25c99 92=for apidoc mn|SV*|PL_rs
c155e47c
SC
93
94The input record separator - C<$/> in Perl space.
95
2eb25c99 96=for apidoc mn|GV*|PL_last_in_gv
c155e47c
SC
97
98The GV which was last used for a filehandle input operation. (C<< <FH> >>)
99
2eb25c99 100=for apidoc mn|SV*|PL_ofs_sv
c155e47c
SC
101
102The output field separator - C<$,> in Perl space.
103
104=cut
105*/
106
cb68f92d
GS
107PERLVAR(Trs, SV *) /* input record separator $/ */
108PERLVAR(Tlast_in_gv, GV *) /* GV used in last <FH> */
7889fe52 109PERLVAR(Tofs_sv, SV *) /* output field separator $, */
cb68f92d 110PERLVAR(Tdefoutgv, GV *) /* default FH for output */
dd374669 111PERLVARI(Tchopset, const char *, " \n-") /* $: */
cb68f92d
GS
112PERLVAR(Tformtarget, SV *)
113PERLVAR(Tbodytarget, SV *)
114PERLVAR(Ttoptarget, SV *)
49f531da 115
d4cce5f1
NIS
116/* Stashes */
117PERLVAR(Tdefstash, HV *) /* main symbol table */
118PERLVAR(Tcurstash, HV *) /* symbol table for current package */
49f531da 119
cb68f92d 120PERLVAR(Trestartop, OP *) /* propagating an error from croak? */
3280af22 121PERLVARI(Tcurcop, COP * VOL, &PL_compiling)
d4cce5f1
NIS
122PERLVAR(Tin_eval, VOL int) /* trap "fatal" errors? */
123PERLVAR(Tdelaymagic, int) /* ($<,$>) = ... */
24d3c518 124PERLVARI(Tdirty, bool, FALSE) /* in the middle of tearing things down? */
61bb5906 125PERLVAR(Tlocalizing, int) /* are we processing a local() list? */
49f531da 126
cb68f92d
GS
127PERLVAR(Tcurstack, AV *) /* THE STACK */
128PERLVAR(Tcurstackinfo, PERL_SI *) /* current stack + context */
129PERLVAR(Tmainstack, AV *) /* the stack when nothing funny is happening */
312caa8e 130
cb68f92d
GS
131PERLVAR(Ttop_env, JMPENV *) /* ptr. to current sigjmp() environment */
132PERLVAR(Tstart_env, JMPENV) /* empty startup sigjmp() environment */
a0714e2c 133PERLVARI(Terrors, SV *, NULL) /* outstanding queued errors */
49f531da 134
4e4c362e 135/* statics "owned" by various functions */
195c09c3
JH
136PERLVAR(Tav_fetch_sv, SV *) /* unused as of change #19268 */
137PERLVAR(Thv_fetch_sv, SV *) /* unused as of change #19268 */
dd28f7bb 138PERLVAR(Thv_fetch_ent_mh, HE*) /* owned by hv_fetch_ent() */
cb68f92d
GS
139
140PERLVAR(Tmodcount, I32) /* how much mod()ification in assignment? */
4e4c362e 141
5c0ca799 142PERLVAR(Tlastgotoprobe, OP*) /* from pp_ctl.c */
3967c732 143PERLVARI(Tdumpindent, I32, 4) /* # of blanks per dump indentation level */
5c0ca799
GS
144
145/* sort stuff */
146PERLVAR(Tsortcop, OP *) /* user defined sort routine */
147PERLVAR(Tsortstash, HV *) /* which is in some package or other */
148PERLVAR(Tfirstgv, GV *) /* $a */
149PERLVAR(Tsecondgv, GV *) /* $b */
5c0ca799 150
7d5ea4e7
GS
151/* float buffer */
152PERLVAR(Tefloatbuf, char*)
153PERLVAR(Tefloatsize, STRLEN)
154
5c0ca799
GS
155/* regex stuff */
156
157PERLVAR(Tscreamfirst, I32 *)
158PERLVAR(Tscreamnext, I32 *)
159PERLVARI(Tmaxscream, I32, -1)
160PERLVAR(Tlastscream, SV *)
161
162PERLVAR(Tregdummy, regnode) /* from regcomp.c */
5c0ca799 163PERLVAR(Tregsize, I32) /* Code size. */
5c0ca799 164PERLVAR(Tcolorset, int) /* from regcomp.c */
51371543 165PERLVARA(Tcolors,6, char *) /* from regcomp.c */
5c0ca799
GS
166PERLVAR(Treginput, char *) /* String-input pointer. */
167PERLVAR(Tregbol, char *) /* Beginning of input, for ^ check. */
168PERLVAR(Tregeol, char *) /* End of input, for $ check. */
cf93c79d
IZ
169PERLVAR(Tregstartp, I32 *) /* Pointer to startp array. */
170PERLVAR(Tregendp, I32 *) /* Ditto for endp. */
5c0ca799 171PERLVAR(Treglastparen, U32 *) /* Similarly for lastparen. */
a01268b5 172PERLVAR(Treglastcloseparen, U32 *) /* Similarly for lastcloseparen. */
5c0ca799 173PERLVAR(Tregtill, char *) /* How far we are required to go. */
5c0ca799
GS
174PERLVAR(Treg_start_tmp, char **) /* from regexec.c */
175PERLVAR(Treg_start_tmpl,U32) /* from regexec.c */
5c0ca799
GS
176 /* from regexec.c renamed was data */
177PERLVAR(Tbostr, char *) /* from regexec.c */
178PERLVAR(Treg_flags, U32) /* from regexec.c */
179PERLVAR(Treg_eval_set, I32) /* from regexec.c */
180PERLVAR(Tregnarrate, I32) /* from regexec.c */
5c0ca799 181PERLVARI(Tregindent, int, 0) /* from regexec.c */
0f5d15d6
IZ
182PERLVAR(Treg_call_cc, struct re_cc_state *) /* from regexec.c */
183PERLVAR(Treg_re, regexp *) /* from regexec.c */
22e551b9
IZ
184PERLVAR(Treg_ganch, char *) /* position of \G */
185PERLVAR(Treg_sv, SV *) /* what we match against */
9661b544
IZ
186PERLVAR(Treg_magic, MAGIC *) /* pos-magic of what we match */
187PERLVAR(Treg_oldpos, I32) /* old pos of what we match */
5c5e4c24
IZ
188PERLVARI(Treg_oldcurpm, PMOP*, NULL) /* curpm before match */
189PERLVARI(Treg_curpm, PMOP*, NULL) /* curpm during match */
cf93c79d
IZ
190PERLVAR(Treg_oldsaved, char*) /* old saved substr during match */
191PERLVAR(Treg_oldsavedlen, STRLEN) /* old length of saved substr during match */
82ba1be6
IZ
192PERLVAR(Treg_maxiter, I32) /* max wait until caching pos */
193PERLVAR(Treg_leftiter, I32) /* wait until caching pos */
bd61b366 194PERLVARI(Treg_poscache, char *, NULL) /* cache of pos of WHILEM */
82ba1be6 195PERLVAR(Treg_poscache_size, STRLEN) /* size of pos cache of WHILEM */
5c0ca799 196
a2efc822
SC
197PERLVARI(Tpeepp, peep_t, MEMBER_TO_FPTR(Perl_peep))
198 /* Pointer to peephole optimizer */
0b94c7bb 199PERLVARI(Tregcompp, regcomp_t, MEMBER_TO_FPTR(Perl_pregcomp))
f722798b 200 /* Pointer to REx compiler */
0b94c7bb 201PERLVARI(Tregexecp, regexec_t, MEMBER_TO_FPTR(Perl_regexec_flags))
f722798b 202 /* Pointer to REx executer */
0b94c7bb 203PERLVARI(Tregint_start, re_intuit_start_t, MEMBER_TO_FPTR(Perl_re_intuit_start))
f722798b 204 /* Pointer to optimized REx executer */
0b94c7bb 205PERLVARI(Tregint_string,re_intuit_string_t, MEMBER_TO_FPTR(Perl_re_intuit_string))
f722798b 206 /* Pointer to optimized REx string */
0b94c7bb 207PERLVARI(Tregfree, regfree_t, MEMBER_TO_FPTR(Perl_pregfree))
f722798b
IZ
208 /* Pointer to REx free()er */
209
a0288114 210PERLVARI(Treginterp_cnt,int, 0) /* Whether "Regexp" was interpolated. */
364723c2 211PERLVARI(Treg_starttry, char *, 0) /* -Dr: where regtry was called. */
22c35a8c
GS
212PERLVARI(Twatchaddr, char **, 0)
213PERLVAR(Twatchok, char *)
d4cce5f1 214
8b3be1d1 215/* Note that the variables below are all explicitly referenced in the code
cb68f92d 216 * as thr->whatever and therefore don't need the 'T' prefix. */
8b3be1d1 217
53c4c00c 218PERLVAR(Treg_match_utf8, bool) /* was what we matched against utf8 */
d9f424b2 219
5d9a96ca
DM
220/* the currently active slab in a chain of slabs of regmatch states,
221 * and the currently active state within that slab */
222
223PERLVARI(Tregmatch_slab, regmatch_slab *, NULL)
224PERLVAR(Tregmatch_state, regmatch_state *)