[perl5.git] / pad.h

/*    pad.h
 *
 *    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.
 *
 * This file defines the types and macros associated with the API for
 * manipulating scratchpads, which are used by perl to store lexical
 * variables, op targets and constants.
 */

/*
=head1 Pad Data Structures
*/


/* offsets within a pad */

#if PTRSIZE == 4
typedef U32TYPE PADOFFSET;
#else
#   if PTRSIZE == 8
typedef U64TYPE PADOFFSET;
#   endif
#endif
#define NOT_IN_PAD ((PADOFFSET) -1)


struct padlist {
    SSize_t	xpadl_max;	/* max index for which array has space */
    PAD **	xpadl_alloc;	/* pointer to beginning of array of AVs */
    U32		xpadl_id;	/* Semi-unique ID, shared between clones */
    U32		xpadl_outid;	/* ID of outer pad */
};


/* 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)						\
	(({ 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)					\
	(({ 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)						\
	(({ 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)					\
	(({ 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)		\
	(0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
#  define COP_SEQ_RANGE_HIGH(sv)	\
	(0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))


#  define PARENT_PAD_INDEX(sv)		\
	(0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xlow))
#  define PARENT_FAKELEX_FLAGS(sv)	\
	(0 + (((XPVNV*) SvANY(sv))->xnv_u.xpad_cop_seq.xhigh))
#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 */

/* flags for the pad_new() function */

#define padnew_CLONE	1	/* this pad is for a cloned CV */
#define padnew_SAVE	2	/* save old globals */
#define padnew_SAVESUB	4	/* also save extra stuff for start of sub */

/* values for the pad_tidy() function */

typedef enum {
	padtidy_SUB,		/* tidy up a pad for a sub, */
	padtidy_SUBCLONE,	/* a cloned sub, */
	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 */

#ifndef PERL_MAD
#  define pad_peg(label)
#endif

#ifdef DEBUGGING
#  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"]",\
	    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"]",\
	    label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
#else
#  define ASSERT_CURPAD_LEGAL(label)
#  define ASSERT_CURPAD_ACTIVE(label)
#endif


/* Note: the following three macros are actually defined in scope.h, but
 * they are documented here for completeness, since they directly or
 * indirectly affect pads.

=for apidoc m|void|SAVEPADSV	|PADOFFSET po
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')

=for apidoc m|void|SAVECOMPPAD
save PL_comppad and PL_curpad


=for apidoc Amx|PAD **|PADLIST_ARRAY|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|PADLIST_MAX|PADLIST padlist
The index of the last pad in the padlist.

=for apidoc Amx|PADNAMELIST *|PADLIST_NAMES|PADLIST padlist
The names associated with pad entries.

=for apidoc Amx|PADNAME **|PADLIST_NAMESARRAY|PADLIST padlist
The C array of pad names.

=for apidoc Amx|SSize_t|PADLIST_NAMESMAX|PADLIST padlist
The index of the last pad name.

=for apidoc Amx|U32|PADLIST_REFCNT|PADLIST padlist
The reference count of the padlist.  Currently this is always 1.

=for apidoc Amx|PADNAME **|PADNAMELIST_ARRAY|PADNAMELIST pnl
The C array of pad names.

=for apidoc Amx|SSize_t|PADNAMELIST_MAX|PADNAMELIST pnl
The index of the last pad name.

=for apidoc Amx|SV **|PAD_ARRAY|PAD pad
The C array of pad entries.

=for apidoc Amx|SSize_t|PAD_MAX|PAD pad
The index of the last pad entry.

=for apidoc Amx|char *|PADNAME_PV|PADNAME pn	
The name stored in the pad name struct.

=for apidoc Amx|STRLEN|PADNAME_LEN|PADNAME pn	
The length of the name.

=for apidoc Amx|bool|PADNAME_UTF8|PADNAME pn
Whether PADNAME_PV is in UTF8.

=for apidoc m|bool|PADNAME_isOUR|PADNAME pn
Whether this is an "our" variable.

=for apidoc m|HV *|PADNAME_OURSTASH
The stash in which this "our" variable was declared.

=for apidoc m|HV *|PADNAME_TYPE|PADNAME pn
The stash associated with a typed lexical.  This returns the %Foo:: hash
for C<my Foo $bar>.


=for apidoc m|SV *|PAD_SETSV	|PADOFFSET po|SV* sv
Set the slot at offset C<po> in the current pad to C<sv>

=for apidoc m|void|PAD_SV	|PADOFFSET po
Get the value at offset C<po> in the current pad

=for apidoc m|SV *|PAD_SVl	|PADOFFSET po
Lightweight and lvalue version of C<PAD_SV>.
Get or set the value at offset C<po> in the current pad.
Unlike C<PAD_SV>, does not print diagnostics with -DX.
For internal use only.

=for apidoc m|SV *|PAD_BASE_SV	|PADLIST padlist|PADOFFSET po
Get the value from slot C<po> 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<n> in the padlist, saving
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();
    PAD_SET_CUR_NOSAVE(padlist,n);


=for apidoc m|void|PAD_SET_CUR_NOSAVE	|PADLIST padlist|I32 n
like PAD_SET_CUR, but without the save

=for apidoc m|void|PAD_SAVE_SETNULLPAD
Save the current pad then set it to null.

=for apidoc m|void|PAD_SAVE_LOCAL|PAD *opad|PAD *npad
Save the current pad to the local variable opad, then make the
current pad equal to npad

=for apidoc m|void|PAD_RESTORE_LOCAL|PAD *opad
Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()

=cut
*/

#define PADLIST_ARRAY(pl)	(pl)->xpadl_alloc
#define PADLIST_MAX(pl)		(pl)->xpadl_max
#define PADLIST_NAMES(pl)	(*PADLIST_ARRAY(pl))
#define PADLIST_NAMESARRAY(pl)	PADNAMELIST_ARRAY(PADLIST_NAMES(pl))
#define PADLIST_NAMESMAX(pl)	PADNAMELIST_MAX(PADLIST_NAMES(pl))
#define PADLIST_REFCNT(pl)	1	/* reserved for future use */

#define PADNAMELIST_ARRAY(pnl)	AvARRAY(pnl)
#define PADNAMELIST_MAX(pnl)	AvFILLp(pnl)

#define PAD_ARRAY(pad)		AvARRAY(pad)
#define PAD_MAX(pad)		AvFILLp(pad)

#define PADNAME_PV(pn)		SvPV_nolen(pn)
#define PADNAME_LEN(pn)		SvCUR(pn)
#define PADNAME_UTF8(pn)	!!SvUTF8(pn)
#define PADNAME_isOUR(pn)	!!SvPAD_OUR(pn)
#define PADNAME_OURSTASH	SvOURSTASH(pn)
#define PADNAME_TYPE(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)
#else
#  define PAD_SV(po)       (PL_curpad[po])
#  define PAD_SETSV(po,sv) PL_curpad[po] = (sv)
#endif

#define PAD_SVl(po)       (PL_curpad[po])

#define PAD_BASE_SV(padlist, po) \
	(PADLIST_ARRAY(padlist)[1])					\
	    ? AvARRAY(MUTABLE_AV((PADLIST_ARRAY(padlist)[1])))[po] \
	    : NULL;


#define PAD_SET_CUR_NOSAVE(padlist,nth) \
	PL_comppad = (PAD*) (PADLIST_ARRAY(padlist)[nth]);	\
	PL_curpad = AvARRAY(PL_comppad);			\
	DEBUG_Xv(PerlIO_printf(Perl_debug_log,			\
	      "Pad 0x%"UVxf"[0x%"UVxf"] set_cur    depth=%d\n",	\
	      PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth)));


