[perl5.git] / pp.h

/*    pp.h
 *
 *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
 *    2000, 2001, 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.
 *
 */

#define PP(s) OP * Perl_##s(pTHX)

/*
=head1 Stack Manipulation Macros

=for apidoc AmU||SP
Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
C<SPAGAIN>.

=for apidoc AmU||MARK
Stack marker variable for the XSUB.  See C<dMARK>.

=for apidoc Am|void|PUSHMARK|SP
Opening bracket for arguments on a callback.  See C<PUTBACK> and
L<perlcall>.

=for apidoc Ams||dSP
Declares a local copy of perl's stack pointer for the XSUB, available via
the C<SP> macro.  See C<SP>.

=for apidoc ms||djSP

Declare Just C<SP>. This is actually identical to C<dSP>, and declares
a local copy of perl's stack pointer, available via the C<SP> macro.
See C<SP>.  (Available for backward source code compatibility with the
old (Perl 5.005) thread model.)

=for apidoc Ams||dMARK
Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
C<dORIGMARK>.

=for apidoc Ams||dORIGMARK
Saves the original stack mark for the XSUB.  See C<ORIGMARK>.

=for apidoc AmU||ORIGMARK
The original stack mark for the XSUB.  See C<dORIGMARK>.

=for apidoc Ams||SPAGAIN
Refetch the stack pointer.  Used after a callback.  See L<perlcall>.

=cut */

#undef SP /* Solaris 2.7 i386 has this in /usr/include/sys/reg.h */
#define SP sp
#define MARK mark
#define TARG targ

#define PUSHMARK(p) if (++PL_markstack_ptr == PL_markstack_max)	\
			markstack_grow();			\
		    *PL_markstack_ptr = (p) - PL_stack_base

#define TOPMARK		(*PL_markstack_ptr)
#define POPMARK		(*PL_markstack_ptr--)

#define dSP		register SV **sp = PL_stack_sp
#define djSP		dSP
#define dMARK		register SV **mark = PL_stack_base + POPMARK
#define dORIGMARK	I32 origmark = mark - PL_stack_base
#define SETORIGMARK	origmark = mark - PL_stack_base
#define ORIGMARK	(PL_stack_base + origmark)

#define SPAGAIN		sp = PL_stack_sp
#define MSPAGAIN	sp = PL_stack_sp; mark = ORIGMARK

#define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
#define dTARGETSTACKED SV * GETTARGETSTACKED

#define GETTARGET targ = PAD_SV(PL_op->op_targ)
#define dTARGET SV * GETTARGET

#define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
#define dATARGET SV * GETATARGET

#define dTARG SV *targ

#define NORMAL PL_op->op_next
#define DIE return Perl_die

/*
=for apidoc Ams||PUTBACK
Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
See C<PUSHMARK> and L<perlcall> for other uses.

=for apidoc Amn|SV*|POPs
Pops an SV off the stack.

=for apidoc Amn|char*|POPp
Pops a string off the stack. Deprecated. New code should provide
a STRLEN n_a and use POPpx.

=for apidoc Amn|char*|POPpx
Pops a string off the stack.
Requires a variable STRLEN n_a in scope.

=for apidoc Amn|char*|POPpbytex
Pops a string off the stack which must consist of bytes i.e. characters < 256.
Requires a variable STRLEN n_a in scope.

=for apidoc Amn|NV|POPn
Pops a double off the stack.

=for apidoc Amn|IV|POPi
Pops an integer off the stack.

=for apidoc Amn|long|POPl
Pops a long off the stack.

=cut
*/

#define PUTBACK		PL_stack_sp = sp
#define RETURN		return PUTBACK, NORMAL
#define RETURNOP(o)	return PUTBACK, o
#define RETURNX(x)	return x, PUTBACK, NORMAL

#define POPs		(*sp--)
#define POPp		(SvPVx(POPs, PL_na))		/* deprecated */
#define POPpx		(SvPVx(POPs, n_a))
#define POPpbytex	(SvPVbytex(POPs, n_a))
#define POPn		(SvNVx(POPs))
#define POPi		((IV)SvIVx(POPs))
#define POPu		((UV)SvUVx(POPs))
#define POPl		((long)SvIVx(POPs))
#define POPul		((unsigned long)SvIVx(POPs))
#ifdef HAS_QUAD
#define POPq		((Quad_t)SvIVx(POPs))
#define POPuq		((Uquad_t)SvUVx(POPs))
#endif

#define TOPs		(*sp)
#define TOPm1s		(*(sp-1))
#define TOPp1s		(*(sp+1))
#define TOPp		(SvPV(TOPs, PL_na))		/* deprecated */
#define TOPpx		(SvPV(TOPs, n_a))
#define TOPn		(SvNV(TOPs))
#define TOPi		((IV)SvIV(TOPs))
#define TOPu		((UV)SvUV(TOPs))
#define TOPl		((long)SvIV(TOPs))
#define TOPul		((unsigned long)SvUV(TOPs))
#ifdef HAS_QUAD
#define TOPq		((Quad_t)SvIV(TOPs))
#define TOPuq		((Uquad_t)SvUV(TOPs))
#endif

/* Go to some pains in the rare event that we must extend the stack. */

