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 ------------------------------------------------------- */
18 # define STMT_START do
22 # define STMT_END while (0)
26 # define SU_D(X) STMT_START X STMT_END
32 # define Newx(v, n, c) New(0, v, n, c)
36 # define SvPV_const(S, L) SvPV(S, L)
39 #ifndef SvPV_nolen_const
40 # define SvPV_nolen_const(S) SvPV_nolen(S)
44 # define HvNAME_get(H) HvNAME(H)
47 #ifndef gv_fetchpvn_flags
48 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
51 #ifndef PERL_MAGIC_tied
52 # define PERL_MAGIC_tied 'P'
55 #ifndef PERL_MAGIC_env
56 # define PERL_MAGIC_env 'E'
59 #ifndef NEGATIVE_INDICES_VAR
60 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
63 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
65 /* --- Stack manipulations ------------------------------------------------- */
67 #ifndef SvCANEXISTDELETE
68 # define SvCANEXISTDELETE(sv) \
70 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
71 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
72 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
73 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
78 /* ... Saving array elements ............................................... */
80 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
81 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
87 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
88 #if SU_HAS_PERL(5, 8, 1)
90 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
93 SV * const * const negative_indices_glob =
94 hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
95 NEGATIVE_INDICES_VAR, 16, 0);
96 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
102 idx = key + av_len(av) + 1;
116 STATIC void su_adelete(pTHX_ void *ud_) {
117 su_ud_adelete *ud = (su_ud_adelete *) ud_;
119 av_delete(ud->av, ud->idx, G_DISCARD);
120 SvREFCNT_dec(ud->av);
125 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
126 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
129 Newx(ud, 1, su_ud_adelete);
134 SAVEDESTRUCTOR_X(su_adelete, ud);
137 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
139 #endif /* SAVEADELETE */
141 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
142 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
149 idx = su_av_key2idx(av, SvIV(key));
151 if (SvCANEXISTDELETE(av))
152 preeminent = av_exists(av, idx);
154 svp = av_fetch(av, idx, 1);
155 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
158 save_aelem(av, idx, svp);
160 SAVEADELETE(av, idx);
162 if (val) { /* local $x[$idx] = $val; */
163 SvSetMagicSV(*svp, val);
164 } else { /* local $x[$idx]; delete $x[$idx]; */
165 av_delete(av, idx, G_DISCARD);
169 /* ... Saving hash elements ................................................ */
171 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
172 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
179 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
180 preeminent = hv_exists_ent(hv, keysv, 0);
182 he = hv_fetch_ent(hv, keysv, 1, 0);
183 svp = he ? &HeVAL(he) : NULL;
184 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
186 if (HvNAME_get(hv) && isGV(*svp)) {
187 save_gp((GV *) *svp, 0);
192 save_helem(hv, keysv, svp);
195 const char * const key = SvPV_const(keysv, keylen);
196 SAVEDELETE(hv, savepvn(key, keylen),
197 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
200 if (val) { /* local $x{$keysv} = $val; */
201 SvSetMagicSV(*svp, val);
202 } else { /* local $x{$keysv}; delete $x{$keysv}; */
203 hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
207 /* --- Actions ------------------------------------------------------------- */
212 void (*handler)(pTHX_ void *);
215 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
216 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
217 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
219 #define SU_UD_FREE(U) STMT_START { \
220 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
224 /* ... Reap ................................................................ */
231 STATIC void su_call(pTHX_ void *ud_) {
232 su_ud_reap *ud = (su_ud_reap *) ud_;
233 #if SU_HAS_PERL(5, 10, 0)
234 I32 dieing = PL_op->op_type == OP_DIE;
239 SU_D(PerlIO_printf(Perl_debug_log, "%p: @@@ call at %d (save is %d)\n",
240 ud, PL_scopestack_ix, PL_savestack_ix));
247 /* If cxstack_ix isn't incremented there, the eval context will be overwritten
248 * when the new sub scope will be created in call_sv. */
250 #if SU_HAS_PERL(5, 10, 0)
252 if (cxstack_ix < cxstack_max)
255 cxstack_ix = Perl_cxinc(aTHX);
258 call_sv(ud->cb, G_VOID);
260 #if SU_HAS_PERL(5, 10, 0)
261 if (dieing && cxstack_ix > 0)
271 SvREFCNT_dec(ud->cb);
275 STATIC void su_reap(pTHX_ void *ud) {
276 #define su_reap(U) su_reap(aTHX_ (U))
277 SU_D(PerlIO_printf(Perl_debug_log, "%p: === reap at %d (save is %d)\n",
278 ud, PL_scopestack_ix, PL_savestack_ix));
279 SAVEDESTRUCTOR_X(su_call, ud);
280 SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
282 PL_scopestack[PL_scopestack_ix]));
285 /* ... Localize & localize array/hash element .............................. */
294 STATIC void su_localize(pTHX_ void *ud_) {
295 #define su_localize(U) su_localize(aTHX_ (U))
296 su_ud_localize *ud = (su_ud_localize *) ud_;
304 if (SvTYPE(sv) >= SVt_PVGV) {
306 if (!val) { /* local *x; */
308 } else if (!SvROK(val)) { /* local *x = $val; */
310 } else { /* local *x = \$val; */
311 t = SvTYPE(SvRV(val));
316 const char *p = SvPV_const(sv, len), *s;
317 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
323 case '$': t = SVt_PV; break;
324 case '@': t = SVt_PVAV; break;
325 case '%': t = SVt_PVHV; break;
326 case '&': t = SVt_PVCV; break;
327 case '*': t = SVt_PVGV; break;
332 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
333 if (SvROK(val) && !sv_isobject(val)) {
334 t = SvTYPE(SvRV(val));
340 gv = gv_fetchpvn_flags(s, l, GV_ADDMULTI, SVt_PVGV);
344 SV *z = newSV_type(t);
345 PerlIO_printf(Perl_debug_log, "%p: === localize a %s at %d (save is %d)\n",
346 ud, sv_reftype(z, 0),
347 PL_scopestack_ix, PL_savestack_ix);
351 /* Inspired from Alias.pm */
355 su_save_aelem(GvAV(gv), elem, val);
362 su_save_helem(GvHV(gv), elem, val);
368 save_gp(gv, 1); /* hide previous entry in symtab */
375 gv = (GV *) save_scalar(gv);
377 if (deref) /* val != NULL */
382 SU_D(PerlIO_printf(Perl_debug_log, "%p: savestack is now at %d, base at %d\n",
384 PL_scopestack[PL_scopestack_ix]));
388 SvSetMagicSV((SV *) gv, val);
391 SvREFCNT_dec(ud->elem);
392 SvREFCNT_dec(ud->val);
393 SvREFCNT_dec(ud->sv);
397 /* --- Pop a context back -------------------------------------------------- */
401 # define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
403 # define SU_CXNAME "XXX"
407 STATIC void su_pop(pTHX_ void *ud) {
408 #define su_pop(U) su_pop(aTHX_ (U))
409 I32 depth, base, mark, *origin;
410 depth = SU_UD_DEPTH(ud);
412 SU_D(PerlIO_printf(Perl_debug_log, "%p: --- pop %s at %d from %d to %d [%d]\n",
414 PL_scopestack_ix, PL_savestack_ix,
415 PL_scopestack[PL_scopestack_ix],
418 origin = SU_UD_ORIGIN(ud);
419 mark = origin[depth];
420 base = origin[depth - 1];
422 SU_D(PerlIO_printf(Perl_debug_log, "%p: clean from %d down to %d\n",
426 PL_savestack_ix = mark;
429 PL_savestack_ix = base;
431 SU_UD_DEPTH(ud) = depth;
432 SU_D(PerlIO_printf(Perl_debug_log, "%p: save new destructor at %d [%d]\n",
433 ud, PL_savestack_ix, depth));
434 SAVEDESTRUCTOR_X(su_pop, ud);
435 SU_D(PerlIO_printf(Perl_debug_log, "%p: pop end at at %d [%d]\n",
436 ud, PL_savestack_ix, depth));
438 SU_UD_HANDLER(ud)(aTHX_ ud);
442 /* --- Initialize the stack and the action userdata ------------------------ */
444 STATIC I32 su_init(pTHX_ I32 level, void *ud, I32 size) {
445 #define su_init(L, U, S) su_init(aTHX_ (L), (U), (S))
446 I32 i, depth = 0, *origin;
452 SU_UD_HANDLER(ud)(aTHX_ ud);
456 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for level %d\n", ud, level));
458 for (i = 0; i < level; ++i) {
459 PERL_CONTEXT *cx = &cxstack[cxstack_ix - i];
460 switch (CxTYPE(cx)) {
461 #if SU_HAS_PERL(5, 11, 0)
464 case CXt_LOOP_LAZYSV:
465 case CXt_LOOP_LAZYIV:
469 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
473 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is normal\n", ud, i));
478 SU_D(PerlIO_printf(Perl_debug_log, "%p: depth is %d\n", ud, depth));
480 Newx(origin, depth + 1, I32);
481 origin[0] = PL_scopestack[PL_scopestack_ix - depth];
482 PL_scopestack[PL_scopestack_ix - depth] += size;
483 for (i = depth - 1; i >= 1; --i) {
484 I32 j = PL_scopestack_ix - i;
485 origin[depth - i] = PL_scopestack[j];
486 PL_scopestack[j] += 3;
488 origin[depth] = PL_savestack_ix;
491 PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
492 depth, 0, PL_scopestack_ix - 1, PL_savestack_ix, origin[depth]);
493 for (i = depth - 1; i >= 0; --i) {
494 I32 x = PL_scopestack_ix - depth + i;
495 PerlIO_printf(Perl_debug_log, "%p: d=%d s=%d x=%d c=%d o=%d\n", ud,
496 i, depth - i, x, PL_scopestack[x], origin[i]);
500 SU_UD_ORIGIN(ud) = origin;
501 SU_UD_DEPTH(ud) = depth;
503 SU_D(PerlIO_printf(Perl_debug_log, "%p: set original destructor at %d [%d]\n",
504 ud, PL_savestack_ix, depth));
506 SAVEDESTRUCTOR_X(su_pop, ud);
514 #define SU_GET_LEVEL(A) \
522 if (level > cxstack_ix) \
525 #define SU_DOPOPTOCX(t) \
527 I32 i, cxix = cxstack_ix, from = 0; \
529 from = SvIV(ST(0)); \
530 for (i = cxix - from; i >= 0; --i) { \
531 if (CxTYPE(&cxstack[i]) == t) { \
532 ST(0) = sv_2mortal(newSViv(cxix - i)); \
539 /* --- XS ------------------------------------------------------------------ */
541 MODULE = Scope::Upper PACKAGE = Scope::Upper
547 HV *stash = gv_stashpv(__PACKAGE__, 1);
548 newCONSTSUB(stash, "HERE", newSViv(0));
555 RETVAL = newSViv(cxstack_ix);
564 I32 cxix = cxstack_ix;
592 SU_DOPOPTOCX(CXt_SUB);
598 SU_DOPOPTOCX(CXt_EVAL);
608 Newx(ud, 1, su_ud_reap);
609 SU_UD_ORIGIN(ud) = NULL;
610 SU_UD_HANDLER(ud) = su_reap;
611 ud->cb = newSVsv(hook);
612 su_init(level, ud, 3);
615 localize(SV *sv, SV *val, ...)
622 Newx(ud, 1, su_ud_localize);
623 SU_UD_ORIGIN(ud) = NULL;
624 SU_UD_HANDLER(ud) = su_localize;
627 ud->val = newSVsv(val);
629 su_init(level, ud, 3);
632 localize_elem(SV *sv, SV *elem, SV *val, ...)
639 Newx(ud, 1, su_ud_localize);
640 SU_UD_ORIGIN(ud) = NULL;
641 SU_UD_HANDLER(ud) = su_localize;
644 ud->val = newSVsv(val);
647 su_init(level, ud, 4);
650 localize_delete(SV *sv, SV *elem, ...)
657 Newx(ud, 1, su_ud_localize);
658 SU_UD_ORIGIN(ud) = NULL;
659 SU_UD_HANDLER(ud) = su_localize;
665 su_init(level, ud, 4);