Fix BUILDARGS logic
[gitmo/Mouse.git] / xs-src / Mouse.xs
CommitLineData
1b812057 1#define NEED_newSVpvn_flags_GLOBAL
df6dd016 2#include "mouse.h"
3
cccb83de 4SV* mouse_package;
5SV* mouse_namespace;
3e44140b 6SV* mouse_methods;
a5df48e5 7SV* mouse_name;
047d7af0 8SV* mouse_get_attribute;
9SV* mouse_get_attribute_list;
cccb83de 10
4e7e3250 11#define MOUSE_xc_flags(a) SvUVX(MOUSE_av_at((a), MOUSE_XC_FLAGS))
a39e9541 12#define MOUSE_xc_gen(a) MOUSE_av_at((a), MOUSE_XC_GEN)
aa2d2e2c 13#define MOUSE_xc_stash(a) ( (HV*)MOUSE_av_at((a), MOUSE_XC_STASH) )
a39e9541 14#define MOUSE_xc_attrall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_ATTRALL) )
15#define MOUSE_xc_buildall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_BUILDALL) )
9974d611 16#define MOUSE_xc_demolishall(a) ( (AV*)MOUSE_av_at((a), MOUSE_XC_DEMOLISHALL) )
a39e9541 17
aa2d2e2c 18enum mouse_xc_flags_t {
19 MOUSEf_XC_IS_IMMUTABLE = 0x0001,
20 MOUSEf_XC_IS_ANON = 0x0002,
21 MOUSEf_XC_HAS_BUILDARGS = 0x0004,
22
23 MOUSEf_XC_mask = 0xFFFF /* not used */
24};
25
a39e9541 26/* Mouse XS Metaclass object */
27enum mouse_xc_ix_t{
4e7e3250 28 MOUSE_XC_FLAGS,
29
a39e9541 30 MOUSE_XC_GEN, /* class generation */
aa2d2e2c 31 MOUSE_XC_STASH, /* symbol table hash */
aa2d2e2c 32
a39e9541 33 MOUSE_XC_ATTRALL, /* all the attributes */
34 MOUSE_XC_BUILDALL, /* all the BUILD methods */
35 MOUSE_XC_DEMOLISHALL, /* all the DEMOLISH methods */
36
37 MOUSE_XC_last
38};
39
40static MGVTBL mouse_xc_vtbl; /* for identity */
41
42static void
43mouse_class_push_attribute_list(pTHX_ SV* const metaclass, AV* const attrall, HV* const seen){
44 dSP;
45 I32 n;
46
47 /* $meta->get_attribute_list */
48 PUSHMARK(SP);
49 XPUSHs(metaclass);
50 PUTBACK;
51
047d7af0 52 n = call_sv(mouse_get_attribute_list, G_ARRAY | G_METHOD);
a39e9541 53 for(NOOP; n > 0; n--){
54 SV* name;
55
56 SPAGAIN;
57 name = POPs;
58 PUTBACK;
59
60 if(hv_exists_ent(seen, name, 0U)){
61 continue;
62 }
63 (void)hv_store_ent(seen, name, &PL_sv_undef, 0U);
da4432f3 64
047d7af0 65 av_push(attrall, newSVsv( mcall1(metaclass, mouse_get_attribute, name) ));
a39e9541 66 }
67}
743ca82e 68
aa2d2e2c 69static int
70mouse_class_has_custom_buildargs(pTHX_ HV* const stash) {
71 XS(XS_Mouse__Object_BUILDARGS); /* prototype */
72
73 GV* const buildargs = gv_fetchmeth_autoload(stash, "BUILDARGS", sizeof("BUILDARGS")-1, 0);
aa2d2e2c 74
12872cc1 75 return buildargs && CvXSUB(GvCV(buildargs)) != XS_Mouse__Object_BUILDARGS;
aa2d2e2c 76}
77
a39e9541 78static void
79mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stash, AV* const xc) {
80 AV* const linearized_isa = mro_get_linear_isa(stash);
81 I32 const len = AvFILLp(linearized_isa);
82 I32 i;
aa2d2e2c 83 U32 flags = 0x00;
a39e9541 84 AV* const attrall = newAV();
85 AV* const buildall = newAV();
86 AV* const demolishall = newAV();
87 HV* const seen = newHV(); /* for attributes */
da4432f3 88
a39e9541 89 ENTER;
90 SAVETMPS;
da4432f3 91
a39e9541 92 sv_2mortal((SV*)seen);
da4432f3 93
a39e9541 94 /* old data will be delete at the end of the perl scope */
95 av_delete(xc, MOUSE_XC_DEMOLISHALL, 0x00);
96 av_delete(xc, MOUSE_XC_BUILDALL, 0x00);
97 av_delete(xc, MOUSE_XC_ATTRALL, 0x00);
743ca82e 98
a39e9541 99 SvREFCNT_inc_simple_void_NN(linearized_isa);
100 sv_2mortal((SV*)linearized_isa);
da4432f3 101
a39e9541 102 /* update */
da4432f3 103
4e7e3250 104 if(predicate_calls(metaclass, "is_immutable")){
aa2d2e2c 105 flags |= MOUSEf_XC_IS_IMMUTABLE;
106 }
107
4e7e3250 108 if(predicate_calls(metaclass, "is_anon_class")){
109 flags |= MOUSEf_XC_IS_ANON;
110 }
111
aa2d2e2c 112 if(mouse_class_has_custom_buildargs(aTHX_ stash)){
113 flags |= MOUSEf_XC_HAS_BUILDARGS;
114 }
115
4e7e3250 116 av_store(xc, MOUSE_XC_FLAGS, newSVuv(flags));
a39e9541 117 av_store(xc, MOUSE_XC_ATTRALL, (SV*)attrall);
118 av_store(xc, MOUSE_XC_BUILDALL, (SV*)buildall);
119 av_store(xc, MOUSE_XC_DEMOLISHALL, (SV*)demolishall);
da4432f3 120
a39e9541 121 for(i = 0; i < len; i++){
047d7af0 122 SV* const klass = MOUSE_av_at(linearized_isa, i);
a39e9541 123 SV* meta;
124 GV* gv;
da4432f3 125
a39e9541 126 gv = stash_fetchs(stash, "BUILD", FALSE);
127 if(gv && GvCVu(gv)){
128 av_push(buildall, newRV_inc((SV*)GvCV(gv)));
129 }
da4432f3 130
a39e9541 131 gv = stash_fetchs(stash, "DEMOLISH", FALSE);
132 if(gv && GvCVu(gv)){
133 av_push(demolishall, newRV_inc((SV*)GvCV(gv)));
134 }
da4432f3 135
a39e9541 136 /* ATTRIBUTES */
aa2d2e2c 137 meta = get_metaclass(klass);
a39e9541 138 if(!SvOK(meta)){
139 continue; /* skip non-Mouse classes */
140 }
da4432f3 141
a39e9541 142 mouse_class_push_attribute_list(aTHX_ meta, attrall, seen);
143 }
da4432f3 144
a39e9541 145 FREETMPS;
146 LEAVE;
da4432f3 147
a39e9541 148 sv_setuv(MOUSE_xc_gen(xc), mro_get_pkg_gen(stash));
149}
da4432f3 150
a39e9541 151AV*
152mouse_get_xc(pTHX_ SV* const metaclass) {
153 AV* xc;
154 SV* gen;
155 HV* stash;
156 MAGIC* mg;
157
158 if(!IsObject(metaclass)){
159 croak("Not a Mouse metaclass");
160 }
da4432f3 161
a39e9541 162 mg = mouse_mg_find(aTHX_ SvRV(metaclass), &mouse_xc_vtbl, 0x00);
163 if(!mg){
164 SV* const package = get_slot(metaclass, mouse_package);
aa2d2e2c 165 STRLEN len;
166 const char* const pv = SvPV_const(package, len);
da4432f3 167
aa2d2e2c 168 stash = gv_stashpvn(pv, len, TRUE);
a39e9541 169 xc = newAV();
da4432f3 170
aa2d2e2c 171 mg = sv_magicext(SvRV(metaclass), (SV*)xc, PERL_MAGIC_ext, &mouse_xc_vtbl, pv, len);
a39e9541 172 SvREFCNT_dec(xc); /* refcnt++ in sv_magicext */
da4432f3 173
a39e9541 174 av_extend(xc, MOUSE_XC_last - 1);
aa2d2e2c 175
a39e9541 176 av_store(xc, MOUSE_XC_GEN, newSViv(0));
aa2d2e2c 177 av_store(xc, MOUSE_XC_STASH, (SV*)stash);
4e7e3250 178
aa2d2e2c 179 SvREFCNT_inc_simple_void_NN(stash);
da4432f3 180 }
a39e9541 181 else{
a39e9541 182 xc = (AV*)MOUSE_mg_obj(mg);
da4432f3 183
a39e9541 184 assert(xc);
185 assert(SvTYPE(xc) == SVt_PVAV);
186 }
da4432f3 187
aa2d2e2c 188 gen = MOUSE_xc_gen(xc);
189 stash = MOUSE_xc_stash(xc);
190
a39e9541 191 if(SvUV(gen) != mro_get_pkg_gen(stash)){
192 mouse_class_update_xc(aTHX_ metaclass, stash, xc);
da4432f3 193 }
a39e9541 194
195 return xc;
196}
197
aa2d2e2c 198HV*
0aad0266 199mouse_build_args(pTHX_ SV* metaclass, SV* const klass, I32 const start, I32 const items, I32 const ax) {
aa2d2e2c 200 HV* args;
201 if((items - start) == 1){
202 SV* const args_ref = ST(start);
203 if(!IsHashRef(args_ref)){
204 if(!metaclass){ metaclass = get_metaclass(klass); }
205 mouse_throw_error(metaclass, NULL, "Single parameters to new() must be a HASH ref");
206 }
207 args = newHVhv((HV*)SvRV(args_ref));
208 sv_2mortal((SV*)args);
209 }
210 else{
211 I32 i;
212
6fab29c6 213 args = newHV_mortal();
aa2d2e2c 214
215 if( ((items - start) % 2) != 0 ){
216 if(!metaclass){ metaclass = get_metaclass(klass); }
217 mouse_throw_error(metaclass, NULL, "Odd number of parameters to new()");
218 }
219
220 for(i = start; i < items; i += 2){
221 (void)hv_store_ent(args, ST(i), newSVsv(ST(i+1)), 0U);
222 }
223
224 }
225 return args;
226}
227
228void
d4712779 229mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
230 AV* const xc = mouse_get_xc(aTHX_ meta);
231 AV* const attrs = MOUSE_xc_attrall(xc);
4e7e3250 232 I32 len = AvFILLp(attrs) + 1;
d4712779 233 I32 i;
4e7e3250 234 AV* triggers_queue = NULL;
235
236 ENTER;
237 SAVETMPS;
238
239 if(!ignore_triggers){
240 triggers_queue = newAV_mortal();
241 }
0aad0266 242
d4712779 243 for(i = 0; i < len; i++){
4e7e3250 244 SV* const attr = AvARRAY(attrs)[i];
245 AV* const xa = mouse_get_xa(aTHX_ AvARRAY(attrs)[i]);
246
247 SV* const slot = MOUSE_xa_slot(xa);
248 U16 const flags = (U16)MOUSE_xa_flags(xa);
249 SV* const init_arg = MOUSE_xa_init_arg(xa);
250 HE* he;
251
252 if(SvOK(init_arg) && ( he = hv_fetch_ent(args, init_arg, FALSE, 0U) ) ){
253 SV* value = HeVAL(he);
254 if(flags & MOUSEf_ATTR_HAS_TC){
255 value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
256 }
257 set_slot(object, slot, value);
258 if(SvROK(value) && flags & MOUSEf_ATTR_IS_WEAK_REF){
259 weaken_slot(object, slot);
260 }
261 if(flags & MOUSEf_ATTR_HAS_TRIGGER && triggers_queue){
262 AV* const pair = newAV();
263 av_push(pair, newSVsv( mcall0s(attr, "trigger") ));
264 av_push(pair, newSVsv(value));
265
266 av_push(triggers_queue, (SV*)pair);
267 }
268 }
269 else { /* no init arg */
270 if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
271 if(!(flags & MOUSEf_ATTR_IS_LAZY)){
272 mouse_xa_set_default(aTHX_ xa, object);
273 }
274 }
275 else if(flags & MOUSEf_ATTR_IS_REQUIRED) {
276 mouse_throw_error(attr, NULL, "Attribute (%"SVf") is required", slot);
277 }
278 }
279 } /* for each attributes */
280
281 if(triggers_queue){
282 len = AvFILLp(triggers_queue) + 1;
283 for(i = 0; i < len; i++){
284 AV* const pair = (AV*)AvARRAY(triggers_queue)[i];
285 SV* const trigger = AvARRAY(pair)[0];
286 SV* const value = AvARRAY(pair)[1];
287
288 mcall1(object, trigger, value);
289 }
290 }
291
292 if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
293 set_slot(object, newSVpvs_flags("__ANON__", SVs_TEMP), meta);
d4712779 294 }
4e7e3250 295
296 FREETMPS;
297 LEAVE;
aa2d2e2c 298}
299
646c0371 300MODULE = Mouse PACKAGE = Mouse
df6dd016 301
302PROTOTYPES: DISABLE
303
cccb83de 304BOOT:
305 mouse_package = newSVpvs_share("package");
306 mouse_namespace = newSVpvs_share("namespace");
3e44140b 307 mouse_methods = newSVpvs_share("methods");
a5df48e5 308 mouse_name = newSVpvs_share("name");
3e44140b 309
047d7af0 310 mouse_get_attribute = newSVpvs_share("get_attribute");
311 mouse_get_attribute_list = newSVpvs_share("get_attribute_list");
da4432f3 312
646c0371 313 MOUSE_CALL_BOOT(Mouse__Util);
1d5ecd5f 314 MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
646c0371 315 MOUSE_CALL_BOOT(Mouse__Meta__Method__Accessor__XS);
aa2d2e2c 316 MOUSE_CALL_BOOT(Mouse__Meta__Attribute);
f48920c1 317
cccb83de 318
7d96ae4d 319MODULE = Mouse PACKAGE = Mouse::Meta::Module
320
321BOOT:
322 INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
323 INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
324 INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
325
326HV*
327namespace(SV* self)
328CODE:
329{
6a97bbda 330 SV* const package = get_slot(self, mouse_package);
7d96ae4d 331 if(!(package && SvOK(package))){
3e44140b 332 croak("No package name defined");
7d96ae4d 333 }
334 RETVAL = gv_stashsv(package, GV_ADDMULTI);
335}
336OUTPUT:
337 RETVAL
338
3e44140b 339# ignore extra arguments for extensibility
340void
341add_method(SV* self, SV* name, SV* code, ...)
342CODE:
343{
6a97bbda 344 SV* const package = get_slot(self, mouse_package); /* $self->{package} */
345 SV* const methods = get_slot(self, mouse_methods); /* $self->{methods} */
3e44140b 346 GV* gv;
347 SV* code_ref;
348
349 if(!(package && SvOK(package))){
350 croak("No package name defined");
351 }
352
353 SvGETMAGIC(name);
354 SvGETMAGIC(code);
355
356 if(!SvOK(name)){
357 mouse_throw_error(self, NULL, "You must define a method name");
358 }
359 if(!SvROK(code)){
360 mouse_throw_error(self, NULL, "You must define a CODE reference");
361 }
362
363 code_ref = code;
364 if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
365 SV* sv = code_ref; /* used in tryAMAGICunDEREF */
366 SV** sp = &sv; /* used in tryAMAGICunDEREF */
367 tryAMAGICunDEREF(to_cv); /* try \&{$code} */
368 if(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV){
369 mouse_throw_error(self, NULL, "Not a CODE reference");
370 }
371 code_ref = sv;
372 }
373
374 /* *{$package . '::' . $name} -> *gv */
375 gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
376 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
377 SvREFCNT_dec(GvCV(gv));
378 GvCV(gv) = NULL;
379 }
380 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
381
6fe2272b 382 set_slot(methods, name, code); /* $self->{methods}{$name} = $code */
3e44140b 383
384 /* TODO: name the CODE ref if it's anonymous */
385 //code_entity = (CV*)SvRV(code_ref);
386 //if(CvANON(code_entity)
387 // && CvGV(code_entity) /* a cv under construction has no gv */ ){
388
389 // CvGV(code_entity) = gv;
390 // CvANON_off(code_entity);
391 //}
392}
393
43165725 394MODULE = Mouse PACKAGE = Mouse::Meta::Class
395
396BOOT:
397 INSTALL_SIMPLE_READER(Class, roles);
398 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
399
cccb83de 400void
401linearized_isa(SV* self)
402PPCODE:
403{
404 SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
405 AV* linearized_isa;
406 I32 len;
407 I32 i;
408 if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
409 croak("namespace() didn't return a HASH reference");
410 }
411 linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
412 len = AvFILLp(linearized_isa) + 1;
413 EXTEND(SP, len);
414 for(i = 0; i < len; i++){
415 PUSHs(AvARRAY(linearized_isa)[i]);
416 }
417}
418
da4432f3 419void
420get_all_attributes(SV* self)
421PPCODE:
422{
0aad0266 423 AV* const xc = mouse_get_xc(aTHX_ self);
424 AV* const all_attrs = MOUSE_xc_attrall(xc);
da4432f3 425 I32 const len = AvFILLp(all_attrs) + 1;
426 I32 i;
427
428 EXTEND(SP, len);
429 for(i = 0; i < len; i++){
430 PUSHs( MOUSE_av_at(all_attrs, i) );
431 }
432}
441964ce 433
aa2d2e2c 434SV*
435new_object_(SV* meta, ...)
436CODE:
437{
438 HV* const args = mouse_build_args(aTHX_ meta, NULL, 1, items, ax);
439 AV* const xc = mouse_get_xc(aTHX_ meta);
d4712779 440
aa2d2e2c 441 RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
d4712779 442 mouse_class_initialize_object(aTHX_ meta, RETVAL, args, FALSE);
aa2d2e2c 443}
444
445
446void
4e7e3250 447_initialize_object(SV* meta, SV* object, HV* args, bool ignore_triggers = FALSE)
aa2d2e2c 448CODE:
449{
d4712779 450 mouse_class_initialize_object(aTHX_ meta, object, args, ignore_triggers);
aa2d2e2c 451}
452
43165725 453MODULE = Mouse PACKAGE = Mouse::Meta::Role
454
455BOOT:
456 INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
457 INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
458
aa2d2e2c 459MODULE = Mouse PACKAGE = Mouse::Object
43165725 460
aa2d2e2c 461HV*
462BUILDARGS(SV* klass, ...)
463CODE:
464{
465 RETVAL = mouse_build_args(aTHX_ NULL, klass, 1, items, ax);
466}
467OUTPUT:
468 RETVAL