/*
=for apidoc Am|void|EXTEND|SP|int nitems
Used to extend the argument stack for an XSUB's return values. Once
used, guarantees that there is room for at least C<nitems> to be pushed
onto the stack.

=for apidoc Am|void|PUSHs|SV* sv
Push an SV onto the stack.  The stack must have room for this element.
Does not handle 'set' magic.  Does not use C<TARG>.  See also C<PUSHmortal>,
C<XPUSHs> and C<XPUSHmortal>.

=for apidoc Am|void|PUSHp|char* str|STRLEN len
Push a string onto the stack.  The stack must have room for this element.
The C<len> indicates the length of the string.  Handles 'set' magic.  Uses
C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it.  Do not
call multiple C<TARG>-oriented macros to return lists from XSUB's - see
C<mPUSHp> instead.  See also C<XPUSHp> and C<mXPUSHp>.

=for apidoc Am|void|PUSHn|NV nv
Push a double onto the stack.  The stack must have room for this element.
Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
called to declare it.  Do not call multiple C<TARG>-oriented macros to
return lists from XSUB's - see C<mPUSHn> instead.  See also C<XPUSHn> and
C<mXPUSHn>.

=for apidoc Am|void|PUSHi|IV iv
Push an integer onto the stack.  The stack must have room for this element.
Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
called to declare it.  Do not call multiple C<TARG>-oriented macros to 
return lists from XSUB's - see C<mPUSHi> instead.  See also C<XPUSHi> and
C<mXPUSHi>.

=for apidoc Am|void|PUSHu|UV uv
Push an unsigned integer onto the stack.  The stack must have room for this
element.  Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
should be called to declare it.  Do not call multiple C<TARG>-oriented
macros to return lists from XSUB's - see C<mPUSHu> instead.  See also
C<XPUSHu> and C<mXPUSHu>.

=for apidoc Am|void|XPUSHs|SV* sv
Push an SV onto the stack, extending the stack if necessary.  Does not
handle 'set' magic.  Does not use C<TARG>.  See also C<XPUSHmortal>,
C<PUSHs> and C<PUSHmortal>.

=for apidoc Am|void|XPUSHp|char* str|STRLEN len
Push a string onto the stack, extending the stack if necessary.  The C<len>
indicates the length of the string.  Handles 'set' magic.  Uses C<TARG>, so
C<dTARGET> or C<dXSTARG> should be called to declare it.  Do not call
multiple C<TARG>-oriented macros to return lists from XSUB's - see
C<mXPUSHp> instead.  See also C<PUSHp> and C<mPUSHp>.

=for apidoc Am|void|XPUSHn|NV nv
Push a double onto the stack, extending the stack if necessary.  Handles
'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
declare it.  Do not call multiple C<TARG>-oriented macros to return lists
from XSUB's - see C<mXPUSHn> instead.  See also C<PUSHn> and C<mPUSHn>.

=for apidoc Am|void|XPUSHi|IV iv
Push an integer onto the stack, extending the stack if necessary.  Handles
'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
declare it.  Do not call multiple C<TARG>-oriented macros to return lists
from XSUB's - see C<mXPUSHi> instead.  See also C<PUSHi> and C<mPUSHi>.

=for apidoc Am|void|XPUSHu|UV uv
Push an unsigned integer onto the stack, extending the stack if necessary.
Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
called to declare it.  Do not call multiple C<TARG>-oriented macros to
return lists from XSUB's - see C<mXPUSHu> instead.  See also C<PUSHu> and
C<mPUSHu>.

=for apidoc Am|void|PUSHmortal
Push a new mortal SV onto the stack.  The stack must have room for this
element.  Does not handle 'set' magic.  Does not use C<TARG>.  See also
C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.

=for apidoc Am|void|mPUSHp|char* str|STRLEN len
Push a string onto the stack.  The stack must have room for this element.
The C<len> indicates the length of the string.  Handles 'set' magic.  Does
not use C<TARG>.  See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.

=for apidoc Am|void|mPUSHn|NV nv
Push a double onto the stack.  The stack must have room for this element.
Handles 'set' magic.  Does not use C<TARG>.  See also C<PUSHn>, C<mXPUSHn>
and C<XPUSHn>.

=for apidoc Am|void|mPUSHi|IV iv
Push an integer onto the stack.  The stack must have room for this element.
Handles 'set' magic.  Does not use C<TARG>.  See also C<PUSHi>, C<mXPUSHi>
and C<XPUSHi>.

=for apidoc Am|void|mPUSHu|UV uv
Push an unsigned integer onto the stack.  The stack must have room for this
element.  Handles 'set' magic.  Does not use C<TARG>.  See also C<PUSHu>,
C<mXPUSHu> and C<XPUSHu>.

=for apidoc Am|void|XPUSHmortal
Push a new mortal SV onto the stack, extending the stack if necessary.  Does
not handle 'set' magic.  Does not use C<TARG>.  See also C<XPUSHs>,
C<PUSHmortal> and C<PUSHs>.

=for apidoc Am|void|mXPUSHp|char* str|STRLEN len
Push a string onto the stack, extending the stack if necessary.  The C<len>
indicates the length of the string.  Handles 'set' magic.  Does not use
C<TARG>.  See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.

=for apidoc Am|void|mXPUSHn|NV nv
Push a double onto the stack, extending the stack if necessary.  Handles
'set' magic.  Does not use C<TARG>.  See also C<XPUSHn>, C<mPUSHn> and
C<PUSHn>.

=for apidoc Am|void|mXPUSHi|IV iv
Push an integer onto the stack, extending the stack if necessary.  Handles
'set' magic.  Does not use C<TARG>.  See also C<XPUSHi>, C<mPUSHi> and
C<PUSHi>.

=for apidoc Am|void|mXPUSHu|UV uv
Push an unsigned integer onto the stack, extending the stack if necessary.
Handles 'set' magic.  Does not use C<TARG>.  See also C<XPUSHu>, C<mPUSHu>
and C<PUSHu>.

=cut
*/

