[p5sagit/p5-mst-13.2.git] / pad.h

/*    pad.h
 *
 *    Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008 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.
 */


/* a padlist is currently just an AV; but that might change,
 * so hide the type. Ditto a pad.  */

typedef AV PADLIST;
typedef AV PAD;


/* 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)

/* 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;

#ifdef PERL_CORE

/* flags for pad_add_name. SVf_UTF8 will also be valid in the future.  */

#  define padadd_OUR		0x01	/* our declaration. */
#  define padadd_STATE		0x02	/* state declaration. */
#  define padadd_NO_DUP_CHECK	0x04	/* skip warning on dups. */

#endif

/* 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 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
*/

#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) \
	(AvARRAY(padlist)[1]) 	\
	? AvARRAY(MUTABLE_AV((AvARRAY(padlist)[1])))[po] : NULL;


#define PAD_SET_CUR_NOSAVE(padlist,nth) \
	PL_comppad = (PAD*) (AvARRAY(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) \
	PL_comppad = opad && SvIS_FREED(opad) ? NULL : 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_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_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_DUP|PADLIST dstpad|PADLIST srcpad|CLONE_PARAMS* param
Clone a padlist.

=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
 * 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 = MUTABLE_AV(ptr_table_fetch(PL_ptr_table, proto_perl->Icomppad)); \
    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;

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