This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regen/embed.pl: Generally generate an ARGS_ASSERT
[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
78342678 16=for apidoc AmnU||SP
fbe13c60 17Stack pointer. This is usually handled by C<xsubpp>. See C<L</dSP>> and
954c1994
GS
18C<SPAGAIN>.
19
78342678 20=for apidoc AmnU||MARK
fbe13c60 21Stack marker variable for the XSUB. See C<L</dMARK>>.
954c1994 22
c578083c 23=for apidoc Am|void|PUSHMARK|SP
fbe13c60 24Opening bracket for arguments on a callback. See C<L</PUTBACK>> and
954c1994
GS
25L<perlcall>.
26
4e5171e9 27=for apidoc Amns||dSP
954c1994 28Declares a local copy of perl's stack pointer for the XSUB, available via
fbe13c60 29the C<SP> macro. See C<L</SP>>.
954c1994 30
fac3506f
MS
31=for apidoc ms||djSP
32
154e47c8 33Declare Just C<SP>. This is actually identical to C<dSP>, and declares
fac3506f 34a local copy of perl's stack pointer, available via the C<SP> macro.
fbe13c60
KW
35See C<L<perlapi/SP>>. (Available for backward source code compatibility with
36the old (Perl 5.005) thread model.)
fac3506f 37
4e5171e9 38=for apidoc Amns||dMARK
fbe13c60
KW
39Declare a stack marker variable, C<mark>, for the XSUB. See C<L</MARK>> and
40C<L</dORIGMARK>>.
954c1994 41
4e5171e9 42=for apidoc Amns||dORIGMARK
fbe13c60 43Saves the original stack mark for the XSUB. See C<L</ORIGMARK>>.
954c1994 44
78342678 45=for apidoc AmnU||ORIGMARK
fbe13c60 46The original stack mark for the XSUB. See C<L</dORIGMARK>>.
954c1994 47
4e5171e9 48=for apidoc Amns||SPAGAIN
954c1994
GS
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
33a4312b 58#define PUSHMARK(p) \
6cae08a8
RU
59 STMT_START { \
60 I32 * mark_stack_entry; \
6d8b7216
DM
61 if (UNLIKELY((mark_stack_entry = ++PL_markstack_ptr) \
62 == PL_markstack_max)) \
6cae08a8
RU
63 mark_stack_entry = markstack_grow(); \
64 *mark_stack_entry = (I32)((p) - PL_stack_base); \
ac07059a 65 DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log, \
147e3846 66 "MARK push %p %" IVdf "\n", \
ac07059a 67 PL_markstack_ptr, (IV)*mark_stack_entry))); \
6cae08a8 68 } STMT_END
6d8b7216 69
33a4312b
FC
70#define TOPMARK S_TOPMARK(aTHX)
71#define POPMARK S_POPMARK(aTHX)
6d8b7216 72
33a4312b
FC
73#define INCMARK \
74 STMT_START { \
ac07059a 75 DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log, \
147e3846 76 "MARK inc %p %" IVdf "\n", \
ac07059a 77 (PL_markstack_ptr+1), (IV)*(PL_markstack_ptr+1)))); \
33a4312b 78 PL_markstack_ptr++; \
6cae08a8 79 } STMT_END
a0d0e21e 80
bc0d193f 81#define dSP SV **sp = PL_stack_sp
39644a26 82#define djSP dSP
5aaab254 83#define dMARK SV **mark = PL_stack_base + POPMARK
514696af 84#define dORIGMARK const I32 origmark = (I32)(mark - PL_stack_base)
3280af22 85#define ORIGMARK (PL_stack_base + origmark)
79072805 86
3280af22 87#define SPAGAIN sp = PL_stack_sp
16e7e110 88#define MSPAGAIN STMT_START { sp = PL_stack_sp; mark = ORIGMARK; } STMT_END
79072805 89
533c011a 90#define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
79072805
LW
91#define dTARGETSTACKED SV * GETTARGETSTACKED
92
533c011a 93#define GETTARGET targ = PAD_SV(PL_op->op_targ)
79072805
LW
94#define dTARGET SV * GETTARGET
95
533c011a 96#define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
79072805
LW
97#define dATARGET SV * GETATARGET
98
99#define dTARG SV *targ
100
533c011a 101#define NORMAL PL_op->op_next
9fed9930 102#define DIE return Perl_die
79072805 103
954c1994 104/*
4e5171e9 105=for apidoc Amns||PUTBACK
954c1994 106Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
fbe13c60 107See C<L</PUSHMARK>> and L<perlcall> for other uses.
954c1994
GS
108
109=for apidoc Amn|SV*|POPs
110Pops an SV off the stack.
111
112=for apidoc Amn|char*|POPp
4b7c0884 113Pops a string off the stack.
595ae481
NIS
114
115=for apidoc Amn|char*|POPpx
4b7c0884
FC
116Pops a string off the stack. Identical to POPp. There are two names for
117historical reasons.
595ae481
NIS
118
119=for apidoc Amn|char*|POPpbytex
120Pops a string off the stack which must consist of bytes i.e. characters < 256.
954c1994
GS
121
122=for apidoc Amn|NV|POPn
123Pops a double off the stack.
124
125=for apidoc Amn|IV|POPi
126Pops an integer off the stack.
127
d0554719
TC
128=for apidoc Amn|UV|POPu
129Pops an unsigned integer off the stack.
130
954c1994
GS
131=for apidoc Amn|long|POPl
132Pops a long off the stack.
133
d0554719
TC
134=for apidoc Amn|long|POPul
135Pops an unsigned long off the stack.
136
954c1994
GS
137=cut
138*/
139
3280af22 140#define PUTBACK PL_stack_sp = sp
8a67133a
NC
141#define RETURN return (PUTBACK, NORMAL)
142#define RETURNOP(o) return (PUTBACK, o)
143#define RETURNX(x) return (x, PUTBACK, NORMAL)
79072805
LW
144
145#define POPs (*sp--)
4b7c0884 146#define POPp POPpx
8c074e2a
NC
147#define POPpx (SvPVx_nolen(POPs))
148#define POPpconstx (SvPVx_nolen_const(POPs))
149#define POPpbytex (SvPVbytex_nolen(POPs))
463ee0b2 150#define POPn (SvNVx(POPs))
a0d0e21e 151#define POPi ((IV)SvIVx(POPs))
ff68c719 152#define POPu ((UV)SvUVx(POPs))
463ee0b2 153#define POPl ((long)SvIVx(POPs))
d9b3e12d 154#define POPul ((unsigned long)SvIVx(POPs))
79072805
LW
155
156#define TOPs (*sp)
56370e9f 157#define TOPm1s (*(sp-1))
7dca457a 158#define TOPp1s (*(sp+1))
4b7c0884 159#define TOPp TOPpx
95fad918 160#define TOPpx (SvPV_nolen(TOPs))
463ee0b2 161#define TOPn (SvNV(TOPs))
a0d0e21e 162#define TOPi ((IV)SvIV(TOPs))
ff68c719 163#define TOPu ((UV)SvUV(TOPs))
463ee0b2 164#define TOPl ((long)SvIV(TOPs))
c5a0f51a 165#define TOPul ((unsigned long)SvUV(TOPs))
79072805
LW
166
167/* Go to some pains in the rare event that we must extend the stack. */
954c1994
GS
168
169/*
fc16c392 170=for apidoc Am|void|EXTEND|SP|SSize_t nitems
72d33970 171Used to extend the argument stack for an XSUB's return values. Once
4375e838 172used, guarantees that there is room for at least C<nitems> to be pushed
954c1994
GS
173onto the stack.
174
175=for apidoc Am|void|PUSHs|SV* sv
aacdac46 176Push an SV onto the stack. The stack must have room for this element.
fbe13c60
KW
177Does not handle 'set' magic. Does not use C<TARG>. See also
178C<L</PUSHmortal>>, C<L</XPUSHs>>, and C<L</XPUSHmortal>>.
954c1994
GS
179
180=for apidoc Am|void|PUSHp|char* str|STRLEN len
181Push a string onto the stack. The stack must have room for this element.
d82b684c
SH
182The C<len> indicates the length of the string. Handles 'set' magic. Uses
183C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
184call multiple C<TARG>-oriented macros to return lists from XSUB's - see
fbe13c60 185C<L</mPUSHp>> instead. See also C<L</XPUSHp>> and C<L</mXPUSHp>>.
954c1994
GS
186
187=for apidoc Am|void|PUSHn|NV nv
188Push a double onto the stack. The stack must have room for this element.
d82b684c
SH
189Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
190called to declare it. Do not call multiple C<TARG>-oriented macros to
fbe13c60
KW
191return lists from XSUB's - see C<L</mPUSHn>> instead. See also C<L</XPUSHn>>
192and C<L</mXPUSHn>>.
954c1994
GS
193
194=for apidoc Am|void|PUSHi|IV iv
195Push an integer onto the stack. The stack must have room for this element.
d82b684c
SH
196Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
197called to declare it. Do not call multiple C<TARG>-oriented macros to
fbe13c60
KW
198return lists from XSUB's - see C<L</mPUSHi>> instead. See also C<L</XPUSHi>>
199and C<L</mXPUSHi>>.
954c1994
GS
200
201=for apidoc Am|void|PUSHu|UV uv
202Push an unsigned integer onto the stack. The stack must have room for this
d82b684c
SH
203element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
204should be called to declare it. Do not call multiple C<TARG>-oriented
fbe13c60
KW
205macros to return lists from XSUB's - see C<L</mPUSHu>> instead. See also
206C<L</XPUSHu>> and C<L</mXPUSHu>>.
954c1994
GS
207
208=for apidoc Am|void|XPUSHs|SV* sv
209Push an SV onto the stack, extending the stack if necessary. Does not
fbe13c60 210handle 'set' magic. Does not use C<TARG>. See also C<L</XPUSHmortal>>,
d82b684c 211C<PUSHs> and C<PUSHmortal>.
954c1994
GS
212
213=for apidoc Am|void|XPUSHp|char* str|STRLEN len
214Push a string onto the stack, extending the stack if necessary. The C<len>
d82b684c
SH
215indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
216C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
217multiple C<TARG>-oriented macros to return lists from XSUB's - see
fbe13c60 218C<L</mXPUSHp>> instead. See also C<L</PUSHp>> and C<L</mPUSHp>>.
954c1994
GS
219
220=for apidoc Am|void|XPUSHn|NV nv
221Push a double onto the stack, extending the stack if necessary. Handles
d82b684c
SH
222'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
223declare it. Do not call multiple C<TARG>-oriented macros to return lists
fbe13c60
KW
224from XSUB's - see C<L</mXPUSHn>> instead. See also C<L</PUSHn>> and
225C<L</mPUSHn>>.
954c1994
GS
226
227=for apidoc Am|void|XPUSHi|IV iv
228Push an integer onto the stack, extending the stack if necessary. Handles
d82b684c
SH
229'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
230declare it. Do not call multiple C<TARG>-oriented macros to return lists
fbe13c60
KW
231from XSUB's - see C<L</mXPUSHi>> instead. See also C<L</PUSHi>> and
232C<L</mPUSHi>>.
954c1994
GS
233
234=for apidoc Am|void|XPUSHu|UV uv
aacdac46 235Push an unsigned integer onto the stack, extending the stack if necessary.
d82b684c
SH
236Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
237called to declare it. Do not call multiple C<TARG>-oriented macros to
fbe13c60
KW
238return lists from XSUB's - see C<L</mXPUSHu>> instead. See also C<L</PUSHu>> and
239C<L</mPUSHu>>.
d82b684c 240
6e449a3a
MHM
241=for apidoc Am|void|mPUSHs|SV* sv
242Push an SV onto the stack and mortalizes the SV. The stack must have room
fbe13c60
KW
243for this element. Does not use C<TARG>. See also C<L</PUSHs>> and
244C<L</mXPUSHs>>.
6e449a3a 245
78342678 246=for apidoc Amn|void|PUSHmortal
d82b684c 247Push a new mortal SV onto the stack. The stack must have room for this
fbe13c60
KW
248element. Does not use C<TARG>. See also C<L</PUSHs>>, C<L</XPUSHmortal>> and
249C<L</XPUSHs>>.
d82b684c
SH
250
251=for apidoc Am|void|mPUSHp|char* str|STRLEN len
252Push a string onto the stack. The stack must have room for this element.
121b7712 253The C<len> indicates the length of the string. Does not use C<TARG>.
fbe13c60 254See also C<L</PUSHp>>, C<L</mXPUSHp>> and C<L</XPUSHp>>.
d82b684c
SH
255
256=for apidoc Am|void|mPUSHn|NV nv
257Push a double onto the stack. The stack must have room for this element.
fbe13c60 258Does not use C<TARG>. See also C<L</PUSHn>>, C<L</mXPUSHn>> and C<L</XPUSHn>>.
d82b684c
SH
259
260=for apidoc Am|void|mPUSHi|IV iv
261Push an integer onto the stack. The stack must have room for this element.
fbe13c60 262Does not use C<TARG>. See also C<L</PUSHi>>, C<L</mXPUSHi>> and C<L</XPUSHi>>.
d82b684c
SH
263
264=for apidoc Am|void|mPUSHu|UV uv
265Push an unsigned integer onto the stack. The stack must have room for this
fbe13c60
KW
266element. Does not use C<TARG>. See also C<L</PUSHu>>, C<L</mXPUSHu>> and
267C<L</XPUSHu>>.
d82b684c 268
6e449a3a
MHM
269=for apidoc Am|void|mXPUSHs|SV* sv
270Push an SV onto the stack, extending the stack if necessary and mortalizes
fbe13c60 271the SV. Does not use C<TARG>. See also C<L</XPUSHs>> and C<L</mPUSHs>>.
6e449a3a 272
78342678 273=for apidoc Amn|void|XPUSHmortal
121b7712 274Push a new mortal SV onto the stack, extending the stack if necessary.
fbe13c60
KW
275Does not use C<TARG>. See also C<L</XPUSHs>>, C<L</PUSHmortal>> and
276C<L</PUSHs>>.
d82b684c
SH
277
278=for apidoc Am|void|mXPUSHp|char* str|STRLEN len
279Push a string onto the stack, extending the stack if necessary. The C<len>
fbe13c60
KW
280indicates the length of the string. Does not use C<TARG>. See also
281C<L</XPUSHp>>, C<mPUSHp> and C<PUSHp>.
d82b684c
SH
282
283=for apidoc Am|void|mXPUSHn|NV nv
121b7712 284Push a double onto the stack, extending the stack if necessary.
fbe13c60 285Does not use C<TARG>. See also C<L</XPUSHn>>, C<L</mPUSHn>> and C<L</PUSHn>>.
d82b684c
SH
286
287=for apidoc Am|void|mXPUSHi|IV iv
121b7712 288Push an integer onto the stack, extending the stack if necessary.
fbe13c60 289Does not use C<TARG>. See also C<L</XPUSHi>>, C<L</mPUSHi>> and C<L</PUSHi>>.
d82b684c
SH
290
291=for apidoc Am|void|mXPUSHu|UV uv
292Push an unsigned integer onto the stack, extending the stack if necessary.
fbe13c60 293Does not use C<TARG>. See also C<L</XPUSHu>>, C<L</mPUSHu>> and C<L</PUSHu>>.
954c1994
GS
294
295=cut
296*/
297
87058c31
DM
298/* EXTEND_HWM_SET: note the high-water-mark to which the stack has been
299 * requested to be extended (which is likely to be less than PL_stack_max)
300 */
301#if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
302# define EXTEND_HWM_SET(p, n) \
303 STMT_START { \
304 SSize_t ix = (p) - PL_stack_base + (n); \
305 if (ix > PL_curstackinfo->si_stack_hwm) \
306 PL_curstackinfo->si_stack_hwm = ix; \
307 } STMT_END
308#else
309# define EXTEND_HWM_SET(p, n) NOOP
310#endif
311
6768377c
DM
312/* _EXTEND_SAFE_N(n): private helper macro for EXTEND().
313 * Tests whether the value of n would be truncated when implicitly cast to
314 * SSize_t as an arg to stack_grow(). If so, sets it to -1 instead to
315 * trigger a panic. It will be constant folded on platforms where this
316 * can't happen.
317 */
318
319#define _EXTEND_SAFE_N(n) \
320 (sizeof(n) > sizeof(SSize_t) && ((SSize_t)(n) != (n)) ? -1 : (n))
321
865e3ae0 322#ifdef STRESS_REALLOC
87058c31
DM
323# define EXTEND_SKIP(p, n) EXTEND_HWM_SET(p, n)
324
aad79b33 325# define EXTEND(p,n) STMT_START { \
6768377c 326 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33 327 PERL_UNUSED_VAR(sp); \
8094bfa4 328 } STMT_END
865e3ae0 329/* Same thing, but update mark register too. */
aad79b33 330# define MEXTEND(p,n) STMT_START { \
ff36bb50 331 const SSize_t markoff = mark - PL_stack_base; \
6768377c 332 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33
JH
333 mark = PL_stack_base + markoff; \
334 PERL_UNUSED_VAR(sp); \
335 } STMT_END
865e3ae0 336#else
6768377c
DM
337
338/* _EXTEND_NEEDS_GROW(p,n): private helper macro for EXTEND().
339 * Tests to see whether n is too big and we need to grow the stack. Be
340 * very careful if modifying this. There are many ways to get things wrong
341 * (wrapping, truncating etc) that could cause a false negative and cause
342 * the call to stack_grow() to be skipped. On the other hand, false
343 * positives are safe.
344 * Bear in mind that sizeof(p) may be less than, equal to, or greater
345 * than sizeof(n), and while n is documented to be signed, someone might
346 * pass an unsigned value or expression. In general don't use casts to
347 * avoid warnings; instead expect the caller to fix their code.
348 * It is legal for p to be greater than PL_stack_max.
349 * If the allocated stack is already very large but current usage is
350 * small, then PL_stack_max - p might wrap round to a negative value, but
351 * this just gives a safe false positive
352 */
353
45d6bfc0 354# define _EXTEND_NEEDS_GROW(p,n) ((n) < 0 || PL_stack_max - (p) < (n))
87058c31
DM
355
356
357/* EXTEND_SKIP(): used for where you would normally call EXTEND(), but
358 * you know for sure that a previous op will have already extended the
359 * stack sufficiently. For example pp_enteriter ensures that that there
360 * is always at least 1 free slot, so pp_iter can return &PL_sv_yes/no
361 * without checking each time. Calling EXTEND_SKIP() defeats the HWM
362 * debugging mechanism which would otherwise whine
363 */
364
365# define EXTEND_SKIP(p, n) STMT_START { \
366 EXTEND_HWM_SET(p, n); \
367 assert(!_EXTEND_NEEDS_GROW(p,n)); \
368 } STMT_END
369
6768377c
DM
370
371# define EXTEND(p,n) STMT_START { \
87058c31 372 EXTEND_HWM_SET(p, n); \
6768377c
DM
373 if (UNLIKELY(_EXTEND_NEEDS_GROW(p,n))) { \
374 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33
JH
375 PERL_UNUSED_VAR(sp); \
376 } } STMT_END
79072805 377/* Same thing, but update mark register too. */
6768377c 378# define MEXTEND(p,n) STMT_START { \
87058c31 379 EXTEND_HWM_SET(p, n); \
6768377c
DM
380 if (UNLIKELY(_EXTEND_NEEDS_GROW(p,n))) { \
381 const SSize_t markoff = mark - PL_stack_base;\
382 sp = stack_grow(sp,p,_EXTEND_SAFE_N(n)); \
aad79b33
JH
383 mark = PL_stack_base + markoff; \
384 PERL_UNUSED_VAR(sp); \
385 } } STMT_END
865e3ae0 386#endif
79072805 387
87058c31 388
edba15b0
DM
389/* set TARG to the IV value i. If do_taint is false,
390 * assume that PL_tainted can never be true */
391#define TARGi(i, do_taint) \
392 STMT_START { \
393 IV TARGi_iv = i; \
394 if (LIKELY( \
2efdfb1e 395 ((SvFLAGS(TARG) & (SVTYPEMASK|SVf_THINKFIRST|SVf_IVisUV)) == SVt_IV) \
edba15b0
DM
396 & (do_taint ? !TAINT_get : 1))) \
397 { \
398 /* Cheap SvIOK_only(). \
399 * Assert that flags which SvIOK_only() would test or \
400 * clear can't be set, because we're SVt_IV */ \
401 assert(!(SvFLAGS(TARG) & \
402 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_IOK|SVp_IOK))))); \
403 SvFLAGS(TARG) |= (SVf_IOK|SVp_IOK); \
404 /* SvIV_set() where sv_any points to head */ \
405 TARG->sv_u.svu_iv = TARGi_iv; \
406 } \
407 else \
408 sv_setiv_mg(targ, TARGi_iv); \
409 } STMT_END
410
411/* set TARG to the UV value u. If do_taint is false,
412 * assume that PL_tainted can never be true */
413#define TARGu(u, do_taint) \
414 STMT_START { \
415 UV TARGu_uv = u; \
416 if (LIKELY( \
2efdfb1e 417 ((SvFLAGS(TARG) & (SVTYPEMASK|SVf_THINKFIRST|SVf_IVisUV)) == SVt_IV) \
edba15b0
DM
418 & (do_taint ? !TAINT_get : 1) \
419 & (TARGu_uv <= (UV)IV_MAX))) \
420 { \
421 /* Cheap SvIOK_only(). \
422 * Assert that flags which SvIOK_only() would test or \
423 * clear can't be set, because we're SVt_IV */ \
424 assert(!(SvFLAGS(TARG) & \
425 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_IOK|SVp_IOK))))); \
426 SvFLAGS(TARG) |= (SVf_IOK|SVp_IOK); \
427 /* SvIV_set() where sv_any points to head */ \
428 TARG->sv_u.svu_iv = TARGu_uv; \
429 } \
430 else \
431 sv_setuv_mg(targ, TARGu_uv); \
432 } STMT_END
433
434/* set TARG to the NV value n. If do_taint is false,
435 * assume that PL_tainted can never be true */
436#define TARGn(n, do_taint) \
437 STMT_START { \
438 NV TARGn_nv = n; \
439 if (LIKELY( \
440 ((SvFLAGS(TARG) & (SVTYPEMASK|SVf_THINKFIRST)) == SVt_NV) \
441 & (do_taint ? !TAINT_get : 1))) \
442 { \
443 /* Cheap SvNOK_only(). \
444 * Assert that flags which SvNOK_only() would test or \
445 * clear can't be set, because we're SVt_NV */ \
446 assert(!(SvFLAGS(TARG) & \
447 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_NOK|SVp_NOK))))); \
448 SvFLAGS(TARG) |= (SVf_NOK|SVp_NOK); \
449 SvNV_set(TARG, TARGn_nv); \
450 } \
451 else \
452 sv_setnv_mg(targ, TARGn_nv); \
453 } STMT_END
454
79072805 455#define PUSHs(s) (*++sp = (s))
86547924
PP
456#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
457#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
edba15b0
DM
458#define PUSHn(n) STMT_START { TARGn(n,1); PUSHs(TARG); } STMT_END
459#define PUSHi(i) STMT_START { TARGi(i,1); PUSHs(TARG); } STMT_END
460#define PUSHu(u) STMT_START { TARGu(u,1); PUSHs(TARG); } STMT_END
79072805 461
0acfb02f 462#define XPUSHs(s) STMT_START { EXTEND(sp,1); *++sp = (s); } STMT_END
86547924
PP
463#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
464#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
edba15b0
DM
465#define XPUSHn(n) STMT_START { TARGn(n,1); XPUSHs(TARG); } STMT_END
466#define XPUSHi(i) STMT_START { TARGi(i,1); XPUSHs(TARG); } STMT_END
467#define XPUSHu(u) STMT_START { TARGu(u,1); XPUSHs(TARG); } STMT_END
b162f9ea 468#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805 469
6e449a3a 470#define mPUSHs(s) PUSHs(sv_2mortal(s))
2cc7004b 471#define PUSHmortal PUSHs(sv_newmortal())
8f14ea01 472#define mPUSHp(p,l) PUSHs(newSVpvn_flags((p), (l), SVs_TEMP))
121b7712
MHM
473#define mPUSHn(n) sv_setnv(PUSHmortal, (NV)(n))
474#define mPUSHi(i) sv_setiv(PUSHmortal, (IV)(i))
475#define mPUSHu(u) sv_setuv(PUSHmortal, (UV)(u))
2cc7004b 476
6e449a3a 477#define mXPUSHs(s) XPUSHs(sv_2mortal(s))
2cc7004b 478#define XPUSHmortal XPUSHs(sv_newmortal())
8f14ea01 479#define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); mPUSHp((p), (l)); } STMT_END
2ca72cbe
EK
480#define mXPUSHn(n) STMT_START { EXTEND(sp,1); mPUSHn(n); } STMT_END
481#define mXPUSHi(i) STMT_START { EXTEND(sp,1); mPUSHi(i); } STMT_END
482#define mXPUSHu(u) STMT_START { EXTEND(sp,1); mPUSHu(u); } STMT_END
d82b684c 483
79072805 484#define SETs(s) (*sp = s)
86547924
PP
485#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
486#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
edba15b0
DM
487#define SETn(n) STMT_START { TARGn(n,1); SETs(TARG); } STMT_END
488#define SETi(i) STMT_START { TARGi(i,1); SETs(TARG); } STMT_END
489#define SETu(u) STMT_START { TARGu(u,1); SETs(TARG); } STMT_END
a0d0e21e 490
79072805
LW
491#define dTOPss SV *sv = TOPs
492#define dPOPss SV *sv = POPs
65202027
DS
493#define dTOPnv NV value = TOPn
494#define dPOPnv NV value = POPn
6f1401dc 495#define dPOPnv_nomg NV value = (sp--, SvNV_nomg(TOPp1s))
a0d0e21e
LW
496#define dTOPiv IV value = TOPi
497#define dPOPiv IV value = POPi
55497cff
PP
498#define dTOPuv UV value = TOPu
499#define dPOPuv UV value = POPu
79072805 500
7a4c00b4 501#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 502#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
503#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
504
505#define USE_LEFT(sv) \
6b349a5c 506 (SvOK(sv) || !(PL_op->op_flags & OPf_STACKED))
6f1401dc 507#define dPOPXiirl_ul_nomg(X) \
096c060c 508 IV right = (sp--, SvIV_nomg(TOPp1s)); \
6f1401dc 509 SV *leftsv = CAT2(X,s); \
096c060c 510 IV left = USE_LEFT(leftsv) ? SvIV_nomg(leftsv) : 0
7a4c00b4
PP
511
512#define dPOPPOPssrl dPOPXssrl(POP)
513#define dPOPPOPnnrl dPOPXnnrl(POP)
7a4c00b4 514#define dPOPPOPiirl dPOPXiirl(POP)
7a4c00b4
PP
515
516#define dPOPTOPssrl dPOPXssrl(TOP)
517#define dPOPTOPnnrl dPOPXnnrl(TOP)
6f1401dc
DM
518#define dPOPTOPnnrl_nomg \
519 NV right = SvNV_nomg(TOPs); NV left = (sp--, SvNV_nomg(TOPs))
7a4c00b4 520#define dPOPTOPiirl dPOPXiirl(TOP)
6f1401dc
DM
521#define dPOPTOPiirl_ul_nomg dPOPXiirl_ul_nomg(TOP)
522#define dPOPTOPiirl_nomg \
096c060c 523 IV right = SvIV_nomg(TOPs); IV left = (sp--, SvIV_nomg(TOPs))
79072805 524
3280af22
NIS
525#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
526#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
527#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 528
3280af22
NIS
529#define RETSETYES RETURNX(SETs(&PL_sv_yes))
530#define RETSETNO RETURNX(SETs(&PL_sv_no))
531#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
5d01050a 532#define RETSETTARG STMT_START { SETTARG; RETURN; } STMT_END
79072805 533
533c011a 534#define ARGTARG PL_op->op_targ
b162f9ea 535
f3574cc6 536#define MAXARG (PL_op->op_private & OPpARG4_MASK)
79072805 537
e336de0d
GS
538#define SWITCHSTACK(f,t) \
539 STMT_START { \
677b06e3 540 AvFILLp(f) = sp - PL_stack_base; \
3280af22 541 PL_stack_base = AvARRAY(t); \
677b06e3 542 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 543 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 544 PL_curstack = t; \
e336de0d 545 } STMT_END
79072805 546
bbce6d69 547#define EXTEND_MORTAL(n) \
a953aca5
DD
548 STMT_START { \
549 SSize_t eMiX = PL_tmps_ix + (n); \
550 if (UNLIKELY(eMiX >= PL_tmps_max)) \
dc9a870f 551 (void)Perl_tmps_grow_p(aTHX_ eMiX); \
677b06e3 552 } STMT_END
bbce6d69 553
a0d0e21e
LW
554#define AMGf_noright 1
555#define AMGf_noleft 2
72876cce 556#define AMGf_assign 4 /* op supports mutator variant, e.g. $x += 1 */
a0d0e21e 557#define AMGf_unary 8
6f1401dc 558#define AMGf_numeric 0x10 /* for Perl_try_amagic_bin */
0872de45 559
67288365 560#define AMGf_want_list 0x40
636ac8fc 561#define AMGf_numarg 0x80
6f1401dc
DM
562
563
564/* do SvGETMAGIC on the stack args before checking for overload */
565
566#define tryAMAGICun_MG(method, flags) STMT_START { \
5d9574c1 567 if ( UNLIKELY((SvFLAGS(TOPs) & (SVf_ROK|SVs_GMG))) \
6f1401dc
DM
568 && Perl_try_amagic_un(aTHX_ method, flags)) \
569 return NORMAL; \
570 } STMT_END
571#define tryAMAGICbin_MG(method, flags) STMT_START { \
5d9574c1 572 if ( UNLIKELY(((SvFLAGS(TOPm1s)|SvFLAGS(TOPs)) & (SVf_ROK|SVs_GMG))) \
6f1401dc
DM
573 && Perl_try_amagic_bin(aTHX_ method, flags)) \
574 return NORMAL; \
575 } STMT_END
576
31d632c3
DM
577#define AMG_CALLunary(sv,meth) \
578 amagic_call(sv,&PL_sv_undef, meth, AMGf_noright | AMGf_unary)
579
580/* No longer used in core. Use AMG_CALLunary instead */
581#define AMG_CALLun(sv,meth) AMG_CALLunary(sv, CAT2(meth,_amg))
a0d0e21e 582
fc99edcf 583#define tryAMAGICunTARGETlist(meth, jump) \
9f39b4f1 584 STMT_START { \
b5c08826
DM
585 dSP; \
586 SV *tmpsv; \
fc99edcf 587 SV *arg= *sp; \
1c23e2bd 588 U8 gimme = GIMME_V; \
5d9574c1 589 if (UNLIKELY(SvAMAGIC(arg) && \
b5c08826 590 (tmpsv = amagic_call(arg, &PL_sv_undef, meth, \
05fbd38d 591 AMGf_want_list | AMGf_noright \
5d9574c1
DM
592 |AMGf_unary)))) \
593 { \
b5c08826 594 SPAGAIN; \
67288365 595 if (gimme == G_VOID) { \
898c5644 596 NOOP; \
67288365 597 } \
05fbd38d 598 else if (gimme == G_ARRAY) { \
c70927a6
FC
599 SSize_t i; \
600 SSize_t len; \
67288365 601 assert(SvTYPE(tmpsv) == SVt_PVAV); \
b9f2b683 602 len = av_tindex((AV *)tmpsv) + 1; \
67288365
JL
603 (void)POPs; /* get rid of the arg */ \
604 EXTEND(sp, len); \
605 for (i = 0; i < len; ++i) \
606 PUSHs(av_shift((AV *)tmpsv)); \
607 } \
608 else { /* AMGf_want_scalar */ \
609 dATARGET; /* just use the arg's location */ \
610 sv_setsv(TARG, tmpsv); \
72876cce 611 if (PL_op->op_flags & OPf_STACKED) \
67288365
JL
612 sp--; \
613 SETTARG; \
614 } \
b5c08826
DM
615 PUTBACK; \
616 if (jump) { \
86e5639b
GG
617 OP *jump_o = NORMAL->op_next; \
618 while (jump_o->op_type == OP_NULL) \
619 jump_o = jump_o->op_next; \
620 assert(jump_o->op_type == OP_ENTERSUB); \
101d6365 621 (void)POPMARK; \
86e5639b 622 return jump_o->op_next; \
9f39b4f1 623 } \
b5c08826
DM
624 return NORMAL; \
625 } \
9f39b4f1
NC
626 } STMT_END
627
8897dcaa
NC
628/* This is no longer used anywhere in the core. You might wish to consider
629 calling amagic_deref_call() directly, as it has a cleaner interface. */
630#define tryAMAGICunDEREF(meth) \
9f39b4f1 631 STMT_START { \
e89bfaa6 632 sv = amagic_deref_call(*sp, CAT2(meth,_amg)); \
25a9ffce 633 SPAGAIN; \
16e7e110 634 } STMT_END
e8c20960 635
180b7b9b 636
72876cce 637/* 2019: no longer used in core */
533c011a 638#define opASSIGN (PL_op->op_flags & OPf_STACKED)
a0d0e21e 639
78f9721b 640/*
78342678 641=for apidoc mnU||LVRET
78f9721b
SM
642True if this op will be the return value of an lvalue subroutine
643
644=cut */
9d96b2e7 645#define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
1b6737cc 646
d30e492c
VP
647#define SvCANEXISTDELETE(sv) \
648 (!SvRMAGICAL(sv) \
2c5f48c2
FC
649 || !(mg = mg_find((const SV *) sv, PERL_MAGIC_tied)) \
650 || ( (stash = SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(sv), mg)))) \
d30e492c
VP
651 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
652 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
653 ) \
654 )
655
d682515d 656#ifdef PERL_CORE
557fbd17 657
d682515d
NC
658/* These are just for Perl_tied_method(), which is not part of the public API.
659 Use 0x04 rather than the next available bit, to help the compiler if the
660 architecture can generate more efficient instructions. */
661# define TIED_METHOD_MORTALIZE_NOT_NEEDED 0x04
662# define TIED_METHOD_ARGUMENTS_ON_STACK 0x08
94bc412f 663# define TIED_METHOD_SAY 0x10
557fbd17
FC
664
665/* Used in various places that need to dereference a glob or globref */
094a3eec 666# define MAYBE_DEREF_GV_flags(sv,phlags) \
557fbd17 667 ( \
094a3eec 668 (void)(phlags & SV_GMAGIC && (SvGETMAGIC(sv),0)), \
557fbd17 669 isGV_with_GP(sv) \
4e794a06 670 ? (GV *)(sv) \
f8afbfa6
FC
671 : SvROK(sv) && SvTYPE(SvRV(sv)) <= SVt_PVLV && \
672 (SvGETMAGIC(SvRV(sv)), isGV_with_GP(SvRV(sv))) \
557fbd17
FC
673 ? (GV *)SvRV(sv) \
674 : NULL \
675 )
094a3eec
FC
676# define MAYBE_DEREF_GV(sv) MAYBE_DEREF_GV_flags(sv,SV_GMAGIC)
677# define MAYBE_DEREF_GV_nomg(sv) MAYBE_DEREF_GV_flags(sv,0)
557fbd17 678
db4cf31d 679# define FIND_RUNCV_padid_eq 1
b4b0692a 680# define FIND_RUNCV_level_eq 2
70794f7b 681
d682515d
NC
682#endif
683
1b6737cc 684/*
14d04a33 685 * ex: set ts=8 sts=4 sw=4 et:
1b6737cc 686 */