pp.h

   1 /*    pp.h
   2  *
   3  *    Copyright (c) 1991-1999, 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_THREADS
  11 #define ARGS thr
  12 #define dARGS struct perl_thread *thr;
  13 #else
  14 #define ARGS
  15 #define dARGS
  16 #endif /* USE_THREADS */
  17
  18 #define PP(s) OP * Perl_##s(pTHX)
  19
  20 #define SP sp
  21 #define MARK mark
  22 #define TARG targ
  23
  24 #define PUSHMARK(p) if (++PL_markstack_ptr == PL_markstack_max) \
  25                         markstack_grow();                       \
  26                     *PL_markstack_ptr = (p) - PL_stack_base
  27
  28 #define TOPMARK         (*PL_markstack_ptr)
  29 #define POPMARK         (*PL_markstack_ptr--)
  30
  31 #define djSP            register SV **sp = PL_stack_sp
  32 #define dSP             dTHR; djSP
  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)
  37
  38 #define SPAGAIN         sp = PL_stack_sp
  39 #define MSPAGAIN        sp = PL_stack_sp; mark = ORIGMARK
  40
  41 #define GETTARGETSTACKED targ = (PL_op->op_flags & OPf_STACKED ? POPs : PAD_SV(PL_op->op_targ))
  42 #define dTARGETSTACKED SV * GETTARGETSTACKED
  43
  44 #define GETTARGET targ = PAD_SV(PL_op->op_targ)
  45 #define dTARGET SV * GETTARGET
  46
  47 #define GETATARGET targ = (PL_op->op_flags & OPf_STACKED ? sp[-1] : PAD_SV(PL_op->op_targ))
  48 #define dATARGET SV * GETATARGET
  49
  50 #define dTARG SV *targ
  51
  52 #define dXS_TARGET SV * targ = (PL_op->op_private & OPpENTERSUB_HASTARG ? PAD_SV(PL_op->op_targ) : sv_newmortal())
  53
  54 #define NORMAL PL_op->op_next
  55 #define DIE return Perl_die
  56
  57 #define PUTBACK         PL_stack_sp = sp
  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--)
  63 #define POPp            (SvPVx(POPs, PL_na))            /* deprecated */
  64 #define POPpx           (SvPVx(POPs, n_a))
  65 #define POPn            (SvNVx(POPs))
  66 #define POPi            ((IV)SvIVx(POPs))
  67 #define POPu            ((UV)SvUVx(POPs))
  68 #define POPl            ((long)SvIVx(POPs))
  69 #define POPul           ((unsigned long)SvIVx(POPs))
  70 #ifdef HAS_QUAD
  71 #define POPq            ((Quad_t)SvIVx(POPs))
  72 #define POPuq           ((Uquad_t)SvUVx(POPs))
  73 #endif
  74
  75 #define TOPs            (*sp)
  76 #define TOPp            (SvPV(TOPs, PL_na))             /* deprecated */
  77 #define TOPpx           (SvPV(TOPs, n_a))
  78 #define TOPn            (SvNV(TOPs))
  79 #define TOPi            ((IV)SvIV(TOPs))
  80 #define TOPu            ((UV)SvUV(TOPs))
  81 #define TOPl            ((long)SvIV(TOPs))
  82 #define TOPul           ((unsigned long)SvUV(TOPs))
  83 #ifdef HAS_QUAD
  84 #define TOPq            ((Quad_t)SvIV(TOPs))
  85 #define TOPuq           ((Uquad_t)SvUV(TOPs))
  86 #endif
  87
  88 /* Go to some pains in the rare event that we must extend the stack. */
  89 #define EXTEND(p,n)     STMT_START { if (PL_stack_max - p < (n)) {              \
  90                             sp = stack_grow(sp,p, (int) (n));           \
  91                         } } STMT_END
  92
  93 /* Same thing, but update mark register too. */
  94 #define MEXTEND(p,n)    STMT_START {if (PL_stack_max - p < (n)) {               \
  95                             int markoff = mark - PL_stack_base;         \
  96                             sp = stack_grow(sp,p,(int) (n));            \
  97                             mark = PL_stack_base + markoff;             \
  98                         } } STMT_END
  99
 100 #define PUSHs(s)        (*++sp = (s))
 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
 103 #define PUSHn(n)        STMT_START { sv_setnv(TARG, (NV)(n)); PUSHTARG; } STMT_END
 104 #define PUSHi(i)        STMT_START { sv_setiv(TARG, (IV)(i)); PUSHTARG; } STMT_END
 105 #define PUSHu(u)        STMT_START { sv_setuv(TARG, (UV)(u)); PUSHTARG; } STMT_END
 106
 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
 110 #define XPUSHn(n)       STMT_START { sv_setnv(TARG, (NV)(n)); XPUSHTARG; } STMT_END
 111 #define XPUSHi(i)       STMT_START { sv_setiv(TARG, (IV)(i)); XPUSHTARG; } STMT_END
 112 #define XPUSHu(u)       STMT_START { sv_setuv(TARG, (UV)(u)); XPUSHTARG; } STMT_END
 113 #define XPUSHundef      STMT_START { SvOK_off(TARG); XPUSHs(TARG); } STMT_END
 114
 115 #define SETs(s)         (*sp = s)
 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
 118 #define SETn(n)         STMT_START { sv_setnv(TARG, (NV)(n)); SETTARG; } STMT_END
 119 #define SETi(i)         STMT_START { sv_setiv(TARG, (IV)(i)); SETTARG; } STMT_END
 120 #define SETu(u)         STMT_START { sv_setuv(TARG, (UV)(u)); SETTARG; } STMT_END
 121
 122 #define dTOPss          SV *sv = TOPs
 123 #define dPOPss          SV *sv = POPs
 124 #define dTOPnv          NV value = TOPn
 125 #define dPOPnv          NV value = POPn
 126 #define dTOPiv          IV value = TOPi
 127 #define dPOPiv          IV value = POPi
 128 #define dTOPuv          UV value = TOPu
 129 #define dPOPuv          UV value = POPu
 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
 136
 137 #define dPOPXssrl(X)    SV *right = POPs; SV *left = CAT2(X,s)
 138 #define dPOPXnnrl(X)    NV right = POPn; NV left = CAT2(X,n)
 139 #define dPOPXiirl(X)    IV right = POPi; IV left = CAT2(X,i)
 140
 141 #define USE_LEFT(sv) \
 142         (SvOK(sv) || SvGMAGICAL(sv) || !(PL_op->op_flags & OPf_STACKED))
 143 #define dPOPXnnrl_ul(X) \
 144     NV right = POPn;                            \
 145     SV *leftsv = CAT2(X,s);                             \
 146     NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
 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)
 163
 164 #define RETPUSHYES      RETURNX(PUSHs(&PL_sv_yes))
 165 #define RETPUSHNO       RETURNX(PUSHs(&PL_sv_no))
 166 #define RETPUSHUNDEF    RETURNX(PUSHs(&PL_sv_undef))
 167
 168 #define RETSETYES       RETURNX(SETs(&PL_sv_yes))
 169 #define RETSETNO        RETURNX(SETs(&PL_sv_no))
 170 #define RETSETUNDEF     RETURNX(SETs(&PL_sv_undef))
 171
 172 #define ARGTARG         PL_op->op_targ
 173
 174     /* See OPpTARGET_MY: */
 175 #define MAXARG          (PL_op->op_private & 15)
 176
 177 #define SWITCHSTACK(f,t) \
 178     STMT_START {                                                        \
 179         AvFILLp(f) = sp - PL_stack_base;                                \
 180         PL_stack_base = AvARRAY(t);                                     \
 181         PL_stack_max = PL_stack_base + AvMAX(t);                        \
 182         sp = PL_stack_sp = PL_stack_base + AvFILLp(t);                  \
 183         PL_curstack = t;                                                \
 184     } STMT_END
 185
 186 #define EXTEND_MORTAL(n) \
 187     STMT_START {                                                        \
 188         if (PL_tmps_ix + (n) >= PL_tmps_max)                            \
 189             tmps_grow(n);                                               \
 190     } STMT_END
 191
 192 #define AMGf_noright    1
 193 #define AMGf_noleft     2
 194 #define AMGf_assign     4
 195 #define AMGf_unary      8
 196
 197 #define tryAMAGICbinW(meth,assign,set) STMT_START { \
 198           if (PL_amagic_generation) { \
 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           } \
 209         } STMT_END
 210
 211 #define tryAMAGICbin(meth,assign) tryAMAGICbinW(meth,assign,SETsv)
 212 #define tryAMAGICbinSET(meth,assign) tryAMAGICbinW(meth,assign,SETs)
 213
 214 #define AMG_CALLun(sv,meth) amagic_call(sv,&PL_sv_undef,  \
 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
 219 #define tryAMAGICunW(meth,set,shift,ret) STMT_START { \
 220           if (PL_amagic_generation) { \
 221             SV* tmpsv; \
 222             SV* arg= sp[shift]; \
 223           am_again: \
 224             if ((SvAMAGIC(arg))&&\
 225                 (tmpsv=AMG_CALLun(arg,meth))) {\
 226                SPAGAIN; if (shift) sp += shift; \
 227                set(tmpsv); ret; } \
 228           } \
 229         } STMT_END
 230
 231 #define FORCE_SETs(sv) STMT_START { sv_setsv(TARG, (sv)); SETTARG; } STMT_END
 232
 233 #define tryAMAGICun(meth)       tryAMAGICunW(meth,SETsvUN,0,RETURN)
 234 #define tryAMAGICunSET(meth)    tryAMAGICunW(meth,SETs,0,RETURN)
 235 #define tryAMAGICunTARGET(meth, shift)                                  \
 236         { dSP; sp--;    /* get TARGET from below PL_stack_sp */         \
 237             { dTARGETSTACKED;                                           \
 238                 { dSP; tryAMAGICunW(meth,FORCE_SETs,shift,RETURN);}}}
 239
 240 #define setAGAIN(ref) sv = arg = ref;                                   \
 241   if (!SvROK(ref))                                                      \
 242       Perl_croak(aTHX_ "Overloaded dereference did not return a reference");    \
 243   goto am_again;
 244
 245 #define tryAMAGICunDEREF(meth) tryAMAGICunW(meth,setAGAIN,0,(void)0)
 246
 247 #define opASSIGN (PL_op->op_flags & OPf_STACKED)
 248 #define SETsv(sv)       STMT_START {                                    \
 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; }                   \
 256                 else SETs(sv); } STMT_END
 257
 258 /* newSVsv does not behave as advertised, so we copy missing
 259  * information by hand */
 260
 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);                   \
 266     SvRV(rv)=AMG_CALLun(rv,copy);        \
 267   } } STMT_END