#define EXTEND(p,n)	STMT_START { if (PL_stack_max - p < (int)(n)) {		\
			    sp = stack_grow(sp,p, (int) (n));		\
			} } STMT_END

/* Same thing, but update mark register too. */
#define MEXTEND(p,n)	STMT_START {if (PL_stack_max - p < (int)(n)) {		\
			    int markoff = mark - PL_stack_base;		\
			    sp = stack_grow(sp,p,(int) (n));		\
			    mark = PL_stack_base + markoff;		\
			} } STMT_END

#define PUSHs(s)	(*++sp = (s))
#define PUSHTARG	STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
#define PUSHp(p,l)	STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
#define PUSHn(n)	STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
#define PUSHi(i)	STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
#define PUSHu(u)	STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END

#define XPUSHs(s)	STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
#define XPUSHTARG	STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
#define XPUSHp(p,l)	STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
#define XPUSHn(n)	STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
#define XPUSHi(i)	STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
#define XPUSHu(u)	STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
#define XPUSHundef	STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END

#define PUSHmortal	PUSHs(sv_newmortal())
#define mPUSHp(p,l)	sv_setpvn_mg(PUSHmortal, (p), (l))
#define mPUSHn(n)	sv_setnv_mg(PUSHmortal, (NV)(n))
#define mPUSHi(i)	sv_setiv_mg(PUSHmortal, (IV)(i))
#define mPUSHu(u)	sv_setuv_mg(PUSHmortal, (UV)(u))

#define XPUSHmortal	XPUSHs(sv_newmortal())
#define mXPUSHp(p,l)	STMT_START { EXTEND(sp,1); sv_setpvn_mg(PUSHmortal, (p), (l)); } STMT_END
#define mXPUSHn(n)	STMT_START { EXTEND(sp,1); sv_setnv_mg(PUSHmortal, (NV)(n)); } STMT_END
#define mXPUSHi(i)	STMT_START { EXTEND(sp,1); sv_setiv_mg(PUSHmortal, (IV)(i)); } STMT_END
#define mXPUSHu(u)	STMT_START { EXTEND(sp,1); sv_setuv_mg(PUSHmortal, (UV)(u)); } STMT_END

#define SETs(s)		(*sp = s)
#define SETTARG		STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
#define SETp(p,l)	STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
#define SETn(n)		STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
#define SETi(i)		STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
#define SETu(u)		STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END

#define dTOPss		SV *sv = TOPs
#define dPOPss		SV *sv = POPs
#define dTOPnv		NV value = TOPn
#define dPOPnv		NV value = POPn
#define dTOPiv		IV value = TOPi
#define dPOPiv		IV value = POPi
#define dTOPuv		UV value = TOPu
#define dPOPuv		UV value = POPu
#ifdef HAS_QUAD
#define dTOPqv		Quad_t value = TOPu
#define dPOPqv		Quad_t value = POPu
#define dTOPuqv		Uquad_t value = TOPuq
#define dPOPuqv		Uquad_t value = POPuq
#endif

#define dPOPXssrl(X)	SV *right = POPs; SV *left = CAT2(X,s)
#define dPOPXnnrl(X)	NV right = POPn; NV left = CAT2(X,n)
#define dPOPXiirl(X)	IV right = POPi; IV left = CAT2(X,i)

#define USE_LEFT(sv) \
	(SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
#define dPOPXnnrl_ul(X)	\
    NV right = POPn;				\
    SV *leftsv = CAT2(X,s);				\
    NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
#define dPOPXiirl_ul(X) \
    IV right = POPi;					\
    SV *leftsv = CAT2(X,s);				\
    IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0

#define dPOPPOPssrl	dPOPXssrl(POP)
#define dPOPPOPnnrl	dPOPXnnrl(POP)
#define dPOPPOPnnrl_ul	dPOPXnnrl_ul(POP)
#define dPOPPOPiirl	dPOPXiirl(POP)
#define dPOPPOPiirl_ul	dPOPXiirl_ul(POP)

#define dPOPTOPssrl	dPOPXssrl(TOP)
#define dPOPTOPnnrl	dPOPXnnrl(TOP)
#define dPOPTOPnnrl_ul	dPOPXnnrl_ul(TOP)
#define dPOPTOPiirl	dPOPXiirl(TOP)
#define dPOPTOPiirl_ul	dPOPXiirl_ul(TOP)

#define RETPUSHYES	RETURNX(PUSHs(&PL_sv_yes))
#define RETPUSHNO	RETURNX(PUSHs(&PL_sv_no))
#define RETPUSHUNDEF	RETURNX(PUSHs(&PL_sv_undef))

#define RETSETYES	RETURNX(SETs(&PL_sv_yes))
#define RETSETNO	RETURNX(SETs(&PL_sv_no))
#define RETSETUNDEF	RETURNX(SETs(&PL_sv_undef))

#define ARGTARG		PL_op->op_targ

    /* See OPpTARGET_MY: */
#define MAXARG		(PL_op->op_private & 15)

#define SWITCHSTACK(f,t) \
    STMT_START {							\
	AvFILLp(f) = sp - PL_stack_base;				\
	PL_stack_base = AvARRAY(t);					\
	PL_stack_max = PL_stack_base + AvMAX(t);			\
	sp = PL_stack_sp = PL_stack_base + AvFILLp(t);			\
	PL_curstack = t;						\
    } STMT_END

#define EXTEND_MORTAL(n) \
    STMT_START {							\
	if (PL_tmps_ix + (n) >= PL_tmps_max)				\
	    tmps_grow(n);						\
    } STMT_END

#define AMGf_noright	1
#define AMGf_noleft	2
#define AMGf_assign	4
#define AMGf_unary	8

#define tryAMAGICbinW(meth,assign,set) STMT_START { \
          if (PL_amagic_generation) { \
	    SV* tmpsv; \
	    SV* right= *(sp); SV* left= *(sp-1);\
	    if ((SvAMAGIC(left)||SvAMAGIC(right))&&\
		(tmpsv=amagic_call(left, \
				   right, \
				   CAT2(meth,_amg), \
				   (assign)? AMGf_assign: 0))) {\
	       SPAGAIN;	\
	       (void)POPs; set(tmpsv); RETURN; } \
	  } \
	} STMT_END

