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