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