#define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
#define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)

#define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef,  \
					CAT2(meth,_amg),AMGf_noright | AMGf_unary)
#define AMG_CALLbinL(left,right,meth) \
            amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)

#define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
          if (PL_amagic_generation) { \
	    SV* tmpsv; \
	    SV* arg= sp[shift]; \
          if(0) goto am_again;  /* shut up unused warning */ \
	  am_again: \
	    if ((SvAMAGIC(arg))&&\
		(tmpsv=AMG_CALLun(arg,meth))) {\
	       SPAGAIN; if (shift) sp += shift; \
	       set(tmpsv); ret; } \
	  } \
	} STMT_END

#define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END

#define tryAMAGICun(meth)	tryAMAGICunW(meth,SETsvUN,0,RETURN)
#define tryAMAGICunSET(meth)	tryAMAGICunW(meth,SETs,0,RETURN)
#define tryAMAGICunTARGET(meth, shift)					\
	{ dSP; sp--; 	/* get TARGET from below PL_stack_sp */		\
	    { dTARGETSTACKED; 						\
		{ dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}}

#define setAGAIN(ref) sv = ref;							\
  if (!SvROK(ref))								\
      Perl_croak(aTHX_ "Overloaded dereference did not return a reference");	\
  if (ref != arg && SvRV(ref) != SvRV(arg)) {					\
      arg = ref;								\
      goto am_again;								\
  }

#define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)

#define opASSIGN (PL_op->op_flags & OPf_STACKED)
#define SETsv(sv)	STMT_START {					\
		if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY))		\
		   { sv_setsv(TARG, (sv)); SETTARG; }			\
		else SETs(sv); } STMT_END

#define SETsvUN(sv)	STMT_START {					\
		if (SvFLAGS(TARG) & SVs_PADMY)		\
		   { sv_setsv(TARG, (sv)); SETTARG; }			\
		else SETs(sv); } STMT_END

/* newSVsv does not behave as advertised, so we copy missing
 * information by hand */

/* SV* ref causes confusion with the member variable
   changed SV* ref to SV* tmpRef */
#define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv);      \
  if (SvREFCNT(tmpRef)>1) {                 \
    SvRV(rv)=AMG_CALLun(rv,copy);	\
    SvREFCNT_dec(tmpRef);                   \
  } } STMT_END

/*
=for apidoc mU||LVRET
True if this op will be the return value of an lvalue subroutine

=cut */
#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
Commit	Line	Data
a0d0e21e	1	/* pp.h
79072805	2	*
4bb101f2 JH	3	* Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
4bb101f2 JH	4	* 2000, 2001, by Larry Wall and others
79072805	5	*
a0d0e21e LW	6	* You may distribute under the terms of either the GNU General Public
a0d0e21e LW	7	* License or the Artistic License, as specified in the README file.
79072805	8	*
a0d0e21e	9	*/
79072805	10
cea2e8a9	11	#define PP(s) OP * Perl_##s(pTHX)
79072805	12
954c1994	13	/*
ccfc67b7 JH	14	=head1 Stack Manipulation Macros
ccfc67b7 JH	15
954c1994 GS	16	=for apidoc AmU\|\|SP
	17	Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
	18	C<SPAGAIN>.
	19
	20	=for apidoc AmU\|\|MARK
	21	Stack marker variable for the XSUB. See C<dMARK>.
	22
c578083c	23	=for apidoc Am\|void\|PUSHMARK\|SP
954c1994 GS	24	Opening bracket for arguments on a callback. See C<PUTBACK> and
	25	L<perlcall>.
	26
	27	=for apidoc Ams\|\|dSP
	28	Declares a local copy of perl's stack pointer for the XSUB, available via
	29	the C<SP> macro. See C<SP>.
	30
fac3506f MS	31	=for apidoc ms\|\|djSP
	32
	33	Declare Just C<SP>. This is actually identical to C<dSP>, and declares
	34	a local copy of perl's stack pointer, available via the C<SP> macro.
	35	See C<SP>. (Available for backward source code compatibility with the
	36	old (Perl 5.005) thread model.)
	37
954c1994 GS	38	=for apidoc Ams\|\|dMARK
	39	Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
	40	C<dORIGMARK>.
	41
	42	=for apidoc Ams\|\|dORIGMARK
	43	Saves the original stack mark for the XSUB. See C<ORIGMARK>.
	44
	45	=for apidoc AmU\|\|ORIGMARK
	46	The original stack mark for the XSUB. See C<dORIGMARK>.
	47
	48	=for apidoc Ams\|\|SPAGAIN
	49	Refetch the stack pointer. Used after a callback. See L<perlcall>.
	50
fac3506f	51	=cut */
954c1994	52
ac634a9a	53	#undef SP /* Solaris 2.7 i386 has this in /usr/include/sys/reg.h */
79072805 LW	54	#define SP sp
	55	#define MARK mark
	56	#define TARG targ
	57
