This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #115066] Fix wrongly nested ‘use’ deparsing
[perl5.git] / pad.h
CommitLineData
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
22typedef U32TYPE PADOFFSET;
23#else
24# if PTRSIZE == 8
25typedef U64TYPE PADOFFSET;
26# endif
27#endif
28#define NOT_IN_PAD ((PADOFFSET) -1)
809abb02 29
7261499d
FC
30
31struct 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
119typedef 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 138# define pad_peg(label)
1dba731d 139
f3548bdc
DM
140#ifdef DEBUGGING
141# define ASSERT_CURPAD_LEGAL(label) \
1dba731d 142 pad_peg(label); \
f3548bdc 143 if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0)) \
61608bb7 144 Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%" UVxf "[0x%" UVxf "]",\
f3548bdc
DM
145 label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
146
147
148# define ASSERT_CURPAD_ACTIVE(label) \
1dba731d 149 pad_peg(label); \
f3548bdc 150 if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad)) \
61608bb7 151 Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%" UVxf "[0x%" UVxf "]",\
f3548bdc
DM
152 label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
153#else
154# define ASSERT_CURPAD_LEGAL(label)
155# define ASSERT_CURPAD_ACTIVE(label)
156#endif
157
158
159
160/* Note: the following three macros are actually defined in scope.h, but
dd2155a4
DM
161 * they are documented here for completeness, since they directly or
162 * indirectly affect pads.
163
164=for apidoc m|void|SAVEPADSV |PADOFFSET po
165Save a pad slot (used to restore after an iteration)
166
f3548bdc 167XXX DAPM it would make more sense to make the arg a PADOFFSET
dd2155a4 168=for apidoc m|void|SAVECLEARSV |SV **svp
154e47c8
FC
169Clear the pointed to pad value on scope exit. (i.e. the runtime action of
170'my')
dd2155a4
DM
171
172=for apidoc m|void|SAVECOMPPAD
9c47725a 173save PL_comppad and PL_curpad
dd2155a4 174
dd2155a4 175
86d2498c 176=for apidoc Amx|PAD **|PadlistARRAY|PADLIST padlist
35e035cc
FC
177The C array of a padlist, containing the pads. Only subscript it with
178numbers >= 1, as the 0th entry is not guaranteed to remain usable.
dd2155a4 179
86d2498c 180=for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist
57ee99bb
FC
181The index of the last allocated space in the padlist. Note that the last
182pad may be in an earlier slot. Any entries following it will be NULL in
183that case.
35e035cc 184
86d2498c 185=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist
35e035cc
FC
186The names associated with pad entries.
187
86d2498c 188=for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST padlist
35e035cc
FC
189The C array of pad names.
190
86d2498c 191=for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST padlist
35e035cc
FC
192The index of the last pad name.
193
86d2498c 194=for apidoc Amx|U32|PadlistREFCNT|PADLIST padlist
35e035cc
FC
195The reference count of the padlist. Currently this is always 1.
196
86d2498c 197=for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST pnl
35e035cc
FC
198The C array of pad names.
199
86d2498c 200=for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST pnl
35e035cc
FC
201The index of the last pad name.
202
86d2498c 203=for apidoc Amx|SV **|PadARRAY|PAD pad
35e035cc
FC
204The C array of pad entries.
205
86d2498c 206=for apidoc Amx|SSize_t|PadMAX|PAD pad
35e035cc
FC
207The index of the last pad entry.
208
86d2498c 209=for apidoc Amx|char *|PadnamePV|PADNAME pn
44510545
FC
210The name stored in the pad name struct. This returns NULL for a target or
211GV slot.
35e035cc 212
86d2498c 213=for apidoc Amx|STRLEN|PadnameLEN|PADNAME pn
35e035cc
FC
214The length of the name.
215
86d2498c
FC
216=for apidoc Amx|bool|PadnameUTF8|PADNAME pn
217Whether PadnamePV is in UTF8.
35e035cc 218
86d2498c 219=for apidoc Amx|SV *|PadnameSV|PADNAME pn
97dad6bd
FC
220Returns the pad name as an SV. This is currently just C<pn>. It will
221begin returning a new mortal SV if pad names ever stop being SVs.
222
86d2498c 223=for apidoc m|bool|PadnameIsOUR|PADNAME pn
35e035cc
FC
224Whether this is an "our" variable.
225
86d2498c 226=for apidoc m|HV *|PadnameOURSTASH
35e035cc
FC
227The stash in which this "our" variable was declared.
228
86d2498c 229=for apidoc m|bool|PadnameOUTER|PADNAME pn
c44737a2
FC
230Whether this entry belongs to an outer pad.
231
3f6a9d3a 232=for apidoc m|bool|PadnameIsSTATE|PADNAME pn
643fe368
FC
233Whether this is a "state" variable.
234
86d2498c 235=for apidoc m|HV *|PadnameTYPE|PADNAME pn
35e035cc
FC
236The stash associated with a typed lexical. This returns the %Foo:: hash
237for C<my Foo $bar>.
dd2155a4
DM
238
239
240=for apidoc m|SV *|PAD_SETSV |PADOFFSET po|SV* sv
241Set the slot at offset C<po> in the current pad to C<sv>
242
9a0afbbc 243=for apidoc m|SV *|PAD_SV |PADOFFSET po
dd2155a4
DM
244Get the value at offset C<po> in the current pad
245
246=for apidoc m|SV *|PAD_SVl |PADOFFSET po
247Lightweight and lvalue version of C<PAD_SV>.
248Get or set the value at offset C<po> in the current pad.
249Unlike C<PAD_SV>, does not print diagnostics with -DX.
250For internal use only.
251
252=for apidoc m|SV *|PAD_BASE_SV |PADLIST padlist|PADOFFSET po
253Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
254
255=for apidoc m|void|PAD_SET_CUR |PADLIST padlist|I32 n
256Set the current pad to be pad C<n> in the padlist, saving
154e47c8 257the previous current pad. NB currently this macro expands to a string too
fd617465
DM
258long for some compilers, so it's best to replace it with
259
260 SAVECOMPPAD();
261 PAD_SET_CUR_NOSAVE(padlist,n);
262
dd2155a4 263
4e380990
DM
264=for apidoc m|void|PAD_SET_CUR_NOSAVE |PADLIST padlist|I32 n
265like PAD_SET_CUR, but without the save
266
dd2155a4
DM
267=for apidoc m|void|PAD_SAVE_SETNULLPAD
268Save the current pad then set it to null.
269
f3548bdc
DM
270=for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad
271Save the current pad to the local variable opad, then make the
272current pad equal to npad
273
274=for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad
275Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
dd2155a4
DM
276
277=cut
278*/
279
86d2498c
FC
280#define PadlistARRAY(pl) (pl)->xpadl_alloc
281#define PadlistMAX(pl) (pl)->xpadl_max
282#define PadlistNAMES(pl) (*PadlistARRAY(pl))
283#define PadlistNAMESARRAY(pl) PadnamelistARRAY(PadlistNAMES(pl))
284#define PadlistNAMESMAX(pl) PadnamelistMAX(PadlistNAMES(pl))
285#define PadlistREFCNT(pl) 1 /* reserved for future use */
7261499d 286
86d2498c
FC
287#define PadnamelistARRAY(pnl) AvARRAY(pnl)
288#define PadnamelistMAX(pnl) AvFILLp(pnl)
7db6405c
FC
289#define PadnamelistMAXNAMED(pnl) \
290 ((XPVAV*) SvANY(pnl))->xmg_u.xmg_hash_index
35e035cc 291
86d2498c
FC
292#define PadARRAY(pad) AvARRAY(pad)
293#define PadMAX(pad) AvFILLp(pad)
35e035cc 294
86d2498c 295#define PadnamePV(pn) (SvPOKp(pn) ? SvPVX(pn) : NULL)
325e1816 296#define PadnameLEN(pn) ((pn) == &PL_sv_undef ? 0 : SvCUR(pn))
86d2498c
FC
297#define PadnameUTF8(pn) !!SvUTF8(pn)
298#define PadnameSV(pn) pn
299#define PadnameIsOUR(pn) !!SvPAD_OUR(pn)
300#define PadnameOURSTASH(pn) SvOURSTASH(pn)
301#define PadnameOUTER(pn) !!SvFAKE(pn)
3f6a9d3a 302#define PadnameIsSTATE(pn) !!SvPAD_STATE(pn)
86d2498c 303#define PadnameTYPE(pn) (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL)
72af0f20
FC
304#define PadnameLVALUE(pn) \
305 ((SvFLAGS(pn) & (SVpad_NAME|SVpad_LVALUE))==(SVpad_NAME|SVpad_LVALUE))
35e035cc 306
72af0f20 307#define PadnameLVALUE_on(pn) (SvFLAGS(pn) |= SVpad_NAME|SVpad_LVALUE)
35e035cc 308
dd2155a4
DM
309#ifdef DEBUGGING
310# define PAD_SV(po) pad_sv(po)
311# define PAD_SETSV(po,sv) pad_setsv(po,sv)
312#else
313# define PAD_SV(po) (PL_curpad[po])
314# define PAD_SETSV(po,sv) PL_curpad[po] = (sv)
315#endif
316
317#define PAD_SVl(po) (PL_curpad[po])
318
319#define PAD_BASE_SV(padlist, po) \
86d2498c
FC
320 (PadlistARRAY(padlist)[1]) \
321 ? AvARRAY(MUTABLE_AV((PadlistARRAY(padlist)[1])))[po] \
7261499d 322 : NULL;
7948fc08 323
dd2155a4 324
de5e01c2 325#define PAD_SET_CUR_NOSAVE(padlist,nth) \
86d2498c 326 PL_comppad = (PAD*) (PadlistARRAY(padlist)[nth]); \
f3548bdc
DM
327 PL_curpad = AvARRAY(PL_comppad); \
328 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
61608bb7 329 "Pad 0x%" UVxf "[0x%" UVxf "] set_cur depth=%d\n", \
de5e01c2 330 PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth)));
f3548bdc
DM
331
332
de5e01c2 333#define PAD_SET_CUR(padlist,nth) \
4e380990 334 SAVECOMPPAD(); \
de5e01c2 335 PAD_SET_CUR_NOSAVE(padlist,nth);
4e380990
DM
336
337
f3548bdc 338#define PAD_SAVE_SETNULLPAD() SAVECOMPPAD(); \
4608196e 339 PL_comppad = NULL; PL_curpad = NULL; \
f3548bdc
DM
340 DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad set_null\n"));
341
342#define PAD_SAVE_LOCAL(opad,npad) \
343 opad = PL_comppad; \
344 PL_comppad = (npad); \
4608196e 345 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
f3548bdc 346 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
61608bb7 347 "Pad 0x%" UVxf "[0x%" UVxf "] save_local\n", \
f3548bdc
DM
348 PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
349
350#define PAD_RESTORE_LOCAL(opad) \
8c63ea58
GG
351 assert(!opad || !SvIS_FREED(opad)); \
352 PL_comppad = opad; \
4608196e 353 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
f3548bdc 354 DEBUG_Xv(PerlIO_printf(Perl_debug_log, \
61608bb7 355 "Pad 0x%" UVxf "[0x%" UVxf "] restore_local\n", \
f3548bdc 356 PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
dd2155a4
DM
357
358
359/*
360=for apidoc m|void|CX_CURPAD_SAVE|struct context
361Save the current pad in the given context block structure.
362
f3548bdc 363=for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po
dd2155a4
DM
364Access the SV at offset po in the saved current pad in the given
365context block structure (can be used as an lvalue).
366
367=cut
368*/
369
f3548bdc 370#define CX_CURPAD_SAVE(block) (block).oldcomppad = PL_comppad
a062e10d 371#define CX_CURPAD_SV(block,po) (AvARRAY(MUTABLE_AV(((block).oldcomppad)))[po])
dd2155a4
DM
372
373
374/*
375=for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po
376Return the flags for the current compiling pad name
154e47c8 377at offset C<po>. Assumes a valid slot entry.
dd2155a4
DM
378
379=for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po
380Return the name of the current compiling pad name
154e47c8 381at offset C<po>. Assumes a valid slot entry.
dd2155a4
DM
382
383=for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po
384Return the type (stash) of the current compiling pad name at offset
154e47c8 385C<po>. Must be a valid name. Returns null if not typed.
dd2155a4
DM
386
387=for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po
388Return the stash associated with an C<our> variable.
389Assumes the slot entry is a valid C<our> lexical.
390
391=for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
392The generation number of the name at offset C<po> in the current
154e47c8 393compiling pad (lvalue). Note that C<SvUVX> is hijacked for this purpose.
dd2155a4 394
b162af07
SP
395=for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen
396Sets the generation number of the name at offset C<po> in the current
931b58fb 397ling pad (lvalue) to C<gen>. Note that C<SvUV_set> is hijacked for this purpose.
b162af07 398
dd2155a4 399=cut
b162af07 400
dd2155a4
DM
401*/
402
35e035cc 403#define PAD_COMPNAME(po) PAD_COMPNAME_SV(po)
3769e90d 404#define PAD_COMPNAME_SV(po) (AvARRAY(PL_comppad_name)[(po)])
f8503592 405#define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po))
1979170b 406#define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po))
f8503592 407#define PAD_COMPNAME_PV(po) SvPV_nolen(PAD_COMPNAME_SV(po))
dd2155a4 408
b21dc031 409#define PAD_COMPNAME_TYPE(po) pad_compname_type(po)
dd2155a4
DM
410
411#define PAD_COMPNAME_OURSTASH(po) \
73d95100 412 (SvOURSTASH(PAD_COMPNAME_SV(po)))
dd2155a4 413
931b58fb 414#define PAD_COMPNAME_GEN(po) ((STRLEN)SvUVX(AvARRAY(PL_comppad_name)[po]))
dd2155a4 415
931b58fb 416#define PAD_COMPNAME_GEN_set(po, gen) SvUV_set(AvARRAY(PL_comppad_name)[po], (UV)(gen))
dd2155a4
DM
417
418
419/*
d77cdebf 420=for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param
dd2155a4
DM
421Clone the state variables associated with running and compiling pads.
422
423=cut
424*/
425
c5ab0850
DM
426/* NB - we set PL_comppad to null unless it points at a value that
427 * has already been dup'ed, ie it points to part of an active padlist.
428 * Otherwise PL_comppad ends up being a leaked scalar in code like
429 * the following:
430 * threads->create(sub { threads->create(sub {...} ) } );
431 * where the second thread dups the outer sub's comppad but not the
432 * sub's CV or padlist. */
f3548bdc 433
dd2155a4 434#define PAD_CLONE_VARS(proto_perl, param) \
253649d9 435 PL_comppad = av_dup(proto_perl->Icomppad, param); \
4608196e 436 PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \
dd2155a4
DM
437 PL_comppad_name = av_dup(proto_perl->Icomppad_name, param); \
438 PL_comppad_name_fill = proto_perl->Icomppad_name_fill; \
439 PL_comppad_name_floor = proto_perl->Icomppad_name_floor; \
dd2155a4
DM
440 PL_min_intro_pending = proto_perl->Imin_intro_pending; \
441 PL_max_intro_pending = proto_perl->Imax_intro_pending; \
442 PL_padix = proto_perl->Ipadix; \
443 PL_padix_floor = proto_perl->Ipadix_floor; \
444 PL_pad_reset_pending = proto_perl->Ipad_reset_pending; \
445 PL_cop_seqmax = proto_perl->Icop_seqmax;
e9a8c099
MHM
446
447/*
cc76b5cc
Z
448=for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash
449
450Exactly like L</pad_add_name_pvn>, but takes a literal string instead
451of a string/length pair.
452
453=cut
454*/
455
456#define pad_add_name_pvs(name,flags,typestash,ourstash) \
457 Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash)
458
459/*
460=for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags
461
462Exactly like L</pad_findmy_pvn>, but takes a literal string instead
463of a string/length pair.
464
465=cut
466*/
467
468#define pad_findmy_pvs(name,flags) \
469 Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags)
470
471/*
e9a8c099
MHM
472 * Local variables:
473 * c-indentation-style: bsd
474 * c-basic-offset: 4
14d04a33 475 * indent-tabs-mode: nil
e9a8c099
MHM
476 * End:
477 *
14d04a33 478 * ex: set ts=8 sts=4 sw=4 et:
e9a8c099 479 */