This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Put a plan in the last added test
[perl5.git] / thrdvar.h
1 /*    thdrvar.h
2  *
3  *    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 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
30 PERLVAR(Tstack_sp,      SV **)          /* top of the stack */
31 #ifdef OP_IN_REGISTER
32 PERLVAR(Topsave,        OP *)
33 #else
34 PERLVAR(Top,            OP *)           /* currently executing op */
35 #endif
36 PERLVAR(Tcurpad,        SV **)          /* active pad (lexicals+tmps) */
37
38 PERLVAR(Tstack_base,    SV **)
39 PERLVAR(Tstack_max,     SV **)
40
41 PERLVAR(Tscopestack,    I32 *)          /* scopes we've ENTERed */
42 PERLVAR(Tscopestack_ix, I32)
43 PERLVAR(Tscopestack_max,I32)
44
45 PERLVAR(Tsavestack,     ANY *)          /* items that need to be restored
46                                            when LEAVEing scopes we've ENTERed */
47 PERLVAR(Tsavestack_ix,  I32)
48 PERLVAR(Tsavestack_max, I32)
49
50 PERLVAR(Ttmps_stack,    SV **)          /* mortals we've made */
51 PERLVARI(Ttmps_ix,      I32,    -1)
52 PERLVARI(Ttmps_floor,   I32,    -1)
53 PERLVAR(Ttmps_max,      I32)
54
55 PERLVAR(Tmarkstack,     I32 *)          /* stack_sp locations we're remembering */
56 PERLVAR(Tmarkstack_ptr, I32 *)
57 PERLVAR(Tmarkstack_max, I32 *)
58
59 PERLVAR(TSv,            SV *)           /* used to hold temporary values */
60 PERLVAR(TXpv,           XPV *)          /* used to hold temporary values */
61
62 /*
63 =for apidoc Amn|STRLEN|PL_na
64
65 A convenience variable which is typically used with C<SvPV> when one
66 doesn't care about the length of the string.  It is usually more efficient
67 to either declare a local variable and use that instead or to use the
68 C<SvPV_nolen> macro.
69
70 =cut
71 */
72
73 PERLVAR(Tna,            STRLEN)         /* for use in SvPV when length is
74                                            Not Applicable */
75
76 /* stat stuff */
77 PERLVAR(Tstatbuf,       Stat_t)
78 PERLVAR(Tstatcache,     Stat_t)         /* _ */
79 PERLVAR(Tstatgv,        GV *)
80 PERLVARI(Tstatname,     SV *,   NULL)
81
82 #ifdef HAS_TIMES
83 PERLVAR(Ttimesbuf,      struct tms)
84 #endif
85
86 /* Fields used by magic variables such as $@, $/ and so on */
87 PERLVAR(Ttainted,       bool)           /* using variables controlled by $< */
88 PERLVAR(Tcurpm,         PMOP *)         /* what to do \ interps in REs from */
89
90 /*
91 =for apidoc mn|SV*|PL_rs
92
93 The input record separator - C<$/> in Perl space.
94
95 =for apidoc mn|GV*|PL_last_in_gv
96
97 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
98
99 =for apidoc mn|SV*|PL_ofs_sv
100
101 The output field separator - C<$,> in Perl space.
102
103 =cut
104 */
105
106 PERLVAR(Trs,            SV *)           /* input record separator $/ */
107 PERLVAR(Tlast_in_gv,    GV *)           /* GV used in last <FH> */
108 PERLVAR(Tofs_sv,        SV *)           /* output field separator $, */
109 PERLVAR(Tdefoutgv,      GV *)           /* default FH for output */
110 PERLVARI(Tchopset,      const char *,   " \n-") /* $: */
111 PERLVAR(Tformtarget,    SV *)
112 PERLVAR(Tbodytarget,    SV *)
113 PERLVAR(Ttoptarget,     SV *)
114
115 /* Stashes */
116 PERLVAR(Tdefstash,      HV *)           /* main symbol table */
117 PERLVAR(Tcurstash,      HV *)           /* symbol table for current package */
118
119 PERLVAR(Trestartop,     OP *)           /* propagating an error from croak? */
120 PERLVARI(Tcurcop,       COP * VOL,      &PL_compiling)
121 PERLVAR(Tin_eval,       VOL int)        /* trap "fatal" errors? */
122 PERLVAR(Tdelaymagic,    int)            /* ($<,$>) = ... */
123 PERLVARI(Tdirty,        bool, FALSE)    /* in the middle of tearing things down? */
124 PERLVAR(Tlocalizing,    int)            /* are we processing a local() list? */
125
126 PERLVAR(Tcurstack,      AV *)           /* THE STACK */
127 PERLVAR(Tcurstackinfo,  PERL_SI *)      /* current stack + context */
128 PERLVAR(Tmainstack,     AV *)           /* the stack when nothing funny is happening */
129
130 PERLVAR(Ttop_env,       JMPENV *)       /* ptr. to current sigjmp() environment */
131 PERLVAR(Tstart_env,     JMPENV)         /* empty startup sigjmp() environment */
132 PERLVARI(Terrors,       SV *, NULL)     /* outstanding queued errors */
133
134 /* statics "owned" by various functions */
135 PERLVAR(Tav_fetch_sv,   SV *)           /* unused as of change #19268 */
136 PERLVAR(Thv_fetch_sv,   SV *)           /* unused as of change #19268 */
137 PERLVAR(Thv_fetch_ent_mh, HE*)          /* owned by hv_fetch_ent() */
138
139 PERLVAR(Tmodcount,      I32)            /* how much mod()ification in assignment? */
140
141 PERLVAR(Tlastgotoprobe, OP*)            /* from pp_ctl.c */
142 PERLVARI(Tdumpindent,   I32, 4)         /* # of blanks per dump indentation level */
143
144 /* sort stuff */
145 PERLVAR(Tsortcop,       OP *)           /* user defined sort routine */
146 PERLVAR(Tsortstash,     HV *)           /* which is in some package or other */
147 PERLVAR(Tfirstgv,       GV *)           /* $a */
148 PERLVAR(Tsecondgv,      GV *)           /* $b */
149
150 /* float buffer */
151 PERLVAR(Tefloatbuf,     char*)
152 PERLVAR(Tefloatsize,    STRLEN)
153
154 /* regex stuff */
155
156 PERLVAR(Tscreamfirst,   I32 *)
157 PERLVAR(Tscreamnext,    I32 *)
158 PERLVARI(Tmaxscream,    I32,    -1)
159 PERLVAR(Tlastscream,    SV *)
160
161 PERLVAR(Treg_state,     struct re_save_state)
162 PERLVAR(Tregdummy,      regnode)        /* from regcomp.c */
163 PERLVAR(Tcolorset,      int)            /* from regcomp.c */
164 PERLVARA(Tcolors,6,     char *)         /* from regcomp.c */
165
166 PERLVARI(Tpeepp,        peep_t, MEMBER_TO_FPTR(Perl_peep))
167                                         /* Pointer to peephole optimizer */
168 PERLVARI(Tregcompp,     regcomp_t, MEMBER_TO_FPTR(Perl_pregcomp))
169                                         /* Pointer to REx compiler */
170 PERLVARI(Tregexecp,     regexec_t, MEMBER_TO_FPTR(Perl_regexec_flags))
171                                         /* Pointer to REx executer */
172 PERLVARI(Tregint_start, re_intuit_start_t, MEMBER_TO_FPTR(Perl_re_intuit_start))
173                                         /* Pointer to optimized REx executer */
174 PERLVARI(Tregint_string,re_intuit_string_t, MEMBER_TO_FPTR(Perl_re_intuit_string))
175                                         /* Pointer to optimized REx string */
176 PERLVARI(Tregfree,      regfree_t, MEMBER_TO_FPTR(Perl_pregfree))
177                                         /* Pointer to REx free()er */
178
179 PERLVARI(Treginterp_cnt,int,        0)  /* Whether "Regexp" was interpolated. */
180 PERLVARI(Twatchaddr,    char **,    0)
181 PERLVAR(Twatchok,       char *)
182
183 /* Note that the variables below are all explicitly referenced in the code
184  * as thr->whatever and therefore don't need the 'T' prefix. */
185
186 /* the currently active slab in a chain of slabs of regmatch states,
187  * and the currently active state within that slab */
188
189 PERLVARI(Tregmatch_slab,        regmatch_slab *, NULL)
190 PERLVAR(Tregmatch_state,        regmatch_state *)