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 = AvARRAY(attrs)[i];
261 AV* const xa = mouse_get_xa(aTHX_ AvARRAY(attrs)[i]);
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("__ANON__", 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);
338 MODULE = Mouse PACKAGE = Mouse
343 mouse_package = newSVpvs_share("package");
344 mouse_namespace = newSVpvs_share("namespace");
345 mouse_methods = newSVpvs_share("methods");
346 mouse_name = newSVpvs_share("name");
348 mouse_get_attribute = newSVpvs_share("get_attribute");
349 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
351 MOUSE_CALL_BOOT(Mouse__Util);
352 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
353 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
354 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
357 MODULE = Mouse PACKAGE = Mouse::Meta::Module
360 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
361 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
362 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
368 SV* const package = get_slot(self, mouse_package);
369 if(!(package && SvOK(package))){
370 croak("No package name defined");
372 RETVAL = gv_stashsv(package, GV_ADDMULTI);
377 # ignore extra arguments for extensibility
379 add_method(SV* self, SV* name, SV* code, ...)
382 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
383 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
387 if(!(package && SvOK(package))){
388 croak("No package name defined");
395 mouse_throw_error(self, NULL, "You must define a method name");
398 mouse_throw_error(self, NULL, "You must define a CODE reference");
402 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
403 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
404 SV** sp = &sv; /* used in tryAMAGICunDEREF */
405 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
406 if(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV){
407 mouse_throw_error(self, NULL, "Not a CODE reference");
412 /* *{$package . '::' . $name} -> *gv */
413 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
414 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
415 SvREFCNT_dec(GvCV(gv));
418 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
420 set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
422 /* name the CODE ref if it's anonymous */
424 CV* const code_entity = (CV*)SvRV(code_ref);
425 if(CvANON(code_entity)
426 && CvGV(code_entity) /* a cv under construction has no gv */ ){
428 CvGV(code_entity) = gv;
429 CvANON_off(code_entity);
434 MODULE = Mouse PACKAGE = Mouse::Meta::Class
437 INSTALL_SIMPLE_READER(Class, roles);
438 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
439 newCONSTSUB(gv_stashpvs("Mouse::Meta::Class", TRUE), "constructor_class",
440 newSVpvs("Mouse::Meta::Method::Constructor::XS"));
441 newCONSTSUB(gv_stashpvs("Mouse::Meta::Class", TRUE), "destructor_class",
442 newSVpvs("Mouse::Meta::Method::Destructor::XS"));
445 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
446 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
447 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
448 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
452 linearized_isa(SV* self)
455 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
459 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
460 croak("namespace() didn't return a HASH reference");
462 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
463 len = AvFILLp(linearized_isa) + 1;
465 for(i = 0; i < len; i++){
466 PUSHs(AvARRAY(linearized_isa)[i]);
471 get_all_attributes(SV* self)
474 AV* const xc = mouse_get_xc(aTHX_ self);
475 AV* const all_attrs = MOUSE_xc_attrall(xc);
476 I32 const len = AvFILLp(all_attrs) + 1;
480 for(i = 0; i < len; i++){
481 PUSHs( MOUSE_av_at(all_attrs, i) );
486 new_object_(SV* meta, ...)
489 AV* const xc = mouse_get_xc(aTHX_ meta);
490 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
492 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
493 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
498 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
501 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
508 AV* const xc = mouse_get_xc(aTHX_ meta);
509 mXPUSHu(MOUSE_xc_flags(xc));
510 mXPUSHs(newRV_inc((SV*)MOUSE_xc_buildall(xc)));
511 mXPUSHs(newRV_inc((SV*)MOUSE_xc_demolishall(xc)));
514 MODULE = Mouse PACKAGE = Mouse::Meta::Role
517 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
518 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
520 MODULE = Mouse PACKAGE = Mouse::Object
526 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
527 AV* const xc = mouse_get_xc(aTHX_ meta);
528 UV const flags = MOUSE_xc_flags(xc);
534 if(flags & MOUSEf_XC_HAS_BUILDARGS){
539 for(i = 0; i < items; i++){
544 call_method("BUILDARGS", G_SCALAR);
549 if(!IsHashRef(args)){
550 croak("BUILDARGS did not return a HASH reference");
554 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
559 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
560 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
563 buildall = MOUSE_xc_buildall(xc);
564 len = AvFILLp(buildall) + 1;
565 for(i = 0; i < len; i++){
574 call_sv(AvARRAY(buildall)[i], G_VOID | G_DISCARD);
584 SV* const meta = get_metaclass(object);
588 if(!IsObject(object)){
589 croak("You must not call DESTROY as a class method");
593 AV* const xc = mouse_get_xc(aTHX_ meta);
595 demolishall = MOUSE_xc_demolishall(xc);
598 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
600 len = AvFILLp(linearized_isa) + 1;
602 demolishall = newAV_mortal();
603 for(i = 0; i < len; i++){
604 SV* const klass = MOUSE_av_at(linearized_isa, i);
605 HV* const st = gv_stashsv(klass, TRUE);
606 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
608 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
614 len = AvFILLp(demolishall) + 1;
616 GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
617 SAVESPTR(GvSV(statusvalue)); /* local $? */
618 SAVESPTR(ERRSV); /* local $@ */
620 GvSV(statusvalue) = sv_2mortal(newSViv(0));
621 ERRSV = sv_2mortal(newSVpvs(""));
622 for(i = 0; i < len; i++){
629 call_sv(AvARRAY(demolishall)[i], G_VOID | G_DISCARD | G_EVAL);
631 SV* const e = newSVsv(ERRSV);
638 croak(NULL); /* rethrow */
645 BUILDARGS(SV* klass, ...)
648 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);