xs-src/MouseAccessor.xs

   1 #include "mouse.h"
   2
   3 #define CHECK_INSTANCE(instance) STMT_START{                          \
   4         if(!(SvROK(instance) && SvTYPE(SvRV(instance)) == SVt_PVHV)){ \
   5             croak("Invalid object instance");                         \
   6         }                                                             \
   7     } STMT_END
   8
   9
  10 #define MOUSE_mg_attribute(mg) MOUSE_xa_attribute(MOUSE_mg_xa(mg))
  11
  12 static MGVTBL mouse_accessor_vtbl; /* MAGIC identity */
  13
  14 #define dMOUSE_self  SV* const self = mouse_accessor_get_self(aTHX_ ax, items, cv)
  15
  16 static inline SV*
  17 mouse_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv) {
  18     if(items < 1){
  19         croak("Too few arguments for %s", GvNAME(CvGV(cv)));
  20     }
  21
  22     /* NOTE: If self has GETMAGIC, $self->accessor will invoke GETMAGIC
  23      *       before calling methods, so SvGETMAGIC(self) is not necessarily needed here.
  24      */
  25
  26     return ST(0);
  27 }
  28
  29
  30 CV*
  31 mouse_accessor_generate(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl){
  32     AV* const xa = mouse_get_xa(aTHX_ attr);
  33     CV* xsub;
  34     MAGIC* mg;
  35
  36     xsub = newXS(NULL, accessor_impl, __FILE__);
  37     sv_2mortal((SV*)xsub);
  38
  39     mg = sv_magicext((SV*)xsub, MOUSE_xa_slot(xa), PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)xa, HEf_SVKEY);
  40
  41     MOUSE_mg_flags(mg) = (U16)MOUSE_xa_flags(xa);
  42
  43     /* NOTE:
  44      * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
  45      */
  46     CvXSUBANY(xsub).any_ptr = (void*)mg;
  47
  48     return xsub;
  49 }
  50
  51
  52 #define PUSH_VALUE(value, flags) STMT_START { \
  53         if((flags) & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY){ \
  54             mouse_push_values(aTHX_ value, (flags));                       \
  55         }                                                                  \
  56         else{                                                              \
  57             dSP;                                                           \
  58             XPUSHs(value ? value : &PL_sv_undef);                          \
  59             PUTBACK;                                                       \
  60         }                                                                  \
  61     } STMT_END                                                             \
  62
  63 /* pushes return values, does auto-deref if needed */
  64 static void
  65 mouse_push_values(pTHX_ SV* const value, U16 const flags){
  66     dSP;
  67
  68     assert( flags & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY );
  69
  70     if(!(value && SvOK(value))){
  71         return;
  72     }
  73
  74     if(flags & MOUSEf_TC_IS_ARRAYREF){
  75         AV* av;
  76         I32 len;
  77         I32 i;
  78
  79         if(!IsArrayRef(value)){
  80             croak("Mouse-panic: Not an ARRAY reference");
  81         }
  82
  83         av  = (AV*)SvRV(value);
  84         len = av_len(av) + 1;
  85         EXTEND(SP, len);
  86         for(i = 0; i < len; i++){
  87             SV** const svp = av_fetch(av, i, FALSE);
  88             PUSHs(svp ? *svp : &PL_sv_undef);
  89         }
  90     }
  91     else if(flags & MOUSEf_TC_IS_HASHREF){
  92         HV* hv;
  93         HE* he;
  94
  95         if(!IsHashRef(value)){
  96             croak("Mouse-panic: Not a HASH reference");
  97         }
  98
  99         hv = (HV*)SvRV(value);
 100         hv_iterinit(hv);
 101         while((he = hv_iternext(hv))){
 102             EXTEND(SP, 2);
 103             PUSHs(hv_iterkeysv(he));
 104             PUSHs(hv_iterval(hv, he));
 105         }
 106     }
 107
 108     PUTBACK;
 109 }
 110
 111 static void
 112 mouse_attr_get(pTHX_ SV* const self, MAGIC* const mg){
 113     U16 const flags = MOUSE_mg_flags(mg);
 114     SV* value;
 115
 116     value = get_slot(self, MOUSE_mg_slot(mg));
 117
 118     /* check_lazy */
 119     if( !value && flags & MOUSEf_ATTR_IS_LAZY ){
 120         value = mouse_xa_set_default(aTHX_ MOUSE_mg_xa(mg), self);
 121     }
 122
 123     PUSH_VALUE(value, flags);
 124 }
 125
 126 static void
 127 mouse_attr_set(pTHX_ SV* const self, MAGIC* const mg, SV* value){
 128     U16 const flags = MOUSE_mg_flags(mg);
 129     SV* const slot  = MOUSE_mg_slot(mg);
 130
 131     if(flags & MOUSEf_ATTR_HAS_TC){
 132         value = mouse_xa_apply_type_constraint(aTHX_ MOUSE_mg_xa(mg), value, flags);
 133     }
 134
 135     set_slot(self, slot, value);
 136
 137     if(flags & MOUSEf_ATTR_IS_WEAK_REF){
 138         weaken_slot(self, slot);
 139     }
 140
 141     if(flags & MOUSEf_ATTR_HAS_TRIGGER){
 142         SV* const trigger = mcall0s(MOUSE_mg_attribute(mg), "trigger");
 143         dSP;
 144
 145         PUSHMARK(SP);
 146         EXTEND(SP, 2);
 147         PUSHs(self);
 148         PUSHs(value);
 149
 150         PUTBACK;
 151         call_sv(trigger, G_VOID | G_DISCARD);
 152         /* need not SPAGAIN */
 153     }
 154
 155     PUSH_VALUE(value, flags);
 156 }
 157
 158 XS(XS_Mouse_accessor)
 159 {
 160     dVAR; dXSARGS;
 161     dMOUSE_self;
 162     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
 163
 164     SP -= items; /* PPCODE */
 165     PUTBACK;
 166
 167     if(items == 1){ /* reader */
 168         mouse_attr_get(aTHX_ self, mg);
 169     }
 170     else if (items == 2){ /* writer */
 171         mouse_attr_set(aTHX_ self, mg, ST(1));
 172     }
 173     else{
 174         mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
 175             "Expected exactly one or two argument for an accessor");
 176     }
 177 }
 178
 179
 180 XS(XS_Mouse_reader)
 181 {
 182     dVAR; dXSARGS;
 183     dMOUSE_self;
 184     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
 185
 186     if (items != 1) {
 187         mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
 188             "Cannot assign a value to a read-only accessor");
 189     }
 190
 191     SP -= items; /* PPCODE */
 192     PUTBACK;
 193
 194     mouse_attr_get(aTHX_ self, mg);
 195 }
 196
 197 XS(XS_Mouse_writer)
 198 {
 199     dVAR; dXSARGS;
 200     dMOUSE_self;
 201     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
 202
 203     if (items != 2) {
 204         mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
 205             "Too few arguments for a write-only accessor");
 206     }
 207
 208     SP -= items; /* PPCODE */
 209     PUTBACK;
 210
 211     mouse_attr_set(aTHX_ self, mg, ST(1));
 212 }
 213
 214 /* simple accessors */
 215
 216 /*
 217 static MAGIC*
 218 mouse_accessor_get_mg(pTHX_ CV* const xsub){
 219     return moose_mg_find(aTHX_ (SV*)xsub, &mouse_simple_accessor_vtbl, MOOSEf_DIE_ON_FAIL);
 220 }
 221 */
 222
 223 CV*
 224 mouse_simple_accessor_generate(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl, void* const dptr, I32 const dlen){
 225     CV* const xsub = newXS((char*)fq_name, accessor_impl, __FILE__);
 226     SV* const slot = newSVpvn_share(key, keylen, 0U);
 227     MAGIC* mg;
 228
 229     if(!fq_name){
 230         /* anonymous xsubs need sv_2mortal */
 231         sv_2mortal((SV*)xsub);
 232     }
 233
 234     mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)dptr, dlen);
 235     SvREFCNT_dec(slot); /* sv_magicext() increases refcnt in mg_obj */
 236     if(dlen == HEf_SVKEY){
 237         SvREFCNT_dec(dptr);
 238     }
 239
 240     /* NOTE:
 241      * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
 242      */
 243     CvXSUBANY(xsub).any_ptr = (void*)mg;
 244
 245     return xsub;
 246 }
 247
 248 XS(XS_Mouse_simple_accessor)
 249 {
 250     dVAR; dXSARGS;
 251     dMOUSE_self;
 252     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
 253     SV* value;
 254
 255     if(items == 1){ /* reader */
 256         value = get_slot(self, MOUSE_mg_slot(mg));
 257         if(!value) {
 258             if(MOUSE_mg_ptr(mg)){
 259                 /* the default value must be a SV */
 260                 assert(MOUSE_mg_len(mg) == HEf_SVKEY);
 261                 value = (SV*)MOUSE_mg_ptr(mg);
 262             }
 263             else{
 264                 value = &PL_sv_undef;
 265             }
 266         }
 267     }
 268     else if(items == 2){ /* writer */
 269          value = set_slot(self, MOUSE_mg_slot(mg), ST(1));
 270     }
 271     else {
 272         croak("Expected exactly one or two argument for an accessor for '%"SVf"'", MOUSE_mg_slot(mg));
 273     }
 274
 275     ST(0) = value;
 276     XSRETURN(1);
 277 }
 278
 279 XS(XS_Mouse_simple_reader)
 280 {
 281     dVAR; dXSARGS;
 282     dMOUSE_self;
 283     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
 284     SV* value;
 285
 286     if (items != 1) {
 287         croak("Expected exactly one argument for a reader for '%"SVf"'", MOUSE_mg_slot(mg));
 288     }
 289
 290     value = get_slot(self, MOUSE_mg_slot(mg));
 291     ST(0) = value ? value : &PL_sv_undef;
 292     XSRETURN(1);
 293 }
 294
 295
 296 XS(XS_Mouse_simple_writer)
 297 {
 298     dVAR; dXSARGS;
 299     dMOUSE_self;
 300     SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
 301
 302     if (items != 2) {
 303         croak("Expected exactly two argument for a writer for '%"SVf"'", slot);
 304     }
 305
 306     ST(0) = set_slot(self, slot, ST(1));
 307     XSRETURN(1);
 308 }
 309
 310 XS(XS_Mouse_simple_clearer)
 311 {
 312     dVAR; dXSARGS;
 313     dMOUSE_self;
 314     SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
 315     SV* value;
 316
 317     if (items != 1) {
 318         croak("Expected exactly one argument for a clearer for '%"SVf"'", slot);
 319     }
 320
 321     value = delete_slot(self, slot);
 322     ST(0) = value ? value : &PL_sv_undef;
 323     XSRETURN(1);
 324 }
 325
 326 XS(XS_Mouse_simple_predicate)
 327 {
 328     dVAR; dXSARGS;
 329     dMOUSE_self;
 330     SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
 331
 332     if (items != 1) {
 333         croak("Expected exactly one argument for a predicate for '%"SVf"'", slot);
 334     }
 335
 336     ST(0) = boolSV( has_slot(self, slot) );
 337     XSRETURN(1);
 338 }
 339
 340 /* simple instance slot accessor (or Mouse::Meta::Instance) */
 341
 342 SV*
 343 mouse_instance_create(pTHX_ HV* const stash) {
 344     assert(stash);
 345     assert(SvTYPE(stash) == SVt_PVHV);
 346     return sv_bless( newRV_noinc((SV*)newHV()), stash );
 347 }
 348
 349 SV*
 350 mouse_instance_clone(pTHX_ SV* const instance) {
 351     HV* proto;
 352     assert(instance);
 353
 354     CHECK_INSTANCE(instance);
 355     proto = newHVhv((HV*)SvRV(instance));
 356     return sv_bless( newRV_noinc((SV*)proto), SvSTASH(SvRV(instance)) );
 357 }
 358
 359 bool
 360 mouse_instance_has_slot(pTHX_ SV* const instance, SV* const slot) {
 361     assert(instance);
 362     assert(slot);
 363     CHECK_INSTANCE(instance);
 364     return hv_exists_ent((HV*)SvRV(instance), slot, 0U);
 365 }
 366
 367 SV*
 368 mouse_instance_get_slot(pTHX_ SV* const instance, SV* const slot) {
 369     HE* he;
 370     assert(instance);
 371     assert(slot);
 372     CHECK_INSTANCE(instance);
 373     he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
 374     return he ? HeVAL(he) : NULL;
 375 }
 376
 377 SV*
 378 mouse_instance_set_slot(pTHX_ SV* const instance, SV* const slot, SV* const value) {
 379     HE* he;
 380     SV* sv;
 381     assert(instance);
 382     assert(slot);
 383     assert(value);
 384     CHECK_INSTANCE(instance);
 385     he = hv_fetch_ent((HV*)SvRV(instance), slot, TRUE, 0U);
 386     sv = HeVAL(he);
 387     sv_setsv(sv, value);
 388     SvSETMAGIC(sv);
 389     return sv;
 390 }
 391
 392 SV*
 393 mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot) {
 394     assert(instance);
 395     assert(slot);
 396     CHECK_INSTANCE(instance);
 397     return hv_delete_ent((HV*)SvRV(instance), slot, 0, 0U);
 398 }
 399
 400 void
 401 mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot) {
 402     HE* he;
 403     assert(instance);
 404     assert(slot);
 405     CHECK_INSTANCE(instance);
 406     he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
 407     if(he){
 408         sv_rvweaken(HeVAL(he));
 409     }
 410 }
 411 \r
 412 MODULE = Mouse::Meta::Method::Accessor::XS  PACKAGE = Mouse::Meta::Method::Accessor::XS
 413
 414 PROTOTYPES:   DISABLE
 415 VERSIONCHECK: DISABLE
 416
 417 CV*
 418 _generate_accessor(klass, SV* attr, metaclass)
 419 CODE:
 420 {
 421     RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_accessor);
 422 }
 423 OUTPUT:
 424     RETVAL
 425
 426 CV*
 427 _generate_reader(klass, SV* attr, metaclass)
 428 CODE:
 429 {
 430     RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_reader);
 431 }
 432 OUTPUT:
 433     RETVAL
 434
 435 CV*
 436 _generate_writer(klass, SV* attr, metaclass)
 437 CODE:
 438 {
 439     RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_writer);
 440 }
 441 OUTPUT:
 442     RETVAL
 443
 444 CV*
 445 _generate_clearer(klass, SV* attr, metaclass)
 446 CODE:
 447 {
 448     SV* const slot = mcall0s(attr, "name");
 449     STRLEN len;
 450     const char* const pv = SvPV_const(slot, len);
 451     RETVAL = mouse_simple_accessor_generate(aTHX_ NULL, pv, len, XS_Mouse_simple_clearer, NULL, 0);
 452 }
 453 OUTPUT:
 454     RETVAL
 455
 456 CV*
 457 _generate_predicate(klass, SV* attr, metaclass)
 458 CODE:
 459 {
 460     SV* const slot = mcall0s(attr, "name");
 461     STRLEN len;
 462     const char* const pv = SvPV_const(slot, len);
 463     RETVAL = mouse_simple_accessor_generate(aTHX_ NULL, pv, len, XS_Mouse_simple_predicate, NULL, 0);
 464 }
 465 OUTPUT:
 466     RETVAL
 467