1 /* This file is part of the Variable::Magic Perl module.
2 * See http://search.cpan.org/dist/Variable-Magic/ */
4 #include <stdarg.h> /* <va_list>, va_{start,arg,end}, ... */
6 #include <stdio.h> /* sprintf() */
8 #define PERL_NO_GET_CONTEXT
13 #define __PACKAGE__ "Variable::Magic"
15 #ifndef VMG_PERL_PATCHLEVEL
17 # define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
19 # define VMG_PERL_PATCHLEVEL 0
23 #define VMG_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
25 #define VMG_HAS_PERL_BRANCH(R, V, S) (PERL_REVISION == (R) && PERL_VERSION == (V) && PERL_SUBVERSION >= (S))
27 #define VMG_HAS_PERL_MAINT(R, V, S, P) (PERL_REVISION == (R) && PERL_VERSION == (V) && (VMG_PERL_PATCHLEVEL >= (P) || (!VMG_PERL_PATCHLEVEL && PERL_SUBVERSION >= (S))))
29 /* --- Threads and multiplicity -------------------------------------------- */
39 #ifndef VMG_MULTIPLICITY
40 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
41 # define VMG_MULTIPLICITY 1
43 # define VMG_MULTIPLICITY 0
46 #if VMG_MULTIPLICITY && !defined(tTHX)
47 # define tTHX PerlInterpreter*
50 #if VMG_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))
51 # define VMG_THREADSAFE 1
53 # define MY_CXT_CLONE \
55 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
56 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
57 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
60 # define VMG_THREADSAFE 0
62 # define dMY_CXT dNOOP
64 # define MY_CXT vmg_globaldata
66 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
68 # define MY_CXT_INIT NOOP
70 # define MY_CXT_CLONE NOOP
75 STATIC SV *vmg_clone(pTHX_ SV *sv, tTHX owner) {
76 #define vmg_clone(P, O) vmg_clone(aTHX_ (P), (O))
78 param.stashes = NULL; /* don't need it unless sv is a PVHV */
80 param.proto_perl = owner;
81 return sv_dup(sv, ¶m);
84 #endif /* VMG_THREADSAFE */
86 /* --- Compatibility ------------------------------------------------------- */
89 # define Newx(v, n, c) New(0, v, n, c)
93 # define NewOp(m, var, c, type) Newz(m, var, c, type)
97 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
101 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
105 # define SvPV_const SvPV
108 #ifndef PERL_MAGIC_ext
109 # define PERL_MAGIC_ext '~'
112 #ifndef PERL_MAGIC_tied
113 # define PERL_MAGIC_tied 'P'
128 #ifndef IN_PERL_COMPILETIME
129 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
132 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
133 # ifndef PL_error_count
134 # define PL_error_count PL_parser->error_count
137 # ifndef PL_error_count
138 # define PL_error_count PL_Ierror_count
142 /* uvar magic and Hash::Util::FieldHash were commited with 28419 */
143 #if VMG_HAS_PERL_MAINT(5, 9, 4, 28419) || VMG_HAS_PERL(5, 10, 0)
149 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160 */
150 #ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
151 # if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
152 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
154 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
158 /* Applied to dev-5.11 as 34908 */
159 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
160 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
162 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
165 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
166 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
167 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
169 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
172 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
173 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
175 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
180 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
181 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
182 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
184 sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
185 /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
186 if ((mg = SvMAGIC(sv))) {
189 const MGVTBL* const vtbl = mg->mg_virtual;
191 if (vtbl->svt_clear) {
196 } while ((mg = mg->mg_moremagic));
200 #endif /* VMG_UVAR */
202 /* --- Context-safe global data -------------------------------------------- */
204 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
213 /* --- Signatures ---------------------------------------------------------- */
215 #define SIG_MIN ((U16) (1u << 8))
216 #define SIG_MAX ((U16) ((1u << 16) - 1))
217 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
218 #define SIG_WIZ ((U16) ((1u << 8) - 1))
220 /* ... Generate signatures ................................................. */
222 STATIC U16 vmg_gensig(pTHX) {
223 #define vmg_gensig() vmg_gensig(aTHX)
229 sig = SIG_NBR * Drand01() + SIG_MIN;
230 } while (hv_exists(MY_CXT.wizards, buf, sprintf(buf, "%u", sig)));
235 /* --- MGWIZ structure ----------------------------------------------------- */
245 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
248 #endif /* MGf_COPY */
254 #endif /* MGf_LOCAL */
256 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
257 #endif /* VMG_UVAR */
260 #endif /* VMG_MULTIPLICITY */
263 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
264 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
266 /* ... Construct private data .............................................. */
268 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
269 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
271 I32 i, alen = (args == NULL) ? 0 : av_len(args);
279 EXTEND(SP, alen + 1);
280 PUSHs(sv_2mortal(newRV_inc(sv)));
281 for (i = 0; i < alen; ++i)
282 PUSHs(*av_fetch(args, i, 0));
285 call_sv(ctor, G_SCALAR);
289 #if VMG_HAS_PERL(5, 8, 3)
290 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
292 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
302 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
303 MAGIC *mg, *moremagic;
305 if (SvTYPE(sv) >= SVt_PVMG) {
306 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
307 moremagic = mg->mg_moremagic;
308 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
310 if (mg) { return mg->mg_obj; }
316 /* ... Magic cast/dispell .................................................. */
319 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
321 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
323 prevmagic->mg_moremagic = moremagic;
325 SvMAGIC_set(sv, moremagic);
327 mg->mg_moremagic = NULL;
328 Safefree(mg->mg_ptr);
331 #endif /* VMG_UVAR */
333 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
334 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
335 MAGIC *mg = NULL, *moremagic = NULL;
338 U32 oldgmg = SvGMAGICAL(sv);
342 if (SvTYPE(sv) >= SVt_PVMG) {
343 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
344 moremagic = mg->mg_moremagic;
345 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
347 if (mg) { return 1; }
350 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
351 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
352 mg->mg_private = w->sig;
355 mg->mg_flags |= MGf_COPY;
356 #endif /* MGf_COPY */
359 mg->mg_flags |= MGf_DUP;
363 mg->mg_flags |= MGf_LOCAL;
364 #endif /* MGf_LOCAL */
366 if (SvTYPE(sv) < SVt_PVHV)
369 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
370 * magic is actually never called for them. If the GMAGICAL flag was off before
371 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
372 * now on, then this wizard has get magic. Hence we can work around the
373 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
374 * has uvar callbacks, it will be turned back on later. */
375 if (!oldgmg && SvGMAGICAL(sv))
383 uf[0].uf_val = vmg_svt_val;
390 /* One uvar magic in the chain is enough. */
391 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
392 moremagic = mg->mg_moremagic;
393 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
396 if (mg) { /* Found another uvar magic. */
397 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
398 if (olduf->uf_val == vmg_svt_val) {
399 /* It's our uvar magic, nothing to do. oldgmg was true. */
402 /* It's another uvar magic, backup it and replace it by ours. */
404 vmg_uvar_del(sv, prevmagic, mg, moremagic);
408 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
409 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
410 * handled by our uvar callback. */
412 #endif /* VMG_UVAR */
418 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
419 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
422 #endif /* VMG_UVAR */
423 MAGIC *mg, *prevmagic, *moremagic = NULL;
425 if (SvTYPE(sv) < SVt_PVMG) { return 0; }
427 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
428 moremagic = mg->mg_moremagic;
429 if (mg->mg_type == PERL_MAGIC_ext) {
430 if (mg->mg_private == sig) {
432 /* If the current has no uvar, short-circuit uvar deletion. */
433 uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
434 #endif /* VMG_UVAR */
437 } else if ((mg->mg_private >= SIG_MIN) &&
438 (mg->mg_private <= SIG_MAX) &&
439 SV2MGWIZ(mg->mg_ptr)->uvar) {
441 /* We can't break here since we need to find the ext magic to delete. */
442 #endif /* VMG_UVAR */
446 if (!mg) { return 0; }
449 prevmagic->mg_moremagic = moremagic;
451 SvMAGIC_set(sv, moremagic);
453 mg->mg_moremagic = NULL;
455 if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
456 SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
460 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
461 /* mg was the first ext magic in the chain that had uvar */
463 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
464 if ((mg->mg_type == PERL_MAGIC_ext) &&
465 (mg->mg_private >= SIG_MIN) &&
466 (mg->mg_private <= SIG_MAX) &&
467 SV2MGWIZ(mg->mg_ptr)->uvar) {
475 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
476 moremagic = mg->mg_moremagic;
477 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
480 uf = (struct ufuncs *) mg->mg_ptr;
481 /* assert(uf->uf_val == vmg_svt_val); */
482 if (uf[1].uf_val || uf[1].uf_set) {
483 /* Revert the original uvar magic. */
485 Renew(uf, 1, struct ufuncs);
486 mg->mg_ptr = (char *) uf;
487 mg->mg_len = sizeof(struct ufuncs);
489 /* Remove the uvar magic. */
490 vmg_uvar_del(sv, prevmagic, mg, moremagic);
494 #endif /* VMG_UVAR */
499 /* ... OP info ............................................................. */
501 #define VMG_OP_INFO_NAME 1
502 #define VMG_OP_INFO_OBJECT 2
504 STATIC U32 vmg_op_name_init = 0;
505 STATIC unsigned char vmg_op_name_len[MAXO] = { 0 };
507 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
508 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
510 case VMG_OP_INFO_NAME:
511 if (!vmg_op_name_init) {
513 for (t = 0; t < OP_max; ++t)
514 vmg_op_name_len[t] = strlen(PL_op_name[t]);
515 vmg_op_name_init = 1;
518 case VMG_OP_INFO_OBJECT: {
520 if (!MY_CXT.b__op_stash) {
522 MY_CXT.b__op_stash = gv_stashpv("B::OP", 1);
531 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
532 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
537 case VMG_OP_INFO_NAME: {
538 OPCODE t = PL_op->op_type;
539 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
541 case VMG_OP_INFO_OBJECT: {
543 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
553 /* ... svt callbacks ....................................................... */
555 #define VMG_CB_CALL_SET_RET(D) \
560 ret = SvOK(svr) ? SvIV(svr) : (D); \
564 #define VMG_CB_CALL_ARGS_MASK 15
565 #define VMG_CB_CALL_ARGS_SHIFT 4
566 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
568 STATIC int vmg_cb_call(pTHX_ SV *cb, unsigned int flags, SV *sv, ...) {
571 unsigned int i, args, opinfo;
575 args = flags & VMG_CB_CALL_ARGS_MASK;
576 flags >>= VMG_CB_CALL_ARGS_SHIFT;
577 opinfo = flags & VMG_CB_CALL_OPINFO;
583 EXTEND(SP, args + 1);
584 PUSHs(sv_2mortal(newRV_inc(sv)));
586 for (i = 0; i < args; ++i) {
587 SV *sva = va_arg(ap, SV *);
588 PUSHs(sva ? sva : &PL_sv_undef);
592 XPUSHs(vmg_op_info(opinfo));
595 call_sv(cb, G_SCALAR);
597 VMG_CB_CALL_SET_RET(0);
605 #define vmg_cb_call1(I, F, S, A1) \
606 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 1), (S), (A1))
607 #define vmg_cb_call2(I, F, S, A1, A2) \
608 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 2), (S), (A1), (A2))
609 #define vmg_cb_call3(I, F, S, A1, A2, A3) \
610 vmg_cb_call(aTHX_ (I), (((F) << VMG_CB_CALL_ARGS_SHIFT) | 3), (S), (A1), (A2), (A3))
612 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
613 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
614 return vmg_cb_call1(w->cb_get, w->opinfo, sv, mg->mg_obj);
617 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
618 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
619 return vmg_cb_call1(w->cb_set, w->opinfo, sv, mg->mg_obj);
622 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
623 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
624 unsigned int opinfo = w->opinfo;
626 svtype t = SvTYPE(sv);
635 PUSHs(sv_2mortal(newRV_inc(sv)));
636 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
639 U8 *s = (U8 *) SvPV_const(sv, l);
641 len = utf8_length(s, s + l);
645 } else if (t == SVt_PVAV) {
646 len = av_len((AV *) sv) + 1;
653 XPUSHs(vmg_op_info(opinfo));
656 call_sv(w->cb_len, G_SCALAR);
658 VMG_CB_CALL_SET_RET(len);
663 return t == SVt_PVAV ? ret - 1 : ret;
666 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
667 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
668 return vmg_cb_call1(w->cb_clear, w->opinfo, sv, mg->mg_obj);
671 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
673 unsigned int had_err, has_err, flags = G_SCALAR | G_EVAL;
678 /* Don't even bother if we are in global destruction - the wizard is prisoner
679 * of circular references and we are way beyond user realm */
683 w = SV2MGWIZ(mg->mg_ptr);
685 /* So that it survives the temp cleanup below */
688 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
689 /* The previous magic tokens were freed but the magic chain wasn't updated, so
690 * if you access the sv from the callback the old deleted magics will trigger
691 * and cause memory misreads. Change 32686 solved it that way : */
700 PUSHs(sv_2mortal(newRV_inc(sv)));
701 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
703 XPUSHs(vmg_op_info(w->opinfo));
706 had_err = SvTRUE(ERRSV);
710 call_sv(w->cb_free, flags);
712 has_err = SvTRUE(ERRSV);
713 if (IN_PERL_COMPILETIME && !had_err && has_err)
716 VMG_CB_CALL_SET_RET(0);
722 /* Get the eval context that was pushed by call_sv, and fake an entry for the
723 * namesv, as die_where will need it to be non NULL later */
724 PERL_CONTEXT *cx = cxstack + cxstack_ix + 1;
725 if (!cx->blk_eval.old_namesv)
726 cx->blk_eval.old_namesv
727 = sv_2mortal(newSVpvn_share("Variable/Magic/DUMMY.pm", 23, 0));
730 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
731 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
734 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
735 * mg->mg_ptr reference count */
740 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
741 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
748 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
751 if (keylen == HEf_SVKEY) {
754 keysv = newSVpvn(key, keylen);
757 ret = vmg_cb_call3(w->cb_copy, w->opinfo, sv, mg->mg_obj, keysv, nsv);
759 if (keylen != HEf_SVKEY) {
765 #endif /* MGf_COPY */
768 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
774 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
775 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
776 return vmg_cb_call1(w->cb_local, w->opinfo, nsv, mg->mg_obj);
778 #endif /* MGf_LOCAL */
781 STATIC OP *vmg_pp_resetuvar(pTHX) {
782 SvRMAGICAL_on(cSVOP_sv);
786 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
789 SV *key = NULL, *newkey = NULL;
792 umg = mg_find(sv, PERL_MAGIC_uvar);
793 /* umg can't be NULL or we wouldn't be there. */
795 uf = (struct ufuncs *) umg->mg_ptr;
797 if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
798 if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
800 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
801 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
803 switch (mg->mg_type) {
806 case PERL_MAGIC_tied:
812 if (mg->mg_private < SIG_MIN || mg->mg_private > SIG_MAX)
814 w = SV2MGWIZ(mg->mg_ptr);
820 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
825 vmg_cb_call2(w->cb_fetch, w->opinfo, sv, mg->mg_obj, key);
827 case HV_FETCH_ISSTORE:
828 case HV_FETCH_LVALUE:
829 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
831 vmg_cb_call2(w->cb_store, w->opinfo, sv, mg->mg_obj, key);
833 case HV_FETCH_ISEXISTS:
835 vmg_cb_call2(w->cb_exists, w->opinfo, sv, mg->mg_obj, key);
839 vmg_cb_call2(w->cb_delete, w->opinfo, sv, mg->mg_obj, key);
844 if (SvRMAGICAL(sv) && !tied) {
845 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
846 * mistaken for a tied hash by the rest of hv_common. It will be reset by
847 * the op_ppaddr of a new fake op injected between the current and the next
850 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
852 NewOp(1101, svop, 1, SVOP);
853 svop->op_type = OP_STUB;
854 svop->op_ppaddr = vmg_pp_resetuvar;
855 svop->op_next = o->op_next;
858 o->op_next = (OP *) svop;
865 #endif /* VMG_UVAR */
867 /* ... Wizard destructor ................................................... */
869 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
873 if (PL_dirty) /* During global destruction, the context is already freed */
878 if (w->owner != aTHX)
881 #endif /* VMG_MULTIPLICITY */
885 if (hv_delete(MY_CXT.wizards, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
888 SvFLAGS(wiz) |= SVf_BREAK;
891 if (w->cb_data != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
892 if (w->cb_get != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
893 if (w->cb_set != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
894 if (w->cb_len != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
895 if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
896 if (w->cb_free != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
898 if (w->cb_copy != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
899 #endif /* MGf_COPY */
901 if (w->cb_dup != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
904 if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
905 #endif /* MGf_LOCAL */
907 if (w->cb_fetch != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
908 if (w->cb_store != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
909 if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
910 if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
911 #endif /* VMG_UVAR */
919 STATIC MGVTBL vmg_wizard_vtbl = {
924 vmg_wizard_free, /* free */
927 #endif /* MGf_COPY */
933 #endif /* MGf_LOCAL */
936 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
937 STATIC const char vmg_invalid_sig[] = "Invalid numeric signature";
938 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
939 STATIC const char vmg_toomanysigs[] = "Too many magic signatures used";
940 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
941 STATIC const char vmg_globstorefail[] = "Couldn't store global wizard information";
943 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
944 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
949 } else if (SvNOK(sv)) {
951 } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
954 croak(vmg_invalid_sig);
956 if (sig < SIG_MIN) { sig += SIG_MIN; }
957 if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
962 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
963 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
968 sig = SV2MGWIZ(SvRV(wiz))->sig;
969 } else if (SvOK(wiz)) {
970 sig = vmg_sv2sig(wiz);
972 croak(vmg_invalid_wiz);
977 if (!hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
983 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
984 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
992 if (SV2MGWIZ(wiz)->owner == aTHX)
994 #endif /* VMG_MULTIPLICITY */
995 sig = SV2MGWIZ(wiz)->sig;
996 } else if (SvOK(wiz)) {
997 sig = vmg_sv2sig(wiz);
999 croak(vmg_invalid_wiz);
1004 return (old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))
1009 #define VMG_SET_CB(S, N) \
1011 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
1013 #define VMG_SET_SVT_CB(S, N) \
1015 if (SvOK(cb) && SvROK(cb)) { \
1016 t->svt_ ## N = vmg_svt_ ## N; \
1017 w->cb_ ## N = newRV_inc(SvRV(cb)); \
1019 t->svt_ ## N = NULL; \
1020 w->cb_ ## N = NULL; \
1025 #define VMG_CLONE_CB(N) \
1026 z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
1030 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
1031 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1036 Copy(w->vtbl, t, 1, MGVTBL);
1043 VMG_CLONE_CB(clear);
1047 #endif /* MGf_COPY */
1050 #endif /* MGf_DUP */
1052 VMG_CLONE_CB(local);
1053 #endif /* MGf_LOCAL */
1055 VMG_CLONE_CB(fetch);
1056 VMG_CLONE_CB(store);
1057 VMG_CLONE_CB(exists);
1058 VMG_CLONE_CB(delete);
1059 #endif /* VMG_UVAR */
1064 z->opinfo = w->opinfo;
1069 #endif /* VMG_THREADSAFE */
1071 /* --- XS ------------------------------------------------------------------ */
1073 MODULE = Variable::Magic PACKAGE = Variable::Magic
1081 MY_CXT.wizards = newHV();
1082 hv_iterinit(MY_CXT.wizards); /* Allocate iterator */
1083 MY_CXT.b__op_stash = NULL;
1084 stash = gv_stashpv(__PACKAGE__, 1);
1085 newCONSTSUB(stash, "SIG_MIN", newSVuv(SIG_MIN));
1086 newCONSTSUB(stash, "SIG_MAX", newSVuv(SIG_MAX));
1087 newCONSTSUB(stash, "SIG_NBR", newSVuv(SIG_NBR));
1088 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1089 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1090 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1091 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1092 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1093 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1094 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1095 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1096 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1097 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1098 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1099 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1100 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1101 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1102 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1103 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1113 U32 had_b__op_stash = 0;
1119 hv_iterinit(hv); /* Allocate iterator */
1120 hv_iterinit(MY_CXT.wizards);
1121 while ((key = hv_iternext(MY_CXT.wizards))) {
1123 char *sig = HePV(key, len);
1127 w = SV2MGWIZ(HeVAL(key));
1128 w = vmg_wizard_clone(w);
1130 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1131 mg->mg_private = SIG_WIZ;
1133 if (!hv_store(hv, sig, len, sv, HeHASH(key))) croak("%s during CLONE", vmg_globstorefail);
1135 if (MY_CXT.b__op_stash)
1136 had_b__op_stash = 1;
1140 MY_CXT.wizards = hv;
1141 MY_CXT.b__op_stash = had_b__op_stash ? gv_stashpv("B::OP", 1) : NULL;
1144 #endif /* VMG_THREADSAFE */
1164 #endif /* MGf_COPY */
1167 #endif /* MGf_DUP */
1170 #endif /* MGf_LOCAL */
1173 #endif /* VMG_UVAR */
1174 ) { croak(vmg_wrongargnum); }
1179 sig = vmg_sv2sig(svsig);
1180 if ((old = hv_fetch(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), 0))) {
1181 ST(0) = sv_2mortal(newRV_inc(*old));
1185 if (HvKEYS(MY_CXT.wizards) >= SIG_NBR) { croak(vmg_toomanysigs); }
1192 VMG_SET_CB(ST(i++), data);
1194 w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1196 vmg_op_info_init(w->opinfo);
1197 VMG_SET_SVT_CB(ST(i++), get);
1198 VMG_SET_SVT_CB(ST(i++), set);
1199 VMG_SET_SVT_CB(ST(i++), len);
1200 VMG_SET_SVT_CB(ST(i++), clear);
1201 VMG_SET_SVT_CB(ST(i++), free);
1203 VMG_SET_SVT_CB(ST(i++), copy);
1204 #endif /* MGf_COPY */
1206 /* VMG_SET_SVT_CB(ST(i++), dup); */
1210 #endif /* MGf_DUP */
1212 VMG_SET_SVT_CB(ST(i++), local);
1213 #endif /* MGf_LOCAL */
1215 VMG_SET_CB(ST(i++), fetch);
1216 VMG_SET_CB(ST(i++), store);
1217 VMG_SET_CB(ST(i++), exists);
1218 VMG_SET_CB(ST(i++), delete);
1220 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1221 w->uvar = SvTRUE(cb) ? 2 : 1;
1224 #endif /* VMG_UVAR */
1225 #if VMG_MULTIPLICITY
1227 #endif /* VMG_MULTIPLICITY */
1232 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1233 mg->mg_private = SIG_WIZ;
1236 if (!hv_store(MY_CXT.wizards, buf, sprintf(buf, "%u", sig), sv, 0)) croak(vmg_globstorefail);
1238 RETVAL = newRV_noinc(sv);
1246 if (HvKEYS(MY_CXT.wizards) >= SIG_NBR) { croak(vmg_toomanysigs); }
1247 RETVAL = newSVuv(vmg_gensig());
1254 if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1255 RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1259 SV *cast(SV *sv, SV *wiz, ...)
1260 PROTOTYPE: \[$@%&*]$@
1265 wiz = vmg_wizard_wiz(wiz);
1271 av_fill(args, items - 2);
1272 for (i = 2; i < items; ++i) {
1275 if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1278 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1285 getdata(SV *sv, SV *wiz)
1286 PROTOTYPE: \[$@%&*]$
1291 sig = vmg_wizard_sig(wiz);
1294 data = vmg_data_get(SvRV(sv), sig);
1295 if (!data) { XSRETURN_UNDEF; }
1299 SV *dispell(SV *sv, SV *wiz)
1300 PROTOTYPE: \[$@%&*]$
1304 sig = vmg_wizard_sig(wiz);
1307 RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));