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 #ifndef SU_DEBUG
  10 # define SU_DEBUG 0
  11 #endif
  12
  13 #ifndef STMT_START
  14 # define STMT_START do
  15 #endif
  16
  17 #ifndef STMT_END
  18 # define STMT_END while (0)
  19 #endif
  20
  21 #if SU_DEBUG
  22 # define SU_D(X) STMT_START X STMT_END
  23 #else
  24 # define SU_D(X)
  25 #endif
  26
  27 #ifndef Newx
  28 # define Newx(v, n, c) New(0, v, n, c)
  29 #endif
  30
  31 #ifndef SvPV_const
  32 # define SvPV_const(S, L) SvPV(S, L)
  33 #endif
  34
  35 #ifndef SvPV_nolen_const
  36 # define SvPV_nolen_const(S) SvPV_nolen(S)
  37 #endif
  38
  39 #ifndef HvNAME_get
  40 # define HvNAME_get(H) HvNAME(H)
  41 #endif
  42
  43 #ifndef gv_fetchpvn_flags
  44 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
  45 #endif
  46
  47 #ifndef PERL_MAGIC_tied
  48 # define PERL_MAGIC_tied 'P'
  49 #endif
  50
  51 #ifndef PERL_MAGIC_env
  52 # define PERL_MAGIC_env 'E'
  53 #endif
  54
  55 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  56
  57 typedef struct {
  58  I32 depth;
  59  I32 *origin;
  60  void (*handler)(pTHX_ void *);
  61 } su_ud_common;
  62
  63 #define SU_UD_DEPTH(U)   (((su_ud_common *) (U))->depth)
  64 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
  65 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
  66
  67 #define SU_UD_FREE(U) do { \
  68  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
  69  Safefree(U); \
  70 } while (0)
  71
  72 typedef struct {
  73  su_ud_common ci;
  74  SV *cb;
  75 } su_ud_reap;
  76
  77 STATIC void su_call(pTHX_ void *ud_) {
  78  su_ud_reap *ud = (su_ud_reap *) ud_;
  79 #if SU_HAS_PERL(5, 10, 0)
  80  I32 dieing = PL_op->op_type == OP_DIE;
  81 #endif
  82
  83  dSP;
  84
  85  SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
  86                                      ud, PL_scopestack_ix, PL_savestack_ix));
  87  ENTER;
  88  SAVETMPS;
  89
  90  PUSHMARK(SP);
  91  PUTBACK;
  92
  93  /* If cxstack_ix isn't incremented there, the eval context will be overwritten
  94   * when the new sub scope will be created in call_sv. */
  95
  96 #if SU_HAS_PERL(5, 10, 0)
  97  if (dieing)
  98   if (cxstack_ix < cxstack_max)
  99    ++cxstack_ix;
 100   else
 101    cxstack_ix = Perl_cxinc(aTHX);
 102 #endif
 103
 104  call_sv(ud->cb, G_VOID);
 105
 106 #if SU_HAS_PERL(5, 10, 0)
 107  if (dieing && cxstack_ix > 0)
 108   --cxstack_ix;
 109 #endif
 110
 111  SPAGAIN;
 112  PUTBACK;
 113
 114  FREETMPS;
 115  LEAVE;
 116
 117  SvREFCNT_dec(ud->cb);
 118  SU_UD_FREE(ud);
 119 }
 120
 121 STATIC void su_reap(pTHX_ void *ud) {
 122 #define su_reap(U) su_reap(aTHX_ (U))
 123  SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
 124                                      ud, PL_scopestack_ix, PL_savestack_ix));
 125  SAVEDESTRUCTOR_X(su_call, ud);
 126  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 127                                      ud, PL_savestack_ix,
 128                                          PL_scopestack[PL_scopestack_ix]));
 129 }
 130
 131 typedef struct {
 132  su_ud_common ci;
 133  SV *sv;
 134  SV *val;
 135  SV *elem;
 136 } su_ud_localize;
 137
 138 #ifndef SvCANEXISTDELETE
 139 # define SvCANEXISTDELETE(sv) \
 140   (!SvRMAGICAL(sv)            \
 141    || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied))            \
 142        && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
 143        && gv_fetchmethod_autoload(stash, "EXISTS", TRUE)     \
 144        && gv_fetchmethod_autoload(stash, "DELETE", TRUE)     \
 145       )                       \
 146    )
 147 #endif
 148
 149 STATIC I32 su_hv_preeminent(pTHX_ HV *hv, SV *keysv) {
 150 #define su_hv_preeminent(H, K) su_hv_preeminent(aTHX_ (H), (K))
 151  MAGIC *mg;
 152  HV *stash;
 153
 154  if (!hv)
 155   return 0;
 156  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
 157   return hv_exists_ent(hv, keysv, 0);
 158
 159  return 1;
 160 }
 161
 162 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV **svp, I32 preeminent) {
 163 #define su_save_helem(H, K, S, P) su_save_helem(aTHX_ (H), (K), (S), (P))
 164  if (HvNAME_get(hv) && isGV(*svp)) {
 165   save_gp((GV *) *svp, 0);
 166   return;
 167  }
 168  if (!preeminent) {
 169   STRLEN keylen;
 170   const char * const key = SvPV_const(keysv, keylen);
 171   SAVEDELETE(hv, savepvn(key, keylen),
 172                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
 173  } else {
 174   save_helem(hv, keysv, svp);
 175  }
 176 }
 177
 178 STATIC void su_localize(pTHX_ void *ud_) {
 179 #define su_localize(U) su_localize(aTHX_ (U))
 180  su_ud_localize *ud = (su_ud_localize *) ud_;
 181  SV *sv   = ud->sv;
 182  SV *val  = ud->val;
 183  SV *elem = ud->elem;
 184  GV *gv;
 185  UV deref = 0;
 186  svtype t = SVt_NULL;
 187
 188  if (SvTYPE(sv) >= SVt_PVGV) {
 189   gv = (GV *) sv;
 190   if (!SvROK(val))
 191    goto assign;
 192   t = SvTYPE(SvRV(val));
 193   deref = 1;
 194  } else {
 195   STRLEN len, l;
 196   const char *p = SvPV_const(sv, len), *s;
 197   for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
 198   if (!l) {
 199    l = len;
 200    s = p;
 201   }
 202   switch (*s) {
 203    case '$': t = SVt_PV;   break;
 204    case '@': t = SVt_PVAV; break;
 205    case '%': t = SVt_PVHV; break;
 206    case '&': t = SVt_PVCV; break;
 207    case '*': t = SVt_PVGV; break;
 208   }
 209   if (t == SVt_NULL) {
 210    if (SvROK(val) && !sv_isobject(val)) {
 211     t = SvTYPE(SvRV(val));
 212     deref = 1;
 213    } else {
 214     t = SvTYPE(val);
 215    }
 216   } else {
 217    ++s;
 218    --l;
 219   }
 220   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
 221  }
 222
 223  SU_D({
 224   SV *z = newSV_type(t);
 225   PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
 226                                  ud, sv_reftype(z, 0),
 227                                      PL_scopestack_ix, PL_savestack_ix);
 228   SvREFCNT_dec(z);
 229  });
 230
 231  /* Inspired from Alias.pm */
 232  switch (t) {
 233   case SVt_PVAV:
 234    if (elem) {
 235     I32 idx  = SvIV(elem);
 236     AV *av   = GvAV(gv);
 237     SV **svp = av_fetch(av, idx, 1);
 238     if (!*svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
 239     save_aelem(av, idx, svp);
 240     gv = (GV *) *svp;
 241     goto maybe_deref;
 242    } else
 243     save_ary(gv);
 244    break;
 245   case SVt_PVHV:
 246    if (elem) {
 247     HV *hv   = GvHV(gv);
 248     I32 preeminent = su_hv_preeminent(hv, elem);
 249     HE *he   = hv_fetch_ent(hv, elem, 1, 0);
 250     SV **svp = he ? &HeVAL(he) : NULL;
 251     if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 252     su_save_helem(hv, elem, svp, preeminent);
 253     gv = (GV *) *svp;
 254     goto maybe_deref;
 255    } else
 256     save_hash(gv);
 257    break;
 258   case SVt_PVGV:
 259    save_gp(gv, 1); /* hide previous entry in symtab */
 260    break;
 261   case SVt_PVCV:
 262    SAVESPTR(GvCV(gv));
 263    GvCV(gv) = NULL;
 264    break;
 265   default:
 266    gv = (GV *) save_scalar(gv);
 267 maybe_deref:
 268    if (deref)
 269     val = SvRV(val);
 270    break;
 271  }
 272
 273  SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
 274                                      ud, PL_savestack_ix,
 275                                          PL_scopestack[PL_scopestack_ix]));
 276
 277 assign:
 278  SvSetMagicSV((SV *) gv, val);
 279
 280  SvREFCNT_dec(ud->elem);
 281  SvREFCNT_dec(ud->val);
 282  SvREFCNT_dec(ud->sv);
 283  SU_UD_FREE(ud);
 284 }
 285
 286 #if SU_DEBUG
 287 # ifdef DEBUGGING
 288 #  define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
 289 # else
 290 #  define SU_CXNAME "XXX"
 291 # endif
 292 #endif
 293
 294 STATIC void su_pop(pTHX_ void *ud) {
 295 #define su_pop(U) su_pop(aTHX_ (U))
 296  I32 depth, base, mark, *origin;
 297  depth = SU_UD_DEPTH(ud);
 298
 299  SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
 300                                      ud, SU_CXNAME,
 301                                          PL_scopestack_ix, PL_savestack_ix,
 302                                          PL_scopestack[PL_scopestack_ix],
 303                                          depth));
 304
 305  origin = SU_UD_ORIGIN(ud);
 306  mark   = origin[depth];
 307  base   = origin[depth - 1];
 308
 309  SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
 310                                      ud, mark, base));
 311
 312  if (base < mark) {
 313   PL_savestack_ix = mark;
 314   leave_scope(base);
 315  }
 316  PL_savestack_ix = base;
 317  if (--depth > 0) {
 318   SU_UD_DEPTH(ud) = depth;
 319   SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
 320                                       ud, PL_savestack_ix, depth));
 321   SAVEDESTRUCTOR_X(su_pop, ud);
 322   SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
 323                                       ud, PL_savestack_ix, depth));
 324  } else {
 325   SU_UD_HANDLER(ud)(aTHX_ ud);
 326  }
 327 }
 328
 329 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
 330 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
 331  I32 i, depth = 0, *origin;
 332  I32 cur, last, step;
 333
 334  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
 335
 336  for (i = 0; i < level; ++i) {
 337   PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
 338   switch (CxTYPE(cx)) {
 339 #if SU_HAS_PERL(5, 11, 0)
 340    case CXt_LOOP_FOR:
 341    case CXt_LOOP_PLAIN:
 342    case CXt_LOOP_LAZYSV:
 343    case CXt_LOOP_LAZYIV:
 344 #else
 345    case CXt_LOOP:
 346 #endif
 347     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
 348     depth += 2;
 349     break;
 350    default:
 351     SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
 352     depth++;
 353     break;
 354   }
 355  }
 356  SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
 357
 358  Newx(origin, depth + 1, I32);
 359  origin[0] = PL_scopestack[PL_scopestack_ix - depth];
 360  PL_scopestack[PL_scopestack_ix - depth] += size;
 361  for (i = depth - 1; i >= 1; --i) {
 362   I32 j = PL_scopestack_ix - i;
 363   origin[depth - i] = PL_scopestack[j];
 364   PL_scopestack[j] += 3;
 365  }
 366  origin[depth] = PL_savestack_ix;
 367
 368  SU_D({
 369   PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 370                 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
 371   for (i = depth - 1; i >= 0; --i) {
 372    I32 x = PL_scopestack_ix  - depth + i;
 373    PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
 374                                   i, depth - i, x, PL_scopestack[x], origin[i]);
 375   }
 376  });
 377
 378  SU_UD_ORIGIN(ud) = origin;
 379  SU_UD_DEPTH(ud)  = depth;
 380  return depth;
 381 }
 382
 383 #define SU_GET_LEVEL(A)  \
 384  if (items > A) {        \
 385   SV *lsv = ST(A);       \
 386   if (SvOK(lsv))         \
 387    level = SvUV(lsv);    \
 388   if (level < 0)         \
 389    XSRETURN(0);          \
 390  }                       \
 391  if (level > cxstack_ix) \
 392   level = cxstack_ix;
 393
 394 /* --- XS ------------------------------------------------------------------ */
 395
 396 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 397
 398 PROTOTYPES: ENABLE
 399
 400 SV *
 401 TOPLEVEL()
 402 PROTOTYPE:
 403 CODE:
 404  RETVAL = newSViv(cxstack_ix);
 405 OUTPUT:
 406  RETVAL
 407
 408 void
 409 reap(SV *hook, ...)
 410 PROTOTYPE: &;$
 411 PREINIT:
 412  I32 level = 0;
 413  su_ud_reap *ud;
 414 CODE:
 415  SU_GET_LEVEL(1);
 416  Newx(ud, 1, su_ud_reap);
 417  SU_UD_ORIGIN(ud)  = NULL;
 418  SU_UD_HANDLER(ud) = su_reap;
 419  ud->cb = newSVsv(hook);
 420  LEAVE;
 421  if (level) {
 422   I32 depth = su_init(level, ud, 3);
 423   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 424                                       ud, PL_savestack_ix, depth));
 425   SAVEDESTRUCTOR_X(su_pop, ud);
 426  } else
 427   su_reap(ud);
 428  ENTER;
 429
 430 void
 431 localize(SV *sv, SV *val, ...)
 432 PROTOTYPE: $$;$
 433 PREINIT:
 434  I32 level = 0;
 435  su_ud_localize *ud;
 436 CODE:
 437  SU_GET_LEVEL(2);
 438  Newx(ud, 1, su_ud_localize);
 439  SU_UD_ORIGIN(ud)  = NULL;
 440  SU_UD_HANDLER(ud) = su_localize;
 441  SvREFCNT_inc(sv);
 442  ud->sv   = sv;
 443  ud->val  = newSVsv(val);
 444  ud->elem = NULL;
 445  LEAVE;
 446  if (level) {
 447   I32 depth = su_init(level, ud, 3);
 448   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 449                                       ud, PL_savestack_ix, depth));
 450   SAVEDESTRUCTOR_X(su_pop, ud);
 451  } else
 452   su_localize(ud);
 453  ENTER;
 454
 455 void
 456 localize_elem(SV *sv, SV *elem, SV *val, ...)
 457 PROTOTYPE: $$$;$
 458 PREINIT:
 459  I32 level = 0;
 460  su_ud_localize *ud;
 461 CODE:
 462  SU_GET_LEVEL(3);
 463  Newx(ud, 1, su_ud_localize);
 464  SU_UD_ORIGIN(ud)  = NULL;
 465  SU_UD_HANDLER(ud) = su_localize;
 466  SvREFCNT_inc(sv);
 467  ud->sv   = sv;
 468  ud->val  = newSVsv(val);
 469  SvREFCNT_inc(elem);
 470  ud->elem = elem;
 471  LEAVE;
 472  if (level) {
 473   I32 depth = su_init(level, ud, 4);
 474   SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
 475                                       ud, PL_savestack_ix, depth));
 476   SAVEDESTRUCTOR_X(su_pop, ud);
 477  } else
 478   su_localize(ud);
 479  ENTER;
 480