This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add a small program that gets the C pre-processor to expand the macro
[perl5.git] / pp.h
CommitLineData
a0d0e21e 1/* pp.h
79072805 2 *
663f364b
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 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
3280af22 70#define dMARK register 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
cea2e8a9 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
8c074e2a 100Pops a string off the stack. Deprecated. New code should use POPpx.
595ae481
NIS
101
102=for apidoc Amn|char*|POPpx
954c1994 103Pops a string off the stack.
595ae481
NIS
104
105=for apidoc Amn|char*|POPpbytex
106Pops a string off the stack which must consist of bytes i.e. characters < 256.
954c1994
GS
107
108=for apidoc Amn|NV|POPn
109Pops a double off the stack.
110
111=for apidoc Amn|IV|POPi
112Pops an integer off the stack.
113
114=for apidoc Amn|long|POPl
115Pops a long off the stack.
116
117=cut
118*/
119
3280af22 120#define PUTBACK PL_stack_sp = sp
8a67133a
NC
121#define RETURN return (PUTBACK, NORMAL)
122#define RETURNOP(o) return (PUTBACK, o)
123#define RETURNX(x) return (x, PUTBACK, NORMAL)
79072805
LW
124
125#define POPs (*sp--)
2d8e6c8d 126#define POPp (SvPVx(POPs, PL_na)) /* deprecated */
8c074e2a
NC
127#define POPpx (SvPVx_nolen(POPs))
128#define POPpconstx (SvPVx_nolen_const(POPs))
129#define POPpbytex (SvPVbytex_nolen(POPs))
463ee0b2 130#define POPn (SvNVx(POPs))
a0d0e21e 131#define POPi ((IV)SvIVx(POPs))
ff68c719 132#define POPu ((UV)SvUVx(POPs))
463ee0b2 133#define POPl ((long)SvIVx(POPs))
d9b3e12d 134#define POPul ((unsigned long)SvIVx(POPs))
1b8cd678 135#ifdef HAS_QUAD
d9b3e12d 136#define POPq ((Quad_t)SvIVx(POPs))
c5a0f51a 137#define POPuq ((Uquad_t)SvUVx(POPs))
d9b3e12d 138#endif
79072805
LW
139
140#define TOPs (*sp)
56370e9f 141#define TOPm1s (*(sp-1))
7dca457a 142#define TOPp1s (*(sp+1))
2d8e6c8d 143#define TOPp (SvPV(TOPs, PL_na)) /* deprecated */
95fad918 144#define TOPpx (SvPV_nolen(TOPs))
463ee0b2 145#define TOPn (SvNV(TOPs))
a0d0e21e 146#define TOPi ((IV)SvIV(TOPs))
ff68c719 147#define TOPu ((UV)SvUV(TOPs))
463ee0b2 148#define TOPl ((long)SvIV(TOPs))
c5a0f51a 149#define TOPul ((unsigned long)SvUV(TOPs))
1b8cd678 150#ifdef HAS_QUAD
d9b3e12d 151#define TOPq ((Quad_t)SvIV(TOPs))
c5a0f51a 152#define TOPuq ((Uquad_t)SvUV(TOPs))
d9b3e12d 153#endif
79072805
LW
154
155/* Go to some pains in the rare event that we must extend the stack. */
954c1994
GS
156
157/*
158=for apidoc Am|void|EXTEND|SP|int nitems
159Used to extend the argument stack for an XSUB's return values. Once
4375e838 160used, guarantees that there is room for at least C<nitems> to be pushed
954c1994
GS
161onto the stack.
162
163=for apidoc Am|void|PUSHs|SV* sv
aacdac46 164Push an SV onto the stack. The stack must have room for this element.
d82b684c
SH
165Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
166C<XPUSHs> and C<XPUSHmortal>.
954c1994
GS
167
168=for apidoc Am|void|PUSHp|char* str|STRLEN len
169Push a string onto the stack. The stack must have room for this element.
d82b684c
SH
170The C<len> indicates the length of the string. Handles 'set' magic. Uses
171C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
172call multiple C<TARG>-oriented macros to return lists from XSUB's - see
173C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
954c1994
GS
174
175=for apidoc Am|void|PUSHn|NV nv
176Push a double onto the stack. The stack must have room for this element.
d82b684c
SH
177Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
178called to declare it. Do not call multiple C<TARG>-oriented macros to
179return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
180C<mXPUSHn>.
954c1994
GS
181
182=for apidoc Am|void|PUSHi|IV iv
183Push an integer onto the stack. The stack must have room for this element.
d82b684c
SH
184Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
185called to declare it. Do not call multiple C<TARG>-oriented macros to
186return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
187C<mXPUSHi>.
954c1994
GS
188
189=for apidoc Am|void|PUSHu|UV uv
190Push an unsigned integer onto the stack. The stack must have room for this
d82b684c
SH
191element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
192should be called to declare it. Do not call multiple C<TARG>-oriented
193macros to return lists from XSUB's - see C<mPUSHu> instead. See also
194C<XPUSHu> and C<mXPUSHu>.
954c1994
GS
195
196=for apidoc Am|void|XPUSHs|SV* sv
197Push an SV onto the stack, extending the stack if necessary. Does not
d82b684c
SH
198handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
199C<PUSHs> and C<PUSHmortal>.
954c1994
GS
200
201=for apidoc Am|void|XPUSHp|char* str|STRLEN len
202Push a string onto the stack, extending the stack if necessary. The C<len>
d82b684c
SH
203indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
204C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
205multiple C<TARG>-oriented macros to return lists from XSUB's - see
206C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
954c1994
GS
207
208=for apidoc Am|void|XPUSHn|NV nv
209Push a double onto the stack, extending the stack if necessary. Handles
d82b684c
SH
210'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
211declare it. Do not call multiple C<TARG>-oriented macros to return lists
212from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
954c1994
GS
213
214=for apidoc Am|void|XPUSHi|IV iv
215Push an integer onto the stack, extending the stack if necessary. Handles
d82b684c
SH
216'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
217declare it. Do not call multiple C<TARG>-oriented macros to return lists
218from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
954c1994
GS
219
220=for apidoc Am|void|XPUSHu|UV uv
aacdac46 221Push an unsigned integer onto the stack, extending the stack if necessary.
d82b684c
SH
222Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
223called to declare it. Do not call multiple C<TARG>-oriented macros to
224return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
225C<mPUSHu>.
226
6e449a3a
MHM
227=for apidoc Am|void|mPUSHs|SV* sv
228Push an SV onto the stack and mortalizes the SV. The stack must have room
121b7712 229for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
6e449a3a 230
d82b684c
SH
231=for apidoc Am|void|PUSHmortal
232Push a new mortal SV onto the stack. The stack must have room for this
121b7712 233element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
d82b684c
SH
234
235=for apidoc Am|void|mPUSHp|char* str|STRLEN len
236Push a string onto the stack. The stack must have room for this element.
121b7712
MHM
237The C<len> indicates the length of the string. Does not use C<TARG>.
238See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
d82b684c
SH
239
240=for apidoc Am|void|mPUSHn|NV nv
241Push a double onto the stack. The stack must have room for this element.
121b7712 242Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
d82b684c
SH
243
244=for apidoc Am|void|mPUSHi|IV iv
245Push an integer onto the stack. The stack must have room for this element.
121b7712 246Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and 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
121b7712 250element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
d82b684c 251
6e449a3a
MHM
252=for apidoc Am|void|mXPUSHs|SV* sv
253Push an SV onto the stack, extending the stack if necessary and mortalizes
121b7712 254the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
6e449a3a 255
d82b684c 256=for apidoc Am|void|XPUSHmortal
121b7712
MHM
257Push a new mortal SV onto the stack, extending the stack if necessary.
258Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
d82b684c
SH
259
260=for apidoc Am|void|mXPUSHp|char* str|STRLEN len
261Push a string onto the stack, extending the stack if necessary. The C<len>
121b7712
MHM
262indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
263C<mPUSHp> and C<PUSHp>.
d82b684c
SH
264
265=for apidoc Am|void|mXPUSHn|NV nv
121b7712
MHM
266Push a double onto the stack, extending the stack if necessary.
267Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
d82b684c
SH
268
269=for apidoc Am|void|mXPUSHi|IV iv
121b7712
MHM
270Push an integer onto the stack, extending the stack if necessary.
271Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
d82b684c
SH
272
273=for apidoc Am|void|mXPUSHu|UV uv
274Push an unsigned integer onto the stack, extending the stack if necessary.
121b7712 275Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
954c1994
GS
276
277=cut
278*/
279
c5661c80 280#define EXTEND(p,n) STMT_START { if (PL_stack_max - p < (int)(n)) { \
bbce6d69 281 sp = stack_grow(sp,p, (int) (n)); \
86547924 282 } } STMT_END
a0d0e21e 283
79072805 284/* Same thing, but update mark register too. */
1b6737cc
AL
285#define MEXTEND(p,n) STMT_START {if (PL_stack_max - p < (int)(n)) { \
286 const int markoff = mark - PL_stack_base; \
bbce6d69 287 sp = stack_grow(sp,p,(int) (n)); \
3280af22 288 mark = PL_stack_base + markoff; \
86547924 289 } } STMT_END
79072805
LW
290
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
86547924
PP
298#define XPUSHs(s) STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
299#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
300#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
65202027 301#define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
86547924 302#define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
55497cff 303#define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
b162f9ea 304#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805 305
6e449a3a 306#define mPUSHs(s) PUSHs(sv_2mortal(s))
2cc7004b 307#define PUSHmortal PUSHs(sv_newmortal())
121b7712
MHM
308#define mPUSHp(p,l) sv_setpvn(PUSHmortal, (p), (l))
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())
121b7712
MHM
315#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); sv_setpvn(PUSHmortal, (p), (l)); } STMT_END
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
a0d0e21e
LW
331#define dTOPiv IV value = TOPi
332#define dPOPiv IV value = POPi
55497cff
PP
333#define dTOPuv UV value = TOPu
334#define dPOPuv UV value = POPu
1b8cd678 335#ifdef HAS_QUAD
2d4389e4
JH
336#define dTOPqv Quad_t value = TOPu
337#define dPOPqv Quad_t value = POPu
338#define dTOPuqv Uquad_t value = TOPuq
339#define dPOPuqv Uquad_t value = POPuq
340#endif
79072805 341
7a4c00b4 342#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 343#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
344#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
345
346#define USE_LEFT(sv) \
533c011a 347 (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
7a4c00b4 348#define dPOPXnnrl_ul(X) \
65202027 349 NV right = POPn; \
7a4c00b4 350 SV *leftsv = CAT2(X,s); \
65202027 351 NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
7a4c00b4
PP
352#define dPOPXiirl_ul(X) \
353 IV right = POPi; \
354 SV *leftsv = CAT2(X,s); \
355 IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
356
357#define dPOPPOPssrl dPOPXssrl(POP)
358#define dPOPPOPnnrl dPOPXnnrl(POP)
359#define dPOPPOPnnrl_ul dPOPXnnrl_ul(POP)
360#define dPOPPOPiirl dPOPXiirl(POP)
361#define dPOPPOPiirl_ul dPOPXiirl_ul(POP)
362
363#define dPOPTOPssrl dPOPXssrl(TOP)
364#define dPOPTOPnnrl dPOPXnnrl(TOP)
365#define dPOPTOPnnrl_ul dPOPXnnrl_ul(TOP)
366#define dPOPTOPiirl dPOPXiirl(TOP)
367#define dPOPTOPiirl_ul dPOPXiirl_ul(TOP)
79072805 368
3280af22
NIS
369#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
370#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
371#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 372
3280af22
NIS
373#define RETSETYES RETURNX(SETs(&PL_sv_yes))
374#define RETSETNO RETURNX(SETs(&PL_sv_no))
375#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
79072805 376
533c011a 377#define ARGTARG PL_op->op_targ
b162f9ea
IZ
378
379 /* See OPpTARGET_MY: */
380#define MAXARG (PL_op->op_private & 15)
79072805 381
e336de0d
GS
382#define SWITCHSTACK(f,t) \
383 STMT_START { \
677b06e3 384 AvFILLp(f) = sp - PL_stack_base; \
3280af22 385 PL_stack_base = AvARRAY(t); \
677b06e3 386 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 387 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 388 PL_curstack = t; \
e336de0d 389 } STMT_END
79072805 390
bbce6d69 391#define EXTEND_MORTAL(n) \
677b06e3
GS
392 STMT_START { \
393 if (PL_tmps_ix + (n) >= PL_tmps_max) \
394 tmps_grow(n); \
395 } STMT_END
bbce6d69 396
a0d0e21e
LW
397#define AMGf_noright 1
398#define AMGf_noleft 2
399#define AMGf_assign 4
400#define AMGf_unary 8
401
eb87d5ef 402#define tryAMAGICbinW_var(meth_enum,assign,set) STMT_START { \
fabdb6c0
AL
403 SV* const left = *(sp-1); \
404 SV* const right = *(sp); \
405 if ((SvAMAGIC(left)||SvAMAGIC(right))) {\
406 SV * const tmpsv = amagic_call(left, \
a0d0e21e 407 right, \
17ab7946 408 (meth_enum), \
fabdb6c0
AL
409 (assign)? AMGf_assign: 0); \
410 if (tmpsv) { \
411 SPAGAIN; \
412 (void)POPs; set(tmpsv); RETURN; } \
413 } \
86547924 414 } STMT_END
a0d0e21e 415
eb87d5ef
NC
416#define tryAMAGICbinW(meth,assign,set) \
417 tryAMAGICbinW_var(CAT2(meth,_amg),assign,set)
418
3658c1f1
NC
419#define tryAMAGICbin_var(meth_enum,assign) \
420 tryAMAGICbinW_var(meth_enum,assign,SETsv)
421#define tryAMAGICbin(meth,assign) \
422 tryAMAGICbin_var(CAT2(meth,_amg),assign)
423
a0d0e21e
LW
424#define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
425
eb87d5ef
NC
426#define tryAMAGICbinSET_var(meth_enum,assign) \
427 tryAMAGICbinW_var(meth_enum,assign,SETs)
428
8a67133a
NC
429#define AMG_CALLun_var(sv,meth_enum) amagic_call(sv,&PL_sv_undef, \
430 meth_enum,AMGf_noright | AMGf_unary)
431#define AMG_CALLun(sv,meth) AMG_CALLun_var(sv,CAT2(meth,_amg))
432
a0d0e21e
LW
433#define AMG_CALLbinL(left,right,meth) \
434 amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
435
8a67133a 436#define tryAMAGICunW_var(meth_enum,set,shift,ret) STMT_START { \
a0d0e21e 437 SV* tmpsv; \
f5284f61 438 SV* arg= sp[shift]; \
c4459e09 439 if(0) goto am_again; /* shut up unused warning */ \
f5284f61 440 am_again: \
a0d0e21e 441 if ((SvAMAGIC(arg))&&\
17ab7946 442 (tmpsv=AMG_CALLun_var(arg,(meth_enum)))) {\
f5284f61 443 SPAGAIN; if (shift) sp += shift; \
e8c20960 444 set(tmpsv); ret; } \
86547924 445 } STMT_END
8a67133a
NC
446#define tryAMAGICunW(meth,set,shift,ret) \
447 tryAMAGICunW_var(CAT2(meth,_amg),set,shift,ret)
a0d0e21e 448
f5284f61
IZ
449#define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
450
8a67133a
NC
451#define tryAMAGICun_var(meth_enum) tryAMAGICunW_var(meth_enum,SETsvUN,0,RETURN)
452#define tryAMAGICun(meth) tryAMAGICun_var(CAT2(meth,_amg))
b162f9ea 453#define tryAMAGICunSET(meth) tryAMAGICunW(meth,SETs,0,RETURN)
f5284f61 454#define tryAMAGICunTARGET(meth, shift) \
16e7e110 455 STMT_START { dSP; sp--; /* get TARGET from below PL_stack_sp */ \
f5284f61 456 { dTARGETSTACKED; \
16e7e110
TH
457 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}} STMT_END
458
459#define setAGAIN(ref) \
460 STMT_START { \
461 sv = ref; \
462 if (!SvROK(ref)) \
463 Perl_croak(aTHX_ "Overloaded dereference did not return a reference"); \
464 if (ref != arg && SvRV(ref) != SvRV(arg)) { \
465 arg = ref; \
466 goto am_again; \
467 } \
468 } STMT_END
e8c20960 469
0f4592ef 470#define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
17ab7946
NC
471#define tryAMAGICunDEREF_var(meth_enum) \
472 tryAMAGICunW_var(meth_enum,setAGAIN,0,(void)0)
a0d0e21e 473
533c011a 474#define opASSIGN (PL_op->op_flags & OPf_STACKED)
e9905555 475#define SETsv(sv) STMT_START { \
b162f9ea
IZ
476 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY)) \
477 { sv_setsv(TARG, (sv)); SETTARG; } \
478 else SETs(sv); } STMT_END
479
480#define SETsvUN(sv) STMT_START { \
481 if (SvFLAGS(TARG) & SVs_PADMY) \
482 { sv_setsv(TARG, (sv)); SETTARG; } \
e9905555 483 else SETs(sv); } STMT_END
a0d0e21e
LW
484
485/* newSVsv does not behave as advertised, so we copy missing
486 * information by hand */
487
76e3520e
GS
488/* SV* ref causes confusion with the member variable
489 changed SV* ref to SV* tmpRef */
490#define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); \
491 if (SvREFCNT(tmpRef)>1) { \
b162af07 492 SvRV_set(rv, AMG_CALLun(rv,copy)); \
76e3520e 493 SvREFCNT_dec(tmpRef); \
86547924 494 } } STMT_END
78f9721b
SM
495
496/*
497=for apidoc mU||LVRET
498True if this op will be the return value of an lvalue subroutine
499
500=cut */
9d96b2e7 501#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
1b6737cc
AL
502
503/*
504 * Local variables:
505 * c-indentation-style: bsd
506 * c-basic-offset: 4
507 * indent-tabs-mode: t
508 * End:
509 *
510 * ex: set ts=8 sts=4 sw=4 noet:
511 */