1 #define NEED_newSVpvn_flags_GLOBAL
8 SV* mouse_get_attribute;
9 SV* mouse_get_attribute_list;
11 #define MOUSE_xc_flags(a) SvUVX(MOUSE_av_at((a), MOUSE_XC_FLAGS))
12 #define MOUSE_xc_gen(a) MOUSE_av_at((a), MOUSE_XC_GEN)
13 #define MOUSE_xc_stash(a) ( (HV*)MOUSE_av_at((a), MOUSE_XC_STASH) )
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) )
16 #define MOUSE_xc_demolishall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_DEMOLISHALL) )
18 enum mouse_xc_flags_t {
19 MOUSEf_XC_IS_IMMUTABLE = 0x0001,
20 MOUSEf_XC_IS_ANON = 0x0002,
21 MOUSEf_XC_HAS_BUILDARGS = 0x0004,
23 MOUSEf_XC_mask = 0xFFFF /* not used */
26 /* Mouse XS Metaclass object */
30 MOUSE_XC_GEN, /* class generation */
31 MOUSE_XC_STASH, /* symbol table hash */
33 MOUSE_XC_ATTRALL, /* all the attributes */
34 MOUSE_XC_BUILDALL, /* all the BUILD methods */
35 MOUSE_XC_DEMOLISHALL, /* all the DEMOLISH methods */
40 static MGVTBL mouse_xc_vtbl; /* for identity */
43 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
47 /* $meta->get_attribute_list */
52 n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
53 for(NOOP; n > 0; n--){
60 if(hv_exists_ent(seen, name, 0U)){
63 (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
65 av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
70 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
71 XS(XS_Mouse__Object_BUILDARGS); /* prototype */
73 GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
75 return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
79 mouse_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);
84 AV* const attrall = newAV();
85 AV* const buildall = newAV();
86 AV* const demolishall = newAV();
87 HV* const seen = newHV(); /* for attributes */
92 sv_2mortal((SV*)seen);
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);
99 SvREFCNT_inc_simple_void_NN(linearized_isa);
100 sv_2mortal((SV*)linearized_isa);
104 if(predicate_calls(metaclass, "is_immutable")){
105 flags |= MOUSEf_XC_IS_IMMUTABLE;
108 if(predicate_calls(metaclass, "is_anon_class")){
109 flags |= MOUSEf_XC_IS_ANON;
112 if(mouse_class_has_custom_buildargs(aTHX_ stash)){
113 flags |= MOUSEf_XC_HAS_BUILDARGS;
116 av_store(xc, MOUSE_XC_FLAGS, newSVuv(flags));
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);
121 for(i = 0; i < len; i++){
122 SV* const klass = MOUSE_av_at(linearized_isa, i);
123 HV* const st = gv_stashsv(klass, TRUE);
127 gv = stash_fetchs(st, "BUILD", FALSE);
129 av_unshift(buildall, 1);
130 av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
133 gv = stash_fetchs(st, "DEMOLISH", FALSE);
135 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
139 meta = get_metaclass(klass);
141 continue; /* skip non-Mouse classes */
144 mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
150 sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
154 mouse_get_xc(pTHX_ SV* const metaclass) {
160 if(!IsObject(metaclass)){
161 croak("Not a Mouse metaclass");
164 mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
166 SV* const package = get_slot(metaclass, mouse_package);
168 const char* const pv = SvPV_const(package, len);
170 stash = gv_stashpvn(pv, len, TRUE);
173 mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
174 SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
176 av_extend(xc, MOUSE_XC_last - 1);
178 av_store(xc, MOUSE_XC_GEN, newSVuv(0U));
179 av_store(xc, MOUSE_XC_STASH, (SV*)stash);
181 SvREFCNT_inc_simple_void_NN(stash);
184 xc = (AV*)MOUSE_mg_obj(mg);
187 assert(SvTYPE(xc) == SVt_PVAV);
190 gen = MOUSE_xc_gen(xc);
192 if(SvUVX(gen) != 0U && MOUSE_xc_flags(xc) & MOUSEf_XC_IS_IMMUTABLE){
196 stash = MOUSE_xc_stash(xc);
198 if(SvUVX(gen) != mro_get_pkg_gen(stash)){
199 mouse_class_update_xc(aTHX_ metaclass, stash, xc);
206 mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
214 SV* const args_ref = ST(0);
215 if(!IsHashRef(args_ref)){
216 if(!metaclass){ metaclass = get_metaclass(klass); }
217 mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
219 args = newHVhv((HV*)SvRV(args_ref));
220 sv_2mortal((SV*)args);
225 args = newHV_mortal();
227 if( (items % 2) != 0 ){
228 if(!metaclass){ metaclass = get_metaclass(klass); }
229 mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
232 for(i = 0; i < items; i += 2){
233 (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
241 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
242 AV* const xc = mouse_get_xc(aTHX_ meta);
243 AV* const attrs = MOUSE_xc_attrall(xc);
244 I32 len = AvFILLp(attrs) + 1;
246 AV* triggers_queue = NULL;
248 assert(meta || object);
250 assert(SvTYPE(args) == SVt_PVHV);
255 if(!ignore_triggers){
256 triggers_queue = newAV_mortal();
259 for(i = 0; i < len; i++){
260 SV* const attr = MOUSE_av_at(attrs, i);
261 AV* const xa = mouse_get_xa(aTHX_ attr);
263 SV* const slot = MOUSE_xa_slot(xa);
264 U16 const flags = (U16)MOUSE_xa_flags(xa);
265 SV* const init_arg = MOUSE_xa_init_arg(xa);
268 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
269 SV* value = HeVAL(he);
270 if(flags & MOUSEf_ATTR_HAS_TC){
271 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
273 set_slot(object, slot, value);
274 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
275 weaken_slot(object, slot);
277 if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
278 AV* const pair = newAV();
279 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
280 av_push(pair, newSVsv(value));
282 av_push(triggers_queue, (SV*)pair);
285 else { /* no init arg */
286 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
287 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
288 mouse_xa_set_default(aTHX_ xa, object);
291 else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
292 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
295 } /* for each attributes */
298 len = AvFILLp(triggers_queue) + 1;
299 for(i = 0; i < len; i++){
300 AV* const pair = (AV*)AvARRAY(triggers_queue)[i];
301 SV* const trigger = AvARRAY(pair)[0];
302 SV* const value = AvARRAY(pair)[1];
304 mcall1(object, trigger, value);
308 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
309 set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
317 mouse_initialize_metaclass(pTHX_ SV* const klass) {
318 SV* meta = get_metaclass(klass);
325 mPUSHp("Mouse::Meta::Class", sizeof("Mouse::Meta::Class")-1);
329 call_method("initialize", G_SCALAR);
339 /* copied from Class-MOP/topic/symbol-manipluator */
341 mouse_get_gv(pTHX_ SV* const self, svtype const type, const char* const var_name, I32 const var_name_len, I32 const flags){
347 SV* const ns = mcall0(self, mouse_namespace);
349 if(!(SvROK(ns) && SvTYPE(SvRV(ns)) == SVt_PVHV)){
350 croak("namespace() did not return a hash reference");
352 gvp = (GV**)hv_fetch((HV*)SvRV(ns), var_name, var_name_len, FALSE);
353 if(gvp && isGV_with_GP(*gvp)){
358 package_name = get_slot(self, mouse_package);
360 if(!(package_name && SvOK(package_name))){
361 croak("No package name defined");
364 pv = SvPV_const(package_name, len);
366 return gv_fetchpvn_flags(Perl_form(aTHX_ "%s::%s", pv, var_name), (len + var_name_len + 2), flags, type);
369 /* copied from Class-MOP/topic/symbol-manipluator */
371 mouse_gv_elem(pTHX_ GV* const gv, svtype const type, I32 const add){
378 assert(isGV_with_GP(gv));
382 sv = (SV*)(add ? GvAVn(gv) : GvAV(gv));
385 sv = (SV*)(add ? GvHVn(gv) : GvHV(gv));
391 sv = (SV*)(add ? GvIOn(gv) : GvIO(gv));
396 default: /* SCALAR */
397 sv = add ? GvSVn(gv) : GvSV(gv);
404 /* copied from Class-MOP/topic/symbol-manipluator */
406 mouse_deconstruct_variable_name(pTHX_ SV* const variable,
407 const char** const var_name, STRLEN* const var_name_len,
409 const char** const type_name) {
414 /* e.g. variable = '$foo' */
416 if(!SvOK(variable)) {
417 croak("You must pass a variable name");
419 pv = SvPV_const(variable, len);
421 croak("You must pass a variable name including a sigil");
425 *var_name_len = len - 1;
429 *type = SVt_PV; /* for all the types of scalars */
430 *type_name = "SCALAR";
434 *type_name = "ARRAY";
449 croak("I do not recognize that sigil '%c'", pv[0]);
454 MODULE = Mouse PACKAGE = Mouse
459 mouse_package = newSVpvs_share("package");
460 mouse_namespace = newSVpvs_share("namespace");
461 mouse_methods = newSVpvs_share("methods");
462 mouse_name = newSVpvs_share("name");
464 mouse_get_attribute = newSVpvs_share("get_attribute");
465 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
467 MOUSE_CALL_BOOT(Mouse__Util);
468 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
469 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
470 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
473 MODULE = Mouse PACKAGE = Mouse::Meta::Module
476 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
477 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
478 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
484 SV* const package = get_slot(self, mouse_package);
485 if(!(package && SvOK(package))){
486 croak("No package name defined");
488 RETVAL = gv_stashsv(package, GV_ADDMULTI);
493 # ignore extra arguments for extensibility
495 add_method(SV* self, SV* name, SV* code, ...)
498 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
499 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
503 if(!(package && SvOK(package))){
504 croak("No package name defined");
511 mouse_throw_error(self, NULL, "You must define a method name");
514 mouse_throw_error(self, NULL, "You must define a CODE reference");
518 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
519 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
520 SV** sp = &sv; /* used in tryAMAGICunDEREF */
521 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
522 if(!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV)){
523 mouse_throw_error(self, NULL, "You must pass a CODE reference to add_method");
528 /* *{$package . '::' . $name} -> *gv */
529 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
530 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
531 SvREFCNT_dec(GvCV(gv));
534 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
536 set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
538 /* name the CODE ref if it's anonymous */
540 CV* const code_entity = (CV*)SvRV(code_ref);
541 if(CvANON(code_entity)
542 && CvGV(code_entity) /* a cv under construction has no gv */ ){
544 CvGV(code_entity) = gv;
545 CvANON_off(code_entity);
551 has_package_symbol(SV* self, SV* variable)
554 const char* type_name;
555 const char* var_name;
559 mouse_deconstruct_variable_name(aTHX_ variable, &var_name, &var_name_len, &type, &type_name);
560 gv = mouse_get_gv(aTHX_ self, type, var_name, var_name_len, 0);
561 RETVAL = mouse_gv_elem(aTHX_ gv, type, FALSE) ? TRUE : FALSE;
566 get_package_symbol(SV* self, SV* variable)
569 const char* type_name;
570 const char* var_name;
576 mouse_deconstruct_variable_name(aTHX_ variable, &var_name, &var_name_len, &type, &type_name);
577 gv = mouse_get_gv(aTHX_ self, type, var_name, var_name_len, flags);
578 sv = mouse_gv_elem(aTHX_ gv, type, FALSE);
580 RETVAL = sv ? newRV_inc(sv) : &PL_sv_undef;
585 MODULE = Mouse PACKAGE = Mouse::Meta::Class
588 INSTALL_SIMPLE_READER(Class, roles);
589 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
591 INSTALL_CLASS_HOLDER(Class, method_metaclass, "Mouse::Meta::Method");
592 INSTALL_CLASS_HOLDER(Class, attribute_metaclass, "Mouse::Meta::Attribute");
593 INSTALL_CLASS_HOLDER(Class, constructor_class, "Mouse::Meta::Method::Constructor::XS");
594 INSTALL_CLASS_HOLDER(Class, destructor_class, "Mouse::Meta::Method::Destructor::XS");
596 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
597 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
598 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
599 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
603 linearized_isa(SV* self)
606 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
610 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
611 croak("namespace() didn't return a HASH reference");
613 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
614 len = AvFILLp(linearized_isa) + 1;
616 for(i = 0; i < len; i++){
617 PUSHs(AvARRAY(linearized_isa)[i]);
622 get_all_attributes(SV* self)
625 AV* const xc = mouse_get_xc(aTHX_ self);
626 AV* const all_attrs = MOUSE_xc_attrall(xc);
627 I32 const len = AvFILLp(all_attrs) + 1;
631 for(i = 0; i < len; i++){
632 PUSHs( MOUSE_av_at(all_attrs, i) );
637 new_object(SV* meta, ...)
640 AV* const xc = mouse_get_xc(aTHX_ meta);
641 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
643 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
644 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
650 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
653 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
656 MODULE = Mouse PACKAGE = Mouse::Meta::Role
659 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
660 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
662 INSTALL_CLASS_HOLDER(Role, method_metaclass, "Mouse::Meta::Role::Method");
664 MODULE = Mouse PACKAGE = Mouse::Object
670 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
671 AV* const xc = mouse_get_xc(aTHX_ meta);
672 UV const flags = MOUSE_xc_flags(xc);
678 if(flags & MOUSEf_XC_HAS_BUILDARGS){
683 for(i = 0; i < items; i++){
688 call_method("BUILDARGS", G_SCALAR);
693 if(!IsHashRef(args)){
694 croak("BUILDARGS did not return a HASH reference");
698 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
703 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
704 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
707 buildall = MOUSE_xc_buildall(xc);
708 len = AvFILLp(buildall) + 1;
709 for(i = 0; i < len; i++){
714 PUSHs(RETVAL); /* self */
718 call_sv(AvARRAY(buildall)[i], G_VOID | G_DISCARD);
728 SV* const meta = get_metaclass(object);
732 if(!IsObject(object)){
733 croak("You must not call DESTROY as a class method");
737 AV* const xc = mouse_get_xc(aTHX_ meta);
739 demolishall = MOUSE_xc_demolishall(xc);
742 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
744 len = AvFILLp(linearized_isa) + 1;
746 demolishall = newAV_mortal();
747 for(i = 0; i < len; i++){
748 SV* const klass = MOUSE_av_at(linearized_isa, i);
749 HV* const st = gv_stashsv(klass, TRUE);
750 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
752 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
758 len = AvFILLp(demolishall) + 1;
760 GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
761 SAVESPTR(GvSV(statusvalue)); /* local $? */
762 SAVESPTR(ERRSV); /* local $@ */
764 GvSV(statusvalue) = sv_2mortal(newSViv(0));
765 ERRSV = sv_2mortal(newSVpvs(""));
766 for(i = 0; i < len; i++){
773 call_sv(AvARRAY(demolishall)[i], G_VOID | G_DISCARD | G_EVAL);
775 SV* const e = newSVsv(ERRSV);
782 croak(NULL); /* rethrow */
789 BUILDARGS(SV* klass, ...)
792 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);