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_report_unmatched_keys(pTHX_ SV* const meta, AV* const attrs, HV* const args) {
242 HV* const attr_map = newHV_mortal();
243 I32 const len = AvFILLp(attrs) + 1;
245 SV* const unknown = newSVpvs_flags("", SVs_TEMP);
248 for(i = 0; i < len; i++){
249 SV* const attr = MOUSE_av_at(attrs, i);
250 (void)hv_store_ent(attr_map, mcall0(attr, mouse_name), &PL_sv_yes, 0U);
254 while((he = hv_iternext(args))){
255 SV* const key = hv_iterkeysv(he);
256 if(!hv_exists_ent(attr_map, key, 0U)){
257 sv_catpvf(unknown, " %"SVf",", key);
260 SvCUR(unknown)--; /* chop "," */
261 mouse_throw_error(meta, NULL,
262 "Unknown attribute init_arg passed to the constructor of %"SVf": %"SVf,
263 mcall0(meta, mouse_name), unknown);
267 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
268 AV* const xc = mouse_get_xc(aTHX_ meta);
269 AV* const attrs = MOUSE_xc_attrall(xc);
270 I32 len = AvFILLp(attrs) + 1;
273 AV* triggers_queue = NULL;
275 assert(meta || object);
277 assert(SvTYPE(args) == SVt_PVHV);
282 if(!ignore_triggers){
283 triggers_queue = newAV_mortal();
286 for(i = 0; i < len; i++){
287 SV* const attr = MOUSE_av_at(attrs, i);
288 AV* const xa = mouse_get_xa(aTHX_ attr);
290 SV* const slot = MOUSE_xa_slot(xa);
291 U16 const flags = (U16)MOUSE_xa_flags(xa);
292 SV* const init_arg = MOUSE_xa_init_arg(xa);
295 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
296 SV* value = HeVAL(he);
297 if(flags & MOUSEf_ATTR_HAS_TC){
298 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
300 set_slot(object, slot, value);
301 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
302 weaken_slot(object, slot);
304 if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
305 AV* const pair = newAV();
306 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
307 av_push(pair, newSVsv(value));
309 av_push(triggers_queue, (SV*)pair);
314 else { /* no init arg */
315 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
316 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
317 mouse_xa_set_default(aTHX_ xa, object);
320 else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
321 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
324 } /* for each attributes */
327 len = AvFILLp(triggers_queue) + 1;
328 for(i = 0; i < len; i++){
329 AV* const pair = (AV*)AvARRAY(triggers_queue)[i];
330 SV* const trigger = AvARRAY(pair)[0];
331 SV* const value = AvARRAY(pair)[1];
333 mcall1(object, trigger, value);
337 if(used < HvUSEDKEYS(args)){
338 mouse_report_unmatched_keys(aTHX_ meta, attrs, args);
341 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
342 set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
350 mouse_initialize_metaclass(pTHX_ SV* const klass) {
351 SV* meta = get_metaclass(klass);
358 mPUSHp("Mouse::Meta::Class", sizeof("Mouse::Meta::Class")-1);
362 call_method("initialize", G_SCALAR);
372 mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
373 AV* const buildall = MOUSE_xc_buildall(xc);
374 I32 const len = AvFILLp(buildall) + 1;
376 for(i = 0; i < len; i++){
385 call_sv(AvARRAY(buildall)[i], G_VOID | G_DISCARD);
389 MODULE = Mouse PACKAGE = Mouse
394 mouse_package = newSVpvs_share("package");
395 mouse_namespace = newSVpvs_share("namespace");
396 mouse_methods = newSVpvs_share("methods");
397 mouse_name = newSVpvs_share("name");
399 mouse_get_attribute = newSVpvs_share("get_attribute");
400 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
402 MOUSE_CALL_BOOT(Mouse__Util);
403 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
404 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
405 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
408 MODULE = Mouse PACKAGE = Mouse::Meta::Module
411 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
412 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
413 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
419 SV* const package = get_slot(self, mouse_package);
420 if(!(package && SvOK(package))){
421 croak("No package name defined");
423 RETVAL = gv_stashsv(package, GV_ADDMULTI);
428 # ignore extra arguments for extensibility
430 add_method(SV* self, SV* name, SV* code, ...)
433 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
434 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
438 if(!(package && SvOK(package))){
439 croak("No package name defined");
446 mouse_throw_error(self, NULL, "You must define a method name");
449 mouse_throw_error(self, NULL, "You must define a CODE reference");
453 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
454 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
455 SV** sp = &sv; /* used in tryAMAGICunDEREF */
456 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
457 if(!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV)){
458 mouse_throw_error(self, NULL, "You must pass a CODE reference to add_method");
463 /* *{$package . '::' . $name} -> *gv */
464 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
465 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
466 SvREFCNT_dec(GvCV(gv));
469 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
471 set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
473 /* name the CODE ref if it's anonymous */
475 CV* const code_entity = (CV*)SvRV(code_ref);
476 if(CvANON(code_entity)
477 && CvGV(code_entity) /* a cv under construction has no gv */ ){
479 CvGV(code_entity) = gv;
480 CvANON_off(code_entity);
485 MODULE = Mouse PACKAGE = Mouse::Meta::Class
488 INSTALL_SIMPLE_READER(Class, roles);
489 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
490 INSTALL_SIMPLE_READER(Class, is_immutable);
492 INSTALL_CLASS_HOLDER(Class, method_metaclass, "Mouse::Meta::Method");
493 INSTALL_CLASS_HOLDER(Class, attribute_metaclass, "Mouse::Meta::Attribute");
494 INSTALL_CLASS_HOLDER(Class, constructor_class, "Mouse::Meta::Method::Constructor::XS");
495 INSTALL_CLASS_HOLDER(Class, destructor_class, "Mouse::Meta::Method::Destructor::XS");
497 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
498 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
499 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
500 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
504 linearized_isa(SV* self)
507 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
511 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
512 croak("namespace() didn't return a HASH reference");
514 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
515 len = AvFILLp(linearized_isa) + 1;
517 for(i = 0; i < len; i++){
518 PUSHs(AvARRAY(linearized_isa)[i]);
523 get_all_attributes(SV* self)
526 AV* const xc = mouse_get_xc(aTHX_ self);
527 AV* const all_attrs = MOUSE_xc_attrall(xc);
528 I32 const len = AvFILLp(all_attrs) + 1;
532 for(i = 0; i < len; i++){
533 PUSHs( MOUSE_av_at(all_attrs, i) );
538 new_object(SV* meta, ...)
541 AV* const xc = mouse_get_xc(aTHX_ meta);
542 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
544 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
545 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
551 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
554 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
557 MODULE = Mouse PACKAGE = Mouse::Meta::Role
560 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
561 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
563 INSTALL_CLASS_HOLDER(Role, method_metaclass, "Mouse::Meta::Role::Method");
565 MODULE = Mouse PACKAGE = Mouse::Object
571 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
572 AV* const xc = mouse_get_xc(aTHX_ meta);
573 UV const flags = MOUSE_xc_flags(xc);
577 if(flags & MOUSEf_XC_HAS_BUILDARGS){
583 for(i = 0; i < items; i++){
588 call_method("BUILDARGS", G_SCALAR);
593 if(!IsHashRef(args)){
594 croak("BUILDARGS did not return a HASH reference");
598 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
603 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
604 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
606 mouse_buildall(aTHX_ xc, RETVAL, args);
618 SV* const meta = get_metaclass(object);
624 if(!IsObject(object)){
625 croak("You must not call DESTROY as a class method");
629 AV* const xc = mouse_get_xc(aTHX_ meta);
631 demolishall = MOUSE_xc_demolishall(xc);
633 else { /* The metaclass is already destroyed */
634 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
636 len = AvFILLp(linearized_isa) + 1;
638 demolishall = newAV_mortal();
639 for(i = 0; i < len; i++){
640 SV* const klass = MOUSE_av_at(linearized_isa, i);
641 HV* const st = gv_stashsv(klass, TRUE);
642 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
644 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
649 len = AvFILLp(demolishall) + 1;
651 GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
652 SAVESPTR(GvSV(statusvalue)); /* local $? */
653 SAVESPTR(ERRSV); /* local $@ */
655 GvSV(statusvalue) = sv_newmortal();
656 ERRSV = newSVpvs_flags("", SVs_TEMP);
657 for(i = 0; i < len; i++){
664 call_sv(AvARRAY(demolishall)[i], G_VOID | G_DISCARD | G_EVAL);
666 SV* const e = newSVsv(ERRSV);
673 croak(NULL); /* rethrow */
680 BUILDARGS(SV* klass, ...)
683 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
690 BUILDALL(SV* self, SV* args)
693 SV* const meta = get_metaclass(self);
694 AV* const xc = mouse_get_xc(aTHX_ meta);
696 if(!IsHashRef(args)){
697 croak("You must pass a HASH reference to BUILDALL");
699 if(mg_find(SvRV(args), PERL_MAGIC_tied)){
700 croak("You cannot use tie HASH reference as args");
702 mouse_buildall(aTHX_ xc, self, args);