3 #define CHECK_INSTANCE(instance) STMT_START{ \
4 if(!(SvROK(instance) && SvTYPE(SvRV(instance)) == SVt_PVHV)){ \
5 croak("Invalid object instance"); \
9 /* Moose XS Attribute object */
18 #define MOUSE_xa_attribute(m) MOUSE_av_at(m, MOUSE_XA_ATTRIBUTE)
19 #define MOUSE_xa_tc(m) MOUSE_av_at(m, MOUSE_XA_TC)
20 #define MOUSE_xa_tc_code(m) MOUSE_av_at(m, MOUSE_XA_TC_CODE)
22 #define MOUSE_mg_attribute(mg) MOUSE_xa_attribute(MOUSE_mg_xa(mg))
24 enum mouse_xa_flags_t{
25 MOUSEf_ATTR_HAS_TC = 0x0001,
26 MOUSEf_ATTR_HAS_DEFAULT = 0x0002,
27 MOUSEf_ATTR_HAS_BUILDER = 0x0004,
28 MOUSEf_ATTR_HAS_INITIALIZER = 0x0008, /* not used in Mouse */
29 MOUSEf_ATTR_HAS_TRIGGER = 0x0010,
31 MOUSEf_ATTR_IS_LAZY = 0x0020,
32 MOUSEf_ATTR_IS_WEAK_REF = 0x0040,
33 MOUSEf_ATTR_IS_REQUIRED = 0x0080,
35 MOUSEf_ATTR_SHOULD_COERCE = 0x0100,
37 MOUSEf_ATTR_SHOULD_AUTO_DEREF
39 MOUSEf_TC_IS_ARRAYREF = 0x0400,
40 MOUSEf_TC_IS_HASHREF = 0x0800,
42 MOUSEf_OTHER1 = 0x1000,
43 MOUSEf_OTHER2 = 0x2000,
44 MOUSEf_OTHER3 = 0x4000,
45 MOUSEf_OTHER4 = 0x8000,
47 MOUSEf_MOUSE_MASK = 0xFFFF /* not used */
50 static MGVTBL mouse_accessor_vtbl; /* MAGIC identity */
54 mouse_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv) {
56 croak("Too few arguments for %s", GvNAME(CvGV(cv)));
59 /* NOTE: If self has GETMAGIC, $self->accessor will invoke GETMAGIC
60 * before calling methods, so SvGETMAGIC(self) is not necessarily needed here.
68 mouse_instantiate_xs_accessor(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl){
69 SV* const slot = mcall0(attr, mouse_name);
70 AV* const xa = newAV();
77 xsub = newXS(NULL, accessor_impl, __FILE__);
78 sv_2mortal((SV*)xsub);
80 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)xa, HEf_SVKEY);
83 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
85 CvXSUBANY(xsub).any_ptr = (void*)mg;
87 av_extend(xa, MOUSE_XA_last - 1);
89 av_store(xa, MOUSE_XA_ATTRIBUTE, newSVsv(attr));
91 /* prepare attribute status */
92 /* XXX: making it lazy is a good way? */
94 if(SvTRUEx(mcall0s(attr, "has_type_constraint"))){
96 flags |= MOUSEf_ATTR_HAS_TC;
101 tc = mcall0s(attr, "type_constraint");
102 av_store(xa, MOUSE_XA_TC, newSVsv(tc));
104 if(SvTRUEx(mcall0s(attr, "should_auto_deref"))){
105 flags |= MOUSEf_ATTR_SHOULD_AUTO_DEREF;
106 if( SvTRUEx(mcall1s(tc, "is_a_type_of", newSVpvs_flags("ArrayRef", SVs_TEMP))) ){
107 flags |= MOUSEf_TC_IS_ARRAYREF;
109 else if( SvTRUEx(mcall1s(tc, "is_a_type_of", newSVpvs_flags("HashRef", SVs_TEMP))) ){
110 flags |= MOUSEf_TC_IS_HASHREF;
113 mouse_throw_error(attr, tc,
114 "Can not auto de-reference the type constraint '%"SVf"'",
115 mcall0(tc, mouse_name));
119 if(SvTRUEx(mcall0s(attr, "should_coerce"))){
120 flags |= MOUSEf_ATTR_SHOULD_COERCE;
127 if(SvTRUEx(mcall0s(attr, "has_trigger"))){
128 flags |= MOUSEf_ATTR_HAS_TRIGGER;
131 if(SvTRUEx(mcall0s(attr, "is_lazy"))){
132 flags |= MOUSEf_ATTR_IS_LAZY;
134 if(SvTRUEx(mcall0s(attr, "has_builder"))){
135 flags |= MOUSEf_ATTR_HAS_BUILDER;
137 else if(SvTRUEx(mcall0s(attr, "has_default"))){
138 flags |= MOUSEf_ATTR_HAS_DEFAULT;
142 if(SvTRUEx(mcall0s(attr, "is_weak_ref"))){
143 flags |= MOUSEf_ATTR_IS_WEAK_REF;
146 if(SvTRUEx(mcall0s(attr, "is_required"))){
147 flags |= MOUSEf_ATTR_IS_REQUIRED;
150 MOUSE_mg_flags(mg) = flags;
156 mouse_apply_type_constraint(pTHX_ AV* const xa, SV* value, U16 const flags){
157 SV* const tc = MOUSE_xa_tc(xa);
160 if(flags & MOUSEf_ATTR_SHOULD_COERCE){
161 value = mcall1s(tc, "coerce", value);
164 if(!SvOK(MOUSE_xa_tc_code(xa))){
165 XS(XS_Mouse__Util__TypeConstraints_Item); /* prototype defined in Mouse.xs */
167 tc_code = mcall0s(tc, "_compiled_type_constraint");
169 if(SvROK(tc_code) && SvTYPE(SvRV(tc_code))
170 && CvXSUB((CV*)SvRV(tc_code)) == XS_Mouse__Util__TypeConstraints_Item){
171 /* built-in type constraints */
172 mouse_tc const id = CvXSUBANY((CV*)SvRV(tc_code)).any_i32;
173 av_store(xa, MOUSE_XA_TC_CODE, newSViv(id));
176 av_store(xa, MOUSE_XA_TC_CODE, newSVsv(tc_code));
180 tc_code = MOUSE_xa_tc_code(xa);
183 if(!mouse_tc_check(aTHX_ tc_code, value)){
184 mouse_throw_error(MOUSE_xa_attribute(xa), value,
185 "Attribute (%"SVf") does not pass the type constraint because: %"SVf,
186 mcall0(MOUSE_xa_attribute(xa), mouse_name),
187 mcall1s(tc, "get_message", value));
193 #define PUSH_VALUE(value, flags) STMT_START { \
194 if((flags) & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY){ \
195 mouse_push_values(aTHX_ value, (flags)); \
199 XPUSHs(value ? value : &PL_sv_undef); \
204 /* pushes return values, does auto-deref if needed */
206 mouse_push_values(pTHX_ SV* const value, U16 const flags){
209 assert( flags & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY );
211 if(!(value && SvOK(value))){
215 if(flags & MOUSEf_TC_IS_ARRAYREF){
216 AV* const av = (AV*)SvRV(value);
220 if(SvTYPE(av) != SVt_PVAV){
221 croak("Mouse-panic: Not an ARRAY reference");
224 len = av_len(av) + 1;
226 for(i = 0; i < len; i++){
227 SV** const svp = av_fetch(av, i, FALSE);
228 PUSHs(svp ? *svp : &PL_sv_undef);
231 else if(flags & MOUSEf_TC_IS_HASHREF){
232 HV* const hv = (HV*)SvRV(value);
235 if(SvTYPE(hv) != SVt_PVHV){
236 croak("Mouse-panic: Not a HASH reference");
240 while((he = hv_iternext(hv))){
242 PUSHs(hv_iterkeysv(he));
243 PUSHs(hv_iterval(hv, he));
251 mouse_attr_get(pTHX_ SV* const self, MAGIC* const mg){
252 U16 const flags = MOUSE_mg_flags(mg);
253 SV* const slot = MOUSE_mg_slot(mg);
256 value = mouse_instance_get_slot(aTHX_ self, slot);
259 if( !value && flags & MOUSEf_ATTR_IS_LAZY ){
260 AV* const xa = MOUSE_mg_xa(mg);
261 SV* const attr = MOUSE_xa_attribute(xa);
263 /* get default value by $attr->default or $attr->builder */
264 if(flags & MOUSEf_ATTR_HAS_DEFAULT){
265 value = mcall0s(attr, "default");
267 if(SvROK(value) && SvTYPE(SvRV(value)) == SVt_PVCV){
268 value = mcall0(self, value);
271 else if(flags & MOUSEf_ATTR_HAS_BUILDER){
272 SV* const builder = mcall0s(attr, "builder");
273 value = mcall0(self, builder);
277 value = sv_newmortal();
280 /* apply coerce and type constraint */
281 if(flags & MOUSEf_ATTR_HAS_TC){
282 value = mouse_apply_type_constraint(aTHX_ xa, value, flags);
285 /* store value to slot */
286 value = mouse_instance_set_slot(aTHX_ self, slot, value);
289 PUSH_VALUE(value, flags);
293 mouse_attr_set(pTHX_ SV* const self, MAGIC* const mg, SV* value){
294 U16 const flags = MOUSE_mg_flags(mg);
295 SV* const slot = MOUSE_mg_slot(mg);
297 if(flags & MOUSEf_ATTR_HAS_TC){
298 value = mouse_apply_type_constraint(aTHX_ MOUSE_mg_xa(mg), value, flags);
301 mouse_instance_set_slot(aTHX_ self, slot, value);
303 if(flags & MOUSEf_ATTR_IS_WEAK_REF){
304 mouse_instance_weaken_slot(aTHX_ self, slot);
307 if(flags & MOUSEf_ATTR_HAS_TRIGGER){
308 SV* const trigger = mcall0s(MOUSE_mg_attribute(mg), "trigger");
317 call_sv(trigger, G_VOID | G_DISCARD);
318 /* need not SPAGAIN */
321 PUSH_VALUE(value, flags);
324 XS(mouse_xs_accessor)
328 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
330 SP -= items; /* PPCODE */
333 if(items == 1){ /* reader */
334 mouse_attr_get(aTHX_ self, mg);
336 else if (items == 2){ /* writer */
337 mouse_attr_set(aTHX_ self, mg, ST(1));
340 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
341 "Expected exactly one or two argument for an accessor");
350 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
353 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
354 "Cannot assign a value to a read-only accessor");
357 SP -= items; /* PPCODE */
360 mouse_attr_get(aTHX_ self, mg);
367 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
370 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
371 "Too few arguments for a write-only accessor");
374 SP -= items; /* PPCODE */
377 mouse_attr_set(aTHX_ self, mg, ST(1));
380 /* simple accessors */
384 mouse_accessor_get_mg(pTHX_ CV* const xsub){
385 return moose_mg_find(aTHX_ (SV*)xsub, &mouse_simple_accessor_vtbl, MOOSEf_DIE_ON_FAIL);
390 mouse_install_simple_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl){
391 CV* const xsub = newXS((char*)fq_name, accessor_impl, __FILE__);
392 SV* const slot = newSVpvn_share(key, keylen, 0U);
396 /* anonymous xsubs need sv_2mortal */
397 sv_2mortal((SV*)xsub);
400 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, NULL, 0);
401 SvREFCNT_dec(slot); /* sv_magicext() increases refcnt in mg_obj */
404 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
406 CvXSUBANY(xsub).any_ptr = (void*)mg;
411 XS(mouse_xs_simple_reader)
415 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
419 croak("Expected exactly one argument for a reader for '%"SVf"'", slot);
422 value = mouse_instance_get_slot(aTHX_ self, slot);
423 ST(0) = value ? value : &PL_sv_undef;
428 XS(mouse_xs_simple_writer)
432 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
435 croak("Expected exactly two argument for a writer for '%"SVf"'", slot);
438 ST(0) = mouse_instance_set_slot(aTHX_ self, slot, ST(1));
442 XS(mouse_xs_simple_clearer)
446 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
450 croak("Expected exactly one argument for a clearer for '%"SVf"'", slot);
453 value = mouse_instance_delete_slot(aTHX_ self, slot);
454 ST(0) = value ? value : &PL_sv_undef;
458 XS(mouse_xs_simple_predicate)
462 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
465 croak("Expected exactly one argument for a predicate for '%"SVf"'", slot);
468 ST(0) = boolSV( mouse_instance_has_slot(aTHX_ self, slot) );
472 /* simple instance slot accessor (or Mouse::Meta::Instance) */
475 mouse_instance_create(pTHX_ HV* const stash) {
477 return sv_bless( newRV_noinc((SV*)newHV()), stash );
481 mouse_instance_clone(pTHX_ SV* const instance) {
485 CHECK_INSTANCE(instance);
486 proto = newHVhv((HV*)SvRV(instance));
487 return sv_bless( newRV_noinc((SV*)proto), SvSTASH(SvRV(instance)) );
491 mouse_instance_has_slot(pTHX_ SV* const instance, SV* const slot) {
494 CHECK_INSTANCE(instance);
495 return hv_exists_ent((HV*)SvRV(instance), slot, 0U);
499 mouse_instance_get_slot(pTHX_ SV* const instance, SV* const slot) {
503 CHECK_INSTANCE(instance);
504 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
505 return he ? HeVAL(he) : NULL;
509 mouse_instance_set_slot(pTHX_ SV* const instance, SV* const slot, SV* const value) {
515 CHECK_INSTANCE(instance);
516 he = hv_fetch_ent((HV*)SvRV(instance), slot, TRUE, 0U);
518 sv_setsv_mg(sv, value);
523 mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot) {
526 CHECK_INSTANCE(instance);
527 return hv_delete_ent((HV*)SvRV(instance), slot, 0, 0U);
531 mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot) {
535 CHECK_INSTANCE(instance);
536 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
538 sv_rvweaken(HeVAL(he));
542 MODULE = Mouse::Meta::Method::Accessor::XS PACKAGE = Mouse::Meta::Method::Accessor::XS
545 VERSIONCHECK: DISABLE
548 _generate_accessor(klass, SV* attr, metaclass)
551 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_accessor);
557 _generate_reader(klass, SV* attr, metaclass)
560 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_reader);
566 _generate_writer(klass, SV* attr, metaclass)
569 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_writer);
575 _generate_clearer(klass, SV* attr, metaclass)
578 SV* const slot = mcall0s(attr, "name");
580 const char* const pv = SvPV_const(slot, len);
581 RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, mouse_xs_simple_clearer);
587 _generate_predicate(klass, SV* attr, metaclass)
590 SV* const slot = mcall0s(attr, "name");
592 const char* const pv = SvPV_const(slot, len);
593 RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, mouse_xs_simple_predicate);