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 ignore_triggers) {
295 AV* const xc = mouse_get_xc(aTHX_ meta);
296 AV* const attrs = MOUSE_xc_attrall(xc);
297 I32 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 if(!ignore_triggers){
311 triggers_queue = newAV_mortal();
314 /* for each attribute */
315 for(i = 0; i < len; i++){
316 SV* const attr = MOUSE_av_at(attrs, i);
317 AV* const xa = mouse_get_xa(aTHX_ attr);
319 SV* const slot = MOUSE_xa_slot(xa);
320 U16 const flags = (U16)MOUSE_xa_flags(xa);
321 SV* const init_arg = MOUSE_xa_init_arg(xa);
324 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
325 SV* value = HeVAL(he);
326 if(flags & MOUSEf_ATTR_HAS_TC){
327 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
329 value = set_slot(object, slot, value);
330 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
331 weaken_slot(object, slot);
333 if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
334 AV* const pair = newAV();
335 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
336 av_push(pair, newSVsv(value));
338 av_push(triggers_queue, (SV*)pair);
342 else { /* no init arg */
343 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
344 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
345 mouse_xa_set_default(aTHX_ xa, object);
348 else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
349 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
352 } /* for each attribute */
354 if(MOUSE_xc_flags(xc) & MOUSEf_XC_CONSTRUCTOR_IS_STRICT && used < HvUSEDKEYS(args)){
355 mouse_report_unknown_args(aTHX_ meta, attrs, args);
359 len = AvFILLp(triggers_queue) + 1;
360 for(i = 0; i < len; i++){
361 AV* const pair = (AV*)AvARRAY(triggers_queue)[i];
362 SV* const trigger = AvARRAY(pair)[0];
363 SV* const value = AvARRAY(pair)[1];
365 mcall1(object, trigger, value);
369 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
370 (void)set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
376 mouse_initialize_metaclass(pTHX_ SV* const klass) {
377 SV* meta = get_metaclass(klass);
384 mPUSHp("Mouse::Meta::Class", sizeof("Mouse::Meta::Class")-1);
388 call_method("initialize", G_SCALAR);
398 mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
399 AV* const buildall = MOUSE_xc_buildall(xc);
400 I32 const len = AvFILLp(buildall) + 1;
402 for(i = 0; i < len; i++){
411 call_sv(AvARRAY(buildall)[i], G_VOID);
413 /* discard a scalar which G_VOID returns */
421 mouse_get_modifier_storage(pTHX_
423 enum mouse_modifier_t const m, SV* const name) {
424 static const char* const keys[] = {
429 SV* const key = sv_2mortal(Perl_newSVpvf(aTHX_ "%s_method_modifiers", keys[m]));
435 mouse_throw_error(meta, NULL, "You must define a method name for '%s' modifiers", keys[m]);
438 table = get_slot(meta, key);
441 /* $meta->{$key} = {} */
442 table = sv_2mortal(newRV_noinc((SV*)newHV()));
443 set_slot(meta, key, table);
446 storage_ref = get_slot(table, name);
449 storage_ref = sv_2mortal(newRV_noinc((SV*)newAV()));
450 set_slot(table, name, storage_ref);
453 if(!IsArrayRef(storage_ref)){
454 croak("Modifier strorage for '%s' is not an ARRAY reference", keys[m]);
458 return (AV*)SvRV(storage_ref);
461 MODULE = Mouse PACKAGE = Mouse
466 mouse_package = newSVpvs_share("package");
467 mouse_namespace = newSVpvs_share("namespace");
468 mouse_methods = newSVpvs_share("methods");
469 mouse_name = newSVpvs_share("name");
470 mouse_coerce = newSVpvs_share("coerce");
472 mouse_get_attribute = newSVpvs_share("get_attribute");
473 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
475 MOUSE_CALL_BOOT(Mouse__Util);
476 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
477 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
478 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
481 MODULE = Mouse PACKAGE = Mouse::Meta::Module
484 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
485 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
486 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
492 SV* const package = get_slot(self, mouse_package);
493 if(!(package && SvOK(package))){
494 croak("No package name defined");
496 RETVAL = gv_stashsv(package, GV_ADDMULTI);
501 # ignore extra arguments for extensibility
503 add_method(SV* self, SV* name, SV* code, ...)
506 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
507 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
511 if(!(package && SvOK(package))){
512 croak("No package name defined");
519 mouse_throw_error(self, NULL, "You must define a method name");
522 mouse_throw_error(self, NULL, "You must define a CODE reference");
526 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
527 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
528 SV** sp = &sv; /* used in tryAMAGICunDEREF */
529 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
530 if(!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV)){
531 mouse_throw_error(self, NULL, "You must pass a CODE reference to add_method");
536 /* *{$package . '::' . $name} -> *gv */
537 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
538 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
539 SvREFCNT_dec(GvCV(gv));
542 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
544 (void)set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
546 /* name the CODE ref if it's anonymous */
548 CV* const code_entity = (CV*)SvRV(code_ref);
549 if(CvANON(code_entity)
550 && CvGV(code_entity) /* a cv under construction has no gv */ ){
553 /* update %DB::sub to make NYTProf happy */
554 if((PL_perldb & (PERLDBf_SUBLINE|PERLDB_NAMEANON))
555 && PL_DBsub && (dbsub = GvHV(PL_DBsub))
557 /* see Perl_newATTRSUB() in op.c */
558 SV* const subname = sv_newmortal();
561 gv_efullname3(subname, CvGV(code_entity), NULL);
562 orig = hv_fetch_ent(dbsub, subname, FALSE, 0U);
564 gv_efullname3(subname, gv, NULL);
565 (void)hv_store_ent(dbsub, subname, HeVAL(orig), 0U);
566 SvREFCNT_inc_simple_void_NN(HeVAL(orig));
570 CvGV(code_entity) = gv;
571 CvANON_off(code_entity);
576 MODULE = Mouse PACKAGE = Mouse::Meta::Class
579 INSTALL_SIMPLE_READER(Class, roles);
580 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
581 INSTALL_SIMPLE_READER(Class, is_immutable);
582 INSTALL_SIMPLE_READER_WITH_KEY(Class, __strict_constructor, strict_constructor);
584 INSTALL_CLASS_HOLDER(Class, method_metaclass, "Mouse::Meta::Method");
585 INSTALL_CLASS_HOLDER(Class, attribute_metaclass, "Mouse::Meta::Attribute");
586 INSTALL_CLASS_HOLDER(Class, constructor_class, "Mouse::Meta::Method::Constructor::XS");
587 INSTALL_CLASS_HOLDER(Class, destructor_class, "Mouse::Meta::Method::Destructor::XS");
589 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
590 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
591 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
592 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
596 linearized_isa(SV* self)
599 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
603 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
604 croak("namespace() didn't return a HASH reference");
606 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
607 len = AvFILLp(linearized_isa) + 1;
609 for(i = 0; i < len; i++){
610 PUSHs(AvARRAY(linearized_isa)[i]);
615 get_all_attributes(SV* self)
618 AV* const xc = mouse_get_xc(aTHX_ self);
619 AV* const all_attrs = MOUSE_xc_attrall(xc);
620 I32 const len = AvFILLp(all_attrs) + 1;
624 for(i = 0; i < len; i++){
625 PUSHs( MOUSE_av_at(all_attrs, i) );
630 new_object(SV* meta, ...)
633 AV* const xc = mouse_get_xc(aTHX_ meta);
634 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
636 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
637 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
643 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
646 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
649 MODULE = Mouse PACKAGE = Mouse::Meta::Role
652 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
653 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
655 INSTALL_CLASS_HOLDER(Role, method_metaclass, "Mouse::Meta::Role::Method");
658 add_before_modifier(SV* self, SV* name, SV* modifier)
661 av_push(mouse_get_modifier_storage(aTHX_ self, ix, name), newSVsv(modifier));
664 add_before_method_modifier = MOUSE_M_BEFORE
665 add_around_method_modifier = MOUSE_M_AROUND
666 add_after_method_modifier = MOUSE_M_AFTER
669 get_before_modifiers(SV* self, SV* name)
671 get_before_method_modifiers = MOUSE_M_BEFORE
672 get_around_method_modifiers = MOUSE_M_AROUND
673 get_after_method_modifiers = MOUSE_M_AFTER
676 AV* const storage = mouse_get_modifier_storage(aTHX_ self, ix, name);
677 I32 const len = av_len(storage) + 1;
678 if(GIMME_V == G_ARRAY) {
681 for(i = 0; i < len; i++){
682 PUSHs(*av_fetch(storage, i, TRUE));
690 MODULE = Mouse PACKAGE = Mouse::Object
696 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
697 AV* const xc = mouse_get_xc(aTHX_ meta);
698 UV const flags = MOUSE_xc_flags(xc);
702 if(flags & MOUSEf_XC_HAS_BUILDARGS){
708 for(i = 0; i < items; i++){
713 call_method("BUILDARGS", G_SCALAR);
718 if(!IsHashRef(args)){
719 croak("BUILDARGS did not return a HASH reference");
723 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
728 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
729 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
731 mouse_buildall(aTHX_ xc, RETVAL, args);
743 SV* const meta = get_metaclass(object);
747 if(!IsObject(object)){
748 croak("You must not call %s as a class method",
749 ix == 0 ? "DESTROY" : "DEMOLISHALL");
753 AV* const xc = mouse_get_xc(aTHX_ meta);
755 demolishall = MOUSE_xc_demolishall(xc);
757 else { /* The metaclass is already destroyed */
758 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
760 len = AvFILLp(linearized_isa) + 1;
762 demolishall = newAV_mortal();
763 for(i = 0; i < len; i++){
764 SV* const klass = MOUSE_av_at(linearized_isa, i);
765 HV* const st = gv_stashsv(klass, TRUE);
766 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
768 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
773 len = AvFILLp(demolishall) + 1;
775 GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
777 if(statusvalue){ /* it can be NULL */
778 SAVESPTR(GvSV(statusvalue)); /* local $? */
779 GvSV(statusvalue) = sv_newmortal();
781 SAVESPTR(ERRSV); /* local $@ */
782 ERRSV = newSVpvs_flags("", SVs_TEMP);
784 for(i = 0; i < len; i++){
789 XPUSHs(boolSV(PL_dirty));
792 call_sv(AvARRAY(demolishall)[i], G_VOID | G_EVAL);
794 /* discard a scalar which G_VOID returns */
800 SV* const e = newSVsv(ERRSV);
807 croak(NULL); /* rethrow */
814 BUILDARGS(SV* klass, ...)
817 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
824 BUILDALL(SV* self, SV* args)
827 SV* const meta = get_metaclass(self);
828 AV* const xc = mouse_get_xc(aTHX_ meta);
830 if(!IsHashRef(args)){
831 croak("You must pass a HASH reference to BUILDALL");
833 mouse_buildall(aTHX_ xc, self, args);