#define PAD_SET_CUR(padlist,nth) \
	SAVECOMPPAD();						\
	PAD_SET_CUR_NOSAVE(padlist,nth);


#define PAD_SAVE_SETNULLPAD()	SAVECOMPPAD(); \
	PL_comppad = NULL; PL_curpad = NULL;	\
	DEBUG_Xv(PerlIO_printf(Perl_debug_log, "Pad set_null\n"));

#define PAD_SAVE_LOCAL(opad,npad) \
	opad = PL_comppad;					\
	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",		\
	      PTR2UV(PL_comppad), PTR2UV(PL_curpad)));

#define PAD_RESTORE_LOCAL(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",	\
	      PTR2UV(PL_comppad), PTR2UV(PL_curpad)));


/*
=for apidoc m|void|CX_CURPAD_SAVE|struct context
Save the current pad in the given context block structure.

=for apidoc m|SV *|CX_CURPAD_SV|struct context|PADOFFSET po
Access the SV at offset po in the saved current pad in the given
context block structure (can be used as an lvalue).

=cut
*/

#define CX_CURPAD_SAVE(block)  (block).oldcomppad = PL_comppad
#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<po>. 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<po>. 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<po>. 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<our> variable.
Assumes the slot entry is a valid C<our> lexical.

=for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
The generation number of the name at offset C<po> in the current
compiling pad (lvalue). Note that C<SvUVX> 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<po> in the current
ling pad (lvalue) to C<gen>.  Note that C<SvUV_set> is hijacked for this purpose.

=cut

*/

#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) 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) \
    (SvOURSTASH(PAD_COMPNAME_SV(po)))

#define PAD_COMPNAME_GEN(po) ((STRLEN)SvUVX(AvARRAY(PL_comppad_name)[po]))

#define PAD_COMPNAME_GEN_set(po, gen) SvUV_set(AvARRAY(PL_comppad_name)[po], (UV)(gen))


/*
=for apidoc m|void|PAD_CLONE_VARS|PerlInterpreter *proto_perl|CLONE_PARAMS* param
Clone the state variables associated with running and compiling pads.

=cut
*/

/* 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
 * the following:
 *     threads->create(sub { threads->create(sub {...} ) } );
 * where the second thread dups the outer sub's comppad but not the
 * sub's CV or padlist. */

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