Commit | Line | Data |
---|---|---|
dd2155a4 DM |
1 | /* pad.h |
2 | * | |
2eee27d7 SS |
3 | * Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008, |
4 | * 2009, 2010, 2011 by Larry Wall and others | |
dd2155a4 DM |
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 | * This file defines the types and macros associated with the API for | |
10 | * manipulating scratchpads, which are used by perl to store lexical | |
11 | * variables, op targets and constants. | |
12 | */ | |
13 | ||
cc76b5cc Z |
14 | /* |
15 | =head1 Pad Data Structures | |
16 | */ | |
dd2155a4 DM |
17 | |
18 | ||
dd2155a4 DM |
19 | /* offsets within a pad */ |
20 | ||
21 | #if PTRSIZE == 4 | |
22 | typedef U32TYPE PADOFFSET; | |
23 | #else | |
24 | # if PTRSIZE == 8 | |
25 | typedef U64TYPE PADOFFSET; | |
26 | # endif | |
27 | #endif | |
28 | #define NOT_IN_PAD ((PADOFFSET) -1) | |
809abb02 | 29 | |
7261499d FC |
30 | |
31 | struct padlist { | |
32 | SSize_t xpadl_max; /* max index for which array has space */ | |
33 | PAD ** xpadl_alloc; /* pointer to beginning of array of AVs */ | |
8771da69 | 34 | PADNAMELIST*xpadl_outid; /* Padnamelist of outer pad; used as ID */ |
7261499d FC |
35 | }; |
36 | ||
37 | ||
2df5bdd7 DM |
38 | /* a value that PL_cop_seqmax is guaranteed never to be, |
39 | * flagging that a lexical is being introduced, or has not yet left scope | |
40 | */ | |
41 | #define PERL_PADSEQ_INTRO U32_MAX | |
42 | ||
43 | ||
7948fc08 | 44 | /* B.xs needs these for the benefit of B::Deparse */ |
809abb02 | 45 | /* Low range end is exclusive (valid from the cop seq after this one) */ |
809abb02 | 46 | /* High range end is inclusive (valid up to this cop seq) */ |
809abb02 | 47 | |
3441fb63 NC |
48 | #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) |
49 | # define COP_SEQ_RANGE_LOW(sv) \ | |
b1bc3f34 | 50 | (({ const SV *const _sv_cop_seq_range_low = (const SV *) (sv); \ |
7948fc08 RU |
51 | assert(SvTYPE(_sv_cop_seq_range_low) == SVt_NV \ |
52 | || SvTYPE(_sv_cop_seq_range_low) >= SVt_PVNV); \ | |
53 | assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVAV); \ | |
54 | assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVHV); \ | |
55 | assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVCV); \ | |
56 | assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVFM); \ | |
57 | assert(!isGV_with_GP(_sv_cop_seq_range_low)); \ | |
b1bc3f34 | 58 | ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_low)))->xnv_u.xpad_cop_seq.xlow; \ |
3441fb63 NC |
59 | })) |
60 | # define COP_SEQ_RANGE_HIGH(sv) \ | |
b1bc3f34 | 61 | (({ const SV *const _sv_cop_seq_range_high = (const SV *) (sv); \ |
7948fc08 RU |
62 | assert(SvTYPE(_sv_cop_seq_range_high) == SVt_NV \ |
63 | || SvTYPE(_sv_cop_seq_range_high) >= SVt_PVNV); \ | |
64 | assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVAV); \ | |
65 | assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVHV); \ | |
66 | assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVCV); \ | |
67 | assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVFM); \ | |
68 | assert(!isGV_with_GP(_sv_cop_seq_range_high)); \ | |
b1bc3f34 | 69 | ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_high)))->xnv_u.xpad_cop_seq.xhigh; \ |
3441fb63 NC |
70 | })) |
71 | # define PARENT_PAD_INDEX(sv) \ | |
b1bc3f34 | 72 | (({ const SV *const _sv_parent_pad_index = (const SV *) (sv); \ |
7948fc08 RU |
73 | assert(SvTYPE(_sv_parent_pad_index) == SVt_NV \ |
74 | || SvTYPE(_sv_parent_pad_index) >= SVt_PVNV); \ | |
75 | assert(SvTYPE(_sv_parent_pad_index) != SVt_PVAV); \ | |
76 | assert(SvTYPE(_sv_parent_pad_index) != SVt_PVHV); \ | |
77 | assert(SvTYPE(_sv_parent_pad_index) != SVt_PVCV); \ | |
78 | assert(SvTYPE(_sv_parent_pad_index) != SVt_PVFM); \ | |
79 | assert(!isGV_with_GP(_sv_parent_pad_index)); \ | |
b1bc3f34 | 80 | ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_pad_index)))->xnv_u.xpad_cop_seq.xlow; \ |
3441fb63 NC |
81 | })) |
82 | # define PARENT_FAKELEX_FLAGS(sv) \ | |
b1bc3f34 | 83 | (({ const SV *const _sv_parent_fakelex_flags = (const SV *) (sv); \ |
7948fc08 RU |
84 | assert(SvTYPE(_sv_parent_fakelex_flags) == SVt_NV \ |
85 | || SvTYPE(_sv_parent_fakelex_flags) >= SVt_PVNV); \ | |
86 | assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVAV); \ | |
87 | assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVHV); \ | |
88 | assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVCV); \ | |
89 | assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVFM); \ | |
90 | assert(!isGV_with_GP(_sv_parent_fakelex_flags)); \ | |
b1bc3f34 | 91 | ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_fakelex_flags)))->xnv_u.xpad_cop_seq.xhigh; \ |
3441fb63 NC |
92 | })) |
93 | #else | |
94 | # define COP_SEQ_RANGE_LOW(sv) \ | |
95 | (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow)) | |
96 | # define COP_SEQ_RANGE_HIGH(sv) \ | |
97 | (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh)) | |
98 | ||
99 | ||
100 | # define PARENT_PAD_INDEX(sv) \ | |
101 | (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow)) | |
102 | # define PARENT_FAKELEX_FLAGS(sv) \ | |
103 | (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh)) | |
104 | #endif | |
dd2155a4 | 105 | |
6c5e080d | 106 | /* Flags set in the SvIVX field of FAKE namesvs */ |
7948fc08 | 107 | |
6c5e080d NC |
108 | #define PAD_FAKELEX_ANON 1 /* the lex is declared in an ANON, or ... */ |
109 | #define PAD_FAKELEX_MULTI 2 /* the lex can be instantiated multiple times */ | |
110 | ||
dd2155a4 DM |
111 | /* flags for the pad_new() function */ |
112 | ||
c7c737cb DM |
113 | #define padnew_CLONE 1 /* this pad is for a cloned CV */ |
114 | #define padnew_SAVE 2 /* save old globals */ | |
115 | #define padnew_SAVESUB 4 /* also save extra stuff for start of sub */ | |
dd2155a4 DM |
116 | |
117 | /* values for the pad_tidy() function */ | |
118 | ||
119 | typedef enum { | |
120 | padtidy_SUB, /* tidy up a pad for a sub, */ | |
121 | padtidy_SUBCLONE, /* a cloned sub, */ | |
122 | padtidy_FORMAT /* or a format */ | |
123 | } padtidy_type; | |
124 | ||
9f6ec8dd | 125 | /* flags for pad_add_name_pvn. */ |
35f82371 | 126 | |
9f6ec8dd BF |
127 | #define padadd_OUR 0x01 /* our declaration. */ |
128 | #define padadd_STATE 0x02 /* state declaration. */ | |
129 | #define padadd_NO_DUP_CHECK 0x04 /* skip warning on dups. */ | |
7ef30830 FC |
130 | #define padadd_STALEOK 0x08 /* allow stale lexical in active |
131 | * sub, but only one level up */ | |
9f6ec8dd | 132 | #define padadd_UTF8_NAME SVf_UTF8 /* name is UTF-8 encoded. */ |
35f82371 | 133 | |
f3548bdc DM |
134 | /* ASSERT_CURPAD_LEGAL and ASSERT_CURPAD_ACTIVE respectively determine |
135 | * whether PL_comppad and PL_curpad are consistent and whether they have | |
136 | * active values */ | |
dd2155a4 | 137 | |
1dba731d NC |
138 | #ifndef PERL_MAD |
139 | # define pad_peg(label) | |
140 | #endif | |
141 | ||
f3548bdc DM |
142 | #ifdef DEBUGGING |
143 | # define ASSERT_CURPAD_LEGAL(label) \ | |
1dba731d | 144 | pad_peg(label); \ |
f3548bdc DM |
145 | if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0)) \ |
146 | Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%"UVxf"[0x%"UVxf"]",\ | |
147 | label, PTR2UV(PL_comppad), PTR2UV(PL_curpad)); | |
148 | ||
149 | ||
150 | # define ASSERT_CURPAD_ACTIVE(label) \ | |
1dba731d | 151 | pad_peg(label); \ |
f3548bdc DM |
152 | if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad)) \ |
153 | Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%"UVxf"[0x%"UVxf"]",\ | |
154 | label, PTR2UV(PL_comppad), PTR2UV(PL_curpad)); | |
155 | #else | |
156 | # define ASSERT_CURPAD_LEGAL(label) | |
157 | # define ASSERT_CURPAD_ACTIVE(label) | |
158 | #endif | |
159 | ||
160 | ||
161 | ||
162 | /* Note: the following three macros are actually defined in scope.h, but | |
dd2155a4 DM |
163 | * they are documented here for completeness, since they directly or |
164 | * indirectly affect pads. | |
165 | ||
166 | =for apidoc m|void|SAVEPADSV |PADOFFSET po | |
167 | Save a pad slot (used to restore after an iteration) | |
168 | ||
f3548bdc | 169 | XXX DAPM it would make more sense to make the arg a PADOFFSET |
dd2155a4 | 170 | =for apidoc m|void|SAVECLEARSV |SV **svp |
eeb8d49e | 171 | Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my') |
dd2155a4 DM |
172 | |
173 | =for apidoc m|void|SAVECOMPPAD | |
9c47725a | 174 | save PL_comppad and PL_curpad |
dd2155a4 | 175 | |
dd2155a4 | 176 | |
86d2498c | 177 | =for apidoc Amx|PAD **|PadlistARRAY|PADLIST padlist |
35e035cc FC |
178 | The C array of a padlist, containing the pads. Only subscript it with |
179 | numbers >= 1, as the 0th entry is not guaranteed to remain usable. | |
dd2155a4 | 180 | |
86d2498c | 181 | =for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist |
35e035cc FC |
182 | The index of the last pad in the padlist. |
183 | ||
86d2498c | 184 | =for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist |
35e035cc FC |
185 | The names associated with pad entries. |
186 | ||
86d2498c | 187 | =for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST padlist |
35e035cc FC |
188 | The C array of pad names. |
189 | ||
86d2498c | 190 | =for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST padlist |
35e035cc FC |
191 | The index of the last pad name. |
192 | ||
86d2498c | 193 | =for apidoc Amx|U32|PadlistREFCNT|PADLIST padlist |
35e035cc FC |
194 | The reference count of the padlist. Currently this is always 1. |
195 | ||
86d2498c | 196 | =for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST pnl |
35e035cc FC |
197 | The C array of pad names. |
198 | ||
86d2498c | 199 | =for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST pnl |
35e035cc FC |
200 | The index of the last pad name. |
201 | ||
86d2498c | 202 | =for apidoc Amx|SV **|PadARRAY|PAD pad |
35e035cc FC |
203 | The C array of pad entries. |
204 | ||
86d2498c | 205 | =for apidoc Amx|SSize_t|PadMAX|PAD pad |
35e035cc FC |
206 | The index of the last pad entry. |
207 | ||
86d2498c | 208 | =for apidoc Amx|char *|PadnamePV|PADNAME pn |
44510545 FC |
209 | The name stored in the pad name struct. This returns NULL for a target or |
210 | GV slot. | |
35e035cc | 211 | |
86d2498c | 212 | =for apidoc Amx|STRLEN|PadnameLEN|PADNAME pn |
35e035cc FC |
213 | The length of the name. |
214 | ||
86d2498c FC |
215 | =for apidoc Amx|bool|PadnameUTF8|PADNAME pn |
216 | Whether PadnamePV is in UTF8. | |
35e035cc | 217 | |
86d2498c | 218 | =for apidoc Amx|SV *|PadnameSV|PADNAME pn |
97dad6bd FC |
219 | Returns the pad name as an SV. This is currently just C<pn>. It will |
220 | begin returning a new mortal SV if pad names ever stop being SVs. | |
221 | ||
86d2498c | 222 | =for apidoc m|bool|PadnameIsOUR|PADNAME pn |
35e035cc FC |
223 | Whether this is an "our" variable. |
224 | ||
86d2498c | 225 | =for apidoc m|HV *|PadnameOURSTASH |
35e035cc FC |
226 | The stash in which this "our" variable was declared. |
227 | ||
86d2498c | 228 | =for apidoc m|bool|PadnameOUTER|PADNAME pn |
c44737a2 FC |
229 | Whether this entry belongs to an outer pad. |
230 | ||
3f6a9d3a | 231 | =for apidoc m|bool|PadnameIsSTATE|PADNAME pn |
643fe368 FC |
232 | Whether this is a "state" variable. |
233 | ||
86d2498c | 234 | =for apidoc m|HV *|PadnameTYPE|PADNAME pn |
35e035cc FC |
235 | The stash associated with a typed lexical. This returns the %Foo:: hash |
236 | for C<my Foo $bar>. | |
dd2155a4 DM |
237 | |
238 | ||
239 | =for apidoc m|SV *|PAD_SETSV |PADOFFSET po|SV* sv | |
240 | Set the slot at offset C<po> in the current pad to C<sv> | |
241 | ||
242 | =for apidoc m|void|PAD_SV |PADOFFSET po | |
243 | Get the value at offset C<po> in the current pad | |
244 | ||
245 | =for apidoc m|SV *|PAD_SVl |PADOFFSET po | |
246 | Lightweight and lvalue version of C<PAD_SV>. | |
247 | Get or set the value at offset C<po> in the current pad. | |
248 | Unlike C<PAD_SV>, does not print diagnostics with -DX. | |
249 | For internal use only. | |
250 | ||
251 | =for apidoc m|SV *|PAD_BASE_SV |PADLIST padlist|PADOFFSET po | |
252 | Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist | |
253 | ||
254 | =for apidoc m|void|PAD_SET_CUR |PADLIST padlist|I32 n | |
255 | Set the current pad to be pad C<n> in the padlist, saving | |
fd617465 DM |
256 | the previous current pad. NB currently this macro expands to a string too |
257 | long for some compilers, so it's best to replace it with | |
258 | ||
259 | SAVECOMPPAD(); | |
260 | PAD_SET_CUR_NOSAVE(padlist,n); | |
261 | ||
dd2155a4 | 262 | |
4e380990 DM |
263 | =for apidoc m|void|PAD_SET_CUR_NOSAVE |PADLIST padlist|I32 n |
264 | like PAD_SET_CUR, but without the save | |
265 | ||
dd2155a4 DM |
266 | =for apidoc m|void|PAD_SAVE_SETNULLPAD |
267 | Save the current pad then set it to null. | |
268 | ||
f3548bdc DM |
269 | =for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad |
270 | Save the current pad to the local variable opad, then make the | |
271 | current pad equal to npad | |
272 | ||
273 | =for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad | |
274 | Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL() | |
dd2155a4 DM |
275 | |
276 | =cut | |
277 | */ | |
278 | ||
86d2498c FC |
279 | #define PadlistARRAY(pl) (pl)->xpadl_alloc |
280 | #define PadlistMAX(pl) (pl)->xpadl_max | |
281 | #define PadlistNAMES(pl) (*PadlistARRAY(pl)) | |
282 | #define PadlistNAMESARRAY(pl) PadnamelistARRAY(PadlistNAMES(pl)) | |
283 | #define PadlistNAMESMAX(pl) PadnamelistMAX(PadlistNAMES(pl)) | |
284 | #define PadlistREFCNT(pl) 1 /* reserved for future use */ | |
7261499d | 285 | |
86d2498c FC |
286 | #define PadnamelistARRAY(pnl) AvARRAY(pnl) |
287 | #define PadnamelistMAX(pnl) AvFILLp(pnl) | |
35e035cc | 288 | |
86d2498c FC |
289 | #define PadARRAY(pad) AvARRAY(pad) |
290 | #define PadMAX(pad) AvFILLp(pad) | |
35e035cc | 291 | |
86d2498c FC |
292 | #define PadnamePV(pn) (SvPOKp(pn) ? SvPVX(pn) : NULL) |
293 | #define PadnameLEN(pn) SvCUR(pn) | |
294 | #define PadnameUTF8(pn) !!SvUTF8(pn) | |
295 | #define PadnameSV(pn) pn | |
296 | #define PadnameIsOUR(pn) !!SvPAD_OUR(pn) | |
297 | #define PadnameOURSTASH(pn) SvOURSTASH(pn) | |
298 | #define PadnameOUTER(pn) !!SvFAKE(pn) | |
3f6a9d3a | 299 | #define PadnameIsSTATE(pn) !!SvPAD_STATE(pn) |
86d2498c | 300 | #define PadnameTYPE(pn) (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL) |
35e035cc FC |
301 | |
302 | ||
dd2155a4 DM |
303 | #ifdef DEBUGGING |
304 | # define PAD_SV(po) pad_sv(po) | |
305 | # define PAD_SETSV(po,sv) pad_setsv(po,sv) | |
306 | #else | |
307 | # define PAD_SV(po) (PL_curpad[po]) | |
308 | # define PAD_SETSV(po,sv) PL_curpad[po] = (sv) | |
309 | #endif | |
310 | ||
311 | #define PAD_SVl(po) (PL_curpad[po]) | |
312 | ||
313 | #define PAD_BASE_SV(padlist, po) \ | |
86d2498c FC |
314 | (PadlistARRAY(padlist)[1]) \ |
315 | ? AvARRAY(MUTABLE_AV((PadlistARRAY(padlist)[1])))[po] \ | |
7261499d | 316 | : NULL; |
7948fc08 | 317 | |
dd2155a4 | 318 | |
de5e01c2 | 319 | #define PAD_SET_CUR_NOSAVE(padlist,nth) \ |
86d2498c | 320 | PL_comppad = (PAD*) (PadlistARRAY(padlist)[nth]); \ |
f3548bdc DM |
321 | PL_curpad = AvARRAY(PL_comppad); \ |
322 | DEBUG_Xv(PerlIO_printf(Perl_debug_log, \ | |
323 | "Pad 0x%"UVxf"[0x%"UVxf"] set_cur depth=%d\n", \ | |
de5e01c2 | 324 | PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth))); |
f3548bdc DM |
325 | |
326 | ||
de5e01c2 | 327 | #define PAD_SET_CUR(padlist,nth) \ |
4e380990 | 328 | SAVECOMPPAD(); \ |
de5e01c2 | 329 | PAD_SET_CUR_NOSAVE(padlist,nth); |
4e380990 DM |
330 | |
331 | ||
f3548bdc | 332 | #define PAD_SAVE_SETNULLPAD() SAVECOMPPAD(); \ |
4608196e | 333 | PL_comppad = NULL; PL_curpad = NULL; \ |
f3548bdc DM |
334 | DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad set_null\n")); |
335 | ||
336 | #define PAD_SAVE_LOCAL(opad,npad) \ | |
337 | opad = PL_comppad; \ | |
338 | PL_comppad = (npad); \ | |
4608196e | 339 | PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \ |
f3548bdc DM |
340 | DEBUG_Xv(PerlIO_printf(Perl_debug_log, \ |
341 | "Pad 0x%"UVxf"[0x%"UVxf"] save_local\n", \ | |
342 | PTR2UV(PL_comppad), PTR2UV(PL_curpad))); | |
343 | ||
344 | #define PAD_RESTORE_LOCAL(opad) \ | |
8c63ea58 GG |
345 | assert(!opad || !SvIS_FREED(opad)); \ |
346 | PL_comppad = opad; \ | |
4608196e | 347 | PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \ |
f3548bdc DM |
348 | DEBUG_Xv(PerlIO_printf(Perl_debug_log, \ |
349 | "Pad 0x%"UVxf"[0x%"UVxf"] restore_local\n", \ | |
350 | PTR2UV(PL_comppad), PTR2UV(PL_curpad))); | |
dd2155a4 DM |
351 | |
352 | ||
353 | /* | |
354 | =for apidoc m|void|CX_CURPAD_SAVE|struct context | |
355 | Save the current pad in the given context block structure. | |
356 | ||
f3548bdc | 357 | =for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po |
dd2155a4 DM |
358 | Access the SV at offset po in the saved current pad in the given |
359 | context block structure (can be used as an lvalue). | |
360 | ||
361 | =cut | |
362 | */ | |
363 | ||
f3548bdc | 364 | #define CX_CURPAD_SAVE(block) (block).oldcomppad = PL_comppad |
a062e10d | 365 | #define CX_CURPAD_SV(block,po) (AvARRAY(MUTABLE_AV(((block).oldcomppad)))[po]) |
dd2155a4 DM |
366 | |
367 | ||
368 | /* | |
369 | =for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po | |
370 | Return the flags for the current compiling pad name | |
371 | at offset C<po>. Assumes a valid slot entry. | |
372 | ||
373 | =for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po | |
374 | Return the name of the current compiling pad name | |
375 | at offset C<po>. Assumes a valid slot entry. | |
376 | ||
377 | =for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po | |
378 | Return the type (stash) of the current compiling pad name at offset | |
379 | C<po>. Must be a valid name. Returns null if not typed. | |
380 | ||
381 | =for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po | |
382 | Return the stash associated with an C<our> variable. | |
383 | Assumes the slot entry is a valid C<our> lexical. | |
384 | ||
385 | =for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po | |
386 | The generation number of the name at offset C<po> in the current | |
931b58fb | 387 | compiling pad (lvalue). Note that C<SvUVX> is hijacked for this purpose. |
dd2155a4 | 388 | |
b162af07 SP |
389 | =for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen |
390 | Sets the generation number of the name at offset C<po> in the current | |
931b58fb | 391 | ling pad (lvalue) to C<gen>. Note that C<SvUV_set> is hijacked for this purpose. |
b162af07 | 392 | |
dd2155a4 | 393 | =cut |
b162af07 | 394 | |
dd2155a4 DM |
395 | */ |
396 | ||
35e035cc | 397 | #define PAD_COMPNAME(po) PAD_COMPNAME_SV(po) |
f8503592 NC |
398 | #define PAD_COMPNAME_SV(po) (*av_fetch(PL_comppad_name, (po), FALSE)) |
399 | #define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po)) | |
1979170b | 400 | #define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po)) |
f8503592 | 401 | #define PAD_COMPNAME_PV(po) SvPV_nolen(PAD_COMPNAME_SV(po)) |
dd2155a4 | 402 | |
b21dc031 | 403 | #define PAD_COMPNAME_TYPE(po) pad_compname_type(po) |
dd2155a4 DM |
404 | |
405 | #define PAD_COMPNAME_OURSTASH(po) \ | |
73d95100 | 406 | (SvOURSTASH(PAD_COMPNAME_SV(po))) |
dd2155a4 | 407 | |
931b58fb | 408 | #define PAD_COMPNAME_GEN(po) ((STRLEN)SvUVX(AvARRAY(PL_comppad_name)[po])) |
dd2155a4 | 409 | |
931b58fb | 410 | #define PAD_COMPNAME_GEN_set(po, gen) SvUV_set(AvARRAY(PL_comppad_name)[po], (UV)(gen)) |
dd2155a4 DM |
411 | |
412 | ||
413 | /* | |
d77cdebf | 414 | =for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param |
dd2155a4 DM |
415 | Clone the state variables associated with running and compiling pads. |
416 | ||
417 | =cut | |
418 | */ | |
419 | ||
c5ab0850 DM |
420 | /* NB - we set PL_comppad to null unless it points at a value that |
421 | * has already been dup'ed, ie it points to part of an active padlist. | |
422 | * Otherwise PL_comppad ends up being a leaked scalar in code like | |
423 | * the following: | |
424 | * threads->create(sub { threads->create(sub {...} ) } ); | |
425 | * where the second thread dups the outer sub's comppad but not the | |
426 | * sub's CV or padlist. */ | |
f3548bdc | 427 | |
dd2155a4 | 428 | #define PAD_CLONE_VARS(proto_perl, param) \ |
253649d9 | 429 | PL_comppad = av_dup(proto_perl->Icomppad, param); \ |
4608196e | 430 | PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \ |
dd2155a4 DM |
431 | PL_comppad_name = av_dup(proto_perl->Icomppad_name, param); \ |
432 | PL_comppad_name_fill = proto_perl->Icomppad_name_fill; \ | |
433 | PL_comppad_name_floor = proto_perl->Icomppad_name_floor; \ | |
dd2155a4 DM |
434 | PL_min_intro_pending = proto_perl->Imin_intro_pending; \ |
435 | PL_max_intro_pending = proto_perl->Imax_intro_pending; \ | |
436 | PL_padix = proto_perl->Ipadix; \ | |
437 | PL_padix_floor = proto_perl->Ipadix_floor; \ | |
438 | PL_pad_reset_pending = proto_perl->Ipad_reset_pending; \ | |
439 | PL_cop_seqmax = proto_perl->Icop_seqmax; | |
e9a8c099 MHM |
440 | |
441 | /* | |
cc76b5cc Z |
442 | =for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash |
443 | ||
444 | Exactly like L</pad_add_name_pvn>, but takes a literal string instead | |
445 | of a string/length pair. | |
446 | ||
447 | =cut | |
448 | */ | |
449 | ||
450 | #define pad_add_name_pvs(name,flags,typestash,ourstash) \ | |
451 | Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash) | |
452 | ||
453 | /* | |
454 | =for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags | |
455 | ||
456 | Exactly like L</pad_findmy_pvn>, but takes a literal string instead | |
457 | of a string/length pair. | |
458 | ||
459 | =cut | |
460 | */ | |
461 | ||
462 | #define pad_findmy_pvs(name,flags) \ | |
463 | Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags) | |
464 | ||
465 | /* | |
e9a8c099 MHM |
466 | * Local variables: |
467 | * c-indentation-style: bsd | |
468 | * c-basic-offset: 4 | |
14d04a33 | 469 | * indent-tabs-mode: nil |
e9a8c099 MHM |
470 | * End: |
471 | * | |
14d04a33 | 472 | * ex: set ts=8 sts=4 sw=4 et: |
e9a8c099 | 473 | */ |