perldelta for 2b42d7ed8
[perl.git] / pad.h
1 /*    pad.h
2  *
3  *    Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008,
4  *    2009, 2010, 2011 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  * 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
14 /*
15 =head1 Pad Data Structures
16 */
17
18
19 /* a padlist is currently just an AV; but that might change,
20  * so hide the type. Ditto a pad.  */
21
22 typedef AV PADLIST;
23 typedef AV PAD;
24
25
26 /* offsets within a pad */
27
28 #if PTRSIZE == 4
29 typedef U32TYPE PADOFFSET;
30 #else
31 #   if PTRSIZE == 8
32 typedef U64TYPE PADOFFSET;
33 #   endif
34 #endif
35 #define NOT_IN_PAD ((PADOFFSET) -1)
36
37 /* a value that PL_cop_seqmax is guaranteed never to be,
38  * flagging that a lexical is being introduced, or has not yet left scope
39  */
40 #define PERL_PADSEQ_INTRO  U32_MAX
41
42
43 /* B.xs needs these for the benefit of B::Deparse */
44 /* Low range end is exclusive (valid from the cop seq after this one) */
45 /* High range end is inclusive (valid up to this cop seq) */
46
47 #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
48 #  define COP_SEQ_RANGE_LOW(sv)                                         \
49         (({ const SV *const _sv_cop_seq_range_low = (const SV *) (sv);  \
50           assert(SvTYPE(_sv_cop_seq_range_low) == SVt_NV                \
51                  || SvTYPE(_sv_cop_seq_range_low) >= SVt_PVNV);         \
52           assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVAV);            \
53           assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVHV);            \
54           assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVCV);            \
55           assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVFM);            \
56           assert(!isGV_with_GP(_sv_cop_seq_range_low));                 \
57           ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_low)))->xnv_u.xpad_cop_seq.xlow; \
58          }))
59 #  define COP_SEQ_RANGE_HIGH(sv)                                        \
60         (({ const SV *const _sv_cop_seq_range_high = (const SV *) (sv); \
61           assert(SvTYPE(_sv_cop_seq_range_high) == SVt_NV               \
62                  || SvTYPE(_sv_cop_seq_range_high) >= SVt_PVNV);        \
63           assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVAV);           \
64           assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVHV);           \
65           assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVCV);           \
66           assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVFM);           \
67           assert(!isGV_with_GP(_sv_cop_seq_range_high));                \
68           ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_high)))->xnv_u.xpad_cop_seq.xhigh; \
69          }))
70 #  define PARENT_PAD_INDEX(sv)                                          \
71         (({ const SV *const _sv_parent_pad_index = (const SV *) (sv);   \
72           assert(SvTYPE(_sv_parent_pad_index) == SVt_NV                 \
73                  || SvTYPE(_sv_parent_pad_index) >= SVt_PVNV);          \
74           assert(SvTYPE(_sv_parent_pad_index) != SVt_PVAV);             \
75           assert(SvTYPE(_sv_parent_pad_index) != SVt_PVHV);             \
76           assert(SvTYPE(_sv_parent_pad_index) != SVt_PVCV);             \
77           assert(SvTYPE(_sv_parent_pad_index) != SVt_PVFM);             \
78           assert(!isGV_with_GP(_sv_parent_pad_index));                  \
79           ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_pad_index)))->xnv_u.xpad_cop_seq.xlow; \
80          }))
81 #  define PARENT_FAKELEX_FLAGS(sv)                                      \
82         (({ const SV *const _sv_parent_fakelex_flags = (const SV *) (sv); \
83           assert(SvTYPE(_sv_parent_fakelex_flags) == SVt_NV             \
84                  || SvTYPE(_sv_parent_fakelex_flags) >= SVt_PVNV);      \
85           assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVAV);         \
86           assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVHV);         \
87           assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVCV);         \
88           assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVFM);         \
89           assert(!isGV_with_GP(_sv_parent_fakelex_flags));              \
90           ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_fakelex_flags)))->xnv_u.xpad_cop_seq.xhigh; \
91          }))
92 #else
93 #  define COP_SEQ_RANGE_LOW(sv)         \
94         (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
95 #  define COP_SEQ_RANGE_HIGH(sv)        \
96         (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
97
98
99 #  define PARENT_PAD_INDEX(sv)          \
100         (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
101 #  define PARENT_FAKELEX_FLAGS(sv)      \
102         (0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
103 #endif
104
105 /* Flags set in the SvIVX field of FAKE namesvs */
106
107 #define PAD_FAKELEX_ANON   1 /* the lex is declared in an ANON, or ... */
108 #define PAD_FAKELEX_MULTI  2 /* the lex can be instantiated multiple times */
109
110 /* flags for the pad_new() function */
111
112 #define padnew_CLONE    1       /* this pad is for a cloned CV */
113 #define padnew_SAVE     2       /* save old globals */
114 #define padnew_SAVESUB  4       /* also save extra stuff for start of sub */
115
116 /* values for the pad_tidy() function */
117
118 typedef enum {
119         padtidy_SUB,            /* tidy up a pad for a sub, */
120         padtidy_SUBCLONE,       /* a cloned sub, */
121         padtidy_FORMAT          /* or a format */
122 } padtidy_type;
123
124 /* flags for pad_add_name_pvn. */
125
126 #define padadd_OUR              0x01       /* our declaration. */
127 #define padadd_STATE            0x02       /* state declaration. */
128 #define padadd_NO_DUP_CHECK     0x04       /* skip warning on dups. */
129 #define padadd_UTF8_NAME        SVf_UTF8   /* name is UTF-8 encoded. */
130
131 /* ASSERT_CURPAD_LEGAL and ASSERT_CURPAD_ACTIVE respectively determine
132  * whether PL_comppad and PL_curpad are consistent and whether they have
133  * active values */
134
135 #ifndef PERL_MAD
136 #  define pad_peg(label)
137 #endif
138
139 #ifdef DEBUGGING
140 #  define ASSERT_CURPAD_LEGAL(label) \
141     pad_peg(label); \
142     if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0))  \
143         Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%"UVxf"[0x%"UVxf"]",\
144             label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
145
146
147 #  define ASSERT_CURPAD_ACTIVE(label) \
148     pad_peg(label); \
149     if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad))                \
150         Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%"UVxf"[0x%"UVxf"]",\
151             label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
152 #else
153 #  define ASSERT_CURPAD_LEGAL(label)
154 #  define ASSERT_CURPAD_ACTIVE(label)
155 #endif
156
157
158
159 /* Note: the following three macros are actually defined in scope.h, but
160  * they are documented here for completeness, since they directly or
161  * indirectly affect pads.
162
163 =for apidoc m|void|SAVEPADSV    |PADOFFSET po
164 Save a pad slot (used to restore after an iteration)
165
166 XXX DAPM it would make more sense to make the arg a PADOFFSET
167 =for apidoc m|void|SAVECLEARSV  |SV **svp
168 Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my')
169
170 =for apidoc m|void|SAVECOMPPAD
171 save PL_comppad and PL_curpad
172
173
174
175
176
177 =for apidoc m|SV *|PAD_SETSV    |PADOFFSET po|SV* sv
178 Set the slot at offset C<po> in the current pad to C<sv>
179
180 =for apidoc m|void|PAD_SV       |PADOFFSET po
181 Get the value at offset C<po> in the current pad
182
183 =for apidoc m|SV *|PAD_SVl      |PADOFFSET po
184 Lightweight and lvalue version of C<PAD_SV>.
185 Get or set the value at offset C<po> in the current pad.
186 Unlike C<PAD_SV>, does not print diagnostics with -DX.
187 For internal use only.
188
189 =for apidoc m|SV *|PAD_BASE_SV  |PADLIST padlist|PADOFFSET po
190 Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
191
192 =for apidoc m|void|PAD_SET_CUR  |PADLIST padlist|I32 n
193 Set the current pad to be pad C<n> in the padlist, saving
194 the previous current pad. NB currently this macro expands to a string too
195 long for some compilers, so it's best to replace it with
196
197     SAVECOMPPAD();
198     PAD_SET_CUR_NOSAVE(padlist,n);
199
200
201 =for apidoc m|void|PAD_SET_CUR_NOSAVE   |PADLIST padlist|I32 n
202 like PAD_SET_CUR, but without the save
203
204 =for apidoc m|void|PAD_SAVE_SETNULLPAD
205 Save the current pad then set it to null.
206
207 =for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad
208 Save the current pad to the local variable opad, then make the
209 current pad equal to npad
210
211 =for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad
212 Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
213
214 =cut
215 */
216
217 #ifdef DEBUGGING
218 #  define PAD_SV(po)       pad_sv(po)
219 #  define PAD_SETSV(po,sv) pad_setsv(po,sv)
220 #else
221 #  define PAD_SV(po)       (PL_curpad[po])
222 #  define PAD_SETSV(po,sv) PL_curpad[po] = (sv)
223 #endif
224
225 #define PAD_SVl(po)       (PL_curpad[po])
226
227 #define PAD_BASE_SV(padlist, po) \
228         (AvARRAY(padlist)[1])   \
229         ? AvARRAY(MUTABLE_AV((AvARRAY(padlist)[1])))[po] : NULL;
230
231
232 #define PAD_SET_CUR_NOSAVE(padlist,nth) \
233         PL_comppad = (PAD*) (AvARRAY(padlist)[nth]);            \
234         PL_curpad = AvARRAY(PL_comppad);                        \
235         DEBUG_Xv(PerlIO_printf(Perl_debug_log,                  \
236               "Pad 0x%"UVxf"[0x%"UVxf"] set_cur    depth=%d\n", \
237               PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth)));
238
239
240 #define PAD_SET_CUR(padlist,nth) \
241         SAVECOMPPAD();                                          \
242         PAD_SET_CUR_NOSAVE(padlist,nth);
243
244
245 #define PAD_SAVE_SETNULLPAD()   SAVECOMPPAD(); \
246         PL_comppad = NULL; PL_curpad = NULL;    \
247         DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad set_null\n"));
248
249 #define PAD_SAVE_LOCAL(opad,npad) \
250         opad = PL_comppad;                                      \
251         PL_comppad = (npad);                                    \
252         PL_curpad =  PL_comppad ? AvARRAY(PL_comppad) : NULL;   \
253         DEBUG_Xv(PerlIO_printf(Perl_debug_log,                  \
254               "Pad 0x%"UVxf"[0x%"UVxf"] save_local\n",          \
255               PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
256
257 #define PAD_RESTORE_LOCAL(opad) \
258         assert(!opad || !SvIS_FREED(opad));                                     \
259         PL_comppad = opad;                                              \
260         PL_curpad =  PL_comppad ? AvARRAY(PL_comppad) : NULL;   \
261         DEBUG_Xv(PerlIO_printf(Perl_debug_log,                  \
262               "Pad 0x%"UVxf"[0x%"UVxf"] restore_local\n",       \
263               PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
264
265
266 /*
267 =for apidoc m|void|CX_CURPAD_SAVE|struct context
268 Save the current pad in the given context block structure.
269
270 =for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po
271 Access the SV at offset po in the saved current pad in the given
272 context block structure (can be used as an lvalue).
273
274 =cut
275 */
276
277 #define CX_CURPAD_SAVE(block)  (block).oldcomppad = PL_comppad
278 #define CX_CURPAD_SV(block,po) (AvARRAY(MUTABLE_AV(((block).oldcomppad)))[po])
279
280
281 /*
282 =for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po
283 Return the flags for the current compiling pad name
284 at offset C<po>. Assumes a valid slot entry.
285
286 =for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po
287 Return the name of the current compiling pad name
288 at offset C<po>. Assumes a valid slot entry.
289
290 =for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po
291 Return the type (stash) of the current compiling pad name at offset
292 C<po>. Must be a valid name. Returns null if not typed.
293
294 =for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po
295 Return the stash associated with an C<our> variable.
296 Assumes the slot entry is a valid C<our> lexical.
297
298 =for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
299 The generation number of the name at offset C<po> in the current
300 compiling pad (lvalue). Note that C<SvUVX> is hijacked for this purpose.
301
302 =for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen
303 Sets the generation number of the name at offset C<po> in the current
304 ling pad (lvalue) to C<gen>.  Note that C<SvUV_set> is hijacked for this purpose.
305
306 =cut
307
308 */
309
310 #define PAD_COMPNAME_SV(po) (*av_fetch(PL_comppad_name, (po), FALSE))
311 #define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po))
312 #define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po))
313 #define PAD_COMPNAME_PV(po) SvPV_nolen(PAD_COMPNAME_SV(po))
314
315 #define PAD_COMPNAME_TYPE(po) pad_compname_type(po)
316
317 #define PAD_COMPNAME_OURSTASH(po) \
318     (SvOURSTASH(PAD_COMPNAME_SV(po)))
319
320 #define PAD_COMPNAME_GEN(po) ((STRLEN)SvUVX(AvARRAY(PL_comppad_name)[po]))
321
322 #define PAD_COMPNAME_GEN_set(po, gen) SvUV_set(AvARRAY(PL_comppad_name)[po], (UV)(gen))
323
324
325 /*
326 =for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param
327 Clone the state variables associated with running and compiling pads.
328
329 =cut
330 */
331
332 /* NB - we set PL_comppad to null unless it points at a value that
333  * has already been dup'ed, ie it points to part of an active padlist.
334  * Otherwise PL_comppad ends up being a leaked scalar in code like
335  * the following:
336  *     threads->create(sub { threads->create(sub {...} ) } );
337  * where the second thread dups the outer sub's comppad but not the
338  * sub's CV or padlist. */
339
340 #define PAD_CLONE_VARS(proto_perl, param)                               \
341     PL_comppad                  = av_dup(proto_perl->Icomppad, param);  \
342     PL_curpad = PL_comppad ?  AvARRAY(PL_comppad) : NULL;               \
343     PL_comppad_name             = av_dup(proto_perl->Icomppad_name, param); \
344     PL_comppad_name_fill        = proto_perl->Icomppad_name_fill;       \
345     PL_comppad_name_floor       = proto_perl->Icomppad_name_floor;      \
346     PL_min_intro_pending        = proto_perl->Imin_intro_pending;       \
347     PL_max_intro_pending        = proto_perl->Imax_intro_pending;       \
348     PL_padix                    = proto_perl->Ipadix;                   \
349     PL_padix_floor              = proto_perl->Ipadix_floor;             \
350     PL_pad_reset_pending        = proto_perl->Ipad_reset_pending;       \
351     PL_cop_seqmax               = proto_perl->Icop_seqmax;
352
353 /*
354 =for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash
355
356 Exactly like L</pad_add_name_pvn>, but takes a literal string instead
357 of a string/length pair.
358
359 =cut
360 */
361
362 #define pad_add_name_pvs(name,flags,typestash,ourstash) \
363     Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash)
364
365 /*
366 =for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags
367
368 Exactly like L</pad_findmy_pvn>, but takes a literal string instead
369 of a string/length pair.
370
371 =cut
372 */
373
374 #define pad_findmy_pvs(name,flags) \
375     Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags)
376
377 /*
378  * Local variables:
379  * c-indentation-style: bsd
380  * c-basic-offset: 4
381  * indent-tabs-mode: t
382  * End:
383  *
384  * ex: set ts=8 sts=4 sw=4 noet:
385  */