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