This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Retract change #3977 (do_open9() adds O_LARGEFILE automagically).
[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
533c011a 52#define NORMAL PL_op->op_next
cea2e8a9 53#define DIE return Perl_die
79072805 54
3280af22 55#define PUTBACK PL_stack_sp = sp
79072805
LW
56#define RETURN return PUTBACK, NORMAL
57#define RETURNOP(o) return PUTBACK, o
58#define RETURNX(x) return x, PUTBACK, NORMAL
59
60#define POPs (*sp--)
2d8e6c8d
GS
61#define POPp (SvPVx(POPs, PL_na)) /* deprecated */
62#define POPpx (SvPVx(POPs, n_a))
463ee0b2 63#define POPn (SvNVx(POPs))
a0d0e21e 64#define POPi ((IV)SvIVx(POPs))
ff68c719 65#define POPu ((UV)SvUVx(POPs))
463ee0b2 66#define POPl ((long)SvIVx(POPs))
79072805
LW
67
68#define TOPs (*sp)
2d8e6c8d
GS
69#define TOPp (SvPV(TOPs, PL_na)) /* deprecated */
70#define TOPpx (SvPV(TOPs, n_a))
463ee0b2 71#define TOPn (SvNV(TOPs))
a0d0e21e 72#define TOPi ((IV)SvIV(TOPs))
ff68c719 73#define TOPu ((UV)SvUV(TOPs))
463ee0b2 74#define TOPl ((long)SvIV(TOPs))
79072805
LW
75
76/* Go to some pains in the rare event that we must extend the stack. */
3280af22 77#define EXTEND(p,n) STMT_START { if (PL_stack_max - p < (n)) { \
bbce6d69 78 sp = stack_grow(sp,p, (int) (n)); \
86547924 79 } } STMT_END
a0d0e21e 80
79072805 81/* Same thing, but update mark register too. */
3280af22
NIS
82#define MEXTEND(p,n) STMT_START {if (PL_stack_max - p < (n)) { \
83 int markoff = mark - PL_stack_base; \
bbce6d69 84 sp = stack_grow(sp,p,(int) (n)); \
3280af22 85 mark = PL_stack_base + markoff; \
86547924 86 } } STMT_END
79072805
LW
87
88#define PUSHs(s) (*++sp = (s))
86547924
PP
89#define PUSHTARG STMT_START { SvSETMAGIC(TARG); PUSHs(TARG); } STMT_END
90#define PUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); PUSHTARG; } STMT_END
65202027 91#define PUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
86547924 92#define PUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
55497cff 93#define PUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
79072805 94
86547924
PP
95#define XPUSHs(s) STMT_START { EXTEND(sp,1); (*++sp = (s)); } STMT_END
96#define XPUSHTARG STMT_START { SvSETMAGIC(TARG); XPUSHs(TARG); } STMT_END
97#define XPUSHp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); XPUSHTARG; } STMT_END
65202027 98#define XPUSHn(n) STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
86547924 99#define XPUSHi(i) STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
55497cff 100#define XPUSHu(u) STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
b162f9ea 101#define XPUSHundef STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
79072805
LW
102
103#define SETs(s) (*sp = s)
86547924
PP
104#define SETTARG STMT_START { SvSETMAGIC(TARG); SETs(TARG); } STMT_END
105#define SETp(p,l) STMT_START { sv_setpvn(TARG, (p), (l)); SETTARG; } STMT_END
65202027 106#define SETn(n) STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
86547924 107#define SETi(i) STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
55497cff 108#define SETu(u) STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
a0d0e21e 109
79072805
LW
110#define dTOPss SV *sv = TOPs
111#define dPOPss SV *sv = POPs
65202027
DS
112#define dTOPnv NV value = TOPn
113#define dPOPnv NV value = POPn
a0d0e21e
LW
114#define dTOPiv IV value = TOPi
115#define dPOPiv IV value = POPi
55497cff
PP
116#define dTOPuv UV value = TOPu
117#define dPOPuv UV value = POPu
79072805 118
7a4c00b4 119#define dPOPXssrl(X) SV *right = POPs; SV *left = CAT2(X,s)
65202027 120#define dPOPXnnrl(X) NV right = POPn; NV left = CAT2(X,n)
7a4c00b4
PP
121#define dPOPXiirl(X) IV right = POPi; IV left = CAT2(X,i)
122
123#define USE_LEFT(sv) \
533c011a 124 (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
7a4c00b4 125#define dPOPXnnrl_ul(X) \
65202027 126 NV right = POPn; \
7a4c00b4 127 SV *leftsv = CAT2(X,s); \
65202027 128 NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
7a4c00b4
PP
129#define dPOPXiirl_ul(X) \
130 IV right = POPi; \
131 SV *leftsv = CAT2(X,s); \
132 IV left = USE_LEFT(leftsv) ? SvIV(leftsv) : 0
133
134#define dPOPPOPssrl dPOPXssrl(POP)
135#define dPOPPOPnnrl dPOPXnnrl(POP)
136#define dPOPPOPnnrl_ul dPOPXnnrl_ul(POP)
137#define dPOPPOPiirl dPOPXiirl(POP)
138#define dPOPPOPiirl_ul dPOPXiirl_ul(POP)
139
140#define dPOPTOPssrl dPOPXssrl(TOP)
141#define dPOPTOPnnrl dPOPXnnrl(TOP)
142#define dPOPTOPnnrl_ul dPOPXnnrl_ul(TOP)
143#define dPOPTOPiirl dPOPXiirl(TOP)
144#define dPOPTOPiirl_ul dPOPXiirl_ul(TOP)
79072805 145
3280af22
NIS
146#define RETPUSHYES RETURNX(PUSHs(&PL_sv_yes))
147#define RETPUSHNO RETURNX(PUSHs(&PL_sv_no))
148#define RETPUSHUNDEF RETURNX(PUSHs(&PL_sv_undef))
79072805 149
3280af22
NIS
150#define RETSETYES RETURNX(SETs(&PL_sv_yes))
151#define RETSETNO RETURNX(SETs(&PL_sv_no))
152#define RETSETUNDEF RETURNX(SETs(&PL_sv_undef))
79072805 153
533c011a 154#define ARGTARG PL_op->op_targ
b162f9ea
IZ
155
156 /* See OPpTARGET_MY: */
157#define MAXARG (PL_op->op_private & 15)
79072805 158
e336de0d
GS
159#define SWITCHSTACK(f,t) \
160 STMT_START { \
677b06e3 161 AvFILLp(f) = sp - PL_stack_base; \
3280af22 162 PL_stack_base = AvARRAY(t); \
677b06e3 163 PL_stack_max = PL_stack_base + AvMAX(t); \
3280af22 164 sp = PL_stack_sp = PL_stack_base + AvFILLp(t); \
677b06e3 165 PL_curstack = t; \
e336de0d 166 } STMT_END
79072805 167
bbce6d69 168#define EXTEND_MORTAL(n) \
677b06e3
GS
169 STMT_START { \
170 if (PL_tmps_ix + (n) >= PL_tmps_max) \
171 tmps_grow(n); \
172 } STMT_END
bbce6d69 173
a0d0e21e
LW
174#define AMGf_noright 1
175#define AMGf_noleft 2
176#define AMGf_assign 4
177#define AMGf_unary 8
178
86547924 179#define tryAMAGICbinW(meth,assign,set) STMT_START { \
3280af22 180 if (PL_amagic_generation) { \
a0d0e21e
LW
181 SV* tmpsv; \
182 SV* right= *(sp); SV* left= *(sp-1);\
183 if ((SvAMAGIC(left)||SvAMAGIC(right))&&\
184 (tmpsv=amagic_call(left, \
185 right, \
186 CAT2(meth,_amg), \
187 (assign)? AMGf_assign: 0))) {\
188 SPAGAIN; \
189 (void)POPs; set(tmpsv); RETURN; } \
190 } \
86547924 191 } STMT_END
a0d0e21e
LW
192
193#define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
194#define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
195
3280af22 196#define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef, \
a0d0e21e
LW
197 CAT2(meth,_amg),AMGf_noright | AMGf_unary)
198#define AMG_CALLbinL(left,right,meth) \
199 amagic_call(left,right,CAT2(meth,_amg),AMGf_noright)
200
e8c20960 201#define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
3280af22 202 if (PL_amagic_generation) { \
a0d0e21e 203 SV* tmpsv; \
f5284f61
IZ
204 SV* arg= sp[shift]; \
205 am_again: \
a0d0e21e
LW
206 if ((SvAMAGIC(arg))&&\
207 (tmpsv=AMG_CALLun(arg,meth))) {\
f5284f61 208 SPAGAIN; if (shift) sp += shift; \
e8c20960 209 set(tmpsv); ret; } \
a0d0e21e 210 } \
86547924 211 } STMT_END
a0d0e21e 212
f5284f61
IZ
213#define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
214
b162f9ea
IZ
215#define tryAMAGICun(meth) tryAMAGICunW(meth,SETsvUN,0,RETURN)
216#define tryAMAGICunSET(meth) tryAMAGICunW(meth,SETs,0,RETURN)
f5284f61
IZ
217#define tryAMAGICunTARGET(meth, shift) \
218 { dSP; sp--; /* get TARGET from below PL_stack_sp */ \
219 { dTARGETSTACKED; \
e8c20960
IZ
220 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}}
221
222#define setAGAIN(ref) sv = arg = ref; \
223 if (!SvROK(ref)) \
cea2e8a9 224 Perl_croak(aTHX_ "Overloaded dereference did not return a reference"); \
e8c20960
IZ
225 goto am_again;
226
0f4592ef 227#define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
a0d0e21e 228
533c011a 229#define opASSIGN (PL_op->op_flags & OPf_STACKED)
e9905555 230#define SETsv(sv) STMT_START { \
b162f9ea
IZ
231 if (opASSIGN || (SvFLAGS(TARG) & SVs_PADMY)) \
232 { sv_setsv(TARG, (sv)); SETTARG; } \
233 else SETs(sv); } STMT_END
234
235#define SETsvUN(sv) STMT_START { \
236 if (SvFLAGS(TARG) & SVs_PADMY) \
237 { sv_setsv(TARG, (sv)); SETTARG; } \
e9905555 238 else SETs(sv); } STMT_END
a0d0e21e
LW
239
240/* newSVsv does not behave as advertised, so we copy missing
241 * information by hand */
242
76e3520e
GS
243/* SV* ref causes confusion with the member variable
244 changed SV* ref to SV* tmpRef */
245#define RvDEEPCP(rv) STMT_START { SV* tmpRef=SvRV(rv); \
246 if (SvREFCNT(tmpRef)>1) { \
247 SvREFCNT_dec(tmpRef); \
748a9306 248 SvRV(rv)=AMG_CALLun(rv,copy); \
86547924 249 } } STMT_END