This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
A mising cast (given that rx->subbeg is only char *)
[perl5.git] / pp.h
CommitLineData
a0d0e21e 1/* pp.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
1d325971 4 * 2000, 2001, 2002, 2003, 2004, 2005 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(); \
62 *PL_markstack_ptr = (p) - PL_stack_base; \
63 } STMT_END
a0d0e21e 64
3280af22
NIS
65#define TOPMARK (*PL_markstack_ptr)
66#define POPMARK (*PL_markstack_ptr--)
a0d0e21e 67
39644a26
TJ
68#define dSP register SV **sp = PL_stack_sp
69#define djSP dSP
3280af22 70#define dMARK register SV **mark = PL_stack_base + POPMARK
a3b680e6 71#define dORIGMARK const I32 origmark = 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
cea2e8a9 89#define DIE return Perl_die
5df617be 90#define DIE_NULL return DieNull
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
8c074e2a 101Pops a string off the stack. Deprecated. New code should use POPpx.
595ae481
NIS
102
103=for apidoc Amn|char*|POPpx
954c1994 104Pops a string off the stack.
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
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 127#define POPp (SvPVx(POPs, PL_na)) /* deprecated */
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))
2d8e6c8d
GS
144#define TOPp (SvPV(TOPs, PL_na)) /* deprecated */
145#define TOPpx (SvPV(TOPs, n_a))
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
228=for apidoc Am|void|PUSHmortal
229Push a new mortal SV onto the stack. The stack must have room for this
230element. Does not handle 'set' magic. Does not use C<TARG>. See also
231C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
232
233=for apidoc Am|void|mPUSHp|char* str|STRLEN len
234Push a string onto the stack. The stack must have room for this element.
de4f2208
RGS
235The C<len> indicates the length of the string. Handles 'set' magic. Does
236not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
d82b684c
SH
237
238=for apidoc Am|void|mPUSHn|NV nv
239Push a double onto the stack. The stack must have room for this element.
de4f2208
RGS
240Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
241and C<XPUSHn>.
d82b684c
SH
242
243=for apidoc Am|void|mPUSHi|IV iv
244Push an integer onto the stack. The stack must have room for this element.
de4f2208
RGS
245Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
246and C<XPUSHi>.
d82b684c
SH
247
248=for apidoc Am|void|mPUSHu|UV uv
249Push an unsigned integer onto the stack. The stack must have room for this
de4f2208
RGS
250element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
251C<mXPUSHu> and C<XPUSHu>.
d82b684c
SH
252
253=for apidoc Am|void|XPUSHmortal
254Push a new mortal SV onto the stack, extending the stack if necessary. Does
255not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
256C<PUSHmortal> and C<PUSHs>.
257
258=for apidoc Am|void|mXPUSHp|char* str|STRLEN len
259Push a string onto the stack, extending the stack if necessary. The C<len>
de4f2208
RGS
260indicates the length of the string. Handles 'set' magic. Does not use
261C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
d82b684c
SH
262
263=for apidoc Am|void|mXPUSHn|NV nv
de4f2208
RGS
264Push a double onto the stack, extending the stack if necessary. Handles
265'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
266C<PUSHn>.
d82b684c
SH
267
268=for apidoc Am|void|mXPUSHi|IV iv
de4f2208
RGS
269Push an integer onto the stack, extending the stack if necessary. Handles
270'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
271C<PUSHi>.
d82b684c
SH
272
273=for apidoc Am|void|mXPUSHu|UV uv
274Push an unsigned integer onto the stack, extending the stack if necessary.
de4f2208
RGS
275Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
276and C<PUSHu>.
954c1994
GS
277
278=cut
279*/
280
c5661c80 281#define EXTEND(p,n) STMT_START { if (PL_stack_max - p < (int)(n)) { \
bbce6d69 282 sp = stack_grow(sp,p, (int) (n)); \
86547924 283 } } STMT_END
a0d0e21e 284
79072805 285/* Same thing, but update mark register too. */
c5661c80 286#define MEXTEND(p,n) STMT_START {if (PL_stack_max - p < (int)(n)) { \
3280af22 287 int markoff = mark - PL_stack_base; \
bbce6d69 288 sp = stack_grow(sp,p,(int) (n)); \
3280af22 289 mark = PL_stack_base + markoff; \
86547924 290 } } STMT_END
79072805
LW
291
292#define PUSHs(s) (*++sp = (s))
86547924
PP
293#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
294#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
65202027 295#define PUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
86547924 296#define PUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
55497cff 297#define PUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
79072805 298
86547924
PP
299#define XPUSHs(s) STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
300#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
301#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
65202027 302#define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
86547924 303#define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
55497cff 304#define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
b162f9ea 305#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805 306
2cc7004b
MHM
307#define PUSHmortal PUSHs(sv_newmortal())
308#define mPUSHp(p,l) sv_setpvn_mg(PUSHmortal, (p), (l))
309#define mPUSHn(n) sv_setnv_mg(PUSHmortal, (NV)(n))
310#define mPUSHi(i) sv_setiv_mg(PUSHmortal, (IV)(i))
311#define mPUSHu(u) sv_setuv_mg(PUSHmortal, (UV)(u))
312
313#define XPUSHmortal XPUSHs(sv_newmortal())
314#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); sv_setpvn_mg(PUSHmortal, (p), (l)); } STMT_END
315#define mXPUSHn(n) STMT_START { EXTEND(sp,1); sv_setnv_mg(PUSHmortal, (NV)(n)); } STMT_END
316#define mXPUSHi(i) STMT_START { EXTEND(sp,1); sv_setiv_mg(PUSHmortal, (IV)(i)); } STMT_END
317#define mXPUSHu(u) STMT_START { EXTEND(sp,1); sv_setuv_mg(PUSHmortal, (UV)(u)); } STMT_END
d82b684c 318
79072805 319#define SETs(s) (*sp = s)
86547924
PP
320#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
321#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
65202027 322#define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
86547924 323#define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
55497cff 324#define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
a0d0e21e 325
79072805
LW
326#define dTOPss SV *sv = TOPs
327#define dPOPss SV *sv = POPs
65202027
DS
328#define dTOPnv NV value = TOPn
329#define dPOPnv NV value = POPn
a0d0e21e
LW
330#define dTOPiv IV value = TOPi
331#define dPOPiv IV value = POPi
55497cff
PP
332#define dTOPuv UV value = TOPu
333#define dPOPuv UV value = POPu
1b8cd678 334#ifdef HAS_QUAD
2d4389e4
JH
335#define dTOPqv Quad_t value = TOPu
336#define dPOPqv Quad_t value = POPu
337#define dTOPuqv Uquad_t value = TOPuq
338#define dPOPuqv Uquad_t value = POPuq
339#endif
79072805 340
7a4c00b4 341#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 342#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
343#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
344
345#define USE_LEFT(sv) \
533c011a 346 (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
7a4c00b4 347#define dPOPXnnrl_ul(X) \
65202027 348 NV right = POPn; \
7a4c00b4 349 SV *leftsv = CAT2(X,s); \
65202027 350 NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
7a4c00b4
PP
351#define dPOPXiirl_ul(X) \
352 IV right = POPi; \
353 SV *leftsv = CAT2(X,s); \
354 IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
355
356#define dPOPPOPssrl dPOPXssrl(POP)
357#define dPOPPOPnnrl dPOPXnnrl(POP)
358#define dPOPPOPnnrl_ul dPOPXnnrl_ul(POP)
359#define dPOPPOPiirl dPOPXiirl(POP)
360#define dPOPPOPiirl_ul dPOPXiirl_ul(POP)
361
362#define dPOPTOPssrl dPOPXssrl(TOP)
363#define dPOPTOPnnrl dPOPXnnrl(TOP)
364#define dPOPTOPnnrl_ul dPOPXnnrl_ul(TOP)
365#define dPOPTOPiirl dPOPXiirl(TOP)
366#define dPOPTOPiirl_ul dPOPXiirl_ul(TOP)
79072805 367
3280af22
NIS
368#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
369#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
370#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 371
3280af22
NIS
372#define RETSETYES RETURNX(SETs(&PL_sv_yes))
373#define RETSETNO RETURNX(SETs(&PL_sv_no))
374#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
79072805 375
533c011a 376#define ARGTARG PL_op->op_targ
b162f9ea
IZ
377
378 /* See OPpTARGET_MY: */
379#define MAXARG (PL_op->op_private & 15)
79072805 380
e336de0d
GS
381#define SWITCHSTACK(f,t) \
382 STMT_START { \
677b06e3 383 AvFILLp(f) = sp - PL_stack_base; \
3280af22 384 PL_stack_base = AvARRAY(t); \
677b06e3 385 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 386 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 387 PL_curstack = t; \
e336de0d 388 } STMT_END
79072805 389
bbce6d69 390#define EXTEND_MORTAL(n) \
677b06e3
GS
391 STMT_START { \
392 if (PL_tmps_ix + (n) >= PL_tmps_max) \
393 tmps_grow(n); \
394 } STMT_END
bbce6d69 395
a0d0e21e
LW
396#define AMGf_noright 1
397#define AMGf_noleft 2
398#define AMGf_assign 4
399#define AMGf_unary 8
400
86547924 401#define tryAMAGICbinW(meth,assign,set) STMT_START { \
3280af22 402 if (PL_amagic_generation) { \
a0d0e21e
LW
403 SV* tmpsv; \
404 SV* right= *(sp); SV* left= *(sp-1);\
405 if ((SvAMAGIC(left)||SvAMAGIC(right))&&\
406 (tmpsv=amagic_call(left, \
407 right, \
408 CAT2(meth,_amg), \
409 (assign)? AMGf_assign: 0))) {\
410 SPAGAIN; \
411 (void)POPs; set(tmpsv); RETURN; } \
412 } \
86547924 413 } STMT_END
a0d0e21e
LW
414
415#define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
416#define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
417
3280af22 418#define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef, \
a0d0e21e
LW
419 CAT2(meth,_amg),AMGf_noright | AMGf_unary)
420#define AMG_CALLbinL(left,right,meth) \
421 amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
422
e8c20960 423#define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
3280af22 424 if (PL_amagic_generation) { \
a0d0e21e 425 SV* tmpsv; \
f5284f61 426 SV* arg= sp[shift]; \
c4459e09 427 if(0) goto am_again; /* shut up unused warning */ \
f5284f61 428 am_again: \
a0d0e21e
LW
429 if ((SvAMAGIC(arg))&&\
430 (tmpsv=AMG_CALLun(arg,meth))) {\
f5284f61 431 SPAGAIN; if (shift) sp += shift; \
e8c20960 432 set(tmpsv); ret; } \
a0d0e21e 433 } \
86547924 434 } STMT_END
a0d0e21e 435
f5284f61
IZ
436#define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
437
b162f9ea
IZ
438#define tryAMAGICun(meth) tryAMAGICunW(meth,SETsvUN,0,RETURN)
439#define tryAMAGICunSET(meth) tryAMAGICunW(meth,SETs,0,RETURN)
f5284f61 440#define tryAMAGICunTARGET(meth, shift) \
16e7e110 441 STMT_START { dSP; sp--; /* get TARGET from below PL_stack_sp */ \
f5284f61 442 { dTARGETSTACKED; \
16e7e110
TH
443 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}} STMT_END
444
445#define setAGAIN(ref) \
446 STMT_START { \
447 sv = ref; \
448 if (!SvROK(ref)) \
449 Perl_croak(aTHX_ "Overloaded dereference did not return a reference"); \
450 if (ref != arg && SvRV(ref) != SvRV(arg)) { \
451 arg = ref; \
452 goto am_again; \
453 } \
454 } STMT_END
e8c20960 455
0f4592ef 456#define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
a0d0e21e 457
533c011a 458#define opASSIGN (PL_op->op_flags & OPf_STACKED)
e9905555 459#define SETsv(sv) STMT_START { \
b162f9ea
IZ
460 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY)) \
461 { sv_setsv(TARG, (sv)); SETTARG; } \
462 else SETs(sv); } STMT_END
463
464#define SETsvUN(sv) STMT_START { \
465 if (SvFLAGS(TARG) & SVs_PADMY) \
466 { sv_setsv(TARG, (sv)); SETTARG; } \
e9905555 467 else SETs(sv); } STMT_END
a0d0e21e
LW
468
469/* newSVsv does not behave as advertised, so we copy missing
470 * information by hand */
471
76e3520e
GS
472/* SV* ref causes confusion with the member variable
473 changed SV* ref to SV* tmpRef */
474#define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); \
475 if (SvREFCNT(tmpRef)>1) { \
b162af07 476 SvRV_set(rv, AMG_CALLun(rv,copy)); \
76e3520e 477 SvREFCNT_dec(tmpRef); \
86547924 478 } } STMT_END
78f9721b
SM
479
480/*
481=for apidoc mU||LVRET
482True if this op will be the return value of an lvalue subroutine
483
484=cut */
9d96b2e7 485#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())