This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
utf8.h: Add macro synonym
[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
d0554719
TC
116=for apidoc Amn|UV|POPu
117Pops an unsigned integer off the stack.
118
954c1994
GS
119=for apidoc Amn|long|POPl
120Pops a long off the stack.
121
d0554719
TC
122=for apidoc Amn|long|POPul
123Pops an unsigned long off the stack.
124
954c1994
GS
125=cut
126*/
127
3280af22 128#define PUTBACK PL_stack_sp = sp
8a67133a
NC
129#define RETURN return (PUTBACK, NORMAL)
130#define RETURNOP(o) return (PUTBACK, o)
131#define RETURNX(x) return (x, PUTBACK, NORMAL)
79072805
LW
132
133#define POPs (*sp--)
4b7c0884 134#define POPp POPpx
8c074e2a
NC
135#define POPpx (SvPVx_nolen(POPs))
136#define POPpconstx (SvPVx_nolen_const(POPs))
137#define POPpbytex (SvPVbytex_nolen(POPs))
463ee0b2 138#define POPn (SvNVx(POPs))
a0d0e21e 139#define POPi ((IV)SvIVx(POPs))
ff68c719 140#define POPu ((UV)SvUVx(POPs))
463ee0b2 141#define POPl ((long)SvIVx(POPs))
d9b3e12d 142#define POPul ((unsigned long)SvIVx(POPs))
79072805
LW
143
144#define TOPs (*sp)
56370e9f 145#define TOPm1s (*(sp-1))
7dca457a 146#define TOPp1s (*(sp+1))
4b7c0884 147#define TOPp TOPpx
95fad918 148#define TOPpx (SvPV_nolen(TOPs))
463ee0b2 149#define TOPn (SvNV(TOPs))
a0d0e21e 150#define TOPi ((IV)SvIV(TOPs))
ff68c719 151#define TOPu ((UV)SvUV(TOPs))
463ee0b2 152#define TOPl ((long)SvIV(TOPs))
c5a0f51a 153#define TOPul ((unsigned long)SvUV(TOPs))
79072805
LW
154
155/* Go to some pains in the rare event that we must extend the stack. */
954c1994
GS
156
157/*
fc16c392 158=for apidoc Am|void|EXTEND|SP|SSize_t nitems
72d33970 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
865e3ae0 280#ifdef STRESS_REALLOC
aad79b33
JH
281# define EXTEND(p,n) STMT_START { \
282 sp = stack_grow(sp,p,(SSize_t) (n)); \
283 PERL_UNUSED_VAR(sp); \
8094bfa4 284 } STMT_END
865e3ae0 285/* Same thing, but update mark register too. */
aad79b33 286# define MEXTEND(p,n) STMT_START { \
ff36bb50 287 const SSize_t markoff = mark - PL_stack_base; \
8094bfa4 288 sp = stack_grow(sp,p,(SSize_t) (n)); \
aad79b33
JH
289 mark = PL_stack_base + markoff; \
290 PERL_UNUSED_VAR(sp); \
291 } STMT_END
865e3ae0 292#else
aad79b33 293# define EXTEND(p,n) STMT_START { \
ff36bb50 294 if (UNLIKELY(PL_stack_max - p < (SSize_t)(n))) { \
aad79b33
JH
295 sp = stack_grow(sp,p,(SSize_t) (n)); \
296 PERL_UNUSED_VAR(sp); \
297 } } STMT_END
79072805 298/* Same thing, but update mark register too. */
aad79b33 299# define MEXTEND(p,n) STMT_START { \
ff36bb50
HS
300 if (UNLIKELY(PL_stack_max - p < (SSize_t)(n))) { \
301 const SSize_t markoff = mark - PL_stack_base; \
aad79b33
JH
302 sp = stack_grow(sp,p,(SSize_t) (n)); \
303 mark = PL_stack_base + markoff; \
304 PERL_UNUSED_VAR(sp); \
305 } } STMT_END
865e3ae0 306#endif
79072805
LW
307
308#define PUSHs(s) (*++sp = (s))
86547924
PP
309#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
310#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
65202027 311#define PUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
86547924 312#define PUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
55497cff 313#define PUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
79072805 314
0acfb02f 315#define XPUSHs(s) STMT_START { EXTEND(sp,1); *++sp = (s); } STMT_END
86547924
PP
316#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
317#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
65202027 318#define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
86547924 319#define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
55497cff 320#define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
b162f9ea 321#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805 322
6e449a3a 323#define mPUSHs(s) PUSHs(sv_2mortal(s))
2cc7004b 324#define PUSHmortal PUSHs(sv_newmortal())
8f14ea01 325#define mPUSHp(p,l) PUSHs(newSVpvn_flags((p), (l), SVs_TEMP))
121b7712
MHM
326#define mPUSHn(n) sv_setnv(PUSHmortal, (NV)(n))
327#define mPUSHi(i) sv_setiv(PUSHmortal, (IV)(i))
328#define mPUSHu(u) sv_setuv(PUSHmortal, (UV)(u))
2cc7004b 329
6e449a3a 330#define mXPUSHs(s) XPUSHs(sv_2mortal(s))
2cc7004b 331#define XPUSHmortal XPUSHs(sv_newmortal())
8f14ea01 332#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); mPUSHp((p), (l)); } STMT_END
121b7712
MHM
333#define mXPUSHn(n) STMT_START { EXTEND(sp,1); sv_setnv(PUSHmortal, (NV)(n)); } STMT_END
334#define mXPUSHi(i) STMT_START { EXTEND(sp,1); sv_setiv(PUSHmortal, (IV)(i)); } STMT_END
335#define mXPUSHu(u) STMT_START { EXTEND(sp,1); sv_setuv(PUSHmortal, (UV)(u)); } STMT_END
d82b684c 336
79072805 337#define SETs(s) (*sp = s)
86547924
PP
338#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
339#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
65202027 340#define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
86547924 341#define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
55497cff 342#define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
a0d0e21e 343
79072805
LW
344#define dTOPss SV *sv = TOPs
345#define dPOPss SV *sv = POPs
65202027
DS
346#define dTOPnv NV value = TOPn
347#define dPOPnv NV value = POPn
6f1401dc 348#define dPOPnv_nomg NV value = (sp--, SvNV_nomg(TOPp1s))
a0d0e21e
LW
349#define dTOPiv IV value = TOPi
350#define dPOPiv IV value = POPi
55497cff
PP
351#define dTOPuv UV value = TOPu
352#define dPOPuv UV value = POPu
79072805 353
7a4c00b4 354#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 355#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
356#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
357
358#define USE_LEFT(sv) \
6b349a5c 359 (SvOK(sv) || !(PL_op->op_flags & OPf_STACKED))
6f1401dc 360#define dPOPXiirl_ul_nomg(X) \
096c060c 361 IV right = (sp--, SvIV_nomg(TOPp1s)); \
6f1401dc 362 SV *leftsv = CAT2(X,s); \
096c060c 363 IV left = USE_LEFT(leftsv) ? SvIV_nomg(leftsv) : 0
7a4c00b4
PP
364
365#define dPOPPOPssrl dPOPXssrl(POP)
366#define dPOPPOPnnrl dPOPXnnrl(POP)
7a4c00b4 367#define dPOPPOPiirl dPOPXiirl(POP)
7a4c00b4
PP
368
369#define dPOPTOPssrl dPOPXssrl(TOP)
370#define dPOPTOPnnrl dPOPXnnrl(TOP)
6f1401dc
DM
371#define dPOPTOPnnrl_nomg \
372 NV right = SvNV_nomg(TOPs); NV left = (sp--, SvNV_nomg(TOPs))
7a4c00b4 373#define dPOPTOPiirl dPOPXiirl(TOP)
6f1401dc
DM
374#define dPOPTOPiirl_ul_nomg dPOPXiirl_ul_nomg(TOP)
375#define dPOPTOPiirl_nomg \
096c060c 376 IV right = SvIV_nomg(TOPs); IV left = (sp--, SvIV_nomg(TOPs))
79072805 377
3280af22
NIS
378#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
379#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
380#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 381
3280af22
NIS
382#define RETSETYES RETURNX(SETs(&PL_sv_yes))
383#define RETSETNO RETURNX(SETs(&PL_sv_no))
384#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
5d01050a 385#define RETSETTARG STMT_START { SETTARG; RETURN; } STMT_END
79072805 386
533c011a 387#define ARGTARG PL_op->op_targ
b162f9ea 388
f3574cc6 389#define MAXARG (PL_op->op_private & OPpARG4_MASK)
79072805 390
e336de0d
GS
391#define SWITCHSTACK(f,t) \
392 STMT_START { \
677b06e3 393 AvFILLp(f) = sp - PL_stack_base; \
3280af22 394 PL_stack_base = AvARRAY(t); \
677b06e3 395 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 396 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 397 PL_curstack = t; \
e336de0d 398 } STMT_END
79072805 399
bbce6d69 400#define EXTEND_MORTAL(n) \
a953aca5
DD
401 STMT_START { \
402 SSize_t eMiX = PL_tmps_ix + (n); \
403 if (UNLIKELY(eMiX >= PL_tmps_max)) \
dc9a870f 404 (void)Perl_tmps_grow_p(aTHX_ eMiX); \
677b06e3 405 } STMT_END
bbce6d69 406
a0d0e21e
LW
407#define AMGf_noright 1
408#define AMGf_noleft 2
409#define AMGf_assign 4
410#define AMGf_unary 8
6f1401dc
DM
411#define AMGf_numeric 0x10 /* for Perl_try_amagic_bin */
412#define AMGf_set 0x20 /* for Perl_try_amagic_bin */
67288365 413#define AMGf_want_list 0x40
636ac8fc 414#define AMGf_numarg 0x80
6f1401dc
DM
415
416
417/* do SvGETMAGIC on the stack args before checking for overload */
418
419#define tryAMAGICun_MG(method, flags) STMT_START { \
5d9574c1 420 if ( UNLIKELY((SvFLAGS(TOPs) & (SVf_ROK|SVs_GMG))) \
6f1401dc
DM
421 && Perl_try_amagic_un(aTHX_ method, flags)) \
422 return NORMAL; \
423 } STMT_END
424#define tryAMAGICbin_MG(method, flags) STMT_START { \
5d9574c1 425 if ( UNLIKELY(((SvFLAGS(TOPm1s)|SvFLAGS(TOPs)) & (SVf_ROK|SVs_GMG))) \
6f1401dc
DM
426 && Perl_try_amagic_bin(aTHX_ method, flags)) \
427 return NORMAL; \
428 } STMT_END
429
31d632c3
DM
430#define AMG_CALLunary(sv,meth) \
431 amagic_call(sv,&PL_sv_undef, meth, AMGf_noright | AMGf_unary)
432
433/* No longer used in core. Use AMG_CALLunary instead */
434#define AMG_CALLun(sv,meth) AMG_CALLunary(sv, CAT2(meth,_amg))
a0d0e21e 435
fc99edcf 436#define tryAMAGICunTARGETlist(meth, jump) \
9f39b4f1 437 STMT_START { \
b5c08826
DM
438 dSP; \
439 SV *tmpsv; \
fc99edcf 440 SV *arg= *sp; \
67288365 441 int gimme = GIMME_V; \
5d9574c1 442 if (UNLIKELY(SvAMAGIC(arg) && \
b5c08826 443 (tmpsv = amagic_call(arg, &PL_sv_undef, meth, \
05fbd38d 444 AMGf_want_list | AMGf_noright \
5d9574c1
DM
445 |AMGf_unary)))) \
446 { \
b5c08826 447 SPAGAIN; \
67288365 448 if (gimme == G_VOID) { \
898c5644 449 NOOP; \
67288365 450 } \
05fbd38d 451 else if (gimme == G_ARRAY) { \
c70927a6
FC
452 SSize_t i; \
453 SSize_t len; \
67288365 454 assert(SvTYPE(tmpsv) == SVt_PVAV); \
b9f2b683 455 len = av_tindex((AV *)tmpsv) + 1; \
67288365
JL
456 (void)POPs; /* get rid of the arg */ \
457 EXTEND(sp, len); \
458 for (i = 0; i < len; ++i) \
459 PUSHs(av_shift((AV *)tmpsv)); \
460 } \
461 else { /* AMGf_want_scalar */ \
462 dATARGET; /* just use the arg's location */ \
463 sv_setsv(TARG, tmpsv); \
464 if (opASSIGN) \
465 sp--; \
466 SETTARG; \
467 } \
b5c08826
DM
468 PUTBACK; \
469 if (jump) { \
86e5639b
GG
470 OP *jump_o = NORMAL->op_next; \
471 while (jump_o->op_type == OP_NULL) \
472 jump_o = jump_o->op_next; \
473 assert(jump_o->op_type == OP_ENTERSUB); \
b5c08826 474 PL_markstack_ptr--; \
86e5639b 475 return jump_o->op_next; \
9f39b4f1 476 } \
b5c08826
DM
477 return NORMAL; \
478 } \
9f39b4f1
NC
479 } STMT_END
480
8897dcaa
NC
481/* This is no longer used anywhere in the core. You might wish to consider
482 calling amagic_deref_call() directly, as it has a cleaner interface. */
483#define tryAMAGICunDEREF(meth) \
9f39b4f1 484 STMT_START { \
e89bfaa6 485 sv = amagic_deref_call(*sp, CAT2(meth,_amg)); \
25a9ffce 486 SPAGAIN; \
16e7e110 487 } STMT_END
e8c20960 488
180b7b9b 489
533c011a 490#define opASSIGN (PL_op->op_flags & OPf_STACKED)
a0d0e21e 491
78f9721b
SM
492/*
493=for apidoc mU||LVRET
494True if this op will be the return value of an lvalue subroutine
495
496=cut */
9d96b2e7 497#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
1b6737cc 498
d30e492c
VP
499#define SvCANEXISTDELETE(sv) \
500 (!SvRMAGICAL(sv) \
2c5f48c2
FC
501 || !(mg = mg_find((const SV *) sv, PERL_MAGIC_tied)) \
502 || ( (stash = SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(sv), mg)))) \
d30e492c
VP
503 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
504 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
505 ) \
506 )
507
d682515d 508#ifdef PERL_CORE
557fbd17 509
d682515d
NC
510/* These are just for Perl_tied_method(), which is not part of the public API.
511 Use 0x04 rather than the next available bit, to help the compiler if the
512 architecture can generate more efficient instructions. */
513# define TIED_METHOD_MORTALIZE_NOT_NEEDED 0x04
514# define TIED_METHOD_ARGUMENTS_ON_STACK 0x08
94bc412f 515# define TIED_METHOD_SAY 0x10
557fbd17
FC
516
517/* Used in various places that need to dereference a glob or globref */
094a3eec 518# define MAYBE_DEREF_GV_flags(sv,phlags) \
557fbd17 519 ( \
094a3eec 520 (void)(phlags & SV_GMAGIC && (SvGETMAGIC(sv),0)), \
557fbd17 521 isGV_with_GP(sv) \
4e794a06 522 ? (GV *)(sv) \
f8afbfa6
FC
523 : SvROK(sv) && SvTYPE(SvRV(sv)) <= SVt_PVLV && \
524 (SvGETMAGIC(SvRV(sv)), isGV_with_GP(SvRV(sv))) \
557fbd17
FC
525 ? (GV *)SvRV(sv) \
526 : NULL \
527 )
094a3eec
FC
528# define MAYBE_DEREF_GV(sv) MAYBE_DEREF_GV_flags(sv,SV_GMAGIC)
529# define MAYBE_DEREF_GV_nomg(sv) MAYBE_DEREF_GV_flags(sv,0)
557fbd17 530
db4cf31d 531# define FIND_RUNCV_padid_eq 1
b4b0692a 532# define FIND_RUNCV_level_eq 2
70794f7b 533
d682515d
NC
534#endif
535
1b6737cc 536/*
14d04a33 537 * ex: set ts=8 sts=4 sw=4 et:
1b6737cc 538 */