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   (void)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  }
 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
 495  LEAVE;
 496
 497  if (cxix >= cxstack_ix) {
 498   SU_UD_HANDLER(ud)(aTHX_ ud);
 499   goto done;
 500  }
 501
 502  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
 503
 504  for (i = cxstack_ix; i > cxix; --i) {
 505   PERL_CONTEXT *cx = cxstack + i;
 506   switch (CxTYPE(cx)) {
 507 #if SU_HAS_PERL(5, 11, 0)
 508    case CXt_LOOP_FOR:
 509    case CXt_LOOP_PLAIN:
 510    case CXt_LOOP_LAZYSV:
 511    case CXt_LOOP_LAZYIV:
 512 #else
 513    case CXt_LOOP:
 514 #endif
 515     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 516     depth += 2;
 517     break;
 518    default:
 519     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
 520     depth++;
 521     break;
 522   }
 523  }
 524  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 525
 526  Newx(origin, depth + 1, I32);
 527  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 528  PL_scopestack[PL_scopestack_ix - depth] += size;
 529  for (i = depth - 1; i >= 1; --i) {
 530   I32 j = PL_scopestack_ix - i;
 531   origin[depth - i] = PL_scopestack[j];
 532   PL_scopestack[j] += 3;
 533  }
 534  origin[depth] = PL_savestack_ix;
 535
 536  SU_D({
 537   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 538                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 539   for (i = depth - 1; i >= 0; --i) {
 540    I32 x = PL_scopestack_ix  - depth + i;
 541    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 542                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 543   }
 544  });
 545
 546  SU_UD_ORIGIN(ud) = origin;
 547  SU_UD_DEPTH(ud)  = depth;
 548
 549  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 550                                      ud, PL_savestack_ix, depth));
 551
 552  SAVEDESTRUCTOR_X(su_pop, ud);
 553
 554 done:
 555  ENTER;
 556
 557  return depth;
 558 }
 559
 560 /* --- Global data --------------------------------------------------------- */
 561
 562 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 563
 564 typedef struct {
 565  I32 cxix;
 566  I32 items;
 567  SV  **savesp;
 568  OP  fakeop;
 569 } my_cxt_t;
 570
 571 START_MY_CXT
 572
 573 /* --- Unwind stack -------------------------------------------------------- */
 574
 575 STATIC void su_unwind(pTHX_ void *ud_) {
 576  dMY_CXT;
 577  I32 cxix    = MY_CXT.cxix;
 578  I32 items   = MY_CXT.items - 1;
 579  SV **savesp = MY_CXT.savesp;
 580  I32 mark;
 581
 582  PERL_UNUSED_VAR(ud_);
 583
 584  if (savesp)
 585   PL_stack_sp = savesp;
 586
 587  if (cxstack_ix > cxix)
 588   dounwind(cxix);
 589
 590  /* Hide the level */
 591  if (items >= 0)
 592   PL_stack_sp--;
 593
 594  mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
 595  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
 596
 597  SU_D({
 598   I32 gimme = GIMME_V;
 599   PerlIO_printf(Perl_debug_log,
 600                 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
 601                 &MY_CXT, cxix,
 602                 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
 603                 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
 604  });
 605
 606  PL_op = PL_ppaddr[OP_RETURN](aTHX);
 607  *PL_markstack_ptr = mark;
 608
 609  MY_CXT.fakeop.op_next = PL_op;
 610  PL_op = &(MY_CXT.fakeop);
 611 }
 612
 613 /* --- XS ------------------------------------------------------------------ */
 614
 615 #if SU_HAS_PERL(5, 8, 9)
 616 # define SU_SKIP_DB_MAX 2
 617 #else
 618 # define SU_SKIP_DB_MAX 3
 619 #endif
 620
 621 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
 622  * followed by a DB sub */
 623
 624 #define SU_SKIP_DB(C) \
 625  STMT_START {         \
 626   I32 i = 1;          \
 627   PERL_CONTEXT *cx = cxstack + (C); \
 628   do {                              \
 629    if (CxTYPE(cx) == CXt_BLOCK && (C) >= i) { \
 630     --cx;                                     \
 631     if (CxTYPE(cx) == CXt_SUB && cx->blk_sub.cv == GvCV(PL_DBsub)) { \
 632      (C) -= i + 1;                 \
 633      break;                        \
 634     }                              \
 635    } else                          \
 636     break;                         \
 637   } while (++i <= SU_SKIP_DB_MAX); \
 638  } STMT_END
 639
 640 #define SU_GET_CONTEXT(A, B)   \
 641  STMT_START {                  \
 642   if (items > A) {             \
 643    SV *csv = ST(B);            \
 644    if (SvOK(csv))              \
 645     cxix = SvIV(csv);          \
 646    if (cxix < 0)               \
 647     cxix = 0;                  \
 648    else if (cxix > cxstack_ix) \
 649     cxix = cxstack_ix;         \
 650   } else {                     \
 651    cxix = cxstack_ix;          \
 652    if (PL_DBsub)               \
 653     SU_SKIP_DB(cxix);          \
 654   }                            \
 655  } STMT_END
 656
 657 #define SU_GET_LEVEL(A, B) \
 658  STMT_START {              \
 659   if (items > 0) {         \
 660    SV *lsv = ST(B);        \
 661    if (SvOK(lsv))          \
 662     level = SvIV(lsv);     \
 663    if (level < 0)          \
 664     level = 0;             \
 665   } else                   \
 666    level = 0;              \
 667  } STMT_END
 668
 669 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
 670
 671 XS(XS_Scope__Upper_unwind) {
 672 #ifdef dVAR
 673  dVAR; dXSARGS;
 674 #else
 675  dXSARGS;
 676 #endif
 677  dMY_CXT;
 678  I32 cxix;
 679
 680  PERL_UNUSED_VAR(cv); /* -W */
 681  PERL_UNUSED_VAR(ax); /* -Wall */
 682
 683  SU_GET_CONTEXT(0, items - 1);
 684  do {
 685   PERL_CONTEXT *cx = cxstack + cxix;
 686   switch (CxTYPE(cx)) {
 687    case CXt_SUB:
 688     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 689      continue;
 690    case CXt_EVAL:
 691    case CXt_FORMAT:
 692     MY_CXT.cxix  = cxix;
 693     MY_CXT.items = items;
 694     /* pp_entersub will want to sanitize the stack after returning from there
 695      * Screw that, we're insane */
 696     if (GIMME_V == G_SCALAR) {
 697      MY_CXT.savesp = PL_stack_sp;
 698      /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
 699      PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
 700     } else {
 701      MY_CXT.savesp = NULL;
 702     }
 703     SAVEDESTRUCTOR_X(su_unwind, NULL);
 704     return;
 705    default:
 706     break;
 707   }
 708  } while (--cxix >= 0);
 709  croak("Can't return outside a subroutine");
 710 }
 711
 712 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 713
 714 PROTOTYPES: ENABLE
 715
 716 BOOT:
 717 {
 718  HV *stash;
 719  MY_CXT_INIT;
 720  stash = gv_stashpv(__PACKAGE__, 1);
 721  newCONSTSUB(stash, "TOP", newSViv(0));
 722  newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
 723 }
 724
 725 #if SU_THREADSAFE
 726
 727 void
 728 CLONE(...)
 729 PROTOTYPE: DISABLE
 730 CODE:
 731  PERL_UNUSED_VAR(items);
 732  MY_CXT_CLONE;
 733
 734 #endif /* SU_THREADSAFE */
 735
 736 SV *
 737 HERE()
 738 PROTOTYPE:
 739 PREINIT:
 740  I32 cxix = cxstack_ix;
 741 CODE:
 742  if (PL_DBsub)
 743   SU_SKIP_DB(cxix);
 744  RETVAL = newSViv(cxix);
 745 OUTPUT:
 746  RETVAL
 747
 748 SV *
 749 UP(...)
 750 PROTOTYPE: ;$
 751 PREINIT:
 752  I32 cxix;
 753 CODE:
 754  SU_GET_CONTEXT(0, 0);
 755  if (--cxix < 0)
 756   cxix = 0;
 757  if (PL_DBsub)
 758   SU_SKIP_DB(cxix);
 759  RETVAL = newSViv(cxix);
 760 OUTPUT:
 761  RETVAL
 762
 763 void
 764 SUB(...)
 765 PROTOTYPE: ;$
 766 PREINIT:
 767  I32 cxix;
 768 PPCODE:
 769  SU_GET_CONTEXT(0, 0);
 770  for (; cxix >= 0; --cxix) {
 771   PERL_CONTEXT *cx = cxstack + cxix;
 772   switch (CxTYPE(cx)) {
 773    default:
 774     continue;
 775    case CXt_SUB:
 776     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 777      continue;
 778     ST(0) = sv_2mortal(newSViv(cxix));
 779     XSRETURN(1);
 780   }
 781  }
 782  XSRETURN_UNDEF;
 783
 784 void
 785 EVAL(...)
 786 PROTOTYPE: ;$
 787 PREINIT:
 788  I32 cxix;
 789 PPCODE:
 790  SU_GET_CONTEXT(0, 0);
 791  for (; cxix >= 0; --cxix) {
 792   PERL_CONTEXT *cx = cxstack + cxix;
 793   switch (CxTYPE(cx)) {
 794    default:
 795     continue;
 796    case CXt_EVAL:
 797     ST(0) = sv_2mortal(newSViv(cxix));
 798     XSRETURN(1);
 799   }
 800  }
 801  XSRETURN_UNDEF;
 802
 803 void
 804 SCOPE(...)
 805 PROTOTYPE: ;$
 806 PREINIT:
 807  I32 cxix, level;
 808 PPCODE:
 809  SU_GET_LEVEL(0, 0);
 810  cxix = cxstack_ix;
 811  if (PL_DBsub) {
 812   SU_SKIP_DB(cxix);
 813   while (cxix > 0) {
 814    if (--level < 0)
 815     break;
 816    --cxix;
 817    SU_SKIP_DB(cxix);
 818   }
 819  } else {
 820   cxix -= level;
 821   if (cxix < 0)
 822    cxix = 0;
 823  }
 824  ST(0) = sv_2mortal(newSViv(cxix));
 825  XSRETURN(1);
 826
 827 void
 828 CALLER(...)
 829 PROTOTYPE: ;$
 830 PREINIT:
 831  I32 cxix, level;
 832 PPCODE:
 833  SU_GET_LEVEL(0, 0);
 834  for (cxix = cxstack_ix; cxix > 0; --cxix) {
 835   PERL_CONTEXT *cx = cxstack + cxix;
 836   switch (CxTYPE(cx)) {
 837    case CXt_SUB:
 838     if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
 839      continue;
 840    case CXt_EVAL:
 841    case CXt_FORMAT:
 842     if (--level < 0)
 843      goto done;
 844     break;
 845   }
 846  }
 847 done:
 848  ST(0) = sv_2mortal(newSViv(cxix));
 849  XSRETURN(1);
 850
 851 void
 852 want_at(...)
 853 PROTOTYPE: ;$
 854 PREINIT:
 855  I32 cxix;
 856 PPCODE:
 857  SU_GET_CONTEXT(0, 0);
 858  while (cxix > 0) {
 859   PERL_CONTEXT *cx = cxstack + cxix--;
 860   switch (CxTYPE(cx)) {
 861    case CXt_SUB:
 862    case CXt_EVAL:
 863    case CXt_FORMAT: {
 864     I32 gimme = cx->blk_gimme;
 865     switch (gimme) {
 866      case G_VOID:   XSRETURN_UNDEF; break;
 867      case G_SCALAR: XSRETURN_NO;    break;
 868      case G_ARRAY:  XSRETURN_YES;   break;
 869     }
 870     break;
 871    }
 872   }
 873  }
 874  XSRETURN_UNDEF;
 875
 876 void
 877 reap(SV *hook, ...)
 878 PROTOTYPE: &;$
 879 PREINIT:
 880  I32 cxix;
 881  su_ud_reap *ud;
 882 CODE:
 883  SU_GET_CONTEXT(1, 1);
 884  Newx(ud, 1, su_ud_reap);
 885  SU_UD_ORIGIN(ud)  = NULL;
 886  SU_UD_HANDLER(ud) = su_reap;
 887  ud->cb = newSVsv(hook);
 888  su_init(cxix, ud, 3);
 889
 890 void
 891 localize(SV *sv, SV *val, ...)
 892 PROTOTYPE: $$;$
 893 PREINIT:
 894  I32 cxix;
 895  su_ud_localize *ud;
 896 CODE:
 897  SU_GET_CONTEXT(2, 2);
 898  Newx(ud, 1, su_ud_localize);
 899  SU_UD_ORIGIN(ud)  = NULL;
 900  SU_UD_HANDLER(ud) = su_localize;
 901  SvREFCNT_inc(sv);
 902  ud->sv   = sv;
 903  ud->val  = newSVsv(val);
 904  ud->elem = NULL;
 905  su_init(cxix, ud, 3);
 906
 907 void
 908 localize_elem(SV *sv, SV *elem, SV *val, ...)
 909 PROTOTYPE: $$$;$
 910 PREINIT:
 911  I32 cxix;
 912  su_ud_localize *ud;
 913 CODE:
 914  SU_GET_CONTEXT(3, 3);
 915  Newx(ud, 1, su_ud_localize);
 916  SU_UD_ORIGIN(ud)  = NULL;
 917  SU_UD_HANDLER(ud) = su_localize;
 918  SvREFCNT_inc(sv);
 919  ud->sv   = sv;
 920  ud->val  = newSVsv(val);
 921  SvREFCNT_inc(elem);
 922  ud->elem = elem;
 923  su_init(cxix, ud, 4);
 924
 925 void
 926 localize_delete(SV *sv, SV *elem, ...)
 927 PROTOTYPE: $$;$
 928 PREINIT:
 929  I32 cxix;
 930  su_ud_localize *ud;
 931 CODE:
 932  SU_GET_CONTEXT(2, 2);
 933  Newx(ud, 1, su_ud_localize);
 934  SU_UD_ORIGIN(ud)  = NULL;
 935  SU_UD_HANDLER(ud) = su_localize;
 936  SvREFCNT_inc(sv);
 937  ud->sv   = sv;
 938  ud->val  = NULL;
 939  SvREFCNT_inc(elem);
 940  ud->elem = elem;
 941  su_init(cxix, ud, 4);