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
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.
11 #define PP(s) OP * Perl_##s(pTHX)
14 =head1 Stack Manipulation Macros
17 Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
21 Stack marker variable for the XSUB. See C<dMARK>.
23 =for apidoc Am|void|PUSHMARK|SP
24 Opening bracket for arguments on a callback. See C<PUTBACK> and
28 Declares a local copy of perl's stack pointer for the XSUB, available via
29 the C<SP> macro. See C<SP>.
33 Declare Just C<SP>. This is actually identical to C<dSP>, and declares
34 a local copy of perl's stack pointer, available via the C<SP> macro.
35 See C<SP>. (Available for backward source code compatibility with the
36 old (Perl 5.005) thread model.)
38 =for apidoc Ams||dMARK
39 Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
42 =for apidoc Ams||dORIGMARK
43 Saves the original stack mark for the XSUB. See C<ORIGMARK>.
45 =for apidoc AmU||ORIGMARK
46 The original stack mark for the XSUB. See C<dORIGMARK>.
48 =for apidoc Ams||SPAGAIN
49 Refetch the stack pointer. Used after a callback. See L<perlcall>.
53 #undef SP /* Solaris 2.7 i386 has this in /usr/include/sys/reg.h */
60 if (++PL_markstack_ptr == PL_markstack_max) \
62 *PL_markstack_ptr = (I32)((p) - PL_stack_base);\
65 #define TOPMARK (*PL_markstack_ptr)
66 #define POPMARK (*PL_markstack_ptr--)
68 #define dSP SV **sp = PL_stack_sp
70 #define dMARK register SV **mark = PL_stack_base + POPMARK
71 #define dORIGMARK const I32 origmark = (I32)(mark - PL_stack_base)
72 #define ORIGMARK (PL_stack_base + origmark)
74 #define SPAGAIN sp = PL_stack_sp
75 #define MSPAGAIN STMT_START { sp = PL_stack_sp; mark = ORIGMARK; } STMT_END
77 #define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
78 #define dTARGETSTACKED SV * GETTARGETSTACKED
80 #define GETTARGET targ = PAD_SV(PL_op->op_targ)
81 #define dTARGET SV * GETTARGET
83 #define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
84 #define dATARGET SV * GETATARGET
86 #define dTARG SV *targ
88 #define NORMAL PL_op->op_next
89 #define DIE return Perl_die
92 =for apidoc Ams||PUTBACK
93 Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
94 See C<PUSHMARK> and L<perlcall> for other uses.
96 =for apidoc Amn|SV*|POPs
97 Pops an SV off the stack.
99 =for apidoc Amn|char*|POPp
100 Pops a string off the stack. Deprecated. New code should use POPpx.
102 =for apidoc Amn|char*|POPpx
103 Pops a string off the stack.
105 =for apidoc Amn|char*|POPpbytex
106 Pops a string off the stack which must consist of bytes i.e. characters < 256.
108 =for apidoc Amn|NV|POPn
109 Pops a double off the stack.
111 =for apidoc Amn|IV|POPi
112 Pops an integer off the stack.
114 =for apidoc Amn|long|POPl
115 Pops a long off the stack.
120 #define PUTBACK PL_stack_sp = sp
121 #define RETURN return (PUTBACK, NORMAL)
122 #define RETURNOP(o) return (PUTBACK, o)
123 #define RETURNX(x) return (x, PUTBACK, NORMAL)
126 #define POPp (SvPVx(POPs, PL_na)) /* deprecated */
127 #define POPpx (SvPVx_nolen(POPs))
128 #define POPpconstx (SvPVx_nolen_const(POPs))
129 #define POPpbytex (SvPVbytex_nolen(POPs))
130 #define POPn (SvNVx(POPs))
131 #define POPi ((IV)SvIVx(POPs))
132 #define POPu ((UV)SvUVx(POPs))
133 #define POPl ((long)SvIVx(POPs))
134 #define POPul ((unsigned long)SvIVx(POPs))
136 #define POPq ((Quad_t)SvIVx(POPs))
137 #define POPuq ((Uquad_t)SvUVx(POPs))
141 #define TOPm1s (*(sp-1))
142 #define TOPp1s (*(sp+1))
143 #define TOPp (SvPV(TOPs, PL_na)) /* deprecated */
144 #define TOPpx (SvPV_nolen(TOPs))
145 #define TOPn (SvNV(TOPs))
146 #define TOPi ((IV)SvIV(TOPs))
147 #define TOPu ((UV)SvUV(TOPs))
148 #define TOPl ((long)SvIV(TOPs))
149 #define TOPul ((unsigned long)SvUV(TOPs))
151 #define TOPq ((Quad_t)SvIV(TOPs))
152 #define TOPuq ((Uquad_t)SvUV(TOPs))
155 /* Go to some pains in the rare event that we must extend the stack. */
158 =for apidoc Am|void|EXTEND|SP|int nitems
159 Used to extend the argument stack for an XSUB's return values. Once
160 used, guarantees that there is room for at least C<nitems> to be pushed
163 =for apidoc Am|void|PUSHs|SV* sv
164 Push an SV onto the stack. The stack must have room for this element.
165 Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
166 C<XPUSHs> and C<XPUSHmortal>.
168 =for apidoc Am|void|PUSHp|char* str|STRLEN len
169 Push a string onto the stack. The stack must have room for this element.
170 The C<len> indicates the length of the string. Handles 'set' magic. Uses
171 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
172 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
173 C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
175 =for apidoc Am|void|PUSHn|NV nv
176 Push a double onto the stack. The stack must have room for this element.
177 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
178 called to declare it. Do not call multiple C<TARG>-oriented macros to
179 return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
182 =for apidoc Am|void|PUSHi|IV iv
183 Push an integer onto the stack. The stack must have room for this element.
184 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
185 called to declare it. Do not call multiple C<TARG>-oriented macros to
186 return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
189 =for apidoc Am|void|PUSHu|UV uv
190 Push an unsigned integer onto the stack. The stack must have room for this
191 element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
192 should be called to declare it. Do not call multiple C<TARG>-oriented
193 macros to return lists from XSUB's - see C<mPUSHu> instead. See also
194 C<XPUSHu> and C<mXPUSHu>.
196 =for apidoc Am|void|XPUSHs|SV* sv
197 Push an SV onto the stack, extending the stack if necessary. Does not
198 handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
199 C<PUSHs> and C<PUSHmortal>.
201 =for apidoc Am|void|XPUSHp|char* str|STRLEN len
202 Push a string onto the stack, extending the stack if necessary. The C<len>
203 indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
204 C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
205 multiple C<TARG>-oriented macros to return lists from XSUB's - see
206 C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
208 =for apidoc Am|void|XPUSHn|NV nv
209 Push a double onto the stack, extending the stack if necessary. Handles
210 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
211 declare it. Do not call multiple C<TARG>-oriented macros to return lists
212 from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
214 =for apidoc Am|void|XPUSHi|IV iv
215 Push an integer onto the stack, extending the stack if necessary. Handles
216 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
217 declare it. Do not call multiple C<TARG>-oriented macros to return lists
218 from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
220 =for apidoc Am|void|XPUSHu|UV uv
221 Push an unsigned integer onto the stack, extending the stack if necessary.
222 Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
223 called to declare it. Do not call multiple C<TARG>-oriented macros to
224 return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
227 =for apidoc Am|void|mPUSHs|SV* sv
228 Push an SV onto the stack and mortalizes the SV. The stack must have room
229 for this element. Does not handle 'set' magic. Does not use C<TARG>.
230 See also C<PUSHs> and C<mXPUSHs>.
232 =for apidoc Am|void|PUSHmortal
233 Push a new mortal SV onto the stack. The stack must have room for this
234 element. Does not handle 'set' magic. Does not use C<TARG>. See also
235 C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
237 =for apidoc Am|void|mPUSHp|char* str|STRLEN len
238 Push a string onto the stack. The stack must have room for this element.
239 The C<len> indicates the length of the string. Handles 'set' magic. Does
240 not use C<TARG>. See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
242 =for apidoc Am|void|mPUSHn|NV nv
243 Push a double onto the stack. The stack must have room for this element.
244 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
247 =for apidoc Am|void|mPUSHi|IV iv
248 Push an integer onto the stack. The stack must have room for this element.
249 Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
252 =for apidoc Am|void|mPUSHu|UV uv
253 Push an unsigned integer onto the stack. The stack must have room for this
254 element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
255 C<mXPUSHu> and C<XPUSHu>.
257 =for apidoc Am|void|mXPUSHs|SV* sv
258 Push an SV onto the stack, extending the stack if necessary and mortalizes
259 the SV. Does not handle 'set' magic. Does not use C<TARG>. See also
260 C<XPUSHs> and C<mPUSHs>.
262 =for apidoc Am|void|XPUSHmortal
263 Push a new mortal SV onto the stack, extending the stack if necessary. Does
264 not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
265 C<PUSHmortal> and C<PUSHs>.
267 =for apidoc Am|void|mXPUSHp|char* str|STRLEN len
268 Push a string onto the stack, extending the stack if necessary. The C<len>
269 indicates the length of the string. Handles 'set' magic. Does not use
270 C<TARG>. See also C<XPUSHp>, C<mPUSHp> and C<PUSHp>.
272 =for apidoc Am|void|mXPUSHn|NV nv
273 Push a double onto the stack, extending the stack if necessary. Handles
274 'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
277 =for apidoc Am|void|mXPUSHi|IV iv
278 Push an integer onto the stack, extending the stack if necessary. Handles
279 'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
282 =for apidoc Am|void|mXPUSHu|UV uv
283 Push an unsigned integer onto the stack, extending the stack if necessary.
284 Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
290 #define EXTEND(p,n) STMT_START { if (PL_stack_max - p < (int)(n)) { \
291 sp = stack_grow(sp,p, (int) (n)); \
294 /* Same thing, but update mark register too. */
295 #define MEXTEND(p,n) STMT_START {if (PL_stack_max - p < (int)(n)) { \
296 const int markoff = mark - PL_stack_base; \
297 sp = stack_grow(sp,p,(int) (n)); \
298 mark = PL_stack_base + markoff; \
301 #define PUSHs(s) (*++sp = (s))
302 #define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
303 #define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
304 #define PUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
305 #define PUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
306 #define PUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
308 #define XPUSHs(s) STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
309 #define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
310 #define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
311 #define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
312 #define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
313 #define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
314 #define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
316 #define mPUSHs(s) PUSHs(sv_2mortal(s))
317 #define PUSHmortal PUSHs(sv_newmortal())
318 #define mPUSHp(p,l) sv_setpvn_mg(PUSHmortal, (p), (l))
319 #define mPUSHn(n) sv_setnv_mg(PUSHmortal, (NV)(n))
320 #define mPUSHi(i) sv_setiv_mg(PUSHmortal, (IV)(i))
321 #define mPUSHu(u) sv_setuv_mg(PUSHmortal, (UV)(u))
323 #define mXPUSHs(s) XPUSHs(sv_2mortal(s))
324 #define XPUSHmortal XPUSHs(sv_newmortal())
325 #define mXPUSHp(p,l) STMT_START { EXTEND(sp,1); sv_setpvn_mg(PUSHmortal, (p), (l)); } STMT_END
326 #define mXPUSHn(n) STMT_START { EXTEND(sp,1); sv_setnv_mg(PUSHmortal, (NV)(n)); } STMT_END
327 #define mXPUSHi(i) STMT_START { EXTEND(sp,1); sv_setiv_mg(PUSHmortal, (IV)(i)); } STMT_END
328 #define mXPUSHu(u) STMT_START { EXTEND(sp,1); sv_setuv_mg(PUSHmortal, (UV)(u)); } STMT_END
330 #define SETs(s) (*sp = s)
331 #define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
332 #define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
333 #define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
334 #define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
335 #define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
337 #define dTOPss SV *sv = TOPs
338 #define dPOPss SV *sv = POPs
339 #define dTOPnv NV value = TOPn
340 #define dPOPnv NV value = POPn
341 #define dTOPiv IV value = TOPi
342 #define dPOPiv IV value = POPi
343 #define dTOPuv UV value = TOPu
344 #define dPOPuv UV value = POPu
346 #define dTOPqv Quad_t value = TOPu
347 #define dPOPqv Quad_t value = POPu
348 #define dTOPuqv Uquad_t value = TOPuq
349 #define dPOPuqv Uquad_t value = POPuq
352 #define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
353 #define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
354 #define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
356 #define USE_LEFT(sv) \
357 (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
358 #define dPOPXnnrl_ul(X) \
360 SV *leftsv = CAT2(X,s); \
361 NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
362 #define dPOPXiirl_ul(X) \
364 SV *leftsv = CAT2(X,s); \
365 IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
367 #define dPOPPOPssrl dPOPXssrl(POP)
368 #define dPOPPOPnnrl dPOPXnnrl(POP)
369 #define dPOPPOPnnrl_ul dPOPXnnrl_ul(POP)
370 #define dPOPPOPiirl dPOPXiirl(POP)
371 #define dPOPPOPiirl_ul dPOPXiirl_ul(POP)
373 #define dPOPTOPssrl dPOPXssrl(TOP)
374 #define dPOPTOPnnrl dPOPXnnrl(TOP)
375 #define dPOPTOPnnrl_ul dPOPXnnrl_ul(TOP)
376 #define dPOPTOPiirl dPOPXiirl(TOP)
377 #define dPOPTOPiirl_ul dPOPXiirl_ul(TOP)
379 #define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
380 #define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
381 #define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
383 #define RETSETYES RETURNX(SETs(&PL_sv_yes))
384 #define RETSETNO RETURNX(SETs(&PL_sv_no))
385 #define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
387 #define ARGTARG PL_op->op_targ
389 /* See OPpTARGET_MY: */
390 #define MAXARG (PL_op->op_private & 15)
392 #define SWITCHSTACK(f,t) \
394 AvFILLp(f) = sp - PL_stack_base; \
395 PL_stack_base = AvARRAY(t); \
396 PL_stack_max = PL_stack_base + AvMAX(t); \
397 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
401 #define EXTEND_MORTAL(n) \
403 if (PL_tmps_ix + (n) >= PL_tmps_max) \
407 #define AMGf_noright 1
408 #define AMGf_noleft 2
409 #define AMGf_assign 4
412 #define tryAMAGICbinW_var(meth_enum,assign,set) STMT_START { \
413 SV* const left = *(sp-1); \
414 SV* const right = *(sp); \
415 if ((SvAMAGIC(left)||SvAMAGIC(right))) {\
416 SV * const tmpsv = amagic_call(left, \
419 (assign)? AMGf_assign: 0); \
422 (void)POPs; set(tmpsv); RETURN; } \
426 #define tryAMAGICbinW(meth,assign,set) \
427 tryAMAGICbinW_var(CAT2(meth,_amg),assign,set)
429 #define tryAMAGICbin_var(meth_enum,assign) \
430 tryAMAGICbinW_var(meth_enum,assign,SETsv)
431 #define tryAMAGICbin(meth,assign) \
432 tryAMAGICbin_var(CAT2(meth,_amg),assign)
434 #define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
436 #define tryAMAGICbinSET_var(meth_enum,assign) \
437 tryAMAGICbinW_var(meth_enum,assign,SETs)
439 #define AMG_CALLun_var(sv,meth_enum) amagic_call(sv,&PL_sv_undef, \
440 meth_enum,AMGf_noright | AMGf_unary)
441 #define AMG_CALLun(sv,meth) AMG_CALLun_var(sv,CAT2(meth,_amg))
443 #define AMG_CALLbinL(left,right,meth) \
444 amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
446 #define tryAMAGICunW_var(meth_enum,set,shift,ret) STMT_START { \
448 SV* arg= sp[shift]; \
449 if(0) goto am_again; /* shut up unused warning */ \
451 if ((SvAMAGIC(arg))&&\
452 (tmpsv=AMG_CALLun_var(arg,(meth_enum)))) {\
453 SPAGAIN; if (shift) sp += shift; \
456 #define tryAMAGICunW(meth,set,shift,ret) \
457 tryAMAGICunW_var(CAT2(meth,_amg),set,shift,ret)
459 #define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
461 #define tryAMAGICun_var(meth_enum) tryAMAGICunW_var(meth_enum,SETsvUN,0,RETURN)
462 #define tryAMAGICun(meth) tryAMAGICun_var(CAT2(meth,_amg))
463 #define tryAMAGICunSET(meth) tryAMAGICunW(meth,SETs,0,RETURN)
464 #define tryAMAGICunTARGET(meth, shift) \
465 STMT_START { dSP; sp--; /* get TARGET from below PL_stack_sp */ \
467 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}} STMT_END
469 #define setAGAIN(ref) \
473 Perl_croak(aTHX_ "Overloaded dereference did not return a reference"); \
474 if (ref != arg && SvRV(ref) != SvRV(arg)) { \
480 #define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
481 #define tryAMAGICunDEREF_var(meth_enum) \
482 tryAMAGICunW_var(meth_enum,setAGAIN,0,(void)0)
484 #define opASSIGN (PL_op->op_flags & OPf_STACKED)
485 #define SETsv(sv) STMT_START { \
486 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY)) \
487 { sv_setsv(TARG, (sv)); SETTARG; } \
488 else SETs(sv); } STMT_END
490 #define SETsvUN(sv) STMT_START { \
491 if (SvFLAGS(TARG) & SVs_PADMY) \
492 { sv_setsv(TARG, (sv)); SETTARG; } \
493 else SETs(sv); } STMT_END
495 /* newSVsv does not behave as advertised, so we copy missing
496 * information by hand */
498 /* SV* ref causes confusion with the member variable
499 changed SV* ref to SV* tmpRef */
500 #define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); \
501 if (SvREFCNT(tmpRef)>1) { \
502 SvRV_set(rv, AMG_CALLun(rv,copy)); \
503 SvREFCNT_dec(tmpRef); \
507 =for apidoc mU||LVRET
508 True if this op will be the return value of an lvalue subroutine
511 #define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
515 * c-indentation-style: bsd
517 * indent-tabs-mode: t
520 * ex: set ts=8 sts=4 sw=4 noet: