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