Add keys(@a) and values(@a) to perldelta
[perl.git] / pp.h
1 /*    pp.h
2  *
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
5  *
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.
8  *
9  */
10
11 #define PP(s) OP * Perl_##s(pTHX)
12
13 /*
14 =head1 Stack Manipulation Macros
15
16 =for apidoc AmU||SP
17 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
18 C<SPAGAIN>.
19
20 =for apidoc AmU||MARK
21 Stack marker variable for the XSUB.  See C<dMARK>.
22
23 =for apidoc Am|void|PUSHMARK|SP
24 Opening bracket for arguments on a callback.  See C<PUTBACK> and
25 L<perlcall>.
26
27 =for apidoc Ams||dSP
28 Declares a local copy of perl's stack pointer for the XSUB, available via
29 the C<SP> macro.  See C<SP>.
30
31 =for apidoc ms||djSP
32
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.)
37
38 =for apidoc Ams||dMARK
39 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
40 C<dORIGMARK>.
41
42 =for apidoc Ams||dORIGMARK
43 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
44
45 =for apidoc AmU||ORIGMARK
46 The original stack mark for the XSUB.  See C<dORIGMARK>.
47
48 =for apidoc Ams||SPAGAIN
49 Refetch the stack pointer.  Used after a callback.  See L<perlcall>.
50
51 =cut */
52
53 #undef SP /* Solaris 2.7 i386 has this in /usr/include/sys/reg.h */
54 #define SP sp
55 #define MARK mark
56 #define TARG targ
57
58 #define PUSHMARK(p)     \
59         STMT_START {                                    \
60             if (++PL_markstack_ptr == PL_markstack_max) \
61             markstack_grow();                           \
62             *PL_markstack_ptr = (I32)((p) - PL_stack_base);\
63         } STMT_END
64
65 #define TOPMARK         (*PL_markstack_ptr)
66 #define POPMARK         (*PL_markstack_ptr--)
67
68 #define dSP             SV **sp = PL_stack_sp
69 #define djSP            dSP
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)
73
74 #define SPAGAIN         sp = PL_stack_sp
75 #define MSPAGAIN        STMT_START { sp = PL_stack_sp; mark = ORIGMARK; } STMT_END
76
77 #define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
78 #define dTARGETSTACKED SV * GETTARGETSTACKED
79
80 #define GETTARGET targ = PAD_SV(PL_op->op_targ)
81 #define dTARGET SV * GETTARGET
82
83 #define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
84 #define dATARGET SV * GETATARGET
85
86 #define dTARG SV *targ
87
88 #define NORMAL PL_op->op_next
89 #define DIE return Perl_die
90
91 /*
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.
95
96 =for apidoc Amn|SV*|POPs
97 Pops an SV off the stack.
98
99 =for apidoc Amn|char*|POPp
100 Pops a string off the stack. Deprecated. New code should use POPpx.
101
102 =for apidoc Amn|char*|POPpx
103 Pops a string off the stack.
104
105 =for apidoc Amn|char*|POPpbytex
106 Pops a string off the stack which must consist of bytes i.e. characters < 256.
107
108 =for apidoc Amn|NV|POPn
109 Pops a double off the stack.
110
111 =for apidoc Amn|IV|POPi
112 Pops an integer off the stack.
113
114 =for apidoc Amn|long|POPl
115 Pops a long off the stack.
116
117 =cut
118 */
119
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)
124
125 #define POPs            (*sp--)
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))
135 #ifdef HAS_QUAD
136 #define POPq            ((Quad_t)SvIVx(POPs))
137 #define POPuq           ((Uquad_t)SvUVx(POPs))
138 #endif
139
140 #define TOPs            (*sp)
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))
150 #ifdef HAS_QUAD
151 #define TOPq            ((Quad_t)SvIV(TOPs))
152 #define TOPuq           ((Uquad_t)SvUV(TOPs))
153 #endif
154
155 /* Go to some pains in the rare event that we must extend the stack. */
156
157 /*
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
161 onto the stack.
162
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>.
167
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>.
174
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
180 C<mXPUSHn>.
181
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
187 C<mXPUSHi>.
188
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>.
195
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>.
200
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>.
207
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>.
213
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>.
219
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
225 C<mPUSHu>.
226
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 use C<TARG>.  See also C<PUSHs> and C<mXPUSHs>.
230
231 =for apidoc Am|void|PUSHmortal
232 Push a new mortal SV onto the stack.  The stack must have room for this
233 element.  Does not use C<TARG>.  See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
234
235 =for apidoc Am|void|mPUSHp|char* str|STRLEN len
236 Push a string onto the stack.  The stack must have room for this element.
237 The C<len> indicates the length of the string.  Does not use C<TARG>.
238 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
239
240 =for apidoc Am|void|mPUSHn|NV nv
241 Push a double onto the stack.  The stack must have room for this element.
242 Does not use C<TARG>.  See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
243
244 =for apidoc Am|void|mPUSHi|IV iv
245 Push an integer onto the stack.  The stack must have room for this element.
246 Does not use C<TARG>.  See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
247
248 =for apidoc Am|void|mPUSHu|UV uv
249 Push an unsigned integer onto the stack.  The stack must have room for this
250 element.  Does not use C<TARG>.  See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
251
252 =for apidoc Am|void|mXPUSHs|SV* sv
253 Push an SV onto the stack, extending the stack if necessary and mortalizes
254 the SV.  Does not use C<TARG>.  See also C<XPUSHs> and C<mPUSHs>.
255
256 =for apidoc Am|void|XPUSHmortal
257 Push a new mortal SV onto the stack, extending the stack if necessary.
258 Does not use C<TARG>.  See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
259
260 =for apidoc Am|void|mXPUSHp|char* str|STRLEN len
261 Push a string onto the stack, extending the stack if necessary.  The C<len>
262 indicates the length of the string.  Does not use C<TARG>.  See also C<XPUSHp>,
263 C<mPUSHp> and C<PUSHp>.
264
265 =for apidoc Am|void|mXPUSHn|NV nv
266 Push a double onto the stack, extending the stack if necessary.
267 Does not use C<TARG>.  See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
268
269 =for apidoc Am|void|mXPUSHi|IV iv
270 Push an integer onto the stack, extending the stack if necessary.
271 Does not use C<TARG>.  See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
272
273 =for apidoc Am|void|mXPUSHu|UV uv
274 Push an unsigned integer onto the stack, extending the stack if necessary.
275 Does not use C<TARG>.  See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
276
277 =cut
278 */
279
280 #define EXTEND(p,n)     STMT_START { if (PL_stack_max - p < (int)(n)) {         \
281                             sp = stack_grow(sp,p, (int) (n));           \
282                         } } STMT_END
283
284 /* Same thing, but update mark register too. */
285 #define MEXTEND(p,n)    STMT_START {if (PL_stack_max - p < (int)(n)) {  \
286                             const int markoff = mark - PL_stack_base;   \
287                             sp = stack_grow(sp,p,(int) (n));            \
288                             mark = PL_stack_base + markoff;             \
289                         } } STMT_END
290
291 #define PUSHs(s)        (*++sp = (s))
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
294 #define PUSHn(n)        STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
295 #define PUSHi(i)        STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
296 #define PUSHu(u)        STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
297
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
301 #define XPUSHn(n)       STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
302 #define XPUSHi(i)       STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
303 #define XPUSHu(u)       STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
304 #define XPUSHundef      STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
305
306 #define mPUSHs(s)       PUSHs(sv_2mortal(s))
307 #define PUSHmortal      PUSHs(sv_newmortal())
308 #define mPUSHp(p,l)     PUSHs(newSVpvn_flags((p), (l), SVs_TEMP))
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))
312
313 #define mXPUSHs(s)      XPUSHs(sv_2mortal(s))
314 #define XPUSHmortal     XPUSHs(sv_newmortal())
315 #define mXPUSHp(p,l)    STMT_START { EXTEND(sp,1); mPUSHp((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
319
320 #define SETs(s)         (*sp = s)
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
323 #define SETn(n)         STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
324 #define SETi(i)         STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
325 #define SETu(u)         STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
326
327 #define dTOPss          SV *sv = TOPs
328 #define dPOPss          SV *sv = POPs
329 #define dTOPnv          NV value = TOPn
330 #define dPOPnv          NV value = POPn
331 #define dPOPnv_nomg     NV value = (sp--, SvNV_nomg(TOPp1s))
332 #define dTOPiv          IV value = TOPi
333 #define dPOPiv          IV value = POPi
334 #define dTOPuv          UV value = TOPu
335 #define dPOPuv          UV value = POPu
336 #ifdef HAS_QUAD
337 #define dTOPqv          Quad_t value = TOPu
338 #define dPOPqv          Quad_t value = POPu
339 #define dTOPuqv         Uquad_t value = TOPuq
340 #define dPOPuqv         Uquad_t value = POPuq
341 #endif
342
343 #define dPOPXssrl(X)    SV *right = POPs; SV *left = CAT2(X,s)
344 #define dPOPXnnrl(X)    NV right = POPn; NV left = CAT2(X,n)
345 #define dPOPXiirl(X)    IV right = POPi; IV left = CAT2(X,i)
346
347 #define USE_LEFT(sv) \
348         (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
349 #define dPOPXnnrl_ul(X) \
350     NV right = POPn;                            \
351     SV *leftsv = CAT2(X,s);                             \
352     NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
353 #define dPOPXiirl_ul(X) \
354     IV right = POPi;                                    \
355     SV *leftsv = CAT2(X,s);                             \
356     IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
357 #define dPOPXiirl_ul_nomg(X) \
358     IV right = POPi;                                    \
359     SV *leftsv = CAT2(X,s);                             \
360     IV left = USE_LEFT(leftsv) ? SvIV_nomg(leftsv) : 0
361
362 #define dPOPPOPssrl     dPOPXssrl(POP)
363 #define dPOPPOPnnrl     dPOPXnnrl(POP)
364 #define dPOPPOPnnrl_ul  dPOPXnnrl_ul(POP)
365 #define dPOPPOPiirl     dPOPXiirl(POP)
366 #define dPOPPOPiirl_ul  dPOPXiirl_ul(POP)
367
368 #define dPOPTOPssrl     dPOPXssrl(TOP)
369 #define dPOPTOPnnrl     dPOPXnnrl(TOP)
370 #define dPOPTOPnnrl_ul  dPOPXnnrl_ul(TOP)
371 #define dPOPTOPnnrl_nomg \
372     NV right = SvNV_nomg(TOPs); NV left = (sp--, SvNV_nomg(TOPs))
373 #define dPOPTOPiirl     dPOPXiirl(TOP)
374 #define dPOPTOPiirl_ul  dPOPXiirl_ul(TOP)
375 #define dPOPTOPiirl_ul_nomg dPOPXiirl_ul_nomg(TOP)
376 #define dPOPTOPiirl_nomg \
377     IV right = SvIV_nomg(TOPs); IV left = (sp--, SvIV_nomg(TOPs))
378
379 #define RETPUSHYES      RETURNX(PUSHs(&PL_sv_yes))
380 #define RETPUSHNO       RETURNX(PUSHs(&PL_sv_no))
381 #define RETPUSHUNDEF    RETURNX(PUSHs(&PL_sv_undef))
382
383 #define RETSETYES       RETURNX(SETs(&PL_sv_yes))
384 #define RETSETNO        RETURNX(SETs(&PL_sv_no))
385 #define RETSETUNDEF     RETURNX(SETs(&PL_sv_undef))
386
387 #define ARGTARG         PL_op->op_targ
388
389     /* See OPpTARGET_MY: */
390 #define MAXARG          (PL_op->op_private & 15)
391
392 #define SWITCHSTACK(f,t) \
393     STMT_START {                                                        \
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);                  \
398         PL_curstack = t;                                                \
399     } STMT_END
400
401 #define EXTEND_MORTAL(n) \
402     STMT_START {                                                        \
403         if (PL_tmps_ix + (n) >= PL_tmps_max)                            \
404             tmps_grow(n);                                               \
405     } STMT_END
406
407 #define AMGf_noright    1
408 #define AMGf_noleft     2
409 #define AMGf_assign     4
410 #define AMGf_unary      8
411 #define AMGf_numeric    0x10    /* for Perl_try_amagic_bin */
412 #define AMGf_set        0x20    /* for Perl_try_amagic_bin */
413
414
415 /* do SvGETMAGIC on the stack args before checking for overload */
416
417 #define tryAMAGICun_MG(method, flags) STMT_START { \
418         if ( (SvFLAGS(TOPs) & (SVf_ROK|SVs_GMG)) \
419                 && Perl_try_amagic_un(aTHX_ method, flags)) \
420             return NORMAL; \
421     } STMT_END
422 #define tryAMAGICbin_MG(method, flags) STMT_START { \
423         if ( ((SvFLAGS(TOPm1s)|SvFLAGS(TOPs)) & (SVf_ROK|SVs_GMG)) \
424                 && Perl_try_amagic_bin(aTHX_ method, flags)) \
425             return NORMAL; \
426     } STMT_END
427
428 /* these  tryAMAGICun* tryAMAGICbin* macros are no longer used in core
429  * (except for tryAMAGICunDEREF*, tryAMAGICunTARGET),
430  * and are only here for backwards compatibility */
431
432 #define tryAMAGICbinW_var(meth_enum,assign,set) STMT_START { \
433             SV* const left = *(sp-1); \
434             SV* const right = *(sp); \
435             if ((SvAMAGIC(left)||SvAMAGIC(right))) {\
436                 SV * const tmpsv = amagic_call(left, \
437                                    right, \
438                                    (meth_enum), \
439                                    (assign)? AMGf_assign: 0); \
440                 if (tmpsv) { \
441                     SPAGAIN; \
442                     (void)POPs; set(tmpsv); RETURN; } \
443                 } \
444         } STMT_END
445
446 #define tryAMAGICbinW(meth,assign,set) \
447     tryAMAGICbinW_var(CAT2(meth,_amg),assign,set)
448
449 #define tryAMAGICbin_var(meth_enum,assign) \
450                 tryAMAGICbinW_var(meth_enum,assign,SETsv)
451 #define tryAMAGICbin(meth,assign) \
452                 tryAMAGICbin_var(CAT2(meth,_amg),assign)
453
454 #define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
455
456 #define tryAMAGICbinSET_var(meth_enum,assign) \
457     tryAMAGICbinW_var(meth_enum,assign,SETs)
458
459 #define AMG_CALLun_var(sv,meth_enum) amagic_call(sv,&PL_sv_undef,  \
460                                         meth_enum,AMGf_noright | AMGf_unary)
461 #define AMG_CALLun(sv,meth) AMG_CALLun_var(sv,CAT2(meth,_amg))
462
463 #define AMG_CALLbinL(left,right,meth) \
464             amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
465
466 #define tryAMAGICunW_var(meth_enum,set,shift,ret) STMT_START { \
467             SV* tmpsv; \
468             SV* arg= sp[shift]; \
469           if(0) goto am_again;  /* shut up unused warning */ \
470           am_again: \
471             if ((SvAMAGIC(arg))&&\
472                 (tmpsv=AMG_CALLun_var(arg,(meth_enum)))) {\
473                SPAGAIN; if (shift) sp += shift; \
474                set(tmpsv); ret; } \
475         } STMT_END
476 #define tryAMAGICunW(meth,set,shift,ret) \
477         tryAMAGICunW_var(CAT2(meth,_amg),set,shift,ret)
478
479 #define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
480
481 #define tryAMAGICun_var(meth_enum) tryAMAGICunW_var(meth_enum,SETsvUN,0,RETURN)
482 #define tryAMAGICun(meth)       tryAMAGICun_var(CAT2(meth,_amg))
483 #define tryAMAGICunSET_var(meth_enum) tryAMAGICunW_var(meth_enum,SETs,0,RETURN)
484 #define tryAMAGICunSET(meth)    tryAMAGICunW(meth,SETs,0,RETURN)
485 #define tryAMAGICunTARGET(meth, shift)                                  \
486         STMT_START { dSP; sp--;         /* get TARGET from below PL_stack_sp */         \
487             { dTARGETSTACKED;                                           \
488                 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}} STMT_END
489
490 #define setAGAIN(ref)   \
491     STMT_START {                                        \
492         sv = ref;                                       \
493         if (!SvROK(ref))                                \
494             Perl_croak(aTHX_ "Overloaded dereference did not return a reference");      \
495         if (ref != arg && SvRV(ref) != SvRV(arg)) {     \
496             arg = ref;                                  \
497             goto am_again;                              \
498         }                                               \
499     } STMT_END
500
501 #define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
502 #define tryAMAGICunDEREF_var(meth_enum) \
503         tryAMAGICunW_var(meth_enum,setAGAIN,0,(void)0)
504
505 /* this macro is obsolete and is only here for backwards compatibility */
506
507 #define tryAMAGICftest(chr)                             \
508     STMT_START {                                        \
509         assert(chr != '?');                             \
510         SvGETMAGIC(TOPs);                               \
511         if ((PL_op->op_flags & OPf_KIDS)                \
512                 && SvAMAGIC(TOPs)) {                    \
513             const char tmpchr = (chr);                  \
514             SV * const tmpsv = amagic_call(TOPs,        \
515                 newSVpvn_flags(&tmpchr, 1, SVs_TEMP),   \
516                 ftest_amg, AMGf_unary);                 \
517                                                         \
518             if (tmpsv) {                                \
519                 const OP *next = PL_op->op_next;        \
520                                                         \
521                 SPAGAIN;                                \
522                                                         \
523                 if (next->op_type >= OP_FTRREAD &&      \
524                     next->op_type <= OP_FTBINARY &&     \
525                     next->op_private & OPpFT_STACKED    \
526                 ) {                                     \
527                     if (SvTRUE(tmpsv))                  \
528                         /* leave the object alone */    \
529                         RETURN;                         \
530                 }                                       \
531                                                         \
532                 SETs(tmpsv);                            \
533                 RETURN;                                 \
534             }                                           \
535         }                                               \
536     } STMT_END
537
538
539 #define opASSIGN (PL_op->op_flags & OPf_STACKED)
540 #define SETsv(sv)       STMT_START {                                    \
541                 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY))            \
542                    { sv_setsv(TARG, (sv)); SETTARG; }                   \
543                 else SETs(sv); } STMT_END
544
545 #define SETsvUN(sv)     STMT_START {                                    \
546                 if (SvFLAGS(TARG) & SVs_PADMY)          \
547                    { sv_setsv(TARG, (sv)); SETTARG; }                   \
548                 else SETs(sv); } STMT_END
549
550 /* newSVsv does not behave as advertised, so we copy missing
551  * information by hand */
552
553 /* SV* ref causes confusion with the member variable
554    changed SV* ref to SV* tmpRef */
555 #define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); SV* rv_copy;     \
556   if (SvREFCNT(tmpRef)>1 && (rv_copy = AMG_CALLun(rv,copy))) {          \
557     SvRV_set(rv, rv_copy);                  \
558     SvSETMAGIC(rv);                         \
559     SvREFCNT_dec(tmpRef);                   \
560   } } STMT_END
561
562 /*
563 =for apidoc mU||LVRET
564 True if this op will be the return value of an lvalue subroutine
565
566 =cut */
567 #define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())
568
569 #define SvCANEXISTDELETE(sv) \
570  (!SvRMAGICAL(sv)            \
571   || ((mg = mg_find((const SV *) sv, PERL_MAGIC_tied))           \
572       && (stash = SvSTASH(SvRV(SvTIED_obj(MUTABLE_SV(sv), mg)))) \
573       && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)          \
574       && gv_fetchmethod_autoload(stash, "DELETE", TRUE)          \
575      )                       \
576   )
577
578 /*
579  * Local variables:
580  * c-indentation-style: bsd
581  * c-basic-offset: 4
582  * indent-tabs-mode: t
583  * End:
584  *
585  * ex: set ts=8 sts=4 sw=4 noet:
586  */