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 int adjust_index = 1;
141 SV * const * const negative_indices_glob =
142 hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
143 NEGATIVE_INDICES_VAR, 16, 0);
144 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
150 idx = key + av_len(av) + 1;
164 STATIC void su_adelete(pTHX_ void *ud_) {
165 su_ud_adelete *ud = (su_ud_adelete *) ud_;
167 av_delete(ud->av, ud->idx, G_DISCARD);
168 SvREFCNT_dec(ud->av);
173 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
174 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
177 Newx(ud, 1, su_ud_adelete);
182 SAVEDESTRUCTOR_X(su_adelete, ud);
185 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
187 #endif /* SAVEADELETE */
189 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
190 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
197 idx = su_av_key2idx(av, SvIV(key));
199 if (SvCANEXISTDELETE(av))
200 preeminent = av_exists(av, idx);
202 svp = av_fetch(av, idx, 1);
203 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
206 save_aelem(av, idx, svp);
208 SAVEADELETE(av, idx);
210 if (val) { /* local $x[$idx] = $val; */
211 SvSetMagicSV(*svp, val);
212 } else { /* local $x[$idx]; delete $x[$idx]; */
213 av_delete(av, idx, G_DISCARD);
217 /* ... Saving hash elements ................................................ */
219 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
220 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
227 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
228 preeminent = hv_exists_ent(hv, keysv, 0);
230 he = hv_fetch_ent(hv, keysv, 1, 0);
231 svp = he ? &HeVAL(he) : NULL;
232 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
234 if (HvNAME_get(hv) && isGV(*svp)) {
235 save_gp((GV *) *svp, 0);
240 save_helem(hv, keysv, svp);
243 const char * const key = SvPV_const(keysv, keylen);
244 SAVEDELETE(hv, savepvn(key, keylen),
245 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
248 if (val) { /* local $x{$keysv} = $val; */
249 SvSetMagicSV(*svp, val);
250 } else { /* local $x{$keysv}; delete $x{$keysv}; */
251 hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
255 /* --- Actions ------------------------------------------------------------- */
260 void (*handler)(pTHX_ void *);
263 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
264 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
265 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
267 #define SU_UD_FREE(U) STMT_START { \
268 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
272 /* ... Reap ................................................................ */
279 STATIC void su_call(pTHX_ void *ud_) {
280 su_ud_reap *ud = (su_ud_reap *) ud_;
281 #if SU_HAS_PERL(5, 10, 0)
282 I32 dieing = PL_op->op_type == OP_DIE;
287 SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
288 ud, PL_scopestack_ix, PL_savestack_ix));
295 /* If cxstack_ix isn't incremented there, the eval context will be overwritten
296 * when the new sub scope will be created in call_sv. */
298 #if SU_HAS_PERL(5, 10, 0)
300 if (cxstack_ix < cxstack_max)
303 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);
425 if (deref) /* val != NULL */
430 SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
432 PL_scopestack[PL_scopestack_ix]));
436 SvSetMagicSV((SV *) gv, val);
439 SvREFCNT_dec(ud->elem);
440 SvREFCNT_dec(ud->val);
441 SvREFCNT_dec(ud->sv);
445 /* --- Pop a context back -------------------------------------------------- */
449 # define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
451 # define SU_CXNAME "XXX"
455 STATIC void su_pop(pTHX_ void *ud) {
456 #define su_pop(U) su_pop(aTHX_ (U))
457 I32 depth, base, mark, *origin;
458 depth = SU_UD_DEPTH(ud);
460 SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
462 PL_scopestack_ix, PL_savestack_ix,
463 PL_scopestack[PL_scopestack_ix],
466 origin = SU_UD_ORIGIN(ud);
467 mark = origin[depth];
468 base = origin[depth - 1];
470 SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
474 PL_savestack_ix = mark;
477 PL_savestack_ix = base;
479 SU_UD_DEPTH(ud) = depth;
480 SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
481 ud, PL_savestack_ix, depth));
482 SAVEDESTRUCTOR_X(su_pop, ud);
483 SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
484 ud, PL_savestack_ix, depth));
486 SU_UD_HANDLER(ud)(aTHX_ ud);
490 /* --- Initialize the stack and the action userdata ------------------------ */
492 STATIC I32 su_init(pTHX_ I32 cxix, void *ud, I32 size) {
493 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
494 I32 i, depth = 0, *origin;
499 if (cxix >= cxstack_ix) {
500 SU_UD_HANDLER(ud)(aTHX_ ud);
504 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
506 for (i = cxstack_ix; i > cxix; --i) {
507 PERL_CONTEXT *cx = cxstack + i;
508 switch (CxTYPE(cx)) {
509 #if SU_HAS_PERL(5, 11, 0)
512 case CXt_LOOP_LAZYSV:
513 case CXt_LOOP_LAZYIV:
517 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
521 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
526 SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
528 Newx(origin, depth + 1, I32);
529 origin[0] = PL_scopestack[PL_scopestack_ix - depth];
530 PL_scopestack[PL_scopestack_ix - depth] += size;
531 for (i = depth - 1; i >= 1; --i) {
532 I32 j = PL_scopestack_ix - i;
533 origin[depth - i] = PL_scopestack[j];
534 PL_scopestack[j] += 3;
536 origin[depth] = PL_savestack_ix;
539 PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
540 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
541 for (i = depth - 1; i >= 0; --i) {
542 I32 x = PL_scopestack_ix - depth + i;
543 PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
544 i, depth - i, x, PL_scopestack[x], origin[i]);
548 SU_UD_ORIGIN(ud) = origin;
549 SU_UD_DEPTH(ud) = depth;
551 SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
552 ud, PL_savestack_ix, depth));
554 SAVEDESTRUCTOR_X(su_pop, ud);
562 /* --- Global data --------------------------------------------------------- */
564 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
575 /* --- Unwind stack -------------------------------------------------------- */
577 STATIC void su_unwind(pTHX_ void *ud_) {
579 I32 cxix = MY_CXT.cxix;
580 I32 items = MY_CXT.items - 1;
581 SV **savesp = MY_CXT.savesp;
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) \
648 else if (cxix > cxstack_ix) \
656 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
658 XS(XS_Scope__Upper_unwind) {
667 PERL_UNUSED_VAR(cv); /* -W */
668 PERL_UNUSED_VAR(ax); /* -Wall */
670 SU_GET_CONTEXT(0, items - 1);
672 PERL_CONTEXT *cx = cxstack + cxix;
673 switch (CxTYPE(cx)) {
675 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
680 MY_CXT.items = items;
681 /* pp_entersub will want to sanitize the stack after returning from there
682 * Screw that, we're insane */
683 if (GIMME_V == G_SCALAR) {
684 MY_CXT.savesp = PL_stack_sp;
685 /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
686 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
688 MY_CXT.savesp = NULL;
690 SAVEDESTRUCTOR_X(su_unwind, NULL);
695 } while (--cxix >= 0);
696 croak("Can't return outside a subroutine");
699 MODULE = Scope::Upper PACKAGE = Scope::Upper
707 stash = gv_stashpv(__PACKAGE__, 1);
708 newCONSTSUB(stash, "TOP", newSViv(0));
709 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
718 #endif /* SU_THREADSAFE */
724 I32 cxix = cxstack_ix;
728 RETVAL = newSViv(cxix);
738 SU_GET_CONTEXT(0, 0);
743 RETVAL = newSViv(cxix);
753 SU_GET_CONTEXT(0, 0);
754 for (; cxix >= 0; --cxix) {
755 PERL_CONTEXT *cx = cxstack + cxix;
756 switch (CxTYPE(cx)) {
760 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
762 ST(0) = sv_2mortal(newSViv(cxix));
774 SU_GET_CONTEXT(0, 0);
775 for (; cxix >= 0; --cxix) {
776 PERL_CONTEXT *cx = cxstack + cxix;
777 switch (CxTYPE(cx)) {
781 ST(0) = sv_2mortal(newSViv(cxix));
791 I32 cxix, caller = 0;
800 for (cxix = cxstack_ix; cxix > 0; --cxix) {
801 PERL_CONTEXT *cx = cxstack + cxix;
802 switch (CxTYPE(cx)) {
804 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
815 ST(0) = sv_2mortal(newSViv(cxix));
824 SU_GET_CONTEXT(0, 0);
826 PERL_CONTEXT *cx = cxstack + cxix--;
827 switch (CxTYPE(cx)) {
831 I32 gimme = cx->blk_gimme;
833 case G_VOID: XSRETURN_UNDEF; break;
834 case G_SCALAR: XSRETURN_NO; break;
835 case G_ARRAY: XSRETURN_YES; break;
850 SU_GET_CONTEXT(1, 1);
851 Newx(ud, 1, su_ud_reap);
852 SU_UD_ORIGIN(ud) = NULL;
853 SU_UD_HANDLER(ud) = su_reap;
854 ud->cb = newSVsv(hook);
855 su_init(cxix, ud, 3);
858 localize(SV *sv, SV *val, ...)
864 SU_GET_CONTEXT(2, 2);
865 Newx(ud, 1, su_ud_localize);
866 SU_UD_ORIGIN(ud) = NULL;
867 SU_UD_HANDLER(ud) = su_localize;
870 ud->val = newSVsv(val);
872 su_init(cxix, ud, 3);
875 localize_elem(SV *sv, SV *elem, SV *val, ...)
881 SU_GET_CONTEXT(3, 3);
882 Newx(ud, 1, su_ud_localize);
883 SU_UD_ORIGIN(ud) = NULL;
884 SU_UD_HANDLER(ud) = su_localize;
887 ud->val = newSVsv(val);
890 su_init(cxix, ud, 4);
893 localize_delete(SV *sv, SV *elem, ...)
899 SU_GET_CONTEXT(2, 2);
900 Newx(ud, 1, su_ud_localize);
901 SU_UD_ORIGIN(ud) = NULL;
902 SU_UD_HANDLER(ud) = su_localize;
908 su_init(cxix, ud, 4);