Refactor type constraint check function to make class_type faster
[gitmo/Mouse.git] / xs-src / MouseAccessor.xs
CommitLineData
646c0371 1#include "mouse.h"
2
3#define CHECK_INSTANCE(instance) STMT_START{ \
4 if(!(SvROK(instance) && SvTYPE(SvRV(instance)) == SVt_PVHV)){ \
76770976 5 croak("Invalid object instance"); \
646c0371 6 } \
7 } STMT_END
8
9/* Moose XS Attribute object */
10enum mouse_xa_ix_t{
11 MOUSE_XA_ATTRIBUTE,
12 MOUSE_XA_TC,
13 MOUSE_XA_TC_CODE,
14
15 MOUSE_XA_last
16};
17
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)
21
22#define MOUSE_mg_attribute(mg) MOUSE_xa_attribute(MOUSE_mg_xa(mg))
23
24enum 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,
30
31 MOUSEf_ATTR_IS_LAZY = 0x0020,
32 MOUSEf_ATTR_IS_WEAK_REF = 0x0040,
33 MOUSEf_ATTR_IS_REQUIRED = 0x0080,
34
35 MOUSEf_ATTR_SHOULD_COERCE = 0x0100,
36
37 MOUSEf_ATTR_SHOULD_AUTO_DEREF
38 = 0x0200,
39 MOUSEf_TC_IS_ARRAYREF = 0x0400,
40 MOUSEf_TC_IS_HASHREF = 0x0800,
41
42 MOUSEf_OTHER1 = 0x1000,
43 MOUSEf_OTHER2 = 0x2000,
44 MOUSEf_OTHER3 = 0x4000,
45 MOUSEf_OTHER4 = 0x8000,
46
47 MOUSEf_MOUSE_MASK = 0xFFFF /* not used */
48};
49
50static MGVTBL mouse_accessor_vtbl; /* MAGIC identity */
51
52
53SV*
54mouse_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv) {
646c0371 55 if(items < 1){
56 croak("Too few arguments for %s", GvNAME(CvGV(cv)));
57 }
58
59 /* NOTE: If self has GETMAGIC, $self->accessor will invoke GETMAGIC
60 * before calling methods, so SvGETMAGIC(self) is not necessarily needed here.
61 */
62
76770976 63 return ST(0);
646c0371 64}
65
66
67CV*
68mouse_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();
71 CV* xsub;
72 MAGIC* mg;
73 U16 flags = 0;
74
75 sv_2mortal((SV*)xa);
76
77 xsub = newXS(NULL, accessor_impl, __FILE__);
78 sv_2mortal((SV*)xsub);
79
80 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)xa, HEf_SVKEY);
81
82 /* NOTE:
83 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
84 */
85 CvXSUBANY(xsub).any_ptr = (void*)mg;
86
87 av_extend(xa, MOUSE_XA_last - 1);
88
89 av_store(xa, MOUSE_XA_ATTRIBUTE, newSVsv(attr));
90
91 /* prepare attribute status */
92 /* XXX: making it lazy is a good way? */
93
94 if(SvTRUEx(mcall0s(attr, "has_type_constraint"))){
95 SV* tc;
96 flags |= MOUSEf_ATTR_HAS_TC;
97
98 ENTER;
99 SAVETMPS;
100
101 tc = mcall0s(attr, "type_constraint");
102 av_store(xa, MOUSE_XA_TC, newSVsv(tc));
103
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;
108 }
109 else if( SvTRUEx(mcall1s(tc, "is_a_type_of", newSVpvs_flags("HashRef", SVs_TEMP))) ){
110 flags |= MOUSEf_TC_IS_HASHREF;
111 }
112 else{
113 mouse_throw_error(attr, tc,
114 "Can not auto de-reference the type constraint '%"SVf"'",
115 mcall0(tc, mouse_name));
116 }
117 }
118
119 if(SvTRUEx(mcall0s(attr, "should_coerce"))){
120 flags |= MOUSEf_ATTR_SHOULD_COERCE;
121 }
122
123 FREETMPS;
124 LEAVE;
125 }
126
127 if(SvTRUEx(mcall0s(attr, "has_trigger"))){
128 flags |= MOUSEf_ATTR_HAS_TRIGGER;
129 }
130
131 if(SvTRUEx(mcall0s(attr, "is_lazy"))){
132 flags |= MOUSEf_ATTR_IS_LAZY;
133
134 if(SvTRUEx(mcall0s(attr, "has_builder"))){
135 flags |= MOUSEf_ATTR_HAS_BUILDER;
136 }
137 else if(SvTRUEx(mcall0s(attr, "has_default"))){
138 flags |= MOUSEf_ATTR_HAS_DEFAULT;
139 }
140 }
141
142 if(SvTRUEx(mcall0s(attr, "is_weak_ref"))){
143 flags |= MOUSEf_ATTR_IS_WEAK_REF;
144 }
145
146 if(SvTRUEx(mcall0s(attr, "is_required"))){
147 flags |= MOUSEf_ATTR_IS_REQUIRED;
148 }
149
150 MOUSE_mg_flags(mg) = flags;
151
152 return xsub;
153}
154
155static SV*
156mouse_apply_type_constraint(pTHX_ AV* const xa, SV* value, U16 const flags){
157 SV* const tc = MOUSE_xa_tc(xa);
158 SV* tc_code;
159
160 if(flags & MOUSEf_ATTR_SHOULD_COERCE){
161 value = mcall1s(tc, "coerce", value);
162 }
163
164 if(!SvOK(MOUSE_xa_tc_code(xa))){
646c0371 165 tc_code = mcall0s(tc, "_compiled_type_constraint");
d33d8840 166 av_store(xa, MOUSE_XA_TC_CODE, newSVsv(tc_code));
167 if(!(SvROK(tc_code) && SvTYPE(SvRV(tc_code)) == SVt_PVCV)){
168 mouse_throw_error(MOUSE_xa_attribute(xa), tc, "Not a CODE reference");
646c0371 169 }
170 }
171 else{
172 tc_code = MOUSE_xa_tc_code(xa);
173 }
174
175 if(!mouse_tc_check(aTHX_ tc_code, value)){
176 mouse_throw_error(MOUSE_xa_attribute(xa), value,
177 "Attribute (%"SVf") does not pass the type constraint because: %"SVf,
178 mcall0(MOUSE_xa_attribute(xa), mouse_name),
179 mcall1s(tc, "get_message", value));
180 }
181
182 return value;
183}
184
208ffaeb 185#define PUSH_VALUE(value, flags) STMT_START { \
186 if((flags) & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY){ \
187 mouse_push_values(aTHX_ value, (flags)); \
188 } \
189 else{ \
190 dSP; \
191 XPUSHs(value ? value : &PL_sv_undef); \
192 PUTBACK; \
193 } \
194 } STMT_END \
646c0371 195
196/* pushes return values, does auto-deref if needed */
197static void
198mouse_push_values(pTHX_ SV* const value, U16 const flags){
199 dSP;
200
208ffaeb 201 assert( flags & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY );
646c0371 202
208ffaeb 203 if(!(value && SvOK(value))){
204 return;
205 }
646c0371 206
208ffaeb 207 if(flags & MOUSEf_TC_IS_ARRAYREF){
208 AV* const av = (AV*)SvRV(value);
209 I32 len;
210 I32 i;
646c0371 211
208ffaeb 212 if(SvTYPE(av) != SVt_PVAV){
213 croak("Mouse-panic: Not an ARRAY reference");
646c0371 214 }
646c0371 215
208ffaeb 216 len = av_len(av) + 1;
217 EXTEND(SP, len);
218 for(i = 0; i < len; i++){
219 SV** const svp = av_fetch(av, i, FALSE);
220 PUSHs(svp ? *svp : &PL_sv_undef);
646c0371 221 }
222 }
208ffaeb 223 else if(flags & MOUSEf_TC_IS_HASHREF){
224 HV* const hv = (HV*)SvRV(value);
225 HE* he;
226
227 if(SvTYPE(hv) != SVt_PVHV){
228 croak("Mouse-panic: Not a HASH reference");
229 }
230
231 hv_iterinit(hv);
232 while((he = hv_iternext(hv))){
233 EXTEND(SP, 2);
234 PUSHs(hv_iterkeysv(he));
235 PUSHs(hv_iterval(hv, he));
236 }
646c0371 237 }
238
239 PUTBACK;
240}
241
242static void
243mouse_attr_get(pTHX_ SV* const self, MAGIC* const mg){
244 U16 const flags = MOUSE_mg_flags(mg);
245 SV* const slot = MOUSE_mg_slot(mg);
246 SV* value;
247
248 value = mouse_instance_get_slot(aTHX_ self, slot);
249
250 /* check_lazy */
251 if( !value && flags & MOUSEf_ATTR_IS_LAZY ){
252 AV* const xa = MOUSE_mg_xa(mg);
253 SV* const attr = MOUSE_xa_attribute(xa);
254
255 /* get default value by $attr->default or $attr->builder */
256 if(flags & MOUSEf_ATTR_HAS_DEFAULT){
257 value = mcall0s(attr, "default");
258
259 if(SvROK(value) && SvTYPE(SvRV(value)) == SVt_PVCV){
260 value = mcall0(self, value);
261 }
262 }
263 else if(flags & MOUSEf_ATTR_HAS_BUILDER){
264 SV* const builder = mcall0s(attr, "builder");
265 value = mcall0(self, builder);
266 }
267
268 if(!value){
269 value = sv_newmortal();
270 }
271
272 /* apply coerce and type constraint */
273 if(flags & MOUSEf_ATTR_HAS_TC){
274 value = mouse_apply_type_constraint(aTHX_ xa, value, flags);
275 }
276
277 /* store value to slot */
278 value = mouse_instance_set_slot(aTHX_ self, slot, value);
279 }
280
208ffaeb 281 PUSH_VALUE(value, flags);
646c0371 282}
283
284static void
285mouse_attr_set(pTHX_ SV* const self, MAGIC* const mg, SV* value){
286 U16 const flags = MOUSE_mg_flags(mg);
287 SV* const slot = MOUSE_mg_slot(mg);
288
289 if(flags & MOUSEf_ATTR_HAS_TC){
290 value = mouse_apply_type_constraint(aTHX_ MOUSE_mg_xa(mg), value, flags);
291 }
292
293 mouse_instance_set_slot(aTHX_ self, slot, value);
294
295 if(flags & MOUSEf_ATTR_IS_WEAK_REF){
296 mouse_instance_weaken_slot(aTHX_ self, slot);
297 }
298
299 if(flags & MOUSEf_ATTR_HAS_TRIGGER){
300 SV* const trigger = mcall0s(MOUSE_mg_attribute(mg), "trigger");
301 dSP;
302
303 PUSHMARK(SP);
304 EXTEND(SP, 2);
305 PUSHs(self);
306 PUSHs(value);
307
308 PUTBACK;
309 call_sv(trigger, G_VOID | G_DISCARD);
310 /* need not SPAGAIN */
311 }
312
208ffaeb 313 PUSH_VALUE(value, flags);
646c0371 314}
315
316XS(mouse_xs_accessor)
317{
318 dVAR; dXSARGS;
319 dMOUSE_self;
320 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
321
322 SP -= items; /* PPCODE */
323 PUTBACK;
324
325 if(items == 1){ /* reader */
326 mouse_attr_get(aTHX_ self, mg);
327 }
328 else if (items == 2){ /* writer */
329 mouse_attr_set(aTHX_ self, mg, ST(1));
330 }
331 else{
332 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
333 "Expected exactly one or two argument for an accessor");
334 }
335}
336
337
338XS(mouse_xs_reader)
339{
340 dVAR; dXSARGS;
341 dMOUSE_self;
342 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
343
344 if (items != 1) {
345 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
346 "Cannot assign a value to a read-only accessor");
347 }
348
349 SP -= items; /* PPCODE */
350 PUTBACK;
351
352 mouse_attr_get(aTHX_ self, mg);
353}
354
355XS(mouse_xs_writer)
356{
357 dVAR; dXSARGS;
358 dMOUSE_self;
359 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
360
361 if (items != 2) {
362 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
363 "Too few arguments for a write-only accessor");
364 }
365
366 SP -= items; /* PPCODE */
367 PUTBACK;
368
369 mouse_attr_set(aTHX_ self, mg, ST(1));
370}
371
372/* simple accessors */
373
374/*
375static MAGIC*
376mouse_accessor_get_mg(pTHX_ CV* const xsub){
377 return moose_mg_find(aTHX_ (SV*)xsub, &mouse_simple_accessor_vtbl, MOOSEf_DIE_ON_FAIL);
378}
379*/
380
381CV*
382mouse_install_simple_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl){
383 CV* const xsub = newXS((char*)fq_name, accessor_impl, __FILE__);
384 SV* const slot = newSVpvn_share(key, keylen, 0U);
385 MAGIC* mg;
386
387 if(!fq_name){
388 /* anonymous xsubs need sv_2mortal */
389 sv_2mortal((SV*)xsub);
390 }
391
392 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, NULL, 0);
393 SvREFCNT_dec(slot); /* sv_magicext() increases refcnt in mg_obj */
394
395 /* NOTE:
396 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
397 */
398 CvXSUBANY(xsub).any_ptr = (void*)mg;
399
400 return xsub;
401}
402
403XS(mouse_xs_simple_reader)
404{
405 dVAR; dXSARGS;
406 dMOUSE_self;
407 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
408 SV* value;
409
410 if (items != 1) {
411 croak("Expected exactly one argument for a reader for '%"SVf"'", slot);
412 }
413
414 value = mouse_instance_get_slot(aTHX_ self, slot);
415 ST(0) = value ? value : &PL_sv_undef;
416 XSRETURN(1);
417}
418
419
420XS(mouse_xs_simple_writer)
421{
422 dVAR; dXSARGS;
423 dMOUSE_self;
424 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
425
426 if (items != 2) {
427 croak("Expected exactly two argument for a writer for '%"SVf"'", slot);
428 }
429
430 ST(0) = mouse_instance_set_slot(aTHX_ self, slot, ST(1));
431 XSRETURN(1);
432}
433
434XS(mouse_xs_simple_clearer)
435{
436 dVAR; dXSARGS;
437 dMOUSE_self;
438 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
439 SV* value;
440
441 if (items != 1) {
442 croak("Expected exactly one argument for a clearer for '%"SVf"'", slot);
443 }
444
445 value = mouse_instance_delete_slot(aTHX_ self, slot);
446 ST(0) = value ? value : &PL_sv_undef;
447 XSRETURN(1);
448}
449
450XS(mouse_xs_simple_predicate)
451{
452 dVAR; dXSARGS;
453 dMOUSE_self;
454 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
455
456 if (items != 1) {
457 croak("Expected exactly one argument for a predicate for '%"SVf"'", slot);
458 }
459
460 ST(0) = boolSV( mouse_instance_has_slot(aTHX_ self, slot) );
461 XSRETURN(1);
462}
463
76770976 464/* simple instance slot accessor (or Mouse::Meta::Instance) */
646c0371 465
466SV*
467mouse_instance_create(pTHX_ HV* const stash) {
468 assert(stash);
469 return sv_bless( newRV_noinc((SV*)newHV()), stash );
470}
471
472SV*
473mouse_instance_clone(pTHX_ SV* const instance) {
474 HV* proto;
475 assert(instance);
476
477 CHECK_INSTANCE(instance);
478 proto = newHVhv((HV*)SvRV(instance));
479 return sv_bless( newRV_noinc((SV*)proto), SvSTASH(SvRV(instance)) );
480}
481
482bool
483mouse_instance_has_slot(pTHX_ SV* const instance, SV* const slot) {
484 assert(instance);
485 assert(slot);
486 CHECK_INSTANCE(instance);
487 return hv_exists_ent((HV*)SvRV(instance), slot, 0U);
488}
489
490SV*
491mouse_instance_get_slot(pTHX_ SV* const instance, SV* const slot) {
492 HE* he;
493 assert(instance);
494 assert(slot);
495 CHECK_INSTANCE(instance);
496 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
497 return he ? HeVAL(he) : NULL;
498}
499
500SV*
501mouse_instance_set_slot(pTHX_ SV* const instance, SV* const slot, SV* const value) {
502 HE* he;
503 SV* sv;
504 assert(instance);
505 assert(slot);
506 assert(value);
507 CHECK_INSTANCE(instance);
508 he = hv_fetch_ent((HV*)SvRV(instance), slot, TRUE, 0U);
509 sv = HeVAL(he);
510 sv_setsv_mg(sv, value);
511 return sv;
512}
513
514SV*
515mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot) {
516 assert(instance);
517 assert(slot);
518 CHECK_INSTANCE(instance);
519 return hv_delete_ent((HV*)SvRV(instance), slot, 0, 0U);
520}
521
522void
523mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot) {
524 HE* he;
525 assert(instance);
526 assert(slot);
527 CHECK_INSTANCE(instance);
528 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
529 if(he){
530 sv_rvweaken(HeVAL(he));
531 }
532}
533\r
534MODULE = Mouse::Meta::Method::Accessor::XS PACKAGE = Mouse::Meta::Method::Accessor::XS
535
536PROTOTYPES: DISABLE
537VERSIONCHECK: DISABLE
538
539CV*
540_generate_accessor(klass, SV* attr, metaclass)
541CODE:
542{
543 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_accessor);
544}
545OUTPUT:
546 RETVAL
547
548CV*
549_generate_reader(klass, SV* attr, metaclass)
550CODE:
551{
552 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_reader);
553}
554OUTPUT:
555 RETVAL
556
557CV*
558_generate_writer(klass, SV* attr, metaclass)
559CODE:
560{
561 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_writer);
562}
563OUTPUT:
564 RETVAL
565
566CV*
567_generate_clearer(klass, SV* attr, metaclass)
568CODE:
569{
570 SV* const slot = mcall0s(attr, "name");
571 STRLEN len;
572 const char* const pv = SvPV_const(slot, len);
573 RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, mouse_xs_simple_clearer);
574}
575OUTPUT:
576 RETVAL
577
578CV*
579_generate_predicate(klass, SV* attr, metaclass)
580CODE:
581{
582 SV* const slot = mcall0s(attr, "name");
583 STRLEN len;
584 const char* const pv = SvPV_const(slot, len);
585 RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, mouse_xs_simple_predicate);
586}
587OUTPUT:
588 RETVAL
589