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