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