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,
25 MOUSEf_XC_mask = 0xFFFF /* not used */
28 /* Mouse XS Metaclass object */
32 MOUSE_XC_GEN, /* class generation */
33 MOUSE_XC_STASH, /* symbol table hash */
35 MOUSE_XC_ATTRALL, /* all the attributes */
36 MOUSE_XC_BUILDALL, /* all the BUILD methods */
37 MOUSE_XC_DEMOLISHALL, /* all the DEMOLISH methods */
42 static MGVTBL mouse_xc_vtbl; /* for identity */
45 mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
49 /* $meta->get_attribute_list */
54 n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
55 for(NOOP; n > 0; n--){
62 if(hv_exists_ent(seen, name, 0U)){
65 (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
67 av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
72 mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
73 XS(XS_Mouse__Object_BUILDARGS); /* prototype */
75 GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
77 return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
81 mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stash, AV* const xc) {
82 AV* const linearized_isa = mro_get_linear_isa(stash);
83 I32 const len = AvFILLp(linearized_isa);
86 AV* const attrall = newAV();
87 AV* const buildall = newAV();
88 AV* const demolishall = newAV();
89 HV* const seen = newHV(); /* for attributes */
94 sv_2mortal((SV*)seen);
96 /* old data will be delete at the end of the perl scope */
97 av_delete(xc, MOUSE_XC_DEMOLISHALL, 0x00);
98 av_delete(xc, MOUSE_XC_BUILDALL, 0x00);
99 av_delete(xc, MOUSE_XC_ATTRALL, 0x00);
101 SvREFCNT_inc_simple_void_NN(linearized_isa);
102 sv_2mortal((SV*)linearized_isa);
106 if(predicate_calls(metaclass, "is_immutable")){
107 flags |= MOUSEf_XC_IS_IMMUTABLE;
110 if(predicate_calls(metaclass, "is_anon_class")){
111 flags |= MOUSEf_XC_IS_ANON;
114 if(mouse_class_has_custom_buildargs(aTHX_ stash)){
115 flags |= MOUSEf_XC_HAS_BUILDARGS;
118 av_store(xc, MOUSE_XC_FLAGS, newSVuv(flags));
119 av_store(xc, MOUSE_XC_ATTRALL, (SV*)attrall);
120 av_store(xc, MOUSE_XC_BUILDALL, (SV*)buildall);
121 av_store(xc, MOUSE_XC_DEMOLISHALL, (SV*)demolishall);
123 for(i = 0; i < len; i++){
124 SV* const klass = MOUSE_av_at(linearized_isa, i);
125 HV* const st = gv_stashsv(klass, TRUE);
129 gv = stash_fetchs(st, "BUILD", FALSE);
131 av_unshift(buildall, 1);
132 av_store(buildall, 0, newRV_inc((SV*)GvCV(gv)));
135 gv = stash_fetchs(st, "DEMOLISH", FALSE);
137 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
141 meta = get_metaclass(klass);
143 continue; /* skip non-Mouse classes */
146 mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
152 sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
156 mouse_get_xc(pTHX_ SV* const metaclass) {
162 if(!IsObject(metaclass)){
163 croak("Not a Mouse metaclass");
166 mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
168 SV* const package = get_slot(metaclass, mouse_package);
170 const char* const pv = SvPV_const(package, len);
172 stash = gv_stashpvn(pv, len, TRUE);
175 mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
176 SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
178 av_extend(xc, MOUSE_XC_last - 1);
180 av_store(xc, MOUSE_XC_GEN, newSVuv(0U));
181 av_store(xc, MOUSE_XC_STASH, (SV*)stash);
183 SvREFCNT_inc_simple_void_NN(stash);
186 xc = (AV*)MOUSE_mg_obj(mg);
189 assert(SvTYPE(xc) == SVt_PVAV);
192 gen = MOUSE_xc_gen(xc);
194 if(SvUVX(gen) != 0U && MOUSE_xc_flags(xc) & MOUSEf_XC_IS_IMMUTABLE){
198 stash = MOUSE_xc_stash(xc);
200 if(SvUVX(gen) != mro_get_pkg_gen(stash)){
201 mouse_class_update_xc(aTHX_ metaclass, stash, xc);
208 mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
216 SV* const args_ref = ST(0);
217 if(!IsHashRef(args_ref)){
218 if(!metaclass){ metaclass = get_metaclass(klass); }
219 mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
221 args = newHVhv((HV*)SvRV(args_ref));
222 sv_2mortal((SV*)args);
227 args = newHV_mortal();
229 if( (items % 2) != 0 ){
230 if(!metaclass){ metaclass = get_metaclass(klass); }
231 mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
234 for(i = 0; i < items; i += 2){
235 (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
243 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
244 AV* const xc = mouse_get_xc(aTHX_ meta);
245 AV* const attrs = MOUSE_xc_attrall(xc);
246 I32 len = AvFILLp(attrs) + 1;
248 AV* triggers_queue = NULL;
250 assert(meta || object);
252 assert(SvTYPE(args) == SVt_PVHV);
254 if(mg_find((SV*)args, PERL_MAGIC_tied)){
255 croak("You cannot use tied HASH reference as initializing arguments");
258 if(!ignore_triggers){
259 triggers_queue = newAV_mortal();
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);
266 SV* const slot = MOUSE_xa_slot(xa);
267 U16 const flags = (U16)MOUSE_xa_flags(xa);
268 SV* const init_arg = MOUSE_xa_init_arg(xa);
271 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
272 SV* value = HeVAL(he);
273 if(flags & MOUSEf_ATTR_HAS_TC){
274 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
276 value = set_slot(object, slot, value);
277 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
278 weaken_slot(object, slot);
280 if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
281 AV* const pair = newAV();
282 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
283 av_push(pair, newSVsv(value));
285 av_push(triggers_queue, (SV*)pair);
288 else { /* no init arg */
289 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
290 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
291 mouse_xa_set_default(aTHX_ xa, object);
294 else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
295 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
298 } /* for each attributes */
301 len = AvFILLp(triggers_queue) + 1;
302 for(i = 0; i < len; i++){
303 AV* const pair = (AV*)AvARRAY(triggers_queue)[i];
304 SV* const trigger = AvARRAY(pair)[0];
305 SV* const value = AvARRAY(pair)[1];
307 mcall1(object, trigger, value);
311 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
312 (void)set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
318 mouse_initialize_metaclass(pTHX_ SV* const klass) {
319 SV* meta = get_metaclass(klass);
326 mPUSHp("Mouse::Meta::Class", sizeof("Mouse::Meta::Class")-1);
330 call_method("initialize", G_SCALAR);
340 mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
341 AV* const buildall = MOUSE_xc_buildall(xc);
342 I32 const len = AvFILLp(buildall) + 1;
344 for(i = 0; i < len; i++){
353 call_sv(AvARRAY(buildall)[i], G_VOID);
355 /* discard a scalar which G_VOID returns */
362 MODULE = Mouse PACKAGE = Mouse
367 mouse_package = newSVpvs_share("package");
368 mouse_namespace = newSVpvs_share("namespace");
369 mouse_methods = newSVpvs_share("methods");
370 mouse_name = newSVpvs_share("name");
371 mouse_coerce = newSVpvs_share("coerce");
373 mouse_get_attribute = newSVpvs_share("get_attribute");
374 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
376 MOUSE_CALL_BOOT(Mouse__Util);
377 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
378 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
379 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
382 MODULE = Mouse PACKAGE = Mouse::Meta::Module
385 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
386 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
387 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
393 SV* const package = get_slot(self, mouse_package);
394 if(!(package && SvOK(package))){
395 croak("No package name defined");
397 RETVAL = gv_stashsv(package, GV_ADDMULTI);
402 # ignore extra arguments for extensibility
404 add_method(SV* self, SV* name, SV* code, ...)
407 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
408 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
412 if(!(package && SvOK(package))){
413 croak("No package name defined");
420 mouse_throw_error(self, NULL, "You must define a method name");
423 mouse_throw_error(self, NULL, "You must define a CODE reference");
427 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
428 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
429 SV** sp = &sv; /* used in tryAMAGICunDEREF */
430 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
431 if(!(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV)){
432 mouse_throw_error(self, NULL, "You must pass a CODE reference to add_method");
437 /* *{$package . '::' . $name} -> *gv */
438 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
439 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
440 SvREFCNT_dec(GvCV(gv));
443 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
445 (void)set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
447 /* name the CODE ref if it's anonymous */
449 CV* const code_entity = (CV*)SvRV(code_ref);
450 if(CvANON(code_entity)
451 && CvGV(code_entity) /* a cv under construction has no gv */ ){
453 CvGV(code_entity) = gv;
454 CvANON_off(code_entity);
459 MODULE = Mouse PACKAGE = Mouse::Meta::Class
462 INSTALL_SIMPLE_READER(Class, roles);
463 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
464 INSTALL_SIMPLE_READER(Class, is_immutable);
466 INSTALL_CLASS_HOLDER(Class, method_metaclass, "Mouse::Meta::Method");
467 INSTALL_CLASS_HOLDER(Class, attribute_metaclass, "Mouse::Meta::Attribute");
468 INSTALL_CLASS_HOLDER(Class, constructor_class, "Mouse::Meta::Method::Constructor::XS");
469 INSTALL_CLASS_HOLDER(Class, destructor_class, "Mouse::Meta::Method::Destructor::XS");
471 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Constructor::XS", TRUE), "_generate_constructor",
472 newRV_inc((SV*)get_cvs("Mouse::Object::new", TRUE)));
473 newCONSTSUB(gv_stashpvs("Mouse::Meta::Method::Destructor::XS", TRUE), "_generate_destructor",
474 newRV_inc((SV*)get_cvs("Mouse::Object::DESTROY", TRUE)));
478 linearized_isa(SV* self)
481 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
485 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
486 croak("namespace() didn't return a HASH reference");
488 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
489 len = AvFILLp(linearized_isa) + 1;
491 for(i = 0; i < len; i++){
492 PUSHs(AvARRAY(linearized_isa)[i]);
497 get_all_attributes(SV* self)
500 AV* const xc = mouse_get_xc(aTHX_ self);
501 AV* const all_attrs = MOUSE_xc_attrall(xc);
502 I32 const len = AvFILLp(all_attrs) + 1;
506 for(i = 0; i < len; i++){
507 PUSHs( MOUSE_av_at(all_attrs, i) );
512 new_object(SV* meta, ...)
515 AV* const xc = mouse_get_xc(aTHX_ meta);
516 HV* const args = mouse_buildargs(aTHX_ meta, NULL, ax, items);
518 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
519 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
525 _initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
528 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
531 MODULE = Mouse PACKAGE = Mouse::Meta::Role
534 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
535 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
537 INSTALL_CLASS_HOLDER(Role, method_metaclass, "Mouse::Meta::Role::Method");
539 MODULE = Mouse PACKAGE = Mouse::Object
545 SV* const meta = mouse_initialize_metaclass(aTHX_ klass);
546 AV* const xc = mouse_get_xc(aTHX_ meta);
547 UV const flags = MOUSE_xc_flags(xc);
551 if(flags & MOUSEf_XC_HAS_BUILDARGS){
557 for(i = 0; i < items; i++){
562 call_method("BUILDARGS", G_SCALAR);
567 if(!IsHashRef(args)){
568 croak("BUILDARGS did not return a HASH reference");
572 args = newRV_inc((SV*)mouse_buildargs(aTHX_ meta, klass, ax, items));
577 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
578 mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
580 mouse_buildall(aTHX_ xc, RETVAL, args);
592 SV* const meta = get_metaclass(object);
596 if(!IsObject(object)){
597 croak("You must not call %s as a class method",
598 ix == 0 ? "DESTROY" : "DEMOLISHALL");
602 AV* const xc = mouse_get_xc(aTHX_ meta);
604 demolishall = MOUSE_xc_demolishall(xc);
606 else { /* The metaclass is already destroyed */
607 AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
609 len = AvFILLp(linearized_isa) + 1;
611 demolishall = newAV_mortal();
612 for(i = 0; i < len; i++){
613 SV* const klass = MOUSE_av_at(linearized_isa, i);
614 HV* const st = gv_stashsv(klass, TRUE);
615 GV* const gv = stash_fetchs(st, "DEMOLISH", FALSE);
617 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
622 len = AvFILLp(demolishall) + 1;
624 GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
625 SAVESPTR(GvSV(statusvalue)); /* local $? */
626 SAVESPTR(ERRSV); /* local $@ */
628 GvSV(statusvalue) = sv_newmortal();
629 ERRSV = newSVpvs_flags("", SVs_TEMP);
630 for(i = 0; i < len; i++){
637 call_sv(AvARRAY(demolishall)[i], G_VOID | G_EVAL);
639 /* discard a scalar which G_VOID returns */
645 SV* const e = newSVsv(ERRSV);
652 croak(NULL); /* rethrow */
659 BUILDARGS(SV* klass, ...)
662 RETVAL = mouse_buildargs(aTHX_ NULL, klass, ax, items);
669 BUILDALL(SV* self, SV* args)
672 SV* const meta = get_metaclass(self);
673 AV* const xc = mouse_get_xc(aTHX_ meta);
675 if(!IsHashRef(args)){
676 croak("You must pass a HASH reference to BUILDALL");
678 mouse_buildall(aTHX_ xc, self, args);