3280af22	58	#define PUSHMARK(p) if (++PL_markstack_ptr == PL_markstack_max) \
a0d0e21e	59	markstack_grow(); \
3280af22	60	*PL_markstack_ptr = (p) - PL_stack_base
a0d0e21e	61
3280af22 NIS	62	#define TOPMARK (*PL_markstack_ptr)
3280af22 NIS	63	#define POPMARK (*PL_markstack_ptr--)
a0d0e21e	64
39644a26 TJ	65	#define dSP register SV **sp = PL_stack_sp
39644a26 TJ	66	#define djSP dSP
3280af22 NIS	67	#define dMARK register SV **mark = PL_stack_base + POPMARK
	68	#define dORIGMARK I32 origmark = mark - PL_stack_base
	69	#define SETORIGMARK origmark = mark - PL_stack_base
	70	#define ORIGMARK (PL_stack_base + origmark)
79072805	71
3280af22 NIS	72	#define SPAGAIN sp = PL_stack_sp
3280af22 NIS	73	#define MSPAGAIN sp = PL_stack_sp; mark = ORIGMARK
79072805	74
533c011a	75	#define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
79072805 LW	76	#define dTARGETSTACKED SV * GETTARGETSTACKED
79072805 LW	77
533c011a	78	#define GETTARGET targ = PAD_SV(PL_op->op_targ)
79072805 LW	79	#define dTARGET SV * GETTARGET
79072805 LW	80
533c011a	81	#define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
79072805 LW	82	#define dATARGET SV * GETATARGET
	83
	84	#define dTARG SV *targ
	85
533c011a	86	#define NORMAL PL_op->op_next
cea2e8a9	87	#define DIE return Perl_die
79072805	88
954c1994 GS	89	/*
	90	=for apidoc Ams\|\|PUTBACK
	91	Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
	92	See C<PUSHMARK> and L<perlcall> for other uses.
	93
	94	=for apidoc Amn\|SV*\|POPs
	95	Pops an SV off the stack.
	96
	97	=for apidoc Amn\|char*\|POPp
595ae481 NIS	98	Pops a string off the stack. Deprecated. New code should provide
	99	a STRLEN n_a and use POPpx.
	100
	101	=for apidoc Amn\|char*\|POPpx
954c1994	102	Pops a string off the stack.
595ae481 NIS	103	Requires a variable STRLEN n_a in scope.
	104
	105	=for apidoc Amn\|char*\|POPpbytex
	106	Pops a string off the stack which must consist of bytes i.e. characters < 256.
	107	Requires a variable STRLEN n_a in scope.
954c1994 GS	108
	109	=for apidoc Amn\|NV\|POPn
	110	Pops a double off the stack.
	111
	112	=for apidoc Amn\|IV\|POPi
	113	Pops an integer off the stack.
	114
	115	=for apidoc Amn\|long\|POPl
	116	Pops a long off the stack.
	117
	118	=cut
	119	*/
	120
3280af22	121	#define PUTBACK PL_stack_sp = sp
79072805 LW	122	#define RETURN return PUTBACK, NORMAL
	123	#define RETURNOP(o) return PUTBACK, o
	124	#define RETURNX(x) return x, PUTBACK, NORMAL
	125
	126	#define POPs (*sp--)
