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