1 /* This file is part of the Variable::Magic Perl module.
2 * See http://search.cpan.org/dist/Variable-Magic/ */
4 #include <stdio.h> /* sprintf() */
6 #define PERL_NO_GET_CONTEXT
11 #define __PACKAGE__ "Variable::Magic"
13 #define R(S) fprintf(stderr, "R(" #S ") = %d\n", SvREFCNT(S))
15 #define PERL_VERSION_LE(R, V, S) (PERL_REVISION < (R) || (PERL_REVISION == (R) && (PERL_VERSION < (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION <= (S))))))
17 #define PERL_API_VERSION_GE(R, V, S) (PERL_API_REVISION > (R) || (PERL_API_REVISION == (R) && (PERL_API_VERSION > (V) || (PERL_API_VERSION == (V) && (PERL_API_SUBVERSION >= (S))))))
19 /* --- Compatibility ------------------------------------------------------- */
22 # define Newx(v, n, c) New(0, v, n, c)
26 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
30 # define MY_CXT vmg_globaldata
32 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
36 #ifndef PERL_MAGIC_ext
37 # define PERL_MAGIC_ext '~'
42 #endif /* !MGf_COPY */
50 #endif /* !MGf_LOCAL */
52 /* --- Context-safe global data -------------------------------------------- */
54 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
63 /* --- Signatures ---------------------------------------------------------- */
65 #define SIG_MIN ((U16) (1u << 8))
66 #define SIG_MAX ((U16) (1u << 16 - 1))
67 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
68 #define SIG_WIZ ((U16) (1u << 8 - 1))
70 /* ... Generate signatures ................................................. */
72 STATIC U16 vmg_gensig(pTHX) {
73 #define vmg_gensig() vmg_gensig(aTHX)
79 sig = SIG_NBR * Drand01() + SIG_MIN;
80 } while (hv_exists(MY_CXT.wizz, buf, sprintf(buf, "%u", sig)));
85 /* --- MGWIZ structure ----------------------------------------------------- */
92 SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
101 #endif /* MGf_LOCAL */
102 SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
105 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
106 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
108 /* ... Construct private data .............................................. */
110 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
111 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
121 XPUSHs(sv_2mortal(newRV_inc(sv)));
123 I32 i, alen = av_len(args);
124 for (i = 0; i < alen; ++i) { XPUSHs(*av_fetch(args, i, 0)); }
128 count = call_sv(ctor, G_SCALAR);
132 if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
134 #if PERL_VERSION_LE(5, 8, 2)
135 nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
137 SvREFCNT_inc(nsv); /* Or it will be destroyed in FREETMPS */
148 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
149 MAGIC *mg, *moremagic;
152 if (SvTYPE(sv) >= SVt_PVMG) {
153 for (mg = SvMAGIC(sv); mg; mg = moremagic) {
154 moremagic = mg->mg_moremagic;
155 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
157 if (mg) { return mg->mg_obj; }
163 /* ... Magic cast/dispell .................................................. */
165 STATIC I32 vmg_uf_val(pTHX_ IV idx, SV *sv);
167 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
168 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
170 MAGIC *mg = NULL, *moremagic = NULL;
176 if ((SvTYPE(sv) >= SVt_PVMG) && (mg = SvMAGIC(sv))) {
177 if (mg->mg_type == PERL_MAGIC_uvar) { has_uvar = 1; }
179 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break;}
180 mg = mg->mg_moremagic;
182 if (mg) { return 1; }
185 if (w->uvar && (SvTYPE(sv) >= SVt_PVHV) && !has_uvar) {
187 uf.uf_val = vmg_uf_val;
190 sv_magicext(sv, NULL, PERL_MAGIC_uvar, &PL_vtbl_uvar, (char *) &uf, sizeof(uf));
193 data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
194 mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (char *) wiz, HEf_SVKEY);
195 mg->mg_private = w->sig;
196 mg->mg_flags = mg->mg_flags
199 #endif /* MGf_COPY */
205 #endif /* MGf_LOCAL */
211 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
212 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
213 MAGIC *mg, *prevmagic, *moremagic = NULL;
216 if (SvTYPE(sv) < SVt_PVMG) { return 0; }
218 for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
219 moremagic = mg->mg_moremagic;
220 if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
222 if (!mg) { return 0; }
225 prevmagic->mg_moremagic = moremagic;
227 SvMAGIC_set(sv, moremagic);
229 mg->mg_moremagic = NULL;
231 if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
232 SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
238 /* ... svt callbacks ....................................................... */
240 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data) {
241 #define vmg_cb_call(I, S, D) vmg_cb_call(aTHX_ (I), (S), (D))
251 XPUSHs(sv_2mortal(newRV_inc(sv)));
252 if (data) { XPUSHs(data); }
255 count = call_sv(cb, G_SCALAR);
259 if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
270 STATIC int vmg_cb_call2(pTHX_ SV *cb, SV *sv, SV *data, SV *extra) {
271 #define vmg_cb_call2(I, S, D, E) vmg_cb_call2(aTHX_ (I), (S), (D), (E))
281 XPUSHs(sv_2mortal(newRV_inc(sv)));
282 XPUSHs(data ? data : &PL_sv_undef);
283 if (extra) { XPUSHs(extra); }
286 count = call_sv(cb, G_SCALAR);
290 if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
301 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
302 return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_get, sv, mg->mg_obj);
305 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
306 return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_set, sv, mg->mg_obj);
309 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
319 XPUSHs(sv_2mortal(newRV_inc(sv)));
320 XPUSHs((mg->mg_obj) ? (mg->mg_obj) : &PL_sv_undef);
321 if (SvTYPE(sv) == SVt_PVAV) {
322 XPUSHs(sv_2mortal(newSViv(av_len((AV *) sv) + 1)));
326 count = call_sv(SV2MGWIZ(mg->mg_ptr)->cb_len, G_SCALAR);
330 if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
341 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
342 return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_clear, sv, mg->mg_obj);
345 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
346 /* So that it can survive tmp cleanup in vmg_cb_call */
348 /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
349 * mg->mg_ptr reference count */
350 return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_free, sv, mg->mg_obj);
354 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *name, int namelen) {
355 return vmg_cb_call2(SV2MGWIZ(mg->mg_ptr)->cb_copy, sv, mg->mg_obj, nsv);
357 #endif /* MGf_COPY */
360 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *p) {
366 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
367 return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_local, nsv, mg->mg_obj);
369 #endif /* MGf_LOCAL */
371 STATIC I32 vmg_uf_val(pTHX_ IV idx, SV *sv) {
374 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
375 if (mg->mg_type == PERL_MAGIC_uvar) { key = mg->mg_obj; break; }
377 if (!key) { return 0; }
378 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
380 if ((mg->mg_type != PERL_MAGIC_ext) ||
381 (mg->mg_private < SIG_MIN) || (mg->mg_private > SIG_MAX)) { continue; }
382 w = SV2MGWIZ(mg->mg_ptr);
383 if (!w->uvar) { continue; }
384 switch (idx & (HV_FETCH_ISSTORE|HV_FETCH_ISEXISTS|HV_FETCH_LVALUE|HV_DELETE)){
386 if (w->cb_fetch) { return vmg_cb_call2(w->cb_fetch, sv, mg->mg_obj, key); }
388 case HV_FETCH_ISSTORE:
389 case HV_FETCH_LVALUE:
390 case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
391 if (w->cb_store) { return vmg_cb_call2(w->cb_store, sv, mg->mg_obj, key); }
393 case HV_FETCH_ISEXISTS:
394 if (w->cb_exists) { return vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key);}
397 if (w->cb_delete) { return vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key);}
404 /* ... Wizard destructor ................................................... */
406 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
413 SvREFCNT_inc(wiz); /* Fake survival - it's gonna be deleted anyway */
414 #if PERL_API_VERSION_GE(5, 9, 5)
415 SvREFCNT_inc(wiz); /* One more push */
417 if (hv_delete(MY_CXT.wizz, buf, sprintf(buf, "%u", w->sig), 0)) {
421 if (w->cb_data != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
422 if (w->cb_get != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
423 if (w->cb_set != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
424 if (w->cb_len != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
425 if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
426 if (w->cb_free != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
428 if (w->cb_copy != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
429 #endif /* MGf_COPY */
431 if (w->cb_dup != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
434 if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
435 #endif /* MGf_LOCAL */
436 if (w->cb_fetch != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
437 if (w->cb_store != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
438 if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
439 if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
446 STATIC MGVTBL vmg_wizard_vtbl = {
451 vmg_wizard_free, /* free */
454 #endif /* MGf_COPY */
460 #endif /* MGf_LOCAL */
463 /* --- Error messages and misc helpers ------------------------------------- */
465 STATIC const char vmg__wizard_args[] = "_wizard() called with a wrong number of arguments - use wizard() instead";
466 STATIC const char vmg_invalid_wiz[] = "Invalid wizard object";
467 STATIC const char vmg_invalid_sv[] = "Invalid variable";
468 STATIC const char vmg_invalid_sig[] = "Invalid numeric signature";
469 STATIC const char vmg_toomanysigs[] = "Too many magic signatures used";
470 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
472 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
473 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
478 } else if (SvNOK(sv)) {
480 } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
483 croak(vmg_invalid_sig);
485 if (sig < SIG_MIN) { sig += SIG_MIN; }
486 if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
491 #define VMG_SET_CB(T, M, CB) \
493 (M)->cb_##T = (SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
495 #define VMG_SET_CB_SVT(T, V, M, CB) \
498 (V)->svt_##T = vmg_svt_##T; (M)->cb_##T = newRV_inc(SvRV(cb)); \
500 (V)->svt_##T = NULL; (M)->cb_##T = NULL; \
503 /* --- XS ------------------------------------------------------------------ */
505 MODULE = Variable::Magic PACKAGE = Variable::Magic
513 MY_CXT.wizz = newHV();
515 stash = gv_stashpv(__PACKAGE__, 1);
516 newCONSTSUB(stash, "SIG_MIN", newSVuv(SIG_MIN));
517 newCONSTSUB(stash, "SIG_MAX", newSVuv(SIG_MAX));
518 newCONSTSUB(stash, "SIG_NBR", newSVuv(SIG_NBR));
519 newCONSTSUB(stash, "MGf_COPY", newSVuv(MGf_COPY));
520 newCONSTSUB(stash, "MGf_DUP", newSVuv(MGf_DUP));
521 newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
524 SV *_wizard(SV *svsig, ...)
537 if (items != 14) { croak(vmg__wizard_args); }
541 sig = vmg_sv2sig(svsig);
542 if (old = hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0)) {
543 ST(0) = sv_2mortal(newRV_inc(*old));
547 if (MY_CXT.count >= SIG_NBR) { croak(vmg_toomanysigs); }
556 VMG_SET_CB(data, w, ST(1));
557 VMG_SET_CB_SVT(get, t, w, ST(2));
558 VMG_SET_CB_SVT(set, t, w, ST(3));
559 VMG_SET_CB_SVT(len, t, w, ST(4));
560 VMG_SET_CB_SVT(clear, t, w, ST(5));
561 VMG_SET_CB_SVT(free, t, w, ST(6));
563 VMG_SET_CB_SVT(copy, t, w, ST(7));
564 #endif /* MGf_COPY */
566 VMG_SET_CB_SVT(dup, t, w, ST(8));
569 VMG_SET_CB_SVT(local, t, w, ST(9));
570 #endif /* MGf_LOCAL */
571 VMG_SET_CB(fetch, w, ST(10));
572 VMG_SET_CB(store, w, ST(11));
573 VMG_SET_CB(exists, w, ST(12));
574 VMG_SET_CB(delete, w, ST(13));
576 w->uvar = (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete);
579 mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, -1);
580 mg->mg_private = SIG_WIZ;
582 if (t->svt_copy) { mg->mg_flags |= MGf_COPY; }
583 #endif /* MGf_COPY */
585 if (t->svt_dup) { mg->mg_flags |= MGf_DUP; }
588 if (t->svt_local) { mg->mg_flags |= MGf_LOCAL; }
589 #endif /* MGf_LOCAL */
591 hv_store(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), sv, 0);
594 RETVAL = newRV_noinc(sv);
602 if (MY_CXT.count >= SIG_NBR) { croak(vmg_toomanysigs); }
603 RETVAL = newSVuv(vmg_gensig());
610 if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
611 RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
615 SV *cast(SV *sv, SV *wiz, ...)
616 PROTOTYPE: \[$@%&*]$@
624 } else if (SvOK(wiz)) {
627 U16 sig = vmg_sv2sig(wiz);
628 if (old = hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0)) {
634 croak(vmg_invalid_sig);
639 av_fill(args, items - 2);
640 for (i = 2; i < items; ++i) {
643 if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
646 ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
652 SV *getdata(SV *sv, SV *wiz)
660 sig = SV2MGWIZ(SvRV(wiz))->sig;
661 } else if (SvOK(wiz)) {
663 sig = vmg_sv2sig(wiz);
664 if (!hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0)) {
668 croak(vmg_invalid_wiz);
670 data = vmg_data_get(SvRV(sv), sig);
671 if (!data) { XSRETURN_UNDEF; }
672 ST(0) = newSVsv(data);
675 SV *dispell(SV *sv, SV *wiz)
682 sig = SV2MGWIZ(SvRV(wiz))->sig;
683 } else if (SvOK(wiz)) {
685 sig = vmg_sv2sig(wiz);
686 if (!hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0)) {
690 croak(vmg_invalid_wiz);
692 RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));