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