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