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