This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Change SAVECOPWARNINGS(c) to SAVECOMPILEWARNINGS() - it's only used to
[perl5.git] / scope.h
CommitLineData
d6376244
JH
1/* scope.h
2 *
4bb101f2 3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
1d325971 4 * 2000, 2001, 2002, 2004, 2005 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
c3564e5c 46#define SAVEt_PADSV 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
79072805 55
b03c0a3a 56#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415 57#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a
NIS
58#endif
59
4b3c1a47
AE
60#define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
61#define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
3280af22
NIS
62#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
63#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04 64#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22
NIS
65#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
66#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
67#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 68#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22
NIS
69#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
70#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04 71#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22
NIS
72#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
73#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
74#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 75#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 76
954c1994 77/*
ccfc67b7
JH
78=head1 Callback Functions
79
954c1994
GS
80=for apidoc Ams||SAVETMPS
81Opening bracket for temporaries on a callback. See C<FREETMPS> and
82L<perlcall>.
83
84=for apidoc Ams||FREETMPS
85Closing bracket for temporaries on a callback. See C<SAVETMPS> and
86L<perlcall>.
87
88=for apidoc Ams||ENTER
89Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
90
91=for apidoc Ams||LEAVE
92Closing bracket on a callback. See C<ENTER> and L<perlcall>.
93
94=cut
95*/
96
3280af22
NIS
97#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
98#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 99
f46d017c
GS
100#ifdef DEBUGGING
101#define ENTER \
102 STMT_START { \
103 push_scope(); \
b4ab917c 104 DEBUG_SCOPE("ENTER") \
f46d017c
GS
105 } STMT_END
106#define LEAVE \
107 STMT_START { \
b4ab917c 108 DEBUG_SCOPE("LEAVE") \
f46d017c
GS
109 pop_scope(); \
110 } STMT_END
111#else
a0d0e21e
LW
112#define ENTER push_scope()
113#define LEAVE pop_scope()
f46d017c 114#endif
3280af22 115#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e 116
3f26ef39
NC
117#define SAVEI8(i) save_I8((I8*)&(i))
118#define SAVEI16(i) save_I16((I16*)&(i))
119#define SAVEI32(i) save_I32((I32*)&(i))
120#define SAVEINT(i) save_int((int*)&(i))
121#define SAVEIV(i) save_iv((IV*)&(i))
122#define SAVELONG(l) save_long((long*)&(l))
123#define SAVEBOOL(b) save_bool((bool*)&(b))
55497cff 124#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39 125#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452 126#define SAVEVPTR(s) save_vptr((void*)&(s))
c3564e5c 127#define SAVEPADSV(s) save_padsv(s)
55497cff 128#define SAVEFREESV(s) save_freesv((SV*)(s))
26d9b02f 129#define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
3f26ef39
NC
130#define SAVEFREEOP(o) save_freeop((OP*)(o))
131#define SAVEFREEPV(p) save_freepv((char*)(p))
132#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37 133#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9 134#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3 135#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc 136#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
55497cff 137#define SAVEDELETE(h,k,l) \
3f26ef39 138 save_delete((HV*)(h), (char*)(k), (I32)(l))
55497cff 139#define SAVEDESTRUCTOR(f,p) \
3f26ef39 140 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee
GS
141
142#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39 143 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213
GS
144
145#define SAVESTACK_POS() \
146 STMT_START { \
147 SSCHECK(2); \
3280af22 148 SSPUSHINT(PL_stack_sp - PL_stack_base); \
25eaa213
GS
149 SSPUSHINT(SAVEt_STACK_POS); \
150 } STMT_END
151
462e5cf6 152#define SAVEOP() save_op()
25eaa213
GS
153
154#define SAVEHINTS() \
dfa41748 155 STMT_START { \
b3ca2e83 156 SSCHECK(4); \
dfa41748
DM
157 if (PL_hints & HINT_LOCALIZE_HH) { \
158 SSPUSHPTR(GvHV(PL_hintgv)); \
5b9c0671 159 GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
dfa41748 160 } \
b3ca2e83 161 if (PL_compiling.cop_hints) { \
cbb1fbea 162 HINTS_REFCNT_LOCK; \
b3ca2e83 163 PL_compiling.cop_hints->refcounted_he_refcnt++; \
cbb1fbea 164 HINTS_REFCNT_UNLOCK; \
b3ca2e83
NC
165 } \
166 SSPUSHPTR(PL_compiling.cop_hints); \
dfa41748
DM
167 SSPUSHINT(PL_hints); \
168 SSPUSHINT(SAVEt_HINTS); \
25eaa213 169 } STMT_END
354992b1
GS
170
171#define SAVECOMPPAD() \
172 STMT_START { \
f3548bdc
DM
173 SSCHECK(2); \
174 SSPUSHPTR((SV*)PL_comppad); \
175 SSPUSHINT(SAVEt_COMPPAD); \
354992b1 176 } STMT_END
a9332b4a 177
8b7059b1
DM
178#define SAVESWITCHSTACK(f,t) \
179 STMT_START { \
180 SSCHECK(3); \
181 SSPUSHPTR((SV*)(f)); \
182 SSPUSHPTR((SV*)(t)); \
183 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
184 SWITCHSTACK((f),(t)); \
185 PL_curstackinfo->si_stack = (t); \
186 } STMT_END
187
fc15ae8f
NC
188#define SAVECOPARYBASE(c) \
189 STMT_START { \
190 SSCHECK(3); \
191 SSPUSHINT(CopARYBASE_get(c)); \
192 SSPUSHPTR(c); \
193 SSPUSHINT(SAVEt_COP_ARYBASE); \
194 } STMT_END
195
c88c823b 196/* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
72dc9ed5
NC
197 because realloc() means that the value can actually change. Possibly
198 could have done savefreesharedpvREF, but this way actually seems cleaner,
199 as it simplifies the code that does the saves, and reduces the load on the
200 save stack. */
68da3b2f 201#define SAVECOMPILEWARNINGS() \
72dc9ed5 202 STMT_START { \
68da3b2f
NC
203 SSCHECK(2); \
204 SSPUSHPTR(PL_compiling.cop_warnings); \
205 SSPUSHINT(SAVEt_COMPILE_WARNINGS); \
72dc9ed5 206 } STMT_END
fc15ae8f 207
57843af0 208#ifdef USE_ITHREADS
f4dd75d9 209# define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
05ec9bb3 210# define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
f4dd75d9 211# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
05ec9bb3 212# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
57843af0 213#else
f4dd75d9
GS
214# define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
215# define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
216# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
217# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
57843af0
GS
218#endif
219
dea28490 220#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
57843af0 221
455ece5e
AD
222/* SSNEW() temporarily allocates a specified number of bytes of data on the
223 * savestack. It returns an integer index into the savestack, because a
224 * pointer would get broken if the savestack is moved on reallocation.
225 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
226 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
227 * alignment will be preserved therough savestack reallocation *only* if
a0288114 228 * realloc returns data aligned to a size divisible by "align"!
455ece5e
AD
229 *
230 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
231 */
232
f2b2c1a7 233#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
02db2b7b 234#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
f2b2c1a7 235#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
455ece5e 236 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
02db2b7b 237#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
455ece5e 238
02db2b7b
IZ
239#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
240#define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
455ece5e 241