Upper.xs

   1 /* This file is part of the Scope::Upper Perl module.
   2  * See http://search.cpan.org/dist/Scope-Upper/ */
   3
   4 #define PERL_NO_GET_CONTEXT
   5 #include "EXTERN.h"
   6 #include "perl.h"
   7 #include "XSUB.h"
   8
   9 #ifndef SU_DEBUG
  10 # define SU_DEBUG 0
  11 #endif
  12
  13 /* --- Compatibility ------------------------------------------------------- */
  14
  15 #ifndef STMT_START
  16 # define STMT_START do
  17 #endif
  18
  19 #ifndef STMT_END
  20 # define STMT_END while (0)
  21 #endif
  22
  23 #if SU_DEBUG
  24 # define SU_D(X) STMT_START X STMT_END
  25 #else
  26 # define SU_D(X)
  27 #endif
  28
  29 #ifndef Newx
  30 # define Newx(v, n, c) New(0, v, n, c)
  31 #endif
  32
  33 #ifndef SvPV_const
  34 # define SvPV_const(S, L) SvPV(S, L)
  35 #endif
  36
  37 #ifndef SvPV_nolen_const
  38 # define SvPV_nolen_const(S) SvPV_nolen(S)
  39 #endif
  40
  41 #ifndef HvNAME_get
  42 # define HvNAME_get(H) HvNAME(H)
  43 #endif
  44
  45 #ifndef gv_fetchpvn_flags
  46 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
  47 #endif
  48
  49 #ifndef PERL_MAGIC_tied
  50 # define PERL_MAGIC_tied 'P'
  51 #endif
  52
  53 #ifndef PERL_MAGIC_env
  54 # define PERL_MAGIC_env 'E'
  55 #endif
  56
  57 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  58
  59 /* --- Stack manipulations ------------------------------------------------- */
  60
  61 #ifndef SvCANEXISTDELETE
  62 # define SvCANEXISTDELETE(sv) \
  63   (!SvRMAGICAL(sv)            \
  64    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
  65        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
  66        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
  67        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
  68       )                       \
  69    )
  70 #endif
  71
  72 /* ... Saving array elements ............................................... */
  73
  74 STATIC I32 su_av_preeminent(pTHX_ AV *av, I32 key) {
  75 #define su_av_preeminent(A, K) su_av_preeminent(aTHX_ (A), (K))
  76  MAGIC *mg;
  77  HV *stash;
  78
  79  if (!av) return 0;
  80  if (SvCANEXISTDELETE(av))
  81   return av_exists(av, key);
  82
  83  return 1;
  84 }
  85
  86 #ifndef SAVEADELETE
  87
  88 typedef struct {
  89  AV *av;
  90  I32 key;
  91 } su_ud_adelete;
  92
  93 STATIC void su_adelete(pTHX_ void *ud_) {
  94  su_ud_adelete *ud = ud_;
  95
  96  av_delete(ud->av, ud->key, G_DISCARD);
  97  SvREFCNT_dec(ud->av);
  98
  99  Safefree(ud);
 100 }
 101
 102 STATIC void su_save_adelete(pTHX_ AV *av, I32 key) {
 103 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 104  su_ud_adelete *ud;
 105
 106  Newx(ud, 1, su_ud_adelete);
 107  ud->av  = av;
 108  ud->key = key;
 109  SvREFCNT_inc(av);
 110
 111  SAVEDESTRUCTOR_X(su_adelete, ud);
 112 }
 113
 114 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 115
 116 #endif /* SAVEADELETE */
 117
 118 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 119 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 120  I32 idx;
 121  I32 preeminent;
 122  SV **svp;
 123
 124  idx = SvIV(key);
 125  preeminent = su_av_preeminent(av, idx);
 126  svp = av_fetch(av, idx, 1);
 127  if (!*svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 128
 129  if (preeminent)
 130   save_aelem(av, idx, svp);
 131  else
 132   SAVEADELETE(av, idx);
 133
 134  if (val) { /* local $x[$idx] = $val; */
 135   SvSetMagicSV(*svp, val);
 136  } else {   /* local $x[$idx]; delete $x[$idx]; */
 137   av_delete(av, idx, G_DISCARD);
 138  }
 139 }
 140
 141 /* ... Saving hash elements ................................................ */
 142
 143 STATIC I32 su_hv_preeminent(pTHX_ HV *hv, SV *keysv) {
 144 #define su_hv_preeminent(H, K) su_hv_preeminent(aTHX_ (H), (K))
 145  MAGIC *mg;
 146  HV *stash;
 147
 148  if (!hv) return 0;
 149  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 150   return hv_exists_ent(hv, keysv, 0);
 151
 152  return 1;
 153 }
 154
 155 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 156 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 157  I32 preeminent;
 158  HE *he;
 159  SV **svp;
 160
 161  preeminent = su_hv_preeminent(hv, keysv);
 162  he  = hv_fetch_ent(hv, keysv, 1, 0);
 163  svp = he ? &HeVAL(he) : NULL;
 164  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 165
 166  if (HvNAME_get(hv) && isGV(*svp)) {
 167   save_gp((GV *) *svp, 0);
 168   return;
 169  }
 170
 171  if (preeminent)
 172   save_helem(hv, keysv, svp);
 173  else {
 174   STRLEN keylen;
 175   const char * const key = SvPV_const(keysv, keylen);
 176   SAVEDELETE(hv, savepvn(key, keylen),
 177                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 178  }
 179
 180  if (val) { /* local $x{$keysv} = $val; */
 181   SvSetMagicSV(*svp, val);
 182  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 183   hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 184  }
 185 }
 186
 187 /* --- Actions ------------------------------------------------------------- */
 188
 189 typedef struct {
 190  I32 depth;
 191  I32 *origin;
 192  void (*handler)(pTHX_ void *);
 193 } su_ud_common;
 194
 195 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 196 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 197 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 198
 199 #define SU_UD_FREE(U) STMT_START { \
 200  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 201  Safefree(U); \
 202 } STMT_END
 203
 204 /* ... Reap ................................................................ */
 205
 206 typedef struct {
 207  su_ud_common ci;
 208  SV *cb;
 209 } su_ud_reap;
 210
 211 STATIC void su_call(pTHX_ void *ud_) {
 212  su_ud_reap *ud = (su_ud_reap *) ud_;
 213 #if SU_HAS_PERL(5, 10, 0)
 214  I32 dieing = PL_op->op_type == OP_DIE;
 215 #endif
 216
 217  dSP;
 218
 219  SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
 220                                      ud, PL_scopestack_ix, PL_savestack_ix));
 221  ENTER;
 222  SAVETMPS;
 223
 224  PUSHMARK(SP);
 225  PUTBACK;
 226
 227  /* If cxstack_ix isn't incremented there, the eval context will be overwritten
 228   * when the new sub scope will be created in call_sv. */
 229
 230 #if SU_HAS_PERL(5, 10, 0)
 231  if (dieing)
 232   if (cxstack_ix < cxstack_max)
 233    ++cxstack_ix;
 234   else
 235    cxstack_ix = Perl_cxinc(aTHX);
 236 #endif
 237
 238  call_sv(ud->cb, G_VOID);
 239
 240 #if SU_HAS_PERL(5, 10, 0)
 241  if (dieing && cxstack_ix > 0)
 242   --cxstack_ix;
 243 #endif
 244
 245  SPAGAIN;
 246  PUTBACK;
 247
 248  FREETMPS;
 249  LEAVE;
 250
 251  SvREFCNT_dec(ud->cb);
 252  SU_UD_FREE(ud);
 253 }
 254
 255 STATIC void su_reap(pTHX_ void *ud) {
 256 #define su_reap(U) su_reap(aTHX_ (U))
 257  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
 258                                      ud, PL_scopestack_ix, PL_savestack_ix));
 259  SAVEDESTRUCTOR_X(su_call, ud);
 260  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 261                                      ud, PL_savestack_ix,
 262                                          PL_scopestack[PL_scopestack_ix]));
 263 }
 264
 265 /* ... Localize & localize array/hash element .............................. */
 266
 267 typedef struct {
 268  su_ud_common ci;
 269  SV *sv;
 270  SV *val;
 271  SV *elem;
 272 } su_ud_localize;
 273
 274 STATIC void su_localize(pTHX_ void *ud_) {
 275 #define su_localize(U) su_localize(aTHX_ (U))
 276  su_ud_localize *ud = (su_ud_localize *) ud_;
 277  SV *sv   = ud->sv;
 278  SV *val  = ud->val;
 279  SV *elem = ud->elem;
 280  GV *gv;
 281  UV deref = 0;
 282  svtype t = SVt_NULL;
 283
 284  if (SvTYPE(sv) >= SVt_PVGV) {
 285   gv = (GV *) sv;
 286   if (!val) {               /* local *x; */
 287    t = SVt_PVGV;
 288   } else if (!SvROK(val)) { /* local *x = $val; */
 289    goto assign;
 290   } else {                  /* local *x = \$val; */
 291    t = SvTYPE(SvRV(val));
 292    deref = 1;
 293   }
 294  } else {
 295   STRLEN len, l;
 296   const char *p = SvPV_const(sv, len), *s;
 297   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 298   if (!l) {
 299    l = len;
 300    s = p;
 301   }
 302   switch (*s) {
 303    case '$': t = SVt_PV;   break;
 304    case '@': t = SVt_PVAV; break;
 305    case '%': t = SVt_PVHV; break;
 306    case '&': t = SVt_PVCV; break;
 307    case '*': t = SVt_PVGV; break;
 308   }
 309   if (t != SVt_NULL) {
 310    ++s;
 311    --l;
 312   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 313    if (SvROK(val) && !sv_isobject(val)) {
 314     t = SvTYPE(SvRV(val));
 315     deref = 1;
 316    } else {
 317     t = SvTYPE(val);
 318    }
 319   }
 320   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 321  }
 322
 323  SU_D({
 324   SV *z = newSV_type(t);
 325   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
 326                                  ud, sv_reftype(z, 0),
 327                                      PL_scopestack_ix, PL_savestack_ix);
 328   SvREFCNT_dec(z);
 329  });
 330
 331  /* Inspired from Alias.pm */
 332  switch (t) {
 333   case SVt_PVAV:
 334    if (elem) {
 335     AV *av = GvAV(gv);
 336     su_save_aelem(av, elem, val);
 337     goto done;
 338    } else
 339     save_ary(gv);
 340    break;
 341   case SVt_PVHV:
 342    if (elem) {
 343     HV *hv = GvHV(gv);
 344     su_save_helem(hv, elem, val);
 345     goto done;
 346    } else
 347     save_hash(gv);
 348    break;
 349   case SVt_PVGV:
 350    save_gp(gv, 1); /* hide previous entry in symtab */
 351    break;
 352   case SVt_PVCV:
 353    SAVESPTR(GvCV(gv));
 354    GvCV(gv) = NULL;
 355    break;
 356   default:
 357    gv = (GV *) save_scalar(gv);
 358 maybe_deref:
 359    if (deref) /* val != NULL */
 360     val = SvRV(val);
 361    break;
 362  }
 363
 364  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 365                                      ud, PL_savestack_ix,
 366                                          PL_scopestack[PL_scopestack_ix]));
 367
 368 assign:
 369  if (val)
 370   SvSetMagicSV((SV *) gv, val);
 371
 372 done:
 373  SvREFCNT_dec(ud->elem);
 374  SvREFCNT_dec(ud->val);
 375  SvREFCNT_dec(ud->sv);
 376  SU_UD_FREE(ud);
 377 }
 378
 379 /* --- Pop a context back -------------------------------------------------- */
 380
 381 #if SU_DEBUG
 382 # ifdef DEBUGGING
 383 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 384 # else
 385 #  define SU_CXNAME "XXX"
 386 # endif
 387 #endif
 388
 389 STATIC void su_pop(pTHX_ void *ud) {
 390 #define su_pop(U) su_pop(aTHX_ (U))
 391  I32 depth, base, mark, *origin;
 392  depth = SU_UD_DEPTH(ud);
 393
 394  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
 395                                      ud, SU_CXNAME,
 396                                          PL_scopestack_ix, PL_savestack_ix,
 397                                          PL_scopestack[PL_scopestack_ix],
 398                                          depth));
 399
 400  origin = SU_UD_ORIGIN(ud);
 401  mark   = origin[depth];
 402  base   = origin[depth - 1];
 403
 404  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
 405                                      ud, mark, base));
 406
 407  if (base < mark) {
 408   PL_savestack_ix = mark;
 409   leave_scope(base);
 410  }
 411  PL_savestack_ix = base;
 412  if (--depth > 0) {
 413   SU_UD_DEPTH(ud) = depth;
 414   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
 415                                       ud, PL_savestack_ix, depth));
 416   SAVEDESTRUCTOR_X(su_pop, ud);
 417   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
 418                                       ud, PL_savestack_ix, depth));
 419  } else {
 420   SU_UD_HANDLER(ud)(aTHX_ ud);
 421  }
 422 }
 423
 424 /* --- Initialize the stack and the action userdata ------------------------ */
 425
 426 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
 427 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 428  I32 i, depth = 0, *origin;
 429  I32 cur, last, step;
 430
 431  LEAVE;
 432
 433  if (level <= 0) {
 434   SU_UD_HANDLER(ud)(aTHX_ ud);
 435   goto done;
 436  }
 437
 438  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
 439
 440  for (i = 0; i < level; ++i) {
 441   PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
 442   switch (CxTYPE(cx)) {
 443 #if SU_HAS_PERL(5, 11, 0)
 444    case CXt_LOOP_FOR:
 445    case CXt_LOOP_PLAIN:
 446    case CXt_LOOP_LAZYSV:
 447    case CXt_LOOP_LAZYIV:
 448 #else
 449    case CXt_LOOP:
 450 #endif
 451     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 452     depth += 2;
 453     break;
 454    default:
 455     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
 456     depth++;
 457     break;
 458   }
 459  }
 460  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 461
 462  Newx(origin, depth + 1, I32);
 463  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 464  PL_scopestack[PL_scopestack_ix - depth] += size;
 465  for (i = depth - 1; i >= 1; --i) {
 466   I32 j = PL_scopestack_ix - i;
 467   origin[depth - i] = PL_scopestack[j];
 468   PL_scopestack[j] += 3;
 469  }
 470  origin[depth] = PL_savestack_ix;
 471
 472  SU_D({
 473   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 474                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 475   for (i = depth - 1; i >= 0; --i) {
 476    I32 x = PL_scopestack_ix  - depth + i;
 477    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 478                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 479   }
 480  });
 481
 482  SU_UD_ORIGIN(ud) = origin;
 483  SU_UD_DEPTH(ud)  = depth;
 484
 485  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 486                                      ud, PL_savestack_ix, depth));
 487
 488  SAVEDESTRUCTOR_X(su_pop, ud);
 489
 490 done:
 491  ENTER;
 492
 493  return depth;
 494 }
 495
 496 #define SU_GET_LEVEL(A)  \
 497  if (items > A) {        \
 498   SV *lsv = ST(A);       \
 499   if (SvOK(lsv))         \
 500    level = SvUV(lsv);    \
 501   if (level < 0)         \
 502    XSRETURN(0);          \
 503  }                       \
 504  if (level > cxstack_ix) \
 505   level = cxstack_ix;
 506
 507 /* --- XS ------------------------------------------------------------------ */
 508
 509 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 510
 511 PROTOTYPES: ENABLE
 512
 513 SV *
 514 TOPLEVEL()
 515 PROTOTYPE:
 516 CODE:
 517  RETVAL = newSViv(cxstack_ix);
 518 OUTPUT:
 519  RETVAL
 520
 521 void
 522 reap(SV *hook, ...)
 523 PROTOTYPE: &;$
 524 PREINIT:
 525  I32 level = 0;
 526  su_ud_reap *ud;
 527 CODE:
 528  SU_GET_LEVEL(1);
 529  Newx(ud, 1, su_ud_reap);
 530  SU_UD_ORIGIN(ud)  = NULL;
 531  SU_UD_HANDLER(ud) = su_reap;
 532  ud->cb = newSVsv(hook);
 533  su_init(level, ud, 3);
 534
 535 void
 536 localize(SV *sv, SV *val, ...)
 537 PROTOTYPE: $$;$
 538 PREINIT:
 539  I32 level = 0;
 540  su_ud_localize *ud;
 541 CODE:
 542  SU_GET_LEVEL(2);
 543  Newx(ud, 1, su_ud_localize);
 544  SU_UD_ORIGIN(ud)  = NULL;
 545  SU_UD_HANDLER(ud) = su_localize;
 546  SvREFCNT_inc(sv);
 547  ud->sv   = sv;
 548  ud->val  = newSVsv(val);
 549  ud->elem = NULL;
 550  su_init(level, ud, 3);
 551
 552 void
 553 localize_elem(SV *sv, SV *elem, SV *val, ...)
 554 PROTOTYPE: $$$;$
 555 PREINIT:
 556  I32 level = 0;
 557  su_ud_localize *ud;
 558 CODE:
 559  SU_GET_LEVEL(3);
 560  Newx(ud, 1, su_ud_localize);
 561  SU_UD_ORIGIN(ud)  = NULL;
 562  SU_UD_HANDLER(ud) = su_localize;
 563  SvREFCNT_inc(sv);
 564  ud->sv   = sv;
 565  ud->val  = newSVsv(val);
 566  SvREFCNT_inc(elem);
 567  ud->elem = elem;
 568  su_init(level, ud, 4);
 569
 570 void
 571 localize_delete(SV *sv, SV *elem, ...)
 572 PROTOTYPE: $$;$
 573 PREINIT:
 574  I32 level = 0;
 575  su_ud_localize *ud;
 576 CODE:
 577  SU_GET_LEVEL(2);
 578  Newx(ud, 1, su_ud_localize);
 579  SU_UD_ORIGIN(ud)  = NULL;
 580  SU_UD_HANDLER(ud) = su_localize;
 581  SvREFCNT_inc(sv);
 582  ud->sv   = sv;
 583  ud->val  = NULL;
 584  SvREFCNT_inc(elem);
 585  ud->elem = elem;
 586  su_init(level, ud, 4);