This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Save the regexp engine state as 1 block on the save stack.
[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
79072805 54
b03c0a3a 55#ifndef SCOPE_SAVES_SIGNAL_MASK
1b266415 56#define SCOPE_SAVES_SIGNAL_MASK 0
b03c0a3a
NIS
57#endif
58
4b3c1a47
AE
59#define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
60#define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
3280af22
NIS
61#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
62#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
9febdf04 63#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
3280af22
NIS
64#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
65#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
66#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
c76ac1ee 67#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
3280af22
NIS
68#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
69#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
9febdf04 70#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
3280af22
NIS
71#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
72#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
73#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
c76ac1ee 74#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
8990e307 75
954c1994 76/*
ccfc67b7
JH
77=head1 Callback Functions
78
954c1994
GS
79=for apidoc Ams||SAVETMPS
80Opening bracket for temporaries on a callback. See C<FREETMPS> and
81L<perlcall>.
82
83=for apidoc Ams||FREETMPS
84Closing bracket for temporaries on a callback. See C<SAVETMPS> and
85L<perlcall>.
86
87=for apidoc Ams||ENTER
88Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
89
90=for apidoc Ams||LEAVE
91Closing bracket on a callback. See C<ENTER> and L<perlcall>.
92
93=cut
94*/
95
3280af22
NIS
96#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
97#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
a0d0e21e 98
f46d017c
GS
99#ifdef DEBUGGING
100#define ENTER \
101 STMT_START { \
102 push_scope(); \
b4ab917c 103 DEBUG_SCOPE("ENTER") \
f46d017c
GS
104 } STMT_END
105#define LEAVE \
106 STMT_START { \
b4ab917c 107 DEBUG_SCOPE("LEAVE") \
f46d017c
GS
108 pop_scope(); \
109 } STMT_END
110#else
a0d0e21e
LW
111#define ENTER push_scope()
112#define LEAVE pop_scope()
f46d017c 113#endif
3280af22 114#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
a0d0e21e 115
3f26ef39
NC
116#define SAVEI8(i) save_I8((I8*)&(i))
117#define SAVEI16(i) save_I16((I16*)&(i))
118#define SAVEI32(i) save_I32((I32*)&(i))
119#define SAVEINT(i) save_int((int*)&(i))
120#define SAVEIV(i) save_iv((IV*)&(i))
121#define SAVELONG(l) save_long((long*)&(l))
122#define SAVEBOOL(b) save_bool((bool*)&(b))
55497cff 123#define SAVESPTR(s) save_sptr((SV**)&(s))
3f26ef39 124#define SAVEPPTR(s) save_pptr((char**)&(s))
57b2e452 125#define SAVEVPTR(s) save_vptr((void*)&(s))
c3564e5c 126#define SAVEPADSV(s) save_padsv(s)
55497cff 127#define SAVEFREESV(s) save_freesv((SV*)(s))
26d9b02f 128#define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
3f26ef39
NC
129#define SAVEFREEOP(o) save_freeop((OP*)(o))
130#define SAVEFREEPV(p) save_freepv((char*)(p))
131#define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
b9d12d37 132#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
f4dd75d9 133#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
05ec9bb3 134#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
14f338dc 135#define SAVESETSVFLAGS(sv,mask,val) save_set_svflags(sv,mask,val)
55497cff 136#define SAVEDELETE(h,k,l) \
3f26ef39 137 save_delete((HV*)(h), (char*)(k), (I32)(l))
55497cff 138#define SAVEDESTRUCTOR(f,p) \
3f26ef39 139 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
c76ac1ee
GS
140
141#define SAVEDESTRUCTOR_X(f,p) \
3f26ef39 142 save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
25eaa213
GS
143
144#define SAVESTACK_POS() \
145 STMT_START { \
146 SSCHECK(2); \
3280af22 147 SSPUSHINT(PL_stack_sp - PL_stack_base); \
25eaa213
GS
148 SSPUSHINT(SAVEt_STACK_POS); \
149 } STMT_END
150
462e5cf6 151#define SAVEOP() save_op()
25eaa213
GS
152
153#define SAVEHINTS() \
dfa41748 154 STMT_START { \
b3ca2e83 155 SSCHECK(4); \
dfa41748
DM
156 if (PL_hints & HINT_LOCALIZE_HH) { \
157 SSPUSHPTR(GvHV(PL_hintgv)); \
5b9c0671 158 GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
dfa41748 159 } \
b3ca2e83
NC
160 if (PL_compiling.cop_hints) { \
161 PL_compiling.cop_hints->refcounted_he_refcnt++; \
162 } \
163 SSPUSHPTR(PL_compiling.cop_hints); \
dfa41748
DM
164 SSPUSHINT(PL_hints); \
165 SSPUSHINT(SAVEt_HINTS); \
25eaa213 166 } STMT_END
354992b1
GS
167
168#define SAVECOMPPAD() \
169 STMT_START { \
f3548bdc
DM
170 SSCHECK(2); \
171 SSPUSHPTR((SV*)PL_comppad); \
172 SSPUSHINT(SAVEt_COMPPAD); \
354992b1 173 } STMT_END
a9332b4a 174
8b7059b1
DM
175#define SAVESWITCHSTACK(f,t) \
176 STMT_START { \
177 SSCHECK(3); \
178 SSPUSHPTR((SV*)(f)); \
179 SSPUSHPTR((SV*)(t)); \
180 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
181 SWITCHSTACK((f),(t)); \
182 PL_curstackinfo->si_stack = (t); \
183 } STMT_END
184
fc15ae8f
NC
185#define SAVECOPARYBASE(c) \
186 STMT_START { \
187 SSCHECK(3); \
188 SSPUSHINT(CopARYBASE_get(c)); \
189 SSPUSHPTR(c); \
190 SSPUSHINT(SAVEt_COP_ARYBASE); \
191 } STMT_END
192
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), \
455ece5e 222 (align - ((int)((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