$VERSION "a5" doesn't quite work.
[p5sagit/p5-mst-13.2.git] / pp.h
1 /*    pp.h
2  *
3  *    Copyright (c) 1991-2001, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 #ifdef USE_5005THREADS
11 #define ARGS thr
12 #define dARGS struct perl_thread *thr;
13 #else
14 #define ARGS
15 #define dARGS
16 #endif /* USE_5005THREADS */
17
18 #define PP(s) OP * Perl_##s(pTHX)
19
20 /*
21 =for apidoc AmU||SP
22 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
23 C<SPAGAIN>.
24
25 =for apidoc AmU||MARK
26 Stack marker variable for the XSUB.  See C<dMARK>.
27
28 =for apidoc Ams||PUSHMARK
29 Opening bracket for arguments on a callback.  See C<PUTBACK> and
30 L<perlcall>.
31
32 =for apidoc Ams||dSP
33 Declares a local copy of perl's stack pointer for the XSUB, available via
34 the C<SP> macro.  See C<SP>.
35
36 =for apidoc ms||djSP
37
38 Declare Just C<SP>. This is actually identical to C<dSP>, and declares
39 a local copy of perl's stack pointer, available via the C<SP> macro.
40 See C<SP>.  (Available for backward source code compatibility with the
41 old (Perl 5.005) thread model.)
42
43 =for apidoc Ams||dMARK
44 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
45 C<dORIGMARK>.
46
47 =for apidoc Ams||dORIGMARK
48 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
49
50 =for apidoc AmU||ORIGMARK
51 The original stack mark for the XSUB.  See C<dORIGMARK>.
52
53 =for apidoc Ams||SPAGAIN
54 Refetch the stack pointer.  Used after a callback.  See L<perlcall>.
55
56 =cut */
57
58 #undef SP /* Solaris 2.7 i386 has this in /usr/include/sys/reg.h */
59 #define SP sp
60 #define MARK mark
61 #define TARG targ
62
63 #define PUSHMARK(p) if (++PL_markstack_ptr == PL_markstack_max) \
64                         markstack_grow();                       \
65                     *PL_markstack_ptr = (p) - PL_stack_base
66
67 #define TOPMARK         (*PL_markstack_ptr)
68 #define POPMARK         (*PL_markstack_ptr--)
69
70 #define dSP             register SV **sp = PL_stack_sp
71 #define djSP            dSP
72 #define dMARK           register SV **mark = PL_stack_base + POPMARK
73 #define dORIGMARK       I32 origmark = mark - PL_stack_base
74 #define SETORIGMARK     origmark = mark - PL_stack_base
75 #define ORIGMARK        (PL_stack_base + origmark)
76
77 #define SPAGAIN         sp = PL_stack_sp
78 #define MSPAGAIN        sp = PL_stack_sp; mark = ORIGMARK
79
80 #define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
81 #define dTARGETSTACKED SV * GETTARGETSTACKED
82
83 #define GETTARGET targ = PAD_SV(PL_op->op_targ)
84 #define dTARGET SV * GETTARGET
85
86 #define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
87 #define dATARGET SV * GETATARGET
88
89 #define dTARG SV *targ
90
91 #define NORMAL PL_op->op_next
92 #define DIE return Perl_die
93
94 /*
95 =for apidoc Ams||PUTBACK
96 Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
97 See C<PUSHMARK> and L<perlcall> for other uses.
98
99 =for apidoc Amn|SV*|POPs
100 Pops an SV off the stack.
101
102 =for apidoc Amn|char*|POPp
103 Pops a string off the stack. Deprecated. New code should provide
104 a STRLEN n_a and use POPpx.
105
106 =for apidoc Amn|char*|POPpx
107 Pops a string off the stack.
108 Requires a variable STRLEN n_a in scope.
109
110 =for apidoc Amn|char*|POPpbytex
111 Pops a string off the stack which must consist of bytes i.e. characters < 256.
112 Requires a variable STRLEN n_a in scope.
113
114 =for apidoc Amn|NV|POPn
115 Pops a double off the stack.
116
117 =for apidoc Amn|IV|POPi
118 Pops an integer off the stack.
119
120 =for apidoc Amn|long|POPl
121 Pops a long off the stack.
122
123 =cut
124 */
125
126 #define PUTBACK         PL_stack_sp = sp
127 #define RETURN          return PUTBACK, NORMAL
128 #define RETURNOP(o)     return PUTBACK, o
129 #define RETURNX(x)      return x, PUTBACK, NORMAL
130
131 #define POPs            (*sp--)
132 #define POPp            (SvPVx(POPs, PL_na))            /* deprecated */
133 #define POPpx           (SvPVx(POPs, n_a))
134 #define POPpbytex       (SvPVbytex(POPs, n_a))
135 #define POPn            (SvNVx(POPs))
136 #define POPi            ((IV)SvIVx(POPs))
137 #define POPu            ((UV)SvUVx(POPs))
138 #define POPl            ((long)SvIVx(POPs))
139 #define POPul           ((unsigned long)SvIVx(POPs))
140 #ifdef HAS_QUAD
141 #define POPq            ((Quad_t)SvIVx(POPs))
142 #define POPuq           ((Uquad_t)SvUVx(POPs))
143 #endif
144
145 #define TOPs            (*sp)
146 #define TOPm1s          (*(sp-1))
147 #define TOPp1s          (*(sp+1))
148 #define TOPp            (SvPV(TOPs, PL_na))             /* deprecated */
149 #define TOPpx           (SvPV(TOPs, n_a))
150 #define TOPn            (SvNV(TOPs))
151 #define TOPi            ((IV)SvIV(TOPs))
152 #define TOPu            ((UV)SvUV(TOPs))
153 #define TOPl            ((long)SvIV(TOPs))
154 #define TOPul           ((unsigned long)SvUV(TOPs))
155 #ifdef HAS_QUAD
156 #define TOPq            ((Quad_t)SvIV(TOPs))
157 #define TOPuq           ((Uquad_t)SvUV(TOPs))
158 #endif
159
160 /* Go to some pains in the rare event that we must extend the stack. */
161
162 /*
163 =for apidoc Am|void|EXTEND|SP|int nitems
164 Used to extend the argument stack for an XSUB's return values. Once
165 used, guarantees that there is room for at least C<nitems> to be pushed
166 onto the stack.
167
168 =for apidoc Am|void|PUSHs|SV* sv
169 Push an SV onto the stack.  The stack must have room for this element.
170 Does not handle 'set' magic.  See C<XPUSHs>.
171
172 =for apidoc Am|void|PUSHp|char* str|STRLEN len
173 Push a string onto the stack.  The stack must have room for this element.
174 The C<len> indicates the length of the string.  Handles 'set' magic.  See
175 C<XPUSHp>.
176
177 =for apidoc Am|void|PUSHn|NV nv
178 Push a double onto the stack.  The stack must have room for this element.
179 Handles 'set' magic.  See C<XPUSHn>.
180
181 =for apidoc Am|void|PUSHi|IV iv
182 Push an integer onto the stack.  The stack must have room for this element.
183 Handles 'set' magic.  See C<XPUSHi>.
184
185 =for apidoc Am|void|PUSHu|UV uv
186 Push an unsigned integer onto the stack.  The stack must have room for this
187 element.  See C<XPUSHu>.
188
189 =for apidoc Am|void|XPUSHs|SV* sv
190 Push an SV onto the stack, extending the stack if necessary.  Does not
191 handle 'set' magic.  See C<PUSHs>.
192
193 =for apidoc Am|void|XPUSHp|char* str|STRLEN len
194 Push a string onto the stack, extending the stack if necessary.  The C<len>
195 indicates the length of the string.  Handles 'set' magic.  See
196 C<PUSHp>.
197
198 =for apidoc Am|void|XPUSHn|NV nv
199 Push a double onto the stack, extending the stack if necessary.  Handles
200 'set' magic.  See C<PUSHn>.
201
202 =for apidoc Am|void|XPUSHi|IV iv
203 Push an integer onto the stack, extending the stack if necessary.  Handles
204 'set' magic. See C<PUSHi>.
205
206 =for apidoc Am|void|XPUSHu|UV uv
207 Push an unsigned integer onto the stack, extending the stack if necessary.
208 See C<PUSHu>.
209
210 =cut
211 */
212
213 #define EXTEND(p,n)     STMT_START { if (PL_stack_max - p < (n)) {              \
214                             sp = stack_grow(sp,p, (int) (n));           \
215                         } } STMT_END
216
217 /* Same thing, but update mark register too. */
218 #define MEXTEND(p,n)    STMT_START {if (PL_stack_max - p < (n)) {               \
219                             int markoff = mark - PL_stack_base;         \
220                             sp = stack_grow(sp,p,(int) (n));            \
221                             mark = PL_stack_base + markoff;             \
222                         } } STMT_END
223
224 #define PUSHs(s)        (*++sp = (s))
225 #define PUSHTARG        STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
226 #define PUSHp(p,l)      STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
227 #define PUSHn(n)        STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
228 #define PUSHi(i)        STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
229 #define PUSHu(u)        STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
230
231 #define XPUSHs(s)       STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
232 #define XPUSHTARG       STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
233 #define XPUSHp(p,l)     STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
234 #define XPUSHn(n)       STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
235 #define XPUSHi(i)       STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
236 #define XPUSHu(u)       STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
237 #define XPUSHundef      STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
238
239 #define SETs(s)         (*sp = s)
240 #define SETTARG         STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
241 #define SETp(p,l)       STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
242 #define SETn(n)         STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
243 #define SETi(i)         STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
244 #define SETu(u)         STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
245
246 #define dTOPss          SV *sv = TOPs
247 #define dPOPss          SV *sv = POPs
248 #define dTOPnv          NV value = TOPn
249 #define dPOPnv          NV value = POPn
250 #define dTOPiv          IV value = TOPi
251 #define dPOPiv          IV value = POPi
252 #define dTOPuv          UV value = TOPu
253 #define dPOPuv          UV value = POPu
254 #ifdef HAS_QUAD
255 #define dTOPqv          Quad_t value = TOPu
256 #define dPOPqv          Quad_t value = POPu
257 #define dTOPuqv         Uquad_t value = TOPuq
258 #define dPOPuqv         Uquad_t value = POPuq
259 #endif
260
261 #define dPOPXssrl(X)    SV *right = POPs; SV *left = CAT2(X,s)
262 #define dPOPXnnrl(X)    NV right = POPn; NV left = CAT2(X,n)
263 #define dPOPXiirl(X)    IV right = POPi; IV left = CAT2(X,i)
264
265 #define USE_LEFT(sv) \
266         (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
267 #define dPOPXnnrl_ul(X) \
268     NV right = POPn;                            \
269     SV *leftsv = CAT2(X,s);                             \
270     NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
271 #define dPOPXiirl_ul(X) \
272     IV right = POPi;                                    \
273     SV *leftsv = CAT2(X,s);                             \
274     IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
275
276 #define dPOPPOPssrl     dPOPXssrl(POP)
277 #define dPOPPOPnnrl     dPOPXnnrl(POP)
278 #define dPOPPOPnnrl_ul  dPOPXnnrl_ul(POP)
279 #define dPOPPOPiirl     dPOPXiirl(POP)
280 #define dPOPPOPiirl_ul  dPOPXiirl_ul(POP)
281
282 #define dPOPTOPssrl     dPOPXssrl(TOP)
283 #define dPOPTOPnnrl     dPOPXnnrl(TOP)
284 #define dPOPTOPnnrl_ul  dPOPXnnrl_ul(TOP)
285 #define dPOPTOPiirl     dPOPXiirl(TOP)
286 #define dPOPTOPiirl_ul  dPOPXiirl_ul(TOP)
287
288 #define RETPUSHYES      RETURNX(PUSHs(&PL_sv_yes))
289 #define RETPUSHNO       RETURNX(PUSHs(&PL_sv_no))
290 #define RETPUSHUNDEF    RETURNX(PUSHs(&PL_sv_undef))
291
292 #define RETSETYES       RETURNX(SETs(&PL_sv_yes))
293 #define RETSETNO        RETURNX(SETs(&PL_sv_no))
294 #define RETSETUNDEF     RETURNX(SETs(&PL_sv_undef))
295
296 #define ARGTARG         PL_op->op_targ
297
298     /* See OPpTARGET_MY: */
299 #define MAXARG          (PL_op->op_private & 15)
300
301 #define SWITCHSTACK(f,t) \
302     STMT_START {                                                        \
303         AvFILLp(f) = sp - PL_stack_base;                                \
304         PL_stack_base = AvARRAY(t);                                     \
305         PL_stack_max = PL_stack_base + AvMAX(t);                        \
306         sp = PL_stack_sp = PL_stack_base + AvFILLp(t);                  \
307         PL_curstack = t;                                                \
308     } STMT_END
309
310 #define EXTEND_MORTAL(n) \
311     STMT_START {                                                        \
312         if (PL_tmps_ix + (n) >= PL_tmps_max)                            \
313             tmps_grow(n);                                               \
314     } STMT_END
315
316 #define AMGf_noright    1
317 #define AMGf_noleft     2
318 #define AMGf_assign     4
319 #define AMGf_unary      8
320
321 #define tryAMAGICbinW(meth,assign,set) STMT_START { \
322           if (PL_amagic_generation) { \
323             SV* tmpsv; \
324             SV* right= *(sp); SV* left= *(sp-1);\
325             if ((SvAMAGIC(left)||SvAMAGIC(right))&&\
326                 (tmpsv=amagic_call(left, \
327                                    right, \
328                                    CAT2(meth,_amg), \
329                                    (assign)? AMGf_assign: 0))) {\
330                SPAGAIN; \
331                (void)POPs; set(tmpsv); RETURN; } \
332           } \
333         } STMT_END
334
335 #define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
336 #define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
337
338 #define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef,  \
339                                         CAT2(meth,_amg),AMGf_noright | AMGf_unary)
340 #define AMG_CALLbinL(left,right,meth) \
341             amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
342
343 #define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
344           if (PL_amagic_generation) { \
345             SV* tmpsv; \
346             SV* arg= sp[shift]; \
347           if(0) goto am_again;  /* shut up unused warning */ \
348           am_again: \
349             if ((SvAMAGIC(arg))&&\
350                 (tmpsv=AMG_CALLun(arg,meth))) {\
351                SPAGAIN; if (shift) sp += shift; \
352                set(tmpsv); ret; } \
353           } \
354         } STMT_END
355
356 #define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
357
358 #define tryAMAGICun(meth)       tryAMAGICunW(meth,SETsvUN,0,RETURN)
359 #define tryAMAGICunSET(meth)    tryAMAGICunW(meth,SETs,0,RETURN)
360 #define tryAMAGICunTARGET(meth, shift)                                  \
361         { dSP; sp--;    /* get TARGET from below PL_stack_sp */         \
362             { dTARGETSTACKED;                                           \
363                 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}}
364
365 #define setAGAIN(ref) sv = ref;                                                 \
366   if (!SvROK(ref))                                                              \
367       Perl_croak(aTHX_ "Overloaded dereference did not return a reference");    \
368   if (ref != arg && SvRV(ref) != SvRV(arg)) {                                   \
369       arg = ref;                                                                \
370       goto am_again;                                                            \
371   }
372
373 #define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
374
375 #define opASSIGN (PL_op->op_flags & OPf_STACKED)
376 #define SETsv(sv)       STMT_START {                                    \
377                 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY))            \
378                    { sv_setsv(TARG, (sv)); SETTARG; }                   \
379                 else SETs(sv); } STMT_END
380
381 #define SETsvUN(sv)     STMT_START {                                    \
382                 if (SvFLAGS(TARG) & SVs_PADMY)          \
383                    { sv_setsv(TARG, (sv)); SETTARG; }                   \
384                 else SETs(sv); } STMT_END
385
386 /* newSVsv does not behave as advertised, so we copy missing
387  * information by hand */
388
389 /* SV* ref causes confusion with the member variable
390    changed SV* ref to SV* tmpRef */
391 #define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv);      \
392   if (SvREFCNT(tmpRef)>1) {                 \
393     SvREFCNT_dec(tmpRef);                   \
394     SvRV(rv)=AMG_CALLun(rv,copy);        \
395   } } STMT_END
396
397 /*
398 =for apidoc mU||LVRET
399 True if this op will be the return value of an lvalue subroutine
400
401 =cut */
402 #define LVRET ((PL_op->op_private & OPpMAYBE_LVSUB) && is_lvalue_sub())