Remove useless use of or-assign
[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));
263728b5 167
d33d8840 168 if(!(SvROK(tc_code) && SvTYPE(SvRV(tc_code)) == SVt_PVCV)){
169 mouse_throw_error(MOUSE_xa_attribute(xa), tc, "Not a CODE reference");
646c0371 170 }
171 }
172 else{
173 tc_code = MOUSE_xa_tc_code(xa);
174 }
175
176 if(!mouse_tc_check(aTHX_ tc_code, value)){
177 mouse_throw_error(MOUSE_xa_attribute(xa), value,
178 "Attribute (%"SVf") does not pass the type constraint because: %"SVf,
179 mcall0(MOUSE_xa_attribute(xa), mouse_name),
180 mcall1s(tc, "get_message", value));
181 }
182
183 return value;
184}
185
208ffaeb 186#define PUSH_VALUE(value, flags) STMT_START { \
187 if((flags) & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY){ \
188 mouse_push_values(aTHX_ value, (flags)); \
189 } \
190 else{ \
191 dSP; \
192 XPUSHs(value ? value : &PL_sv_undef); \
193 PUTBACK; \
194 } \
195 } STMT_END \
646c0371 196
197/* pushes return values, does auto-deref if needed */
198static void
199mouse_push_values(pTHX_ SV* const value, U16 const flags){
200 dSP;
201
208ffaeb 202 assert( flags & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY );
646c0371 203
208ffaeb 204 if(!(value && SvOK(value))){
205 return;
206 }
646c0371 207
208ffaeb 208 if(flags & MOUSEf_TC_IS_ARRAYREF){
209 AV* const av = (AV*)SvRV(value);
210 I32 len;
211 I32 i;
646c0371 212
208ffaeb 213 if(SvTYPE(av) != SVt_PVAV){
214 croak("Mouse-panic: Not an ARRAY reference");
646c0371 215 }
646c0371 216
208ffaeb 217 len = av_len(av) + 1;
218 EXTEND(SP, len);
219 for(i = 0; i < len; i++){
220 SV** const svp = av_fetch(av, i, FALSE);
221 PUSHs(svp ? *svp : &PL_sv_undef);
646c0371 222 }
223 }
208ffaeb 224 else if(flags & MOUSEf_TC_IS_HASHREF){
225 HV* const hv = (HV*)SvRV(value);
226 HE* he;
227
228 if(SvTYPE(hv) != SVt_PVHV){
229 croak("Mouse-panic: Not a HASH reference");
230 }
231
232 hv_iterinit(hv);
233 while((he = hv_iternext(hv))){
234 EXTEND(SP, 2);
235 PUSHs(hv_iterkeysv(he));
236 PUSHs(hv_iterval(hv, he));
237 }
646c0371 238 }
239
240 PUTBACK;
241}
242
243static void
244mouse_attr_get(pTHX_ SV* const self, MAGIC* const mg){
245 U16 const flags = MOUSE_mg_flags(mg);
246 SV* const slot = MOUSE_mg_slot(mg);
247 SV* value;
248
6fe2272b 249 value = get_slot(self, slot);
646c0371 250
251 /* check_lazy */
252 if( !value && flags & MOUSEf_ATTR_IS_LAZY ){
8fa5f9b8 253 AV* const xa = MOUSE_mg_xa(mg);
646c0371 254 SV* const attr = MOUSE_xa_attribute(xa);
255
8fa5f9b8 256 /* get default value by $attr->builder or $attr->default */
257 if(flags & MOUSEf_ATTR_HAS_BUILDER){
258 SV* const builder = mcall0s(attr, "builder");
259 value = mcall0(self, builder);
260 }
261 else {
646c0371 262 value = mcall0s(attr, "default");
263
264 if(SvROK(value) && SvTYPE(SvRV(value)) == SVt_PVCV){
265 value = mcall0(self, value);
266 }
267 }
646c0371 268
269 /* apply coerce and type constraint */
270 if(flags & MOUSEf_ATTR_HAS_TC){
271 value = mouse_apply_type_constraint(aTHX_ xa, value, flags);
272 }
273
274 /* store value to slot */
6fe2272b 275 value = set_slot(self, slot, value);
646c0371 276 }
277
208ffaeb 278 PUSH_VALUE(value, flags);
646c0371 279}
280
281static void
282mouse_attr_set(pTHX_ SV* const self, MAGIC* const mg, SV* value){
283 U16 const flags = MOUSE_mg_flags(mg);
284 SV* const slot = MOUSE_mg_slot(mg);
285
286 if(flags & MOUSEf_ATTR_HAS_TC){
287 value = mouse_apply_type_constraint(aTHX_ MOUSE_mg_xa(mg), value, flags);
288 }
289
6fe2272b 290 set_slot(self, slot, value);
646c0371 291
292 if(flags & MOUSEf_ATTR_IS_WEAK_REF){
6fe2272b 293 weaken_slot(self, slot);
646c0371 294 }
295
296 if(flags & MOUSEf_ATTR_HAS_TRIGGER){
297 SV* const trigger = mcall0s(MOUSE_mg_attribute(mg), "trigger");
298 dSP;
299
300 PUSHMARK(SP);
301 EXTEND(SP, 2);
302 PUSHs(self);
303 PUSHs(value);
304
305 PUTBACK;
306 call_sv(trigger, G_VOID | G_DISCARD);
307 /* need not SPAGAIN */
308 }
309
208ffaeb 310 PUSH_VALUE(value, flags);
646c0371 311}
312
30e11004 313XS(XS_Mouse_accessor)
646c0371 314{
315 dVAR; dXSARGS;
316 dMOUSE_self;
317 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
318
319 SP -= items; /* PPCODE */
320 PUTBACK;
321
322 if(items == 1){ /* reader */
323 mouse_attr_get(aTHX_ self, mg);
324 }
325 else if (items == 2){ /* writer */
326 mouse_attr_set(aTHX_ self, mg, ST(1));
327 }
328 else{
329 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
330 "Expected exactly one or two argument for an accessor");
331 }
332}
333
334
30e11004 335XS(XS_Mouse_reader)
646c0371 336{
337 dVAR; dXSARGS;
338 dMOUSE_self;
339 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
340
341 if (items != 1) {
342 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
343 "Cannot assign a value to a read-only accessor");
344 }
345
346 SP -= items; /* PPCODE */
347 PUTBACK;
348
349 mouse_attr_get(aTHX_ self, mg);
350}
351
30e11004 352XS(XS_Mouse_writer)
646c0371 353{
354 dVAR; dXSARGS;
355 dMOUSE_self;
356 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
357
358 if (items != 2) {
359 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
360 "Too few arguments for a write-only accessor");
361 }
362
363 SP -= items; /* PPCODE */
364 PUTBACK;
365
366 mouse_attr_set(aTHX_ self, mg, ST(1));
367}
368
369/* simple accessors */
370
371/*
372static MAGIC*
373mouse_accessor_get_mg(pTHX_ CV* const xsub){
374 return moose_mg_find(aTHX_ (SV*)xsub, &mouse_simple_accessor_vtbl, MOOSEf_DIE_ON_FAIL);
375}
376*/
377
378CV*
379mouse_install_simple_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl){
380 CV* const xsub = newXS((char*)fq_name, accessor_impl, __FILE__);
381 SV* const slot = newSVpvn_share(key, keylen, 0U);
382 MAGIC* mg;
383
384 if(!fq_name){
385 /* anonymous xsubs need sv_2mortal */
386 sv_2mortal((SV*)xsub);
387 }
388
389 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, NULL, 0);
390 SvREFCNT_dec(slot); /* sv_magicext() increases refcnt in mg_obj */
391
392 /* NOTE:
393 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
394 */
395 CvXSUBANY(xsub).any_ptr = (void*)mg;
396
397 return xsub;
398}
399
30e11004 400XS(XS_Mouse_simple_reader)
646c0371 401{
402 dVAR; dXSARGS;
403 dMOUSE_self;
404 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
405 SV* value;
406
407 if (items != 1) {
408 croak("Expected exactly one argument for a reader for '%"SVf"'", slot);
409 }
410
6fe2272b 411 value = get_slot(self, slot);
646c0371 412 ST(0) = value ? value : &PL_sv_undef;
413 XSRETURN(1);
414}
415
416
30e11004 417XS(XS_Mouse_simple_writer)
646c0371 418{
419 dVAR; dXSARGS;
420 dMOUSE_self;
421 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
422
423 if (items != 2) {
424 croak("Expected exactly two argument for a writer for '%"SVf"'", slot);
425 }
426
6fe2272b 427 ST(0) = set_slot(self, slot, ST(1));
646c0371 428 XSRETURN(1);
429}
430
30e11004 431XS(XS_Mouse_simple_clearer)
646c0371 432{
433 dVAR; dXSARGS;
434 dMOUSE_self;
435 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
436 SV* value;
437
438 if (items != 1) {
439 croak("Expected exactly one argument for a clearer for '%"SVf"'", slot);
440 }
441
6fe2272b 442 value = delete_slot(self, slot);
646c0371 443 ST(0) = value ? value : &PL_sv_undef;
444 XSRETURN(1);
445}
446
30e11004 447XS(XS_Mouse_simple_predicate)
646c0371 448{
449 dVAR; dXSARGS;
450 dMOUSE_self;
451 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
452
453 if (items != 1) {
454 croak("Expected exactly one argument for a predicate for '%"SVf"'", slot);
455 }
456
6fe2272b 457 ST(0) = boolSV( has_slot(self, slot) );
646c0371 458 XSRETURN(1);
459}
460
76770976 461/* simple instance slot accessor (or Mouse::Meta::Instance) */
646c0371 462
463SV*
464mouse_instance_create(pTHX_ HV* const stash) {
465 assert(stash);
466 return sv_bless( newRV_noinc((SV*)newHV()), stash );
467}
468
469SV*
470mouse_instance_clone(pTHX_ SV* const instance) {
471 HV* proto;
472 assert(instance);
473
474 CHECK_INSTANCE(instance);
475 proto = newHVhv((HV*)SvRV(instance));
476 return sv_bless( newRV_noinc((SV*)proto), SvSTASH(SvRV(instance)) );
477}
478
479bool
480mouse_instance_has_slot(pTHX_ SV* const instance, SV* const slot) {
481 assert(instance);
482 assert(slot);
483 CHECK_INSTANCE(instance);
484 return hv_exists_ent((HV*)SvRV(instance), slot, 0U);
485}
486
487SV*
488mouse_instance_get_slot(pTHX_ SV* const instance, SV* const slot) {
489 HE* he;
490 assert(instance);
491 assert(slot);
492 CHECK_INSTANCE(instance);
493 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
494 return he ? HeVAL(he) : NULL;
495}
496
497SV*
498mouse_instance_set_slot(pTHX_ SV* const instance, SV* const slot, SV* const value) {
499 HE* he;
500 SV* sv;
501 assert(instance);
502 assert(slot);
503 assert(value);
504 CHECK_INSTANCE(instance);
505 he = hv_fetch_ent((HV*)SvRV(instance), slot, TRUE, 0U);
506 sv = HeVAL(he);
507 sv_setsv_mg(sv, value);
508 return sv;
509}
510
511SV*
512mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot) {
513 assert(instance);
514 assert(slot);
515 CHECK_INSTANCE(instance);
516 return hv_delete_ent((HV*)SvRV(instance), slot, 0, 0U);
517}
518
519void
520mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot) {
521 HE* he;
522 assert(instance);
523 assert(slot);
524 CHECK_INSTANCE(instance);
525 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
526 if(he){
527 sv_rvweaken(HeVAL(he));
528 }
529}
530\r
531MODULE = Mouse::Meta::Method::Accessor::XS PACKAGE = Mouse::Meta::Method::Accessor::XS
532
533PROTOTYPES: DISABLE
534VERSIONCHECK: DISABLE
535
536CV*
537_generate_accessor(klass, SV* attr, metaclass)
538CODE:
539{
30e11004 540 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, XS_Mouse_accessor);
646c0371 541}
542OUTPUT:
543 RETVAL
544
545CV*
546_generate_reader(klass, SV* attr, metaclass)
547CODE:
548{
30e11004 549 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, XS_Mouse_reader);
646c0371 550}
551OUTPUT:
552 RETVAL
553
554CV*
555_generate_writer(klass, SV* attr, metaclass)
556CODE:
557{
30e11004 558 RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, XS_Mouse_writer);
646c0371 559}
560OUTPUT:
561 RETVAL
562
563CV*
564_generate_clearer(klass, SV* attr, metaclass)
565CODE:
566{
567 SV* const slot = mcall0s(attr, "name");
568 STRLEN len;
569 const char* const pv = SvPV_const(slot, len);
30e11004 570 RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, XS_Mouse_simple_clearer);
646c0371 571}
572OUTPUT:
573 RETVAL
574
575CV*
576_generate_predicate(klass, SV* attr, metaclass)
577CODE:
578{
579 SV* const slot = mcall0s(attr, "name");
580 STRLEN len;
581 const char* const pv = SvPV_const(slot, len);
30e11004 582 RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, XS_Mouse_simple_predicate);
646c0371 583}
584OUTPUT:
585 RETVAL
586