This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Use SSize_t for tmps stack offsets
[perl5.git] / pp.h
CommitLineData
a0d0e21e 1/* pp.h
79072805 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
79072805 5 *
a0d0e21e
LW
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
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
15
954c1994
GS
16=for apidoc AmU||SP
17Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
18C<SPAGAIN>.
19
20=for apidoc AmU||MARK
21Stack marker variable for the XSUB. See C<dMARK>.
22
c578083c 23=for apidoc Am|void|PUSHMARK|SP
954c1994
GS
24Opening bracket for arguments on a callback. See C<PUTBACK> and
25L<perlcall>.
26
27=for apidoc Ams||dSP
28Declares a local copy of perl's stack pointer for the XSUB, available via
29the C<SP> macro. See C<SP>.
30
fac3506f
MS
31=for apidoc ms||djSP
32
33Declare Just C<SP>. This is actually identical to C<dSP>, and declares
34a local copy of perl's stack pointer, available via the C<SP> macro.
35See C<SP>. (Available for backward source code compatibility with the
36old (Perl 5.005) thread model.)
37
954c1994
GS
38=for apidoc Ams||dMARK
39Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
40C<dORIGMARK>.
41
42=for apidoc Ams||dORIGMARK
43Saves the original stack mark for the XSUB. See C<ORIGMARK>.
44
45=for apidoc AmU||ORIGMARK
46The original stack mark for the XSUB. See C<dORIGMARK>.
47
48=for apidoc Ams||SPAGAIN
49Refetch 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
16e7e110
TH
58#define PUSHMARK(p) \
59 STMT_START { \
60 if (++PL_markstack_ptr == PL_markstack_max) \
61 markstack_grow(); \
514696af 62 *PL_markstack_ptr = (I32)((p) - PL_stack_base);\
16e7e110 63 } STMT_END
a0d0e21e 64
3280af22
NIS
65#define TOPMARK (*PL_markstack_ptr)
66#define POPMARK (*PL_markstack_ptr--)
a0d0e21e 67
bc0d193f 68#define dSP SV **sp = PL_stack_sp
39644a26 69#define djSP dSP
5aaab254 70#define dMARK SV **mark = PL_stack_base + POPMARK
514696af 71#define dORIGMARK const I32 origmark = (I32)(mark - PL_stack_base)
3280af22 72#define ORIGMARK (PL_stack_base + origmark)
79072805 73
3280af22 74#define SPAGAIN sp = PL_stack_sp
16e7e110 75#define MSPAGAIN STMT_START { sp = PL_stack_sp; mark = ORIGMARK; } STMT_END
79072805 76
533c011a 77#define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
79072805
LW
78#define dTARGETSTACKED SV * GETTARGETSTACKED
79
533c011a 80#define GETTARGET targ = PAD_SV(PL_op->op_targ)
79072805
LW
81#define dTARGET SV * GETTARGET
82
533c011a 83#define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
79072805
LW
84#define dATARGET SV * GETATARGET
85
86#define dTARG SV *targ
87
533c011a 88#define NORMAL PL_op->op_next
9fed9930 89#define DIE return Perl_die
79072805 90
954c1994
GS
91/*
92=for apidoc Ams||PUTBACK
93Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
94See C<PUSHMARK> and L<perlcall> for other uses.
95
96=for apidoc Amn|SV*|POPs
97Pops an SV off the stack.
98
99=for apidoc Amn|char*|POPp
4b7c0884 100Pops a string off the stack.
595ae481
NIS
101
102=for apidoc Amn|char*|POPpx
4b7c0884
FC
103Pops a string off the stack. Identical to POPp. There are two names for
104historical reasons.
595ae481
NIS
105
106=for apidoc Amn|char*|POPpbytex
107Pops a string off the stack which must consist of bytes i.e. characters < 256.
954c1994
GS
108
109=for apidoc Amn|NV|POPn
110Pops a double off the stack.
111
112=for apidoc Amn|IV|POPi
113Pops an integer off the stack.
114
115=for apidoc Amn|long|POPl
116Pops a long off the stack.
117
118=cut
119*/
120
3280af22 121#define PUTBACK PL_stack_sp = sp
8a67133a
NC
122#define RETURN return (PUTBACK, NORMAL)
123#define RETURNOP(o) return (PUTBACK, o)
124#define RETURNX(x) return (x, PUTBACK, NORMAL)
79072805
LW
125
126#define POPs (*sp--)
4b7c0884 127#define POPp POPpx
8c074e2a
NC
128#define POPpx (SvPVx_nolen(POPs))
129#define POPpconstx (SvPVx_nolen_const(POPs))
130#define POPpbytex (SvPVbytex_nolen(POPs))
463ee0b2 131#define POPn (SvNVx(POPs))
a0d0e21e 132#define POPi ((IV)SvIVx(POPs))
ff68c719 133#define POPu ((UV)SvUVx(POPs))
463ee0b2 134#define POPl ((long)SvIVx(POPs))
d9b3e12d 135#define POPul ((unsigned long)SvIVx(POPs))
1b8cd678 136#ifdef HAS_QUAD
d9b3e12d 137#define POPq ((Quad_t)SvIVx(POPs))
c5a0f51a 138#define POPuq ((Uquad_t)SvUVx(POPs))
d9b3e12d 139#endif
79072805
LW
140
141#define TOPs (*sp)
56370e9f 142#define TOPm1s (*(sp-1))
7dca457a 143#define TOPp1s (*(sp+1))
4b7c0884 144#define TOPp TOPpx
95fad918 145#define TOPpx (SvPV_nolen(TOPs))
463ee0b2 146#define TOPn (SvNV(TOPs))
a0d0e21e 147#define TOPi ((IV)SvIV(TOPs))
ff68c719 148#define TOPu ((UV)SvUV(TOPs))
463ee0b2 149#define TOPl ((long)SvIV(TOPs))
c5a0f51a 150#define TOPul ((unsigned long)SvUV(TOPs))
1b8cd678 151#ifdef HAS_QUAD
d9b3e12d 152#define TOPq ((Quad_t)SvIV(TOPs))
c5a0f51a 153#define TOPuq ((Uquad_t)SvUV(TOPs))
d9b3e12d 154#endif
79072805
LW
155
156/* Go to some pains in the rare event that we must extend the stack. */
954c1994
GS
157
158/*
159=for apidoc Am|void|EXTEND|SP|int nitems
160Used to extend the argument stack for an XSUB's return values. Once
4375e838 161used, guarantees that there is room for at least C<nitems> to be pushed
954c1994
GS
162onto the stack.
163
164=for apidoc Am|void|PUSHs|SV* sv
aacdac46 165Push an SV onto the stack. The stack must have room for this element.
d82b684c
SH
166Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
167C<XPUSHs> and C<XPUSHmortal>.
954c1994
GS
168
169=for apidoc Am|void|PUSHp|char* str|STRLEN len
170Push a string onto the stack. The stack must have room for this element.
d82b684c
SH
171The C<len> indicates the length of the string. Handles 'set' magic. Uses
172C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
173call multiple C<TARG>-oriented macros to return lists from XSUB's - see
174C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
954c1994
GS
175
176=for apidoc Am|void|PUSHn|NV nv
177Push a double onto the stack. The stack must have room for this element.
d82b684c
SH
178Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
179called to declare it. Do not call multiple C<TARG>-oriented macros to
180return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
181C<mXPUSHn>.
954c1994
GS
182
183=for apidoc Am|void|PUSHi|IV iv
184Push an integer onto the stack. The stack must have room for this element.
d82b684c
SH
185Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
186called to declare it. Do not call multiple C<TARG>-oriented macros to
187return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
188C<mXPUSHi>.
954c1994
GS
189
190=for apidoc Am|void|PUSHu|UV uv
191Push an unsigned integer onto the stack. The stack must have room for this
d82b684c
SH
192element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
193should be called to declare it. Do not call multiple C<TARG>-oriented
194macros to return lists from XSUB's - see C<mPUSHu> instead. See also
195C<XPUSHu> and C<mXPUSHu>.
954c1994
GS
196
197=for apidoc Am|void|XPUSHs|SV* sv
198Push an SV onto the stack, extending the stack if necessary. Does not
d82b684c
SH
199handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
200C<PUSHs> and C<PUSHmortal>.
954c1994
GS
201
202=for apidoc Am|void|XPUSHp|char* str|STRLEN len
203Push a string onto the stack, extending the stack if necessary. The C<len>
d82b684c
SH
204indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
205C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
206multiple C<TARG>-oriented macros to return lists from XSUB's - see
207C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
954c1994
GS
208
209=for apidoc Am|void|XPUSHn|NV nv
210Push a double onto the stack, extending the stack if necessary. Handles
d82b684c
SH
211'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
212declare it. Do not call multiple C<TARG>-oriented macros to return lists
213from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
954c1994
GS
214
215=for apidoc Am|void|XPUSHi|IV iv
216Push an integer onto the stack, extending the stack if necessary. Handles
d82b684c
SH
217'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
218declare it. Do not call multiple C<TARG>-oriented macros to return lists
219from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
954c1994
GS
220
221=for apidoc Am|void|XPUSHu|UV uv
aacdac46 222Push an unsigned integer onto the stack, extending the stack if necessary.
d82b684c
SH
223Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
224called to declare it. Do not call multiple C<TARG>-oriented macros to
225return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
226C<mPUSHu>.
227
6e449a3a
MHM
228=for apidoc Am|void|mPUSHs|SV* sv
229Push an SV onto the stack and mortalizes the SV. The stack must have room
121b7712 230for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
6e449a3a 231
d82b684c
SH
232=for apidoc Am|void|PUSHmortal
233Push a new mortal SV onto the stack. The stack must have room for this
121b7712 234element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
d82b684c
SH
235
236=for apidoc Am|void|mPUSHp|char* str|STRLEN len
237Push a string onto the stack. The stack must have room for this element.
121b7712
MHM
238The C<len> indicates the length of the string. Does not use C<TARG>.
239See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
d82b684c
SH
240
241=for apidoc Am|void|mPUSHn|NV nv
242Push a double onto the stack. The stack must have room for this element.
121b7712 243Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
d82b684c
SH
244
245=for apidoc Am|void|mPUSHi|IV iv
246Push an integer onto the stack. The stack must have room for this element.
121b7712 247Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
d82b684c
SH
248
249=for apidoc Am|void|mPUSHu|UV uv
250Push an unsigned integer onto the stack. The stack must have room for this
121b7712 251element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
d82b684c 252
6e449a3a
MHM
253=for apidoc Am|void|mXPUSHs|SV* sv
254Push an SV onto the stack, extending the stack if necessary and mortalizes
121b7712 255the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
6e449a3a 256
d82b684c 257=for apidoc Am|void|XPUSHmortal
121b7712
MHM
258Push a new mortal SV onto the stack, extending the stack if necessary.
259Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
d82b684c
SH
260
261=for apidoc Am|void|mXPUSHp|char* str|STRLEN len
262Push a string onto the stack, extending the stack if necessary. The C<len>
121b7712
MHM
263indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
264C<mPUSHp> and C<PUSHp>.
d82b684c
SH
265
266=for apidoc Am|void|mXPUSHn|NV nv
121b7712
MHM
267Push a double onto the stack, extending the stack if necessary.
268Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
d82b684c
SH
269
270=for apidoc Am|void|mXPUSHi|IV iv
121b7712
MHM
271Push an integer onto the stack, extending the stack if necessary.
272Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
d82b684c
SH
273
274=for apidoc Am|void|mXPUSHu|UV uv
275Push an unsigned integer onto the stack, extending the stack if necessary.
121b7712 276Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
954c1994
GS
277
278=cut
279*/
280
2439e033 281#define EXTEND(p,n) (void)(UNLIKELY(PL_stack_max - p < (int)(n)) && \
8d7906e1 282 (sp = stack_grow(sp,p, (int) (n))))
a0d0e21e 283
79072805 284/* Same thing, but update mark register too. */
2439e033
SM
285#define MEXTEND(p,n) STMT_START {if (UNLIKELY(PL_stack_max - p < (int)(n))) {\
286 const int markoff = mark - PL_stack_base; \
287 sp = stack_grow(sp,p,(int) (n)); \
288 mark = PL_stack_base + markoff; \
289 } } STMT_END
79072805
LW
290
291#define PUSHs(s) (*++sp = (s))
86547924
PP
292#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
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
8d7906e1 298#define XPUSHs(s) (EXTEND(sp,1), *++sp = (s))
86547924
PP
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
6e449a3a 306#define mPUSHs(s) PUSHs(sv_2mortal(s))
2cc7004b 307#define PUSHmortal PUSHs(sv_newmortal())
8f14ea01 308#define mPUSHp(p,l) PUSHs(newSVpvn_flags((p), (l), SVs_TEMP))
121b7712
MHM
309#define mPUSHn(n) sv_setnv(PUSHmortal, (NV)(n))
310#define mPUSHi(i) sv_setiv(PUSHmortal, (IV)(i))
311#define mPUSHu(u) sv_setuv(PUSHmortal, (UV)(u))
2cc7004b 312
6e449a3a 313#define mXPUSHs(s) XPUSHs(sv_2mortal(s))
2cc7004b 314#define XPUSHmortal XPUSHs(sv_newmortal())
8f14ea01 315#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); mPUSHp((p), (l)); } STMT_END
121b7712
MHM
316#define mXPUSHn(n) STMT_START { EXTEND(sp,1); sv_setnv(PUSHmortal, (NV)(n)); } STMT_END
317#define mXPUSHi(i) STMT_START { EXTEND(sp,1); sv_setiv(PUSHmortal, (IV)(i)); } STMT_END
318#define mXPUSHu(u) STMT_START { EXTEND(sp,1); sv_setuv(PUSHmortal, (UV)(u)); } STMT_END
d82b684c 319
79072805 320#define SETs(s) (*sp = s)
86547924
PP
321#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
322#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
65202027 323#define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
86547924 324#define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
55497cff 325#define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
a0d0e21e 326
79072805
LW
327#define dTOPss SV *sv = TOPs
328#define dPOPss SV *sv = POPs
65202027
DS
329#define dTOPnv NV value = TOPn
330#define dPOPnv NV value = POPn
6f1401dc 331#define dPOPnv_nomg NV value = (sp--, SvNV_nomg(TOPp1s))
a0d0e21e
LW
332#define dTOPiv IV value = TOPi
333#define dPOPiv IV value = POPi
55497cff
PP
334#define dTOPuv UV value = TOPu
335#define dPOPuv UV value = POPu
1b8cd678 336#ifdef HAS_QUAD
2d4389e4
JH
337#define dTOPqv Quad_t value = TOPu
338#define dPOPqv Quad_t value = POPu
339#define dTOPuqv Uquad_t value = TOPuq
340#define dPOPuqv Uquad_t value = POPuq
341#endif
79072805 342
7a4c00b4 343#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 344#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
345#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
346
347#define USE_LEFT(sv) \
6b349a5c 348 (SvOK(sv) || !(PL_op->op_flags & OPf_STACKED))
6f1401dc 349#define dPOPXiirl_ul_nomg(X) \
096c060c 350 IV right = (sp--, SvIV_nomg(TOPp1s)); \
6f1401dc 351 SV *leftsv = CAT2(X,s); \
096c060c 352 IV left = USE_LEFT(leftsv) ? SvIV_nomg(leftsv) : 0
7a4c00b4
PP
353
354#define dPOPPOPssrl dPOPXssrl(POP)
355#define dPOPPOPnnrl dPOPXnnrl(POP)
7a4c00b4 356#define dPOPPOPiirl dPOPXiirl(POP)
7a4c00b4
PP
357
358#define dPOPTOPssrl dPOPXssrl(TOP)
359#define dPOPTOPnnrl dPOPXnnrl(TOP)
6f1401dc
DM
360#define dPOPTOPnnrl_nomg \
361 NV right = SvNV_nomg(TOPs); NV left = (sp--, SvNV_nomg(TOPs))
7a4c00b4 362#define dPOPTOPiirl dPOPXiirl(TOP)
6f1401dc
DM
363#define dPOPTOPiirl_ul_nomg dPOPXiirl_ul_nomg(TOP)
364#define dPOPTOPiirl_nomg \
096c060c 365 IV right = SvIV_nomg(TOPs); IV left = (sp--, SvIV_nomg(TOPs))
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) \
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 390 STMT_START { \
2439e033 391 if (UNLIKELY(PL_tmps_ix + (n) >= PL_tmps_max)) \
677b06e3
GS
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
6f1401dc
DM
399#define AMGf_numeric 0x10 /* for Perl_try_amagic_bin */
400#define AMGf_set 0x20 /* for Perl_try_amagic_bin */
67288365 401#define AMGf_want_list 0x40
6f1401dc
DM
402
403
404/* do SvGETMAGIC on the stack args before checking for overload */
405
406#define tryAMAGICun_MG(method, flags) STMT_START { \
407 if ( (SvFLAGS(TOPs) & (SVf_ROK|SVs_GMG)) \
408 && Perl_try_amagic_un(aTHX_ method, flags)) \
409 return NORMAL; \
410 } STMT_END
411#define tryAMAGICbin_MG(method, flags) STMT_START { \
412 if ( ((SvFLAGS(TOPm1s)|SvFLAGS(TOPs)) & (SVf_ROK|SVs_GMG)) \
413 && Perl_try_amagic_bin(aTHX_ method, flags)) \
414 return NORMAL; \
415 } STMT_END
416
31d632c3
DM
417#define AMG_CALLunary(sv,meth) \
418 amagic_call(sv,&PL_sv_undef, meth, AMGf_noright | AMGf_unary)
419
420/* No longer used in core. Use AMG_CALLunary instead */
421#define AMG_CALLun(sv,meth) AMG_CALLunary(sv, CAT2(meth,_amg))
a0d0e21e 422
fc99edcf 423#define tryAMAGICunTARGETlist(meth, jump) \
9f39b4f1 424 STMT_START { \
b5c08826
DM
425 dSP; \
426 SV *tmpsv; \
fc99edcf 427 SV *arg= *sp; \
67288365 428 int gimme = GIMME_V; \
b5c08826
DM
429 if (SvAMAGIC(arg) && \
430 (tmpsv = amagic_call(arg, &PL_sv_undef, meth, \
05fbd38d
FC
431 AMGf_want_list | AMGf_noright \
432 |AMGf_unary))) { \
b5c08826 433 SPAGAIN; \
67288365
JL
434 if (gimme == G_VOID) { \
435 (void)POPs; /* XXX ??? */ \
436 } \
05fbd38d 437 else if (gimme == G_ARRAY) { \
67288365
JL
438 int i; \
439 I32 len; \
440 assert(SvTYPE(tmpsv) == SVt_PVAV); \
441 len = av_len((AV *)tmpsv) + 1; \
442 (void)POPs; /* get rid of the arg */ \
443 EXTEND(sp, len); \
444 for (i = 0; i < len; ++i) \
445 PUSHs(av_shift((AV *)tmpsv)); \
446 } \
447 else { /* AMGf_want_scalar */ \
448 dATARGET; /* just use the arg's location */ \
449 sv_setsv(TARG, tmpsv); \
450 if (opASSIGN) \
451 sp--; \
452 SETTARG; \
453 } \
b5c08826
DM
454 PUTBACK; \
455 if (jump) { \
86e5639b
GG
456 OP *jump_o = NORMAL->op_next; \
457 while (jump_o->op_type == OP_NULL) \
458 jump_o = jump_o->op_next; \
459 assert(jump_o->op_type == OP_ENTERSUB); \
b5c08826 460 PL_markstack_ptr--; \
86e5639b 461 return jump_o->op_next; \
9f39b4f1 462 } \
b5c08826
DM
463 return NORMAL; \
464 } \
9f39b4f1
NC
465 } STMT_END
466
8897dcaa
NC
467/* This is no longer used anywhere in the core. You might wish to consider
468 calling amagic_deref_call() directly, as it has a cleaner interface. */
469#define tryAMAGICunDEREF(meth) \
9f39b4f1 470 STMT_START { \
e89bfaa6 471 sv = amagic_deref_call(*sp, CAT2(meth,_amg)); \
25a9ffce 472 SPAGAIN; \
16e7e110 473 } STMT_END
e8c20960 474
180b7b9b 475
533c011a 476#define opASSIGN (PL_op->op_flags & OPf_STACKED)
e9905555 477#define SETsv(sv) STMT_START { \
b162f9ea
IZ
478 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY)) \
479 { sv_setsv(TARG, (sv)); SETTARG; } \
480 else SETs(sv); } STMT_END
481
482#define SETsvUN(sv) STMT_START { \
483 if (SvFLAGS(TARG) & SVs_PADMY) \
484 { sv_setsv(TARG, (sv)); SETTARG; } \
e9905555 485 else SETs(sv); } STMT_END
a0d0e21e 486
78f9721b
SM
487/*
488=for apidoc mU||LVRET
489True if this op will be the return value of an lvalue subroutine
490
491=cut */
9d96b2e7 492#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
1b6737cc 493
d30e492c
VP
494#define SvCANEXISTDELETE(sv) \
495 (!SvRMAGICAL(sv) \
2c5f48c2
FC
496 || !(mg = mg_find((const SV *) sv, PERL_MAGIC_tied)) \
497 || ( (stash = SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(sv), mg)))) \
d30e492c
VP
498 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
499 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
500 ) \
501 )
502
d682515d 503#ifdef PERL_CORE
557fbd17 504
d682515d
NC
505/* These are just for Perl_tied_method(), which is not part of the public API.
506 Use 0x04 rather than the next available bit, to help the compiler if the
507 architecture can generate more efficient instructions. */
508# define TIED_METHOD_MORTALIZE_NOT_NEEDED 0x04
509# define TIED_METHOD_ARGUMENTS_ON_STACK 0x08
94bc412f 510# define TIED_METHOD_SAY 0x10
557fbd17
FC
511
512/* Used in various places that need to dereference a glob or globref */
094a3eec 513# define MAYBE_DEREF_GV_flags(sv,phlags) \
557fbd17 514 ( \
094a3eec 515 (void)(phlags & SV_GMAGIC && (SvGETMAGIC(sv),0)), \
557fbd17 516 isGV_with_GP(sv) \
4e794a06 517 ? (GV *)(sv) \
f8afbfa6
FC
518 : SvROK(sv) && SvTYPE(SvRV(sv)) <= SVt_PVLV && \
519 (SvGETMAGIC(SvRV(sv)), isGV_with_GP(SvRV(sv))) \
557fbd17
FC
520 ? (GV *)SvRV(sv) \
521 : NULL \
522 )
094a3eec
FC
523# define MAYBE_DEREF_GV(sv) MAYBE_DEREF_GV_flags(sv,SV_GMAGIC)
524# define MAYBE_DEREF_GV_nomg(sv) MAYBE_DEREF_GV_flags(sv,0)
557fbd17 525
db4cf31d 526# define FIND_RUNCV_padid_eq 1
b4b0692a 527# define FIND_RUNCV_level_eq 2
70794f7b 528
d682515d
NC
529#endif
530
1b6737cc
AL
531/*
532 * Local variables:
533 * c-indentation-style: bsd
534 * c-basic-offset: 4
14d04a33 535 * indent-tabs-mode: nil
1b6737cc
AL
536 * End:
537 *
14d04a33 538 * ex: set ts=8 sts=4 sw=4 et:
1b6737cc 539 */