Magic.xs

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