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