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