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