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