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    SV * const * const negative_indices_glob =
 141                     hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
 142                              NEGATIVE_INDICES_VAR, 16, 0);
 143    if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
 144     return key;
 145   }
 146  }
 147 #endif
 148
 149  idx = key + av_len(av) + 1;
 150  if (idx < 0)
 151   return key;
 152
 153  return idx;
 154 }
 155
 156 #ifndef SAVEADELETE
 157
 158 typedef struct {
 159  AV *av;
 160  I32 idx;
 161 } su_ud_adelete;
 162
 163 STATIC void su_adelete(pTHX_ void *ud_) {
 164  su_ud_adelete *ud = (su_ud_adelete *) ud_;
 165
 166  av_delete(ud->av, ud->idx, G_DISCARD);
 167  SvREFCNT_dec(ud->av);
 168
 169  Safefree(ud);
 170 }
 171
 172 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 173 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
 174  su_ud_adelete *ud;
 175
 176  Newx(ud, 1, su_ud_adelete);
 177  ud->av  = av;
 178  ud->idx = idx;
 179  SvREFCNT_inc(av);
 180
 181  SAVEDESTRUCTOR_X(su_adelete, ud);
 182 }
 183
 184 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
 185
 186 #endif /* SAVEADELETE */
 187
 188 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
 189 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
 190  I32 idx;
 191  I32 preeminent = 1;
 192  SV **svp;
 193  HV *stash;
 194  MAGIC *mg;
 195
 196  idx = su_av_key2idx(av, SvIV(key));
 197
 198  if (SvCANEXISTDELETE(av))
 199   preeminent = av_exists(av, idx);
 200
 201  svp = av_fetch(av, idx, 1);
 202  if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 203
 204  if (preeminent)
 205   save_aelem(av, idx, svp);
 206  else
 207   SAVEADELETE(av, idx);
 208
 209  if (val) { /* local $x[$idx] = $val; */
 210   SvSetMagicSV(*svp, val);
 211  } else {   /* local $x[$idx]; delete $x[$idx]; */
 212   av_delete(av, idx, G_DISCARD);
 213  }
 214 }
 215
 216 /* ... Saving hash elements ................................................ */
 217
 218 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
 219 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
 220  I32 preeminent = 1;
 221  HE *he;
 222  SV **svp;
 223  HV *stash;
 224  MAGIC *mg;
 225
 226  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 227   preeminent = hv_exists_ent(hv, keysv, 0);
 228
 229  he  = hv_fetch_ent(hv, keysv, 1, 0);
 230  svp = he ? &HeVAL(he) : NULL;
 231  if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 232
 233  if (HvNAME_get(hv) && isGV(*svp)) {
 234   save_gp((GV *) *svp, 0);
 235   return;
 236  }
 237
 238  if (preeminent)
 239   save_helem(hv, keysv, svp);
 240  else {
 241   STRLEN keylen;
 242   const char * const key = SvPV_const(keysv, keylen);
 243   SAVEDELETE(hv, savepvn(key, keylen),
 244                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 245  }
 246
 247  if (val) { /* local $x{$keysv} = $val; */
 248   SvSetMagicSV(*svp, val);
 249  } else {   /* local $x{$keysv}; delete $x{$keysv}; */
 250   hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
 251  }
 252 }
 253
 254 /* --- Actions ------------------------------------------------------------- */
 255
 256 typedef struct {
 257  I32 depth;
 258  I32 *origin;
 259  void (*handler)(pTHX_ void *);
 260 } su_ud_common;
 261
 262 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
 263 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 264 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 265
 266 #define SU_UD_FREE(U) STMT_START { \
 267  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
 268  Safefree(U); \
 269 } STMT_END
 270
 271 /* ... Reap ................................................................ */
 272
 273 typedef struct {
 274  su_ud_common ci;
 275  SV *cb;
 276 } su_ud_reap;
 277
 278 STATIC void su_call(pTHX_ void *ud_) {
 279  su_ud_reap *ud = (su_ud_reap *) ud_;
 280 #if SU_HAS_PERL(5, 10, 0)
 281  I32 dieing = PL_op->op_type == OP_DIE;
 282 #endif
 283
 284  dSP;
 285
 286  SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
 287                                      ud, PL_scopestack_ix, PL_savestack_ix));
 288  ENTER;
 289  SAVETMPS;
 290
 291  PUSHMARK(SP);
 292  PUTBACK;
 293
 294  /* If cxstack_ix isn't incremented there, the eval context will be overwritten
 295   * when the new sub scope will be created in call_sv. */
 296
 297 #if SU_HAS_PERL(5, 10, 0)
 298  if (dieing)
 299   if (cxstack_ix < cxstack_max)
 300    ++cxstack_ix;
 301   else
 302    cxstack_ix = Perl_cxinc(aTHX);
 303 #endif
 304
 305  call_sv(ud->cb, G_VOID);
 306
 307 #if SU_HAS_PERL(5, 10, 0)
 308  if (dieing && cxstack_ix > 0)
 309   --cxstack_ix;
 310 #endif
 311
 312  SPAGAIN;
 313  PUTBACK;
 314
 315  FREETMPS;
 316  LEAVE;
 317
 318  SvREFCNT_dec(ud->cb);
 319  SU_UD_FREE(ud);
 320 }
 321
 322 STATIC void su_reap(pTHX_ void *ud) {
 323 #define su_reap(U) su_reap(aTHX_ (U))
 324  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
 325                                      ud, PL_scopestack_ix, PL_savestack_ix));
 326  SAVEDESTRUCTOR_X(su_call, ud);
 327  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 328                                      ud, PL_savestack_ix,
 329                                          PL_scopestack[PL_scopestack_ix]));
 330 }
 331
 332 /* ... Localize & localize array/hash element .............................. */
 333
 334 typedef struct {
 335  su_ud_common ci;
 336  SV *sv;
 337  SV *val;
 338  SV *elem;
 339 } su_ud_localize;
 340
 341 STATIC void su_localize(pTHX_ void *ud_) {
 342 #define su_localize(U) su_localize(aTHX_ (U))
 343  su_ud_localize *ud = (su_ud_localize *) ud_;
 344  SV *sv   = ud->sv;
 345  SV *val  = ud->val;
 346  SV *elem = ud->elem;
 347  GV *gv;
 348  UV deref = 0;
 349  svtype t = SVt_NULL;
 350
 351  if (SvTYPE(sv) >= SVt_PVGV) {
 352   gv = (GV *) sv;
 353   if (!val) {               /* local *x; */
 354    t = SVt_PVGV;
 355   } else if (!SvROK(val)) { /* local *x = $val; */
 356    goto assign;
 357   } else {                  /* local *x = \$val; */
 358    t = SvTYPE(SvRV(val));
 359    deref = 1;
 360   }
 361  } else {
 362   STRLEN len, l;
 363   const char *p = SvPV_const(sv, len), *s;
 364   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 365   if (!l) {
 366    l = len;
 367    s = p;
 368   }
 369   switch (*s) {
 370    case '$': t = SVt_PV;   break;
 371    case '@': t = SVt_PVAV; break;
 372    case '%': t = SVt_PVHV; break;
 373    case '&': t = SVt_PVCV; break;
 374    case '*': t = SVt_PVGV; break;
 375   }
 376   if (t != SVt_NULL) {
 377    ++s;
 378    --l;
 379   } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
 380    if (SvROK(val) && !sv_isobject(val)) {
 381     t = SvTYPE(SvRV(val));
 382     deref = 1;
 383    } else {
 384     t = SvTYPE(val);
 385    }
 386   }
 387   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 388  }
 389
 390  SU_D({
 391   SV *z = newSV_type(t);
 392   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
 393                                  ud, sv_reftype(z, 0),
 394                                      PL_scopestack_ix, PL_savestack_ix);
 395   SvREFCNT_dec(z);
 396  });
 397
 398  /* Inspired from Alias.pm */
 399  switch (t) {
 400   case SVt_PVAV:
 401    if (elem) {
 402     su_save_aelem(GvAV(gv), elem, val);
 403     goto done;
 404    } else
 405     save_ary(gv);
 406    break;
 407   case SVt_PVHV:
 408    if (elem) {
 409     su_save_helem(GvHV(gv), elem, val);
 410     goto done;
 411    } else
 412     save_hash(gv);
 413    break;
 414   case SVt_PVGV:
 415    save_gp(gv, 1); /* hide previous entry in symtab */
 416    break;
 417   case SVt_PVCV:
 418    SAVESPTR(GvCV(gv));
 419    GvCV(gv) = NULL;
 420    break;
 421   default:
 422    gv = (GV *) save_scalar(gv);
 423    if (deref) /* val != NULL */
 424     val = SvRV(val);
 425    break;
 426  }
 427
 428  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 429                                      ud, PL_savestack_ix,
 430                                          PL_scopestack[PL_scopestack_ix]));
 431
 432 assign:
 433  if (val)
 434   SvSetMagicSV((SV *) gv, val);
 435
 436 done:
 437  SvREFCNT_dec(ud->elem);
 438  SvREFCNT_dec(ud->val);
 439  SvREFCNT_dec(ud->sv);
 440  SU_UD_FREE(ud);
 441 }
 442
 443 /* --- Pop a context back -------------------------------------------------- */
 444
 445 #if SU_DEBUG
 446 # ifdef DEBUGGING
 447 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 448 # else
 449 #  define SU_CXNAME "XXX"
 450 # endif
 451 #endif
 452
 453 STATIC void su_pop(pTHX_ void *ud) {
 454 #define su_pop(U) su_pop(aTHX_ (U))
 455  I32 depth, base, mark, *origin;
 456  depth = SU_UD_DEPTH(ud);
 457
 458  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
 459                                      ud, SU_CXNAME,
 460                                          PL_scopestack_ix, PL_savestack_ix,
 461                                          PL_scopestack[PL_scopestack_ix],
 462                                          depth));
 463
 464  origin = SU_UD_ORIGIN(ud);
 465  mark   = origin[depth];
 466  base   = origin[depth - 1];
 467
 468  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
 469                                      ud, mark, base));
 470
 471  if (base < mark) {
 472   PL_savestack_ix = mark;
 473   leave_scope(base);
 474  }
 475  PL_savestack_ix = base;
 476  if (--depth > 0) {
 477   SU_UD_DEPTH(ud) = depth;
 478   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
 479                                       ud, PL_savestack_ix, depth));
 480   SAVEDESTRUCTOR_X(su_pop, ud);
 481   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
 482                                       ud, PL_savestack_ix, depth));
 483  } else {
 484   SU_UD_HANDLER(ud)(aTHX_ ud);
 485  }
 486 }
 487
 488 /* --- Initialize the stack and the action userdata ------------------------ */
 489
 490 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
 491 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 492  I32 i, depth = 0, *origin;
 493
 494  LEAVE;
 495
 496  if (cxix >= cxstack_ix) {
 497   SU_UD_HANDLER(ud)(aTHX_ ud);
 498   goto done;
 499  }
 500
 501  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 502
 503  for (i = cxstack_ix; i > cxix; --i) {
 504   PERL_CONTEXT *cx = cxstack + i;
 505   switch (CxTYPE(cx)) {
 506 #if SU_HAS_PERL(5, 11, 0)
 507    case CXt_LOOP_FOR:
 508    case CXt_LOOP_PLAIN:
 509    case CXt_LOOP_LAZYSV:
 510    case CXt_LOOP_LAZYIV:
 511 #else
 512    case CXt_LOOP:
 513 #endif
 514     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 515     depth += 2;
 516     break;
 517    default:
 518     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
 519     depth++;
 520     break;
 521   }
 522  }
 523  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 524
 525  Newx(origin, depth + 1, I32);
 526  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 527  PL_scopestack[PL_scopestack_ix - depth] += size;
 528  for (i = depth - 1; i >= 1; --i) {
 529   I32 j = PL_scopestack_ix - i;
 530   origin[depth - i] = PL_scopestack[j];
 531   PL_scopestack[j] += 3;
 532  }
 533  origin[depth] = PL_savestack_ix;
 534
 535  SU_D({
 536   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 537                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 538   for (i = depth - 1; i >= 0; --i) {
 539    I32 x = PL_scopestack_ix  - depth + i;
 540    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 541                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 542   }
 543  });
 544
 545  SU_UD_ORIGIN(ud) = origin;
 546  SU_UD_DEPTH(ud)  = depth;
 547
 548  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 549                                      ud, PL_savestack_ix, depth));
 550
 551  SAVEDESTRUCTOR_X(su_pop, ud);
 552
 553 done:
 554  ENTER;
 555
 556  return depth;
 557 }
 558
 559 /* --- Global data --------------------------------------------------------- */
 560
 561 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 562
 563 typedef struct {
 564  I32 cxix;
 565  I32 items;
 566  SV  **savesp;
 567  OP  fakeop;
 568 } my_cxt_t;
 569
 570 START_MY_CXT
 571
 572 /* --- Unwind stack -------------------------------------------------------- */
 573
 574 STATIC void su_unwind(pTHX_ void *ud_) {
 575  dMY_CXT;
 576  I32 cxix    = MY_CXT.cxix;
 577  I32 items   = MY_CXT.items - 1;
 578  SV **savesp = MY_CXT.savesp;
 579  I32 mark;
 580
 581  PERL_UNUSED_VAR(ud_);
 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  PERL_UNUSED_VAR(items);
 729 #if SU_THREADSAFE
 730  MY_CXT_CLONE;
 731 #endif /* SU_THREADSAFE */
 732
 733 SV *
 734 HERE()
 735 PROTOTYPE:
 736 PREINIT:
 737  I32 cxix = cxstack_ix;
 738 CODE:
 739  if (PL_DBsub)
 740   SU_SKIP_DB(cxix);
 741  RETVAL = newSViv(cxix);
 742 OUTPUT:
 743  RETVAL
 744
 745 SV *
 746 UP(...)
 747 PROTOTYPE: ;$
 748 PREINIT:
 749  I32 cxix;
 750 CODE:
 751  SU_GET_CONTEXT(0, 0);
 752  if (--cxix < 0)
 753   cxix = 0;
 754  if (PL_DBsub)
 755   SU_SKIP_DB(cxix);
 756  RETVAL = newSViv(cxix);
 757 OUTPUT:
 758  RETVAL
 759
 760 void
 761 SUB(...)
 762 PROTOTYPE: ;$
 763 PREINIT:
 764  I32 cxix;
 765 PPCODE:
 766  SU_GET_CONTEXT(0, 0);
 767  for (; cxix >= 0; --cxix) {
 768   PERL_CONTEXT *cx = cxstack + cxix;
 769   switch (CxTYPE(cx)) {
 770    default:
 771     continue;
 772    case CXt_SUB:
 773     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 774      continue;
 775     ST(0) = sv_2mortal(newSViv(cxix));
 776     XSRETURN(1);
 777   }
 778  }
 779  XSRETURN_UNDEF;
 780
 781 void
 782 EVAL(...)
 783 PROTOTYPE: ;$
 784 PREINIT:
 785  I32 cxix;
 786 PPCODE:
 787  SU_GET_CONTEXT(0, 0);
 788  for (; cxix >= 0; --cxix) {
 789   PERL_CONTEXT *cx = cxstack + cxix;
 790   switch (CxTYPE(cx)) {
 791    default:
 792     continue;
 793    case CXt_EVAL:
 794     ST(0) = sv_2mortal(newSViv(cxix));
 795     XSRETURN(1);
 796   }
 797  }
 798  XSRETURN_UNDEF;
 799
 800 void
 801 SCOPE(...)
 802 PROTOTYPE: ;$
 803 PREINIT:
 804  I32 cxix, level;
 805 PPCODE:
 806  SU_GET_LEVEL(0, 0);
 807  cxix = cxstack_ix;
 808  if (PL_DBsub) {
 809   SU_SKIP_DB(cxix);
 810   while (cxix > 0) {
 811    if (--level < 0)
 812     break;
 813    --cxix;
 814    SU_SKIP_DB(cxix);
 815   }
 816  } else {
 817   cxix -= level;
 818   if (cxix < 0)
 819    cxix = 0;
 820  }
 821  ST(0) = sv_2mortal(newSViv(cxix));
 822  XSRETURN(1);
 823
 824 void
 825 CALLER(...)
 826 PROTOTYPE: ;$
 827 PREINIT:
 828  I32 cxix, level;
 829 PPCODE:
 830  SU_GET_LEVEL(0, 0);
 831  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 832   PERL_CONTEXT *cx = cxstack + cxix;
 833   switch (CxTYPE(cx)) {
 834    case CXt_SUB:
 835     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 836      continue;
 837    case CXt_EVAL:
 838    case CXt_FORMAT:
 839     if (--level < 0)
 840      goto done;
 841     break;
 842   }
 843  }
 844 done:
 845  ST(0) = sv_2mortal(newSViv(cxix));
 846  XSRETURN(1);
 847
 848 void
 849 want_at(...)
 850 PROTOTYPE: ;$
 851 PREINIT:
 852  I32 cxix;
 853 PPCODE:
 854  SU_GET_CONTEXT(0, 0);
 855  while (cxix > 0) {
 856   PERL_CONTEXT *cx = cxstack + cxix--;
 857   switch (CxTYPE(cx)) {
 858    case CXt_SUB:
 859    case CXt_EVAL:
 860    case CXt_FORMAT: {
 861     I32 gimme = cx->blk_gimme;
 862     switch (gimme) {
 863      case G_VOID:   XSRETURN_UNDEF; break;
 864      case G_SCALAR: XSRETURN_NO;    break;
 865      case G_ARRAY:  XSRETURN_YES;   break;
 866     }
 867     break;
 868    }
 869   }
 870  }
 871  XSRETURN_UNDEF;
 872
 873 void
 874 reap(SV *hook, ...)
 875 PROTOTYPE: &;$
 876 PREINIT:
 877  I32 cxix;
 878  su_ud_reap *ud;
 879 CODE:
 880  SU_GET_CONTEXT(1, 1);
 881  Newx(ud, 1, su_ud_reap);
 882  SU_UD_ORIGIN(ud)  = NULL;
 883  SU_UD_HANDLER(ud) = su_reap;
 884  ud->cb = newSVsv(hook);
 885  su_init(cxix, ud, 3);
 886
 887 void
 888 localize(SV *sv, SV *val, ...)
 889 PROTOTYPE: $$;$
 890 PREINIT:
 891  I32 cxix;
 892  su_ud_localize *ud;
 893 CODE:
 894  SU_GET_CONTEXT(2, 2);
 895  Newx(ud, 1, su_ud_localize);
 896  SU_UD_ORIGIN(ud)  = NULL;
 897  SU_UD_HANDLER(ud) = su_localize;
 898  SvREFCNT_inc(sv);
 899  ud->sv   = sv;
 900  ud->val  = newSVsv(val);
 901  ud->elem = NULL;
 902  su_init(cxix, ud, 3);
 903
 904 void
 905 localize_elem(SV *sv, SV *elem, SV *val, ...)
 906 PROTOTYPE: $$$;$
 907 PREINIT:
 908  I32 cxix;
 909  su_ud_localize *ud;
 910 CODE:
 911  SU_GET_CONTEXT(3, 3);
 912  Newx(ud, 1, su_ud_localize);
 913  SU_UD_ORIGIN(ud)  = NULL;
 914  SU_UD_HANDLER(ud) = su_localize;
 915  SvREFCNT_inc(sv);
 916  ud->sv   = sv;
 917  ud->val  = newSVsv(val);
 918  SvREFCNT_inc(elem);
 919  ud->elem = elem;
 920  su_init(cxix, ud, 4);
 921
 922 void
 923 localize_delete(SV *sv, SV *elem, ...)
 924 PROTOTYPE: $$;$
 925 PREINIT:
 926  I32 cxix;
 927  su_ud_localize *ud;
 928 CODE:
 929  SU_GET_CONTEXT(2, 2);
 930  Newx(ud, 1, su_ud_localize);
 931  SU_UD_ORIGIN(ud)  = NULL;
 932  SU_UD_HANDLER(ud) = su_localize;
 933  SvREFCNT_inc(sv);
 934  ud->sv   = sv;
 935  ud->val  = NULL;
 936  SvREFCNT_inc(elem);
 937  ud->elem = elem;
 938  su_init(cxix, ud, 4);