Add Mouse::Object::new in XS
[gitmo/Mouse.git] / xs-src / Mouse.xs
CommitLineData
1b812057 1#define NEED_newSVpvn_flags_GLOBAL
df6dd016 2#include "mouse.h"
3
cccb83de 4SV* mouse_package;
5SV* mouse_namespace;
3e44140b 6SV* mouse_methods;
a5df48e5 7SV* mouse_name;
047d7af0 8SV* mouse_get_attribute;
9SV* mouse_get_attribute_list;
cccb83de 10
4e7e3250 11#define MOUSE_xc_flags(a) SvUVX(MOUSE_av_at((a), MOUSE_XC_FLAGS))
a39e9541 12#define MOUSE_xc_gen(a) MOUSE_av_at((a), MOUSE_XC_GEN)
aa2d2e2c 13#define MOUSE_xc_stash(a) ( (HV*)MOUSE_av_at((a), MOUSE_XC_STASH) )
a39e9541 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) )
9974d611 16#define MOUSE_xc_demolishall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_DEMOLISHALL) )
a39e9541 17
aa2d2e2c 18enum 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
a39e9541 26/* Mouse XS Metaclass object */
27enum mouse_xc_ix_t{
4e7e3250 28 MOUSE_XC_FLAGS,
29
a39e9541 30 MOUSE_XC_GEN, /* class generation */
aa2d2e2c 31 MOUSE_XC_STASH, /* symbol table hash */
aa2d2e2c 32
a39e9541 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
40static MGVTBL mouse_xc_vtbl; /* for identity */
41
42static void
43mouse_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
047d7af0 52 n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
a39e9541 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);
da4432f3 64
047d7af0 65 av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
a39e9541 66 }
67}
743ca82e 68
aa2d2e2c 69static int
70mouse_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);
aa2d2e2c 74
12872cc1 75 return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
aa2d2e2c 76}
77
a39e9541 78static void
79mouse_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;
aa2d2e2c 83 U32 flags = 0x00;
a39e9541 84 AV* const attrall = newAV();
85 AV* const buildall = newAV();
86 AV* const demolishall = newAV();
87 HV* const seen = newHV(); /* for attributes */
da4432f3 88
a39e9541 89 ENTER;
90 SAVETMPS;
da4432f3 91
a39e9541 92 sv_2mortal((SV*)seen);
da4432f3 93
a39e9541 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);
743ca82e 98
a39e9541 99 SvREFCNT_inc_simple_void_NN(linearized_isa);
100 sv_2mortal((SV*)linearized_isa);
da4432f3 101
a39e9541 102 /* update */
da4432f3 103
4e7e3250 104 if(predicate_calls(metaclass, "is_immutable")){
aa2d2e2c 105 flags |= MOUSEf_XC_IS_IMMUTABLE;
106 }
107
4e7e3250 108 if(predicate_calls(metaclass, "is_anon_class")){
109 flags |= MOUSEf_XC_IS_ANON;
110 }
111
aa2d2e2c 112 if(mouse_class_has_custom_buildargs(aTHX_ stash)){
113 flags |= MOUSEf_XC_HAS_BUILDARGS;
114 }
115
4e7e3250 116 av_store(xc, MOUSE_XC_FLAGS, newSVuv(flags));
a39e9541 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);
da4432f3 120
a39e9541 121 for(i = 0; i < len; i++){
047d7af0 122 SV* const klass = MOUSE_av_at(linearized_isa, i);
074a414d 123 HV* const st = gv_stashsv(klass, TRUE);
a39e9541 124 SV* meta;
125 GV* gv;
da4432f3 126
074a414d 127 gv = stash_fetchs(st, "BUILD", FALSE);
a39e9541 128 if(gv && GvCVu(gv)){
074a414d 129 av_unshift(buildall, 1);
130 av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
a39e9541 131 }
da4432f3 132
074a414d 133 gv = stash_fetchs(st, "DEMOLISH", FALSE);
a39e9541 134 if(gv && GvCVu(gv)){
135 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
136 }
da4432f3 137
a39e9541 138 /* ATTRIBUTES */
aa2d2e2c 139 meta = get_metaclass(klass);
a39e9541 140 if(!SvOK(meta)){
141 continue; /* skip non-Mouse classes */
142 }
da4432f3 143
a39e9541 144 mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
145 }
da4432f3 146
a39e9541 147 FREETMPS;
148 LEAVE;
da4432f3 149
a39e9541 150 sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
151}
da4432f3 152
a39e9541 153AV*
154mouse_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 }
da4432f3 163
a39e9541 164 mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
165 if(!mg){
166 SV* const package = get_slot(metaclass, mouse_package);
aa2d2e2c 167 STRLEN len;
168 const char* const pv = SvPV_const(package, len);
da4432f3 169
aa2d2e2c 170 stash = gv_stashpvn(pv, len, TRUE);
a39e9541 171 xc = newAV();
da4432f3 172
aa2d2e2c 173 mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
a39e9541 174 SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
da4432f3 175
a39e9541 176 av_extend(xc, MOUSE_XC_last - 1);
aa2d2e2c 177
a39e9541 178 av_store(xc, MOUSE_XC_GEN, newSViv(0));
aa2d2e2c 179 av_store(xc, MOUSE_XC_STASH, (SV*)stash);
4e7e3250 180
aa2d2e2c 181 SvREFCNT_inc_simple_void_NN(stash);
da4432f3 182 }
a39e9541 183 else{
a39e9541 184 xc = (AV*)MOUSE_mg_obj(mg);
da4432f3 185
a39e9541 186 assert(xc);
187 assert(SvTYPE(xc) == SVt_PVAV);
188 }
da4432f3 189
aa2d2e2c 190 gen = MOUSE_xc_gen(xc);
191 stash = MOUSE_xc_stash(xc);
192
a39e9541 193 if(SvUV(gen) != mro_get_pkg_gen(stash)){
194 mouse_class_update_xc(aTHX_ metaclass, stash, xc);
da4432f3 195 }
a39e9541 196
197 return xc;
198}
199
aa2d2e2c 200HV*
074a414d 201mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
aa2d2e2c 202 HV* args;
074a414d 203
204 /* shift @_ */
205 ax++;
206 items--;
207
208 if(items == 1){
209 SV* const args_ref = ST(0);
aa2d2e2c 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
6fab29c6 220 args = newHV_mortal();
aa2d2e2c 221
074a414d 222 if( (items % 2) != 0 ){
aa2d2e2c 223 if(!metaclass){ metaclass = get_metaclass(klass); }
224 mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
225 }
226
074a414d 227 for(i = 0; i < items; i += 2){
aa2d2e2c 228 (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
229 }
230
231 }
232 return args;
233}
234
235void
d4712779 236mouse_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);
4e7e3250 239 I32 len = AvFILLp(attrs) + 1;
d4712779 240 I32 i;
4e7e3250 241 AV* triggers_queue = NULL;
242
074a414d 243 assert(meta || object);
244 assert(args);
245 assert(SvTYPE(args) == SVt_PVHV);
246
4e7e3250 247 ENTER;
248 SAVETMPS;
249
250 if(!ignore_triggers){
251 triggers_queue = newAV_mortal();
252 }
0aad0266 253
d4712779 254 for(i = 0; i < len; i++){
4e7e3250 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);
d4712779 305 }
4e7e3250 306
307 FREETMPS;
308 LEAVE;
aa2d2e2c 309}
310
646c0371 311MODULE = Mouse PACKAGE = Mouse
df6dd016 312
313PROTOTYPES: DISABLE
314
cccb83de 315BOOT:
316 mouse_package = newSVpvs_share("package");
317 mouse_namespace = newSVpvs_share("namespace");
3e44140b 318 mouse_methods = newSVpvs_share("methods");
a5df48e5 319 mouse_name = newSVpvs_share("name");
3e44140b 320
047d7af0 321 mouse_get_attribute = newSVpvs_share("get_attribute");
322 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
da4432f3 323
646c0371 324 MOUSE_CALL_BOOT(Mouse__Util);
1d5ecd5f 325 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
646c0371 326 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
aa2d2e2c 327 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
f48920c1 328
cccb83de 329
7d96ae4d 330MODULE = Mouse PACKAGE = Mouse::Meta::Module
331
332BOOT:
333 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
334 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
335 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
336
337HV*
338namespace(SV* self)
339CODE:
340{
6a97bbda 341 SV* const package = get_slot(self, mouse_package);
7d96ae4d 342 if(!(package && SvOK(package))){
3e44140b 343 croak("No package name defined");
7d96ae4d 344 }
345 RETVAL = gv_stashsv(package, GV_ADDMULTI);
346}
347OUTPUT:
348 RETVAL
349
3e44140b 350# ignore extra arguments for extensibility
351void
352add_method(SV* self, SV* name, SV* code, ...)
353CODE:
354{
6a97bbda 355 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
356 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
3e44140b 357 GV* gv;
358 SV* code_ref;
359
360 if(!(package && SvOK(package))){
361 croak("No package name defined");
362 }
363
364 SvGETMAGIC(name);
365 SvGETMAGIC(code);
366
367 if(!SvOK(name)){
368 mouse_throw_error(self, NULL, "You must define a method name");
369 }
370 if(!SvROK(code)){
371 mouse_throw_error(self, NULL, "You must define a CODE reference");
372 }
373
374 code_ref = code;
375 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
376 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
377 SV** sp = &sv; /* used in tryAMAGICunDEREF */
378 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
379 if(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV){
380 mouse_throw_error(self, NULL, "Not a CODE reference");
381 }
382 code_ref = sv;
383 }
384
385 /* *{$package . '::' . $name} -> *gv */
386 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
387 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
388 SvREFCNT_dec(GvCV(gv));
389 GvCV(gv) = NULL;
390 }
391 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
392
6fe2272b 393 set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
3e44140b 394
395 /* TODO: name the CODE ref if it's anonymous */
396 //code_entity = (CV*)SvRV(code_ref);
397 //if(CvANON(code_entity)
398 // && CvGV(code_entity) /* a cv under construction has no gv */ ){
399
400 // CvGV(code_entity) = gv;
401 // CvANON_off(code_entity);
402 //}
403}
404
43165725 405MODULE = Mouse PACKAGE = Mouse::Meta::Class
406
407BOOT:
408 INSTALL_SIMPLE_READER(Class, roles);
409 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
410
cccb83de 411void
412linearized_isa(SV* self)
413PPCODE:
414{
415 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
416 AV* linearized_isa;
417 I32 len;
418 I32 i;
419 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
420 croak("namespace() didn't return a HASH reference");
421 }
422 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
423 len = AvFILLp(linearized_isa) + 1;
424 EXTEND(SP, len);
425 for(i = 0; i < len; i++){
426 PUSHs(AvARRAY(linearized_isa)[i]);
427 }
428}
429
da4432f3 430void
431get_all_attributes(SV* self)
432PPCODE:
433{
0aad0266 434 AV* const xc = mouse_get_xc(aTHX_ self);
435 AV* const all_attrs = MOUSE_xc_attrall(xc);
da4432f3 436 I32 const len = AvFILLp(all_attrs) + 1;
437 I32 i;
438
439 EXTEND(SP, len);
440 for(i = 0; i < len; i++){
441 PUSHs( MOUSE_av_at(all_attrs, i) );
442 }
443}
441964ce 444
aa2d2e2c 445SV*
446new_object_(SV* meta, ...)
447CODE:
448{
aa2d2e2c 449 AV* const xc = mouse_get_xc(aTHX_ meta);
074a414d 450 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
d4712779 451
aa2d2e2c 452 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
d4712779 453 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
aa2d2e2c 454}
455
456
457void
4e7e3250 458_initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
aa2d2e2c 459CODE:
460{
d4712779 461 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
aa2d2e2c 462}
463
074a414d 464void
465__xc(SV* meta)
466PPCODE:
467{
468 AV* const xc = mouse_get_xc(aTHX_ meta);
469 mXPUSHu(MOUSE_xc_flags(xc));
470 mXPUSHs(newRV_inc((SV*)MOUSE_xc_buildall(xc)));
471 mXPUSHs(newRV_inc((SV*)MOUSE_xc_demolishall(xc)));
472}
473
43165725 474MODULE = Mouse PACKAGE = Mouse::Meta::Role
475
476BOOT:
477 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
478 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
479
aa2d2e2c 480MODULE = Mouse PACKAGE = Mouse::Object
43165725 481
074a414d 482SV*
483new(SV* klass, ...)
484CODE:
485{
486 SV* const meta = get_metaclass(klass);
487 AV* const xc = mouse_get_xc(aTHX_ meta);
488 UV const flags = MOUSE_xc_flags(xc);
489 SV* args;
490 AV* av;
491 I32 len, i;
492
493 /* BUILDARGS */
494 if(flags & MOUSEf_XC_HAS_BUILDARGS){
495 SPAGAIN;
496
497 PUSHMARK(SP);
498 EXTEND(SP, items);
499 for(i = 0; i < items; i++){
500 PUSHs(ST(i));
501 }
502 //SP += items;
503 PUTBACK;
504 call_method("BUILDARGS", G_SCALAR);
505 SPAGAIN;
506 args = POPs;
507 PUTBACK;
508
509 if(!IsHashRef(args)){
510 croak("BUILDARGS did not return a HASH reference");
511 }
512 }
513 else{
514 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
515 sv_2mortal(args);
516 }
517
518 /* new_object */
519 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
520 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
521
522 /* BUILDALL */
523 av = MOUSE_xc_buildall(xc);
524 len = AvFILLp(av) + 1;
525 for(i = 0; i < len; i++){
526 dSP;
527
528 PUSHMARK(SP);
529 EXTEND(SP, 2);
530 PUSHs(RETVAL);
531 PUSHs(args);
532 PUTBACK;
533
534 call_sv(AvARRAY(av)[i], G_VOID | G_DISCARD);
535 }
536}
537OUTPUT:
538 RETVAL
539
aa2d2e2c 540HV*
541BUILDARGS(SV* klass, ...)
542CODE:
543{
074a414d 544 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
aa2d2e2c 545}
546OUTPUT:
547 RETVAL