Fix RT #54203 (reported by chocolateboy) that setters might return undef.
[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
646c0371 9
10#define MOUSE_mg_attribute(mg) MOUSE_xa_attribute(MOUSE_mg_xa(mg))
11
646c0371 12static MGVTBL mouse_accessor_vtbl; /* MAGIC identity */
13
cc7cd81f 14#define dMOUSE_self SV* const self = mouse_accessor_get_self(aTHX_ ax, items, cv)
646c0371 15
cc7cd81f 16static inline SV*
646c0371 17mouse_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv) {
646c0371 18 if(items < 1){
19 croak("Too few arguments for %s", GvNAME(CvGV(cv)));
20 }
21
22 /* NOTE: If self has GETMAGIC, $self->accessor will invoke GETMAGIC
23 * before calling methods, so SvGETMAGIC(self) is not necessarily needed here.
24 */
25
76770976 26 return ST(0);
646c0371 27}
28
29
30CV*
a17f6313 31mouse_accessor_generate(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl){
0aad0266 32 AV* const xa = mouse_get_xa(aTHX_ attr);
646c0371 33 CV* xsub;
34 MAGIC* mg;
646c0371 35
36 xsub = newXS(NULL, accessor_impl, __FILE__);
37 sv_2mortal((SV*)xsub);
38
0aad0266 39 mg = sv_magicext((SV*)xsub, MOUSE_xa_slot(xa), PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)xa, HEf_SVKEY);
40
4e7e3250 41 MOUSE_mg_flags(mg) = (U16)MOUSE_xa_flags(xa);
646c0371 42
43 /* NOTE:
44 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
45 */
46 CvXSUBANY(xsub).any_ptr = (void*)mg;
47
646c0371 48 return xsub;
49}
50
646c0371 51
208ffaeb 52#define PUSH_VALUE(value, flags) STMT_START { \
53 if((flags) & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY){ \
54 mouse_push_values(aTHX_ value, (flags)); \
55 } \
56 else{ \
57 dSP; \
58 XPUSHs(value ? value : &PL_sv_undef); \
59 PUTBACK; \
60 } \
61 } STMT_END \
646c0371 62
63/* pushes return values, does auto-deref if needed */
64static void
65mouse_push_values(pTHX_ SV* const value, U16 const flags){
66 dSP;
67
208ffaeb 68 assert( flags & MOUSEf_ATTR_SHOULD_AUTO_DEREF && GIMME_V == G_ARRAY );
646c0371 69
208ffaeb 70 if(!(value && SvOK(value))){
71 return;
72 }
646c0371 73
208ffaeb 74 if(flags & MOUSEf_TC_IS_ARRAYREF){
80aa5731 75 AV* av;
208ffaeb 76 I32 len;
77 I32 i;
646c0371 78
80aa5731 79 if(!IsArrayRef(value)){
208ffaeb 80 croak("Mouse-panic: Not an ARRAY reference");
646c0371 81 }
646c0371 82
80aa5731 83 av = (AV*)SvRV(value);
208ffaeb 84 len = av_len(av) + 1;
85 EXTEND(SP, len);
86 for(i = 0; i < len; i++){
87 SV** const svp = av_fetch(av, i, FALSE);
88 PUSHs(svp ? *svp : &PL_sv_undef);
646c0371 89 }
90 }
208ffaeb 91 else if(flags & MOUSEf_TC_IS_HASHREF){
80aa5731 92 HV* hv;
208ffaeb 93 HE* he;
94
80aa5731 95 if(!IsHashRef(value)){
208ffaeb 96 croak("Mouse-panic: Not a HASH reference");
97 }
98
80aa5731 99 hv = (HV*)SvRV(value);
208ffaeb 100 hv_iterinit(hv);
101 while((he = hv_iternext(hv))){
102 EXTEND(SP, 2);
103 PUSHs(hv_iterkeysv(he));
104 PUSHs(hv_iterval(hv, he));
105 }
646c0371 106 }
107
108 PUTBACK;
109}
110
111static void
112mouse_attr_get(pTHX_ SV* const self, MAGIC* const mg){
113 U16 const flags = MOUSE_mg_flags(mg);
646c0371 114 SV* value;
115
4e7e3250 116 value = get_slot(self, MOUSE_mg_slot(mg));
646c0371 117
118 /* check_lazy */
119 if( !value && flags & MOUSEf_ATTR_IS_LAZY ){
4e7e3250 120 value = mouse_xa_set_default(aTHX_ MOUSE_mg_xa(mg), self);
646c0371 121 }
122
208ffaeb 123 PUSH_VALUE(value, flags);
646c0371 124}
125
126static void
127mouse_attr_set(pTHX_ SV* const self, MAGIC* const mg, SV* value){
128 U16 const flags = MOUSE_mg_flags(mg);
129 SV* const slot = MOUSE_mg_slot(mg);
130
131 if(flags & MOUSEf_ATTR_HAS_TC){
4e7e3250 132 value = mouse_xa_apply_type_constraint(aTHX_ MOUSE_mg_xa(mg), value, flags);
646c0371 133 }
134
ca8e67d6 135 value = set_slot(self, slot, value);
646c0371 136
137 if(flags & MOUSEf_ATTR_IS_WEAK_REF){
6fe2272b 138 weaken_slot(self, slot);
646c0371 139 }
140
141 if(flags & MOUSEf_ATTR_HAS_TRIGGER){
142 SV* const trigger = mcall0s(MOUSE_mg_attribute(mg), "trigger");
143 dSP;
144
145 PUSHMARK(SP);
146 EXTEND(SP, 2);
147 PUSHs(self);
148 PUSHs(value);
149
150 PUTBACK;
151 call_sv(trigger, G_VOID | G_DISCARD);
152 /* need not SPAGAIN */
153 }
154
208ffaeb 155 PUSH_VALUE(value, flags);
646c0371 156}
157
30e11004 158XS(XS_Mouse_accessor)
646c0371 159{
160 dVAR; dXSARGS;
161 dMOUSE_self;
162 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
163
164 SP -= items; /* PPCODE */
165 PUTBACK;
166
167 if(items == 1){ /* reader */
168 mouse_attr_get(aTHX_ self, mg);
169 }
170 else if (items == 2){ /* writer */
171 mouse_attr_set(aTHX_ self, mg, ST(1));
172 }
173 else{
174 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
175 "Expected exactly one or two argument for an accessor");
176 }
177}
178
179
30e11004 180XS(XS_Mouse_reader)
646c0371 181{
182 dVAR; dXSARGS;
183 dMOUSE_self;
184 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
185
186 if (items != 1) {
187 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
188 "Cannot assign a value to a read-only accessor");
189 }
190
191 SP -= items; /* PPCODE */
192 PUTBACK;
193
194 mouse_attr_get(aTHX_ self, mg);
195}
196
30e11004 197XS(XS_Mouse_writer)
646c0371 198{
199 dVAR; dXSARGS;
200 dMOUSE_self;
201 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
202
203 if (items != 2) {
204 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
205 "Too few arguments for a write-only accessor");
206 }
207
208 SP -= items; /* PPCODE */
209 PUTBACK;
210
211 mouse_attr_set(aTHX_ self, mg, ST(1));
212}
213
214/* simple accessors */
215
216/*
217static MAGIC*
218mouse_accessor_get_mg(pTHX_ CV* const xsub){
219 return moose_mg_find(aTHX_ (SV*)xsub, &mouse_simple_accessor_vtbl, MOOSEf_DIE_ON_FAIL);
220}
221*/
222
223CV*
a17f6313 224mouse_simple_accessor_generate(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl, void* const dptr, I32 const dlen){
646c0371 225 CV* const xsub = newXS((char*)fq_name, accessor_impl, __FILE__);
226 SV* const slot = newSVpvn_share(key, keylen, 0U);
227 MAGIC* mg;
228
229 if(!fq_name){
230 /* anonymous xsubs need sv_2mortal */
231 sv_2mortal((SV*)xsub);
232 }
233
e058b279 234 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)dptr, dlen);
646c0371 235 SvREFCNT_dec(slot); /* sv_magicext() increases refcnt in mg_obj */
e058b279 236 if(dlen == HEf_SVKEY){
237 SvREFCNT_dec(dptr);
238 }
646c0371 239
240 /* NOTE:
241 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
242 */
243 CvXSUBANY(xsub).any_ptr = (void*)mg;
244
245 return xsub;
246}
247
30e11004 248XS(XS_Mouse_simple_reader)
646c0371 249{
250 dVAR; dXSARGS;
251 dMOUSE_self;
e058b279 252 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
646c0371 253 SV* value;
254
255 if (items != 1) {
e058b279 256 croak("Expected exactly one argument for a reader for '%"SVf"'", MOUSE_mg_slot(mg));
646c0371 257 }
258
e058b279 259 value = get_slot(self, MOUSE_mg_slot(mg));
2468f1d7 260 if(!value) {
261 if(MOUSE_mg_ptr(mg)){
262 /* the default value must be a SV */
263 assert(MOUSE_mg_len(mg) == HEf_SVKEY);
264 value = (SV*)MOUSE_mg_ptr(mg);
265 }
266 else{
267 value = &PL_sv_undef;
268 }
269 }
270
271 ST(0) = value;
646c0371 272 XSRETURN(1);
273}
274
275
30e11004 276XS(XS_Mouse_simple_writer)
646c0371 277{
278 dVAR; dXSARGS;
279 dMOUSE_self;
280 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
281
282 if (items != 2) {
283 croak("Expected exactly two argument for a writer for '%"SVf"'", slot);
284 }
285
6fe2272b 286 ST(0) = set_slot(self, slot, ST(1));
646c0371 287 XSRETURN(1);
288}
289
30e11004 290XS(XS_Mouse_simple_clearer)
646c0371 291{
292 dVAR; dXSARGS;
293 dMOUSE_self;
294 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
295 SV* value;
296
297 if (items != 1) {
298 croak("Expected exactly one argument for a clearer for '%"SVf"'", slot);
299 }
300
6fe2272b 301 value = delete_slot(self, slot);
646c0371 302 ST(0) = value ? value : &PL_sv_undef;
303 XSRETURN(1);
304}
305
30e11004 306XS(XS_Mouse_simple_predicate)
646c0371 307{
308 dVAR; dXSARGS;
309 dMOUSE_self;
310 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
311
312 if (items != 1) {
313 croak("Expected exactly one argument for a predicate for '%"SVf"'", slot);
314 }
315
6fe2272b 316 ST(0) = boolSV( has_slot(self, slot) );
646c0371 317 XSRETURN(1);
318}
319
76770976 320/* simple instance slot accessor (or Mouse::Meta::Instance) */
646c0371 321
322SV*
323mouse_instance_create(pTHX_ HV* const stash) {
324 assert(stash);
aa2d2e2c 325 assert(SvTYPE(stash) == SVt_PVHV);
646c0371 326 return sv_bless( newRV_noinc((SV*)newHV()), stash );
327}
328
329SV*
330mouse_instance_clone(pTHX_ SV* const instance) {
331 HV* proto;
332 assert(instance);
333
334 CHECK_INSTANCE(instance);
335 proto = newHVhv((HV*)SvRV(instance));
336 return sv_bless( newRV_noinc((SV*)proto), SvSTASH(SvRV(instance)) );
337}
338
339bool
340mouse_instance_has_slot(pTHX_ SV* const instance, SV* const slot) {
341 assert(instance);
342 assert(slot);
343 CHECK_INSTANCE(instance);
344 return hv_exists_ent((HV*)SvRV(instance), slot, 0U);
345}
346
347SV*
348mouse_instance_get_slot(pTHX_ SV* const instance, SV* const slot) {
349 HE* he;
350 assert(instance);
351 assert(slot);
352 CHECK_INSTANCE(instance);
353 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
354 return he ? HeVAL(he) : NULL;
355}
356
357SV*
358mouse_instance_set_slot(pTHX_ SV* const instance, SV* const slot, SV* const value) {
359 HE* he;
360 SV* sv;
361 assert(instance);
362 assert(slot);
363 assert(value);
364 CHECK_INSTANCE(instance);
365 he = hv_fetch_ent((HV*)SvRV(instance), slot, TRUE, 0U);
366 sv = HeVAL(he);
957474ad 367 sv_setsv(sv, value);
368 SvSETMAGIC(sv);
646c0371 369 return sv;
370}
371
372SV*
373mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot) {
374 assert(instance);
375 assert(slot);
376 CHECK_INSTANCE(instance);
377 return hv_delete_ent((HV*)SvRV(instance), slot, 0, 0U);
378}
379
380void
381mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot) {
382 HE* he;
383 assert(instance);
384 assert(slot);
385 CHECK_INSTANCE(instance);
386 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
387 if(he){
388 sv_rvweaken(HeVAL(he));
389 }
390}
346a3ab8 391
646c0371 392MODULE = Mouse::Meta::Method::Accessor::XS PACKAGE = Mouse::Meta::Method::Accessor::XS
393
394PROTOTYPES: DISABLE
395VERSIONCHECK: DISABLE
396
397CV*
398_generate_accessor(klass, SV* attr, metaclass)
399CODE:
400{
a17f6313 401 RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_accessor);
646c0371 402}
403OUTPUT:
404 RETVAL
405
406CV*
407_generate_reader(klass, SV* attr, metaclass)
408CODE:
409{
a17f6313 410 RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_reader);
646c0371 411}
412OUTPUT:
413 RETVAL
414
415CV*
416_generate_writer(klass, SV* attr, metaclass)
417CODE:
418{
a17f6313 419 RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_writer);
646c0371 420}
421OUTPUT:
422 RETVAL
423
424CV*
425_generate_clearer(klass, SV* attr, metaclass)
426CODE:
427{
428 SV* const slot = mcall0s(attr, "name");
429 STRLEN len;
430 const char* const pv = SvPV_const(slot, len);
a17f6313 431 RETVAL = mouse_simple_accessor_generate(aTHX_ NULL, pv, len, XS_Mouse_simple_clearer, NULL, 0);
646c0371 432}
433OUTPUT:
434 RETVAL
435
436CV*
437_generate_predicate(klass, SV* attr, metaclass)
438CODE:
439{
440 SV* const slot = mcall0s(attr, "name");
441 STRLEN len;
442 const char* const pv = SvPV_const(slot, len);
a17f6313 443 RETVAL = mouse_simple_accessor_generate(aTHX_ NULL, pv, len, XS_Mouse_simple_predicate, NULL, 0);
646c0371 444}
445OUTPUT:
446 RETVAL
447