xs-src/Mouse.xs

   1 #define  NEED_newSVpvn_flags_GLOBAL
   2 #include "mouse.h"
   3
   4 SV* mouse_package;
   5 SV* mouse_namespace;
   6 SV* mouse_methods;
   7 SV* mouse_name;
   8 SV* mouse_get_attribute;
   9 SV* mouse_get_attribute_list;
  10
  11 #define MOUSE_xc_flags(a)       SvUVX(MOUSE_av_at((a), MOUSE_XC_FLAGS))
  12 #define MOUSE_xc_gen(a)         MOUSE_av_at((a), MOUSE_XC_GEN)
  13 #define MOUSE_xc_stash(a)       ( (HV*)MOUSE_av_at((a), MOUSE_XC_STASH) )
  14 #define MOUSE_xc_attrall(a)     ( (AV*)MOUSE_av_at((a), MOUSE_XC_ATTRALL) )
  15 #define MOUSE_xc_buildall(a)    ( (AV*)MOUSE_av_at((a), MOUSE_XC_BUILDALL) )
  16 #define MOUSE_xc_demolishall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_DEMOLISHALL) )
  17
  18 enum mouse_xc_flags_t {
  19     MOUSEf_XC_IS_IMMUTABLE   = 0x0001,
  20     MOUSEf_XC_IS_ANON        = 0x0002,
  21     MOUSEf_XC_HAS_BUILDARGS  = 0x0004,
  22
  23     MOUSEf_XC_mask           = 0xFFFF /* not used */
  24 };
  25
  26 /* Mouse XS Metaclass object */
  27 enum mouse_xc_ix_t{
  28     MOUSE_XC_FLAGS,
  29
  30     MOUSE_XC_GEN,          /* class generation */
  31     MOUSE_XC_STASH,        /* symbol table hash */
  32
  33     MOUSE_XC_ATTRALL,      /* all the attributes */
  34     MOUSE_XC_BUILDALL,     /* all the BUILD methods */
  35     MOUSE_XC_DEMOLISHALL,  /* all the DEMOLISH methods */
  36
  37     MOUSE_XC_last
  38 };
  39
  40 static MGVTBL mouse_xc_vtbl; /* for identity */
  41
  42 static void
  43 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
  44     dSP;
  45     I32 n;
  46
  47     /* $meta->get_attribute_list */
  48     PUSHMARK(SP);
  49     XPUSHs(metaclass);
  50     PUTBACK;
  51
  52     n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
  53     for(NOOP; n > 0; n--){
  54         SV* name;
  55
  56         SPAGAIN;
  57         name = POPs;
  58         PUTBACK;
  59
  60         if(hv_exists_ent(seen, name, 0U)){
  61             continue;
  62         }
  63         (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
  64
  65         av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
  66     }
  67 }
  68
  69 static int
  70 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
  71     XS(XS_Mouse__Object_BUILDARGS); /* prototype */
  72
  73     GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
  74
  75     return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
  76 }
  77
  78 static void
  79 mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stash, AV* const xc) {
  80     AV* const linearized_isa = mro_get_linear_isa(stash);
  81     I32 const len            = AvFILLp(linearized_isa);
  82     I32 i;
  83     U32 flags             = 0x00;
  84     AV* const attrall     = newAV();
  85     AV* const buildall    = newAV();
  86     AV* const demolishall = newAV();
  87     HV* const seen        = newHV(); /* for attributes */
  88
  89     ENTER;
  90     SAVETMPS;
  91
  92     sv_2mortal((SV*)seen);
  93
  94      /* old data will be delete at the end of the perl scope */
  95     av_delete(xc, MOUSE_XC_DEMOLISHALL, 0x00);
  96     av_delete(xc, MOUSE_XC_BUILDALL,    0x00);
  97     av_delete(xc, MOUSE_XC_ATTRALL,     0x00);
  98
  99     SvREFCNT_inc_simple_void_NN(linearized_isa);
 100     sv_2mortal((SV*)linearized_isa);
 101
 102     /* update */
 103
 104     if(predicate_calls(metaclass, "is_immutable")){
 105         flags |= MOUSEf_XC_IS_IMMUTABLE;
 106     }
 107
 108     if(predicate_calls(metaclass, "is_anon_class")){
 109         flags |= MOUSEf_XC_IS_ANON;
 110     }
 111
 112     if(mouse_class_has_custom_buildargs(aTHX_ stash)){
 113         flags |= MOUSEf_XC_HAS_BUILDARGS;
 114     }
 115
 116     av_store(xc, MOUSE_XC_FLAGS,       newSVuv(flags));
 117     av_store(xc, MOUSE_XC_ATTRALL,     (SV*)attrall);
 118     av_store(xc, MOUSE_XC_BUILDALL,    (SV*)buildall);
 119     av_store(xc, MOUSE_XC_DEMOLISHALL, (SV*)demolishall);
 120
 121     for(i = 0; i < len; i++){
 122         SV* const klass = MOUSE_av_at(linearized_isa, i);
 123         HV* const st    = gv_stashsv(klass, TRUE);
 124         SV* meta;
 125         GV* gv;
 126
 127         gv = stash_fetchs(st, "BUILD", FALSE);
 128         if(gv && GvCVu(gv)){
 129             av_unshift(buildall, 1);
 130             av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
 131         }
 132
 133         gv = stash_fetchs(st, "DEMOLISH", FALSE);
 134         if(gv && GvCVu(gv)){
 135             av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
 136         }
 137
 138         /* ATTRIBUTES */
 139         meta = get_metaclass(klass);
 140         if(!SvOK(meta)){
 141             continue; /* skip non-Mouse classes */
 142         }
 143
 144         mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
 145     }
 146
 147     FREETMPS;
 148     LEAVE;
 149
 150     sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
 151 }
 152
 153 AV*
 154 mouse_get_xc(pTHX_ SV* const metaclass) {
 155     AV* xc;
 156     SV* gen;
 157     HV* stash;
 158     MAGIC* mg;
 159
 160     if(!IsObject(metaclass)){
 161         croak("Not a Mouse metaclass");
 162     }
 163
 164     mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
 165     if(!mg){
 166         SV* const package = get_slot(metaclass, mouse_package);
 167         STRLEN len;
 168         const char* const pv = SvPV_const(package, len);
 169
 170         stash = gv_stashpvn(pv, len, TRUE);
 171         xc    = newAV();
 172
 173         mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
 174         SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
 175
 176         av_extend(xc, MOUSE_XC_last - 1);
 177
 178         av_store(xc, MOUSE_XC_GEN, newSViv(0));
 179         av_store(xc, MOUSE_XC_STASH, (SV*)stash);
 180
 181         SvREFCNT_inc_simple_void_NN(stash);
 182     }
 183     else{
 184         xc    = (AV*)MOUSE_mg_obj(mg);
 185
 186         assert(xc);
 187         assert(SvTYPE(xc) == SVt_PVAV);
 188     }
 189
 190     gen   = MOUSE_xc_gen(xc);
 191     stash = MOUSE_xc_stash(xc);
 192
 193     if(SvUV(gen) != mro_get_pkg_gen(stash)){
 194         mouse_class_update_xc(aTHX_ metaclass, stash, xc);
 195     }
 196
 197     return xc;
 198 }
 199
 200 HV*
 201 mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
 202     HV* args;
 203
 204     /* shift @_ */
 205     ax++;
 206     items--;
 207
 208     if(items == 1){
 209         SV* const args_ref = ST(0);
 210         if(!IsHashRef(args_ref)){
 211             if(!metaclass){ metaclass = get_metaclass(klass); }
 212             mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
 213         }
 214         args = newHVhv((HV*)SvRV(args_ref));
 215         sv_2mortal((SV*)args);
 216     }
 217     else{
 218         I32 i;
 219
 220         args = newHV_mortal();
 221
 222         if( (items % 2) != 0 ){
 223             if(!metaclass){ metaclass = get_metaclass(klass); }
 224             mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
 225         }
 226
 227         for(i = 0; i < items; i += 2){
 228             (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
 229         }
 230
 231     }
 232     return args;
 233 }
 234
 235 void
 236 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
 237     AV* const xc    = mouse_get_xc(aTHX_ meta);
 238     AV* const attrs = MOUSE_xc_attrall(xc);
 239     I32 len         = AvFILLp(attrs) + 1;
 240     I32 i;
 241     AV* triggers_queue = NULL;
 242
 243     assert(meta || object);
 244     assert(args);
 245     assert(SvTYPE(args) == SVt_PVHV);
 246
 247     ENTER;
 248     SAVETMPS;
 249
 250     if(!ignore_triggers){
 251         triggers_queue = newAV_mortal();
 252     }
 253
 254     for(i = 0; i < len; i++){
 255         SV* const attr = AvARRAY(attrs)[i];
 256         AV* const xa   = mouse_get_xa(aTHX_ AvARRAY(attrs)[i]);
 257
 258         SV* const slot     = MOUSE_xa_slot(xa);
 259         U16 const flags    = (U16)MOUSE_xa_flags(xa);
 260         SV* const init_arg = MOUSE_xa_init_arg(xa);
 261         HE* he;
 262
 263         if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
 264             SV* value = HeVAL(he);
 265             if(flags & MOUSEf_ATTR_HAS_TC){
 266                 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
 267             }
 268             set_slot(object, slot, value);
 269             if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
 270                 weaken_slot(object, slot);
 271             }
 272             if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
 273                 AV* const pair = newAV();
 274                 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
 275                 av_push(pair, newSVsv(value));
 276
 277                 av_push(triggers_queue, (SV*)pair);
 278             }
 279         }
 280         else { /* no init arg */
 281             if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
 282                 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
 283                     mouse_xa_set_default(aTHX_ xa, object);
 284                 }
 285             }
 286             else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
 287                 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
 288             }
 289         }
 290     } /* for each attributes */
 291
 292     if(triggers_queue){
 293         len = AvFILLp(triggers_queue) + 1;
 294         for(i = 0; i < len; i++){
 295             AV* const pair    = (AV*)AvARRAY(triggers_queue)[i];
 296             SV* const trigger = AvARRAY(pair)[0];
 297             SV* const value   = AvARRAY(pair)[1];
 298
 299             mcall1(object, trigger, value);
 300         }
 301     }
 302
 303     if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
 304         set_slot(object, newSVpvs_flags("__ANON__", SVs_TEMP), meta);
 305     }
 306
 307     FREETMPS;
 308     LEAVE;
 309 }
 310
 311 SV*
 312 mouse_initialize_metaclass(pTHX_ SV* const klass) {
 313     SV* meta = get_metaclass(klass);
 314
 315     if(!SvOK(meta)){
 316         dSP;
 317         PUSHMARK(SP);
 318
 319         EXTEND(SP, 2);
 320         mPUSHp("Mouse::Meta::Class", sizeof("Mouse::Meta::Class")-1);
 321         PUSHs(klass);
 322         PUTBACK;
 323
 324         call_method("initialize", G_SCALAR);
 325         SPAGAIN;
 326         meta = POPs;
 327         PUTBACK;
 328     }
 329
 330     return meta;
 331 }
 332
 333 MODULE = Mouse  PACKAGE = Mouse
 334
 335 PROTOTYPES: DISABLE
 336
 337 BOOT:
 338     mouse_package   = newSVpvs_share("package");
 339     mouse_namespace = newSVpvs_share("namespace");
 340     mouse_methods   = newSVpvs_share("methods");
 341     mouse_name      = newSVpvs_share("name");
 342
 343     mouse_get_attribute      = newSVpvs_share("get_attribute");
 344     mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
 345
 346     MOUSE_CALL_BOOT(Mouse__Util);
 347     MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
 348     MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
 349     MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
 350
 351
 352 MODULE = Mouse  PACKAGE = Mouse::Meta::Module
 353
 354 BOOT:
 355     INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
 356     INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
 357     INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
 358
 359 HV*
 360 namespace(SV* self)
 361 CODE:
 362 {
 363     SV* const package = get_slot(self, mouse_package);
 364     if(!(package && SvOK(package))){
 365         croak("No package name defined");
 366     }
 367     RETVAL = gv_stashsv(package, GV_ADDMULTI);
 368 }
 369 OUTPUT:
 370     RETVAL
 371
 372 # ignore extra arguments for extensibility
 373 void
 374 add_method(SV* self, SV* name, SV* code, ...)
 375 CODE:
 376 {
 377     SV* const package = get_slot(self, mouse_package); /* $self->{package} */
 378     SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
 379     GV* gv;
 380     SV* code_ref;
 381
 382     if(!(package && SvOK(package))){
 383         croak("No package name defined");
 384     }
 385
 386     SvGETMAGIC(name);
 387     SvGETMAGIC(code);
 388
 389     if(!SvOK(name)){
 390         mouse_throw_error(self, NULL, "You must define a method name");
 391     }
 392     if(!SvROK(code)){
 393         mouse_throw_error(self, NULL, "You must define a CODE reference");
 394     }
 395
 396     code_ref = code;
 397     if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
 398         SV*  sv = code_ref;  /* used in tryAMAGICunDEREF */
 399         SV** sp = &sv;       /* used in tryAMAGICunDEREF */
 400         tryAMAGICunDEREF(to_cv); /* try \&{$code} */
 401         if(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV){
 402             mouse_throw_error(self, NULL, "Not a CODE reference");
 403         }
 404         code_ref = sv;
 405     }
 406
 407     /*  *{$package . '::' . $name} -> *gv */
 408     gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
 409     if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
 410         SvREFCNT_dec(GvCV(gv));
 411         GvCV(gv) = NULL;
 412     }
 413     sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
 414
 415     set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
 416
 417     /* TODO: name the CODE ref if it's anonymous */
 418     //code_entity = (CV*)SvRV(code_ref);
 419     //if(CvANON(code_entity)
 420     //    && CvGV(code_entity) /* a cv under construction has no gv */ ){
 421
 422     //    CvGV(code_entity) = gv;
 423     //    CvANON_off(code_entity);
 424     //}
 425 }
 426
 427 MODULE = Mouse  PACKAGE = Mouse::Meta::Class
 428
 429 BOOT:
 430     INSTALL_SIMPLE_READER(Class, roles);
 431     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
 432     newCONSTSUB(gv_stashpvs("Mouse::Meta::Class", TRUE), "constructor_class",
 433         newSVpvs("Mouse::Meta::Method::Constructor::XS"));
 434
 435 void
 436 linearized_isa(SV* self)
 437 PPCODE:
 438 {
 439     SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
 440     AV* linearized_isa;
 441     I32 len;
 442     I32 i;
 443     if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
 444         croak("namespace() didn't return a HASH reference");
 445     }
 446     linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
 447     len = AvFILLp(linearized_isa) + 1;
 448     EXTEND(SP, len);
 449     for(i = 0; i < len; i++){
 450         PUSHs(AvARRAY(linearized_isa)[i]);
 451     }
 452 }
 453
 454 void
 455 get_all_attributes(SV* self)
 456 PPCODE:
 457 {
 458     AV* const xc        = mouse_get_xc(aTHX_ self);
 459     AV* const all_attrs =  MOUSE_xc_attrall(xc);
 460     I32 const len       = AvFILLp(all_attrs) + 1;
 461     I32 i;
 462
 463     EXTEND(SP, len);
 464     for(i = 0; i < len; i++){
 465         PUSHs( MOUSE_av_at(all_attrs, i) );
 466     }
 467 }
 468
 469 SV*
 470 new_object_(SV* meta, ...)
 471 CODE:
 472 {
 473     AV* const xc   = mouse_get_xc(aTHX_ meta);
 474     HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
 475
 476     RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
 477     mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
 478 }
 479
 480
 481 void
 482 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
 483 CODE:
 484 {
 485     mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
 486 }
 487
 488 void
 489 __xc(SV* meta)
 490 PPCODE:
 491 {
 492     AV* const xc = mouse_get_xc(aTHX_ meta);
 493     mXPUSHu(MOUSE_xc_flags(xc));
 494     mXPUSHs(newRV_inc((SV*)MOUSE_xc_buildall(xc)));
 495     mXPUSHs(newRV_inc((SV*)MOUSE_xc_demolishall(xc)));
 496 }
 497
 498 MODULE = Mouse  PACKAGE = Mouse::Meta::Role
 499
 500 BOOT:
 501     INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
 502     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
 503
 504 MODULE = Mouse  PACKAGE = Mouse::Object
 505
 506 SV*
 507 new(SV* klass, ...)
 508 CODE:
 509 {
 510     SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
 511     AV* const xc   = mouse_get_xc(aTHX_ meta);
 512     UV const flags = MOUSE_xc_flags(xc);
 513     SV* args;
 514     AV* av;
 515     I32 len, i;
 516
 517     /* BUILDARGS */
 518     if(flags & MOUSEf_XC_HAS_BUILDARGS){
 519         SPAGAIN;
 520
 521         PUSHMARK(SP);
 522         EXTEND(SP, items);
 523         for(i = 0; i < items; i++){
 524             PUSHs(ST(i));
 525         }
 526         //SP += items;
 527         PUTBACK;
 528         call_method("BUILDARGS", G_SCALAR);
 529         SPAGAIN;
 530         args = POPs;
 531         PUTBACK;
 532
 533         if(!IsHashRef(args)){
 534             croak("BUILDARGS did not return a HASH reference");
 535         }
 536     }
 537     else{
 538         args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
 539         sv_2mortal(args);
 540     }
 541
 542     /* new_object */
 543     RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
 544     mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
 545
 546     /* BUILDALL */
 547     av  = MOUSE_xc_buildall(xc);
 548     len = AvFILLp(av) + 1;
 549     for(i = 0; i < len; i++){
 550         dSP;
 551
 552         PUSHMARK(SP);
 553         EXTEND(SP, 2);
 554         PUSHs(RETVAL);
 555         PUSHs(args);
 556         PUTBACK;
 557
 558         call_sv(AvARRAY(av)[i], G_VOID | G_DISCARD);
 559     }
 560 }
 561 OUTPUT:
 562     RETVAL
 563
 564 HV*
 565 BUILDARGS(SV* klass, ...)
 566 CODE:
 567 {
 568     RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
 569 }
 570 OUTPUT:
 571     RETVAL
 572
 573 MODULE = Mouse  PACKAGE = Mouse::Meta::Method::Constructor::XS
 574
 575 CV*
 576 _generate_constructor(...)
 577 CODE:
 578 {
 579     RETVAL = get_cvs("Mouse::Object::new", TRUE);
 580     SvREFCNT_inc_simple_void_NN(RETVAL);
 581 }
 582 OUTPUT:
 583     RETVAL
 584