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
206 typedef HV * my_cxt_t;
210 /* --- Signatures ---------------------------------------------------------- */
212 #define SIG_MIN ((U16) (1u << 8))
213 #define SIG_MAX ((U16) ((1u << 16) - 1))
214 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
215 #define SIG_WIZ ((U16) ((1u << 8) - 1))
217 /* ... Generate signatures ................................................. */
219 STATIC U16 vmg_gensig(pTHX) {
220 #define vmg_gensig() vmg_gensig(aTHX)
226 sig = SIG_NBR * Drand01() + SIG_MIN;
227 } while (hv_exists(MY_CXT, buf, sprintf(buf, "%u", sig)));
232 /* --- MGWIZ structure ----------------------------------------------------- */
242 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
245 #endif /* MGf_COPY */
251 #endif /* MGf_LOCAL */
253 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
254 #endif /* VMG_UVAR */
257 #endif /* VMG_MULTIPLICITY */
260 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
261 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
263 /* ... Construct private data .............................................. */
265 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
266 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
268 I32 i, alen = (args == NULL) ? 0 : av_len(args);
276 EXTEND(SP, alen + 1);
277 PUSHs(sv_2mortal(newRV_inc(sv)));
278 for (i = 0; i < alen; ++i)
279 PUSHs(*av_fetch(args, i, 0));
282 call_sv(ctor, G_SCALAR);
286 #if VMG_HAS_PERL(5, 8, 3)
287 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
289 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
299 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
300 MAGIC *mg, *moremagic;
302 if (SvTYPE(sv) >= SVt_PVMG) {
303 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
304 moremagic = mg->mg_moremagic;
305 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
307 if (mg) { return mg->mg_obj; }
313 /* ... Magic cast/dispell .................................................. */
316 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
318 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
320 prevmagic->mg_moremagic = moremagic;
322 SvMAGIC_set(sv, moremagic);
324 mg->mg_moremagic = NULL;
325 Safefree(mg->mg_ptr);
328 #endif /* VMG_UVAR */
330 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
331 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
332 MAGIC *mg = NULL, *moremagic = NULL;
335 U32 oldgmg = SvGMAGICAL(sv);
339 if (SvTYPE(sv) >= SVt_PVMG) {
340 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
341 moremagic = mg->mg_moremagic;
342 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
344 if (mg) { return 1; }
347 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
348 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
349 mg->mg_private = w->sig;
352 mg->mg_flags |= MGf_COPY;
353 #endif /* MGf_COPY */
356 mg->mg_flags |= MGf_DUP;
360 mg->mg_flags |= MGf_LOCAL;
361 #endif /* MGf_LOCAL */
363 if (SvTYPE(sv) < SVt_PVHV)
366 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
367 * magic is actually never called for them. If the GMAGICAL flag was off before
368 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
369 * now on, then this wizard has get magic. Hence we can work around the
370 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
371 * has uvar callbacks, it will be turned back on later. */
372 if (!oldgmg && SvGMAGICAL(sv))
380 uf[0].uf_val = vmg_svt_val;
387 /* One uvar magic in the chain is enough. */
388 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
389 moremagic = mg->mg_moremagic;
390 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
393 if (mg) { /* Found another uvar magic. */
394 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
395 if (olduf->uf_val == vmg_svt_val) {
396 /* It's our uvar magic, nothing to do. oldgmg was true. */
399 /* It's another uvar magic, backup it and replace it by ours. */
401 vmg_uvar_del(sv, prevmagic, mg, moremagic);
405 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
406 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
407 * handled by our uvar callback. */
409 #endif /* VMG_UVAR */
415 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
416 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
419 #endif /* VMG_UVAR */
420 MAGIC *mg, *prevmagic, *moremagic = NULL;
422 if (SvTYPE(sv) < SVt_PVMG) { return 0; }
424 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
425 moremagic = mg->mg_moremagic;
426 if (mg->mg_type == PERL_MAGIC_ext) {
427 if (mg->mg_private == sig) {
429 /* If the current has no uvar, short-circuit uvar deletion. */
430 uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
431 #endif /* VMG_UVAR */
434 } else if ((mg->mg_private >= SIG_MIN) &&
435 (mg->mg_private <= SIG_MAX) &&
436 SV2MGWIZ(mg->mg_ptr)->uvar) {
438 /* We can't break here since we need to find the ext magic to delete. */
439 #endif /* VMG_UVAR */
443 if (!mg) { return 0; }
446 prevmagic->mg_moremagic = moremagic;
448 SvMAGIC_set(sv, moremagic);
450 mg->mg_moremagic = NULL;
452 if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
453 SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
457 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
458 /* mg was the first ext magic in the chain that had uvar */
460 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
461 if ((mg->mg_type == PERL_MAGIC_ext) &&
462 (mg->mg_private >= SIG_MIN) &&
463 (mg->mg_private <= SIG_MAX) &&
464 SV2MGWIZ(mg->mg_ptr)->uvar) {
472 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
473 moremagic = mg->mg_moremagic;
474 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
477 uf = (struct ufuncs *) mg->mg_ptr;
478 /* assert(uf->uf_val == vmg_svt_val); */
479 if (uf[1].uf_val || uf[1].uf_set) {
480 /* Revert the original uvar magic. */
482 Renew(uf, 1, struct ufuncs);
483 mg->mg_ptr = (char *) uf;
484 mg->mg_len = sizeof(struct ufuncs);
486 /* Remove the uvar magic. */
487 vmg_uvar_del(sv, prevmagic, mg, moremagic);
491 #endif /* VMG_UVAR */
496 /* ... OP info ............................................................. */
498 #define VMG_OP_INFO_NAME 1
499 #define VMG_OP_INFO_OBJECT 2
501 STATIC STRLEN *vmg_op_name_len = NULL;
503 STATIC HV *vmg_b__op_stash = NULL;
505 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
506 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
508 case VMG_OP_INFO_NAME:
509 if (!vmg_op_name_len) {
511 Newx(vmg_op_name_len, MAXO, STRLEN);
512 for (t = 0; t < OP_max; ++t)
513 vmg_op_name_len[t] = strlen(PL_op_name[t]);
516 case VMG_OP_INFO_OBJECT:
517 if (!vmg_b__op_stash) {
519 vmg_b__op_stash = gv_stashpv("B::OP", 1);
527 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
528 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
533 case VMG_OP_INFO_NAME: {
534 OPCODE t = PL_op->op_type;
535 return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
537 case VMG_OP_INFO_OBJECT:
538 return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
547 /* ... svt callbacks ....................................................... */
549 #define VMG_CB_CALL_ARGS_MASK 15
550 #define VMG_CB_CALL_ARGS_SHIFT 4
551 #define VMG_CB_CALL_OPINFO (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
552 #define VMG_CB_CALL_EVAL 4
554 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data, unsigned int flags, ...){
558 unsigned int i, args, opinfo, eval;
562 args = flags & VMG_CB_CALL_ARGS_MASK;
563 flags >>= VMG_CB_CALL_ARGS_SHIFT;
564 opinfo = flags & VMG_CB_CALL_OPINFO;
565 eval = flags & VMG_CB_CALL_EVAL ? G_EVAL : 0;
571 EXTEND(SP, args + 2);
572 PUSHs(sv_2mortal(newRV_inc(sv)));
573 PUSHs(data ? data : &PL_sv_undef);
575 for (i = 0; i < args; ++i) {
576 SV *sva = va_arg(ap, SV *);
577 PUSHs(sva ? sva : &PL_sv_undef);
581 XPUSHs(vmg_op_info(opinfo));
584 call_sv(cb, G_SCALAR | eval);
587 if (eval && IN_PERL_COMPILETIME && SvTRUE(ERRSV))
590 ret = SvOK(svr) ? SvIV(svr) : 0;
599 #define vmg_cb_call1(I, S, D) \
600 vmg_cb_call(aTHX_ (I), (S), (D), (flags << VMG_CB_CALL_ARGS_SHIFT))
601 #define vmg_cb_call2(I, S, D, S2) \
602 vmg_cb_call(aTHX_ (I), (S), (D), ((flags << VMG_CB_CALL_ARGS_SHIFT) | 1), (S2))
603 #define vmg_cb_call3(I, S, D, S2, S3) \
604 vmg_cb_call(aTHX_ (I), (S), (D), ((flags << VMG_CB_CALL_ARGS_SHIFT) | 2), (S2), (S3))
606 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
607 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
608 unsigned int flags = w->opinfo;
609 return vmg_cb_call1(w->cb_get, sv, mg->mg_obj);
612 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
613 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
614 unsigned int flags = w->opinfo;
615 return vmg_cb_call1(w->cb_set, sv, mg->mg_obj);
618 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
620 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
621 unsigned int opinfo = w->opinfo;
623 svtype t = SvTYPE(sv);
632 PUSHs(sv_2mortal(newRV_inc(sv)));
633 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
636 U8 *s = (U8 *) SvPV_const(sv, l);
638 len = utf8_length(s, s + l);
642 } else if (t == SVt_PVAV) {
643 len = av_len((AV *) sv) + 1;
650 XPUSHs(vmg_op_info(opinfo));
653 call_sv(w->cb_len, G_SCALAR);
657 ret = SvOK(svr) ? SvUV(svr) : 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 unsigned int flags = w->opinfo;
669 return vmg_cb_call1(w->cb_clear, sv, mg->mg_obj);
672 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
677 /* Don't even bother if we are in global destruction - the wizard is prisoner
678 * of circular references and we are way beyond user realm */
682 w = SV2MGWIZ(mg->mg_ptr);
683 flags = w->opinfo | VMG_CB_CALL_EVAL;
685 /* So that it survives the temp cleanup in vmg_cb_call */
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 : */
695 ret = vmg_cb_call1(w->cb_free, sv, mg->mg_obj);
697 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
698 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
701 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
702 * mg->mg_ptr reference count */
707 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
708 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
715 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
716 unsigned int flags = w->opinfo;
719 if (keylen == HEf_SVKEY) {
722 keysv = newSVpvn(key, keylen);
725 ret = vmg_cb_call3(w->cb_copy, sv, mg->mg_obj, keysv, nsv);
727 if (keylen != HEf_SVKEY) {
733 #endif /* MGf_COPY */
736 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
742 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
743 const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
744 unsigned int flags = w->opinfo;
745 return vmg_cb_call1(w->cb_local, nsv, mg->mg_obj);
747 #endif /* MGf_LOCAL */
750 STATIC OP *vmg_pp_resetuvar(pTHX) {
751 SvRMAGICAL_on(cSVOP_sv);
755 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
758 SV *key = NULL, *newkey = NULL;
761 umg = mg_find(sv, PERL_MAGIC_uvar);
762 /* umg can't be NULL or we wouldn't be there. */
764 uf = (struct ufuncs *) umg->mg_ptr;
766 if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
767 if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
769 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
770 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
773 switch (mg->mg_type) {
776 case PERL_MAGIC_tied:
782 if (mg->mg_private < SIG_MIN || mg->mg_private > SIG_MAX)
784 w = SV2MGWIZ(mg->mg_ptr);
791 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
795 if (w->cb_fetch) { vmg_cb_call2(w->cb_fetch, sv, mg->mg_obj, key); }
797 case HV_FETCH_ISSTORE:
798 case HV_FETCH_LVALUE:
799 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
800 if (w->cb_store) { vmg_cb_call2(w->cb_store, sv, mg->mg_obj, key); }
802 case HV_FETCH_ISEXISTS:
803 if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
806 if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
811 if (SvRMAGICAL(sv) && !tied) {
812 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
813 * mistaken for a tied hash by the rest of hv_common. It will be reset by
814 * the op_ppaddr of a new fake op injected between the current and the next
817 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
819 NewOp(1101, svop, 1, SVOP);
820 svop->op_type = OP_STUB;
821 svop->op_ppaddr = vmg_pp_resetuvar;
822 svop->op_next = o->op_next;
825 o->op_next = (OP *) svop;
832 #endif /* VMG_UVAR */
834 /* ... Wizard destructor ................................................... */
836 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
840 if (PL_dirty) /* During global destruction, the context is already freed */
845 if (w->owner != aTHX)
848 #endif /* VMG_MULTIPLICITY */
852 if (hv_delete(MY_CXT, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
855 SvFLAGS(wiz) |= SVf_BREAK;
858 if (w->cb_data != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
859 if (w->cb_get != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
860 if (w->cb_set != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
861 if (w->cb_len != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
862 if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
863 if (w->cb_free != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
865 if (w->cb_copy != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
866 #endif /* MGf_COPY */
868 if (w->cb_dup != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
871 if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
872 #endif /* MGf_LOCAL */
874 if (w->cb_fetch != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
875 if (w->cb_store != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
876 if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
877 if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
878 #endif /* VMG_UVAR */
886 STATIC MGVTBL vmg_wizard_vtbl = {
891 vmg_wizard_free, /* free */
894 #endif /* MGf_COPY */
900 #endif /* MGf_LOCAL */
903 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
904 STATIC const char vmg_invalid_sig[] = "Invalid numeric signature";
905 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
906 STATIC const char vmg_toomanysigs[] = "Too many magic signatures used";
907 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
909 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
910 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
915 } else if (SvNOK(sv)) {
917 } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
920 croak(vmg_invalid_sig);
922 if (sig < SIG_MIN) { sig += SIG_MIN; }
923 if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
928 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
929 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
934 sig = SV2MGWIZ(SvRV(wiz))->sig;
935 } else if (SvOK(wiz)) {
936 sig = vmg_sv2sig(wiz);
938 croak(vmg_invalid_wiz);
943 if (!hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
949 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
950 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
958 if (SV2MGWIZ(wiz)->owner == aTHX)
960 #endif /* VMG_MULTIPLICITY */
961 sig = SV2MGWIZ(wiz)->sig;
962 } else if (SvOK(wiz)) {
963 sig = vmg_sv2sig(wiz);
965 croak(vmg_invalid_wiz);
970 return (old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
975 #define VMG_SET_CB(S, N) \
977 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
979 #define VMG_SET_SVT_CB(S, N) \
981 if (SvOK(cb) && SvROK(cb)) { \
982 t->svt_ ## N = vmg_svt_ ## N; \
983 w->cb_ ## N = newRV_inc(SvRV(cb)); \
985 t->svt_ ## N = NULL; \
986 w->cb_ ## N = NULL; \
991 #define VMG_CLONE_CB(N) \
992 z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
996 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
997 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
1002 Copy(w->vtbl, t, 1, MGVTBL);
1009 VMG_CLONE_CB(clear);
1013 #endif /* MGf_COPY */
1016 #endif /* MGf_DUP */
1018 VMG_CLONE_CB(local);
1019 #endif /* MGf_LOCAL */
1021 VMG_CLONE_CB(fetch);
1022 VMG_CLONE_CB(store);
1023 VMG_CLONE_CB(exists);
1024 VMG_CLONE_CB(delete);
1025 #endif /* VMG_UVAR */
1030 z->opinfo = w->opinfo;
1035 #endif /* VMG_THREADSAFE */
1037 /* --- XS ------------------------------------------------------------------ */
1039 MODULE = Variable::Magic PACKAGE = Variable::Magic
1048 hv_iterinit(MY_CXT); /* Allocate iterator */
1049 stash = gv_stashpv(__PACKAGE__, 1);
1050 newCONSTSUB(stash, "SIG_MIN", newSVuv(SIG_MIN));
1051 newCONSTSUB(stash, "SIG_MAX", newSVuv(SIG_MAX));
1052 newCONSTSUB(stash, "SIG_NBR", newSVuv(SIG_NBR));
1053 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
1054 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
1055 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1056 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
1057 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1058 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1059 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1060 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1061 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1062 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1063 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1064 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1065 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1066 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
1067 newCONSTSUB(stash, "VMG_OP_INFO_NAME", newSVuv(VMG_OP_INFO_NAME));
1068 newCONSTSUB(stash, "VMG_OP_INFO_OBJECT", newSVuv(VMG_OP_INFO_OBJECT));
1083 hv_iterinit(hv); /* Allocate iterator */
1084 hv_iterinit(MY_CXT);
1085 while ((key = hv_iternext(MY_CXT))) {
1087 char *sig = HePV(key, len);
1091 w = SV2MGWIZ(HeVAL(key));
1092 w = vmg_wizard_clone(w);
1094 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1095 mg->mg_private = SIG_WIZ;
1097 hv_store(hv, sig, len, sv, HeHASH(key));
1105 #endif /* VMG_THREADSAFE */
1125 #endif /* MGf_COPY */
1128 #endif /* MGf_DUP */
1131 #endif /* MGf_LOCAL */
1134 #endif /* VMG_UVAR */
1135 ) { croak(vmg_wrongargnum); }
1140 sig = vmg_sv2sig(svsig);
1141 if ((old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))) {
1142 ST(0) = sv_2mortal(newRV_inc(*old));
1146 if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1153 VMG_SET_CB(ST(i++), data);
1155 w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1157 vmg_op_info_init(w->opinfo);
1158 VMG_SET_SVT_CB(ST(i++), get);
1159 VMG_SET_SVT_CB(ST(i++), set);
1160 VMG_SET_SVT_CB(ST(i++), len);
1161 VMG_SET_SVT_CB(ST(i++), clear);
1162 VMG_SET_SVT_CB(ST(i++), free);
1164 VMG_SET_SVT_CB(ST(i++), copy);
1165 #endif /* MGf_COPY */
1167 /* VMG_SET_SVT_CB(ST(i++), dup); */
1171 #endif /* MGf_DUP */
1173 VMG_SET_SVT_CB(ST(i++), local);
1174 #endif /* MGf_LOCAL */
1176 VMG_SET_CB(ST(i++), fetch);
1177 VMG_SET_CB(ST(i++), store);
1178 VMG_SET_CB(ST(i++), exists);
1179 VMG_SET_CB(ST(i++), delete);
1181 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1182 w->uvar = SvTRUE(cb) ? 2 : 1;
1185 #endif /* VMG_UVAR */
1186 #if VMG_MULTIPLICITY
1188 #endif /* VMG_MULTIPLICITY */
1193 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1194 mg->mg_private = SIG_WIZ;
1197 hv_store(MY_CXT, buf, sprintf(buf, "%u", sig), sv, 0);
1199 RETVAL = newRV_noinc(sv);
1207 if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1208 RETVAL = newSVuv(vmg_gensig());
1215 if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1216 RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1220 SV *cast(SV *sv, SV *wiz, ...)
1221 PROTOTYPE: \[$@%&*]$@
1226 wiz = vmg_wizard_wiz(wiz);
1232 av_fill(args, items - 2);
1233 for (i = 2; i < items; ++i) {
1236 if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1239 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1246 getdata(SV *sv, SV *wiz)
1247 PROTOTYPE: \[$@%&*]$
1252 sig = vmg_wizard_sig(wiz);
1255 data = vmg_data_get(SvRV(sv), sig);
1256 if (!data) { XSRETURN_UNDEF; }
1260 SV *dispell(SV *sv, SV *wiz)
1261 PROTOTYPE: \[$@%&*]$
1265 sig = vmg_wizard_sig(wiz);
1268 RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1276 if (vmg_op_name_len) {
1277 Safefree(vmg_op_name_len);
1278 vmg_op_name_len = NULL;