X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/f8503592a22431f4f2362d87270e54bfdb2d3177..00b25eff1415ab27d5829f30fea1fecd57a7934e:/pad.h diff --git a/pad.h b/pad.h index 81a1312..6269bdc 100644 --- a/pad.h +++ b/pad.h @@ -1,6 +1,7 @@ /* pad.h * - * Copyright (C) 2002, 2003, 2005, by Larry Wall and others + * Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008, + * 2009, 2010, 2011 by Larry Wall and others * * You may distribute under the terms of either the GNU General Public * License or the Artistic License, as specified in the README file. @@ -10,14 +11,9 @@ * variables, op targets and constants. */ - - - -/* a padlist is currently just an AV; but that might change, - * so hide the type. Ditto a pad. */ - -typedef AV PADLIST; -typedef AV PAD; +/* +=head1 Pad Data Structures +*/ /* offsets within a pad */ @@ -31,50 +27,68 @@ typedef U64TYPE PADOFFSET; #endif #define NOT_IN_PAD ((PADOFFSET) -1) -/* B.xs needs these for the benefit of B::Deparse */ + +struct padlist { + SSize_t xpadl_max; /* max index for which array has space */ + PAD ** xpadl_alloc; /* pointer to beginning of array of AVs */ + PADNAMELIST*xpadl_outid; /* Padnamelist of outer pad; used as ID */ +}; + + +/* a value that PL_cop_seqmax is guaranteed never to be, + * flagging that a lexical is being introduced, or has not yet left scope + */ +#define PERL_PADSEQ_INTRO U32_MAX + + +/* B.xs needs these for the benefit of B::Deparse */ /* Low range end is exclusive (valid from the cop seq after this one) */ /* High range end is inclusive (valid up to this cop seq) */ #if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN) # define COP_SEQ_RANGE_LOW(sv) \ - (({ SV *const _svi = (SV *) (sv); \ - assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \ - assert(SvTYPE(_svi) != SVt_PVAV); \ - assert(SvTYPE(_svi) != SVt_PVHV); \ - assert(SvTYPE(_svi) != SVt_PVCV); \ - assert(SvTYPE(_svi) != SVt_PVFM); \ - assert(!isGV_with_GP(_svi)); \ - ((XPVNV*) SvANY(_svi))->xnv_u.xpad_cop_seq.xlow; \ + (({ const SV *const _sv_cop_seq_range_low = (const SV *) (sv); \ + assert(SvTYPE(_sv_cop_seq_range_low) == SVt_NV \ + || SvTYPE(_sv_cop_seq_range_low) >= SVt_PVNV); \ + assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVAV); \ + assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVHV); \ + assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVCV); \ + assert(SvTYPE(_sv_cop_seq_range_low) != SVt_PVFM); \ + assert(!isGV_with_GP(_sv_cop_seq_range_low)); \ + ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_low)))->xnv_u.xpad_cop_seq.xlow; \ })) # define COP_SEQ_RANGE_HIGH(sv) \ - (({ SV *const _svi = (SV *) (sv); \ - assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \ - assert(SvTYPE(_svi) != SVt_PVAV); \ - assert(SvTYPE(_svi) != SVt_PVHV); \ - assert(SvTYPE(_svi) != SVt_PVCV); \ - assert(SvTYPE(_svi) != SVt_PVFM); \ - assert(!isGV_with_GP(_svi)); \ - ((XPVNV*) SvANY(_svi))->xnv_u.xpad_cop_seq.xhigh; \ + (({ const SV *const _sv_cop_seq_range_high = (const SV *) (sv); \ + assert(SvTYPE(_sv_cop_seq_range_high) == SVt_NV \ + || SvTYPE(_sv_cop_seq_range_high) >= SVt_PVNV); \ + assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVAV); \ + assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVHV); \ + assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVCV); \ + assert(SvTYPE(_sv_cop_seq_range_high) != SVt_PVFM); \ + assert(!isGV_with_GP(_sv_cop_seq_range_high)); \ + ((XPVNV*) MUTABLE_PTR(SvANY(_sv_cop_seq_range_high)))->xnv_u.xpad_cop_seq.xhigh; \ })) # define PARENT_PAD_INDEX(sv) \ - (({ SV *const _svi = (SV *) (sv); \ - assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \ - assert(SvTYPE(_svi) != SVt_PVAV); \ - assert(SvTYPE(_svi) != SVt_PVHV); \ - assert(SvTYPE(_svi) != SVt_PVCV); \ - assert(SvTYPE(_svi) != SVt_PVFM); \ - assert(!isGV_with_GP(_svi)); \ - ((XPVNV*) SvANY(_svi))->xnv_u.xpad_cop_seq.xlow; \ + (({ const SV *const _sv_parent_pad_index = (const SV *) (sv); \ + assert(SvTYPE(_sv_parent_pad_index) == SVt_NV \ + || SvTYPE(_sv_parent_pad_index) >= SVt_PVNV); \ + assert(SvTYPE(_sv_parent_pad_index) != SVt_PVAV); \ + assert(SvTYPE(_sv_parent_pad_index) != SVt_PVHV); \ + assert(SvTYPE(_sv_parent_pad_index) != SVt_PVCV); \ + assert(SvTYPE(_sv_parent_pad_index) != SVt_PVFM); \ + assert(!isGV_with_GP(_sv_parent_pad_index)); \ + ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_pad_index)))->xnv_u.xpad_cop_seq.xlow; \ })) # define PARENT_FAKELEX_FLAGS(sv) \ - (({ SV *const _svi = (SV *) (sv); \ - assert(SvTYPE(_svi) == SVt_NV || SvTYPE(_svi) >= SVt_PVNV); \ - assert(SvTYPE(_svi) != SVt_PVAV); \ - assert(SvTYPE(_svi) != SVt_PVHV); \ - assert(SvTYPE(_svi) != SVt_PVCV); \ - assert(SvTYPE(_svi) != SVt_PVFM); \ - assert(!isGV_with_GP(_svi)); \ - ((XPVNV*) SvANY(_svi))->xnv_u.xpad_cop_seq.xhigh; \ + (({ const SV *const _sv_parent_fakelex_flags = (const SV *) (sv); \ + assert(SvTYPE(_sv_parent_fakelex_flags) == SVt_NV \ + || SvTYPE(_sv_parent_fakelex_flags) >= SVt_PVNV); \ + assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVAV); \ + assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVHV); \ + assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVCV); \ + assert(SvTYPE(_sv_parent_fakelex_flags) != SVt_PVFM); \ + assert(!isGV_with_GP(_sv_parent_fakelex_flags)); \ + ((XPVNV*) MUTABLE_PTR(SvANY(_sv_parent_fakelex_flags)))->xnv_u.xpad_cop_seq.xhigh; \ })) #else # define COP_SEQ_RANGE_LOW(sv) \ @@ -90,7 +104,7 @@ typedef U64TYPE PADOFFSET; #endif /* Flags set in the SvIVX field of FAKE namesvs */ - + #define PAD_FAKELEX_ANON 1 /* the lex is declared in an ANON, or ... */ #define PAD_FAKELEX_MULTI 2 /* the lex can be instantiated multiple times */ @@ -108,6 +122,15 @@ typedef enum { padtidy_FORMAT /* or a format */ } padtidy_type; +/* flags for pad_add_name_pvn. */ + +#define padadd_OUR 0x01 /* our declaration. */ +#define padadd_STATE 0x02 /* state declaration. */ +#define padadd_NO_DUP_CHECK 0x04 /* skip warning on dups. */ +#define padadd_STALEOK 0x08 /* allow stale lexical in active + * sub, but only one level up */ +#define padadd_UTF8_NAME SVf_UTF8 /* name is UTF-8 encoded. */ + /* ASSERT_CURPAD_LEGAL and ASSERT_CURPAD_ACTIVE respectively determine * whether PL_comppad and PL_curpad are consistent and whether they have * active values */ @@ -120,14 +143,14 @@ typedef enum { # define ASSERT_CURPAD_LEGAL(label) \ pad_peg(label); \ if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0)) \ - Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%"UVxf"[0x%"UVxf"]",\ + Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%" UVxf "[0x%" UVxf "]",\ label, PTR2UV(PL_comppad), PTR2UV(PL_curpad)); # define ASSERT_CURPAD_ACTIVE(label) \ pad_peg(label); \ if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad)) \ - Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%"UVxf"[0x%"UVxf"]",\ + Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%" UVxf "[0x%" UVxf "]",\ label, PTR2UV(PL_comppad), PTR2UV(PL_curpad)); #else # define ASSERT_CURPAD_LEGAL(label) @@ -145,13 +168,75 @@ Save a pad slot (used to restore after an iteration) XXX DAPM it would make more sense to make the arg a PADOFFSET =for apidoc m|void|SAVECLEARSV |SV **svp -Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my') +Clear the pointed to pad value on scope exit. (i.e. the runtime action of +'my') =for apidoc m|void|SAVECOMPPAD save PL_comppad and PL_curpad +=for apidoc Amx|PAD **|PadlistARRAY|PADLIST padlist +The C array of a padlist, containing the pads. Only subscript it with +numbers >= 1, as the 0th entry is not guaranteed to remain usable. + +=for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist +The index of the last allocated space in the padlist. Note that the last +pad may be in an earlier slot. Any entries following it will be NULL in +that case. + +=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist +The names associated with pad entries. + +=for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST padlist +The C array of pad names. + +=for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST padlist +The index of the last pad name. + +=for apidoc Amx|U32|PadlistREFCNT|PADLIST padlist +The reference count of the padlist. Currently this is always 1. + +=for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST pnl +The C array of pad names. + +=for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST pnl +The index of the last pad name. + +=for apidoc Amx|SV **|PadARRAY|PAD pad +The C array of pad entries. + +=for apidoc Amx|SSize_t|PadMAX|PAD pad +The index of the last pad entry. + +=for apidoc Amx|char *|PadnamePV|PADNAME pn +The name stored in the pad name struct. This returns NULL for a target or +GV slot. + +=for apidoc Amx|STRLEN|PadnameLEN|PADNAME pn +The length of the name. + +=for apidoc Amx|bool|PadnameUTF8|PADNAME pn +Whether PadnamePV is in UTF8. + +=for apidoc Amx|SV *|PadnameSV|PADNAME pn +Returns the pad name as an SV. This is currently just C. It will +begin returning a new mortal SV if pad names ever stop being SVs. + +=for apidoc m|bool|PadnameIsOUR|PADNAME pn +Whether this is an "our" variable. + +=for apidoc m|HV *|PadnameOURSTASH +The stash in which this "our" variable was declared. +=for apidoc m|bool|PadnameOUTER|PADNAME pn +Whether this entry belongs to an outer pad. + +=for apidoc m|bool|PadnameIsSTATE|PADNAME pn +Whether this is a "state" variable. + +=for apidoc m|HV *|PadnameTYPE|PADNAME pn +The stash associated with a typed lexical. This returns the %Foo:: hash +for C. =for apidoc m|SV *|PAD_SETSV |PADOFFSET po|SV* sv @@ -171,7 +256,7 @@ Get the value from slot C in the base (DEPTH=1) pad of a padlist =for apidoc m|void|PAD_SET_CUR |PADLIST padlist|I32 n Set the current pad to be pad C in the padlist, saving -the previous current pad. NB currently this macro expands to a string too +the previous current pad. NB currently this macro expands to a string too long for some compilers, so it's best to replace it with SAVECOMPPAD(); @@ -194,6 +279,32 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL() =cut */ +#define PadlistARRAY(pl) (pl)->xpadl_alloc +#define PadlistMAX(pl) (pl)->xpadl_max +#define PadlistNAMES(pl) (*PadlistARRAY(pl)) +#define PadlistNAMESARRAY(pl) PadnamelistARRAY(PadlistNAMES(pl)) +#define PadlistNAMESMAX(pl) PadnamelistMAX(PadlistNAMES(pl)) +#define PadlistREFCNT(pl) 1 /* reserved for future use */ + +#define PadnamelistARRAY(pnl) AvARRAY(pnl) +#define PadnamelistMAX(pnl) AvFILLp(pnl) +#define PadnamelistMAXNAMED(pnl) \ + ((XPVAV*) SvANY(pnl))->xmg_u.xmg_hash_index + +#define PadARRAY(pad) AvARRAY(pad) +#define PadMAX(pad) AvFILLp(pad) + +#define PadnamePV(pn) (SvPOKp(pn) ? SvPVX(pn) : NULL) +#define PadnameLEN(pn) ((pn) == &PL_sv_undef ? 0 : SvCUR(pn)) +#define PadnameUTF8(pn) !!SvUTF8(pn) +#define PadnameSV(pn) pn +#define PadnameIsOUR(pn) !!SvPAD_OUR(pn) +#define PadnameOURSTASH(pn) SvOURSTASH(pn) +#define PadnameOUTER(pn) !!SvFAKE(pn) +#define PadnameIsSTATE(pn) !!SvPAD_STATE(pn) +#define PadnameTYPE(pn) (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL) + + #ifdef DEBUGGING # define PAD_SV(po) pad_sv(po) # define PAD_SETSV(po,sv) pad_setsv(po,sv) @@ -205,15 +316,16 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL() #define PAD_SVl(po) (PL_curpad[po]) #define PAD_BASE_SV(padlist, po) \ - (AvARRAY(padlist)[1]) \ - ? AvARRAY((AV*)(AvARRAY(padlist)[1]))[po] : NULL; - + (PadlistARRAY(padlist)[1]) \ + ? AvARRAY(MUTABLE_AV((PadlistARRAY(padlist)[1])))[po] \ + : NULL; + #define PAD_SET_CUR_NOSAVE(padlist,nth) \ - PL_comppad = (PAD*) (AvARRAY(padlist)[nth]); \ + PL_comppad = (PAD*) (PadlistARRAY(padlist)[nth]); \ PL_curpad = AvARRAY(PL_comppad); \ DEBUG_Xv(PerlIO_printf(Perl_debug_log, \ - "Pad 0x%"UVxf"[0x%"UVxf"] set_cur depth=%d\n", \ + "Pad 0x%" UVxf "[0x%" UVxf "] set_cur depth=%d\n", \ PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth))); @@ -231,14 +343,15 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL() PL_comppad = (npad); \ PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \ DEBUG_Xv(PerlIO_printf(Perl_debug_log, \ - "Pad 0x%"UVxf"[0x%"UVxf"] save_local\n", \ + "Pad 0x%" UVxf "[0x%" UVxf "] save_local\n", \ PTR2UV(PL_comppad), PTR2UV(PL_curpad))); #define PAD_RESTORE_LOCAL(opad) \ - PL_comppad = opad; \ + assert(!opad || !SvIS_FREED(opad)); \ + PL_comppad = opad; \ PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \ DEBUG_Xv(PerlIO_printf(Perl_debug_log, \ - "Pad 0x%"UVxf"[0x%"UVxf"] restore_local\n", \ + "Pad 0x%" UVxf "[0x%" UVxf "] restore_local\n", \ PTR2UV(PL_comppad), PTR2UV(PL_curpad))); @@ -254,21 +367,21 @@ context block structure (can be used as an lvalue). */ #define CX_CURPAD_SAVE(block) (block).oldcomppad = PL_comppad -#define CX_CURPAD_SV(block,po) (AvARRAY((AV*)((block).oldcomppad))[po]) +#define CX_CURPAD_SV(block,po) (AvARRAY(MUTABLE_AV(((block).oldcomppad)))[po]) /* =for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po Return the flags for the current compiling pad name -at offset C. Assumes a valid slot entry. +at offset C. Assumes a valid slot entry. =for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po Return the name of the current compiling pad name -at offset C. Assumes a valid slot entry. +at offset C. Assumes a valid slot entry. =for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po Return the type (stash) of the current compiling pad name at offset -C. Must be a valid name. Returns null if not typed. +C. Must be a valid name. Returns null if not typed. =for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po Return the stash associated with an C variable. @@ -276,7 +389,7 @@ Assumes the slot entry is a valid C lexical. =for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po The generation number of the name at offset C in the current -compiling pad (lvalue). Note that C is hijacked for this purpose. +compiling pad (lvalue). Note that C is hijacked for this purpose. =for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen Sets the generation number of the name at offset C in the current @@ -286,16 +399,16 @@ ling pad (lvalue) to C. Note that C is hijacked for this purpose */ +#define PAD_COMPNAME(po) PAD_COMPNAME_SV(po) #define PAD_COMPNAME_SV(po) (*av_fetch(PL_comppad_name, (po), FALSE)) #define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po)) -#define PAD_COMPNAME_FLAGS_isOUR(po) \ - ((PAD_COMPNAME_FLAGS(po) & (SVpad_NAME|SVpad_OUR)) == (SVpad_NAME|SVpad_OUR)) +#define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po)) #define PAD_COMPNAME_PV(po) SvPV_nolen(PAD_COMPNAME_SV(po)) #define PAD_COMPNAME_TYPE(po) pad_compname_type(po) #define PAD_COMPNAME_OURSTASH(po) \ - (OURSTASH(PAD_COMPNAME_SV(po))) + (SvOURSTASH(PAD_COMPNAME_SV(po))) #define PAD_COMPNAME_GEN(po) ((STRLEN)SvUVX(AvARRAY(PL_comppad_name)[po])) @@ -303,28 +416,12 @@ ling pad (lvalue) to C. Note that C is hijacked for this purpose /* -=for apidoc m|void|PAD_DUP|PADLIST dstpad|PADLIST srcpad|CLONE_PARAMS* param -Clone a padlist. - -=for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl \ -|CLONE_PARAMS* param +=for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param Clone the state variables associated with running and compiling pads. =cut */ - -#define PAD_DUP(dstpad, srcpad, param) \ - if ((srcpad) && !AvREAL(srcpad)) { \ - /* XXX padlists are real, but pretend to be not */ \ - AvREAL_on(srcpad); \ - (dstpad) = av_dup_inc((srcpad), param); \ - AvREAL_off(srcpad); \ - AvREAL_off(dstpad); \ - } \ - else \ - (dstpad) = av_dup_inc((srcpad), param); - /* NB - we set PL_comppad to null unless it points at a value that * has already been dup'ed, ie it points to part of an active padlist. * Otherwise PL_comppad ends up being a leaked scalar in code like @@ -334,7 +431,7 @@ Clone the state variables associated with running and compiling pads. * sub's CV or padlist. */ #define PAD_CLONE_VARS(proto_perl, param) \ - PL_comppad = (AV *) ptr_table_fetch(PL_ptr_table, proto_perl->Icomppad); \ + PL_comppad = av_dup(proto_perl->Icomppad, param); \ PL_curpad = PL_comppad ? AvARRAY(PL_comppad) : NULL; \ PL_comppad_name = av_dup(proto_perl->Icomppad_name, param); \ PL_comppad_name_fill = proto_perl->Icomppad_name_fill; \ @@ -345,3 +442,37 @@ Clone the state variables associated with running and compiling pads. PL_padix_floor = proto_perl->Ipadix_floor; \ PL_pad_reset_pending = proto_perl->Ipad_reset_pending; \ PL_cop_seqmax = proto_perl->Icop_seqmax; + +/* +=for apidoc Am|PADOFFSET|pad_add_name_pvs|const char *name|U32 flags|HV *typestash|HV *ourstash + +Exactly like L, but takes a literal string instead +of a string/length pair. + +=cut +*/ + +#define pad_add_name_pvs(name,flags,typestash,ourstash) \ + Perl_pad_add_name_pvn(aTHX_ STR_WITH_LEN(name), flags, typestash, ourstash) + +/* +=for apidoc Am|PADOFFSET|pad_findmy_pvs|const char *name|U32 flags + +Exactly like L, but takes a literal string instead +of a string/length pair. + +=cut +*/ + +#define pad_findmy_pvs(name,flags) \ + Perl_pad_findmy_pvn(aTHX_ STR_WITH_LEN(name), flags) + +/* + * Local variables: + * c-indentation-style: bsd + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * + * ex: set ts=8 sts=4 sw=4 et: + */