Magic.xs

   1 /* This file is part of the Variable::Magic Perl module.
   2  * See http://search.cpan.org/dist/Variable-Magic/ */
   3
   4 #include <stdio.h>  /* sprintf() */
   5
   6 #define PERL_NO_GET_CONTEXT
   7 #include "EXTERN.h"
   8 #include "perl.h"
   9 #include "XSUB.h"
  10
  11 #define __PACKAGE__ "Variable::Magic"
  12
  13 #define R(S) fprintf(stderr, "R(" #S ") = %d\n", SvREFCNT(S))
  14
  15 #define PERL_VERSION_GE(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
  16
  17 #define PERL_VERSION_LE(R, V, S) (PERL_REVISION < (R) || (PERL_REVISION == (R) && (PERL_VERSION < (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION <= (S))))))
  18
  19 #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))))))
  20
  21 #define PERL_API_VERSION_LE(R, V, S) (PERL_API_REVISION < (R) || (PERL_API_REVISION == (R) && (PERL_API_VERSION < (V) || (PERL_API_VERSION == (V) && (PERL_API_SUBVERSION <= (S))))))
  22
  23 #ifndef VMG_PERL_PATCHLEVEL
  24 # ifdef PERL_PATCHNUM
  25 #  define VMG_PERL_PATCHLEVEL PERL_PATCHNUM
  26 # else
  27 #  define VMG_PERL_PATCHLEVEL 0
  28 # endif
  29 #endif
  30
  31 /* --- Compatibility ------------------------------------------------------- */
  32
  33 #ifndef Newx
  34 # define Newx(v, n, c) New(0, v, n, c)
  35 #endif
  36
  37 #ifndef SvMAGIC_set
  38 # define SvMAGIC_set(sv, val) (SvMAGIC(sv) = (val))
  39 #endif
  40
  41 #ifndef dMY_CXT
  42 # define MY_CXT vmg_globaldata
  43 # define dMY_CXT
  44 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
  45 # define MY_CXT_INIT
  46 #endif
  47
  48 #ifndef PERL_MAGIC_ext
  49 # define PERL_MAGIC_ext '~'
  50 #endif
  51
  52 #ifndef MGf_COPY
  53 # define MGf_COPY 0
  54 #endif
  55
  56 #ifndef MGf_DUP
  57 # define MGf_DUP 0
  58 #endif
  59
  60 #ifndef MGf_LOCAL
  61 # define MGf_LOCAL 0
  62 #endif
  63
  64 #if PERL_API_VERSION_GE(5, 10, 0)
  65 # define VMG_UVAR 1
  66 #else
  67 # define VMG_UVAR 0
  68 #endif
  69
  70 #if (VMG_PERL_PATCHLEVEL >= 25854) || PERL_VERSION_GE(5, 9, 3)
  71 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 1
  72 #else
  73 # define VMG_COMPAT_ARRAY_PUSH_NOLEN 0
  74 #endif
  75
  76 /* since 5.9.5 - see #43357 */
  77 #if (VMG_PERL_PATCHLEVEL >= 31473) || PERL_VERSION_GE(5, 9, 5)
  78 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 1
  79 #else
  80 # define VMG_COMPAT_ARRAY_UNDEF_CLEAR 0
  81 #endif
  82
  83 #if VMG_UVAR
  84
  85 /* Bug-free mg_magical - see http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/2008-01/msg00036.html */
  86 STATIC void vmg_mg_magical(pTHX_ SV *sv) {
  87 #define vmg_mg_magical(S) vmg_mg_magical(aTHX_ (S))
  88  const MAGIC* mg;
  89  PERL_UNUSED_CONTEXT;
  90  if ((mg = SvMAGIC(sv))) {
  91   SvRMAGICAL_off(sv);
  92   do {
  93    const MGVTBL* const vtbl = mg->mg_virtual;
  94    if (vtbl) {
  95     if (vtbl->svt_get && !(mg->mg_flags & MGf_GSKIP))
  96      SvGMAGICAL_on(sv);
  97     if (vtbl->svt_set)
  98      SvSMAGICAL_on(sv);
  99     if (vtbl->svt_clear)
 100      SvRMAGICAL_on(sv);
 101    }
 102   } while ((mg = mg->mg_moremagic));
 103   if (!(SvFLAGS(sv) & (SVs_GMG|SVs_SMG)))
 104    SvRMAGICAL_on(sv);
 105  }
 106 }
 107
 108 #endif /* VMG_UVAR */
 109
 110 /* --- Context-safe global data -------------------------------------------- */
 111
 112 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
 113
 114 typedef struct {
 115  HV *wizz;
 116  U16 count;
 117 } my_cxt_t;
 118
 119 START_MY_CXT
 120
 121 /* --- Signatures ---------------------------------------------------------- */
 122
 123 #define SIG_MIN ((U16) (1u << 8))
 124 #define SIG_MAX ((U16) ((1u << 16) - 1))
 125 #define SIG_NBR (SIG_MAX - SIG_MIN + 1)
 126 #define SIG_WIZ ((U16) ((1u << 8) - 1))
 127
 128 /* ... Generate signatures ................................................. */
 129
 130 STATIC U16 vmg_gensig(pTHX) {
 131 #define vmg_gensig() vmg_gensig(aTHX)
 132  U16 sig;
 133  char buf[8];
 134  dMY_CXT;
 135
 136  do {
 137   sig = SIG_NBR * Drand01() + SIG_MIN;
 138  } while (hv_exists(MY_CXT.wizz, buf, sprintf(buf, "%u", sig)));
 139
 140  return sig;
 141 }
 142
 143 /* --- MGWIZ structure ----------------------------------------------------- */
 144
 145 typedef struct {
 146  MGVTBL *vtbl;
 147  U16 sig;
 148  U16 uvar;
 149  SV *cb_data;
 150  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 151 #if MGf_COPY
 152  SV *cb_copy;
 153 #endif /* MGf_COPY */
 154 #if MGf_DUP
 155  SV *cb_dup;
 156 #endif /* MGf_DUP */
 157 #if MGf_LOCAL
 158  SV *cb_local;
 159 #endif /* MGf_LOCAL */
 160 #if VMG_UVAR
 161  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 162 #endif /* VMG_UVAR */
 163 } MGWIZ;
 164
 165 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
 166 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
 167
 168 /* ... Construct private data .............................................. */
 169
 170 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
 171 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
 172  SV *nsv;
 173
 174  dSP;
 175  int count;
 176
 177  ENTER;
 178  SAVETMPS;
 179
 180  PUSHMARK(SP);
 181  XPUSHs(sv_2mortal(newRV_inc(sv)));
 182  if (args != NULL) {
 183   I32 i, alen = av_len(args);
 184   for (i = 0; i < alen; ++i) { XPUSHs(*av_fetch(args, i, 0)); }
 185  }
 186  PUTBACK;
 187
 188  count = call_sv(ctor, G_SCALAR);
 189
 190  SPAGAIN;
 191
 192  if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
 193  nsv = POPs;
 194 #if PERL_VERSION_LE(5, 8, 2)
 195  nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
 196 #else
 197  SvREFCNT_inc(nsv);    /* Or it will be destroyed in FREETMPS */
 198 #endif
 199
 200  PUTBACK;
 201
 202  FREETMPS;
 203  LEAVE;
 204
 205  return nsv;
 206 }
 207
 208 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
 209  MAGIC *mg, *moremagic;
 210
 211  if (SvTYPE(sv) >= SVt_PVMG) {
 212   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 213    moremagic = mg->mg_moremagic;
 214    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
 215   }
 216   if (mg) { return mg->mg_obj; }
 217  }
 218
 219  return NULL;
 220 }
 221
 222 /* ... Magic cast/dispell .................................................. */
 223
 224 #if VMG_UVAR
 225 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 226
 227 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 228  if (prevmagic) {
 229   prevmagic->mg_moremagic = moremagic;
 230  } else {
 231   SvMAGIC_set(sv, moremagic);
 232  }
 233  mg->mg_moremagic = NULL;
 234  Safefree(mg->mg_ptr);
 235  Safefree(mg);
 236 }
 237 #endif /* VMG_UVAR */
 238
 239 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
 240 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
 241  MAGIC *mg = NULL, *moremagic = NULL;
 242  MGWIZ *w;
 243  SV *data;
 244
 245  w = SV2MGWIZ(wiz);
 246
 247  if (SvTYPE(sv) >= SVt_PVMG) {
 248   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 249    moremagic = mg->mg_moremagic;
 250    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
 251   }
 252   if (mg) { return 1; }
 253  }
 254
 255  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
 256  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 257  mg->mg_private = w->sig;
 258  mg->mg_flags   = mg->mg_flags
 259 #if MGf_COPY
 260                 | MGf_COPY
 261 #endif /* MGf_COPY */
 262 #if MGf_DUP
 263                 | MGf_DUP
 264 #endif /* MGf_DUP */
 265 #if MGf_LOCAL
 266                 | MGf_LOCAL
 267 #endif /* MGf_LOCAL */
 268                 ;
 269
 270 #if VMG_UVAR
 271  if (w->uvar && SvTYPE(sv) >= SVt_PVHV) {
 272   MAGIC *prevmagic;
 273   int add_uvar = 1;
 274   struct ufuncs uf[2];
 275
 276   uf[0].uf_val   = vmg_svt_val;
 277   uf[0].uf_set   = NULL;
 278   uf[0].uf_index = 0;
 279   uf[1].uf_val   = NULL;
 280   uf[1].uf_set   = NULL;
 281   uf[1].uf_index = 0;
 282
 283   /* One uvar magic in the chain is enough. */
 284   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 285    moremagic = mg->mg_moremagic;
 286    if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 287   }
 288
 289   if (mg) { /* Found another uvar magic. */
 290    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 291    if (olduf->uf_val == vmg_svt_val) {
 292     /* It's our uvar magic, nothing to do. */
 293     add_uvar = 0;
 294    } else {
 295     /* It's another uvar magic, backup it and replace it by ours. */
 296     uf[1] = *olduf;
 297     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 298    }
 299   }
 300
 301   if (add_uvar) {
 302    sv_magic(sv, NULL, PERL_MAGIC_uvar, (const char *) &uf, sizeof(uf));
 303    vmg_mg_magical(sv);
 304   }
 305
 306  }
 307 #endif /* VMG_UVAR */
 308
 309  return 1;
 310 }
 311
 312 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
 313 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
 314 #if VMG_UVAR
 315  U32 uvars = 0;
 316 #endif /* VMG_UVAR */
 317  MAGIC *mg, *prevmagic, *moremagic = NULL;
 318
 319  if (SvTYPE(sv) < SVt_PVMG) { return 0; }
 320
 321  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 322   moremagic = mg->mg_moremagic;
 323   if (mg->mg_type == PERL_MAGIC_ext) {
 324    if (mg->mg_private == sig) {
 325 #if VMG_UVAR
 326     /* If the current has no uvar, short-circuit uvar deletion. */
 327     uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
 328 #endif /* VMG_UVAR */
 329     break;
 330 #if VMG_UVAR
 331    } else if ((mg->mg_private >= SIG_MIN) &&
 332               (mg->mg_private <= SIG_MAX) &&
 333                SV2MGWIZ(mg->mg_ptr)->uvar) {
 334     ++uvars;
 335     /* We can't break here since we need to find the ext magic to delete. */
 336 #endif /* VMG_UVAR */
 337    }
 338   }
 339  }
 340  if (!mg) { return 0; }
 341
 342  if (prevmagic) {
 343   prevmagic->mg_moremagic = moremagic;
 344  } else {
 345   SvMAGIC_set(sv, moremagic);
 346  }
 347  mg->mg_moremagic = NULL;
 348
 349  if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
 350  SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
 351  Safefree(mg);
 352
 353 #if VMG_UVAR
 354  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 355   /* mg was the first ext magic in the chain that had uvar */
 356
 357   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 358    if ((mg->mg_type == PERL_MAGIC_ext) &&
 359        (mg->mg_private >= SIG_MIN) &&
 360        (mg->mg_private <= SIG_MAX) &&
 361         SV2MGWIZ(mg->mg_ptr)->uvar) {
 362     ++uvars;
 363     break;
 364    }
 365   }
 366
 367   if (uvars == 1) {
 368    struct ufuncs *uf;
 369    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 370     moremagic = mg->mg_moremagic;
 371     if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 372    }
 373    /* assert(mg); */
 374    uf = (struct ufuncs *) mg->mg_ptr;
 375    /* assert(uf->uf_val == vmg_svt_val); */
 376    if (uf[1].uf_val || uf[1].uf_set) {
 377     /* Revert the original uvar magic. */
 378     uf[0] = uf[1];
 379     Renew(uf, 1, struct ufuncs);
 380     mg->mg_ptr = (char *) uf;
 381     mg->mg_len = sizeof(struct ufuncs);
 382    } else {
 383     /* Remove the uvar magic. */
 384     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 385    }
 386   }
 387  }
 388 #endif /* VMG_UVAR */
 389
 390  return 1;
 391 }
 392
 393 /* ... svt callbacks ....................................................... */
 394
 395 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data) {
 396 #define vmg_cb_call(I, S, D) vmg_cb_call(aTHX_ (I), (S), (D))
 397  SV *svr;
 398  int ret;
 399
 400  dSP;
 401  int count;
 402
 403  ENTER;
 404  SAVETMPS;
 405
 406  PUSHMARK(SP);
 407  XPUSHs(sv_2mortal(newRV_inc(sv)));
 408  if (data) { XPUSHs(data); }
 409  PUTBACK;
 410
 411  count = call_sv(cb, G_SCALAR);
 412
 413  SPAGAIN;
 414
 415  if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
 416  svr = POPs;
 417  ret = SvOK(svr) ? SvIV(svr) : 0;
 418
 419  PUTBACK;
 420
 421  FREETMPS;
 422  LEAVE;
 423
 424  return ret;
 425 }
 426
 427 #if VMG_UVAR
 428 STATIC int vmg_cb_call2(pTHX_ SV *cb, SV *sv, SV *data, SV *sv2) {
 429 #define vmg_cb_call2(I, S, D, S2) vmg_cb_call2(aTHX_ (I), (S), (D), (S2))
 430  SV *svr;
 431  int ret;
 432
 433  dSP;
 434  int count;
 435
 436  ENTER;
 437  SAVETMPS;
 438
 439  PUSHMARK(SP);
 440  XPUSHs(sv_2mortal(newRV_inc(sv)));
 441  XPUSHs(data ? data : &PL_sv_undef);
 442  if (sv2) { XPUSHs(sv2); }
 443  PUTBACK;
 444
 445  count = call_sv(cb, G_SCALAR);
 446
 447  SPAGAIN;
 448
 449  if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
 450  svr = POPs;
 451  ret = SvOK(svr) ? SvIV(svr) : 0;
 452
 453  PUTBACK;
 454
 455  FREETMPS;
 456  LEAVE;
 457
 458  return ret;
 459 }
 460 #endif /* VMG_UVAR */
 461
 462 #if MGf_COPY
 463 STATIC int vmg_cb_call3(pTHX_ SV *cb, SV *sv, SV *data, SV *sv2, SV *sv3) {
 464 #define vmg_cb_call3(I, S, D, S2, S3) vmg_cb_call3(aTHX_ (I), (S), (D), (S2), (S3))
 465  SV *svr;
 466  int ret;
 467
 468  dSP;
 469  int count;
 470
 471  ENTER;
 472  SAVETMPS;
 473
 474  PUSHMARK(SP);
 475  XPUSHs(sv_2mortal(newRV_inc(sv)));
 476  XPUSHs(data ? data : &PL_sv_undef);
 477  XPUSHs(sv2  ? sv2  : &PL_sv_undef);
 478  if (sv3) { XPUSHs(sv3); }
 479  PUTBACK;
 480
 481  count = call_sv(cb, G_SCALAR);
 482
 483  SPAGAIN;
 484
 485  if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
 486  svr = POPs;
 487  ret = SvOK(svr) ? SvIV(svr) : 0;
 488
 489  PUTBACK;
 490
 491  FREETMPS;
 492  LEAVE;
 493
 494  return ret;
 495 }
 496 #endif /* MGf_COPY */
 497
 498 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 499  return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_get, sv, mg->mg_obj);
 500 }
 501
 502 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 503  return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_set, sv, mg->mg_obj);
 504 }
 505
 506 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 507  SV *svr;
 508  I32 len;
 509  U32 ret;
 510
 511  dSP;
 512  int count;
 513
 514  ENTER;
 515  SAVETMPS;
 516
 517  PUSHMARK(SP);
 518  XPUSHs(sv_2mortal(newRV_inc(sv)));
 519  XPUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 520  if (SvTYPE(sv) == SVt_PVAV) {
 521   len = av_len((AV *) sv) + 1;
 522   XPUSHs(sv_2mortal(newSViv(len)));
 523  }
 524  PUTBACK;
 525
 526  count = call_sv(SV2MGWIZ(mg->mg_ptr)->cb_len, G_SCALAR);
 527
 528  SPAGAIN;
 529
 530  if (count != 1) { croak("Callback needs to return 1 scalar\n"); }
 531  svr = POPs;
 532  ret = SvOK(svr) ? SvUV(svr)
 533                  : ((SvTYPE(sv) == SVt_PVAV) ? len : 1);
 534
 535  PUTBACK;
 536
 537  FREETMPS;
 538  LEAVE;
 539
 540  return ret - 1;
 541 }
 542
 543 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
 544  return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_clear, sv, mg->mg_obj);
 545 }
 546
 547 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
 548  /* So that it can survive tmp cleanup in vmg_cb_call */
 549  SvREFCNT_inc(sv);
 550  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
 551   * mg->mg_ptr reference count */
 552  return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_free, sv, mg->mg_obj);
 553 }
 554
 555 #if MGf_COPY
 556 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
 557 # if PERL_API_VERSION_GE(5, 11, 0)
 558   I32 keylen
 559 # else
 560   int keylen
 561 # endif
 562  ) {
 563  SV *keysv;
 564  int ret;
 565
 566  if (keylen == HEf_SVKEY) {
 567   keysv = (SV *) key;
 568  } else {
 569   keysv = newSVpvn(key, keylen);
 570  }
 571
 572  ret = vmg_cb_call3(SV2MGWIZ(mg->mg_ptr)->cb_copy, sv, mg->mg_obj, keysv, nsv);
 573
 574  if (keylen != HEf_SVKEY) {
 575   SvREFCNT_dec(keysv);
 576  }
 577
 578  return ret;
 579 }
 580 #endif /* MGf_COPY */
 581
 582 #if 0 /*  MGf_DUP */
 583 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
 584  return 0;
 585 }
 586 #endif /* MGf_DUP */
 587
 588 #if MGf_LOCAL
 589 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
 590  return vmg_cb_call(SV2MGWIZ(mg->mg_ptr)->cb_local, nsv, mg->mg_obj);
 591 }
 592 #endif /* MGf_LOCAL */
 593
 594 #if VMG_UVAR
 595 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
 596  struct ufuncs *uf;
 597  MAGIC *mg;
 598  SV *key = NULL;
 599
 600  mg  = mg_find(sv, PERL_MAGIC_uvar);
 601  /* mg can't be NULL or we wouldn't be there. */
 602  key = mg->mg_obj;
 603  uf  = (struct ufuncs *) mg->mg_ptr;
 604
 605  if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
 606  if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
 607
 608  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
 609  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 610   MGWIZ *w;
 611   if ((mg->mg_type != PERL_MAGIC_ext)
 612    || (mg->mg_private < SIG_MIN)
 613    || (mg->mg_private > SIG_MAX)) { continue; }
 614   w = SV2MGWIZ(mg->mg_ptr);
 615   if (!w->uvar) { continue; }
 616   switch (action) {
 617    case 0:
 618     if (w->cb_fetch) { vmg_cb_call2(w->cb_fetch, sv, mg->mg_obj, key); }
 619     break;
 620    case HV_FETCH_ISSTORE:
 621    case HV_FETCH_LVALUE:
 622    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 623     if (w->cb_store) { vmg_cb_call2(w->cb_store, sv, mg->mg_obj, key); }
 624     break;
 625    case HV_FETCH_ISEXISTS:
 626     if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
 627     break;
 628    case HV_DELETE:
 629     if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
 630     break;
 631   }
 632  }
 633
 634  return 0;
 635 }
 636 #endif /* VMG_UVAR */
 637
 638 /* ... Wizard destructor ................................................... */
 639
 640 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
 641  char buf[8];
 642  MGWIZ *w;
 643  dMY_CXT;
 644
 645  w = SV2MGWIZ(wiz);
 646
 647  SvREFCNT_inc(wiz); /* Fake survival - it's gonna be deleted anyway */
 648 #if PERL_API_VERSION_GE(5, 9, 5)
 649  SvREFCNT_inc(wiz); /* One more push */
 650 #endif
 651  if (hv_delete(MY_CXT.wizz, buf, sprintf(buf, "%u", w->sig), 0)) {
 652   --MY_CXT.count;
 653  }
 654
 655  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
 656  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
 657  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
 658  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
 659  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
 660  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
 661 #if MGf_COPY
 662  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
 663 #endif /* MGf_COPY */
 664 #if MGf_DUP
 665  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
 666 #endif /* MGf_DUP */
 667 #if MGf_LOCAL
 668  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
 669 #endif /* MGf_LOCAL */
 670 #if VMG_UVAR
 671  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
 672  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
 673  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
 674  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
 675 #endif /* VMG_UVAR */
 676  Safefree(w->vtbl);
 677  Safefree(w);
 678
 679  return 0;
 680 }
 681
 682 STATIC MGVTBL vmg_wizard_vtbl = {
 683  NULL,            /* get */
 684  NULL,            /* set */
 685  NULL,            /* len */
 686  NULL,            /* clear */
 687  vmg_wizard_free, /* free */
 688 #if MGf_COPY
 689  NULL,            /* copy */
 690 #endif /* MGf_COPY */
 691 #if MGf_DUP
 692  NULL,            /* dup */
 693 #endif /* MGf_DUP */
 694 #if MGf_LOCAL
 695  NULL,            /* local */
 696 #endif /* MGf_LOCAL */
 697 };
 698
 699 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 700 STATIC const char vmg_invalid_sv[]     = "Invalid variable";
 701 STATIC const char vmg_invalid_sig[]    = "Invalid numeric signature";
 702 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 703 STATIC const char vmg_toomanysigs[]    = "Too many magic signatures used";
 704 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 705
 706 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
 707 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
 708  U16 sig;
 709
 710  if (SvIOK(sv)) {
 711   sig = SvUVX(sv);
 712  } else if (SvNOK(sv)) {
 713   sig = SvNVX(sv);
 714  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
 715   sig = SvUV(sv);
 716  } else {
 717   croak(vmg_invalid_sig);
 718  }
 719  if (sig < SIG_MIN) { sig += SIG_MIN; }
 720  if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
 721
 722  return sig;
 723 }
 724
 725 #define VMG_SET_CB(S, N)              \
 726  cb = (S);                            \
 727  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
 728
 729 #define VMG_SET_SVT_CB(S, N)          \
 730  cb = (S);                            \
 731  if (SvOK(cb) && SvROK(cb)) {         \
 732   t->svt_ ## N = vmg_svt_ ## N;       \
 733   w->cb_  ## N = newRV_inc(SvRV(cb)); \
 734  } else {                             \
 735   t->svt_ ## N = NULL;                \
 736   w->cb_  ## N = NULL;                \
 737  }
 738
 739
 740 /* --- XS ------------------------------------------------------------------ */
 741
 742 MODULE = Variable::Magic            PACKAGE = Variable::Magic
 743
 744 PROTOTYPES: ENABLE
 745
 746 BOOT:
 747 {
 748  HV *stash;
 749  MY_CXT_INIT;
 750  MY_CXT.wizz = newHV();
 751  MY_CXT.count = 0;
 752  stash = gv_stashpv(__PACKAGE__, 1);
 753  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
 754  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
 755  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
 756  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
 757  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
 758  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
 759  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
 760  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
 761                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
 762  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
 763                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
 764 }
 765
 766 SV *_wizard(...)
 767 PROTOTYPE: DISABLE
 768 PREINIT:
 769  I32 i = 0;
 770  U16 sig;
 771  char buf[8];
 772  MGWIZ *w;
 773  MGVTBL *t;
 774  MAGIC *mg;
 775  SV *sv;
 776  SV *svsig;
 777  SV *cb;
 778 CODE:
 779  dMY_CXT;
 780
 781  if (items != 7
 782 #if MGf_COPY
 783               + 1
 784 #endif /* MGf_COPY */
 785 #if MGf_DUP
 786               + 1
 787 #endif /* MGf_DUP */
 788 #if MGf_LOCAL
 789               + 1
 790 #endif /* MGf_LOCAL */
 791 #if VMG_UVAR
 792               + 4
 793 #endif /* VMG_UVAR */
 794               ) { croak(vmg_wrongargnum); }
 795
 796  svsig = ST(i++);
 797  if (SvOK(svsig)) {
 798   SV **old;
 799   sig = vmg_sv2sig(svsig);
 800   if ((old = hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0))) {
 801    ST(0) = sv_2mortal(newRV_inc(*old));
 802    XSRETURN(1);
 803   }
 804  } else {
 805   if (MY_CXT.count >= SIG_NBR) { croak(vmg_toomanysigs); }
 806   sig = vmg_gensig();
 807  }
 808
 809  Newx(t, 1, MGVTBL);
 810  Newx(w, 1, MGWIZ);
 811
 812  VMG_SET_CB(ST(i++), data);
 813  VMG_SET_SVT_CB(ST(i++), get);
 814  VMG_SET_SVT_CB(ST(i++), set);
 815  VMG_SET_SVT_CB(ST(i++), len);
 816  VMG_SET_SVT_CB(ST(i++), clear);
 817  VMG_SET_SVT_CB(ST(i++), free);
 818 #if MGf_COPY
 819  VMG_SET_SVT_CB(ST(i++), copy);
 820 #endif /* MGf_COPY */
 821 #if MGf_DUP
 822  /* VMG_SET_SVT_CB(ST(i++), dup); */
 823  i++;
 824  t->svt_dup = NULL;
 825  w->cb_dup  = NULL;
 826 #endif /* MGf_DUP */
 827 #if MGf_LOCAL
 828  VMG_SET_SVT_CB(ST(i++), local);
 829 #endif /* MGf_LOCAL */
 830 #if VMG_UVAR
 831  VMG_SET_CB(ST(i++), fetch);
 832  VMG_SET_CB(ST(i++), store);
 833  VMG_SET_CB(ST(i++), exists);
 834  VMG_SET_CB(ST(i++), delete);
 835 #endif /* VMG_UVAR */
 836
 837  w->vtbl = t;
 838  w->sig  = sig;
 839 #if VMG_UVAR
 840  w->uvar = (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete);
 841 #endif /* VMG_UVAR */
 842
 843  sv = MGWIZ2SV(w);
 844  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, -1);
 845  mg->mg_private = SIG_WIZ;
 846
 847  hv_store(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), sv, 0);
 848  ++MY_CXT.count;
 849
 850  RETVAL = newRV_noinc(sv);
 851 OUTPUT:
 852  RETVAL
 853
 854 SV *gensig()
 855 PROTOTYPE:
 856 CODE:
 857  dMY_CXT;
 858  if (MY_CXT.count >= SIG_NBR) { croak(vmg_toomanysigs); }
 859  RETVAL = newSVuv(vmg_gensig());
 860 OUTPUT:
 861  RETVAL
 862
 863 SV *getsig(SV *wiz)
 864 PROTOTYPE: $
 865 CODE:
 866  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
 867  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
 868 OUTPUT:
 869  RETVAL
 870
 871 SV *cast(SV *sv, SV *wiz, ...)
 872 PROTOTYPE: \[$@%&*]$@
 873 PREINIT:
 874  AV *args = NULL;
 875  SV *ret;
 876 CODE:
 877  dMY_CXT;
 878  if (SvROK(wiz)) {
 879   wiz = SvRV(wiz);
 880  } else if (SvOK(wiz)) {
 881   char buf[8];
 882   SV **old;
 883   U16 sig = vmg_sv2sig(wiz);
 884   if ((old = hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0))) {
 885    wiz = *old;
 886   } else {
 887    XSRETURN_UNDEF;
 888   }
 889  } else {
 890   croak(vmg_invalid_sig);
 891  }
 892  if (items > 2) {
 893   I32 i;
 894   args = newAV();
 895   av_fill(args, items - 2);
 896   for (i = 2; i < items; ++i) {
 897    SV *arg = ST(i);
 898    SvREFCNT_inc(arg);
 899    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
 900   }
 901  }
 902  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
 903  SvREFCNT_dec(args);
 904  RETVAL = ret;
 905 OUTPUT:
 906  RETVAL
 907
 908 SV *getdata(SV *sv, SV *wiz)
 909 PROTOTYPE: \[$@%&*]$
 910 PREINIT:
 911  SV *data;
 912  U16 sig;
 913 CODE:
 914  dMY_CXT;
 915  if (SvROK(wiz)) {
 916   sig = SV2MGWIZ(SvRV(wiz))->sig;
 917  } else if (SvOK(wiz)) {
 918   char buf[8];
 919   sig = vmg_sv2sig(wiz);
 920   if (!hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0)) {
 921    XSRETURN_UNDEF;
 922   }
 923  } else {
 924   croak(vmg_invalid_wiz);
 925  }
 926  data = vmg_data_get(SvRV(sv), sig);
 927  if (!data) { XSRETURN_UNDEF; }
 928  ST(0) = data;
 929  XSRETURN(1);
 930
 931 SV *dispell(SV *sv, SV *wiz)
 932 PROTOTYPE: \[$@%&*]$
 933 PREINIT:
 934  U16 sig;
 935 CODE:
 936  dMY_CXT;
 937  if (SvROK(wiz)) {
 938   sig = SV2MGWIZ(SvRV(wiz))->sig;
 939  } else if (SvOK(wiz)) {
 940   char buf[8];
 941   sig = vmg_sv2sig(wiz);
 942   if (!hv_fetch(MY_CXT.wizz, buf, sprintf(buf, "%u", sig), 0)) {
 943    XSRETURN_UNDEF;
 944   }
 945  } else {
 946   croak(vmg_invalid_wiz);
 947  }
 948  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
 949 OUTPUT:
 950  RETVAL