2d8e6c8d GS	127	#define POPp (SvPVx(POPs, PL_na)) /* deprecated */
2d8e6c8d GS	128	#define POPpx (SvPVx(POPs, n_a))
595ae481	129	#define POPpbytex (SvPVbytex(POPs, n_a))
463ee0b2	130	#define POPn (SvNVx(POPs))
a0d0e21e	131	#define POPi ((IV)SvIVx(POPs))
ff68c719	132	#define POPu ((UV)SvUVx(POPs))
463ee0b2	133	#define POPl ((long)SvIVx(POPs))
d9b3e12d	134	#define POPul ((unsigned long)SvIVx(POPs))
1b8cd678	135	#ifdef HAS_QUAD
d9b3e12d	136	#define POPq ((Quad_t)SvIVx(POPs))
c5a0f51a	137	#define POPuq ((Uquad_t)SvUVx(POPs))
d9b3e12d	138	#endif
79072805 LW	139
79072805 LW	140	#define TOPs (*sp)
56370e9f	141	#define TOPm1s (*(sp-1))
7dca457a	142	#define TOPp1s (*(sp+1))
2d8e6c8d GS	143	#define TOPp (SvPV(TOPs, PL_na)) /* deprecated */
2d8e6c8d GS	144	#define TOPpx (SvPV(TOPs, n_a))
463ee0b2	145	#define TOPn (SvNV(TOPs))
a0d0e21e	146	#define TOPi ((IV)SvIV(TOPs))
ff68c719	147	#define TOPu ((UV)SvUV(TOPs))
463ee0b2	148	#define TOPl ((long)SvIV(TOPs))
c5a0f51a	149	#define TOPul ((unsigned long)SvUV(TOPs))
1b8cd678	150	#ifdef HAS_QUAD
d9b3e12d	151	#define TOPq ((Quad_t)SvIV(TOPs))
c5a0f51a	152	#define TOPuq ((Uquad_t)SvUV(TOPs))
d9b3e12d	153	#endif
79072805 LW	154
79072805 LW	155	/* Go to some pains in the rare event that we must extend the stack. */
954c1994 GS	156
	157	/*
	158	=for apidoc Am\|void\|EXTEND\|SP\|int nitems
	159	Used to extend the argument stack for an XSUB's return values. Once
4375e838	160	used, guarantees that there is room for at least C<nitems> to be pushed
954c1994 GS	161	onto the stack.
	162
	163	=for apidoc Am\|void\|PUSHs\|SV* sv
aacdac46	164	Push an SV onto the stack. The stack must have room for this element.
d82b684c SH	165	Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
d82b684c SH	166	C<XPUSHs> and C<XPUSHmortal>.
954c1994 GS	167
	168	=for apidoc Am\|void\|PUSHp\|char* str\|STRLEN len
	169	Push a string onto the stack. The stack must have room for this element.
d82b684c SH	170	The C<len> indicates the length of the string. Handles 'set' magic. Uses
	171	C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
	172	call multiple C<TARG>-oriented macros to return lists from XSUB's - see
	173	C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
954c1994 GS	174
	175	=for apidoc Am\|void\|PUSHn\|NV nv
	176	Push a double onto the stack. The stack must have room for this element.
d82b684c SH	177	Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
	178	called to declare it. Do not call multiple C<TARG>-oriented macros to
	179	return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
	180	C<mXPUSHn>.
954c1994 GS	181
	182	=for apidoc Am\|void\|PUSHi\|IV iv
	183	Push an integer onto the stack. The stack must have room for this element.
d82b684c SH	184	Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
	185	called to declare it. Do not call multiple C<TARG>-oriented macros to
	186	return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
	187	C<mXPUSHi>.
954c1994 GS	188
	189	=for apidoc Am\|void\|PUSHu\|UV uv
	190	Push an unsigned integer onto the stack. The stack must have room for this
d82b684c SH	191	element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
	192	should be called to declare it. Do not call multiple C<TARG>-oriented
	193	macros to return lists from XSUB's - see C<mPUSHu> instead. See also
	194	C<XPUSHu> and C<mXPUSHu>.
954c1994 GS	195
	196	=for apidoc Am\|void\|XPUSHs\|SV* sv
	197	Push an SV onto the stack, extending the stack if necessary. Does not
d82b684c SH	198	handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
d82b684c SH	199	C<PUSHs> and C<PUSHmortal>.
954c1994 GS	200
	201	=for apidoc Am\|void\|XPUSHp\|char* str\|STRLEN len
	202	Push a string onto the stack, extending the stack if necessary. The C<len>
d82b684c SH	203	indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
	204	C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
	205	multiple C<TARG>-oriented macros to return lists from XSUB's - see
	206	C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
954c1994 GS	207
	208	=for apidoc Am\|void\|XPUSHn\|NV nv
	209	Push a double onto the stack, extending the stack if necessary. Handles
d82b684c SH	210	'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
	211	declare it. Do not call multiple C<TARG>-oriented macros to return lists
	212	from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
954c1994 GS	213
	214	=for apidoc Am\|void\|XPUSHi\|IV iv
	215	Push an integer onto the stack, extending the stack if necessary. Handles
d82b684c SH	216	'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
	217	declare it. Do not call multiple C<TARG>-oriented macros to return lists
	218	from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
954c1994 GS	219
954c1994 GS	220	=for apidoc Am\|void\|XPUSHu\|UV uv
aacdac46	221	Push an unsigned integer onto the stack, extending the stack if necessary.
d82b684c SH	222	Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
	223	called to declare it. Do not call multiple C<TARG>-oriented macros to
	224	return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
	225	C<mPUSHu>.
	226
	227	=for apidoc Am\|void\|PUSHmortal
	228	Push a new mortal SV onto the stack. The stack must have room for this
	229	element. Does not handle 'set' magic. Does not use C<TARG>. See also
	230	C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
	231
	232	=for apidoc Am\|void\|mPUSHp\|char* str\|STRLEN len
	233	Push a string onto the stack. The stack must have room for this element.
de4f2208 RGS	234	The C<len> indicates the length of the string. Handles 'set' magic. Does
de4f2208 RGS	235	not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
d82b684c SH	236
	237	=for apidoc Am\|void\|mPUSHn\|NV nv
	238	Push a double onto the stack. The stack must have room for this element.
de4f2208 RGS	239	Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
de4f2208 RGS	240	and C<XPUSHn>.
d82b684c SH	241
	242	=for apidoc Am\|void\|mPUSHi\|IV iv
	243	Push an integer onto the stack. The stack must have room for this element.
de4f2208 RGS	244	Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
de4f2208 RGS	245	and C<XPUSHi>.
d82b684c SH	246
	247	=for apidoc Am\|void\|mPUSHu\|UV uv
	248	Push an unsigned integer onto the stack. The stack must have room for this
de4f2208 RGS	249	element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
de4f2208 RGS	250	C<mXPUSHu> and C<XPUSHu>.
d82b684c SH	251
	252	=for apidoc Am\|void\|XPUSHmortal
	253	Push a new mortal SV onto the stack, extending the stack if necessary. Does
	254	not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
	255	C<PUSHmortal> and C<PUSHs>.
	256
	257	=for apidoc Am\|void\|mXPUSHp\|char* str\|STRLEN len
	258	Push a string onto the stack, extending the stack if necessary. The C<len>
de4f2208 RGS	259	indicates the length of the string. Handles 'set' magic. Does not use
de4f2208 RGS	260	C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
d82b684c SH	261
d82b684c SH	262	=for apidoc Am\|void\|mXPUSHn\|NV nv
de4f2208 RGS	263	Push a double onto the stack, extending the stack if necessary. Handles
	264	'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
	265	C<PUSHn>.
d82b684c SH	266
d82b684c SH	267	=for apidoc Am\|void\|mXPUSHi\|IV iv
de4f2208 RGS	268	Push an integer onto the stack, extending the stack if necessary. Handles
	269	'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
	270	C<PUSHi>.
d82b684c SH	271
	272	=for apidoc Am\|void\|mXPUSHu\|UV uv
	273	Push an unsigned integer onto the stack, extending the stack if necessary.
de4f2208 RGS	274	Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
de4f2208 RGS	275	and C<PUSHu>.
954c1994 GS	276
	277	=cut
	278	*/
	279
