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 mPUSHu
 101 # define mPUSHu(U) PUSHs(sv_2mortal(newSVuv(U)))
 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
 233  U16 sig;
 234  U8 uvar;
 235  U8 opinfo;
 236
 237  SV *cb_data;
 238  SV *cb_get, *cb_set, *cb_len, *cb_clear, *cb_free;
 239 #if MGf_COPY
 240  SV *cb_copy;
 241 #endif /* MGf_COPY */
 242 #if MGf_DUP
 243  SV *cb_dup;
 244 #endif /* MGf_DUP */
 245 #if MGf_LOCAL
 246  SV *cb_local;
 247 #endif /* MGf_LOCAL */
 248 #if VMG_UVAR
 249  SV *cb_fetch, *cb_store, *cb_exists, *cb_delete;
 250 #endif /* VMG_UVAR */
 251 #if VMG_MULTIPLICITY
 252  tTHX owner;
 253 #endif /* VMG_MULTIPLICITY */
 254 } MGWIZ;
 255
 256 #define MGWIZ2SV(W) (newSVuv(PTR2UV(W)))
 257 #define SV2MGWIZ(S) (INT2PTR(MGWIZ*, SvUVX((SV *) (S))))
 258
 259 /* ... Construct private data .............................................. */
 260
 261 STATIC SV *vmg_data_new(pTHX_ SV *ctor, SV *sv, AV *args) {
 262 #define vmg_data_new(C, S, A) vmg_data_new(aTHX_ (C), (S), (A))
 263  SV *nsv;
 264  I32 i, alen = (args == NULL) ? 0 : av_len(args);
 265
 266  dSP;
 267
 268  ENTER;
 269  SAVETMPS;
 270
 271  PUSHMARK(SP);
 272  EXTEND(SP, alen + 1);
 273  PUSHs(sv_2mortal(newRV_inc(sv)));
 274  for (i = 0; i < alen; ++i)
 275   PUSHs(*av_fetch(args, i, 0));
 276  PUTBACK;
 277
 278  call_sv(ctor, G_SCALAR);
 279
 280  SPAGAIN;
 281  nsv = POPs;
 282 #if VMG_HAS_PERL(5, 8, 3)
 283  SvREFCNT_inc(nsv);    /* Or it will be destroyed in FREETMPS */
 284 #else
 285  nsv = sv_newref(nsv); /* Workaround some bug in SvREFCNT_inc() */
 286 #endif
 287  PUTBACK;
 288
 289  FREETMPS;
 290  LEAVE;
 291
 292  return nsv;
 293 }
 294
 295 STATIC SV *vmg_data_get(SV *sv, U16 sig) {
 296  MAGIC *mg, *moremagic;
 297
 298  if (SvTYPE(sv) >= SVt_PVMG) {
 299   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 300    moremagic = mg->mg_moremagic;
 301    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == sig)) { break; }
 302   }
 303   if (mg) { return mg->mg_obj; }
 304  }
 305
 306  return NULL;
 307 }
 308
 309 /* ... Magic cast/dispell .................................................. */
 310
 311 #if VMG_UVAR
 312 STATIC I32 vmg_svt_val(pTHX_ IV, SV *);
 313
 314 STATIC void vmg_uvar_del(SV *sv, MAGIC *prevmagic, MAGIC *mg, MAGIC *moremagic) {
 315  if (prevmagic) {
 316   prevmagic->mg_moremagic = moremagic;
 317  } else {
 318   SvMAGIC_set(sv, moremagic);
 319  }
 320  mg->mg_moremagic = NULL;
 321  Safefree(mg->mg_ptr);
 322  Safefree(mg);
 323 }
 324 #endif /* VMG_UVAR */
 325
 326 STATIC UV vmg_cast(pTHX_ SV *sv, SV *wiz, AV *args) {
 327 #define vmg_cast(S, W, A) vmg_cast(aTHX_ (S), (W), (A))
 328  MAGIC *mg = NULL, *moremagic = NULL;
 329  MGWIZ *w;
 330  SV *data;
 331  U32 oldgmg = SvGMAGICAL(sv);
 332
 333  w = SV2MGWIZ(wiz);
 334
 335  if (SvTYPE(sv) >= SVt_PVMG) {
 336   for (mg = SvMAGIC(sv); mg; mg = moremagic) {
 337    moremagic = mg->mg_moremagic;
 338    if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_private == w->sig)) { break; }
 339   }
 340   if (mg) { return 1; }
 341  }
 342
 343  data = (w->cb_data) ? vmg_data_new(w->cb_data, sv, args) : NULL;
 344  mg = sv_magicext(sv, data, PERL_MAGIC_ext, w->vtbl, (const char *) wiz, HEf_SVKEY);
 345  mg->mg_private = w->sig;
 346 #if MGf_COPY
 347  if (w->cb_copy)
 348   mg->mg_flags |= MGf_COPY;
 349 #endif /* MGf_COPY */
 350 #if 0 /* MGf_DUP */
 351  if (w->cb_dup)
 352   mg->mg_flags |= MGf_DUP;
 353 #endif /* MGf_DUP */
 354 #if MGf_LOCAL
 355  if (w->cb_local)
 356   mg->mg_flags |= MGf_LOCAL;
 357 #endif /* MGf_LOCAL */
 358
 359  if (SvTYPE(sv) < SVt_PVHV)
 360   goto done;
 361
 362  /* The GMAGICAL flag only says that a hash is tied or has uvar magic - get
 363   * magic is actually never called for them. If the GMAGICAL flag was off before
 364   * calling sv_magicext(), the hash isn't tied and has no uvar magic. If it's
 365   * now on, then this wizard has get magic. Hence we can work around the
 366   * get/clear shortcoming by turning the GMAGICAL flag off. If the current magic
 367   * has uvar callbacks, it will be turned back on later. */
 368  if (!oldgmg && SvGMAGICAL(sv))
 369   SvGMAGICAL_off(sv);
 370
 371 #if VMG_UVAR
 372  if (w->uvar) {
 373   MAGIC *prevmagic;
 374   struct ufuncs uf[2];
 375
 376   uf[0].uf_val   = vmg_svt_val;
 377   uf[0].uf_set   = NULL;
 378   uf[0].uf_index = 0;
 379   uf[1].uf_val   = NULL;
 380   uf[1].uf_set   = NULL;
 381   uf[1].uf_index = 0;
 382
 383   /* One uvar magic in the chain is enough. */
 384   for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 385    moremagic = mg->mg_moremagic;
 386    if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 387   }
 388
 389   if (mg) { /* Found another uvar magic. */
 390    struct ufuncs *olduf = (struct ufuncs *) mg->mg_ptr;
 391    if (olduf->uf_val == vmg_svt_val) {
 392     /* It's our uvar magic, nothing to do. oldgmg was true. */
 393     goto done;
 394    } else {
 395     /* It's another uvar magic, backup it and replace it by ours. */
 396     uf[1] = *olduf;
 397     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 398    }
 399   }
 400
 401   vmg_sv_magicuvar(sv, (const char *) &uf, sizeof(uf));
 402   /* Our hash now carries uvar magic. The uvar/clear shortcoming has to be
 403    * handled by our uvar callback. */
 404  }
 405 #endif /* VMG_UVAR */
 406
 407 done:
 408  return 1;
 409 }
 410
 411 STATIC UV vmg_dispell(pTHX_ SV *sv, U16 sig) {
 412 #define vmg_dispell(S, Z) vmg_dispell(aTHX_ (S), (Z))
 413 #if VMG_UVAR
 414  U32 uvars = 0;
 415 #endif /* VMG_UVAR */
 416  MAGIC *mg, *prevmagic, *moremagic = NULL;
 417
 418  if (SvTYPE(sv) < SVt_PVMG) { return 0; }
 419
 420  for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic) {
 421   moremagic = mg->mg_moremagic;
 422   if (mg->mg_type == PERL_MAGIC_ext) {
 423    if (mg->mg_private == sig) {
 424 #if VMG_UVAR
 425     /* If the current has no uvar, short-circuit uvar deletion. */
 426     uvars = (SV2MGWIZ(mg->mg_ptr)->uvar) ? (uvars + 1) : 0;
 427 #endif /* VMG_UVAR */
 428     break;
 429 #if VMG_UVAR
 430    } else if ((mg->mg_private >= SIG_MIN) &&
 431               (mg->mg_private <= SIG_MAX) &&
 432                SV2MGWIZ(mg->mg_ptr)->uvar) {
 433     ++uvars;
 434     /* We can't break here since we need to find the ext magic to delete. */
 435 #endif /* VMG_UVAR */
 436    }
 437   }
 438  }
 439  if (!mg) { return 0; }
 440
 441  if (prevmagic) {
 442   prevmagic->mg_moremagic = moremagic;
 443  } else {
 444   SvMAGIC_set(sv, moremagic);
 445  }
 446  mg->mg_moremagic = NULL;
 447
 448  if (mg->mg_obj != sv) { SvREFCNT_dec(mg->mg_obj); } /* Destroy private data */
 449  SvREFCNT_dec((SV *) mg->mg_ptr); /* Unreference the wizard */
 450  Safefree(mg);
 451
 452 #if VMG_UVAR
 453  if (uvars == 1 && SvTYPE(sv) >= SVt_PVHV) {
 454   /* mg was the first ext magic in the chain that had uvar */
 455
 456   for (mg = moremagic; mg; mg = mg->mg_moremagic) {
 457    if ((mg->mg_type == PERL_MAGIC_ext) &&
 458        (mg->mg_private >= SIG_MIN) &&
 459        (mg->mg_private <= SIG_MAX) &&
 460         SV2MGWIZ(mg->mg_ptr)->uvar) {
 461     ++uvars;
 462     break;
 463    }
 464   }
 465
 466   if (uvars == 1) {
 467    struct ufuncs *uf;
 468    for (prevmagic = NULL, mg = SvMAGIC(sv); mg; prevmagic = mg, mg = moremagic){
 469     moremagic = mg->mg_moremagic;
 470     if (mg->mg_type == PERL_MAGIC_uvar) { break; }
 471    }
 472    /* assert(mg); */
 473    uf = (struct ufuncs *) mg->mg_ptr;
 474    /* assert(uf->uf_val == vmg_svt_val); */
 475    if (uf[1].uf_val || uf[1].uf_set) {
 476     /* Revert the original uvar magic. */
 477     uf[0] = uf[1];
 478     Renew(uf, 1, struct ufuncs);
 479     mg->mg_ptr = (char *) uf;
 480     mg->mg_len = sizeof(struct ufuncs);
 481    } else {
 482     /* Remove the uvar magic. */
 483     vmg_uvar_del(sv, prevmagic, mg, moremagic);
 484    }
 485   }
 486  }
 487 #endif /* VMG_UVAR */
 488
 489  return 1;
 490 }
 491
 492 /* ... OP info ............................................................. */
 493
 494 #define VMG_OP_INFO_NAME   1
 495 #define VMG_OP_INFO_OBJECT 2
 496
 497 STATIC STRLEN *vmg_op_name_len = NULL;
 498
 499 STATIC HV *vmg_b__op_stash = NULL;
 500
 501 STATIC void vmg_op_info_init(pTHX_ unsigned int opinfo) {
 502 #define vmg_op_info_init(W) vmg_op_info_init(aTHX_ (W))
 503  switch (opinfo) {
 504   case VMG_OP_INFO_NAME:
 505    if (!vmg_op_name_len) {
 506     OPCODE t;
 507     Newx(vmg_op_name_len, MAXO, STRLEN);
 508     for (t = 0; t < OP_max; ++t)
 509      vmg_op_name_len[t] = strlen(PL_op_name[t]);
 510    }
 511    break;
 512   case VMG_OP_INFO_OBJECT:
 513    if (!vmg_b__op_stash) {
 514     require_pv("B.pm");
 515     vmg_b__op_stash = gv_stashpv("B::OP", 1);
 516    }
 517    break;
 518   default:
 519    break;
 520  }
 521 }
 522
 523 STATIC SV *vmg_op_info(pTHX_ unsigned int opinfo) {
 524 #define vmg_op_info(W) vmg_op_info(aTHX_ (W))
 525  if (!PL_op)
 526   return &PL_sv_undef;
 527
 528  switch (opinfo) {
 529   case VMG_OP_INFO_NAME: {
 530    OPCODE t = PL_op->op_type;
 531    return sv_2mortal(newSVpvn(PL_op_name[t], vmg_op_name_len[t]));
 532   }
 533   case VMG_OP_INFO_OBJECT:
 534    return sv_bless(sv_2mortal(newRV_noinc(newSViv(PTR2IV(PL_op)))),
 535                               vmg_b__op_stash);
 536   default:
 537    break;
 538  }
 539
 540  return &PL_sv_undef;
 541 }
 542
 543 /* ... svt callbacks ....................................................... */
 544
 545 #define VMG_CB_CALL_ARGS_MASK  15
 546 #define VMG_CB_CALL_ARGS_SHIFT 4
 547 #define VMG_CB_CALL_OPINFO     (VMG_OP_INFO_NAME|VMG_OP_INFO_OBJECT)
 548 #define VMG_CB_CALL_EVAL       4
 549
 550 STATIC int vmg_cb_call(pTHX_ SV *cb, SV *sv, SV *data, unsigned int flags, ...){
 551  va_list ap;
 552  SV *svr;
 553  int ret;
 554  unsigned int i, args, opinfo, eval;
 555
 556  dSP;
 557
 558  args    = flags & VMG_CB_CALL_ARGS_MASK;
 559  flags >>= VMG_CB_CALL_ARGS_SHIFT;
 560  opinfo  = flags & VMG_CB_CALL_OPINFO;
 561  eval    = flags & VMG_CB_CALL_EVAL ? G_EVAL : 0;
 562
 563  ENTER;
 564  SAVETMPS;
 565
 566  PUSHMARK(SP);
 567  EXTEND(SP, args + 2);
 568  PUSHs(sv_2mortal(newRV_inc(sv)));
 569  PUSHs(data ? data : &PL_sv_undef);
 570  va_start(ap, flags);
 571  for (i = 0; i < args; ++i) {
 572   SV *sva = va_arg(ap, SV *);
 573   PUSHs(sva ? sva : &PL_sv_undef);
 574  }
 575  va_end(ap);
 576  if (opinfo)
 577   XPUSHs(vmg_op_info(opinfo));
 578  PUTBACK;
 579
 580  call_sv(cb, G_SCALAR | eval);
 581
 582  SPAGAIN;
 583  if (eval && IN_PERL_COMPILETIME && SvTRUE(ERRSV))
 584   ++PL_error_count;
 585  svr = POPs;
 586  ret = SvOK(svr) ? SvIV(svr) : 0;
 587  PUTBACK;
 588
 589  FREETMPS;
 590  LEAVE;
 591
 592  return ret;
 593 }
 594
 595 #define vmg_cb_call1(I, S, D) \
 596         vmg_cb_call(aTHX_ (I), (S), (D), (flags << VMG_CB_CALL_ARGS_SHIFT))
 597 #define vmg_cb_call2(I, S, D, S2) \
 598         vmg_cb_call(aTHX_ (I), (S), (D), ((flags << VMG_CB_CALL_ARGS_SHIFT) | 1), (S2))
 599 #define vmg_cb_call3(I, S, D, S2, S3) \
 600         vmg_cb_call(aTHX_ (I), (S), (D), ((flags << VMG_CB_CALL_ARGS_SHIFT) | 2), (S2), (S3))
 601
 602 STATIC int vmg_svt_get(pTHX_ SV *sv, MAGIC *mg) {
 603  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 604  unsigned int flags = w->opinfo;
 605  return vmg_cb_call1(w->cb_get, sv, mg->mg_obj);
 606 }
 607
 608 STATIC int vmg_svt_set(pTHX_ SV *sv, MAGIC *mg) {
 609  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 610  unsigned int flags = w->opinfo;
 611  return vmg_cb_call1(w->cb_set, sv, mg->mg_obj);
 612 }
 613
 614 STATIC U32 vmg_svt_len(pTHX_ SV *sv, MAGIC *mg) {
 615  SV *svr;
 616  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 617  unsigned int opinfo = w->opinfo;
 618  U32 len, ret;
 619  svtype t = SvTYPE(sv);
 620
 621  dSP;
 622
 623  ENTER;
 624  SAVETMPS;
 625
 626  PUSHMARK(SP);
 627  EXTEND(SP, 3);
 628  PUSHs(sv_2mortal(newRV_inc(sv)));
 629  PUSHs(mg->mg_obj ? mg->mg_obj : &PL_sv_undef);
 630  if (t < SVt_PVAV) {
 631   STRLEN l;
 632   U8 *s = (U8 *) SvPV_const(sv, l);
 633   if (DO_UTF8(sv))
 634    len = utf8_length(s, s + l);
 635   else
 636    len = l;
 637   mPUSHu(len);
 638  } else if (t == SVt_PVAV) {
 639   len = av_len((AV *) sv) + 1;
 640   mPUSHu(len);
 641  } else {
 642   len = 0;
 643   PUSHs(&PL_sv_undef);
 644  }
 645  if (opinfo)
 646   XPUSHs(vmg_op_info(opinfo));
 647  PUTBACK;
 648
 649  call_sv(w->cb_len, G_SCALAR);
 650
 651  SPAGAIN;
 652  svr = POPs;
 653  ret = SvOK(svr) ? SvUV(svr) : len;
 654  PUTBACK;
 655
 656  FREETMPS;
 657  LEAVE;
 658
 659  return t == SVt_PVAV ? ret - 1 : ret;
 660 }
 661
 662 STATIC int vmg_svt_clear(pTHX_ SV *sv, MAGIC *mg) {
 663  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 664  unsigned int flags = w->opinfo;
 665  return vmg_cb_call1(w->cb_clear, sv, mg->mg_obj);
 666 }
 667
 668 STATIC int vmg_svt_free(pTHX_ SV *sv, MAGIC *mg) {
 669  SV *wiz = (SV *) mg->mg_ptr;
 670  const MGWIZ *w;
 671  unsigned int flags;
 672  int ret = 0;
 673
 674  /* This may happen in global destruction */
 675  if (SvTYPE(wiz) == SVTYPEMASK)
 676   return 0;
 677
 678  w = SV2MGWIZ(mg->mg_ptr);
 679  flags = w->opinfo | VMG_CB_CALL_EVAL;
 680
 681  /* So that it survives the temp cleanup in vmg_cb_call */
 682  SvREFCNT_inc(sv);
 683
 684 #if !VMG_HAS_PERL_MAINT(5, 11, 0, 32686)
 685  /* The previous magic tokens were freed but the magic chain wasn't updated, so
 686   * if you access the sv from the callback the old deleted magics will trigger
 687   * and cause memory misreads. Change 32686 solved it that way : */
 688  SvMAGIC_set(sv, mg);
 689 #endif
 690
 691  ret = vmg_cb_call1(w->cb_free, sv, mg->mg_obj);
 692
 693  /* Calling SvREFCNT_dec() will trigger destructors in an infinite loop, so
 694   * we have to rely on SvREFCNT() being a lvalue. Heck, even the core does it */
 695  --SvREFCNT(sv);
 696
 697  /* Perl_mg_free will get rid of the magic and decrement mg->mg_obj and
 698   * mg->mg_ptr reference count */
 699  return ret;
 700 }
 701
 702 #if MGf_COPY
 703 STATIC int vmg_svt_copy(pTHX_ SV *sv, MAGIC *mg, SV *nsv, const char *key,
 704 # if VMG_HAS_PERL_MAINT(5, 11, 0, 33256)
 705   I32 keylen
 706 # else
 707   int keylen
 708 # endif
 709  ) {
 710  SV *keysv;
 711  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 712  unsigned int flags = w->opinfo;
 713  int ret;
 714
 715  if (keylen == HEf_SVKEY) {
 716   keysv = (SV *) key;
 717  } else {
 718   keysv = newSVpvn(key, keylen);
 719  }
 720
 721  ret = vmg_cb_call3(w->cb_copy, sv, mg->mg_obj, keysv, nsv);
 722
 723  if (keylen != HEf_SVKEY) {
 724   SvREFCNT_dec(keysv);
 725  }
 726
 727  return ret;
 728 }
 729 #endif /* MGf_COPY */
 730
 731 #if 0 /*  MGf_DUP */
 732 STATIC int vmg_svt_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) {
 733  return 0;
 734 }
 735 #endif /* MGf_DUP */
 736
 737 #if MGf_LOCAL
 738 STATIC int vmg_svt_local(pTHX_ SV *nsv, MAGIC *mg) {
 739  const MGWIZ *w = SV2MGWIZ(mg->mg_ptr);
 740  unsigned int flags = w->opinfo;
 741  return vmg_cb_call1(w->cb_local, nsv, mg->mg_obj);
 742 }
 743 #endif /* MGf_LOCAL */
 744
 745 #if VMG_UVAR
 746 STATIC OP *vmg_pp_resetuvar(pTHX) {
 747  SvRMAGICAL_on(cSVOP_sv);
 748  return NORMAL;
 749 }
 750
 751 STATIC I32 vmg_svt_val(pTHX_ IV action, SV *sv) {
 752  struct ufuncs *uf;
 753  MAGIC *mg, *umg;
 754  SV *key = NULL, *newkey = NULL;
 755  int tied = 0;
 756
 757  umg = mg_find(sv, PERL_MAGIC_uvar);
 758  /* umg can't be NULL or we wouldn't be there. */
 759  key = umg->mg_obj;
 760  uf  = (struct ufuncs *) umg->mg_ptr;
 761
 762  if (uf[1].uf_val != NULL) { uf[1].uf_val(aTHX_ action, sv); }
 763  if (uf[1].uf_set != NULL) { uf[1].uf_set(aTHX_ action, sv); }
 764
 765  action &= HV_FETCH_ISSTORE | HV_FETCH_ISEXISTS | HV_FETCH_LVALUE | HV_DELETE;
 766  for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
 767   const MGWIZ *w;
 768   unsigned int flags;
 769   switch (mg->mg_type) {
 770    case PERL_MAGIC_ext:
 771     break;
 772    case PERL_MAGIC_tied:
 773     ++tied;
 774     continue;
 775    default:
 776     continue;
 777   }
 778   if (mg->mg_private < SIG_MIN || mg->mg_private > SIG_MAX)
 779    continue;
 780   w = SV2MGWIZ(mg->mg_ptr);
 781   flags = w->opinfo;
 782   switch (w->uvar) {
 783    case 0:
 784     continue;
 785    case 2:
 786     if (!newkey)
 787      newkey = key = umg->mg_obj = sv_mortalcopy(umg->mg_obj);
 788   }
 789   switch (action) {
 790    case 0:
 791     if (w->cb_fetch)  { vmg_cb_call2(w->cb_fetch,  sv, mg->mg_obj, key); }
 792     break;
 793    case HV_FETCH_ISSTORE:
 794    case HV_FETCH_LVALUE:
 795    case (HV_FETCH_ISSTORE|HV_FETCH_LVALUE):
 796     if (w->cb_store)  { vmg_cb_call2(w->cb_store,  sv, mg->mg_obj, key); }
 797     break;
 798    case HV_FETCH_ISEXISTS:
 799     if (w->cb_exists) { vmg_cb_call2(w->cb_exists, sv, mg->mg_obj, key); }
 800     break;
 801    case HV_DELETE:
 802     if (w->cb_delete) { vmg_cb_call2(w->cb_delete, sv, mg->mg_obj, key); }
 803     break;
 804   }
 805  }
 806
 807  if (SvRMAGICAL(sv) && !tied) {
 808   /* Temporarily hide the RMAGICAL flag of the hash so it isn't wrongly
 809    * mistaken for a tied hash by the rest of hv_common. It will be reset by
 810    * the op_ppaddr of a new fake op injected between the current and the next
 811    * one. */
 812   OP *o = PL_op;
 813   if (!o->op_next || o->op_next->op_ppaddr != vmg_pp_resetuvar) {
 814    SVOP *svop;
 815    NewOp(1101, svop, 1, SVOP);
 816    svop->op_type   = OP_STUB;
 817    svop->op_ppaddr = vmg_pp_resetuvar;
 818    svop->op_next   = o->op_next;
 819    svop->op_flags  = 0;
 820    svop->op_sv     = sv;
 821    o->op_next      = (OP *) svop;
 822   }
 823   SvRMAGICAL_off(sv);
 824  }
 825
 826  return 0;
 827 }
 828 #endif /* VMG_UVAR */
 829
 830 /* ... Wizard destructor ................................................... */
 831
 832 STATIC int vmg_wizard_free(pTHX_ SV *wiz, MAGIC *mg) {
 833  char buf[8];
 834  MGWIZ *w;
 835
 836  if (PL_dirty) /* During global destruction, the context is already freed */
 837   return 0;
 838
 839  w = SV2MGWIZ(wiz);
 840 #if VMG_MULTIPLICITY
 841  if (w->owner != aTHX)
 842   return 0;
 843  w->owner = NULL;
 844 #endif /* VMG_MULTIPLICITY */
 845
 846  {
 847   dMY_CXT;
 848   if (hv_delete(MY_CXT, buf, sprintf(buf, "%u", w->sig), 0) != wiz)
 849    return 0;
 850  }
 851  SvFLAGS(wiz) |= SVf_BREAK;
 852  FREETMPS;
 853
 854  if (w->cb_data  != NULL) { SvREFCNT_dec(SvRV(w->cb_data)); }
 855  if (w->cb_get   != NULL) { SvREFCNT_dec(SvRV(w->cb_get)); }
 856  if (w->cb_set   != NULL) { SvREFCNT_dec(SvRV(w->cb_set)); }
 857  if (w->cb_len   != NULL) { SvREFCNT_dec(SvRV(w->cb_len)); }
 858  if (w->cb_clear != NULL) { SvREFCNT_dec(SvRV(w->cb_clear)); }
 859  if (w->cb_free  != NULL) { SvREFCNT_dec(SvRV(w->cb_free)); }
 860 #if MGf_COPY
 861  if (w->cb_copy  != NULL) { SvREFCNT_dec(SvRV(w->cb_copy)); }
 862 #endif /* MGf_COPY */
 863 #if 0 /* MGf_DUP */
 864  if (w->cb_dup   != NULL) { SvREFCNT_dec(SvRV(w->cb_dup)); }
 865 #endif /* MGf_DUP */
 866 #if MGf_LOCAL
 867  if (w->cb_local != NULL) { SvREFCNT_dec(SvRV(w->cb_local)); }
 868 #endif /* MGf_LOCAL */
 869 #if VMG_UVAR
 870  if (w->cb_fetch  != NULL) { SvREFCNT_dec(SvRV(w->cb_fetch)); }
 871  if (w->cb_store  != NULL) { SvREFCNT_dec(SvRV(w->cb_store)); }
 872  if (w->cb_exists != NULL) { SvREFCNT_dec(SvRV(w->cb_exists)); }
 873  if (w->cb_delete != NULL) { SvREFCNT_dec(SvRV(w->cb_delete)); }
 874 #endif /* VMG_UVAR */
 875
 876  Safefree(w->vtbl);
 877  Safefree(w);
 878
 879  return 0;
 880 }
 881
 882 STATIC MGVTBL vmg_wizard_vtbl = {
 883  NULL,            /* get */
 884  NULL,            /* set */
 885  NULL,            /* len */
 886  NULL,            /* clear */
 887  vmg_wizard_free, /* free */
 888 #if MGf_COPY
 889  NULL,            /* copy */
 890 #endif /* MGf_COPY */
 891 #if MGf_DUP
 892  NULL,            /* dup */
 893 #endif /* MGf_DUP */
 894 #if MGf_LOCAL
 895  NULL,            /* local */
 896 #endif /* MGf_LOCAL */
 897 };
 898
 899 STATIC const char vmg_invalid_wiz[]    = "Invalid wizard object";
 900 STATIC const char vmg_invalid_sig[]    = "Invalid numeric signature";
 901 STATIC const char vmg_wrongargnum[]    = "Wrong number of arguments";
 902 STATIC const char vmg_toomanysigs[]    = "Too many magic signatures used";
 903 STATIC const char vmg_argstorefailed[] = "Error while storing arguments";
 904
 905 STATIC U16 vmg_sv2sig(pTHX_ SV *sv) {
 906 #define vmg_sv2sig(S) vmg_sv2sig(aTHX_ (S))
 907  U16 sig;
 908
 909  if (SvIOK(sv)) {
 910   sig = SvUVX(sv);
 911  } else if (SvNOK(sv)) {
 912   sig = SvNVX(sv);
 913  } else if ((SvPOK(sv) && grok_number(SvPVX(sv), SvCUR(sv), NULL))) {
 914   sig = SvUV(sv);
 915  } else {
 916   croak(vmg_invalid_sig);
 917  }
 918  if (sig < SIG_MIN) { sig += SIG_MIN; }
 919  if (sig > SIG_MAX) { sig %= SIG_MAX + 1; }
 920
 921  return sig;
 922 }
 923
 924 STATIC U16 vmg_wizard_sig(pTHX_ SV *wiz) {
 925 #define vmg_wizard_sig(W) vmg_wizard_sig(aTHX_ (W))
 926  char buf[8];
 927  U16 sig;
 928
 929  if (SvROK(wiz)) {
 930   sig = SV2MGWIZ(SvRV(wiz))->sig;
 931  } else if (SvOK(wiz)) {
 932   sig = vmg_sv2sig(wiz);
 933  } else {
 934   croak(vmg_invalid_wiz);
 935  }
 936
 937  {
 938   dMY_CXT;
 939   if (!hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
 940    sig = 0;
 941  }
 942  return sig;
 943 }
 944
 945 STATIC SV *vmg_wizard_wiz(pTHX_ SV *wiz) {
 946 #define vmg_wizard_wiz(W) vmg_wizard_wiz(aTHX_ (W))
 947  char buf[8];
 948  SV **old;
 949  U16 sig;
 950
 951  if (SvROK(wiz)) {
 952   wiz = SvRV(wiz);
 953 #if VMG_MULTIPLICITY
 954   if (SV2MGWIZ(wiz)->owner == aTHX)
 955    return wiz;
 956 #endif /* VMG_MULTIPLICITY */
 957   sig = SV2MGWIZ(wiz)->sig;
 958  } else if (SvOK(wiz)) {
 959   sig = vmg_sv2sig(wiz);
 960  } else {
 961   croak(vmg_invalid_wiz);
 962  }
 963
 964  {
 965   dMY_CXT;
 966   return (old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))
 967           ? *old : NULL;
 968  }
 969 }
 970
 971 #define VMG_SET_CB(S, N)              \
 972  cb = (S);                            \
 973  w->cb_ ## N = (SvOK(cb) && SvROK(cb)) ? newRV_inc(SvRV(cb)) : NULL;
 974
 975 #define VMG_SET_SVT_CB(S, N)          \
 976  cb = (S);                            \
 977  if (SvOK(cb) && SvROK(cb)) {         \
 978   t->svt_ ## N = vmg_svt_ ## N;       \
 979   w->cb_  ## N = newRV_inc(SvRV(cb)); \
 980  } else {                             \
 981   t->svt_ ## N = NULL;                \
 982   w->cb_  ## N = NULL;                \
 983  }
 984
 985 #if VMG_THREADSAFE
 986
 987 #define VMG_CLONE_CB(N) \
 988  z->cb_ ## N = (w->cb_ ## N) ? newRV_inc(vmg_clone(SvRV(w->cb_ ## N), \
 989                                          w->owner))                   \
 990                              : NULL;
 991
 992 STATIC MGWIZ *vmg_wizard_clone(pTHX_ const MGWIZ *w) {
 993 #define vmg_wizard_clone(W) vmg_wizard_clone(aTHX_ (W))
 994  MGVTBL *t;
 995  MGWIZ *z;
 996
 997  Newx(t, 1, MGVTBL);
 998  Copy(w->vtbl, t, 1, MGVTBL);
 999
1000  Newx(z, 1, MGWIZ);
1001  VMG_CLONE_CB(data);
1002  VMG_CLONE_CB(get);
1003  VMG_CLONE_CB(set);
1004  VMG_CLONE_CB(len);
1005  VMG_CLONE_CB(clear);
1006  VMG_CLONE_CB(free);
1007 #if MGf_COPY
1008  VMG_CLONE_CB(copy);
1009 #endif /* MGf_COPY */
1010 #if MGf_DUP
1011  VMG_CLONE_CB(dup);
1012 #endif /* MGf_DUP */
1013 #if MGf_LOCAL
1014  VMG_CLONE_CB(local);
1015 #endif /* MGf_LOCAL */
1016 #if VMG_UVAR
1017  VMG_CLONE_CB(fetch);
1018  VMG_CLONE_CB(store);
1019  VMG_CLONE_CB(exists);
1020  VMG_CLONE_CB(delete);
1021 #endif /* VMG_UVAR */
1022  z->owner  = aTHX;
1023  z->vtbl   = t;
1024  z->sig    = w->sig;
1025  z->uvar   = w->uvar;
1026  z->opinfo = w->opinfo;
1027
1028  return z;
1029 }
1030
1031 #endif /* VMG_THREADSAFE */
1032
1033 /* --- XS ------------------------------------------------------------------ */
1034
1035 MODULE = Variable::Magic            PACKAGE = Variable::Magic
1036
1037 PROTOTYPES: ENABLE
1038
1039 BOOT:
1040 {
1041  HV *stash;
1042  MY_CXT_INIT;
1043  MY_CXT = newHV();
1044  hv_iterinit(MY_CXT); /* Allocate iterator */
1045  stash = gv_stashpv(__PACKAGE__, 1);
1046  newCONSTSUB(stash, "SIG_MIN",   newSVuv(SIG_MIN));
1047  newCONSTSUB(stash, "SIG_MAX",   newSVuv(SIG_MAX));
1048  newCONSTSUB(stash, "SIG_NBR",   newSVuv(SIG_NBR));
1049  newCONSTSUB(stash, "MGf_COPY",  newSVuv(MGf_COPY));
1050  newCONSTSUB(stash, "MGf_DUP",   newSVuv(MGf_DUP));
1051  newCONSTSUB(stash, "MGf_LOCAL", newSVuv(MGf_LOCAL));
1052  newCONSTSUB(stash, "VMG_UVAR",  newSVuv(VMG_UVAR));
1053  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_PUSH_NOLEN",
1054                     newSVuv(VMG_COMPAT_ARRAY_PUSH_NOLEN));
1055  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID",
1056                     newSVuv(VMG_COMPAT_ARRAY_UNSHIFT_NOLEN_VOID));
1057  newCONSTSUB(stash, "VMG_COMPAT_ARRAY_UNDEF_CLEAR",
1058                     newSVuv(VMG_COMPAT_ARRAY_UNDEF_CLEAR));
1059  newCONSTSUB(stash, "VMG_COMPAT_SCALAR_LENGTH_NOLEN",
1060                     newSVuv(VMG_COMPAT_SCALAR_LENGTH_NOLEN));
1061  newCONSTSUB(stash, "VMG_PERL_PATCHLEVEL", newSVuv(VMG_PERL_PATCHLEVEL));
1062  newCONSTSUB(stash, "VMG_THREADSAFE",      newSVuv(VMG_THREADSAFE));
1063  newCONSTSUB(stash, "VMG_OP_INFO_NAME",    newSVuv(VMG_OP_INFO_NAME));
1064  newCONSTSUB(stash, "VMG_OP_INFO_OBJECT",  newSVuv(VMG_OP_INFO_OBJECT));
1065 }
1066
1067 #if VMG_THREADSAFE
1068
1069 void
1070 CLONE(...)
1071 PROTOTYPE: DISABLE
1072 PREINIT:
1073  HV *hv;
1074 CODE:
1075  {
1076   HE *key;
1077   dMY_CXT;
1078   hv = newHV();
1079   hv_iterinit(hv); /* Allocate iterator */
1080   hv_iterinit(MY_CXT);
1081   while ((key = hv_iternext(MY_CXT))) {
1082    STRLEN len;
1083    char *sig = HePV(key, len);
1084    SV *sv;
1085    MAGIC *mg;
1086    sv = MGWIZ2SV(vmg_wizard_clone(SV2MGWIZ(HeVAL(key))));
1087    mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1088    mg->mg_private = SIG_WIZ;
1089    SvREADONLY_on(sv);
1090    hv_store(hv, sig, len, sv, HeHASH(key));
1091   }
1092  }
1093  {
1094   MY_CXT_CLONE;
1095   MY_CXT = hv;
1096  }
1097
1098 #endif /* VMG_THREADSAFE */
1099
1100 SV *_wizard(...)
1101 PROTOTYPE: DISABLE
1102 PREINIT:
1103  I32 i = 0;
1104  U16 sig;
1105  char buf[8];
1106  MGWIZ *w;
1107  MGVTBL *t;
1108  MAGIC *mg;
1109  SV *sv;
1110  SV *svsig;
1111  SV *cb;
1112 CODE:
1113  dMY_CXT;
1114
1115  if (items != 8
1116 #if MGf_COPY
1117               + 1
1118 #endif /* MGf_COPY */
1119 #if MGf_DUP
1120               + 1
1121 #endif /* MGf_DUP */
1122 #if MGf_LOCAL
1123               + 1
1124 #endif /* MGf_LOCAL */
1125 #if VMG_UVAR
1126               + 5
1127 #endif /* VMG_UVAR */
1128               ) { croak(vmg_wrongargnum); }
1129
1130  svsig = ST(i++);
1131  if (SvOK(svsig)) {
1132   SV **old;
1133   sig = vmg_sv2sig(svsig);
1134   if ((old = hv_fetch(MY_CXT, buf, sprintf(buf, "%u", sig), 0))) {
1135    ST(0) = sv_2mortal(newRV_inc(*old));
1136    XSRETURN(1);
1137   }
1138  } else {
1139   if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1140   sig = vmg_gensig();
1141  }
1142
1143  Newx(t, 1, MGVTBL);
1144  Newx(w, 1, MGWIZ);
1145
1146  VMG_SET_CB(ST(i++), data);
1147  cb = ST(i++);
1148  w->opinfo = SvOK(cb) ? SvUV(cb) : 0;
1149  if (w->opinfo)
1150   vmg_op_info_init(w->opinfo);
1151  VMG_SET_SVT_CB(ST(i++), get);
1152  VMG_SET_SVT_CB(ST(i++), set);
1153  VMG_SET_SVT_CB(ST(i++), len);
1154  VMG_SET_SVT_CB(ST(i++), clear);
1155  VMG_SET_SVT_CB(ST(i++), free);
1156 #if MGf_COPY
1157  VMG_SET_SVT_CB(ST(i++), copy);
1158 #endif /* MGf_COPY */
1159 #if MGf_DUP
1160  /* VMG_SET_SVT_CB(ST(i++), dup); */
1161  i++;
1162  t->svt_dup = NULL;
1163  w->cb_dup  = NULL;
1164 #endif /* MGf_DUP */
1165 #if MGf_LOCAL
1166  VMG_SET_SVT_CB(ST(i++), local);
1167 #endif /* MGf_LOCAL */
1168 #if VMG_UVAR
1169  VMG_SET_CB(ST(i++), fetch);
1170  VMG_SET_CB(ST(i++), store);
1171  VMG_SET_CB(ST(i++), exists);
1172  VMG_SET_CB(ST(i++), delete);
1173  cb = ST(i++);
1174  if (w->cb_fetch || w->cb_store || w->cb_exists || w->cb_delete)
1175   w->uvar = SvTRUE(cb) ? 2 : 1;
1176  else
1177   w->uvar = 0;
1178 #endif /* VMG_UVAR */
1179 #if VMG_MULTIPLICITY
1180  w->owner = aTHX;
1181 #endif /* VMG_MULTIPLICITY */
1182  w->vtbl  = t;
1183  w->sig   = sig;
1184
1185  sv = MGWIZ2SV(w);
1186  mg = sv_magicext(sv, NULL, PERL_MAGIC_ext, &vmg_wizard_vtbl, NULL, 0);
1187  mg->mg_private = SIG_WIZ;
1188  SvREADONLY_on(sv);
1189
1190  hv_store(MY_CXT, buf, sprintf(buf, "%u", sig), sv, 0);
1191
1192  RETVAL = newRV_noinc(sv);
1193 OUTPUT:
1194  RETVAL
1195
1196 SV *gensig()
1197 PROTOTYPE:
1198 CODE:
1199  dMY_CXT;
1200  if (HvKEYS(MY_CXT) >= SIG_NBR) { croak(vmg_toomanysigs); }
1201  RETVAL = newSVuv(vmg_gensig());
1202 OUTPUT:
1203  RETVAL
1204
1205 SV *getsig(SV *wiz)
1206 PROTOTYPE: $
1207 CODE:
1208  if (!SvROK(wiz)) { croak(vmg_invalid_wiz); }
1209  RETVAL = newSVuv(SV2MGWIZ(SvRV(wiz))->sig);
1210 OUTPUT:
1211  RETVAL
1212
1213 SV *cast(SV *sv, SV *wiz, ...)
1214 PROTOTYPE: \[$@%&*]$@
1215 PREINIT:
1216  AV *args = NULL;
1217  SV *ret;
1218 CODE:
1219  wiz = vmg_wizard_wiz(wiz);
1220  if (!wiz)
1221   XSRETURN_UNDEF;
1222  if (items > 2) {
1223   I32 i;
1224   args = newAV();
1225   av_fill(args, items - 2);
1226   for (i = 2; i < items; ++i) {
1227    SV *arg = ST(i);
1228    SvREFCNT_inc(arg);
1229    if (av_store(args, i - 2, arg) == NULL) { croak(vmg_argstorefailed); }
1230   }
1231  }
1232  ret = newSVuv(vmg_cast(SvRV(sv), wiz, args));
1233  SvREFCNT_dec(args);
1234  RETVAL = ret;
1235 OUTPUT:
1236  RETVAL
1237
1238 SV *getdata(SV *sv, SV *wiz)
1239 PROTOTYPE: \[$@%&*]$
1240 PREINIT:
1241  SV *data;
1242  U16 sig;
1243 CODE:
1244  sig = vmg_wizard_sig(wiz);
1245  if (!sig)
1246   XSRETURN_UNDEF;
1247  data = vmg_data_get(SvRV(sv), sig);
1248  if (!data) { XSRETURN_UNDEF; }
1249  ST(0) = data;
1250  XSRETURN(1);
1251
1252 SV *dispell(SV *sv, SV *wiz)
1253 PROTOTYPE: \[$@%&*]$
1254 PREINIT:
1255  U16 sig;
1256 CODE:
1257  sig = vmg_wizard_sig(wiz);
1258  if (!sig)
1259   XSRETURN_UNDEF;
1260  RETVAL = newSVuv(vmg_dispell(SvRV(sv), sig));
1261 OUTPUT:
1262  RETVAL
1263
1264 void
1265 _cleanup()
1266 PROTOTYPE:
1267 PPCODE:
1268  if (vmg_op_name_len) {
1269   Safefree(vmg_op_name_len);
1270   vmg_op_name_len = NULL;
1271  }
1272  XSRETURN(0);