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