source: trunk/essentials/dev-lang/perl/scope.h@ 3367

Last change on this file since 3367 was 3181, checked in by bird, 19 years ago

perl 5.8.8
File size: 13.0 KB
Line 
1/* scope.h
2 *
3 * Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2004, 2005 by Larry Wall and others
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
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
41#define SAVEt_DESTRUCTOR_X 30
42#define SAVEt_VPTR 31
43#define SAVEt_I8 32
44#define SAVEt_COMPPAD 33
45#define SAVEt_GENERIC_PVREF 34
46#define SAVEt_PADSV 35
47#define SAVEt_MORTALIZESV 36
48#define SAVEt_SHARED_PVREF 37
49#define SAVEt_BOOL 38
50#define SAVEt_SAVESWITCHSTACK 40
51
52#ifndef SCOPE_SAVES_SIGNAL_MASK
53#define SCOPE_SAVES_SIGNAL_MASK 0
54#endif
55
56#define SSCHECK(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow()
57#define SSGROW(need) if (PL_savestack_ix + (need) > PL_savestack_max) savestack_grow_cnt(need)
58#define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
59#define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
60#define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
61#define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
62#define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
63#define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
64#define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
65#define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
66#define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
67#define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
68#define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
69#define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
70#define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
71#define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
72
73/*
74=head1 Callback Functions
75
76=for apidoc Ams||SAVETMPS
77Opening bracket for temporaries on a callback. See C<FREETMPS> and
78L<perlcall>.
79
80=for apidoc Ams||FREETMPS
81Closing bracket for temporaries on a callback. See C<SAVETMPS> and
82L<perlcall>.
83
84=for apidoc Ams||ENTER
85Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
86
87=for apidoc Ams||LEAVE
88Closing bracket on a callback. See C<ENTER> and L<perlcall>.
89
90=cut
91*/
92
93#define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
94#define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
95
96#ifdef DEBUGGING
97#define ENTER \
98 STMT_START { \
99 push_scope(); \
100 DEBUG_SCOPE("ENTER") \
101 } STMT_END
102#define LEAVE \
103 STMT_START { \
104 DEBUG_SCOPE("LEAVE") \
105 pop_scope(); \
106 } STMT_END
107#else
108#define ENTER push_scope()
109#define LEAVE pop_scope()
110#endif
111#define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
112
113/*
114 * Not using SOFT_CAST on SAVESPTR, SAVEGENERICSV and SAVEFREESV
115 * because these are used for several kinds of pointer values
116 */
117#define SAVEI8(i) save_I8(SOFT_CAST(I8*)&(i))
118#define SAVEI16(i) save_I16(SOFT_CAST(I16*)&(i))
119#define SAVEI32(i) save_I32(SOFT_CAST(I32*)&(i))
120#define SAVEINT(i) save_int(SOFT_CAST(int*)&(i))
121#define SAVEIV(i) save_iv(SOFT_CAST(IV*)&(i))
122#define SAVELONG(l) save_long(SOFT_CAST(long*)&(l))
123#define SAVEBOOL(b) save_bool(SOFT_CAST(bool*)&(b))
124#define SAVESPTR(s) save_sptr((SV**)&(s))
125#define SAVEPPTR(s) save_pptr(SOFT_CAST(char**)&(s))
126#define SAVEVPTR(s) save_vptr((void*)&(s))
127#define SAVEPADSV(s) save_padsv(s)
128#define SAVEFREESV(s) save_freesv((SV*)(s))
129#define SAVEMORTALIZESV(s) save_mortalizesv((SV*)(s))
130#define SAVEFREEOP(o) save_freeop(SOFT_CAST(OP*)(o))
131#define SAVEFREEPV(p) save_freepv(SOFT_CAST(char*)(p))
132#define SAVECLEARSV(sv) save_clearsv(SOFT_CAST(SV**)&(sv))
133#define SAVEGENERICSV(s) save_generic_svref((SV**)&(s))
134#define SAVEGENERICPV(s) save_generic_pvref((char**)&(s))
135#define SAVESHAREDPV(s) save_shared_pvref((char**)&(s))
136#define SAVEDELETE(h,k,l) \
137 save_delete(SOFT_CAST(HV*)(h), SOFT_CAST(char*)(k), (I32)(l))
138#define SAVEDESTRUCTOR(f,p) \
139 save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), SOFT_CAST(void*)(p))
140
141#define SAVEDESTRUCTOR_X(f,p) \
142 save_destructor_x((DESTRUCTORFUNC_t)(f), SOFT_CAST(void*)(p))
143
144#define SAVESTACK_POS() \
145 STMT_START { \
146 SSCHECK(2); \
147 SSPUSHINT(PL_stack_sp - PL_stack_base); \
148 SSPUSHINT(SAVEt_STACK_POS); \
149 } STMT_END
150
151#define SAVEOP() save_op()
152
153#define SAVEHINTS() \
154 STMT_START { \
155 SSCHECK(3); \
156 if (PL_hints & HINT_LOCALIZE_HH) { \
157 SSPUSHPTR(GvHV(PL_hintgv)); \
158 GvHV(PL_hintgv) = newHVhv(GvHV(PL_hintgv)); \
159 } \
160 SSPUSHINT(PL_hints); \
161 SSPUSHINT(SAVEt_HINTS); \
162 } STMT_END
163
164#define SAVECOMPPAD() \
165 STMT_START { \
166 SSCHECK(2); \
167 SSPUSHPTR((SV*)PL_comppad); \
168 SSPUSHINT(SAVEt_COMPPAD); \
169 } STMT_END
170
171#define SAVESWITCHSTACK(f,t) \
172 STMT_START { \
173 SSCHECK(3); \
174 SSPUSHPTR((SV*)(f)); \
175 SSPUSHPTR((SV*)(t)); \
176 SSPUSHINT(SAVEt_SAVESWITCHSTACK); \
177 SWITCHSTACK((f),(t)); \
178 PL_curstackinfo->si_stack = (t); \
179 } STMT_END
180
181#ifdef USE_ITHREADS
182# define SAVECOPSTASH(c) SAVEPPTR(CopSTASHPV(c))
183# define SAVECOPSTASH_FREE(c) SAVESHAREDPV(CopSTASHPV(c))
184# define SAVECOPFILE(c) SAVEPPTR(CopFILE(c))
185# define SAVECOPFILE_FREE(c) SAVESHAREDPV(CopFILE(c))
186#else
187# define SAVECOPSTASH(c) SAVESPTR(CopSTASH(c))
188# define SAVECOPSTASH_FREE(c) SAVECOPSTASH(c) /* XXX not refcounted */
189# define SAVECOPFILE(c) SAVESPTR(CopFILEGV(c))
190# define SAVECOPFILE_FREE(c) SAVEGENERICSV(CopFILEGV(c))
191#endif
192
193#define SAVECOPLINE(c) SAVEI32(CopLINE(c))
194
195/* SSNEW() temporarily allocates a specified number of bytes of data on the
196 * savestack. It returns an integer index into the savestack, because a
197 * pointer would get broken if the savestack is moved on reallocation.
198 * SSNEWa() works like SSNEW(), but also aligns the data to the specified
199 * number of bytes. MEM_ALIGNBYTES is perhaps the most useful. The
200 * alignment will be preserved therough savestack reallocation *only* if
201 * realloc returns data aligned to a size divisible by "align"!
202 *
203 * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
204 */
205
206#define SSNEW(size) Perl_save_alloc(aTHX_ (size), 0)
207#define SSNEWt(n,t) SSNEW((n)*sizeof(t))
208#define SSNEWa(size,align) Perl_save_alloc(aTHX_ (size), \
209 (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
210#define SSNEWat(n,t,align) SSNEWa((n)*sizeof(t), align)
211
212#define SSPTR(off,type) ((type) ((char*)PL_savestack + off))
213#define SSPTRt(off,type) ((type*) ((char*)PL_savestack + off))
214
215/* A jmpenv packages the state required to perform a proper non-local jump.
216 * Note that there is a start_env initialized when perl starts, and top_env
217 * points to this initially, so top_env should always be non-null.
218 *
219 * Existence of a non-null top_env->je_prev implies it is valid to call
220 * longjmp() at that runlevel (we make sure start_env.je_prev is always
221 * null to ensure this).
222 *
223 * je_mustcatch, when set at any runlevel to TRUE, means eval ops must
224 * establish a local jmpenv to handle exception traps. Care must be taken
225 * to restore the previous value of je_mustcatch before exiting the
226 * stack frame iff JMPENV_PUSH was not called in that stack frame.
227 * GSAR 97-03-27
228 */
229
230struct jmpenv {
231 struct jmpenv * je_prev;
232 Sigjmp_buf je_buf; /* only for use if !je_throw */
233 int je_ret; /* last exception thrown */
234 bool je_mustcatch; /* need to call longjmp()? */
235#ifdef PERL_FLEXIBLE_EXCEPTIONS
236 void (*je_throw)(int v); /* last for bincompat */
237 bool je_noset; /* no need for setjmp() */
238#endif
239};
240