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