1 /* This file is part of the Scope::Upper Perl module.
2 * See http://search.cpan.org/dist/Scope-Upper/ */
4 #define PERL_NO_GET_CONTEXT
9 #define __PACKAGE__ "Scope::Upper"
15 /* --- Compatibility ------------------------------------------------------- */
17 #ifndef PERL_UNUSED_VAR
18 # define PERL_UNUSED_VAR(V)
22 # define STMT_START do
26 # define STMT_END while (0)
30 # define SU_D(X) STMT_START X STMT_END
36 # define Newx(v, n, c) New(0, v, n, c)
40 # define SvPV_const(S, L) SvPV(S, L)
43 #ifndef SvPV_nolen_const
44 # define SvPV_nolen_const(S) SvPV_nolen(S)
48 # define HvNAME_get(H) HvNAME(H)
51 #ifndef gv_fetchpvn_flags
52 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
55 #ifndef PERL_MAGIC_tied
56 # define PERL_MAGIC_tied 'P'
59 #ifndef PERL_MAGIC_env
60 # define PERL_MAGIC_env 'E'
63 #ifndef NEGATIVE_INDICES_VAR
64 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
67 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
69 /* --- Threads and multiplicity -------------------------------------------- */
79 #ifndef SU_MULTIPLICITY
80 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
81 # define SU_MULTIPLICITY 1
83 # define SU_MULTIPLICITY 0
86 #if SU_MULTIPLICITY && !defined(tTHX)
87 # define tTHX PerlInterpreter*
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
93 # define MY_CXT_CLONE \
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))
100 # define SU_THREADSAFE 0
102 # define dMY_CXT dNOOP
104 # define MY_CXT su_globaldata
106 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
108 # define MY_CXT_INIT NOOP
110 # define MY_CXT_CLONE NOOP
113 /* --- Stack manipulations ------------------------------------------------- */
115 #ifndef SvCANEXISTDELETE
116 # define SvCANEXISTDELETE(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) \
126 /* ... Saving array elements ............................................... */
128 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
129 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
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);
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)))
149 idx = key + av_len(av) + 1;
163 STATIC void su_adelete(pTHX_ void *ud_) {
164 su_ud_adelete *ud = (su_ud_adelete *) ud_;
166 av_delete(ud->av, ud->idx, G_DISCARD);
167 SvREFCNT_dec(ud->av);
172 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
173 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
176 Newx(ud, 1, su_ud_adelete);
181 SAVEDESTRUCTOR_X(su_adelete, ud);
184 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
186 #endif /* SAVEADELETE */
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))
196 idx = su_av_key2idx(av, SvIV(key));
198 if (SvCANEXISTDELETE(av))
199 preeminent = av_exists(av, idx);
201 svp = av_fetch(av, idx, 1);
202 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
205 save_aelem(av, idx, svp);
207 SAVEADELETE(av, idx);
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);
216 /* ... Saving hash elements ................................................ */
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))
226 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
227 preeminent = hv_exists_ent(hv, keysv, 0);
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));
233 if (HvNAME_get(hv) && isGV(*svp)) {
234 save_gp((GV *) *svp, 0);
239 save_helem(hv, keysv, svp);
242 const char * const key = SvPV_const(keysv, keylen);
243 SAVEDELETE(hv, savepvn(key, keylen),
244 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
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));
254 /* --- Actions ------------------------------------------------------------- */
259 void (*handler)(pTHX_ void *);
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)
266 #define SU_UD_FREE(U) STMT_START { \
267 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
271 /* ... Reap ................................................................ */
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;
286 SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
287 ud, PL_scopestack_ix, PL_savestack_ix));
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. */
297 #if SU_HAS_PERL(5, 10, 0)
299 if (cxstack_ix < cxstack_max)
302 cxstack_ix = Perl_cxinc(aTHX);
306 call_sv(ud->cb, G_VOID);
308 #if SU_HAS_PERL(5, 10, 0)
309 if (dieing && cxstack_ix > 0)
319 SvREFCNT_dec(ud->cb);
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",
330 PL_scopestack[PL_scopestack_ix]));
333 /* ... Localize & localize array/hash element .............................. */
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_;
352 if (SvTYPE(sv) >= SVt_PVGV) {
354 if (!val) { /* local *x; */
356 } else if (!SvROK(val)) { /* local *x = $val; */
358 } else { /* local *x = \$val; */
359 t = SvTYPE(SvRV(val));
364 const char *p = SvPV_const(sv, len), *s;
365 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
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;
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));
388 gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
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);
399 /* Inspired from Alias.pm */
403 su_save_aelem(GvAV(gv), elem, val);
410 su_save_helem(GvHV(gv), elem, val);
416 save_gp(gv, 1); /* hide previous entry in symtab */
423 gv = (GV *) save_scalar(gv);
424 if (deref) /* val != NULL */
429 SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
431 PL_scopestack[PL_scopestack_ix]));
435 SvSetMagicSV((SV *) gv, val);
438 SvREFCNT_dec(ud->elem);
439 SvREFCNT_dec(ud->val);
440 SvREFCNT_dec(ud->sv);
444 /* --- Pop a context back -------------------------------------------------- */
448 # define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
450 # define SU_CXNAME "XXX"
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);
459 SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
461 PL_scopestack_ix, PL_savestack_ix,
462 PL_scopestack[PL_scopestack_ix],
465 origin = SU_UD_ORIGIN(ud);
466 mark = origin[depth];
467 base = origin[depth - 1];
469 SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
473 PL_savestack_ix = mark;
476 PL_savestack_ix = base;
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));
485 SU_UD_HANDLER(ud)(aTHX_ ud);
489 /* --- Initialize the stack and the action userdata ------------------------ */
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;
497 if (cxix >= cxstack_ix) {
498 SU_UD_HANDLER(ud)(aTHX_ ud);
502 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
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)
510 case CXt_LOOP_LAZYSV:
511 case CXt_LOOP_LAZYIV:
515 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
519 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
524 SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
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;
534 origin[depth] = PL_savestack_ix;
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]);
546 SU_UD_ORIGIN(ud) = origin;
547 SU_UD_DEPTH(ud) = depth;
549 SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
550 ud, PL_savestack_ix, depth));
552 SAVEDESTRUCTOR_X(su_pop, ud);
560 /* --- Global data --------------------------------------------------------- */
562 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
573 /* --- Unwind stack -------------------------------------------------------- */
575 STATIC void su_unwind(pTHX_ void *ud_) {
577 I32 cxix = MY_CXT.cxix;
578 I32 items = MY_CXT.items - 1;
579 SV **savesp = MY_CXT.savesp;
582 PERL_UNUSED_VAR(ud_);
585 PL_stack_sp = savesp;
587 if (cxstack_ix > cxix)
594 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
595 *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
599 PerlIO_printf(Perl_debug_log,
600 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
602 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
603 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
606 PL_op = PL_ppaddr[OP_RETURN](aTHX);
607 *PL_markstack_ptr = mark;
609 MY_CXT.fakeop.op_next = PL_op;
610 PL_op = &(MY_CXT.fakeop);
613 /* --- XS ------------------------------------------------------------------ */
615 #if SU_HAS_PERL(5, 8, 9)
616 # define SU_SKIP_DB_MAX 2
618 # define SU_SKIP_DB_MAX 3
621 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
622 * followed by a DB sub */
624 #define SU_SKIP_DB(C) \
627 PERL_CONTEXT *cx = cxstack + (C); \
629 if (CxTYPE(cx) == CXt_BLOCK && (C) >= i) { \
631 if (CxTYPE(cx) == CXt_SUB && cx->blk_sub.cv == GvCV(PL_DBsub)) { \
637 } while (++i <= SU_SKIP_DB_MAX); \
640 #define SU_GET_CONTEXT(A, B) \
649 else if (cxix > cxstack_ix) \
659 #define SU_GET_LEVEL(A, B) \
672 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
674 XS(XS_Scope__Upper_unwind) {
683 PERL_UNUSED_VAR(cv); /* -W */
684 PERL_UNUSED_VAR(ax); /* -Wall */
686 SU_GET_CONTEXT(0, items - 1);
688 PERL_CONTEXT *cx = cxstack + cxix;
689 switch (CxTYPE(cx)) {
691 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
696 MY_CXT.items = items;
697 /* pp_entersub will want to sanitize the stack after returning from there
698 * Screw that, we're insane */
699 if (GIMME_V == G_SCALAR) {
700 MY_CXT.savesp = PL_stack_sp;
701 /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
702 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
704 MY_CXT.savesp = NULL;
706 SAVEDESTRUCTOR_X(su_unwind, NULL);
711 } while (--cxix >= 0);
712 croak("Can't return outside a subroutine");
715 MODULE = Scope::Upper PACKAGE = Scope::Upper
723 stash = gv_stashpv(__PACKAGE__, 1);
724 newCONSTSUB(stash, "TOP", newSViv(0));
725 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
734 PERL_UNUSED_VAR(items);
737 #endif /* SU_THREADSAFE */
743 I32 cxix = cxstack_ix;
747 RETVAL = newSViv(cxix);
757 SU_GET_CONTEXT(0, 0);
762 RETVAL = newSViv(cxix);
772 SU_GET_CONTEXT(0, 0);
773 for (; cxix >= 0; --cxix) {
774 PERL_CONTEXT *cx = cxstack + cxix;
775 switch (CxTYPE(cx)) {
779 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
781 ST(0) = sv_2mortal(newSViv(cxix));
793 SU_GET_CONTEXT(0, 0);
794 for (; cxix >= 0; --cxix) {
795 PERL_CONTEXT *cx = cxstack + cxix;
796 switch (CxTYPE(cx)) {
800 ST(0) = sv_2mortal(newSViv(cxix));
827 ST(0) = sv_2mortal(newSViv(cxix));
837 for (cxix = cxstack_ix; cxix > 0; --cxix) {
838 PERL_CONTEXT *cx = cxstack + cxix;
839 switch (CxTYPE(cx)) {
841 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
851 ST(0) = sv_2mortal(newSViv(cxix));
860 SU_GET_CONTEXT(0, 0);
862 PERL_CONTEXT *cx = cxstack + cxix--;
863 switch (CxTYPE(cx)) {
867 I32 gimme = cx->blk_gimme;
869 case G_VOID: XSRETURN_UNDEF; break;
870 case G_SCALAR: XSRETURN_NO; break;
871 case G_ARRAY: XSRETURN_YES; break;
886 SU_GET_CONTEXT(1, 1);
887 Newx(ud, 1, su_ud_reap);
888 SU_UD_ORIGIN(ud) = NULL;
889 SU_UD_HANDLER(ud) = su_reap;
890 ud->cb = newSVsv(hook);
891 su_init(cxix, ud, 3);
894 localize(SV *sv, SV *val, ...)
900 SU_GET_CONTEXT(2, 2);
901 Newx(ud, 1, su_ud_localize);
902 SU_UD_ORIGIN(ud) = NULL;
903 SU_UD_HANDLER(ud) = su_localize;
906 ud->val = newSVsv(val);
908 su_init(cxix, ud, 3);
911 localize_elem(SV *sv, SV *elem, SV *val, ...)
917 SU_GET_CONTEXT(3, 3);
918 Newx(ud, 1, su_ud_localize);
919 SU_UD_ORIGIN(ud) = NULL;
920 SU_UD_HANDLER(ud) = su_localize;
923 ud->val = newSVsv(val);
926 su_init(cxix, ud, 4);
929 localize_delete(SV *sv, SV *elem, ...)
935 SU_GET_CONTEXT(2, 2);
936 Newx(ud, 1, su_ud_localize);
937 SU_UD_ORIGIN(ud) = NULL;
938 SU_UD_HANDLER(ud) = su_localize;
944 su_init(cxix, ud, 4);