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 mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
104 #ifndef PERL_MAGIC_ext
105 # define PERL_MAGIC_ext '~'
108 #ifndef PERL_MAGIC_tied
109 # define PERL_MAGIC_tied 'P'
124 #ifndef IN_PERL_COMPILETIME
125 # define IN_PERL_COMPILETIME (PL_curcop == &PL_compiling)
128 #if VMG_HAS_PERL(5, 10, 0) || defined(PL_parser)
129 # ifndef PL_error_count
130 # define PL_error_count PL_parser->error_count
133 # ifndef PL_error_count
134 # define PL_error_count PL_Ierror_count
138 /* uvar magic and Hash::Util::FieldHash were commited with 28419 */
139 #if VMG_HAS_PERL_MAINT(5, 9, 4, 28419) || VMG_HAS_PERL(5, 10, 0)
145 /* Applied to dev-5.9 as 25854, integrated to maint-5.8 as 28160 */
146 #ifndef VMG_COMPAT_ARRAY_PUSH_NOLEN
147 # if VMG_HAS_PERL_MAINT(5, 8, 9, 28160) || VMG_HAS_PERL_MAINT(5, 9, 3, 25854) || VMG_HAS_PERL(5, 10, 0)
148 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
150 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
154 /* Applied to dev-5.11 as 34908 */
155 #if VMG_HAS_PERL_MAINT(5, 11, 0, 34908)
156 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 1
158 # define VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID 0
161 /* Applied to dev-5.9 as 31473 (see #43357), integrated to maint-5.8 as 32542 */
162 #if VMG_HAS_PERL_MAINT(5, 8, 9, 32542) || VMG_HAS_PERL_MAINT(5, 9, 5, 31473) || VMG_HAS_PERL(5, 10, 0)
163 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
165 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
168 #if VMG_HAS_PERL_MAINT(5, 11, 0, 32969)
169 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 1
171 # define VMG_COMPAT_SCALAR_LENGTH_NOLEN 0
176 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html - but specialized to our needs. */
177 STATIC void vmg_sv_magicuvar(pTHX_ SV *sv, const char *uf, I32 len) {
178 #define vmg_sv_magicuvar(S, U, L) vmg_sv_magicuvar(aTHX_ (S), (U), (L))
180 sv_magic(sv, NULL, PERL_MAGIC_uvar, uf, len);
181 /* uvar magic has set and get magic, hence this has set SVs_GMG and SVs_SMG. */
182 if ((mg = SvMAGIC(sv))) {
185 const MGVTBL* const vtbl = mg->mg_virtual;
187 if (vtbl->svt_clear) {
192 } while ((mg = mg->mg_moremagic));
196 #endif /* VMG_UVAR */
198 /* --- Context-safe global data -------------------------------------------- */
200 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
202 typedef HV * my_cxt_t;
206 /* --- Signatures ---------------------------------------------------------- */
208 #define SIG_MIN ((U16) (1u << 8))
209 #define SIG_MAX ((U16) ((1u << 16) - 1))
210 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
211 #define SIG_WIZ ((U16) ((1u << 8) - 1))
213 /* ... Generate signatures ................................................. */
215 STATIC U16 vmg_gensig(pTHX) {
216 #define vmg_gensig() vmg_gensig(aTHX)
222 sig = SIG_NBR * Drand01() + SIG_MIN;
223 } while (hv_exists(MY_CXT, buf, sprintf(buf, "%u", sig)));
228 /* --- MGWIZ structure ----------------------------------------------------- */
235 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
238 #endif /* MGf_COPY */
244 #endif /* MGf_LOCAL */
246 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
247 #endif /* VMG_UVAR */
250 #endif /* VMG_MULTIPLICITY */
253 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
254 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
256 /* ... Construct private data .............................................. */
258 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
259 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
261 I32 i, alen = (args == NULL) ? 0 : av_len(args);
269 EXTEND(SP, alen + 1);
270 PUSHs(sv_2mortal(newRV_inc(sv)));
271 for (i = 0; i < alen; ++i)
272 PUSHs(*av_fetch(args, i, 0));
275 call_sv(ctor, G_SCALAR);
279 #if VMG_HAS_PERL(5, 8, 3)
280 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
282 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
292 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
293 MAGIC *mg, *moremagic;
295 if (SvTYPE(sv) >= SVt_PVMG) {
296 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
297 moremagic = mg->mg_moremagic;
298 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
300 if (mg) { return mg->mg_obj; }
306 /* ... Magic cast/dispell .................................................. */
309 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
311 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
313 prevmagic->mg_moremagic = moremagic;
315 SvMAGIC_set(sv, moremagic);
317 mg->mg_moremagic = NULL;
318 Safefree(mg->mg_ptr);
321 #endif /* VMG_UVAR */
323 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
324 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
325 MAGIC *mg = NULL, *moremagic = NULL;
328 U32 oldgmg = SvGMAGICAL(sv);
332 if (SvTYPE(sv) >= SVt_PVMG) {
333 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
334 moremagic = mg->mg_moremagic;
335 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
337 if (mg) { return 1; }
340 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
341 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
342 mg->mg_private = w->sig;
345 mg->mg_flags |= MGf_COPY;
346 #endif /* MGf_COPY */
349 mg->mg_flags |= MGf_DUP;
353 mg->mg_flags |= MGf_LOCAL;
354 #endif /* MGf_LOCAL */
356 if (SvTYPE(sv) < SVt_PVHV)
359 /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
360 * magic is actually never called for them. If the GMAGICAL flag was off before
361 * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
362 * now on, then this wizard has get magic. Hence we can work around the
363 * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
364 * has uvar callbacks, it will be turned back on later. */
365 if (!oldgmg && SvGMAGICAL(sv))
373 uf[0].uf_val = vmg_svt_val;
380 /* One uvar magic in the chain is enough. */
381 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
382 moremagic = mg->mg_moremagic;
383 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
386 if (mg) { /* Found another uvar magic. */
387 struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
388 if (olduf->uf_val == vmg_svt_val) {
389 /* It's our uvar magic, nothing to do. oldgmg was true. */
392 /* It's another uvar magic, backup it and replace it by ours. */
394 vmg_uvar_del(sv, prevmagic, mg, moremagic);
398 vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
399 /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
400 * handled by our uvar callback. */
402 #endif /* VMG_UVAR */
408 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
409 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
412 #endif /* VMG_UVAR */
413 MAGIC *mg, *prevmagic, *moremagic = NULL;
415 if (SvTYPE(sv) < SVt_PVMG) { return 0; }
417 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
418 moremagic = mg->mg_moremagic;
419 if (mg->mg_type == PERL_MAGIC_ext) {
420 if (mg->mg_private == sig) {
422 /* If the current has no uvar, short-circuit uvar deletion. */
423 uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
424 #endif /* VMG_UVAR */
427 } else if ((mg->mg_private >= SIG_MIN) &&
428 (mg->mg_private <= SIG_MAX) &&
429 SV2MGWIZ(mg->mg_ptr)->uvar) {
431 /* We can't break here since we need to find the ext magic to delete. */
432 #endif /* VMG_UVAR */
436 if (!mg) { return 0; }
439 prevmagic->mg_moremagic = moremagic;
441 SvMAGIC_set(sv, moremagic);
443 mg->mg_moremagic = NULL;
445 if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
446 SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
450 if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
451 /* mg was the first ext magic in the chain that had uvar */
453 for (mg = moremagic; mg; mg = mg->mg_moremagic) {
454 if ((mg->mg_type == PERL_MAGIC_ext) &&
455 (mg->mg_private >= SIG_MIN) &&
456 (mg->mg_private <= SIG_MAX) &&
457 SV2MGWIZ(mg->mg_ptr)->uvar) {
465 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
466 moremagic = mg->mg_moremagic;
467 if (mg->mg_type == PERL_MAGIC_uvar) { break; }
470 uf = (struct ufuncs *) mg->mg_ptr;
471 /* assert(uf->uf_val == vmg_svt_val); */
472 if (uf[1].uf_val || uf[1].uf_set) {
473 /* Revert the original uvar magic. */
475 Renew(uf, 1, struct ufuncs);
476 mg->mg_ptr = (char *) uf;
477 mg->mg_len = sizeof(struct ufuncs);
479 /* Remove the uvar magic. */
480 vmg_uvar_del(sv, prevmagic, mg, moremagic);
484 #endif /* VMG_UVAR */
489 /* ... svt callbacks ....................................................... */
491 #define VMG_CB_CALL_ARGS_MASK 15
492 #define VMG_CB_CALL_EVAL 16
494 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data, unsigned int flags, ...){
499 unsigned int args = flags & VMG_CB_CALL_ARGS_MASK;
500 unsigned int eval = flags & VMG_CB_CALL_EVAL ? G_EVAL : 0;
508 EXTEND(SP, args + 2);
509 PUSHs(sv_2mortal(newRV_inc(sv)));
510 PUSHs(data ? data : &PL_sv_undef);
512 for (i = 0; i < args; ++i) {
513 SV *sva = va_arg(ap, SV *);
514 PUSHs(sva ? sva : &PL_sv_undef);
519 call_sv(cb, G_SCALAR | eval);
522 if (eval && IN_PERL_COMPILETIME && SvTRUE(ERRSV))
525 ret = SvOK(svr) ? SvIV(svr) : 0;
534 #define vmg_cb_call1(I, S, D) vmg_cb_call(aTHX_ (I), (S), (D), 0)
535 #define vmg_cb_call1e(I, S, D) vmg_cb_call(aTHX_ (I), (S), (D), VMG_CB_CALL_EVAL)
536 #define vmg_cb_call2(I, S, D, S2) vmg_cb_call(aTHX_ (I), (S), (D), 1, (S2))
537 #define vmg_cb_call3(I, S, D, S2, S3) vmg_cb_call(aTHX_ (I), (S), (D), 2, (S2), (S3))
539 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
540 return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_get, sv, mg->mg_obj);
543 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
544 return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_set, sv, mg->mg_obj);
547 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
554 has_array = SvTYPE(sv) == SVt_PVAV;
561 PUSHs(sv_2mortal(newRV_inc(sv)));
562 PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
564 len = av_len((AV *) sv) + 1;
572 call_sv(SV2MGWIZ(mg->mg_ptr)->cb_len, G_SCALAR);
576 ret = SvOK(svr) ? SvUV(svr) : len;
582 return has_array ? ret - 1 : ret;
585 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
586 return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_clear, sv, mg->mg_obj);
589 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
590 SV *wiz = (SV *) mg->mg_ptr;
593 /* This may happen in global destruction */
594 if (SvTYPE(wiz) == SVTYPEMASK)
597 /* So that it survives the temp cleanup in vmg_cb_call */
600 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
601 /* The previous magic tokens were freed but the magic chain wasn't updated, so
602 * if you access the sv from the callback the old deleted magics will trigger
603 * and cause memory misreads. Change 32686 solved it that way : */
607 ret = vmg_cb_call1e(SV2MGWIZ(wiz)->cb_free, sv, mg->mg_obj);
609 /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
610 * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
613 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
614 * mg->mg_ptr reference count */
619 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
620 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
629 if (keylen == HEf_SVKEY) {
632 keysv = newSVpvn(key, keylen);
635 ret = vmg_cb_call3(SV2MGWIZ(mg->mg_ptr)->cb_copy, sv, mg->mg_obj, keysv, nsv);
637 if (keylen != HEf_SVKEY) {
643 #endif /* MGf_COPY */
646 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
652 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
653 return vmg_cb_call1(SV2MGWIZ(mg->mg_ptr)->cb_local, nsv, mg->mg_obj);
655 #endif /* MGf_LOCAL */
658 STATIC OP *vmg_pp_resetuvar(pTHX) {
659 SvRMAGICAL_on(cSVOP_sv);
663 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
666 SV *key = NULL, *newkey = NULL;
669 umg = mg_find(sv, PERL_MAGIC_uvar);
670 /* umg can't be NULL or we wouldn't be there. */
672 uf = (struct ufuncs *) umg->mg_ptr;
674 if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
675 if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
677 action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
678 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
680 switch (mg->mg_type) {
683 case PERL_MAGIC_tied:
689 if (mg->mg_private < SIG_MIN || mg->mg_private > SIG_MAX)
691 w = SV2MGWIZ(mg->mg_ptr);
697 newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
701 if (w->cb_fetch) { vmg_cb_call2(w->cb_fetch, sv, mg->mg_obj, key); }
703 case HV_FETCH_ISSTORE:
704 case HV_FETCH_LVALUE:
705 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
706 if (w->cb_store) { vmg_cb_call2(w->cb_store, sv, mg->mg_obj, key); }
708 case HV_FETCH_ISEXISTS:
709 if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
712 if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
717 if (SvRMAGICAL(sv) && !tied) {
718 /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
719 * mistaken for a tied hash by the rest of hv_common. It will be reset by
720 * the op_ppaddr of a new fake op injected between the current and the next
723 if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
725 NewOp(1101, svop, 1, SVOP);
726 svop->op_type = OP_STUB;
727 svop->op_ppaddr = vmg_pp_resetuvar;
728 svop->op_next = o->op_next;
731 o->op_next = (OP *) svop;
738 #endif /* VMG_UVAR */
740 /* ... Wizard destructor ................................................... */
742 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
746 if (PL_dirty) /* During global destruction, the context is already freed */
751 if (w->owner != aTHX)
754 #endif /* VMG_MULTIPLICITY */
758 if (hv_delete(MY_CXT, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
761 SvFLAGS(wiz) |= SVf_BREAK;
764 if (w->cb_data != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
765 if (w->cb_get != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
766 if (w->cb_set != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
767 if (w->cb_len != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
768 if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
769 if (w->cb_free != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
771 if (w->cb_copy != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
772 #endif /* MGf_COPY */
774 if (w->cb_dup != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
777 if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
778 #endif /* MGf_LOCAL */
780 if (w->cb_fetch != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
781 if (w->cb_store != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
782 if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
783 if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
784 #endif /* VMG_UVAR */
792 STATIC MGVTBL vmg_wizard_vtbl = {
797 vmg_wizard_free, /* free */
800 #endif /* MGf_COPY */
806 #endif /* MGf_LOCAL */
809 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
810 STATIC const char vmg_invalid_sig[] = "Invalid numeric signature";
811 STATIC const char vmg_wrongargnum[] = "Wrong number of arguments";
812 STATIC const char vmg_toomanysigs[] = "Too many magic signatures used";
813 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
815 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
816 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
821 } else if (SvNOK(sv)) {
823 } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
826 croak(vmg_invalid_sig);
828 if (sig < SIG_MIN) { sig += SIG_MIN; }
829 if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
834 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
835 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
840 sig = SV2MGWIZ(SvRV(wiz))->sig;
841 } else if (SvOK(wiz)) {
842 sig = vmg_sv2sig(wiz);
844 croak(vmg_invalid_wiz);
849 if (!hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
855 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
856 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
864 if (SV2MGWIZ(wiz)->owner == aTHX)
866 #endif /* VMG_MULTIPLICITY */
867 sig = SV2MGWIZ(wiz)->sig;
868 } else if (SvOK(wiz)) {
869 sig = vmg_sv2sig(wiz);
871 croak(vmg_invalid_wiz);
876 return (old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
881 #define VMG_SET_CB(S, N) \
883 w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
885 #define VMG_SET_SVT_CB(S, N) \
887 if (SvOK(cb) && SvROK(cb)) { \
888 t->svt_ ## N = vmg_svt_ ## N; \
889 w->cb_ ## N = newRV_inc(SvRV(cb)); \
891 t->svt_ ## N = NULL; \
892 w->cb_ ## N = NULL; \
897 #define VMG_CLONE_CB(N) \
898 z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
902 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
903 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
908 Copy(w->vtbl, t, 1, MGVTBL);
919 #endif /* MGf_COPY */
925 #endif /* MGf_LOCAL */
929 VMG_CLONE_CB(exists);
930 VMG_CLONE_CB(delete);
931 #endif /* VMG_UVAR */
940 #endif /* VMG_THREADSAFE */
942 /* --- XS ------------------------------------------------------------------ */
944 MODULE = Variable::Magic PACKAGE = Variable::Magic
953 hv_iterinit(MY_CXT); /* Allocate iterator */
954 stash = gv_stashpv(__PACKAGE__, 1);
955 newCONSTSUB(stash, "SIG_MIN", newSVuv(SIG_MIN));
956 newCONSTSUB(stash, "SIG_MAX", newSVuv(SIG_MAX));
957 newCONSTSUB(stash, "SIG_NBR", newSVuv(SIG_NBR));
958 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
959 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
960 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
961 newCONSTSUB(stash, "VMG_UVAR", newSVuv(VMG_UVAR));
962 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
963 newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
964 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
965 newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
966 newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
967 newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
968 newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
969 newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
970 newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
971 newCONSTSUB(stash, "VMG_THREADSAFE", newSVuv(VMG_THREADSAFE));
986 hv_iterinit(hv); /* Allocate iterator */
988 while ((key = hv_iternext(MY_CXT))) {
990 char *sig = HePV(key, len);
993 sv = MGWIZ2SV(vmg_wizard_clone(SV2MGWIZ(HeVAL(key))));
994 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
995 mg->mg_private = SIG_WIZ;
997 hv_store(hv, sig, len, sv, HeHASH(key));
1005 #endif /* VMG_THREADSAFE */
1025 #endif /* MGf_COPY */
1028 #endif /* MGf_DUP */
1031 #endif /* MGf_LOCAL */
1034 #endif /* VMG_UVAR */
1035 ) { croak(vmg_wrongargnum); }
1040 sig = vmg_sv2sig(svsig);
1041 if ((old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))) {
1042 ST(0) = sv_2mortal(newRV_inc(*old));
1046 if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1053 VMG_SET_CB(ST(i++), data);
1054 VMG_SET_SVT_CB(ST(i++), get);
1055 VMG_SET_SVT_CB(ST(i++), set);
1056 VMG_SET_SVT_CB(ST(i++), len);
1057 VMG_SET_SVT_CB(ST(i++), clear);
1058 VMG_SET_SVT_CB(ST(i++), free);
1060 VMG_SET_SVT_CB(ST(i++), copy);
1061 #endif /* MGf_COPY */
1063 /* VMG_SET_SVT_CB(ST(i++), dup); */
1067 #endif /* MGf_DUP */
1069 VMG_SET_SVT_CB(ST(i++), local);
1070 #endif /* MGf_LOCAL */
1072 VMG_SET_CB(ST(i++), fetch);
1073 VMG_SET_CB(ST(i++), store);
1074 VMG_SET_CB(ST(i++), exists);
1075 VMG_SET_CB(ST(i++), delete);
1077 if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1078 w->uvar = SvTRUE(cb) ? 2 : 1;
1081 #endif /* VMG_UVAR */
1082 #if VMG_MULTIPLICITY
1084 #endif /* VMG_MULTIPLICITY */
1089 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1090 mg->mg_private = SIG_WIZ;
1093 hv_store(MY_CXT, buf, sprintf(buf, "%u", sig), sv, 0);
1095 RETVAL = newRV_noinc(sv);
1103 if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1104 RETVAL = newSVuv(vmg_gensig());
1111 if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1112 RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1116 SV *cast(SV *sv, SV *wiz, ...)
1117 PROTOTYPE: \[$@%&*]$@
1122 wiz = vmg_wizard_wiz(wiz);
1128 av_fill(args, items - 2);
1129 for (i = 2; i < items; ++i) {
1132 if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1135 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1141 SV *getdata(SV *sv, SV *wiz)
1142 PROTOTYPE: \[$@%&*]$
1147 sig = vmg_wizard_sig(wiz);
1150 data = vmg_data_get(SvRV(sv), sig);
1151 if (!data) { XSRETURN_UNDEF; }
1155 SV *dispell(SV *sv, SV *wiz)
1156 PROTOTYPE: \[$@%&*]$
1160 sig = vmg_wizard_sig(wiz);
1163 RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));