Tweaks
[gitmo/Mouse.git] / xs-src / Mouse.xs
1 #define  NEED_newSVpvn_flags_GLOBAL
2 #include "mouse.h"
3
4 /* keywords for methods/keys */
5 SV* mouse_package;
6 SV* mouse_namespace;
7 SV* mouse_methods;
8 SV* mouse_name;
9 SV* mouse_get_attribute;
10 SV* mouse_get_attribute_list;
11 SV* mouse_coerce;
12
13 #define MOUSE_xc_flags(a)       SvUVX(MOUSE_av_at((a), MOUSE_XC_FLAGS))
14 #define MOUSE_xc_gen(a)         MOUSE_av_at((a), MOUSE_XC_GEN)
15 #define MOUSE_xc_stash(a)       ( (HV*)MOUSE_av_at((a), MOUSE_XC_STASH) )
16 #define MOUSE_xc_attrall(a)     ( (AV*)MOUSE_av_at((a), MOUSE_XC_ATTRALL) )
17 #define MOUSE_xc_buildall(a)    ( (AV*)MOUSE_av_at((a), MOUSE_XC_BUILDALL) )
18 #define MOUSE_xc_demolishall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_DEMOLISHALL) )
19
20 enum mouse_xc_flags_t {
21     MOUSEf_XC_IS_IMMUTABLE   = 0x0001,
22     MOUSEf_XC_IS_ANON        = 0x0002,
23     MOUSEf_XC_HAS_BUILDARGS  = 0x0004,
24     MOUSEf_XC_CONSTRUCTOR_IS_STRICT
25                              = 0x0008,
26
27     MOUSEf_XC_mask           = 0xFFFF /* not used */
28 };
29
30 /* Mouse XS Metaclass object */
31 enum mouse_xc_ix_t{
32     MOUSE_XC_FLAGS,
33
34     MOUSE_XC_GEN,          /* class generation */
35     MOUSE_XC_STASH,        /* symbol table hash */
36
37     MOUSE_XC_ATTRALL,      /* all the attributes */
38     MOUSE_XC_BUILDALL,     /* all the BUILD methods */
39     MOUSE_XC_DEMOLISHALL,  /* all the DEMOLISH methods */
40
41     MOUSE_XC_last
42 };
43
44 enum mouse_modifier_t {
45     MOUSE_M_BEFORE,
46     MOUSE_M_AROUND,
47     MOUSE_M_AFTER,
48 };
49
50 static MGVTBL mouse_xc_vtbl; /* for identity */
51
52 static void
53 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
54     dSP;
55     I32 n;
56
57     /* $meta->get_attribute_list */
58     PUSHMARK(SP);
59     XPUSHs(metaclass);
60     PUTBACK;
61
62     n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
63     for(NOOP; n > 0; n--){
64         SV* name;
65
66         SPAGAIN;
67         name = POPs;
68         PUTBACK;
69
70         if(hv_exists_ent(seen, name, 0U)){
71             continue;
72         }
73         (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
74
75         av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
76     }
77 }
78
79 XS(XS_Mouse__Object_BUILDARGS); /* prototype */
80
81 static int
82 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
83     GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
84
85     return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
86 }
87
88 static void
89 mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stash, AV* const xc) {
90     AV* const linearized_isa = mro_get_linear_isa(stash);
91     I32 const len            = AvFILLp(linearized_isa) + 1;
92     I32 i;
93     U32 flags             = 0x00;
94     AV* const attrall     = newAV();
95     AV* const buildall    = newAV();
96     AV* const demolishall = newAV();
97     HV* const seen        = newHV(); /* for attributes */
98
99     ENTER;
100     SAVETMPS;
101
102     sv_2mortal((SV*)seen);
103
104      /* old data will be delete at the end of the perl scope */
105     av_delete(xc, MOUSE_XC_DEMOLISHALL, 0x00);
106     av_delete(xc, MOUSE_XC_BUILDALL,    0x00);
107     av_delete(xc, MOUSE_XC_ATTRALL,     0x00);
108
109     SvREFCNT_inc_simple_void_NN(linearized_isa);
110     sv_2mortal((SV*)linearized_isa);
111
112     /* update */
113
114     if(predicate_calls(metaclass, "is_immutable")){
115         flags |= MOUSEf_XC_IS_IMMUTABLE;
116     }
117
118     if(predicate_calls(metaclass, "is_anon_class")){
119         flags |= MOUSEf_XC_IS_ANON;
120     }
121
122     if(mouse_class_has_custom_buildargs(aTHX_ stash)){
123         flags |= MOUSEf_XC_HAS_BUILDARGS;
124     }
125
126     if(predicate_calls(metaclass, "strict_constructor")){
127         flags |= MOUSEf_XC_CONSTRUCTOR_IS_STRICT;
128     }
129
130     av_store(xc, MOUSE_XC_FLAGS,       newSVuv(flags));
131     av_store(xc, MOUSE_XC_ATTRALL,     (SV*)attrall);
132     av_store(xc, MOUSE_XC_BUILDALL,    (SV*)buildall);
133     av_store(xc, MOUSE_XC_DEMOLISHALL, (SV*)demolishall);
134
135     for(i = 0; i < len; i++){
136         SV* const klass = MOUSE_av_at(linearized_isa, i);
137         HV* const st    = gv_stashsv(klass, TRUE);
138         SV* meta;
139         GV* gv;
140
141         gv = stash_fetchs(st, "BUILD", FALSE);
142         if(gv && GvCVu(gv)){
143             av_unshift(buildall, 1);
144             av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
145         }
146
147         gv = stash_fetchs(st, "DEMOLISH", FALSE);
148         if(gv && GvCVu(gv)){
149             av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
150         }
151
152         /* ATTRIBUTES */
153         meta = get_metaclass(klass);
154         if(!SvOK(meta)){
155             continue; /* skip non-Mouse classes */
156         }
157
158         mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
159     }
160
161     FREETMPS;
162     LEAVE;
163
164     sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
165 }
166
167 static AV*
168 mouse_get_xc(pTHX_ SV* const metaclass) {
169     AV* xc;
170     SV* gen;
171     HV* stash;
172     MAGIC* mg;
173
174     if(!IsObject(metaclass)){
175         croak("Not a Mouse metaclass");
176     }
177
178     mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
179     if(!mg){
180         SV* const package = get_slot(metaclass, mouse_package);
181         STRLEN len;
182         const char* const pv = SvPV_const(package, len);
183
184         stash = gv_stashpvn(pv, len, TRUE);
185         xc    = newAV();
186
187         mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
188         SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
189
190         av_extend(xc, MOUSE_XC_last - 1);
191
192         av_store(xc, MOUSE_XC_GEN, newSVuv(0U));
193         av_store(xc, MOUSE_XC_STASH, (SV*)stash);
194
195         SvREFCNT_inc_simple_void_NN(stash);
196     }
197     else{
198         xc    = (AV*)MOUSE_mg_obj(mg);
199
200         assert(xc);
201         assert(SvTYPE(xc) == SVt_PVAV);
202     }
203
204     gen   = MOUSE_xc_gen(xc);
205
206     if(SvUVX(gen) != 0U && MOUSE_xc_flags(xc) & MOUSEf_XC_IS_IMMUTABLE){
207         return xc;
208     }
209
210     stash = MOUSE_xc_stash(xc);
211
212     if(SvUVX(gen) != mro_get_pkg_gen(stash)){
213         mouse_class_update_xc(aTHX_ metaclass, stash, xc);
214     }
215
216     return xc;
217 }
218
219 static HV*
220 mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
221     HV* args;
222
223     /* shift @_ */
224     ax++;
225     items--;
226
227     if(items == 1){
228         SV* const args_ref = ST(0);
229         if(!IsHashRef(args_ref)){
230             if(!metaclass){ metaclass = get_metaclass(klass); }
231             mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
232         }
233         args = newHVhv((HV*)SvRV(args_ref));
234         sv_2mortal((SV*)args);
235     }
236     else{
237         I32 i;
238
239         if( (items % 2) != 0 ){
240             if(!metaclass){ metaclass = get_metaclass(klass); }
241             mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
242         }
243
244         args = newHV_mortal();
245         for(i = 0; i < items; i += 2){
246             (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
247         }
248
249     }
250     return args;
251 }
252
253 static void
254 mouse_report_unknown_args(pTHX_ SV* const meta, AV* const attrs, HV* const args) {
255     HV* const attr_map = newHV_mortal();
256     SV* const unknown  = newSVpvs_flags("", SVs_TEMP);
257     I32 const len      = AvFILLp(attrs) + 1;
258     I32 i;
259     HE* he;
260
261     for(i = 0; i < len; i++){
262         SV* const attr = MOUSE_av_at(attrs, i);
263         AV* const xa   = mouse_get_xa(aTHX_ attr);
264         SV* const init_arg = MOUSE_xa_init_arg(xa);
265         if(SvOK(init_arg)){
266             (void)hv_store_ent(attr_map, init_arg, &PL_sv_undef, 0U);
267         }
268     }
269
270     hv_iterinit(args);
271     while((he = hv_iternext(args))){
272         SV* const key = hv_iterkeysv(he);
273         if(!hv_exists_ent(attr_map, key, 0U)){
274             sv_catpvf(unknown, "%"SVf", ", key);
275         }
276     }
277
278     if(SvCUR(unknown) > 0){
279         SvCUR(unknown) -= 2; /* chop "," */
280     }
281     else{
282         sv_setpvs(unknown, "(unknown)");
283     }
284
285     mouse_throw_error(meta, NULL,
286         "Unknown attribute passed to the constructor of %"SVf": %"SVf,
287         mcall0(meta, mouse_name), unknown);
288 }
289
290
291
292 static void
293 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const is_cloning) {
294     AV* const xc    = mouse_get_xc(aTHX_ meta);
295     AV* const attrs = MOUSE_xc_attrall(xc);
296     I32 const len   = AvFILLp(attrs) + 1;
297     I32 i;
298     AV* triggers_queue = NULL;
299     I32 used = 0;
300
301     assert(meta || object);
302     assert(args);
303     assert(SvTYPE(args) == SVt_PVHV);
304
305     if(mg_find((SV*)args, PERL_MAGIC_tied)){
306         croak("You cannot use tied HASH reference as initializing arguments");
307     }
308
309     /* for each attribute */
310     for(i = 0; i < len; i++){
311         SV* const attr = MOUSE_av_at(attrs, i);
312         AV* const xa   = mouse_get_xa(aTHX_ attr);
313
314         SV* const slot     = MOUSE_xa_slot(xa);
315         U16 const flags    = (U16)MOUSE_xa_flags(xa);
316         SV* const init_arg = MOUSE_xa_init_arg(xa);
317         HE* he;
318
319         if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
320             SV* value = HeVAL(he);
321             if(flags & MOUSEf_ATTR_HAS_TC){
322                 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
323             }
324             value = set_slot(object, slot, value);
325             if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
326                 weaken_slot(object, slot);
327             }
328             if(flags & MOUSEf_ATTR_HAS_TRIGGER){
329                 AV* const pair = newAV();
330                 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
331                 av_push(pair, newSVsv(value));
332
333                 if(!triggers_queue) {
334                     triggers_queue = newAV_mortal();
335                 }
336                 av_push(triggers_queue, (SV*)pair);
337             }
338             used++;
339         }
340         else { /* no init arg */
341             if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
342                 /* skip if the object has the slot (it occurs on cloning/reblessing) */
343                 if(!(flags & MOUSEf_ATTR_IS_LAZY) && !has_slot(object, slot)){
344                     mouse_xa_set_default(aTHX_ xa, object);
345                 }
346             }
347             /* don't check while cloning (or reblesseing) */
348             else if(!is_cloning && flags & MOUSEf_ATTR_IS_REQUIRED) {
349                 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
350             }
351         }
352     } /* for each attribute */
353
354     if(MOUSE_xc_flags(xc) & MOUSEf_XC_CONSTRUCTOR_IS_STRICT
355             && used < (I32)HvUSEDKEYS(args)){
356         mouse_report_unknown_args(aTHX_ meta, attrs, args);
357     }
358
359     if(triggers_queue){
360         I32 const len = AvFILLp(triggers_queue) + 1;
361         for(i = 0; i < len; i++){
362             AV* const pair    = (AV*)AvARRAY(triggers_queue)[i];
363             SV* const trigger = AvARRAY(pair)[0];
364             SV* const value   = AvARRAY(pair)[1];
365
366             mcall1(object, trigger, value);
367         }
368     }
369
370     if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
371         (void)set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
372     }
373 }
374
375 STATIC_INLINE SV*
376 mouse_initialize_metaclass(pTHX_ SV* const klass) {
377     SV* const meta = get_metaclass(klass);
378     if(LIKELY(SvOK(meta))){
379         return meta;
380     }
381     return mcall1s(newSVpvs_flags("Mouse::Meta::Class", SVs_TEMP),
382             "initialize", klass);
383 }
384
385 static void
386 mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
387     AV* const buildall = MOUSE_xc_buildall(xc);
388     I32 const len      = AvFILLp(buildall) + 1;
389     I32 i;
390     for(i = 0; i < len; i++){
391         dSP;
392
393         PUSHMARK(SP);
394         EXTEND(SP, 2);
395         PUSHs(object);
396         PUSHs(args);
397         PUTBACK;
398
399         call_sv_safe(AvARRAY(buildall)[i], G_VOID);
400
401         /* discard a scalar which G_VOID returns */
402         SPAGAIN;
403         (void)POPs;
404         PUTBACK;
405     }
406 }
407
408 static AV*
409 mouse_get_modifier_storage(pTHX_
410         SV* const meta,
411         enum mouse_modifier_t const m, SV* const name) {
412     static const char* const keys[] = {
413         "before",
414         "around",
415         "after",
416     };
417     SV* const key = sv_2mortal(Perl_newSVpvf(aTHX_ "%s_method_modifiers", keys[m]));
418     SV* table;
419     SV* storage_ref;
420
421     must_defined(name, "a method name");
422
423     table = get_slot(meta, key);
424
425     if(!table){
426         /* $meta->{$key} = {} */
427         table = sv_2mortal(newRV_noinc((SV*)newHV()));
428         set_slot(meta, key, table);
429     }
430
431     storage_ref = get_slot(table, name);
432
433     if(!storage_ref){
434         storage_ref = sv_2mortal(newRV_noinc((SV*)newAV()));
435         set_slot(table, name, storage_ref);
436     }
437     else{
438         if(!IsArrayRef(storage_ref)){
439             croak("Modifier strorage for '%s' is not an ARRAY reference", keys[m]);
440         }
441     }
442
443     return (AV*)SvRV(storage_ref);
444 }
445
446 static void
447 XS_Mouse_value_holder(pTHX_ CV* const cv PERL_UNUSED_DECL) {
448     dVAR; dXSARGS;
449     SV* const value = (SV*)XSANY.any_ptr;
450     assert(value);
451     PERL_UNUSED_VAR(items);
452     ST(0) = value;
453     XSRETURN(1);
454 }
455
456 DECL_BOOT(Mouse__Util);
457 DECL_BOOT(Mouse__Util__TypeConstraints);
458 DECL_BOOT(Mouse__Meta__Method__Accessor__XS);
459 DECL_BOOT(Mouse__Meta__Attribute);
460
461 MODULE = Mouse  PACKAGE = Mouse
462
463 PROTOTYPES: DISABLE
464
465 BOOT:
466 {
467     mouse_package   = newSVpvs_share("package");
468     mouse_namespace = newSVpvs_share("namespace");
469     mouse_methods   = newSVpvs_share("methods");
470     mouse_name      = newSVpvs_share("name");
471     mouse_coerce    = newSVpvs_share("coerce");
472
473     mouse_get_attribute      = newSVpvs_share("get_attribute");
474     mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
475
476     CALL_BOOT(Mouse__Util);
477     CALL_BOOT(Mouse__Util__TypeConstraints);
478     CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
479     CALL_BOOT(Mouse__Meta__Attribute);
480 }
481
482 MODULE = Mouse  PACKAGE = Mouse::Meta::Module
483
484 BOOT:
485     INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
486     INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
487     INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
488
489 HV*
490 namespace(SV* self)
491 CODE:
492 {
493     SV* const package = get_slot(self, mouse_package);
494     if(!(package && SvOK(package))){
495         croak("No package name defined");
496     }
497     RETVAL = gv_stashsv(package, GV_ADDMULTI);
498 }
499 OUTPUT:
500     RETVAL
501
502 # ignore extra arguments for extensibility
503 void
504 add_method(SV* self, SV* name, SV* code, ...)
505 CODE:
506 {
507     SV* const package = get_slot(self, mouse_package); /* $self->{package} */
508     SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
509     GV* gv;
510     SV* code_ref;
511
512     if(!(package && SvOK(package))){
513         croak("No package name defined");
514     }
515
516     must_defined(name, "a method name");
517     must_ref    (code, "a CODE reference", SVt_NULL); /* any reftype is OK */
518
519     code_ref = code;
520     if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
521         SV*  sv = code_ref;  /* used in tryAMAGICunDEREF */
522         SV** sp = &sv;       /* used in tryAMAGICunDEREF */
523         tryAMAGICunDEREF(to_cv); /* try \&{$code} */
524         must_ref(code, "a CODE reference", SVt_PVCV);
525         code_ref = sv;
526     }
527
528     /*  *{$package . '::' . $name} -> *gv */
529     gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
530     mouse_install_sub(aTHX_ gv, code_ref);
531     //CvMETHOD_on((CV*)SvRV(code_ref));
532     (void)set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
533 }
534
535 MODULE = Mouse  PACKAGE = Mouse::Meta::Class
536
537 BOOT:
538 {
539     CV* xsub;
540
541     INSTALL_SIMPLE_READER(Class, roles);
542     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
543     INSTALL_SIMPLE_READER(Class, is_immutable);
544
545     INSTALL_INHERITABLE_CLASS_ACCESSOR(strict_constructor);
546
547     INSTALL_CLASS_HOLDER(Class, method_metaclass,     "Mouse::Meta::Method");
548     INSTALL_CLASS_HOLDER(Class, attribute_metaclass,  "Mouse::Meta::Attribute");
549     INSTALL_CLASS_HOLDER(Class, constructor_class,    "Mouse::Meta::Method::Constructor::XS");
550     INSTALL_CLASS_HOLDER(Class, destructor_class,     "Mouse::Meta::Method::Destructor::XS");
551
552     xsub = newXS("Mouse::Meta::Method::Constructor::XS::_generate_constructor",
553         XS_Mouse_value_holder, file);
554     CvXSUBANY(xsub).any_ptr
555         = newRV_inc((SV*)get_cvs("Mouse::Object::new", GV_ADD));
556
557     xsub = newXS("Mouse::Meta::Method::Destructor::XS::_generate_destructor",
558         XS_Mouse_value_holder, file);
559     CvXSUBANY(xsub).any_ptr
560         = newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", GV_ADD));
561 }
562
563
564 void
565 linearized_isa(SV* self)
566 PPCODE:
567 {
568     SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
569     AV* linearized_isa;
570     I32 len;
571     I32 i;
572     if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
573         croak("namespace() didn't return a HASH reference");
574     }
575     linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
576     len = AvFILLp(linearized_isa) + 1;
577     EXTEND(SP, len);
578     for(i = 0; i < len; i++){
579         PUSHs(AvARRAY(linearized_isa)[i]);
580     }
581 }
582
583 void
584 get_all_attributes(SV* self)
585 PPCODE:
586 {
587     AV* const xc        = mouse_get_xc(aTHX_ self);
588     AV* const all_attrs = MOUSE_xc_attrall(xc);
589     I32 const len       = AvFILLp(all_attrs) + 1;
590     I32 i;
591
592     EXTEND(SP, len);
593     for(i = 0; i < len; i++){
594         PUSHs( MOUSE_av_at(all_attrs, i) );
595     }
596 }
597
598 void
599 new_object(SV* meta, ...)
600 CODE:
601 {
602     AV* const xc   = mouse_get_xc(aTHX_ meta);
603     HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
604     SV* object;
605
606     object = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
607     mouse_class_initialize_object(aTHX_ meta, object, args, FALSE);
608     mouse_buildall(aTHX_ xc, object, sv_2mortal(newRV_inc((SV*)args))); /* BUILDALL */
609     ST(0) = object; /* because object is mortal, we should return it as is */
610     XSRETURN(1);
611 }
612
613 void
614 clone_object(SV* meta, SV* object, ...)
615 CODE:
616 {
617     AV* const xc   = mouse_get_xc(aTHX_ meta);
618     HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax + 1, items - 1);
619     SV* proto;
620
621     if(!mouse_is_an_instance_of(aTHX_ MOUSE_xc_stash(xc), object)) {
622         mouse_throw_error(meta, object,
623             "You must pass an instance of the metaclass (%"SVf"), not (%"SVf")",
624             mcall0(meta, mouse_name), object);
625     }
626
627     proto = mouse_instance_clone(aTHX_ object);
628     mouse_class_initialize_object(aTHX_ meta, proto, args, TRUE);
629     ST(0) = proto; /* because object is mortal, we should return it as is */
630     XSRETURN(1);
631 }
632
633 void
634 _initialize_object(SV* meta, SV* object, HV* args, bool is_cloning = FALSE)
635 CODE:
636 {
637     mouse_class_initialize_object(aTHX_ meta, object, args, is_cloning);
638 }
639
640 MODULE = Mouse  PACKAGE = Mouse::Meta::Role
641
642 BOOT:
643     INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
644     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
645
646     INSTALL_CLASS_HOLDER(Role, method_metaclass,  "Mouse::Meta::Role::Method");
647
648 void
649 add_before_modifier(SV* self, SV* name, SV* modifier)
650 CODE:
651 {
652     av_push(mouse_get_modifier_storage(aTHX_ self, (enum mouse_modifier_t)ix, name), newSVsv(modifier));
653 }
654 ALIAS:
655     add_before_method_modifier = MOUSE_M_BEFORE
656     add_around_method_modifier = MOUSE_M_AROUND
657     add_after_method_modifier  = MOUSE_M_AFTER
658
659 void
660 get_before_modifiers(SV* self, SV* name)
661 ALIAS:
662     get_before_method_modifiers = MOUSE_M_BEFORE
663     get_around_method_modifiers = MOUSE_M_AROUND
664     get_after_method_modifiers  = MOUSE_M_AFTER
665 PPCODE:
666 {
667     AV* const storage = mouse_get_modifier_storage(aTHX_ self, (enum mouse_modifier_t)ix, name);
668     I32 const len     = av_len(storage) + 1;
669     if(GIMME_V == G_ARRAY) {
670         I32 i;
671         EXTEND(SP, len);
672         for(i = 0; i < len; i++){
673             PUSHs(*av_fetch(storage, i, TRUE));
674         }
675     }
676     else{
677         mPUSHi(len);
678     }
679 }
680
681 void
682 add_metaclass_accessor(SV* self, SV* name)
683 CODE:
684 {
685     SV* const klass = mcall0(self, mouse_name);
686     const char* fq_name = form("%"SVf"::%"SVf, klass, name);
687     STRLEN keylen;
688     const char* const key = SvPV_const(name, keylen);
689     mouse_simple_accessor_generate(aTHX_ fq_name, key, keylen,
690         XS_Mouse_inheritable_class_accessor, NULL, 0);
691 }
692
693 MODULE = Mouse  PACKAGE = Mouse::Object
694
695 void
696 new(SV* klass, ...)
697 CODE:
698 {
699     SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
700     AV* const xc   = mouse_get_xc(aTHX_ meta);
701     UV const flags = MOUSE_xc_flags(xc);
702     SV* args;
703     SV* object;
704
705     /* BUILDARGS */
706     if(flags & MOUSEf_XC_HAS_BUILDARGS){
707         I32 i;
708         SPAGAIN;
709
710         PUSHMARK(SP);
711         EXTEND(SP, items);
712         for(i = 0; i < items; i++){
713             PUSHs(ST(i));
714         }
715
716         PUTBACK;
717         call_method_safes("BUILDARGS", G_SCALAR);
718
719         SPAGAIN;
720         args = POPs;
721         PUTBACK;
722
723         if(!IsHashRef(args)){
724             croak("BUILDARGS did not return a HASH reference");
725         }
726     }
727     else{
728         args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
729         sv_2mortal(args);
730     }
731
732     /* new_object */
733     object = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
734     mouse_class_initialize_object(aTHX_ meta, object, (HV*)SvRV(args), FALSE);
735     mouse_buildall(aTHX_ xc, object, args); /* BUILDALL */
736     ST(0) = object; /* because object is mortal, we should return it as is */
737     XSRETURN(1);
738 }
739
740 void
741 DESTROY(SV* object)
742 ALIAS:
743     DESTROY     = 0
744     DEMOLISHALL = 1
745 CODE:
746 {
747     SV* const meta = get_metaclass(object);
748     AV* demolishall;
749     I32 len, i;
750
751     if(!IsObject(object)){
752         croak("You must not call %s as a class method",
753             ix == 0 ? "DESTROY" : "DEMOLISHALL");
754     }
755
756     if(SvOK(meta)){
757         AV* const xc = mouse_get_xc(aTHX_ meta);
758
759         demolishall = MOUSE_xc_demolishall(xc);
760     }
761     else { /* The metaclass is already destroyed */
762         AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
763
764         len = AvFILLp(linearized_isa) + 1;
765
766         demolishall = newAV_mortal();
767         for(i = 0; i < len; i++){
768             SV* const klass = MOUSE_av_at(linearized_isa, i);
769             HV* const st    = gv_stashsv(klass, TRUE);
770             GV* const gv    = stash_fetchs(st, "DEMOLISH", FALSE);
771             if(gv && GvCVu(gv)){
772                 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
773             }
774         }
775     }
776
777     len      = AvFILLp(demolishall) + 1;
778     if(len > 0){
779         SV* const in_global_destruction = boolSV(PL_dirty);
780         SAVEI32(PL_statusvalue); /* local $? */
781         PL_statusvalue = 0;
782
783         SAVESPTR(ERRSV); /* local $@ */
784         ERRSV = sv_newmortal();
785
786         EXTEND(SP, 2);
787
788         for(i = 0; i < len; i++){
789             SPAGAIN;
790
791             PUSHMARK(SP);
792             PUSHs(object);
793             PUSHs(in_global_destruction);
794             PUTBACK;
795
796             call_sv(AvARRAY(demolishall)[i], G_VOID | G_EVAL);
797
798             /* discard a scalar which G_VOID returns */
799             SPAGAIN;
800             (void)POPs;
801             PUTBACK;
802
803             if(sv_true(ERRSV)){
804                 SV* const e = newSVsv(ERRSV);
805
806                 FREETMPS;
807                 LEAVE;
808
809                 sv_setsv(ERRSV, e);
810                 SvREFCNT_dec(e);
811                 croak(NULL); /* rethrow */
812             }
813         }
814     }
815 }
816
817 HV*
818 BUILDARGS(SV* klass, ...)
819 CODE:
820 {
821     RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
822 }
823 OUTPUT:
824     RETVAL
825
826
827 void
828 BUILDALL(SV* self, SV* args)
829 CODE:
830 {
831     SV* const meta = get_metaclass(self);
832     AV* const xc   = mouse_get_xc(aTHX_ meta);
833
834     must_ref(args, "a HASH reference to BUILDALL", SVt_PVHV);
835     mouse_buildall(aTHX_ xc, self, args);
836 }