c5661c80	280	#define EXTEND(p,n) STMT_START { if (PL_stack_max - p < (int)(n)) { \
bbce6d69	281	sp = stack_grow(sp,p, (int) (n)); \
86547924	282	} } STMT_END
a0d0e21e	283
79072805	284	/* Same thing, but update mark register too. */
c5661c80	285	#define MEXTEND(p,n) STMT_START {if (PL_stack_max - p < (int)(n)) { \
3280af22	286	int markoff = mark - PL_stack_base; \
bbce6d69	287	sp = stack_grow(sp,p,(int) (n)); \
3280af22	288	mark = PL_stack_base + markoff; \
86547924	289	} } STMT_END
79072805 LW	290
79072805 LW	291	#define PUSHs(s) (*++sp = (s))
86547924	292	#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
86547924	293	#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
65202027	294	#define PUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
86547924	295	#define PUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
55497cff	296	#define PUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
79072805	297
86547924	298	#define XPUSHs(s) STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
	299	#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
	300	#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
65202027	301	#define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
86547924	302	#define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
55497cff	303	#define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
b162f9ea	304	#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805	305
2cc7004b MHM	306	#define PUSHmortal PUSHs(sv_newmortal())
	307	#define mPUSHp(p,l) sv_setpvn_mg(PUSHmortal, (p), (l))
	308	#define mPUSHn(n) sv_setnv_mg(PUSHmortal, (NV)(n))
	309	#define mPUSHi(i) sv_setiv_mg(PUSHmortal, (IV)(i))
	310	#define mPUSHu(u) sv_setuv_mg(PUSHmortal, (UV)(u))
	311
	312	#define XPUSHmortal XPUSHs(sv_newmortal())
	313	#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); sv_setpvn_mg(PUSHmortal, (p), (l)); } STMT_END
	314	#define mXPUSHn(n) STMT_START { EXTEND(sp,1); sv_setnv_mg(PUSHmortal, (NV)(n)); } STMT_END
	315	#define mXPUSHi(i) STMT_START { EXTEND(sp,1); sv_setiv_mg(PUSHmortal, (IV)(i)); } STMT_END
	316	#define mXPUSHu(u) STMT_START { EXTEND(sp,1); sv_setuv_mg(PUSHmortal, (UV)(u)); } STMT_END
d82b684c	317
79072805	318	#define SETs(s) (*sp = s)
86547924	319	#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
86547924	320	#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
65202027	321	#define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
86547924	322	#define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
55497cff	323	#define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
a0d0e21e	324
79072805 LW	325	#define dTOPss SV *sv = TOPs
79072805 LW	326	#define dPOPss SV *sv = POPs
65202027 DS	327	#define dTOPnv NV value = TOPn
65202027 DS	328	#define dPOPnv NV value = POPn
a0d0e21e LW	329	#define dTOPiv IV value = TOPi
a0d0e21e LW	330	#define dPOPiv IV value = POPi
55497cff	331	#define dTOPuv UV value = TOPu
55497cff	332	#define dPOPuv UV value = POPu
1b8cd678	333	#ifdef HAS_QUAD
2d4389e4 JH	334	#define dTOPqv Quad_t value = TOPu
	335	#define dPOPqv Quad_t value = POPu
	336	#define dTOPuqv Uquad_t value = TOPuq
	337	#define dPOPuqv Uquad_t value = POPuq
	338	#endif
79072805	339
7a4c00b4	340	#define dPOPXssrl(X) SV right = POPs; SV left = CAT2(X,s)
65202027	341	#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4	342	#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
	343
	344	#define USE_LEFT(sv) \
533c011a	345	(SvOK(sv) \|\| SvGMAGICAL(sv) \|\| !(PL_op->op_flags & OPf_STACKED))
7a4c00b4	346	#define dPOPXnnrl_ul(X) \
65202027	347	NV right = POPn; \
7a4c00b4	348	SV *leftsv = CAT2(X,s); \
65202027	349	NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
7a4c00b4	350	#define dPOPXiirl_ul(X) \
	351	IV right = POPi; \
	352	SV *leftsv = CAT2(X,s); \
	353	IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
	354
	355	#define dPOPPOPssrl dPOPXssrl(POP)
	356	#define dPOPPOPnnrl dPOPXnnrl(POP)
	357	#define dPOPPOPnnrl_ul dPOPXnnrl_ul(POP)
	358	#define dPOPPOPiirl dPOPXiirl(POP)
	359	#define dPOPPOPiirl_ul dPOPXiirl_ul(POP)
	360
	361	#define dPOPTOPssrl dPOPXssrl(TOP)
	362	#define dPOPTOPnnrl dPOPXnnrl(TOP)
	363	#define dPOPTOPnnrl_ul dPOPXnnrl_ul(TOP)
	364	#define dPOPTOPiirl dPOPXiirl(TOP)
	365	#define dPOPTOPiirl_ul dPOPXiirl_ul(TOP)
