This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
A macro used only once isn't a typing saving, and 3 macro definitions
[perl5.git] / scope.h
CommitLineData
d6376244
JH
1/* scope.h
2 *
4bb101f2 3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
699a97de 4 * 2000, 2001, 2002, 2004, 2005, 2006, 2007 by Larry Wall and others
d6376244
JH
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
9 */
10
b9d12d37
GS
11#define SAVEt_ITEM 0
12#define SAVEt_SV 1
13#define SAVEt_AV 2
14#define SAVEt_HV 3
15#define SAVEt_INT 4
16#define SAVEt_LONG 5
17#define SAVEt_I32 6
18#define SAVEt_IV 7
19#define SAVEt_SPTR 8
20#define SAVEt_APTR 9
21#define SAVEt_HPTR 10
22#define SAVEt_PPTR 11
23#define SAVEt_NSTAB 12
24#define SAVEt_SVREF 13
25#define SAVEt_GP 14
26#define SAVEt_FREESV 15
27#define SAVEt_FREEOP 16
28#define SAVEt_FREEPV 17
29#define SAVEt_CLEARSV 18
30#define SAVEt_DELETE 19
31#define SAVEt_DESTRUCTOR 20
32#define SAVEt_REGCONTEXT 21
33#define SAVEt_STACK_POS 22
34#define SAVEt_I16 23
35#define SAVEt_AELEM 24
36#define SAVEt_HELEM 25
37#define SAVEt_OP 26
38#define SAVEt_HINTS 27
39#define SAVEt_ALLOC 28
40#define SAVEt_GENERIC_SVREF 29
c76ac1ee 41#define SAVEt_DESTRUCTOR_X 30
7766f137 42#define SAVEt_VPTR 31
e8347627 43#define SAVEt_I8 32
354992b1 44#define SAVEt_COMPPAD 33
f4dd75d9 45#define SAVEt_GENERIC_PVREF 34
09edbca0 46#define SAVEt_PADSV_AND_MORTALIZE 35
26d9b02f 47#define SAVEt_MORTALIZESV 36
05ec9bb3 48#define SAVEt_SHARED_PVREF 37
9febdf04 49#define SAVEt_BOOL 38
14f338dc 50#define SAVEt_SET_SVFLAGS 39
8b7059b1 51#define SAVEt_SAVESWITCHSTACK 40
fc15ae8f 52#define SAVEt_COP_ARYBASE 41
1ade1aa1 53#define SAVEt_RE_STATE 42
68da3b2f 54#define SAVEt_COMPILE_WARNINGS 43
ea8d6ae1 55#define SAVEt_STACK_CXPOS 44
7c197c94 56#define SAVEt_PARSER 45
79072805 57
b03c0a3a 58#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415 59#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a
NIS
60#endif
61
bb7a0f54
MHM
62#define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
63#define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
3280af22
NIS
64#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
65#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04 66#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22
NIS
67#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
68#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
69#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 70#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22
NIS
71#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
72#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04 73#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22
NIS
74#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
75#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
76#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 77#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 78
954c1994 79/*
ccfc67b7
JH
80=head1 Callback Functions
81
954c1994
GS
82=for apidoc Ams||SAVETMPS
83Opening bracket for temporaries on a callback. See C<FREETMPS> and
84L<perlcall>.
85
86=for apidoc Ams||FREETMPS
87Closing bracket for temporaries on a callback. See C<SAVETMPS> and
88L<perlcall>.
89
90=for apidoc Ams||ENTER
91Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
92
93=for apidoc Ams||LEAVE
94Closing bracket on a callback. See C<ENTER> and L<perlcall>.
95
96=cut
97*/
98
3280af22
NIS
99#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
100#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 101
f46d017c
GS
102#ifdef DEBUGGING
103#define ENTER \
104 STMT_START { \
105 push_scope(); \
b4ab917c 106 DEBUG_SCOPE("ENTER") \
f46d017c
GS
107 } STMT_END
108#define LEAVE \
109 STMT_START { \
b4ab917c 110 DEBUG_SCOPE("LEAVE") \
f46d017c
GS
111 pop_scope(); \
112 } STMT_END
113#else
a0d0e21e
LW
114#define ENTER push_scope()
115#define LEAVE pop_scope()
f46d017c 116#endif
3280af22 117#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e 118
3f26ef39
NC
119#define SAVEI8(i) save_I8((I8*)&(i))
120#define SAVEI16(i) save_I16((I16*)&(i))
121#define SAVEI32(i) save_I32((I32*)&(i))
122#define SAVEINT(i) save_int((int*)&(i))
123#define SAVEIV(i) save_iv((IV*)&(i))
124#define SAVELONG(l) save_long((long*)&(l))
125#define SAVEBOOL(b) save_bool((bool*)&(b))
55497cff 126#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39 127#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452 128#define SAVEVPTR(s) save_vptr((void*)&(s))
09edbca0 129#define SAVEPADSVANDMORTALIZE(s) save_padsv_and_mortalize(s)
55497cff 130#define SAVEFREESV(s) save_freesv((SV*)(s))
26d9b02f 131#define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
3f26ef39
NC
132#define SAVEFREEOP(o) save_freeop((OP*)(o))
133#define SAVEFREEPV(p) save_freepv((char*)(p))
134#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37 135#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9 136#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3 137#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc 138#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
55497cff 139#define SAVEDELETE(h,k,l) \
3f26ef39 140 save_delete((HV*)(h), (char*)(k), (I32)(l))
55497cff 141#define SAVEDESTRUCTOR(f,p) \
3f26ef39 142 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee
GS
143
144#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39 145 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213
GS
146
147#define SAVESTACK_POS() \
148 STMT_START { \
149 SSCHECK(2); \
3280af22 150 SSPUSHINT(PL_stack_sp - PL_stack_base); \
25eaa213
GS
151 SSPUSHINT(SAVEt_STACK_POS); \
152 } STMT_END
153
462e5cf6 154#define SAVEOP() save_op()
25eaa213
GS
155
156#define SAVEHINTS() \
dfa41748 157 STMT_START { \
b3ca2e83 158 SSCHECK(4); \
dfa41748
DM
159 if (PL_hints & HINT_LOCALIZE_HH) { \
160 SSPUSHPTR(GvHV(PL_hintgv)); \
5b9c0671 161 GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
dfa41748 162 } \
c28fe1ec 163 if (PL_compiling.cop_hints_hash) { \
cbb1fbea 164 HINTS_REFCNT_LOCK; \
c28fe1ec 165 PL_compiling.cop_hints_hash->refcounted_he_refcnt++; \
cbb1fbea 166 HINTS_REFCNT_UNLOCK; \
b3ca2e83 167 } \
c28fe1ec 168 SSPUSHPTR(PL_compiling.cop_hints_hash); \
dfa41748
DM
169 SSPUSHINT(PL_hints); \
170 SSPUSHINT(SAVEt_HINTS); \
25eaa213 171 } STMT_END
354992b1
GS
172
173#define SAVECOMPPAD() \
174 STMT_START { \
f3548bdc
DM
175 SSCHECK(2); \
176 SSPUSHPTR((SV*)PL_comppad); \
177 SSPUSHINT(SAVEt_COMPPAD); \
354992b1 178 } STMT_END
a9332b4a 179
8b7059b1
DM
180#define SAVESWITCHSTACK(f,t) \
181 STMT_START { \
182 SSCHECK(3); \
183 SSPUSHPTR((SV*)(f)); \
184 SSPUSHPTR((SV*)(t)); \
185 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
186 SWITCHSTACK((f),(t)); \
187 PL_curstackinfo->si_stack = (t); \
188 } STMT_END
189
fc15ae8f
NC
190#define SAVECOPARYBASE(c) \
191 STMT_START { \
192 SSCHECK(3); \
193 SSPUSHINT(CopARYBASE_get(c)); \
194 SSPUSHPTR(c); \
195 SSPUSHINT(SAVEt_COP_ARYBASE); \
196 } STMT_END
197
c88c823b 198/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
72dc9ed5
NC
199 because realloc() means that the value can actually change. Possibly
200 could have done savefreesharedpvREF, but this way actually seems cleaner,
201 as it simplifies the code that does the saves, and reduces the load on the
202 save stack. */
68da3b2f 203#define SAVECOMPILEWARNINGS() \
72dc9ed5 204 STMT_START { \
68da3b2f
NC
205 SSCHECK(2); \
206 SSPUSHPTR(PL_compiling.cop_warnings); \
207 SSPUSHINT(SAVEt_COMPILE_WARNINGS); \
72dc9ed5 208 } STMT_END
fc15ae8f 209
ea8d6ae1
DB
210#define SAVESTACK_CXPOS() \
211 STMT_START { \
212 SSCHECK(3); \
213 SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
214 SSPUSHINT(cxstack_ix); \
215 SSPUSHINT(SAVEt_STACK_CXPOS); \
216 } STMT_END
217
7c197c94
DM
218#define SAVEPARSER(p) \
219 STMT_START { \
220 SSCHECK(2); \
221 SSPUSHPTR(p); \
222 SSPUSHINT(SAVEt_PARSER); \
223 } STMT_END
224
57843af0 225#ifdef USE_ITHREADS
f4dd75d9 226# define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
05ec9bb3 227# define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
f4dd75d9 228# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
05ec9bb3 229# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0 230#else
f4dd75d9
GS
231# define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
232# define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
233# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
234# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0
GS
235#endif
236
dea28490 237#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0 238
455ece5e
AD
239/* SSNEW() temporarily allocates a specified number of bytes of data on the
240 * savestack. It returns an integer index into the savestack, because a
241 * pointer would get broken if the savestack is moved on reallocation.
242 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
243 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
244 * alignment will be preserved therough savestack reallocation *only* if
a0288114 245 * realloc returns data aligned to a size divisible by "align"!
455ece5e
AD
246 *
247 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
248 */
249
f2b2c1a7 250#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b 251#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7 252#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
455ece5e 253 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b 254#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e 255
02db2b7b
IZ
256#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
257#define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
455ece5e 258
e9a8c099
MHM
259/*
260 * Local variables:
261 * c-indentation-style: bsd
262 * c-basic-offset: 4
263 * indent-tabs-mode: t
264 * End:
265 *
266 * ex: set ts=8 sts=4 sw=4 noet:
267 */