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
  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_DEOLISHALL) )
  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_GEN,          /* class generation */
  29     MOUSE_XC_STASH,        /* symbol table hash */
  30     MOUSE_XC_FLAGS,
  31
  32     MOUSE_XC_BUILDARGS,    /* Custom BUILDARGS */
  33
  34     MOUSE_XC_ATTRALL,      /* all the attributes */
  35     MOUSE_XC_BUILDALL,     /* all the BUILD methods */
  36     MOUSE_XC_DEMOLISHALL,  /* all the DEMOLISH methods */
  37
  38     MOUSE_XC_last
  39 };
  40
  41 static MGVTBL mouse_xc_vtbl; /* for identity */
  42
  43 static void
  44 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
  45     dSP;
  46     I32 n;
  47
  48     /* $meta->get_attribute_list */
  49     PUSHMARK(SP);
  50     XPUSHs(metaclass);
  51     PUTBACK;
  52
  53     n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
  54     for(NOOP; n > 0; n--){
  55         SV* name;
  56
  57         SPAGAIN;
  58         name = POPs;
  59         PUTBACK;
  60
  61         if(hv_exists_ent(seen, name, 0U)){
  62             continue;
  63         }
  64         (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
  65
  66         av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
  67     }
  68 }
  69
  70 static int
  71 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
  72     XS(XS_Mouse__Object_BUILDARGS); /* prototype */
  73
  74     GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
  75
  76     return buildargs && CvXSUB(GvCV(buildargs)) == XS_Mouse__Object_BUILDARGS;
  77 }
  78
  79 static void
  80 mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stash, AV* const xc) {
  81     AV* const linearized_isa = mro_get_linear_isa(stash);
  82     I32 const len            = AvFILLp(linearized_isa);
  83     I32 i;
  84     U32 flags             = 0x00;
  85     AV* const attrall     = newAV();
  86     AV* const buildall    = newAV();
  87     AV* const demolishall = newAV();
  88     HV* const seen        = newHV(); /* for attributes */
  89
  90     ENTER;
  91     SAVETMPS;
  92
  93     sv_2mortal((SV*)seen);
  94
  95      /* old data will be delete at the end of the perl scope */
  96     av_delete(xc, MOUSE_XC_DEMOLISHALL, 0x00);
  97     av_delete(xc, MOUSE_XC_BUILDALL,    0x00);
  98     av_delete(xc, MOUSE_XC_ATTRALL,     0x00);
  99
 100     SvREFCNT_inc_simple_void_NN(linearized_isa);
 101     sv_2mortal((SV*)linearized_isa);
 102
 103     /* update */
 104
 105     if(SvTRUEx( mcall0s(metaclass, "is_immutable") )){
 106         flags |= MOUSEf_XC_IS_IMMUTABLE;
 107     }
 108
 109     if(mouse_class_has_custom_buildargs(aTHX_ stash)){
 110         flags |= MOUSEf_XC_HAS_BUILDARGS;
 111     }
 112
 113     av_store(xc, MOUSE_XC_ATTRALL,     (SV*)attrall);
 114     av_store(xc, MOUSE_XC_BUILDALL,    (SV*)buildall);
 115     av_store(xc, MOUSE_XC_DEMOLISHALL, (SV*)demolishall);
 116
 117     for(i = 0; i < len; i++){
 118         SV* const klass = MOUSE_av_at(linearized_isa, i);
 119         SV* meta;
 120         GV* gv;
 121
 122         gv = stash_fetchs(stash, "BUILD", FALSE);
 123         if(gv && GvCVu(gv)){
 124             av_push(buildall, newRV_inc((SV*)GvCV(gv)));
 125         }
 126
 127         gv = stash_fetchs(stash, "DEMOLISH", FALSE);
 128         if(gv && GvCVu(gv)){
 129             av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
 130         }
 131
 132         /* ATTRIBUTES */
 133         meta = get_metaclass(klass);
 134         if(!SvOK(meta)){
 135             continue; /* skip non-Mouse classes */
 136         }
 137
 138         mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
 139     }
 140
 141     FREETMPS;
 142     LEAVE;
 143
 144     sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
 145 }
 146
 147 AV*
 148 mouse_get_xc(pTHX_ SV* const metaclass) {
 149     AV* xc;
 150     SV* gen;
 151     HV* stash;
 152     MAGIC* mg;
 153
 154     if(!IsObject(metaclass)){
 155         croak("Not a Mouse metaclass");
 156     }
 157
 158     mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
 159     if(!mg){
 160         SV* const package = get_slot(metaclass, mouse_package);
 161         STRLEN len;
 162         const char* const pv = SvPV_const(package, len);
 163
 164         stash = gv_stashpvn(pv, len, TRUE);
 165         xc    = newAV();
 166
 167         mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
 168         SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
 169
 170         av_extend(xc, MOUSE_XC_last - 1);
 171
 172         av_store(xc, MOUSE_XC_GEN, newSViv(0));
 173         av_store(xc, MOUSE_XC_STASH, (SV*)stash);
 174         SvREFCNT_inc_simple_void_NN(stash);
 175     }
 176     else{
 177         xc    = (AV*)MOUSE_mg_obj(mg);
 178
 179         assert(xc);
 180         assert(SvTYPE(xc) == SVt_PVAV);
 181     }
 182
 183     gen   = MOUSE_xc_gen(xc);
 184     stash = MOUSE_xc_stash(xc);
 185
 186     if(SvUV(gen) != mro_get_pkg_gen(stash)){
 187         mouse_class_update_xc(aTHX_ metaclass, stash, xc);
 188     }
 189
 190     return xc;
 191 }
 192
 193 HV*
 194 mouse_build_args(pTHX_ SV* metaclass, SV* const klass, I32 const start, I32 const items, I32 const ax) {
 195     HV* args;
 196     if((items - start) == 1){
 197         SV* const args_ref = ST(start);
 198         if(!IsHashRef(args_ref)){
 199             if(!metaclass){ metaclass = get_metaclass(klass); }
 200             mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
 201         }
 202         args = newHVhv((HV*)SvRV(args_ref));
 203         sv_2mortal((SV*)args);
 204     }
 205     else{
 206         I32 i;
 207
 208         args = newHV_mortal();
 209
 210         if( ((items - start) % 2) != 0 ){
 211             if(!metaclass){ metaclass = get_metaclass(klass); }
 212             mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
 213         }
 214
 215         for(i = start; i < items; i += 2){
 216             (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
 217         }
 218
 219     }
 220     return args;
 221 }
 222
 223 void
 224 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
 225     AV* const xc    = mouse_get_xc(aTHX_ meta);
 226     AV* const attrs = MOUSE_xc_attrall(xc);
 227     I32 const len   = AvFILLp(attrs) + 1;
 228     I32 i;
 229     AV* const triggers_queue = (ignore_triggers ? NULL : newAV_mortal());
 230
 231     for(i = 0; i < len; i++){
 232         AV* const xa = mouse_get_xa(aTHX_ AvARRAY(attrs)[i]);
 233     }
 234 }
 235
 236 MODULE = Mouse  PACKAGE = Mouse
 237
 238 PROTOTYPES: DISABLE
 239
 240 BOOT:
 241     mouse_package   = newSVpvs_share("package");
 242     mouse_namespace = newSVpvs_share("namespace");
 243     mouse_methods   = newSVpvs_share("methods");
 244     mouse_name      = newSVpvs_share("name");
 245
 246     mouse_get_attribute      = newSVpvs_share("get_attribute");
 247     mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
 248
 249     MOUSE_CALL_BOOT(Mouse__Util);
 250     MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
 251     MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
 252     MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
 253
 254
 255 MODULE = Mouse  PACKAGE = Mouse::Meta::Module
 256
 257 BOOT:
 258     INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
 259     INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
 260     INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
 261
 262 HV*
 263 namespace(SV* self)
 264 CODE:
 265 {
 266     SV* const package = get_slot(self, mouse_package);
 267     if(!(package && SvOK(package))){
 268         croak("No package name defined");
 269     }
 270     RETVAL = gv_stashsv(package, GV_ADDMULTI);
 271 }
 272 OUTPUT:
 273     RETVAL
 274
 275 # ignore extra arguments for extensibility
 276 void
 277 add_method(SV* self, SV* name, SV* code, ...)
 278 CODE:
 279 {
 280     SV* const package = get_slot(self, mouse_package); /* $self->{package} */
 281     SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
 282     GV* gv;
 283     SV* code_ref;
 284
 285     if(!(package && SvOK(package))){
 286         croak("No package name defined");
 287     }
 288
 289     SvGETMAGIC(name);
 290     SvGETMAGIC(code);
 291
 292     if(!SvOK(name)){
 293         mouse_throw_error(self, NULL, "You must define a method name");
 294     }
 295     if(!SvROK(code)){
 296         mouse_throw_error(self, NULL, "You must define a CODE reference");
 297     }
 298
 299     code_ref = code;
 300     if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
 301         SV*  sv = code_ref;  /* used in tryAMAGICunDEREF */
 302         SV** sp = &sv;       /* used in tryAMAGICunDEREF */
 303         tryAMAGICunDEREF(to_cv); /* try \&{$code} */
 304         if(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV){
 305             mouse_throw_error(self, NULL, "Not a CODE reference");
 306         }
 307         code_ref = sv;
 308     }
 309
 310     /*  *{$package . '::' . $name} -> *gv */
 311     gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
 312     if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
 313         SvREFCNT_dec(GvCV(gv));
 314         GvCV(gv) = NULL;
 315     }
 316     sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
 317
 318     set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
 319
 320     /* TODO: name the CODE ref if it's anonymous */
 321     //code_entity = (CV*)SvRV(code_ref);
 322     //if(CvANON(code_entity)
 323     //    && CvGV(code_entity) /* a cv under construction has no gv */ ){
 324
 325     //    CvGV(code_entity) = gv;
 326     //    CvANON_off(code_entity);
 327     //}
 328 }
 329
 330 MODULE = Mouse  PACKAGE = Mouse::Meta::Class
 331
 332 BOOT:
 333     INSTALL_SIMPLE_READER(Class, roles);
 334     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
 335
 336 void
 337 linearized_isa(SV* self)
 338 PPCODE:
 339 {
 340     SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
 341     AV* linearized_isa;
 342     I32 len;
 343     I32 i;
 344     if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
 345         croak("namespace() didn't return a HASH reference");
 346     }
 347     linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
 348     len = AvFILLp(linearized_isa) + 1;
 349     EXTEND(SP, len);
 350     for(i = 0; i < len; i++){
 351         PUSHs(AvARRAY(linearized_isa)[i]);
 352     }
 353 }
 354
 355 void
 356 get_all_attributes(SV* self)
 357 PPCODE:
 358 {
 359     AV* const xc        = mouse_get_xc(aTHX_ self);
 360     AV* const all_attrs =  MOUSE_xc_attrall(xc);
 361     I32 const len       = AvFILLp(all_attrs) + 1;
 362     I32 i;
 363
 364     EXTEND(SP, len);
 365     for(i = 0; i < len; i++){
 366         PUSHs( MOUSE_av_at(all_attrs, i) );
 367     }
 368 }
 369
 370 SV*
 371 new_object_(SV* meta, ...)
 372 CODE:
 373 {
 374     HV* const args = mouse_build_args(aTHX_ meta, NULL, 1, items, ax);
 375     AV* const xc   = mouse_get_xc(aTHX_ meta);
 376
 377     RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
 378     mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
 379 }
 380
 381
 382 void
 383 _initialize_object_(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
 384 CODE:
 385 {
 386     mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
 387 }
 388
 389 MODULE = Mouse  PACKAGE = Mouse::Meta::Role
 390
 391 BOOT:
 392     INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
 393     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
 394
 395 MODULE = Mouse  PACKAGE = Mouse::Object
 396
 397 HV*
 398 BUILDARGS(SV* klass, ...)
 399 CODE:
 400 {
 401     RETVAL = mouse_build_args(aTHX_ NULL, klass, 1, items, ax);
 402 }
 403 OUTPUT:
 404     RETVAL
 405