Further tweaks to make it easier to create regexp engine plug ins.
[perl.git] / scope.h
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_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
57 #ifndef SCOPE_SAVES_SIGNAL_MASK
58 #define SCOPE_SAVES_SIGNAL_MASK 0
59 #endif
60
61 #define SSCHECK(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow()
62 #define SSGROW(need) if (PL_savestack_ix + (I32)(need) > PL_savestack_max) savestack_grow_cnt(need)
63 #define SSPUSHINT(i) (PL_savestack[PL_savestack_ix++].any_i32 = (I32)(i))
64 #define SSPUSHLONG(i) (PL_savestack[PL_savestack_ix++].any_long = (long)(i))
65 #define SSPUSHBOOL(p) (PL_savestack[PL_savestack_ix++].any_bool = (p))
66 #define SSPUSHIV(i) (PL_savestack[PL_savestack_ix++].any_iv = (IV)(i))
67 #define SSPUSHPTR(p) (PL_savestack[PL_savestack_ix++].any_ptr = (void*)(p))
68 #define SSPUSHDPTR(p) (PL_savestack[PL_savestack_ix++].any_dptr = (p))
69 #define SSPUSHDXPTR(p) (PL_savestack[PL_savestack_ix++].any_dxptr = (p))
70 #define SSPOPINT (PL_savestack[--PL_savestack_ix].any_i32)
71 #define SSPOPLONG (PL_savestack[--PL_savestack_ix].any_long)
72 #define SSPOPBOOL (PL_savestack[--PL_savestack_ix].any_bool)
73 #define SSPOPIV (PL_savestack[--PL_savestack_ix].any_iv)
74 #define SSPOPPTR (PL_savestack[--PL_savestack_ix].any_ptr)
75 #define SSPOPDPTR (PL_savestack[--PL_savestack_ix].any_dptr)
76 #define SSPOPDXPTR (PL_savestack[--PL_savestack_ix].any_dxptr)
77
78 /*
79 =head1 Callback Functions
80
81 =for apidoc Ams||SAVETMPS
82 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
83 L<perlcall>.
84
85 =for apidoc Ams||FREETMPS
86 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
87 L<perlcall>.
88
89 =for apidoc Ams||ENTER
90 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
91
92 =for apidoc Ams||LEAVE
93 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
94
95 =cut
96 */
97
98 #define SAVETMPS save_int((int*)&PL_tmps_floor), PL_tmps_floor = PL_tmps_ix
99 #define FREETMPS if (PL_tmps_ix > PL_tmps_floor) free_tmps()
100
101 #ifdef DEBUGGING
102 #define ENTER                                                   \
103     STMT_START {                                                \
104         push_scope();                                           \
105         DEBUG_SCOPE("ENTER")                                    \
106     } STMT_END
107 #define LEAVE                                                   \
108     STMT_START {                                                \
109         DEBUG_SCOPE("LEAVE")                                    \
110         pop_scope();                                            \
111     } STMT_END
112 #else
113 #define ENTER push_scope()
114 #define LEAVE pop_scope()
115 #endif
116 #define LEAVE_SCOPE(old) if (PL_savestack_ix > old) leave_scope(old)
117
118 #define SAVEI8(i)       save_I8((I8*)&(i))
119 #define SAVEI16(i)      save_I16((I16*)&(i))
120 #define SAVEI32(i)      save_I32((I32*)&(i))
121 #define SAVEINT(i)      save_int((int*)&(i))
122 #define SAVEIV(i)       save_iv((IV*)&(i))
123 #define SAVELONG(l)     save_long((long*)&(l))
124 #define SAVEBOOL(b)     save_bool((bool*)&(b))
125 #define SAVESPTR(s)     save_sptr((SV**)&(s))
126 #define SAVEPPTR(s)     save_pptr((char**)&(s))
127 #define SAVEVPTR(s)     save_vptr((void*)&(s))
128 #define SAVEPADSV(s)    save_padsv(s)
129 #define SAVEFREESV(s)   save_freesv((SV*)(s))
130 #define SAVEMORTALIZESV(s)      save_mortalizesv((SV*)(s))
131 #define SAVEFREEOP(o)   save_freeop((OP*)(o))
132 #define SAVEFREEPV(p)   save_freepv((char*)(p))
133 #define SAVECLEARSV(sv) save_clearsv((SV**)&(sv))
134 #define SAVEGENERICSV(s)        save_generic_svref((SV**)&(s))
135 #define SAVEGENERICPV(s)        save_generic_pvref((char**)&(s))
136 #define SAVESHAREDPV(s)         save_shared_pvref((char**)&(s))
137 #define SAVESETSVFLAGS(sv,mask,val)     save_set_svflags(sv,mask,val)
138 #define SAVEDELETE(h,k,l) \
139           save_delete((HV*)(h), (char*)(k), (I32)(l))
140 #define SAVEDESTRUCTOR(f,p) \
141           save_destructor((DESTRUCTORFUNC_NOCONTEXT_t)(f), (void*)(p))
142
143 #define SAVEDESTRUCTOR_X(f,p) \
144           save_destructor_x((DESTRUCTORFUNC_t)(f), (void*)(p))
145
146 #define SAVESTACK_POS() \
147     STMT_START {                                \
148         SSCHECK(2);                             \
149         SSPUSHINT(PL_stack_sp - PL_stack_base); \
150         SSPUSHINT(SAVEt_STACK_POS);             \
151     } STMT_END
152
153 #define SAVEOP()        save_op()
154
155 #define SAVEHINTS() \
156     STMT_START {                                        \
157         SSCHECK(4);                                     \
158         if (PL_hints & HINT_LOCALIZE_HH) {              \
159             SSPUSHPTR(GvHV(PL_hintgv));                 \
160             GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv)); \
161         }                                               \
162         if (PL_compiling.cop_hints_hash) {              \
163             HINTS_REFCNT_LOCK;                          \
164             PL_compiling.cop_hints_hash->refcounted_he_refcnt++;        \
165             HINTS_REFCNT_UNLOCK;                        \
166         }                                               \
167         SSPUSHPTR(PL_compiling.cop_hints_hash);         \
168         SSPUSHINT(PL_hints);                            \
169         SSPUSHINT(SAVEt_HINTS);                         \
170     } STMT_END
171
172 #define SAVECOMPPAD() \
173     STMT_START {                                                \
174         SSCHECK(2);                                             \
175         SSPUSHPTR((SV*)PL_comppad);                             \
176         SSPUSHINT(SAVEt_COMPPAD);                               \
177     } STMT_END
178
179 #define SAVESWITCHSTACK(f,t) \
180     STMT_START {                                        \
181         SSCHECK(3);                                     \
182         SSPUSHPTR((SV*)(f));                            \
183         SSPUSHPTR((SV*)(t));                            \
184         SSPUSHINT(SAVEt_SAVESWITCHSTACK);               \
185         SWITCHSTACK((f),(t));                           \
186         PL_curstackinfo->si_stack = (t);                \
187     } STMT_END
188
189 #define SAVECOPARYBASE(c) \
190     STMT_START {                                        \
191         SSCHECK(3);                                     \
192         SSPUSHINT(CopARYBASE_get(c));                   \
193         SSPUSHPTR(c);                                   \
194         SSPUSHINT(SAVEt_COP_ARYBASE);                   \
195     } STMT_END
196
197 /* Need to do the cop warnings like this, rather than a "SAVEFREESHAREDPV",
198    because realloc() means that the value can actually change. Possibly
199    could have done savefreesharedpvREF, but this way actually seems cleaner,
200    as it simplifies the code that does the saves, and reduces the load on the
201    save stack.  */
202 #define SAVECOMPILEWARNINGS() \
203     STMT_START {                                        \
204         SSCHECK(2);                                     \
205         SSPUSHPTR(PL_compiling.cop_warnings);           \
206         SSPUSHINT(SAVEt_COMPILE_WARNINGS);              \
207     } STMT_END
208
209 #define SAVESTACK_CXPOS() \
210     STMT_START {                                  \
211         SSCHECK(3);                               \
212         SSPUSHINT(cxstack[cxstack_ix].blk_oldsp); \
213         SSPUSHINT(cxstack_ix);                    \
214         SSPUSHINT(SAVEt_STACK_CXPOS);             \
215     } STMT_END
216
217 #ifdef USE_ITHREADS
218 #  define SAVECOPSTASH(c)       SAVEPPTR(CopSTASHPV(c))
219 #  define SAVECOPSTASH_FREE(c)  SAVESHAREDPV(CopSTASHPV(c))
220 #  define SAVECOPFILE(c)        SAVEPPTR(CopFILE(c))
221 #  define SAVECOPFILE_FREE(c)   SAVESHAREDPV(CopFILE(c))
222 #else
223 #  define SAVECOPSTASH(c)       SAVESPTR(CopSTASH(c))
224 #  define SAVECOPSTASH_FREE(c)  SAVECOPSTASH(c) /* XXX not refcounted */
225 #  define SAVECOPFILE(c)        SAVESPTR(CopFILEGV(c))
226 #  define SAVECOPFILE_FREE(c)   SAVEGENERICSV(CopFILEGV(c))
227 #endif
228
229 #define SAVECOPLINE(c)          SAVEI32(CopLINE(c))
230
231 /* SSNEW() temporarily allocates a specified number of bytes of data on the
232  * savestack.  It returns an integer index into the savestack, because a
233  * pointer would get broken if the savestack is moved on reallocation.
234  * SSNEWa() works like SSNEW(), but also aligns the data to the specified
235  * number of bytes.  MEM_ALIGNBYTES is perhaps the most useful.  The
236  * alignment will be preserved therough savestack reallocation *only* if
237  * realloc returns data aligned to a size divisible by "align"!
238  *
239  * SSPTR() converts the index returned by SSNEW/SSNEWa() into a pointer.
240  */
241
242 #define SSNEW(size)             Perl_save_alloc(aTHX_ (size), 0)
243 #define SSNEWt(n,t)             SSNEW((n)*sizeof(t))
244 #define SSNEWa(size,align)      Perl_save_alloc(aTHX_ (size), \
245     (align - ((int)((caddr_t)&PL_savestack[PL_savestack_ix]) % align)) % align)
246 #define SSNEWat(n,t,align)      SSNEWa((n)*sizeof(t), align)
247
248 #define SSPTR(off,type)         ((type)  ((char*)PL_savestack + off))
249 #define SSPTRt(off,type)        ((type*) ((char*)PL_savestack + off))
250