[perl5.git] / pp.h

/*    pp.h
 *
 *    Copyright (c) 1991-2001, Larry Wall
 *
 *    You may distribute under the terms of either the GNU General Public
 *    License or the Artistic License, as specified in the README file.
 *
 */

#ifdef USE_THREADS
#define ARGS thr
#define dARGS struct perl_thread *thr;
#else
#define ARGS
#define dARGS
#endif /* USE_THREADS */

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

/*
=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 Ams||PUSHMARK
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 */

#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 djSP		register SV **sp = PL_stack_sp
#define dSP		djSP
#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.

=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 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 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.  See C<XPUSHs>.

=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.  See
C<XPUSHp>.

=for apidoc Am|void|PUSHn|NV nv
Push a double onto the stack.  The stack must have room for this element.
Handles 'set' magic.  See C<XPUSHn>.

=for apidoc Am|void|PUSHi|IV iv
Push an integer onto the stack.  The stack must have room for this element.
Handles 'set' magic.  See C<XPUSHi>.

=for apidoc Am|void|PUSHu|UV uv
Push an unsigned integer onto the stack.  The stack must have room for this
element.  See C<XPUSHu>.

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

=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.  See
C<PUSHp>.

=for apidoc Am|void|XPUSHn|NV nv
Push a double onto the stack, extending the stack if necessary.  Handles
'set' magic.  See C<PUSHn>.

=for apidoc Am|void|XPUSHi|IV iv
Push an integer onto the stack, extending the stack if necessary.  Handles
'set' magic. See C<PUSHi>.

=for apidoc Am|void|XPUSHu|UV uv
Push an unsigned integer onto the stack, extending the stack if necessary.
See C<PUSHu>.

=cut
*/

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