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 #define __PACKAGE__ "Scope::Upper"
  10
  11 #ifndef SU_DEBUG
  12 # define SU_DEBUG 0
  13 #endif
  14
  15 /* --- Compatibility ------------------------------------------------------- */
  16
  17 #ifndef PERL_UNUSED_VAR
  18 # define PERL_UNUSED_VAR(V)
  19 #endif
  20
  21 #ifndef STMT_START
  22 # define STMT_START do
  23 #endif
  24
  25 #ifndef STMT_END
  26 # define STMT_END while (0)
  27 #endif
  28
  29 #if SU_DEBUG
  30 # define SU_D(X) STMT_START X STMT_END
  31 #else
  32 # define SU_D(X)
  33 #endif
  34
  35 #ifndef Newx
  36 # define Newx(v, n, c) New(0, v, n, c)
  37 #endif
  38
  39 #ifndef SvPV_const
  40 # define SvPV_const(S, L) SvPV(S, L)
  41 #endif
  42
  43 #ifndef SvPV_nolen_const
  44 # define SvPV_nolen_const(S) SvPV_nolen(S)
  45 #endif
  46
  47 #ifndef SvREFCNT_inc_simple_void
  48 # define SvREFCNT_inc_simple_void(sv) SvREFCNT_inc(sv)
  49 #endif
  50
  51 #ifndef HvNAME_get
  52 # define HvNAME_get(H) HvNAME(H)
  53 #endif
  54
  55 #ifndef gv_fetchpvn_flags
  56 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
  57 #endif
  58
  59 #ifndef PERL_MAGIC_tied
  60 # define PERL_MAGIC_tied 'P'
  61 #endif
  62
  63 #ifndef PERL_MAGIC_env
  64 # define PERL_MAGIC_env 'E'
  65 #endif
  66
  67 #ifndef NEGATIVE_INDICES_VAR
  68 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
  69 #endif
  70
  71 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  72
  73 /* --- Threads and multiplicity -------------------------------------------- */
  74
  75 #ifndef NOOP
  76 # define NOOP
  77 #endif
  78
  79 #ifndef dNOOP
  80 # define dNOOP
  81 #endif
  82
  83 #ifndef SU_MULTIPLICITY
  84 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
  85 #  define SU_MULTIPLICITY 1
  86 # else
  87 #  define SU_MULTIPLICITY 0
  88 # endif
  89 #endif
  90 #if SU_MULTIPLICITY && !defined(tTHX)
  91 # define tTHX PerlInterpreter*
  92 #endif
  93
  94 #if SU_MULTIPLICITY && defined(USE_ITHREADS) && defined(dMY_CXT) && defined(MY_CXT) && defined(START_MY_CXT) && defined(MY_CXT_INIT) && (defined(MY_CXT_CLONE) || defined(dMY_CXT_SV))
  95 # define SU_THREADSAFE 1
  96 # ifndef MY_CXT_CLONE
  97 #  define MY_CXT_CLONE \
  98     dMY_CXT_SV;                                                      \
  99     my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
 100     Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
 101     sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
 102 # endif
 103 #else
 104 # define SU_THREADSAFE 0
 105 # undef  dMY_CXT
 106 # define dMY_CXT      dNOOP
 107 # undef  MY_CXT
 108 # define MY_CXT       su_globaldata
 109 # undef  START_MY_CXT
 110 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
 111 # undef  MY_CXT_INIT
 112 # define MY_CXT_INIT  NOOP
 113 # undef  MY_CXT_CLONE
 114 # define MY_CXT_CLONE NOOP
 115 #endif
 116
 117 /* --- Stack manipulations ------------------------------------------------- */
 118
 119 #ifndef SvCANEXISTDELETE
 120 # define SvCANEXISTDELETE(sv) \
 121   (!SvRMAGICAL(sv)            \
 122    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 123        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 124        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 125        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 126       )                       \
 127    )
 128 #endif
 129
 130 /* ... Saving array elements ............................................... */
 131
 132 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
 133 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
 134  I32 idx;
 135
 136  if (key >= 0)
 137   return key;
 138
 139 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
 140 #if SU_HAS_PERL(5, 8, 1)
 141  if (SvRMAGICAL(av)) {
 142   const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
 143   if (tied_magic) {
 144    SV * const * const negative_indices_glob =
 145                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 146                              NEGATIVE_INDICES_VAR, 16, 0);
 147    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 148     return key;
 149   }
 150  }
 151 #endif
 152
 153  idx = key + av_len(av) + 1;
 154  if (idx < 0)
 155   return key;
 156
 157  return idx;
 158 }
 159
 160 #ifndef SAVEADELETE
 161
 162 typedef struct {
 163  AV *av;
 164  I32 idx;
 165 } su_ud_adelete;
 166
 167 STATIC void su_adelete(pTHX_ void *ud_) {
 168  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 169
 170  av_delete(ud->av, ud->idx, G_DISCARD);
 171  SvREFCNT_dec(ud->av);
 172
 173  Safefree(ud);
 174 }
 175
 176 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 177 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 178  su_ud_adelete *ud;
 179
 180  Newx(ud, 1, su_ud_adelete);
 181  ud->av  = av;
 182  ud->idx = idx;
 183  SvREFCNT_inc_simple_void(av);
 184
 185  SAVEDESTRUCTOR_X(su_adelete, ud);
 186 }
 187
 188 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 189
 190 #endif /* SAVEADELETE */
 191
 192 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 193 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 194  I32 idx;
 195  I32 preeminent = 1;
 196  SV **svp;
 197  HV *stash;
 198  MAGIC *mg;
 199
 200  idx = su_av_key2idx(av, SvIV(key));
 201
 202  if (SvCANEXISTDELETE(av))
 203   preeminent = av_exists(av, idx);
 204
 205  svp = av_fetch(av, idx, 1);
 206  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 207
 208  if (preeminent)
 209   save_aelem(av, idx, svp);
 210  else
 211   SAVEADELETE(av, idx);
 212
 213  if (val) { /* local $x[$idx] = $val; */
 214   SvSetMagicSV(*svp, val);
 215  } else {   /* local $x[$idx]; delete $x[$idx]; */
 216   av_delete(av, idx, G_DISCARD);
 217  }
 218 }
 219
 220 /* ... Saving hash elements ................................................ */
 221
 222 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 223 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 224  I32 preeminent = 1;
 225  HE *he;
 226  SV **svp;
 227  HV *stash;
 228  MAGIC *mg;
 229
 230  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 231   preeminent = hv_exists_ent(hv, keysv, 0);
 232
 233  he  = hv_fetch_ent(hv, keysv, 1, 0);
 234  svp = he ? &HeVAL(he) : NULL;
 235  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 236
 237  if (HvNAME_get(hv) && isGV(*svp)) {
 238   save_gp((GV *) *svp, 0);
 239   return;
 240  }
 241
 242  if (preeminent)
 243   save_helem(hv, keysv, svp);
 244  else {
 245   STRLEN keylen;
 246   const char * const key = SvPV_const(keysv, keylen);
 247   SAVEDELETE(hv, savepvn(key, keylen),
 248                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 249  }
 250
 251  if (val) { /* local $x{$keysv} = $val; */
 252   SvSetMagicSV(*svp, val);
 253  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 254   (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 255  }
 256 }
 257
 258 /* --- Actions ------------------------------------------------------------- */
 259
 260 typedef struct {
 261  I32 depth;
 262  I32 *origin;
 263  void (*handler)(pTHX_ void *);
 264 } su_ud_common;
 265
 266 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 267 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 268 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 269
 270 #define SU_UD_FREE(U) STMT_START { \
 271  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 272  Safefree(U); \
 273 } STMT_END
 274
 275 /* ... Reap ................................................................ */
 276
 277 typedef struct {
 278  su_ud_common ci;
 279  SV *cb;
 280 } su_ud_reap;
 281
 282 STATIC void su_call(pTHX_ void *ud_) {
 283  su_ud_reap *ud = (su_ud_reap *) ud_;
 284 #if SU_HAS_PERL(5, 9, 5)
 285  PERL_CONTEXT saved_cx;
 286  I32 cxix;
 287 #endif
 288
 289  dSP;
 290
 291  SU_D({
 292   PerlIO_printf(Perl_debug_log,
 293                 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 294                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 295  });
 296
 297  ENTER;
 298  SAVETMPS;
 299
 300  PUSHMARK(SP);
 301  PUTBACK;
 302
 303  /* If the recently popped context isn't saved there, it will be overwritten by
 304   * the sub scope from call_sv, although it's still needed in our caller. */
 305
 306 #if SU_HAS_PERL(5, 9, 5)
 307  if (cxstack_ix < cxstack_max)
 308   cxix = cxstack_ix + 1;
 309  else
 310   cxix = Perl_cxinc(aTHX);
 311  saved_cx = cxstack[cxix];
 312 #endif
 313
 314  call_sv(ud->cb, G_VOID);
 315
 316 #if SU_HAS_PERL(5, 9, 5)
 317  cxstack[cxix] = saved_cx;
 318 #endif
 319
 320  PUTBACK;
 321
 322  FREETMPS;
 323  LEAVE;
 324
 325  SvREFCNT_dec(ud->cb);
 326  SU_UD_FREE(ud);
 327 }
 328
 329 STATIC void su_reap(pTHX_ void *ud) {
 330 #define su_reap(U) su_reap(aTHX_ (U))
 331  SU_D({
 332   PerlIO_printf(Perl_debug_log,
 333                 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 334                  ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 335  });
 336
 337  SAVEDESTRUCTOR_X(su_call, ud);
 338 }
 339
 340 /* ... Localize & localize array/hash element .............................. */
 341
 342 typedef struct {
 343  su_ud_common ci;
 344  SV    *sv;
 345  SV    *val;
 346  SV    *elem;
 347  svtype type;
 348 } su_ud_localize;
 349
 350 STATIC void su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
 351 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
 352  UV deref = 0;
 353  svtype t = SVt_NULL;
 354
 355  SvREFCNT_inc_simple_void(sv);
 356
 357  if (SvTYPE(sv) >= SVt_PVGV) {
 358   if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
 359    t = SVt_PVGV;
 360   } else {                   /* local *x = \$val; */
 361    t = SvTYPE(SvRV(val));
 362    deref = 1;
 363   }
 364  } else {
 365   STRLEN len, l;
 366   const char *p = SvPV_const(sv, len), *s;
 367   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 368   if (!l) {
 369    l = len;
 370    s = p;
 371   }
 372   switch (*s) {
 373    case '$': t = SVt_PV;   break;
 374    case '@': t = SVt_PVAV; break;
 375    case '%': t = SVt_PVHV; break;
 376    case '&': t = SVt_PVCV; break;
 377    case '*': t = SVt_PVGV; break;
 378   }
 379   if (t != SVt_NULL) {
 380    ++s;
 381    --l;
 382   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 383    if (SvROK(val) && !sv_isobject(val)) {
 384     t = SvTYPE(SvRV(val));
 385     deref = 1;
 386    } else {
 387     t = SvTYPE(val);
 388    }
 389   }
 390   SvREFCNT_dec(sv);
 391   sv = newSVpvn(s, l);
 392  }
 393
 394  switch (t) {
 395   case SVt_PVAV:
 396   case SVt_PVHV:
 397   case SVt_PVCV:
 398   case SVt_PVGV:
 399    deref = 0;
 400   default:
 401    break;
 402  }
 403  /* When deref is set, val isn't NULL */
 404
 405  ud->sv   = sv;
 406  ud->val  = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
 407  ud->elem = SvREFCNT_inc(elem);
 408  ud->type = t;
 409 }
 410
 411 STATIC void su_localize(pTHX_ void *ud_) {
 412 #define su_localize(U) su_localize(aTHX_ (U))
 413  su_ud_localize *ud = (su_ud_localize *) ud_;
 414  SV *sv   = ud->sv;
 415  SV *val  = ud->val;
 416  SV *elem = ud->elem;
 417  svtype t = ud->type;
 418  GV *gv;
 419
 420  if (SvTYPE(sv) >= SVt_PVGV) {
 421   gv = (GV *) sv;
 422  } else {
 423 #ifdef gv_fetchsv
 424   gv = gv_fetchsv(sv, GV_ADDMULTI, t);
 425 #else
 426   STRLEN len;
 427   const char *name = SvPV_const(sv, len);
 428   gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
 429 #endif
 430  }
 431
 432  SU_D({
 433   SV *z = newSV(0);
 434   SvUPGRADE(z, t);
 435   PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
 436   PerlIO_printf(Perl_debug_log,
 437                 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
 438                  ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
 439   SvREFCNT_dec(z);
 440  });
 441
 442  /* Inspired from Alias.pm */
 443  switch (t) {
 444   case SVt_PVAV:
 445    if (elem) {
 446     su_save_aelem(GvAV(gv), elem, val);
 447     goto done;
 448    } else
 449     save_ary(gv);
 450    break;
 451   case SVt_PVHV:
 452    if (elem) {
 453     su_save_helem(GvHV(gv), elem, val);
 454     goto done;
 455    } else
 456     save_hash(gv);
 457    break;
 458   case SVt_PVGV:
 459    save_gp(gv, 1); /* hide previous entry in symtab */
 460    break;
 461   case SVt_PVCV:
 462    SAVESPTR(GvCV(gv));
 463    GvCV(gv) = NULL;
 464    break;
 465   default:
 466    gv = (GV *) save_scalar(gv);
 467    break;
 468  }
 469
 470  if (val)
 471   SvSetMagicSV((SV *) gv, val);
 472
 473 done:
 474  SvREFCNT_dec(ud->elem);
 475  SvREFCNT_dec(ud->val);
 476  SvREFCNT_dec(ud->sv);
 477  SU_UD_FREE(ud);
 478 }
 479
 480 /* --- Pop a context back -------------------------------------------------- */
 481
 482 #if SU_DEBUG
 483 # ifdef DEBUGGING
 484 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 485 # else
 486 #  define SU_CXNAME "XXX"
 487 # endif
 488 #endif
 489
 490 STATIC void su_pop(pTHX_ void *ud) {
 491 #define su_pop(U) su_pop(aTHX_ (U))
 492  I32 depth, base, mark, *origin;
 493  depth = SU_UD_DEPTH(ud);
 494
 495  SU_D(
 496   PerlIO_printf(Perl_debug_log,
 497    "%p: --- pop a %s\n"
 498    "%p: leave scope     at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
 499     ud, SU_CXNAME,
 500     ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
 501  );
 502
 503  origin = SU_UD_ORIGIN(ud);
 504  mark   = origin[depth];
 505  base   = origin[depth - 1];
 506
 507  SU_D(PerlIO_printf(Perl_debug_log,
 508                     "%p: original scope was %*c top=%2d     base=%2d\n",
 509                      ud,                24, ' ',    mark,        base));
 510
 511  if (base < mark) {
 512   SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
 513   PL_savestack_ix = mark;
 514   leave_scope(base);
 515  }
 516  PL_savestack_ix = base;
 517
 518  SU_UD_DEPTH(ud) = --depth;
 519
 520  if (depth > 0) {
 521   I32 i = 1;
 522
 523   SAVEDESTRUCTOR_X(su_pop, ud);
 524
 525   /* Skip depths corresponding to scopes for which leave_scope() might not be
 526    * called. */
 527   while (depth > 1 && PL_scopestack_ix >= i) {
 528    I32 j = PL_scopestack[PL_scopestack_ix - i];
 529
 530    if (j < PL_savestack_ix)
 531     break;
 532
 533    SU_D(PerlIO_printf(Perl_debug_log,
 534     "%p: skip scope%*cat depth=%2d scope_ix=%2d new_top=%2d >= cur_base=%2d\n",
 535      ud,           6, ' ',   depth, PL_scopestack_ix - i, j, PL_savestack_ix));
 536
 537    SU_UD_DEPTH(ud) = --depth;
 538
 539    ++i;
 540   }
 541
 542   SU_D(PerlIO_printf(Perl_debug_log,
 543          "%p: set destructor  at depth=%2d scope_ix=%2d save_ix=%2d\n",
 544           ud,                        depth, PL_scopestack_ix, PL_savestack_ix));
 545  } else {
 546   SU_UD_HANDLER(ud)(aTHX_ ud);
 547  }
 548
 549  SU_D(PerlIO_printf(Perl_debug_log,
 550                     "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
 551                      ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
 552 }
 553
 554 /* --- Global data --------------------------------------------------------- */
 555
 556 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 557
 558 typedef struct {
 559  int stack_placeholder;
 560  I32 cxix;
 561  I32 items;
 562  SV  **savesp;
 563  OP  fakeop;
 564 } my_cxt_t;
 565
 566 START_MY_CXT
 567
 568 /* --- Initialize the stack and the action userdata ------------------------ */
 569
 570 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
 571 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 572  I32 i, depth = 1, *origin;
 573
 574  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 575
 576  for (i = cxstack_ix; i > cxix; --i) {
 577   PERL_CONTEXT *cx = cxstack + i;
 578   switch (CxTYPE(cx)) {
 579 #if SU_HAS_PERL(5, 10, 0)
 580    case CXt_BLOCK:
 581     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
 582     /* Given and when blocks are actually followed by a simple block, so skip
 583      * it if needed. */
 584     if (cxix > 0) { /* Implies i > 0 */
 585      PERL_CONTEXT *next = cx - 1;
 586      if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
 587       --cxix;
 588     }
 589     depth++;
 590     break;
 591 #endif
 592 #if SU_HAS_PERL(5, 11, 0)
 593    case CXt_LOOP_FOR:
 594    case CXt_LOOP_PLAIN:
 595    case CXt_LOOP_LAZYSV:
 596    case CXt_LOOP_LAZYIV:
 597 #else
 598    case CXt_LOOP:
 599 #endif
 600     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 601     depth += 2;
 602     break;
 603    default:
 604     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
 605     depth++;
 606     break;
 607   }
 608  }
 609  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 610
 611  Newx(origin, depth + 1, I32);
 612  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 613  PL_scopestack[PL_scopestack_ix - depth] += size;
 614  for (i = depth - 1; i >= 1; --i) {
 615   I32 j = PL_scopestack_ix - i;
 616   origin[depth - i] = PL_scopestack[j];
 617   PL_scopestack[j] += 3;
 618  }
 619  origin[depth] = PL_savestack_ix;
 620
 621  SU_UD_ORIGIN(ud) = origin;
 622  SU_UD_DEPTH(ud)  = depth;
 623
 624  SU_D(PerlIO_printf(Perl_debug_log,
 625         "%p: set original destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
 626          ud,                     depth, PL_scopestack_ix - 1, PL_savestack_ix));
 627
 628  /* Make sure the first destructor fires by pushing enough fake slots on the
 629   * stack. */
 630  if (PL_savestack_ix + 3 <= PL_scopestack[PL_scopestack_ix - 1]) {
 631   dMY_CXT;
 632   do {
 633    save_int(&MY_CXT.stack_placeholder);
 634   } while (PL_savestack_ix + 3 <= PL_scopestack[PL_scopestack_ix - 1]);
 635  }
 636
 637  SAVEDESTRUCTOR_X(su_pop, ud);
 638
 639  SU_D({
 640   for (i = 0; i <= depth; ++i) {
 641    I32 j = PL_scopestack_ix  - i;
 642    PerlIO_printf(Perl_debug_log,
 643                  "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
 644                   ud,        i, j, origin[depth - i],
 645                                    i == 0 ? PL_savestack_ix : PL_scopestack[j]);
 646   }
 647  });
 648
 649  return depth;
 650 }
 651
 652 /* --- Unwind stack -------------------------------------------------------- */
 653
 654 STATIC void su_unwind(pTHX_ void *ud_) {
 655  dMY_CXT;
 656  I32 cxix    = MY_CXT.cxix;
 657  I32 items   = MY_CXT.items - 1;
 658  SV **savesp = MY_CXT.savesp;
 659  I32 mark;
 660
 661  PERL_UNUSED_VAR(ud_);
 662
 663  if (savesp)
 664   PL_stack_sp = savesp;
 665
 666  if (cxstack_ix > cxix)
 667   dounwind(cxix);
 668
 669  /* Hide the level */
 670  if (items >= 0)
 671   PL_stack_sp--;
 672
 673  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 674  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 675
 676  SU_D({
 677   I32 gimme = GIMME_V;
 678   PerlIO_printf(Perl_debug_log,
 679                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 680                 &MY_CXT, cxix,
 681                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 682                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 683  });
 684
 685  PL_op = PL_ppaddr[OP_RETURN](aTHX);
 686  *PL_markstack_ptr = mark;
 687
 688  MY_CXT.fakeop.op_next = PL_op;
 689  PL_op = &(MY_CXT.fakeop);
 690 }
 691
 692 /* --- XS ------------------------------------------------------------------ */
 693
 694 #if SU_HAS_PERL(5, 8, 9)
 695 # define SU_SKIP_DB_MAX 2
 696 #else
 697 # define SU_SKIP_DB_MAX 3
 698 #endif
 699
 700 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
 701  * followed by a DB sub */
 702
 703 #define SU_SKIP_DB(C) \
 704  STMT_START {         \
 705   I32 skipped = 0;    \
 706   PERL_CONTEXT *base = cxstack;      \
 707   PERL_CONTEXT *cx   = base + (C);   \
 708   while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
 709    --cx, ++skipped;                  \
 710   if (cx >= base && (C) > skipped) { \
 711    switch (CxTYPE(cx)) {  \
 712     case CXt_SUB:         \
 713      if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
 714       (C) -= skipped + 1; \
 715       break;              \
 716     default:              \
 717      break;               \
 718    }                      \
 719   }                       \
 720  } STMT_END
 721
 722 #define SU_GET_CONTEXT(A, B)   \
 723  STMT_START {                  \
 724   if (items > A) {             \
 725    SV *csv = ST(B);            \
 726    if (!SvOK(csv))             \
 727     goto default_cx;           \
 728    cxix = SvIV(csv);           \
 729    if (cxix < 0)               \
 730     cxix = 0;                  \
 731    else if (cxix > cxstack_ix) \
 732     cxix = cxstack_ix;         \
 733   } else {                     \
 734 default_cx:                    \
 735    cxix = cxstack_ix;          \
 736    if (PL_DBsub)               \
 737     SU_SKIP_DB(cxix);          \
 738   }                            \
 739  } STMT_END
 740
 741 #define SU_GET_LEVEL(A, B) \
 742  STMT_START {              \
 743   level = 0;               \
 744   if (items > 0) {         \
 745    SV *lsv = ST(B);        \
 746    if (SvOK(lsv)) {        \
 747     level = SvIV(lsv);     \
 748     if (level < 0)         \
 749      level = 0;            \
 750    }                       \
 751   }                        \
 752  } STMT_END
 753
 754 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
 755
 756 XS(XS_Scope__Upper_unwind) {
 757 #ifdef dVAR
 758  dVAR; dXSARGS;
 759 #else
 760  dXSARGS;
 761 #endif
 762  dMY_CXT;
 763  I32 cxix;
 764
 765  PERL_UNUSED_VAR(cv); /* -W */
 766  PERL_UNUSED_VAR(ax); /* -Wall */
 767
 768  SU_GET_CONTEXT(0, items - 1);
 769  do {
 770   PERL_CONTEXT *cx = cxstack + cxix;
 771   switch (CxTYPE(cx)) {
 772    case CXt_SUB:
 773     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 774      continue;
 775    case CXt_EVAL:
 776    case CXt_FORMAT:
 777     MY_CXT.cxix  = cxix;
 778     MY_CXT.items = items;
 779     /* pp_entersub will want to sanitize the stack after returning from there
 780      * Screw that, we're insane */
 781     if (GIMME_V == G_SCALAR) {
 782      MY_CXT.savesp = PL_stack_sp;
 783      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
 784      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
 785     } else {
 786      MY_CXT.savesp = NULL;
 787     }
 788     SAVEDESTRUCTOR_X(su_unwind, NULL);
 789     return;
 790    default:
 791     break;
 792   }
 793  } while (--cxix >= 0);
 794  croak("Can't return outside a subroutine");
 795 }
 796
 797 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 798
 799 PROTOTYPES: ENABLE
 800
 801 BOOT:
 802 {
 803  HV *stash;
 804
 805  MY_CXT_INIT;
 806  MY_CXT.stack_placeholder = 0;
 807
 808  stash = gv_stashpv(__PACKAGE__, 1);
 809  newCONSTSUB(stash, "TOP",           newSViv(0));
 810  newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
 811
 812  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
 813 }
 814
 815 #if SU_THREADSAFE
 816
 817 void
 818 CLONE(...)
 819 PROTOTYPE: DISABLE
 820 CODE:
 821  PERL_UNUSED_VAR(items);
 822  {
 823   MY_CXT_CLONE;
 824  }
 825
 826 #endif /* SU_THREADSAFE */
 827
 828 SV *
 829 HERE()
 830 PROTOTYPE:
 831 PREINIT:
 832  I32 cxix = cxstack_ix;
 833 CODE:
 834  if (PL_DBsub)
 835   SU_SKIP_DB(cxix);
 836  RETVAL = newSViv(cxix);
 837 OUTPUT:
 838  RETVAL
 839
 840 SV *
 841 UP(...)
 842 PROTOTYPE: ;$
 843 PREINIT:
 844  I32 cxix;
 845 CODE:
 846  SU_GET_CONTEXT(0, 0);
 847  if (--cxix < 0)
 848   cxix = 0;
 849  if (PL_DBsub)
 850   SU_SKIP_DB(cxix);
 851  RETVAL = newSViv(cxix);
 852 OUTPUT:
 853  RETVAL
 854
 855 void
 856 SUB(...)
 857 PROTOTYPE: ;$
 858 PREINIT:
 859  I32 cxix;
 860 PPCODE:
 861  SU_GET_CONTEXT(0, 0);
 862  for (; cxix >= 0; --cxix) {
 863   PERL_CONTEXT *cx = cxstack + cxix;
 864   switch (CxTYPE(cx)) {
 865    default:
 866     continue;
 867    case CXt_SUB:
 868     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 869      continue;
 870     ST(0) = sv_2mortal(newSViv(cxix));
 871     XSRETURN(1);
 872   }
 873  }
 874  XSRETURN_UNDEF;
 875
 876 void
 877 EVAL(...)
 878 PROTOTYPE: ;$
 879 PREINIT:
 880  I32 cxix;
 881 PPCODE:
 882  SU_GET_CONTEXT(0, 0);
 883  for (; cxix >= 0; --cxix) {
 884   PERL_CONTEXT *cx = cxstack + cxix;
 885   switch (CxTYPE(cx)) {
 886    default:
 887     continue;
 888    case CXt_EVAL:
 889     ST(0) = sv_2mortal(newSViv(cxix));
 890     XSRETURN(1);
 891   }
 892  }
 893  XSRETURN_UNDEF;
 894
 895 void
 896 SCOPE(...)
 897 PROTOTYPE: ;$
 898 PREINIT:
 899  I32 cxix, level;
 900 PPCODE:
 901  SU_GET_LEVEL(0, 0);
 902  cxix = cxstack_ix;
 903  if (PL_DBsub) {
 904   SU_SKIP_DB(cxix);
 905   while (cxix > 0) {
 906    if (--level < 0)
 907     break;
 908    --cxix;
 909    SU_SKIP_DB(cxix);
 910   }
 911  } else {
 912   cxix -= level;
 913   if (cxix < 0)
 914    cxix = 0;
 915  }
 916  ST(0) = sv_2mortal(newSViv(cxix));
 917  XSRETURN(1);
 918
 919 void
 920 CALLER(...)
 921 PROTOTYPE: ;$
 922 PREINIT:
 923  I32 cxix, level;
 924 PPCODE:
 925  SU_GET_LEVEL(0, 0);
 926  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 927   PERL_CONTEXT *cx = cxstack + cxix;
 928   switch (CxTYPE(cx)) {
 929    case CXt_SUB:
 930     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 931      continue;
 932    case CXt_EVAL:
 933    case CXt_FORMAT:
 934     if (--level < 0)
 935      goto done;
 936     break;
 937   }
 938  }
 939 done:
 940  ST(0) = sv_2mortal(newSViv(cxix));
 941  XSRETURN(1);
 942
 943 void
 944 want_at(...)
 945 PROTOTYPE: ;$
 946 PREINIT:
 947  I32 cxix;
 948 PPCODE:
 949  SU_GET_CONTEXT(0, 0);
 950  while (cxix > 0) {
 951   PERL_CONTEXT *cx = cxstack + cxix--;
 952   switch (CxTYPE(cx)) {
 953    case CXt_SUB:
 954    case CXt_EVAL:
 955    case CXt_FORMAT: {
 956     I32 gimme = cx->blk_gimme;
 957     switch (gimme) {
 958      case G_VOID:   XSRETURN_UNDEF; break;
 959      case G_SCALAR: XSRETURN_NO;    break;
 960      case G_ARRAY:  XSRETURN_YES;   break;
 961     }
 962     break;
 963    }
 964   }
 965  }
 966  XSRETURN_UNDEF;
 967
 968 void
 969 reap(SV *hook, ...)
 970 PROTOTYPE: &;$
 971 PREINIT:
 972  I32 cxix;
 973  su_ud_reap *ud;
 974 CODE:
 975  SU_GET_CONTEXT(1, 1);
 976  Newx(ud, 1, su_ud_reap);
 977  SU_UD_ORIGIN(ud)  = NULL;
 978  SU_UD_HANDLER(ud) = su_reap;
 979  ud->cb = newSVsv(hook);
 980  su_init(cxix, ud, 3);
 981
 982 void
 983 localize(SV *sv, SV *val, ...)
 984 PROTOTYPE: $$;$
 985 PREINIT:
 986  I32 cxix;
 987  I32 size = 3;
 988  su_ud_localize *ud;
 989 CODE:
 990  SU_GET_CONTEXT(2, 2);
 991  Newx(ud, 1, su_ud_localize);
 992  SU_UD_ORIGIN(ud)  = NULL;
 993  SU_UD_HANDLER(ud) = su_localize;
 994  su_ud_localize_init(ud, sv, val, NULL);
 995 #if !SU_HAS_PERL(5, 8, 9)
 996  if (ud->type >= SVt_PVGV)
 997   size = 6;
 998 #endif
 999  su_init(cxix, ud, size);
1000
1001 void
1002 localize_elem(SV *sv, SV *elem, SV *val, ...)
1003 PROTOTYPE: $$$;$
1004 PREINIT:
1005  I32 cxix;
1006  su_ud_localize *ud;
1007 CODE:
1008  SU_GET_CONTEXT(3, 3);
1009  Newx(ud, 1, su_ud_localize);
1010  SU_UD_ORIGIN(ud)  = NULL;
1011  SU_UD_HANDLER(ud) = su_localize;
1012  su_ud_localize_init(ud, sv, val, elem);
1013  su_init(cxix, ud, 4);
1014
1015 void
1016 localize_delete(SV *sv, SV *elem, ...)
1017 PROTOTYPE: $$;$
1018 PREINIT:
1019  I32 cxix;
1020  I32 size = 4;
1021  su_ud_localize *ud;
1022 CODE:
1023  SU_GET_CONTEXT(2, 2);
1024  Newx(ud, 1, su_ud_localize);
1025  SU_UD_ORIGIN(ud)  = NULL;
1026  SU_UD_HANDLER(ud) = su_localize;
1027  su_ud_localize_init(ud, sv, NULL, elem);
1028 #if !SU_HAS_PERL(5, 8, 9)
1029  if (ud->type >= SVt_PVGV)
1030   size = 6;
1031 #endif
1032  su_init(cxix, ud, size);