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