Maintainers.pl: podlators Makefile.PL is CUSTOMIZED
[perl.git] / scope.h
1 /*    scope.h
2  *
3  *    Copyright (C) 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001,
4  *    2002, 2004, 2005, 2006, 2007, 2008 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_AND_MORTALIZE       35
47 #define SAVEt_MORTALIZESV       36
48 #define SAVEt_SHARED_PVREF      37
49 #define SAVEt_BOOL              38
50 #define SAVEt_SET_SVFLAGS       39
51 #define SAVEt_SAVESWITCHSTACK   40
52 #define SAVEt_COP_ARYBASE       41
53 #define SAVEt_RE_STATE          42
54 #define SAVEt_COMPILE_WARNINGS  43
55 #define SAVEt_STACK_CXPOS       44
56 #define SAVEt_PARSER            45
57 #define SAVEt_ADELETE           46
58 #define SAVEt_I32_SMALL         47
59 #define SAVEt_INT_SMALL         48
60
61 #define SAVEf_SETMAGIC          1
62 #define SAVEf_KEEPOLDELEM       2
63
64 #define SAVE_TIGHT_SHIFT        6
65 #define SAVE_MASK               0x3F
66
67 #define save_aelem(av,idx,sptr) save_aelem_flags(av,idx,sptr,SAVEf_SETMAGIC)
68 #define save_helem(hv,key,sptr) save_helem_flags(hv,key,sptr,SAVEf_SETMAGIC)
69
70 #ifndef SCOPE_SAVES_SIGNAL_MASK
71 #define SCOPE_SAVES_SIGNAL_MASK 0
72 #endif
73
74 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
75 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
76 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
77 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
78 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
79 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
80 #define SSPUSHUV(u) (PL_savestack[PL_savestack_ix++].any_uv = (UV)(u))
81 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
82 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
83 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
84 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
85 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
86 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
87 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
88 #define SSPOPUV (PL_savestack[--PL_savestack_ix].any_uv)
89 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
90 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
91 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
92
93 /*
94 =head1 Callback Functions
95
96 =for apidoc Ams||SAVETMPS
97 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
98 L<perlcall>.
99
100 =for apidoc Ams||FREETMPS
101 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
102 L<perlcall>.
103
104 =for apidoc Ams||ENTER
105 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
106
107 =for apidoc Ams||LEAVE
108 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
109
110 =over
111
112 =item ENTER_with_name(name)
113
114 Same as C<ENTER>, but when debugging is enabled it also associates the
115 given literal string with the new scope.
116
117 =item LEAVE_with_name(name)
118
119 Same as C<LEAVE>, but when debugging is enabled it first checks that the
120 scope has the given name. Name must be a literal string.
121
122 =back
123
124 =cut
125 */
126
127 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
128 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
129
130 #ifdef DEBUGGING
131 #define ENTER                                                   \
132     STMT_START {                                                \
133         push_scope();                                           \
134         DEBUG_SCOPE("ENTER")                                    \
135     } STMT_END
136 #define LEAVE                                                   \
137     STMT_START {                                                \
138         DEBUG_SCOPE("LEAVE")                                    \
139         pop_scope();                                            \
140     } STMT_END
141 #define ENTER_with_name(name)                                           \
142     STMT_START {                                                        \
143         push_scope();                                                   \
144         if (PL_scopestack_name)                                         \
145             PL_scopestack_name[PL_scopestack_ix-1] = name;              \
146         DEBUG_SCOPE("ENTER \"" name "\"")                               \
147     } STMT_END
148 #define LEAVE_with_name(name)                                           \
149     STMT_START {                                                        \
150         DEBUG_SCOPE("LEAVE \"" name "\"")                               \
151         if (PL_scopestack_name) {                                       \
152             assert(((char*)PL_scopestack_name[PL_scopestack_ix-1]       \
153                         == (char*)name)                                 \
154                     || strEQ(PL_scopestack_name[PL_scopestack_ix-1], name));        \
155         }                                                               \
156         pop_scope();                                                    \
157     } STMT_END
158 #else
159 #define ENTER push_scope()
160 #define LEAVE pop_scope()
161 #define ENTER_with_name(name) ENTER
162 #define LEAVE_with_name(name) LEAVE
163 #endif
164 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
165
166 #define SAVEI8(i)       save_I8((I8*)&(i))
167 #define SAVEI16(i)      save_I16((I16*)&(i))
168 #define SAVEI32(i)      save_I32((I32*)&(i))
169 #define SAVEINT(i)      save_int((int*)&(i))
170 #define SAVEIV(i)       save_iv((IV*)&(i))
171 #define SAVELONG(l)     save_long((long*)&(l))
172 #define SAVEBOOL(b)     save_bool(&(b))
173 #define SAVESPTR(s)     save_sptr((SV**)&(s))
174 #define SAVEPPTR(s)     save_pptr((char**)&(s))
175 #define SAVEVPTR(s)     save_vptr((void*)&(s))
176 #define SAVEPADSVANDMORTALIZE(s)        save_padsv_and_mortalize(s)
177 #define SAVEFREESV(s)   save_freesv(MUTABLE_SV(s))
178 #define SAVEMORTALIZESV(s)      save_mortalizesv(MUTABLE_SV(s))
179 #define SAVEFREEOP(o)   save_freeop((OP*)(o))
180 #define SAVEFREEPV(p)   save_freepv((char*)(p))
181 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
182 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
183 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
184 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
185 #define SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
186 #define SAVEDELETE(h,k,l) \
187           save_delete(MUTABLE_HV(h), (char*)(k), (I32)(l))
188 #define SAVEHDELETE(h,s) \
189           save_hdelete(MUTABLE_HV(h), (s))
190 #define SAVEADELETE(a,k) \
191           save_adelete(MUTABLE_AV(a), (I32)(k))
192 #define SAVEDESTRUCTOR(f,p) \
193           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
194
195 #define SAVEDESTRUCTOR_X(f,p) \
196           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
197
198 #define SAVESTACK_POS() \
199     STMT_START {                                \
200         SSCHECK(2);                             \
201         SSPUSHINT(PL_stack_sp - PL_stack_base); \
202         SSPUSHUV(SAVEt_STACK_POS);              \
203     } STMT_END
204
205 #define SAVEOP()        save_op()
206
207 #define SAVEHINTS()     save_hints()
208
209 #define SAVECOMPPAD() save_pushptr(MUTABLE_SV(PL_comppad), SAVEt_COMPPAD)
210
211 #define SAVESWITCHSTACK(f,t) \
212     STMT_START {                                        \
213         save_pushptrptr(MUTABLE_SV(f), MUTABLE_SV(t), SAVEt_SAVESWITCHSTACK); \
214         SWITCHSTACK((f),(t));                           \
215         PL_curstackinfo->si_stack = (t);                \
216     } STMT_END
217
218 #define SAVECOPARYBASE(c) save_pushi32ptr(CopARYBASE_get(c), c, SAVEt_COP_ARYBASE);
219
220 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
221    because realloc() means that the value can actually change. Possibly
222    could have done savefreesharedpvREF, but this way actually seems cleaner,
223    as it simplifies the code that does the saves, and reduces the load on the
224    save stack.  */
225 #define SAVECOMPILEWARNINGS() save_pushptr(PL_compiling.cop_warnings, SAVEt_COMPILE_WARNINGS)
226
227 #define SAVESTACK_CXPOS() \
228     STMT_START {                                  \
229         SSCHECK(3);                               \
230         SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
231         SSPUSHINT(cxstack_ix);                    \
232         SSPUSHUV(SAVEt_STACK_CXPOS);              \
233     } STMT_END
234
235 #define SAVEPARSER(p) save_pushptr((p), SAVEt_PARSER)
236
237 #ifdef USE_ITHREADS
238 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
239 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
240 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
241 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
242 #else
243 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
244 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
245 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
246 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
247 #endif
248
249 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
250
251 /* SSNEW() temporarily allocates a specified number of bytes of data on the
252  * savestack.  It returns an integer index into the savestack, because a
253  * pointer would get broken if the savestack is moved on reallocation.
254  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
255  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
256  * alignment will be preserved therough savestack reallocation *only* if
257  * realloc returns data aligned to a size divisible by "align"!
258  *
259  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
260  */
261
262 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
263 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
264 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
265     (I32)(align - ((size_t)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
266 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
267
268 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
269 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
270
271 #define save_freesv(op)         save_pushptr((void *)(op), SAVEt_FREESV)
272 #define save_mortalizesv(op)    save_pushptr((void *)(op), SAVEt_MORTALIZESV)
273 #define save_freeop(op)         save_pushptr((void *)(op), SAVEt_FREEOP)
274 #define save_freepv(pv)         save_pushptr((void *)(pv), SAVEt_FREEPV)
275 #define save_op()               save_pushptr((void *)(PL_op), SAVEt_OP)
276
277 /*
278  * Local variables:
279  * c-indentation-style: bsd
280  * c-basic-offset: 4
281  * indent-tabs-mode: t
282  * End:
283  *
284  * ex: set ts=8 sts=4 sw=4 noet:
285  */