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 static MGVTBL mouse_xc_vtbl; /* for identity */
47 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
51 /* $meta->get_attribute_list */
56 n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
57 for(NOOP; n > 0; n--){
64 if(hv_exists_ent(seen, name, 0U)){
67 (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
69 av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
74 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
75 XS(XS_Mouse__Object_BUILDARGS); /* prototype */
77 GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
79 return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
83 mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stash, AV* const xc) {
84 AV* const linearized_isa = mro_get_linear_isa(stash);
85 I32 const len = AvFILLp(linearized_isa);
88 AV* const attrall = newAV();
89 AV* const buildall = newAV();
90 AV* const demolishall = newAV();
91 HV* const seen = newHV(); /* for attributes */
96 sv_2mortal((SV*)seen);
98 /* old data will be delete at the end of the perl scope */
99 av_delete(xc, MOUSE_XC_DEMOLISHALL, 0x00);
100 av_delete(xc, MOUSE_XC_BUILDALL, 0x00);
101 av_delete(xc, MOUSE_XC_ATTRALL, 0x00);
103 SvREFCNT_inc_simple_void_NN(linearized_isa);
104 sv_2mortal((SV*)linearized_isa);
108 if(predicate_calls(metaclass, "is_immutable")){
109 flags |= MOUSEf_XC_IS_IMMUTABLE;
112 if(predicate_calls(metaclass, "is_anon_class")){
113 flags |= MOUSEf_XC_IS_ANON;
116 if(mouse_class_has_custom_buildargs(aTHX_ stash)){
117 flags |= MOUSEf_XC_HAS_BUILDARGS;
120 if(predicate_calls(metaclass, "__strict_constructor")){
121 flags |= MOUSEf_XC_CONSTRUCTOR_IS_STRICT;
124 av_store(xc, MOUSE_XC_FLAGS, newSVuv(flags));
125 av_store(xc, MOUSE_XC_ATTRALL, (SV*)attrall);
126 av_store(xc, MOUSE_XC_BUILDALL, (SV*)buildall);
127 av_store(xc, MOUSE_XC_DEMOLISHALL, (SV*)demolishall);
129 for(i = 0; i < len; i++){
130 SV* const klass = MOUSE_av_at(linearized_isa, i);
131 HV* const st = gv_stashsv(klass, TRUE);
135 gv = stash_fetchs(st, "BUILD", FALSE);
137 av_unshift(buildall, 1);
138 av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
141 gv = stash_fetchs(st, "DEMOLISH", FALSE);
143 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
147 meta = get_metaclass(klass);
149 continue; /* skip non-Mouse classes */
152 mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
158 sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
162 mouse_get_xc(pTHX_ SV* const metaclass) {
168 if(!IsObject(metaclass)){
169 croak("Not a Mouse metaclass");
172 mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
174 SV* const package = get_slot(metaclass, mouse_package);
176 const char* const pv = SvPV_const(package, len);
178 stash = gv_stashpvn(pv, len, TRUE);
181 mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
182 SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
184 av_extend(xc, MOUSE_XC_last - 1);
186 av_store(xc, MOUSE_XC_GEN, newSVuv(0U));
187 av_store(xc, MOUSE_XC_STASH, (SV*)stash);
189 SvREFCNT_inc_simple_void_NN(stash);
192 xc = (AV*)MOUSE_mg_obj(mg);
195 assert(SvTYPE(xc) == SVt_PVAV);
198 gen = MOUSE_xc_gen(xc);
200 if(SvUVX(gen) != 0U && MOUSE_xc_flags(xc) & MOUSEf_XC_IS_IMMUTABLE){
204 stash = MOUSE_xc_stash(xc);
206 if(SvUVX(gen) != mro_get_pkg_gen(stash)){
207 mouse_class_update_xc(aTHX_ metaclass, stash, xc);
214 mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
222 SV* const args_ref = ST(0);
223 if(!IsHashRef(args_ref)){
224 if(!metaclass){ metaclass = get_metaclass(klass); }
225 mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
227 args = newHVhv((HV*)SvRV(args_ref));
228 sv_2mortal((SV*)args);
233 args = newHV_mortal();
235 if( (items % 2) != 0 ){
236 if(!metaclass){ metaclass = get_metaclass(klass); }
237 mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
240 for(i = 0; i < items; i += 2){
241 (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
249 mouse_report_unknown_args(pTHX_ SV* const meta, AV* const attrs, HV* const args) {
250 HV* const attr_map = newHV_mortal();
251 SV* const unknown = newSVpvs_flags("", SVs_TEMP);
252 I32 const len = AvFILLp(attrs) + 1;
256 for(i = 0; i < len; i++){
257 SV* const attr = MOUSE_av_at(attrs, i);
258 AV* const xa = mouse_get_xa(aTHX_ attr);
259 SV* const init_arg = MOUSE_xa_init_arg(xa);
261 (void)hv_store_ent(attr_map, init_arg, &PL_sv_undef, 0U);
266 while((he = hv_iternext(args))){
267 SV* const key = hv_iterkeysv(he);
268 if(!hv_exists_ent(attr_map, key, 0U)){
269 sv_catpvf(unknown, "%"SVf", ", key);
273 if(SvCUR(unknown) > 0){
274 SvCUR(unknown) -= 2; /* chop "," */
277 sv_setpvs(unknown, "(unknown)");
280 mouse_throw_error(meta, NULL,
281 "Unknown attribute passed to the constructor of %"SVf": %"SVf,
282 mcall0(meta, mouse_name), unknown);
288 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
289 AV* const xc = mouse_get_xc(aTHX_ meta);
290 AV* const attrs = MOUSE_xc_attrall(xc);
291 I32 len = AvFILLp(attrs) + 1;
293 AV* triggers_queue = NULL;
296 assert(meta || object);
298 assert(SvTYPE(args) == SVt_PVHV);
300 if(mg_find((SV*)args, PERL_MAGIC_tied)){
301 croak("You cannot use tied HASH reference as initializing arguments");
304 if(!ignore_triggers){
305 triggers_queue = newAV_mortal();
308 /* for each attribute */
309 for(i = 0; i < len; i++){
310 SV* const attr = MOUSE_av_at(attrs, i);
311 AV* const xa = mouse_get_xa(aTHX_ attr);
313 SV* const slot = MOUSE_xa_slot(xa);
314 U16 const flags = (U16)MOUSE_xa_flags(xa);
315 SV* const init_arg = MOUSE_xa_init_arg(xa);
318 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
319 SV* value = HeVAL(he);
320 if(flags & MOUSEf_ATTR_HAS_TC){
321 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
323 value = set_slot(object, slot, value);
324 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
325 weaken_slot(object, slot);
327 if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
328 AV* const pair = newAV();
329 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
330 av_push(pair, newSVsv(value));
332 av_push(triggers_queue, (SV*)pair);
336 else { /* no init arg */
337 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
338 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
339 mouse_xa_set_default(aTHX_ xa, object);
342 else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
343 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
346 } /* for each attribute */
348 if(MOUSE_xc_flags(xc) & MOUSEf_XC_CONSTRUCTOR_IS_STRICT && used < HvUSEDKEYS(args)){
349 mouse_report_unknown_args(aTHX_ meta, attrs, args);
353 len = AvFILLp(triggers_queue) + 1;
354 for(i = 0; i < len; i++){
355 AV* const pair = (AV*)AvARRAY(triggers_queue)[i];
356 SV* const trigger = AvARRAY(pair)[0];
357 SV* const value = AvARRAY(pair)[1];
359 mcall1(object, trigger, value);
363 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
364 (void)set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
370 mouse_initialize_metaclass(pTHX_ SV* const klass) {
371 SV* meta = get_metaclass(klass);
378 mPUSHp("Mouse::Meta::Class", sizeof("Mouse::Meta::Class")-1);
382 call_method("initialize", G_SCALAR);
392 mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
393 AV* const buildall = MOUSE_xc_buildall(xc);
394 I32 const len = AvFILLp(buildall) + 1;
396 for(i = 0; i < len; i++){
405 call_sv(AvARRAY(buildall)[i], G_VOID);
407 /* discard a scalar which G_VOID returns */
414 MODULE = Mouse PACKAGE = Mouse
419 mouse_package = newSVpvs_share("package");
420 mouse_namespace = newSVpvs_share("namespace");
421 mouse_methods = newSVpvs_share("methods");
422 mouse_name = newSVpvs_share("name");
423 mouse_coerce = newSVpvs_share("coerce");
425 mouse_get_attribute = newSVpvs_share("get_attribute");
426 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
428 MOUSE_CALL_BOOT(Mouse__Util);
429 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
430 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
431 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
434 MODULE = Mouse PACKAGE = Mouse::Meta::Module
437 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
438 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
439 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
445 SV* const package = get_slot(self, mouse_package);
446 if(!(package && SvOK(package))){
447 croak("No package name defined");
449 RETVAL = gv_stashsv(package, GV_ADDMULTI);
454 # ignore extra arguments for extensibility
456 add_method(SV* self, SV* name, SV* code, ...)
459 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
460 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
464 if(!(package && SvOK(package))){
465 croak("No package name defined");
472 mouse_throw_error(self, NULL, "You must define a method name");
475 mouse_throw_error(self, NULL, "You must define a CODE reference");
479 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
480 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
481 SV** sp = &sv; /* used in tryAMAGICunDEREF */
482 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
483 if(!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV)){
484 mouse_throw_error(self, NULL, "You must pass a CODE reference to add_method");
489 /* *{$package . '::' . $name} -> *gv */
490 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
491 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
492 SvREFCNT_dec(GvCV(gv));
495 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
497 (void)set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
499 /* name the CODE ref if it's anonymous */
501 CV* const code_entity = (CV*)SvRV(code_ref);
502 if(CvANON(code_entity)
503 && CvGV(code_entity) /* a cv under construction has no gv */ ){
506 /* update %DB::sub to make NYTProf happy */
507 if((PL_perldb & (PERLDBf_SUBLINE|PERLDB_NAMEANON))
508 && PL_DBsub && (dbsub = GvHV(PL_DBsub))
510 /* see Perl_newATTRSUB() in op.c */
511 SV* const subname = sv_newmortal();
514 gv_efullname3(subname, CvGV(code_entity), NULL);
515 orig = hv_fetch_ent(dbsub, subname, FALSE, 0U);
517 gv_efullname3(subname, gv, NULL);
518 (void)hv_store_ent(dbsub, subname, HeVAL(orig), 0U);
519 SvREFCNT_inc_simple_void_NN(HeVAL(orig));
523 CvGV(code_entity) = gv;
524 CvANON_off(code_entity);
529 MODULE = Mouse PACKAGE = Mouse::Meta::Class
532 INSTALL_SIMPLE_READER(Class, roles);
533 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
534 INSTALL_SIMPLE_READER(Class, is_immutable);
535 INSTALL_SIMPLE_READER_WITH_KEY(Class, __strict_constructor, strict_constructor);
537 INSTALL_CLASS_HOLDER(Class, method_metaclass, "Mouse::Meta::Method");
538 INSTALL_CLASS_HOLDER(Class, attribute_metaclass, "Mouse::Meta::Attribute");
539 INSTALL_CLASS_HOLDER(Class, constructor_class, "Mouse::Meta::Method::Constructor::XS");
540 INSTALL_CLASS_HOLDER(Class, destructor_class, "Mouse::Meta::Method::Destructor::XS");
542 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
543 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
544 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
545 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
549 linearized_isa(SV* self)
552 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
556 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
557 croak("namespace() didn't return a HASH reference");
559 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
560 len = AvFILLp(linearized_isa) + 1;
562 for(i = 0; i < len; i++){
563 PUSHs(AvARRAY(linearized_isa)[i]);
568 get_all_attributes(SV* self)
571 AV* const xc = mouse_get_xc(aTHX_ self);
572 AV* const all_attrs = MOUSE_xc_attrall(xc);
573 I32 const len = AvFILLp(all_attrs) + 1;
577 for(i = 0; i < len; i++){
578 PUSHs( MOUSE_av_at(all_attrs, i) );
583 new_object(SV* meta, ...)
586 AV* const xc = mouse_get_xc(aTHX_ meta);
587 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
589 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
590 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
596 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
599 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
602 MODULE = Mouse PACKAGE = Mouse::Meta::Role
605 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
606 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
608 INSTALL_CLASS_HOLDER(Role, method_metaclass, "Mouse::Meta::Role::Method");
610 MODULE = Mouse PACKAGE = Mouse::Object
616 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
617 AV* const xc = mouse_get_xc(aTHX_ meta);
618 UV const flags = MOUSE_xc_flags(xc);
622 if(flags & MOUSEf_XC_HAS_BUILDARGS){
628 for(i = 0; i < items; i++){
633 call_method("BUILDARGS", G_SCALAR);
638 if(!IsHashRef(args)){
639 croak("BUILDARGS did not return a HASH reference");
643 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
648 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
649 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
651 mouse_buildall(aTHX_ xc, RETVAL, args);
663 SV* const meta = get_metaclass(object);
667 if(!IsObject(object)){
668 croak("You must not call %s as a class method",
669 ix == 0 ? "DESTROY" : "DEMOLISHALL");
673 AV* const xc = mouse_get_xc(aTHX_ meta);
675 demolishall = MOUSE_xc_demolishall(xc);
677 else { /* The metaclass is already destroyed */
678 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
680 len = AvFILLp(linearized_isa) + 1;
682 demolishall = newAV_mortal();
683 for(i = 0; i < len; i++){
684 SV* const klass = MOUSE_av_at(linearized_isa, i);
685 HV* const st = gv_stashsv(klass, TRUE);
686 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
688 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
693 len = AvFILLp(demolishall) + 1;
695 GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
697 if(statusvalue){ /* it can be NULL */
698 SAVESPTR(GvSV(statusvalue)); /* local $? */
699 GvSV(statusvalue) = sv_newmortal();
701 SAVESPTR(ERRSV); /* local $@ */
702 ERRSV = newSVpvs_flags("", SVs_TEMP);
704 for(i = 0; i < len; i++){
709 XPUSHs(boolSV(PL_dirty));
712 call_sv(AvARRAY(demolishall)[i], G_VOID | G_EVAL);
714 /* discard a scalar which G_VOID returns */
720 SV* const e = newSVsv(ERRSV);
727 croak(NULL); /* rethrow */
734 BUILDARGS(SV* klass, ...)
737 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
744 BUILDALL(SV* self, SV* args)
747 SV* const meta = get_metaclass(self);
748 AV* const xc = mouse_get_xc(aTHX_ meta);
750 if(!IsHashRef(args)){
751 croak("You must pass a HASH reference to BUILDALL");
753 mouse_buildall(aTHX_ xc, self, args);