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