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