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