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