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