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