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