79072805	366
3280af22 NIS	367	#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
	368	#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
	369	#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805	370
3280af22 NIS	371	#define RETSETYES RETURNX(SETs(&PL_sv_yes))
	372	#define RETSETNO RETURNX(SETs(&PL_sv_no))
	373	#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
79072805	374
533c011a	375	#define ARGTARG PL_op->op_targ
b162f9ea IZ	376
	377	/* See OPpTARGET_MY: */
	378	#define MAXARG (PL_op->op_private & 15)
79072805	379
e336de0d GS	380	#define SWITCHSTACK(f,t) \
e336de0d GS	381	STMT_START { \
677b06e3	382	AvFILLp(f) = sp - PL_stack_base; \
3280af22	383	PL_stack_base = AvARRAY(t); \
677b06e3	384	PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22	385	sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3	386	PL_curstack = t; \
e336de0d	387	} STMT_END
79072805	388
bbce6d69	389	#define EXTEND_MORTAL(n) \
677b06e3 GS	390	STMT_START { \
	391	if (PL_tmps_ix + (n) >= PL_tmps_max) \
	392	tmps_grow(n); \
	393	} STMT_END
bbce6d69	394
a0d0e21e LW	395	#define AMGf_noright 1
	396	#define AMGf_noleft 2
	397	#define AMGf_assign 4
	398	#define AMGf_unary 8
	399
86547924	400	#define tryAMAGICbinW(meth,assign,set) STMT_START { \
3280af22	401	if (PL_amagic_generation) { \
a0d0e21e LW	402	SV* tmpsv; \
	403	SV* right= (sp); SV left= *(sp-1);\
	404	if ((SvAMAGIC(left)\|\|SvAMAGIC(right))&&\
	405	(tmpsv=amagic_call(left, \
	406	right, \
	407	CAT2(meth,_amg), \
	408	(assign)? AMGf_assign: 0))) {\
	409	SPAGAIN; \
	410	(void)POPs; set(tmpsv); RETURN; } \
	411	} \
86547924	412	} STMT_END
a0d0e21e LW	413
	414	#define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
	415	#define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
	416
3280af22	417	#define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef, \
a0d0e21e LW	418	CAT2(meth,_amg),AMGf_noright \| AMGf_unary)
	419	#define AMG_CALLbinL(left,right,meth) \
	420	amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
	421
e8c20960	422	#define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
3280af22	423	if (PL_amagic_generation) { \
a0d0e21e	424	SV* tmpsv; \
f5284f61	425	SV* arg= sp[shift]; \
c4459e09	426	if(0) goto am_again; /* shut up unused warning */ \
f5284f61	427	am_again: \
a0d0e21e LW	428	if ((SvAMAGIC(arg))&&\
a0d0e21e LW	429	(tmpsv=AMG_CALLun(arg,meth))) {\
f5284f61	430	SPAGAIN; if (shift) sp += shift; \
e8c20960	431	set(tmpsv); ret; } \
a0d0e21e	432	} \
86547924	433	} STMT_END
a0d0e21e	434
f5284f61 IZ	435	#define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
f5284f61 IZ	436
b162f9ea IZ	437	#define tryAMAGICun(meth) tryAMAGICunW(meth,SETsvUN,0,RETURN)
b162f9ea IZ	438	#define tryAMAGICunSET(meth) tryAMAGICunW(meth,SETs,0,RETURN)
f5284f61 IZ	439	#define tryAMAGICunTARGET(meth, shift) \
	440	{ dSP; sp--; /* get TARGET from below PL_stack_sp */ \
	441	{ dTARGETSTACKED; \
e8c20960 IZ	442	{ dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}}
e8c20960 IZ	443
aacdac46 NIS	444	#define setAGAIN(ref) sv = ref; \
aacdac46 NIS	445	if (!SvROK(ref)) \
cea2e8a9	446	Perl_croak(aTHX_ "Overloaded dereference did not return a reference"); \
aacdac46 NIS	447	if (ref != arg && SvRV(ref) != SvRV(arg)) { \
	448	arg = ref; \
	449	goto am_again; \
	450	}
e8c20960	451
0f4592ef	452	#define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
a0d0e21e	453
533c011a	454	#define opASSIGN (PL_op->op_flags & OPf_STACKED)
e9905555	455	#define SETsv(sv) STMT_START { \
b162f9ea IZ	456	if (opASSIGN \|\| (SvFLAGS(TARG) & SVs_PADMY)) \
	457	{ sv_setsv(TARG, (sv)); SETTARG; } \
	458	else SETs(sv); } STMT_END
	459
	460	#define SETsvUN(sv) STMT_START { \
	461	if (SvFLAGS(TARG) & SVs_PADMY) \
	462	{ sv_setsv(TARG, (sv)); SETTARG; } \
e9905555	463	else SETs(sv); } STMT_END
a0d0e21e LW	464
	465	/* newSVsv does not behave as advertised, so we copy missing
	466	* information by hand */
	467
76e3520e GS	468	/* SV* ref causes confusion with the member variable
	469	changed SV* ref to SV* tmpRef */
	470	#define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); \
	471	if (SvREFCNT(tmpRef)>1) { \
29ddfe35	472	SvRV(rv)=AMG_CALLun(rv,copy); \
76e3520e	473	SvREFCNT_dec(tmpRef); \
86547924	474	} } STMT_END
78f9721b SM	475
	476	/*
	477	=for apidoc mU\|\|LVRET
	478	True if this op will be the return value of an lvalue subroutine
	479
	480	=cut */
9d96b2e7	481	#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())