]> git.vpit.fr Git - perl/modules/Scope-Upper.git/blobdiff - Upper.xs
Introduce want_at()
[perl/modules/Scope-Upper.git] / Upper.xs
index 799a2f38b63ba48f3efc2ec7b105c3f7034f466c..6a0b35e77bfb733c038838f378c8001b7e7c88eb 100644 (file)
--- a/Upper.xs
+++ b/Upper.xs
@@ -6,12 +6,18 @@
 #include "perl.h" 
 #include "XSUB.h"
 
+#define __PACKAGE__ "Scope::Upper"
+
 #ifndef SU_DEBUG
 # define SU_DEBUG 0
 #endif
 
 /* --- Compatibility ------------------------------------------------------- */
 
+#ifndef PERL_UNUSED_VAR
+# define PERL_UNUSED_VAR(V)
+#endif
+
 #ifndef STMT_START
 # define STMT_START do
 #endif
 # define PERL_MAGIC_env 'E'
 #endif
 
+#ifndef NEGATIVE_INDICES_VAR
+# define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
+#endif
+
 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
 
 /* --- Stack manipulations ------------------------------------------------- */
 
 /* ... Saving array elements ............................................... */
 
-STATIC I32 su_av_preeminent(pTHX_ AV *av, I32 key) {
-#define su_av_preeminent(A, K) su_av_preeminent(aTHX_ (A), (K))
- MAGIC *mg;
- HV *stash;
+STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
+#define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
+ I32 idx;
+
+ if (key >= 0)
+  return key;
+
+/* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
+#if SU_HAS_PERL(5, 8, 1)
+ if (SvRMAGICAL(av)) {
+  const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
+  if (tied_magic) {
+   int adjust_index = 1;
+   SV * const * const negative_indices_glob =
+                    hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
+                             NEGATIVE_INDICES_VAR, 16, 0);
+   if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
+    return key;
+  }
+ }
+#endif
 
- if (!av)
-  return 0;
- if (SvCANEXISTDELETE(av))
-  return av_exists(av, key);
+ idx = key + av_len(av) + 1;
+ if (idx < 0)
+  return key;
 
- return 1;
+ return idx;
 }
 
 #ifndef SAVEADELETE
 
 typedef struct {
  AV *av;
- I32 key;
+ I32 idx;
 } su_ud_adelete;
 
 STATIC void su_adelete(pTHX_ void *ud_) {
- su_ud_adelete *ud = ud_;
+ su_ud_adelete *ud = (su_ud_adelete *) ud_;
 
- av_delete(ud->av, ud->key, G_DISCARD);
+ av_delete(ud->av, ud->idx, G_DISCARD);
  SvREFCNT_dec(ud->av);
 
  Safefree(ud);
 }
 
-STATIC void su_save_adelete(pTHX_ AV *av, I32 key) {
+STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
  su_ud_adelete *ud;
 
  Newx(ud, 1, su_ud_adelete);
  ud->av  = av;
- ud->key = key;
+ ud->idx = idx;
  SvREFCNT_inc(av);
 
  SAVEDESTRUCTOR_X(su_adelete, ud);
@@ -116,42 +142,69 @@ STATIC void su_save_adelete(pTHX_ AV *av, I32 key) {
 
 #endif /* SAVEADELETE */
 
-STATIC void su_save_aelem(pTHX_ AV *av, I32 key, SV **svp, I32 preeminent) {
-#define su_save_aelem(A, K, S, P) su_save_aelem(aTHX_ (A), (K), (S), (P))
+STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
+#define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
+ I32 idx;
+ I32 preeminent = 1;
+ SV **svp;
+ HV *stash;
+ MAGIC *mg;
+
+ idx = su_av_key2idx(av, SvIV(key));
+
+ if (SvCANEXISTDELETE(av))
+  preeminent = av_exists(av, idx);
+
+ svp = av_fetch(av, idx, 1);
+ if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
+
  if (preeminent)
-  save_aelem(av, key, svp);
+  save_aelem(av, idx, svp);
  else
-  SAVEADELETE(av, key);
+  SAVEADELETE(av, idx);
+
+ if (val) { /* local $x[$idx] = $val; */
+  SvSetMagicSV(*svp, val);
+ } else {   /* local $x[$idx]; delete $x[$idx]; */
+  av_delete(av, idx, G_DISCARD);
+ }
 }
 
 /* ... Saving hash elements ................................................ */
 
-STATIC I32 su_hv_preeminent(pTHX_ HV *hv, SV *keysv) {
-#define su_hv_preeminent(H, K) su_hv_preeminent(aTHX_ (H), (K))
- MAGIC *mg;
+STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
+#define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
+ I32 preeminent = 1;
+ HE *he;
+ SV **svp;
  HV *stash;
+ MAGIC *mg;
 
- if (!hv)
-  return 0;
  if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
-  return hv_exists_ent(hv, keysv, 0);
+  preeminent = hv_exists_ent(hv, keysv, 0);
 
- return 1;
-}
+ he  = hv_fetch_ent(hv, keysv, 1, 0);
+ svp = he ? &HeVAL(he) : NULL;
+ if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
 
-STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV **svp, I32 preeminent) {
-#define su_save_helem(H, K, S, P) su_save_helem(aTHX_ (H), (K), (S), (P))
  if (HvNAME_get(hv) && isGV(*svp)) {
   save_gp((GV *) *svp, 0);
   return;
  }
- if (!preeminent) {
+
+ if (preeminent)
+  save_helem(hv, keysv, svp);
+ else {
   STRLEN keylen;
   const char * const key = SvPV_const(keysv, keylen);
   SAVEDELETE(hv, savepvn(key, keylen),
                  SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
- } else {
-  save_helem(hv, keysv, svp);
+ }
+
+ if (val) { /* local $x{$keysv} = $val; */
+  SvSetMagicSV(*svp, val);
+ } else {   /* local $x{$keysv}; delete $x{$keysv}; */
+  hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
  }
 }
 
@@ -167,10 +220,10 @@ typedef struct {
 #define SU_UD_ORIGIN(U)  (((su_ud_common *) (U))->origin)
 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
 
-#define SU_UD_FREE(U) do { \
+#define SU_UD_FREE(U) STMT_START { \
  if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
  Safefree(U); \
-} while (0)
+} STMT_END
 
 /* ... Reap ................................................................ */
 
@@ -254,10 +307,14 @@ STATIC void su_localize(pTHX_ void *ud_) {
 
  if (SvTYPE(sv) >= SVt_PVGV) {
   gv = (GV *) sv;
-  if (!SvROK(val))
+  if (!val) {               /* local *x; */
+   t = SVt_PVGV;
+  } else if (!SvROK(val)) { /* local *x = $val; */
    goto assign;
-  t = SvTYPE(SvRV(val));
-  deref = 1;
+  } else {                  /* local *x = \$val; */
+   t = SvTYPE(SvRV(val));
+   deref = 1;
+  }
  } else {
   STRLEN len, l;
   const char *p = SvPV_const(sv, len), *s;
@@ -273,16 +330,16 @@ STATIC void su_localize(pTHX_ void *ud_) {
    case '&': t = SVt_PVCV; break;
    case '*': t = SVt_PVGV; break;
   }
-  if (t == SVt_NULL) {
+  if (t != SVt_NULL) {
+   ++s;
+   --l;
+  } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
    if (SvROK(val) && !sv_isobject(val)) {
     t = SvTYPE(SvRV(val));
     deref = 1;
    } else {
     t = SvTYPE(val);
    }
-  } else {
-   ++s;
-   --l;
   }
   gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
  }
@@ -299,27 +356,15 @@ STATIC void su_localize(pTHX_ void *ud_) {
  switch (t) {
   case SVt_PVAV:
    if (elem) {
-    I32 idx  = SvIV(elem);
-    AV *av   = GvAV(gv);
-    I32 preeminent = su_av_preeminent(av, idx);
-    SV **svp = av_fetch(av, idx, 1);
-    if (!*svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
-    su_save_aelem(av, idx, svp, preeminent);
-    gv = (GV *) *svp;
-    goto maybe_deref;
+    su_save_aelem(GvAV(gv), elem, val);
+    goto done;
    } else
     save_ary(gv);
    break;
   case SVt_PVHV:
    if (elem) {
-    HV *hv   = GvHV(gv);
-    I32 preeminent = su_hv_preeminent(hv, elem);
-    HE *he   = hv_fetch_ent(hv, elem, 1, 0);
-    SV **svp = he ? &HeVAL(he) : NULL;
-    if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
-    su_save_helem(hv, elem, svp, preeminent);
-    gv = (GV *) *svp;
-    goto maybe_deref;
+    su_save_helem(GvHV(gv), elem, val);
+    goto done;
    } else
     save_hash(gv);
    break;
@@ -333,7 +378,7 @@ STATIC void su_localize(pTHX_ void *ud_) {
   default:
    gv = (GV *) save_scalar(gv);
 maybe_deref:
-   if (deref)
+   if (deref) /* val != NULL */
     val = SvRV(val);
    break;
  }
@@ -343,8 +388,10 @@ maybe_deref:
                                          PL_scopestack[PL_scopestack_ix]));
 
 assign:
- SvSetMagicSV((SV *) gv, val);
+ if (val)
+  SvSetMagicSV((SV *) gv, val);
 
+done:
  SvREFCNT_dec(ud->elem);
  SvREFCNT_dec(ud->val);
  SvREFCNT_dec(ud->sv);
@@ -403,6 +450,13 @@ STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
  I32 i, depth = 0, *origin;
  I32 cur, last, step;
 
+ LEAVE;
+
+ if (level <= 0) {
+  SU_UD_HANDLER(ud)(aTHX_ ud);
+  goto done;
+ }
+
  SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
 
  for (i = 0; i < level; ++i) {
@@ -449,34 +503,266 @@ STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
 
  SU_UD_ORIGIN(ud) = origin;
  SU_UD_DEPTH(ud)  = depth;
+
+ SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
+                                     ud, PL_savestack_ix, depth));
+
+ SAVEDESTRUCTOR_X(su_pop, ud);
+
+done:
+ ENTER;
+
  return depth;
 }
 
+/* --- Unwind stack -------------------------------------------------------- */
+
+typedef struct {
+ I32 cxix;
+ I32 items;
+} su_ud_unwind;
+
+STATIC void su_unwind(pTHX_ void *ud_) {
+ su_ud_unwind *ud = (su_ud_unwind *) ud_;
+ OP fakeop;
+ I32 cxix  = ud->cxix;
+ I32 items = ud->items - 1;
+ I32 gimme, mark;
+
+ if (cxstack_ix > cxix)
+  dounwind(cxix);
+
+ /* Hide the level */
+ if (items >= 0)
+  PL_stack_sp--;
+
+ mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
+
+ gimme = GIMME_V;
+ if (gimme == G_SCALAR) {
+  *PL_markstack_ptr = PL_stack_sp - PL_stack_base;
+  PL_stack_sp += items;
+ } else {
+  *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
+ }
+
+ SU_D({
+  PerlIO_printf(Perl_debug_log,
+                "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
+                ud, cxix,
+                gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
+                items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
+ });
+
+ PL_op = PL_ppaddr[OP_RETURN](aTHX);
+ *PL_markstack_ptr = mark;
+
+ fakeop.op_next = PL_op;
+ PL_op = &fakeop;
+
+ Safefree(ud);
+}
+
+/* --- XS ------------------------------------------------------------------ */
+
 #define SU_GET_LEVEL(A)  \
  if (items > A) {        \
   SV *lsv = ST(A);       \
   if (SvOK(lsv))         \
-   level = SvUV(lsv);    \
+   level = SvIV(lsv);    \
   if (level < 0)         \
    XSRETURN(0);          \
  }                       \
  if (level > cxstack_ix) \
   level = cxstack_ix;
 
-/* --- XS ------------------------------------------------------------------ */
+#define SU_DOPOPTOCX(t)                    \
+ STMT_START {                              \
+  I32 i, cxix = cxstack_ix, level = 0;     \
+  if (items) {                             \
+   SV *lsv = ST(0);                        \
+   if (SvOK(lsv))                          \
+    level = SvIV(lsv);                     \
+   if (level < 0)                          \
+    level = 0;                             \
+   else if (level > cxix)                  \
+    level = cxix;                          \
+  }                                        \
+  for (i = cxix - level; i >= 0; --i) {    \
+   if (CxTYPE(&cxstack[i]) == t) {         \
+    ST(0) = sv_2mortal(newSViv(cxix - i)); \
+    XSRETURN(1);                           \
+   }                                       \
+  }                                        \
+  XSRETURN_UNDEF;                          \
+ } STMT_END
+
+XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
+
+XS(XS_Scope__Upper_unwind) {
+#ifdef dVAR
+ dVAR; dXSARGS;
+#else
+ dXSARGS;
+#endif
+ I32 level = 0, cxix = cxstack_ix;
+ su_ud_unwind *ud;
+ PERL_UNUSED_VAR(cv); /* -W */
+ PERL_UNUSED_VAR(ax); /* -Wall */
+ if (items) {
+  SV *lsv = ST(items - 1);
+  if (SvOK(lsv))
+   level = SvIV(lsv);
+  if (level < 0)
+   level = 0;
+  else if (level > cxix)
+   level = cxix;
+ }
+ cxix -= level;
+ do {
+  PERL_CONTEXT *cx = cxstack + cxix;
+  switch (CxTYPE(cx)) {
+   case CXt_SUB:
+   case CXt_EVAL:
+   case CXt_FORMAT:
+    /* pp_entersub will try to sanitize the stack - screw that, we're insane */
+    if (GIMME_V == G_SCALAR)
+     PL_stack_sp = PL_stack_base + TOPMARK + 1;
+    Newx(ud, 1, su_ud_unwind);
+    ud->cxix  = cxix;
+    ud->items = items;
+    SAVEDESTRUCTOR_X(su_unwind, ud);
+    return;
+   default:
+    break;
+  }
+ } while (--cxix >= 0);
+ croak("Can't return outside a subroutine");
+}
 
 MODULE = Scope::Upper            PACKAGE = Scope::Upper
 
 PROTOTYPES: ENABLE
 
+BOOT:
+{
+ HV *stash = gv_stashpv(__PACKAGE__, 1);
+ newCONSTSUB(stash, "HERE", newSViv(0));
+ newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
+}
+
 SV *
-TOPLEVEL()
+TOP()
 PROTOTYPE:
 CODE:
  RETVAL = newSViv(cxstack_ix);
 OUTPUT:
  RETVAL
 
+SV *
+UP(...)
+PROTOTYPE: ;$
+PREINIT:
+ I32 i = 0;
+ I32 cxix = cxstack_ix;
+CODE:
+ if (items)
+  i = SvIV(ST(0));
+ if (++i > cxix)
+  i = cxix;
+ RETVAL = newSViv(i);
+OUTPUT:
+ RETVAL
+
+SV *
+DOWN(...)
+PROTOTYPE: ;$
+PREINIT:
+ I32 i = 0;
+CODE:
+ if (items)
+  i = SvIV(ST(0));
+ if (--i < 0)
+  i = 0;
+ RETVAL = newSViv(i);
+OUTPUT:
+ RETVAL
+
+void
+SUB(...)
+PROTOTYPE: ;$
+PPCODE:
+ SU_DOPOPTOCX(CXt_SUB);
+
+void
+EVAL(...)
+PROTOTYPE: ;$
+PPCODE:
+ SU_DOPOPTOCX(CXt_EVAL);
+
+void
+CALLER(...)
+PROTOTYPE: ;$
+PREINIT:
+ I32 cxix = cxstack_ix, caller = 0, level = 0;
+PPCODE:
+ if (items) {
+  SV *csv = ST(0);
+  if (SvOK(csv))
+   caller = SvIV(csv);
+ }
+ cxix = cxstack_ix;
+ while (cxix > 0) {
+  PERL_CONTEXT *cx = cxstack + cxix--;
+  switch (CxTYPE(cx)) {
+   case CXt_SUB:
+   case CXt_EVAL:
+   case CXt_FORMAT:
+    --caller;
+    if (caller < 0)
+     goto done;
+    break;
+  }
+  ++level;
+ }
+done:
+ ST(0) = sv_2mortal(newSViv(level));
+ XSRETURN(1);
+
+void
+want_at(...)
+PROTOTYPE: ;$
+PREINIT:
+ I32 cxix = cxstack_ix, level = 0;
+PPCODE:
+ if (items) {
+  SV *lsv = ST(0);
+  if (SvOK(lsv))
+   level = SvIV(lsv);
+  if (level < 0)
+   level = 0;
+  else if (level > cxix)
+   level = cxix;
+ }
+ cxix -= level;
+ while (cxix > 0) {
+  PERL_CONTEXT *cx = cxstack + cxix--;
+  switch (CxTYPE(cx)) {
+   case CXt_SUB:
+   case CXt_EVAL:
+   case CXt_FORMAT: {
+    I32 gimme = cx->blk_gimme;
+    switch (gimme) {
+     case G_VOID:   XSRETURN_UNDEF; break;
+     case G_SCALAR: XSRETURN_NO;    break;
+     case G_ARRAY:  XSRETURN_YES;   break;
+    }
+    break;
+   }
+  }
+ }
+ XSRETURN_UNDEF;
+
 void
 reap(SV *hook, ...)
 PROTOTYPE: &;$
@@ -489,15 +775,7 @@ CODE:
  SU_UD_ORIGIN(ud)  = NULL;
  SU_UD_HANDLER(ud) = su_reap;
  ud->cb = newSVsv(hook);
- LEAVE;
- if (level) {
-  I32 depth = su_init(level, ud, 3);
-  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
-                                      ud, PL_savestack_ix, depth));
-  SAVEDESTRUCTOR_X(su_pop, ud);
- } else
-  su_reap(ud);
- ENTER;
+ su_init(level, ud, 3);
 
 void
 localize(SV *sv, SV *val, ...)
