Improve error messages
[gitmo/Mouse.git] / xs-src / MouseAccessor.xs
CommitLineData
646c0371 1#include "mouse.h"
2
73d8d597 3#define CHECK_INSTANCE(instance) STMT_START{ \
4 if(!(SvROK(instance) && SvTYPE(SvRV(instance)) == SVt_PVHV)){ \
ef53a04b 5 croak("Invalid object instance: '%"SVf"'", instance); \
73d8d597 6 } \
646c0371 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 }
caf77af6 91 else{
80aa5731 92 HV* hv;
208ffaeb 93 HE* he;
94
caf77af6 95 assert(flags & MOUSEf_TC_IS_HASHREF);
96
80aa5731 97 if(!IsHashRef(value)){
208ffaeb 98 croak("Mouse-panic: Not a HASH reference");
99 }
100
80aa5731 101 hv = (HV*)SvRV(value);
208ffaeb 102 hv_iterinit(hv);
103 while((he = hv_iternext(hv))){
104 EXTEND(SP, 2);
105 PUSHs(hv_iterkeysv(he));
106 PUSHs(hv_iterval(hv, he));
107 }
646c0371 108 }
109
110 PUTBACK;
111}
112
113static void
114mouse_attr_get(pTHX_ SV* const self, MAGIC* const mg){
115 U16 const flags = MOUSE_mg_flags(mg);
646c0371 116 SV* value;
117
4e7e3250 118 value = get_slot(self, MOUSE_mg_slot(mg));
646c0371 119
120 /* check_lazy */
121 if( !value && flags & MOUSEf_ATTR_IS_LAZY ){
4e7e3250 122 value = mouse_xa_set_default(aTHX_ MOUSE_mg_xa(mg), self);
646c0371 123 }
124
208ffaeb 125 PUSH_VALUE(value, flags);
646c0371 126}
127
128static void
129mouse_attr_set(pTHX_ SV* const self, MAGIC* const mg, SV* value){
130 U16 const flags = MOUSE_mg_flags(mg);
131 SV* const slot = MOUSE_mg_slot(mg);
132
133 if(flags & MOUSEf_ATTR_HAS_TC){
4e7e3250 134 value = mouse_xa_apply_type_constraint(aTHX_ MOUSE_mg_xa(mg), value, flags);
646c0371 135 }
136
ca8e67d6 137 value = set_slot(self, slot, value);
646c0371 138
139 if(flags & MOUSEf_ATTR_IS_WEAK_REF){
6fe2272b 140 weaken_slot(self, slot);
646c0371 141 }
142
143 if(flags & MOUSEf_ATTR_HAS_TRIGGER){
144 SV* const trigger = mcall0s(MOUSE_mg_attribute(mg), "trigger");
145 dSP;
146
8ab2c6ab 147 /* NOTE: triggers can remove value, so
148 value must be copied here,
149 revealed by Net::Google::DataAPI (DANJOU).
150 */
151 value = sv_mortalcopy(value);
152
646c0371 153 PUSHMARK(SP);
154 EXTEND(SP, 2);
155 PUSHs(self);
156 PUSHs(value);
157
158 PUTBACK;
b3cd4c14 159 call_sv_safe(trigger, G_VOID | G_DISCARD);
646c0371 160 /* need not SPAGAIN */
8ab2c6ab 161
162 assert(SvTYPE(value) != SVTYPEMASK);
646c0371 163 }
164
208ffaeb 165 PUSH_VALUE(value, flags);
646c0371 166}
167
30e11004 168XS(XS_Mouse_accessor)
646c0371 169{
170 dVAR; dXSARGS;
171 dMOUSE_self;
172 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
173
174 SP -= items; /* PPCODE */
175 PUTBACK;
176
177 if(items == 1){ /* reader */
178 mouse_attr_get(aTHX_ self, mg);
179 }
180 else if (items == 2){ /* writer */
181 mouse_attr_set(aTHX_ self, mg, ST(1));
182 }
183 else{
184 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
185 "Expected exactly one or two argument for an accessor");
186 }
187}
188
189
30e11004 190XS(XS_Mouse_reader)
646c0371 191{
192 dVAR; dXSARGS;
193 dMOUSE_self;
194 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
195
196 if (items != 1) {
197 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
198 "Cannot assign a value to a read-only accessor");
199 }
200
201 SP -= items; /* PPCODE */
202 PUTBACK;
203
204 mouse_attr_get(aTHX_ self, mg);
205}
206
30e11004 207XS(XS_Mouse_writer)
646c0371 208{
209 dVAR; dXSARGS;
210 dMOUSE_self;
211 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
212
213 if (items != 2) {
214 mouse_throw_error(MOUSE_mg_attribute(mg), NULL,
215 "Too few arguments for a write-only accessor");
216 }
217
218 SP -= items; /* PPCODE */
219 PUTBACK;
220
221 mouse_attr_set(aTHX_ self, mg, ST(1));
222}
223
224/* simple accessors */
225
226/*
227static MAGIC*
228mouse_accessor_get_mg(pTHX_ CV* const xsub){
229 return moose_mg_find(aTHX_ (SV*)xsub, &mouse_simple_accessor_vtbl, MOOSEf_DIE_ON_FAIL);
230}
231*/
232
233CV*
a17f6313 234mouse_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 235 CV* const xsub = newXS((char*)fq_name, accessor_impl, __FILE__);
236 SV* const slot = newSVpvn_share(key, keylen, 0U);
237 MAGIC* mg;
238
239 if(!fq_name){
240 /* anonymous xsubs need sv_2mortal */
241 sv_2mortal((SV*)xsub);
242 }
243
e058b279 244 mg = sv_magicext((SV*)xsub, slot, PERL_MAGIC_ext, &mouse_accessor_vtbl, (char*)dptr, dlen);
646c0371 245 SvREFCNT_dec(slot); /* sv_magicext() increases refcnt in mg_obj */
e058b279 246 if(dlen == HEf_SVKEY){
247 SvREFCNT_dec(dptr);
248 }
646c0371 249
250 /* NOTE:
251 * although we use MAGIC for gc, we also store mg to CvXSUBANY for efficiency (gfx)
252 */
253 CvXSUBANY(xsub).any_ptr = (void*)mg;
254
255 return xsub;
256}
257
30e11004 258XS(XS_Mouse_simple_reader)
646c0371 259{
260 dVAR; dXSARGS;
261 dMOUSE_self;
e058b279 262 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
646c0371 263 SV* value;
264
265 if (items != 1) {
e058b279 266 croak("Expected exactly one argument for a reader for '%"SVf"'", MOUSE_mg_slot(mg));
646c0371 267 }
268
e058b279 269 value = get_slot(self, MOUSE_mg_slot(mg));
2468f1d7 270 if(!value) {
271 if(MOUSE_mg_ptr(mg)){
272 /* the default value must be a SV */
273 assert(MOUSE_mg_len(mg) == HEf_SVKEY);
274 value = (SV*)MOUSE_mg_ptr(mg);
275 }
276 else{
277 value = &PL_sv_undef;
278 }
279 }
280
281 ST(0) = value;
646c0371 282 XSRETURN(1);
283}
284
285
30e11004 286XS(XS_Mouse_simple_writer)
646c0371 287{
288 dVAR; dXSARGS;
289 dMOUSE_self;
290 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
291
292 if (items != 2) {
293 croak("Expected exactly two argument for a writer for '%"SVf"'", slot);
294 }
295
6fe2272b 296 ST(0) = set_slot(self, slot, ST(1));
646c0371 297 XSRETURN(1);
298}
299
30e11004 300XS(XS_Mouse_simple_clearer)
646c0371 301{
302 dVAR; dXSARGS;
303 dMOUSE_self;
304 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
305 SV* value;
306
307 if (items != 1) {
308 croak("Expected exactly one argument for a clearer for '%"SVf"'", slot);
309 }
310
6fe2272b 311 value = delete_slot(self, slot);
646c0371 312 ST(0) = value ? value : &PL_sv_undef;
313 XSRETURN(1);
314}
315
30e11004 316XS(XS_Mouse_simple_predicate)
646c0371 317{
318 dVAR; dXSARGS;
319 dMOUSE_self;
320 SV* const slot = MOUSE_mg_slot((MAGIC*)XSANY.any_ptr);
321
322 if (items != 1) {
323 croak("Expected exactly one argument for a predicate for '%"SVf"'", slot);
324 }
325
6fe2272b 326 ST(0) = boolSV( has_slot(self, slot) );
646c0371 327 XSRETURN(1);
328}
329
76770976 330/* simple instance slot accessor (or Mouse::Meta::Instance) */
646c0371 331
332SV*
333mouse_instance_create(pTHX_ HV* const stash) {
334 assert(stash);
aa2d2e2c 335 assert(SvTYPE(stash) == SVt_PVHV);
646c0371 336 return sv_bless( newRV_noinc((SV*)newHV()), stash );
337}
338
339SV*
340mouse_instance_clone(pTHX_ SV* const instance) {
341 HV* proto;
342 assert(instance);
343
344 CHECK_INSTANCE(instance);
345 proto = newHVhv((HV*)SvRV(instance));
346 return sv_bless( newRV_noinc((SV*)proto), SvSTASH(SvRV(instance)) );
347}
348
349bool
350mouse_instance_has_slot(pTHX_ SV* const instance, SV* const slot) {
351 assert(instance);
352 assert(slot);
353 CHECK_INSTANCE(instance);
354 return hv_exists_ent((HV*)SvRV(instance), slot, 0U);
355}
356
357SV*
358mouse_instance_get_slot(pTHX_ SV* const instance, SV* const slot) {
359 HE* he;
360 assert(instance);
361 assert(slot);
362 CHECK_INSTANCE(instance);
363 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
364 return he ? HeVAL(he) : NULL;
365}
366
367SV*
368mouse_instance_set_slot(pTHX_ SV* const instance, SV* const slot, SV* const value) {
369 HE* he;
370 SV* sv;
371 assert(instance);
372 assert(slot);
373 assert(value);
374 CHECK_INSTANCE(instance);
375 he = hv_fetch_ent((HV*)SvRV(instance), slot, TRUE, 0U);
376 sv = HeVAL(he);
957474ad 377 sv_setsv(sv, value);
378 SvSETMAGIC(sv);
646c0371 379 return sv;
380}
381
382SV*
383mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot) {
384 assert(instance);
385 assert(slot);
386 CHECK_INSTANCE(instance);
387 return hv_delete_ent((HV*)SvRV(instance), slot, 0, 0U);
388}
389
390void
391mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot) {
392 HE* he;
393 assert(instance);
394 assert(slot);
395 CHECK_INSTANCE(instance);
396 he = hv_fetch_ent((HV*)SvRV(instance), slot, FALSE, 0U);
397 if(he){
398 sv_rvweaken(HeVAL(he));
399 }
400}
346a3ab8 401
646c0371 402MODULE = Mouse::Meta::Method::Accessor::XS PACKAGE = Mouse::Meta::Method::Accessor::XS
403
404PROTOTYPES: DISABLE
405VERSIONCHECK: DISABLE
406
407CV*
408_generate_accessor(klass, SV* attr, metaclass)
409CODE:
410{
a17f6313 411 RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_accessor);
646c0371 412}
413OUTPUT:
414 RETVAL
415
416CV*
417_generate_reader(klass, SV* attr, metaclass)
418CODE:
419{
a17f6313 420 RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_reader);
646c0371 421}
422OUTPUT:
423 RETVAL
424
425CV*
426_generate_writer(klass, SV* attr, metaclass)
427CODE:
428{
a17f6313 429 RETVAL = mouse_accessor_generate(aTHX_ attr, XS_Mouse_writer);
646c0371 430}
431OUTPUT:
432 RETVAL
433
434CV*
435_generate_clearer(klass, SV* attr, metaclass)
436CODE:
437{
06afbf31 438 SV* const slot = mcall0(attr, mouse_name);
646c0371 439 STRLEN len;
440 const char* const pv = SvPV_const(slot, len);
a17f6313 441 RETVAL = mouse_simple_accessor_generate(aTHX_ NULL, pv, len, XS_Mouse_simple_clearer, NULL, 0);
646c0371 442}
443OUTPUT:
444 RETVAL
445
446CV*
447_generate_predicate(klass, SV* attr, metaclass)
448CODE:
449{
06afbf31 450 SV* const slot = mcall0(attr, mouse_name);
646c0371 451 STRLEN len;
452 const char* const pv = SvPV_const(slot, len);
a17f6313 453 RETVAL = mouse_simple_accessor_generate(aTHX_ NULL, pv, len, XS_Mouse_simple_predicate, NULL, 0);
646c0371 454}
455OUTPUT:
456 RETVAL
457