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_ void *av_, SV *key, SV *val) {
 119 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 120  AV *av = av_;
 121  I32 idx;
 122  I32 preeminent;
 123  SV **svp;
 124
 125  idx = SvIV(key);
 126  preeminent = su_av_preeminent(av, idx);
 127  svp = av_fetch(av, idx, 1);
 128  if (!*svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 129
 130  if (preeminent)
 131   save_aelem(av, idx, svp);
 132  else
 133   SAVEADELETE(av, idx);
 134
 135  if (val) { /* local $x[$idx] = $val; */
 136   SvSetMagicSV(*svp, val);
 137  } else {   /* local $x[$idx]; delete $x[$idx]; */
 138   av_delete(av, idx, G_DISCARD);
 139  }
 140 }
 141
 142 /* ... Saving hash elements ................................................ */
 143
 144 STATIC I32 su_hv_preeminent(pTHX_ HV *hv, SV *keysv) {
 145 #define su_hv_preeminent(H, K) su_hv_preeminent(aTHX_ (H), (K))
 146  MAGIC *mg;
 147  HV *stash;
 148
 149  if (!hv) return 0;
 150  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 151   return hv_exists_ent(hv, keysv, 0);
 152
 153  return 1;
 154 }
 155
 156 STATIC void su_save_helem(pTHX_ void *hv_, SV *keysv, SV *val) {
 157 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 158  HV *hv = hv_;
 159  I32 preeminent;
 160  HE *he;
 161  SV **svp;
 162
 163  preeminent = su_hv_preeminent(hv, keysv);
 164  he  = hv_fetch_ent(hv, keysv, 1, 0);
 165  svp = he ? &HeVAL(he) : NULL;
 166  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 167
 168  if (HvNAME_get(hv) && isGV(*svp)) {
 169   save_gp((GV *) *svp, 0);
 170   return;
 171  }
 172
 173  if (preeminent)
 174   save_helem(hv, keysv, svp);
 175  else {
 176   STRLEN keylen;
 177   const char * const key = SvPV_const(keysv, keylen);
 178   SAVEDELETE(hv, savepvn(key, keylen),
 179                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 180  }
 181
 182  if (val) { /* local $x{$keysv} = $val; */
 183   SvSetMagicSV(*svp, val);
 184  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 185   hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 186  }
 187 }
 188
 189 /* --- Actions ------------------------------------------------------------- */
 190
 191 typedef struct {
 192  I32 depth;
 193  I32 *origin;
 194  void (*handler)(pTHX_ void *);
 195 } su_ud_common;
 196
 197 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 198 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 199 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 200
 201 #define SU_UD_FREE(U) STMT_START { \
 202  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 203  Safefree(U); \
 204 } STMT_END
 205
 206 /* ... Reap ................................................................ */
 207
 208 typedef struct {
 209  su_ud_common ci;
 210  SV *cb;
 211 } su_ud_reap;
 212
 213 STATIC void su_call(pTHX_ void *ud_) {
 214  su_ud_reap *ud = (su_ud_reap *) ud_;
 215 #if SU_HAS_PERL(5, 10, 0)
 216  I32 dieing = PL_op->op_type == OP_DIE;
 217 #endif
 218
 219  dSP;
 220
 221  SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
 222                                      ud, PL_scopestack_ix, PL_savestack_ix));
 223  ENTER;
 224  SAVETMPS;
 225
 226  PUSHMARK(SP);
 227  PUTBACK;
 228
 229  /* If cxstack_ix isn't incremented there, the eval context will be overwritten
 230   * when the new sub scope will be created in call_sv. */
 231
 232 #if SU_HAS_PERL(5, 10, 0)
 233  if (dieing)
 234   if (cxstack_ix < cxstack_max)
 235    ++cxstack_ix;
 236   else
 237    cxstack_ix = Perl_cxinc(aTHX);
 238 #endif
 239
 240  call_sv(ud->cb, G_VOID);
 241
 242 #if SU_HAS_PERL(5, 10, 0)
 243  if (dieing && cxstack_ix > 0)
 244   --cxstack_ix;
 245 #endif
 246
 247  SPAGAIN;
 248  PUTBACK;
 249
 250  FREETMPS;
 251  LEAVE;
 252
 253  SvREFCNT_dec(ud->cb);
 254  SU_UD_FREE(ud);
 255 }
 256
 257 STATIC void su_reap(pTHX_ void *ud) {
 258 #define su_reap(U) su_reap(aTHX_ (U))
 259  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
 260                                      ud, PL_scopestack_ix, PL_savestack_ix));
 261  SAVEDESTRUCTOR_X(su_call, ud);
 262  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 263                                      ud, PL_savestack_ix,
 264                                          PL_scopestack[PL_scopestack_ix]));
 265 }
 266
 267 /* ... Localize & localize array/hash element .............................. */
 268
 269 typedef struct {
 270  su_ud_common ci;
 271  SV *sv;
 272  SV *val;
 273  SV *elem;
 274 } su_ud_localize;
 275
 276 STATIC void su_localize_elem(pTHX_ void *obj, SV *elem, SV *val, void (*do_elem)(pTHX_ void *, SV *, SV *)) {
 277 #define su_localize_elem(O, E, V, D) su_localize_elem(aTHX_ (O), (E), (V), (D))
 278  AV *aelem, *aval;
 279  if (SvROK(elem) && (aelem = (AV *) SvRV(elem), SvTYPE(aelem) == SVt_PVAV)) {
 280   I32 i, last = av_len(aelem);
 281   SV **svpe, **svpv;
 282   if (!val) {
 283    for (i = 0; i <= last; ++i) {
 284     svpe = av_fetch(aelem, i, 0);
 285     if (!svpe) continue;
 286     do_elem(aTHX_ obj, *svpe, NULL);
 287    }
 288   } else if (SvROK(val) && (aval = (AV *) SvRV(val), SvTYPE(aval) == SVt_PVAV)){
 289    for (i = 0; i <= last; ++i) {
 290     svpe = av_fetch(aelem, i, 0);
 291     if (!svpe) continue;
 292     svpv = av_fetch(aval,  i, 0);
 293     if (!svpv) continue;
 294     do_elem(aTHX_ obj, *svpe, *svpv);
 295    }
 296   }
 297  } else {
 298   do_elem(aTHX_ obj, elem, val);
 299  }
 300 }
 301
 302 STATIC void su_localize(pTHX_ void *ud_) {
 303 #define su_localize(U) su_localize(aTHX_ (U))
 304  su_ud_localize *ud = (su_ud_localize *) ud_;
 305  SV *sv   = ud->sv;
 306  SV *val  = ud->val;
 307  SV *elem = ud->elem;
 308  GV *gv;
 309  UV deref = 0;
 310  svtype t = SVt_NULL;
 311
 312  if (SvTYPE(sv) >= SVt_PVGV) {
 313   gv = (GV *) sv;
 314   if (!val) {               /* local *x; */
 315    t = SVt_PVGV;
 316   } else if (!SvROK(val)) { /* local *x = $val; */
 317    goto assign;
 318   } else {                  /* local *x = \$val; */
 319    t = SvTYPE(SvRV(val));
 320    deref = 1;
 321   }
 322  } else {
 323   STRLEN len, l;
 324   const char *p = SvPV_const(sv, len), *s;
 325   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 326   if (!l) {
 327    l = len;
 328    s = p;
 329   }
 330   switch (*s) {
 331    case '$': t = SVt_PV;   break;
 332    case '@': t = SVt_PVAV; break;
 333    case '%': t = SVt_PVHV; break;
 334    case '&': t = SVt_PVCV; break;
 335    case '*': t = SVt_PVGV; break;
 336   }
 337   if (t != SVt_NULL) {
 338    ++s;
 339    --l;
 340   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 341    if (SvROK(val) && !sv_isobject(val)) {
 342     t = SvTYPE(SvRV(val));
 343     deref = 1;
 344    } else {
 345     t = SvTYPE(val);
 346    }
 347   }
 348   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 349  }
 350
 351  SU_D({
 352   SV *z = newSV_type(t);
 353   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
 354                                  ud, sv_reftype(z, 0),
 355                                      PL_scopestack_ix, PL_savestack_ix);
 356   SvREFCNT_dec(z);
 357  });
 358
 359  /* Inspired from Alias.pm */
 360  switch (t) {
 361   case SVt_PVAV:
 362    if (elem) {
 363     su_localize_elem(GvAV(gv), elem, val, su_save_aelem);
 364     goto done;
 365    } else
 366     save_ary(gv);
 367    break;
 368   case SVt_PVHV:
 369    if (elem) {
 370     su_localize_elem(GvHV(gv), elem, val, su_save_helem);
 371     goto done;
 372    } else
 373     save_hash(gv);
 374    break;
 375   case SVt_PVGV:
 376    save_gp(gv, 1); /* hide previous entry in symtab */
 377    break;
 378   case SVt_PVCV:
 379    SAVESPTR(GvCV(gv));
 380    GvCV(gv) = NULL;
 381    break;
 382   default:
 383    gv = (GV *) save_scalar(gv);
 384 maybe_deref:
 385    if (deref) /* val != NULL */
 386     val = SvRV(val);
 387    break;
 388  }
 389
 390  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 391                                      ud, PL_savestack_ix,
 392                                          PL_scopestack[PL_scopestack_ix]));
 393
 394 assign:
 395  if (val)
 396   SvSetMagicSV((SV *) gv, val);
 397
 398 done:
 399  SvREFCNT_dec(ud->elem);
 400  SvREFCNT_dec(ud->val);
 401  SvREFCNT_dec(ud->sv);
 402  SU_UD_FREE(ud);
 403 }
 404
 405 /* --- Pop a context back -------------------------------------------------- */
 406
 407 #if SU_DEBUG
 408 # ifdef DEBUGGING
 409 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 410 # else
 411 #  define SU_CXNAME "XXX"
 412 # endif
 413 #endif
 414
 415 STATIC void su_pop(pTHX_ void *ud) {
 416 #define su_pop(U) su_pop(aTHX_ (U))
 417  I32 depth, base, mark, *origin;
 418  depth = SU_UD_DEPTH(ud);
 419
 420  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
 421                                      ud, SU_CXNAME,
 422                                          PL_scopestack_ix, PL_savestack_ix,
 423                                          PL_scopestack[PL_scopestack_ix],
 424                                          depth));
 425
 426  origin = SU_UD_ORIGIN(ud);
 427  mark   = origin[depth];
 428  base   = origin[depth - 1];
 429
 430  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
 431                                      ud, mark, base));
 432
 433  if (base < mark) {
 434   PL_savestack_ix = mark;
 435   leave_scope(base);
 436  }
 437  PL_savestack_ix = base;
 438  if (--depth > 0) {
 439   SU_UD_DEPTH(ud) = depth;
 440   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
 441                                       ud, PL_savestack_ix, depth));
 442   SAVEDESTRUCTOR_X(su_pop, ud);
 443   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
 444                                       ud, PL_savestack_ix, depth));
 445  } else {
 446   SU_UD_HANDLER(ud)(aTHX_ ud);
 447  }
 448 }
 449
 450 /* --- Initialize the stack and the action userdata ------------------------ */
 451
 452 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
 453 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 454  I32 i, depth = 0, *origin;
 455  I32 cur, last, step;
 456
 457  LEAVE;
 458
 459  if (level <= 0) {
 460   SU_UD_HANDLER(ud)(aTHX_ ud);
 461   goto done;
 462  }
 463
 464  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
 465
 466  for (i = 0; i < level; ++i) {
 467   PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
 468   switch (CxTYPE(cx)) {
 469 #if SU_HAS_PERL(5, 11, 0)
 470    case CXt_LOOP_FOR:
 471    case CXt_LOOP_PLAIN:
 472    case CXt_LOOP_LAZYSV:
 473    case CXt_LOOP_LAZYIV:
 474 #else
 475    case CXt_LOOP:
 476 #endif
 477     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 478     depth += 2;
 479     break;
 480    default:
 481     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
 482     depth++;
 483     break;
 484   }
 485  }
 486  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 487
 488  Newx(origin, depth + 1, I32);
 489  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 490  PL_scopestack[PL_scopestack_ix - depth] += size;
 491  for (i = depth - 1; i >= 1; --i) {
 492   I32 j = PL_scopestack_ix - i;
 493   origin[depth - i] = PL_scopestack[j];
 494   PL_scopestack[j] += 3;
 495  }
 496  origin[depth] = PL_savestack_ix;
 497
 498  SU_D({
 499   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 500                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 501   for (i = depth - 1; i >= 0; --i) {
 502    I32 x = PL_scopestack_ix  - depth + i;
 503    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 504                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 505   }
 506  });
 507
 508  SU_UD_ORIGIN(ud) = origin;
 509  SU_UD_DEPTH(ud)  = depth;
 510
 511  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 512                                      ud, PL_savestack_ix, depth));
 513
 514  SAVEDESTRUCTOR_X(su_pop, ud);
 515
 516 done:
 517  ENTER;
 518
 519  return depth;
 520 }
 521
 522 #define SU_GET_LEVEL(A)  \
 523  if (items > A) {        \
 524   SV *lsv = ST(A);       \
 525   if (SvOK(lsv))         \
 526    level = SvUV(lsv);    \
 527   if (level < 0)         \
 528    XSRETURN(0);          \
 529  }                       \
 530  if (level > cxstack_ix) \
 531   level = cxstack_ix;
 532
 533 /* --- XS ------------------------------------------------------------------ */
 534
 535 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 536
 537 PROTOTYPES: ENABLE
 538
 539 SV *
 540 TOPLEVEL()
 541 PROTOTYPE:
 542 CODE:
 543  RETVAL = newSViv(cxstack_ix);
 544 OUTPUT:
 545  RETVAL
 546
 547 void
 548 reap(SV *hook, ...)
 549 PROTOTYPE: &;$
 550 PREINIT:
 551  I32 level = 0;
 552  su_ud_reap *ud;
 553 CODE:
 554  SU_GET_LEVEL(1);
 555  Newx(ud, 1, su_ud_reap);
 556  SU_UD_ORIGIN(ud)  = NULL;
 557  SU_UD_HANDLER(ud) = su_reap;
 558  ud->cb = newSVsv(hook);
 559  su_init(level, ud, 3);
 560
 561 void
 562 localize(SV *sv, SV *val, ...)
 563 PROTOTYPE: $$;$
 564 PREINIT:
 565  I32 level = 0;
 566  su_ud_localize *ud;
 567 CODE:
 568  SU_GET_LEVEL(2);
 569  Newx(ud, 1, su_ud_localize);
 570  SU_UD_ORIGIN(ud)  = NULL;
 571  SU_UD_HANDLER(ud) = su_localize;
 572  SvREFCNT_inc(sv);
 573  ud->sv   = sv;
 574  ud->val  = newSVsv(val);
 575  ud->elem = NULL;
 576  su_init(level, ud, 3);
 577
 578 void
 579 localize_elem(SV *sv, SV *elem, SV *val, ...)
 580 PROTOTYPE: $$$;$
 581 PREINIT:
 582  I32 level = 0, slots = 1;
 583  su_ud_localize *ud;
 584 CODE:
 585  SU_GET_LEVEL(3);
 586  Newx(ud, 1, su_ud_localize);
 587  SU_UD_ORIGIN(ud)  = NULL;
 588  SU_UD_HANDLER(ud) = su_localize;
 589  SvREFCNT_inc(sv);
 590  ud->sv   = sv;
 591  ud->val  = newSVsv(val);
 592  SvREFCNT_inc(elem);
 593  ud->elem = elem;
 594  if (SvROK(elem) && (elem = SvRV(elem), SvTYPE(elem) == SVt_PVAV))
 595   slots = 1 + av_len((AV *) elem);
 596  su_init(level, ud, slots * 4);
 597
 598 void
 599 localize_delete(SV *sv, SV *elem, ...)
 600 PROTOTYPE: $$;$
 601 PREINIT:
 602  I32 level = 0, slots = 1;
 603  su_ud_localize *ud;
 604 CODE:
 605  SU_GET_LEVEL(2);
 606  Newx(ud, 1, su_ud_localize);
 607  SU_UD_ORIGIN(ud)  = NULL;
 608  SU_UD_HANDLER(ud) = su_localize;
 609  SvREFCNT_inc(sv);
 610  ud->sv   = sv;
 611  ud->val  = NULL;
 612  SvREFCNT_inc(elem);
 613  ud->elem = elem;
 614  if (SvROK(elem) && (elem = SvRV(elem), SvTYPE(elem) == SVt_PVAV))
 615   slots = 1 + av_len((AV *) elem);
 616  su_init(level, ud, slots * 3);