@@ -514,15 +792,7 @@ CODE:
  ud->sv   = sv;
  ud->val  = newSVsv(val);
  ud->elem = NULL;
- LEAVE;
- if (level) {
-  I32 depth = su_init(level, ud, 3);
-  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
-                                      ud, PL_savestack_ix, depth));
-  SAVEDESTRUCTOR_X(su_pop, ud);
- } else
-  su_localize(ud);
- ENTER;
+ su_init(level, ud, 3);
 
 void
 localize_elem(SV *sv, SV *elem, SV *val, ...)
@@ -540,13 +810,22 @@ CODE:
  ud->val  = newSVsv(val);
  SvREFCNT_inc(elem);
  ud->elem = elem;
- LEAVE;
- if (level) {
-  I32 depth = su_init(level, ud, 4);
-  SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
-                                      ud, PL_savestack_ix, depth));
-  SAVEDESTRUCTOR_X(su_pop, ud);
- } else
-  su_localize(ud);
- ENTER;
+ su_init(level, ud, 4);
 
+void
+localize_delete(SV *sv, SV *elem, ...)
+PROTOTYPE: $$;$
+PREINIT:
+ I32 level = 0;
+ su_ud_localize *ud;
+CODE:
+ SU_GET_LEVEL(2);
+ Newx(ud, 1, su_ud_localize);
+ SU_UD_ORIGIN(ud)  = NULL;
+ SU_UD_HANDLER(ud) = su_localize;
+ SvREFCNT_inc(sv);
+ ud->sv   = sv;
+ ud->val  = NULL;
+ SvREFCNT_inc(elem);
+ ud->elem = elem;
+ su_init(level, ud, 4);