This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[ID 19990821.001] [PATCH] perl5.005_60 cygwin port
[perl5.git] / pp.h
CommitLineData
a0d0e21e 1/* pp.h
79072805 2 *
4eb8286e 3 * Copyright (c) 1991-1999, Larry Wall
79072805 4 *
a0d0e21e
LW
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.
79072805 7 *
a0d0e21e 8 */
79072805 9
11343788
MB
10#ifdef USE_THREADS
11#define ARGS thr
52e1cb5e 12#define dARGS struct perl_thread *thr;
11343788 13#else
79072805 14#define ARGS
79072805 15#define dARGS
11343788 16#endif /* USE_THREADS */
22c35a8c 17
cea2e8a9 18#define PP(s) OP * Perl_##s(pTHX)
79072805
LW
19
20#define SP sp
21#define MARK mark
22#define TARG targ
23
3280af22 24#define PUSHMARK(p) if (++PL_markstack_ptr == PL_markstack_max) \
a0d0e21e 25 markstack_grow(); \
3280af22 26 *PL_markstack_ptr = (p) - PL_stack_base
a0d0e21e 27
3280af22
NIS
28#define TOPMARK (*PL_markstack_ptr)
29#define POPMARK (*PL_markstack_ptr--)
a0d0e21e 30
3280af22 31#define djSP register SV **sp = PL_stack_sp
4e35701f 32#define dSP dTHR; djSP
3280af22
NIS
33#define dMARK register SV **mark = PL_stack_base + POPMARK
34#define dORIGMARK I32 origmark = mark - PL_stack_base
35#define SETORIGMARK origmark = mark - PL_stack_base
36#define ORIGMARK (PL_stack_base + origmark)
79072805 37
3280af22
NIS
38#define SPAGAIN sp = PL_stack_sp
39#define MSPAGAIN sp = PL_stack_sp; mark = ORIGMARK
79072805 40
533c011a 41#define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
79072805
LW
42#define dTARGETSTACKED SV * GETTARGETSTACKED
43
533c011a 44#define GETTARGET targ = PAD_SV(PL_op->op_targ)
79072805
LW
45#define dTARGET SV * GETTARGET
46
533c011a 47#define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
79072805
LW
48#define dATARGET SV * GETATARGET
49
50#define dTARG SV *targ
51
d3011074
IZ
52#define dXS_TARGET SV * targ = (PL_op->op_private & OPpENTERSUB_HASTARG ? PAD_SV(PL_op->op_targ) : sv_newmortal())
53
533c011a 54#define NORMAL PL_op->op_next
cea2e8a9 55#define DIE return Perl_die
79072805 56
3280af22 57#define PUTBACK PL_stack_sp = sp
79072805
LW
58#define RETURN return PUTBACK, NORMAL
59#define RETURNOP(o) return PUTBACK, o
60#define RETURNX(x) return x, PUTBACK, NORMAL
61
62#define POPs (*sp--)
2d8e6c8d
GS
63#define POPp (SvPVx(POPs, PL_na)) /* deprecated */
64#define POPpx (SvPVx(POPs, n_a))
463ee0b2 65#define POPn (SvNVx(POPs))
a0d0e21e 66#define POPi ((IV)SvIVx(POPs))
ff68c719 67#define POPu ((UV)SvUVx(POPs))
463ee0b2 68#define POPl ((long)SvIVx(POPs))
d9b3e12d
JH
69#define POPul ((unsigned long)SvIVx(POPs))
70#ifdef HAS_QUAD
71#define POPq ((Quad_t)SvIVx(POPs))
c5a0f51a 72#define POPuq ((Uquad_t)SvUVx(POPs))
d9b3e12d 73#endif
79072805
LW
74
75#define TOPs (*sp)
2d8e6c8d
GS
76#define TOPp (SvPV(TOPs, PL_na)) /* deprecated */
77#define TOPpx (SvPV(TOPs, n_a))
463ee0b2 78#define TOPn (SvNV(TOPs))
a0d0e21e 79#define TOPi ((IV)SvIV(TOPs))
ff68c719 80#define TOPu ((UV)SvUV(TOPs))
463ee0b2 81#define TOPl ((long)SvIV(TOPs))
c5a0f51a 82#define TOPul ((unsigned long)SvUV(TOPs))
d9b3e12d
JH
83#ifdef HAS_QUAD
84#define TOPq ((Quad_t)SvIV(TOPs))
c5a0f51a 85#define TOPuq ((Uquad_t)SvUV(TOPs))
d9b3e12d 86#endif
79072805
LW
87
88/* Go to some pains in the rare event that we must extend the stack. */
3280af22 89#define EXTEND(p,n) STMT_START { if (PL_stack_max - p < (n)) { \
bbce6d69 90 sp = stack_grow(sp,p, (int) (n)); \
86547924 91 } } STMT_END
a0d0e21e 92
79072805 93/* Same thing, but update mark register too. */
3280af22
NIS
94#define MEXTEND(p,n) STMT_START {if (PL_stack_max - p < (n)) { \
95 int markoff = mark - PL_stack_base; \
bbce6d69 96 sp = stack_grow(sp,p,(int) (n)); \
3280af22 97 mark = PL_stack_base + markoff; \
86547924 98 } } STMT_END
79072805
LW
99
100#define PUSHs(s) (*++sp = (s))
86547924 101#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
102#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
65202027 103#define PUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
86547924 104#define PUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
55497cff 105#define PUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
79072805 106
86547924 107#define XPUSHs(s) STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
108#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
109#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
65202027 110#define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
86547924 111#define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
55497cff 112#define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
b162f9ea 113#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805
LW
114
115#define SETs(s) (*sp = s)
86547924 116#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
117#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
65202027 118#define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
86547924 119#define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
55497cff 120#define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
a0d0e21e 121
79072805
LW
122#define dTOPss SV *sv = TOPs
123#define dPOPss SV *sv = POPs
65202027
DS
124#define dTOPnv NV value = TOPn
125#define dPOPnv NV value = POPn
a0d0e21e
LW
126#define dTOPiv IV value = TOPi
127#define dPOPiv IV value = POPi
55497cff 128#define dTOPuv UV value = TOPu
129#define dPOPuv UV value = POPu
2d4389e4
JH
130#ifdef HAS_QUAD
131#define dTOPqv Quad_t value = TOPu
132#define dPOPqv Quad_t value = POPu
133#define dTOPuqv Uquad_t value = TOPuq
134#define dPOPuqv Uquad_t value = POPuq
135#endif
79072805 136
7a4c00b4 137#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 138#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4 139#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
140
141#define USE_LEFT(sv) \
533c011a 142 (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
7a4c00b4 143#define dPOPXnnrl_ul(X) \
65202027 144 NV right = POPn; \
7a4c00b4 145 SV *leftsv = CAT2(X,s); \
65202027 146 NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
7a4c00b4 147#define dPOPXiirl_ul(X) \
148 IV right = POPi; \
149 SV *leftsv = CAT2(X,s); \
150 IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
151
152#define dPOPPOPssrl dPOPXssrl(POP)
153#define dPOPPOPnnrl dPOPXnnrl(POP)
154#define dPOPPOPnnrl_ul dPOPXnnrl_ul(POP)
155#define dPOPPOPiirl dPOPXiirl(POP)
156#define dPOPPOPiirl_ul dPOPXiirl_ul(POP)
157
158#define dPOPTOPssrl dPOPXssrl(TOP)
159#define dPOPTOPnnrl dPOPXnnrl(TOP)
160#define dPOPTOPnnrl_ul dPOPXnnrl_ul(TOP)
161#define dPOPTOPiirl dPOPXiirl(TOP)
162#define dPOPTOPiirl_ul dPOPXiirl_ul(TOP)
79072805 163
3280af22
NIS
164#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
165#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
166#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 167
3280af22
NIS
168#define RETSETYES RETURNX(SETs(&PL_sv_yes))
169#define RETSETNO RETURNX(SETs(&PL_sv_no))
170#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
79072805 171
533c011a 172#define ARGTARG PL_op->op_targ
b162f9ea
IZ
173
174 /* See OPpTARGET_MY: */
175#define MAXARG (PL_op->op_private & 15)
79072805 176
e336de0d
GS
177#define SWITCHSTACK(f,t) \
178 STMT_START { \
677b06e3 179 AvFILLp(f) = sp - PL_stack_base; \
3280af22 180 PL_stack_base = AvARRAY(t); \
677b06e3 181 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 182 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 183 PL_curstack = t; \
e336de0d 184 } STMT_END
79072805 185
bbce6d69 186#define EXTEND_MORTAL(n) \
677b06e3
GS
187 STMT_START { \
188 if (PL_tmps_ix + (n) >= PL_tmps_max) \
189 tmps_grow(n); \
190 } STMT_END
bbce6d69 191
a0d0e21e
LW
192#define AMGf_noright 1
193#define AMGf_noleft 2
194#define AMGf_assign 4
195#define AMGf_unary 8
196
86547924 197#define tryAMAGICbinW(meth,assign,set) STMT_START { \
3280af22 198 if (PL_amagic_generation) { \
a0d0e21e
LW
199 SV* tmpsv; \
200 SV* right= *(sp); SV* left= *(sp-1);\
201 if ((SvAMAGIC(left)||SvAMAGIC(right))&&\
202 (tmpsv=amagic_call(left, \
203 right, \
204 CAT2(meth,_amg), \
205 (assign)? AMGf_assign: 0))) {\
206 SPAGAIN; \
207 (void)POPs; set(tmpsv); RETURN; } \
208 } \
86547924 209 } STMT_END
a0d0e21e
LW
210
211#define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
212#define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
213
3280af22 214#define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef, \
a0d0e21e
LW
215 CAT2(meth,_amg),AMGf_noright | AMGf_unary)
216#define AMG_CALLbinL(left,right,meth) \
217 amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
218
e8c20960 219#define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
3280af22 220 if (PL_amagic_generation) { \
a0d0e21e 221 SV* tmpsv; \
f5284f61
IZ
222 SV* arg= sp[shift]; \
223 am_again: \
a0d0e21e
LW
224 if ((SvAMAGIC(arg))&&\
225 (tmpsv=AMG_CALLun(arg,meth))) {\
f5284f61 226 SPAGAIN; if (shift) sp += shift; \
e8c20960 227 set(tmpsv); ret; } \
a0d0e21e 228 } \
86547924 229 } STMT_END
a0d0e21e 230
f5284f61
IZ
231#define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
232
b162f9ea
IZ
233#define tryAMAGICun(meth) tryAMAGICunW(meth,SETsvUN,0,RETURN)
234#define tryAMAGICunSET(meth) tryAMAGICunW(meth,SETs,0,RETURN)
f5284f61
IZ
235#define tryAMAGICunTARGET(meth, shift) \
236 { dSP; sp--; /* get TARGET from below PL_stack_sp */ \
237 { dTARGETSTACKED; \
e8c20960
IZ
238 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}}
239
240#define setAGAIN(ref) sv = arg = ref; \
241 if (!SvROK(ref)) \
cea2e8a9 242 Perl_croak(aTHX_ "Overloaded dereference did not return a reference"); \
e8c20960
IZ
243 goto am_again;
244
0f4592ef 245#define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
a0d0e21e 246
533c011a 247#define opASSIGN (PL_op->op_flags & OPf_STACKED)
e9905555 248#define SETsv(sv) STMT_START { \
b162f9ea
IZ
249 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY)) \
250 { sv_setsv(TARG, (sv)); SETTARG; } \
251 else SETs(sv); } STMT_END
252
253#define SETsvUN(sv) STMT_START { \
254 if (SvFLAGS(TARG) & SVs_PADMY) \
255 { sv_setsv(TARG, (sv)); SETTARG; } \
e9905555 256 else SETs(sv); } STMT_END
a0d0e21e
LW
257
258/* newSVsv does not behave as advertised, so we copy missing
259 * information by hand */
260
76e3520e
GS
261/* SV* ref causes confusion with the member variable
262 changed SV* ref to SV* tmpRef */
263#define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); \
264 if (SvREFCNT(tmpRef)>1) { \
265 SvREFCNT_dec(tmpRef); \
748a9306 266 SvRV(rv)=AMG_CALLun(rv,copy); \
86547924 267 } } STMT_END