1 #define NEED_newSVpvn_flags_GLOBAL
4 /* keywords for methods/keys */
9 SV* mouse_get_attribute;
10 SV* mouse_get_attribute_list;
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) )
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
27 MOUSEf_XC_mask = 0xFFFF /* not used */
30 /* Mouse XS Metaclass object */
34 MOUSE_XC_GEN, /* class generation */
35 MOUSE_XC_STASH, /* symbol table hash */
37 MOUSE_XC_ATTRALL, /* all the attributes */
38 MOUSE_XC_BUILDALL, /* all the BUILD methods */
39 MOUSE_XC_DEMOLISHALL, /* all the DEMOLISH methods */
44 enum mouse_modifier_t {
50 static MGVTBL mouse_xc_vtbl; /* for identity */
53 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
57 /* $meta->get_attribute_list */
62 n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
63 for(NOOP; n > 0; n--){
70 if(hv_exists_ent(seen, name, 0U)){
73 (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
75 av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
80 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
81 XS(XS_Mouse__Object_BUILDARGS); /* prototype */
83 GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
85 return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
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);
94 AV* const attrall = newAV();
95 AV* const buildall = newAV();
96 AV* const demolishall = newAV();
97 HV* const seen = newHV(); /* for attributes */
102 sv_2mortal((SV*)seen);
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);
109 SvREFCNT_inc_simple_void_NN(linearized_isa);
110 sv_2mortal((SV*)linearized_isa);
114 if(predicate_calls(metaclass, "is_immutable")){
115 flags |= MOUSEf_XC_IS_IMMUTABLE;
118 if(predicate_calls(metaclass, "is_anon_class")){
119 flags |= MOUSEf_XC_IS_ANON;
122 if(mouse_class_has_custom_buildargs(aTHX_ stash)){
123 flags |= MOUSEf_XC_HAS_BUILDARGS;
126 if(predicate_calls(metaclass, "__strict_constructor")){
127 flags |= MOUSEf_XC_CONSTRUCTOR_IS_STRICT;
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);
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);
141 gv = stash_fetchs(st, "BUILD", FALSE);
143 av_unshift(buildall, 1);
144 av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
147 gv = stash_fetchs(st, "DEMOLISH", FALSE);
149 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
153 meta = get_metaclass(klass);
155 continue; /* skip non-Mouse classes */
158 mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
164 sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
168 mouse_get_xc(pTHX_ SV* const metaclass) {
174 if(!IsObject(metaclass)){
175 croak("Not a Mouse metaclass");
178 mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
180 SV* const package = get_slot(metaclass, mouse_package);
182 const char* const pv = SvPV_const(package, len);
184 stash = gv_stashpvn(pv, len, TRUE);
187 mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
188 SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
190 av_extend(xc, MOUSE_XC_last - 1);
192 av_store(xc, MOUSE_XC_GEN, newSVuv(0U));
193 av_store(xc, MOUSE_XC_STASH, (SV*)stash);
195 SvREFCNT_inc_simple_void_NN(stash);
198 xc = (AV*)MOUSE_mg_obj(mg);
201 assert(SvTYPE(xc) == SVt_PVAV);
204 gen = MOUSE_xc_gen(xc);
206 if(SvUVX(gen) != 0U && MOUSE_xc_flags(xc) & MOUSEf_XC_IS_IMMUTABLE){
210 stash = MOUSE_xc_stash(xc);
212 if(SvUVX(gen) != mro_get_pkg_gen(stash)){
213 mouse_class_update_xc(aTHX_ metaclass, stash, xc);
220 mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
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");
233 args = newHVhv((HV*)SvRV(args_ref));
234 sv_2mortal((SV*)args);
239 args = newHV_mortal();
241 if( (items % 2) != 0 ){
242 if(!metaclass){ metaclass = get_metaclass(klass); }
243 mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
246 for(i = 0; i < items; i += 2){
247 (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
255 mouse_report_unknown_args(pTHX_ SV* const meta, AV* const attrs, HV* const args) {
256 HV* const attr_map = newHV_mortal();
257 SV* const unknown = newSVpvs_flags("", SVs_TEMP);
258 I32 const len = AvFILLp(attrs) + 1;
262 for(i = 0; i < len; i++){
263 SV* const attr = MOUSE_av_at(attrs, i);
264 AV* const xa = mouse_get_xa(aTHX_ attr);
265 SV* const init_arg = MOUSE_xa_init_arg(xa);
267 (void)hv_store_ent(attr_map, init_arg, &PL_sv_undef, 0U);
272 while((he = hv_iternext(args))){
273 SV* const key = hv_iterkeysv(he);
274 if(!hv_exists_ent(attr_map, key, 0U)){
275 sv_catpvf(unknown, "%"SVf", ", key);
279 if(SvCUR(unknown) > 0){
280 SvCUR(unknown) -= 2; /* chop "," */
283 sv_setpvs(unknown, "(unknown)");
286 mouse_throw_error(meta, NULL,
287 "Unknown attribute passed to the constructor of %"SVf": %"SVf,
288 mcall0(meta, mouse_name), unknown);
294 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const is_cloning) {
295 AV* const xc = mouse_get_xc(aTHX_ meta);
296 AV* const attrs = MOUSE_xc_attrall(xc);
297 I32 const len = AvFILLp(attrs) + 1;
299 AV* triggers_queue = NULL;
302 assert(meta || object);
304 assert(SvTYPE(args) == SVt_PVHV);
306 if(mg_find((SV*)args, PERL_MAGIC_tied)){
307 croak("You cannot use tied HASH reference as initializing arguments");
310 /* for each attribute */
311 for(i = 0; i < len; i++){
312 SV* const attr = MOUSE_av_at(attrs, i);
313 AV* const xa = mouse_get_xa(aTHX_ attr);
315 SV* const slot = MOUSE_xa_slot(xa);
316 U16 const flags = (U16)MOUSE_xa_flags(xa);
317 SV* const init_arg = MOUSE_xa_init_arg(xa);
320 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
321 SV* value = HeVAL(he);
322 if(flags & MOUSEf_ATTR_HAS_TC){
323 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
325 value = set_slot(object, slot, value);
326 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
327 weaken_slot(object, slot);
329 if(flags & MOUSEf_ATTR_HAS_TRIGGER){
330 AV* const pair = newAV();
331 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
332 av_push(pair, newSVsv(value));
334 if(!triggers_queue) {
335 triggers_queue = newAV_mortal();
337 av_push(triggers_queue, (SV*)pair);
341 else { /* no init arg */
342 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
343 /* skip if the object has the slot (it occurs on cloning/reblessing) */
344 if(!(flags & MOUSEf_ATTR_IS_LAZY) && !has_slot(object, slot)){
345 mouse_xa_set_default(aTHX_ xa, object);
348 /* don't check while cloning (or reblesseing) */
349 else if(!is_cloning && flags & MOUSEf_ATTR_IS_REQUIRED) {
350 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
353 } /* for each attribute */
355 if(MOUSE_xc_flags(xc) & MOUSEf_XC_CONSTRUCTOR_IS_STRICT && used < HvUSEDKEYS(args)){
356 mouse_report_unknown_args(aTHX_ meta, attrs, args);
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];
366 mcall1(object, trigger, value);
370 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
371 (void)set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
377 mouse_initialize_metaclass(pTHX_ SV* const klass) {
378 SV* meta = get_metaclass(klass);
381 meta = mcall1s(newSVpvs_flags("Mouse::Meta::Class", SVs_TEMP), "initialize", klass);
388 mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
389 AV* const buildall = MOUSE_xc_buildall(xc);
390 I32 const len = AvFILLp(buildall) + 1;
392 for(i = 0; i < len; i++){
401 call_sv_safe(AvARRAY(buildall)[i], G_VOID);
403 /* discard a scalar which G_VOID returns */
411 mouse_get_modifier_storage(pTHX_
413 enum mouse_modifier_t const m, SV* const name) {
414 static const char* const keys[] = {
419 SV* const key = sv_2mortal(Perl_newSVpvf(aTHX_ "%s_method_modifiers", keys[m]));
423 must_defined(name, "a method name");
425 table = get_slot(meta, key);
428 /* $meta->{$key} = {} */
429 table = sv_2mortal(newRV_noinc((SV*)newHV()));
430 set_slot(meta, key, table);
433 storage_ref = get_slot(table, name);
436 storage_ref = sv_2mortal(newRV_noinc((SV*)newAV()));
437 set_slot(table, name, storage_ref);
440 if(!IsArrayRef(storage_ref)){
441 croak("Modifier strorage for '%s' is not an ARRAY reference", keys[m]);
445 return (AV*)SvRV(storage_ref);
448 MODULE = Mouse PACKAGE = Mouse
453 mouse_package = newSVpvs_share("package");
454 mouse_namespace = newSVpvs_share("namespace");
455 mouse_methods = newSVpvs_share("methods");
456 mouse_name = newSVpvs_share("name");
457 mouse_coerce = newSVpvs_share("coerce");
459 mouse_get_attribute = newSVpvs_share("get_attribute");
460 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
462 MOUSE_CALL_BOOT(Mouse__Util);
463 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
464 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
465 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
468 MODULE = Mouse PACKAGE = Mouse::Meta::Module
471 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
472 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
473 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
479 SV* const package = get_slot(self, mouse_package);
480 if(!(package && SvOK(package))){
481 croak("No package name defined");
483 RETVAL = gv_stashsv(package, GV_ADDMULTI);
488 # ignore extra arguments for extensibility
490 add_method(SV* self, SV* name, SV* code, ...)
493 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
494 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
498 if(!(package && SvOK(package))){
499 croak("No package name defined");
502 must_defined(name, "a method name");
503 must_ref (code, "a CODE reference", SVt_NULL); /* any reftype is OK */
506 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
507 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
508 SV** sp = &sv; /* used in tryAMAGICunDEREF */
509 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
510 must_ref(code, "a CODE reference", SVt_PVCV);
514 /* *{$package . '::' . $name} -> *gv */
515 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
516 mouse_install_sub(aTHX_ gv, code_ref);
517 //CvMETHOD_on((CV*)SvRV(code_ref));
518 (void)set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
521 MODULE = Mouse PACKAGE = Mouse::Meta::Class
524 INSTALL_SIMPLE_READER(Class, roles);
525 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
526 INSTALL_SIMPLE_READER(Class, is_immutable);
527 INSTALL_SIMPLE_READER_WITH_KEY(Class, __strict_constructor, strict_constructor);
529 INSTALL_CLASS_HOLDER(Class, method_metaclass, "Mouse::Meta::Method");
530 INSTALL_CLASS_HOLDER(Class, attribute_metaclass, "Mouse::Meta::Attribute");
531 INSTALL_CLASS_HOLDER(Class, constructor_class, "Mouse::Meta::Method::Constructor::XS");
532 INSTALL_CLASS_HOLDER(Class, destructor_class, "Mouse::Meta::Method::Destructor::XS");
534 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
535 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
536 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
537 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
541 linearized_isa(SV* self)
544 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
548 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
549 croak("namespace() didn't return a HASH reference");
551 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
552 len = AvFILLp(linearized_isa) + 1;
554 for(i = 0; i < len; i++){
555 PUSHs(AvARRAY(linearized_isa)[i]);
560 get_all_attributes(SV* self)
563 AV* const xc = mouse_get_xc(aTHX_ self);
564 AV* const all_attrs = MOUSE_xc_attrall(xc);
565 I32 const len = AvFILLp(all_attrs) + 1;
569 for(i = 0; i < len; i++){
570 PUSHs( MOUSE_av_at(all_attrs, i) );
575 new_object(SV* meta, ...)
578 AV* const xc = mouse_get_xc(aTHX_ meta);
579 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
581 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
582 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
583 mouse_buildall(aTHX_ xc, RETVAL, sv_2mortal(newRV_inc((SV*)args))); /* BUILDALL */
589 clone_object(SV* meta, SV* object, ...)
592 AV* const xc = mouse_get_xc(aTHX_ meta);
593 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax + 1, items - 1);
595 if(!mouse_is_an_instance_of(aTHX_ MOUSE_xc_stash(xc), object)) {
596 mouse_throw_error(meta, object,
597 "You must pass an instance of the metaclass (%"SVf"), not (%"SVf")",
598 mcall0(meta, mouse_name), object);
601 RETVAL = mouse_instance_clone(aTHX_ object);
602 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, TRUE);
609 _initialize_object(SV* meta, SV* object, HV* args, bool is_cloning = FALSE)
612 mouse_class_initialize_object(aTHX_ meta, object, args, is_cloning);
615 MODULE = Mouse PACKAGE = Mouse::Meta::Role
618 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
619 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
621 INSTALL_CLASS_HOLDER(Role, method_metaclass, "Mouse::Meta::Role::Method");
624 add_before_modifier(SV* self, SV* name, SV* modifier)
627 av_push(mouse_get_modifier_storage(aTHX_ self, ix, name), newSVsv(modifier));
630 add_before_method_modifier = MOUSE_M_BEFORE
631 add_around_method_modifier = MOUSE_M_AROUND
632 add_after_method_modifier = MOUSE_M_AFTER
635 get_before_modifiers(SV* self, SV* name)
637 get_before_method_modifiers = MOUSE_M_BEFORE
638 get_around_method_modifiers = MOUSE_M_AROUND
639 get_after_method_modifiers = MOUSE_M_AFTER
642 AV* const storage = mouse_get_modifier_storage(aTHX_ self, ix, name);
643 I32 const len = av_len(storage) + 1;
644 if(GIMME_V == G_ARRAY) {
647 for(i = 0; i < len; i++){
648 PUSHs(*av_fetch(storage, i, TRUE));
656 MODULE = Mouse PACKAGE = Mouse::Object
662 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
663 AV* const xc = mouse_get_xc(aTHX_ meta);
664 UV const flags = MOUSE_xc_flags(xc);
668 if(flags & MOUSEf_XC_HAS_BUILDARGS){
674 for(i = 0; i < items; i++){
679 call_method_safes("BUILDARGS", G_SCALAR);
685 if(!IsHashRef(args)){
686 croak("BUILDARGS did not return a HASH reference");
690 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
695 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
696 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
697 mouse_buildall(aTHX_ xc, RETVAL, args); /* BUILDALL */
709 SV* const meta = get_metaclass(object);
713 if(!IsObject(object)){
714 croak("You must not call %s as a class method",
715 ix == 0 ? "DESTROY" : "DEMOLISHALL");
719 AV* const xc = mouse_get_xc(aTHX_ meta);
721 demolishall = MOUSE_xc_demolishall(xc);
723 else { /* The metaclass is already destroyed */
724 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
726 len = AvFILLp(linearized_isa) + 1;
728 demolishall = newAV_mortal();
729 for(i = 0; i < len; i++){
730 SV* const klass = MOUSE_av_at(linearized_isa, i);
731 HV* const st = gv_stashsv(klass, TRUE);
732 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
734 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
739 len = AvFILLp(demolishall) + 1;
741 SV* const in_global_destruction = boolSV(PL_dirty);
742 SAVEI32(PL_statusvalue); /* local $? */
745 SAVESPTR(ERRSV); /* local $@ */
746 ERRSV = sv_newmortal();
750 for(i = 0; i < len; i++){
755 PUSHs(in_global_destruction);
758 call_sv(AvARRAY(demolishall)[i], G_VOID | G_EVAL);
760 /* discard a scalar which G_VOID returns */
766 SV* const e = newSVsv(ERRSV);
773 croak(NULL); /* rethrow */
780 BUILDARGS(SV* klass, ...)
783 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
790 BUILDALL(SV* self, SV* args)
793 SV* const meta = get_metaclass(self);
794 AV* const xc = mouse_get_xc(aTHX_ meta);
796 must_ref(args, "a HASH reference to BUILDALL", SVt_PVHV);
797 mouse_buildall(aTHX_ xc, self, args);