perltidy this test file
[gitmo/Class-MOP.git] / MOP.xs
CommitLineData
e7b69038 1/* There's a lot of cases of doubled parens in here like this:
2
3 while ( (he = ...) ) {
4
5This shuts up warnings from gcc -Wall
6*/
7
e0e4674a 8#include "EXTERN.h"
9#include "perl.h"
10#include "XSUB.h"
15273f3c 11
08f4716f 12#define NEED_newRV_noinc
599791aa 13#define NEED_sv_2pv_flags
15273f3c 14#define NEED_sv_2pv_nolen
b0e94057 15#include "ppport.h"
e0e4674a 16
193bfdc0 17#define DECLARE_KEY(name) SV *key_##name; U32 hash_##name;
18
1654881c 19#define PREHASH_KEY_WITH_VALUE(name, value) do { \
193bfdc0 20 key_##name = newSVpvs(value); \
21 PERL_HASH(hash_##name, value, sizeof(value) - 1); \
22} while (0)
23
45a46f7b 24/* this is basically the same as the above macro, except that the value will be
25 * the stringified name. However, we can't just implement this in terms of
26 * PREHASH_KEY_WITH_VALUE as that'd cause macro expansion on the value of
27 * 'name' when it's being passed to the other macro. suggestions on how to make
28 * this more elegant would be much appreciated */
29
30#define PREHASH_KEY(name) do { \
31 key_##name = newSVpvs(#name); \
32 PERL_HASH(hash_##name, #name, sizeof(#name) - 1); \
33} while (0)
1654881c 34
193bfdc0 35DECLARE_KEY(name);
36DECLARE_KEY(package);
37DECLARE_KEY(package_name);
38DECLARE_KEY(body);
39DECLARE_KEY(package_cache_flag);
40DECLARE_KEY(methods);
41DECLARE_KEY(VERSION);
42DECLARE_KEY(ISA);
d508fabd 43
00c93f7a 44SV *method_metaclass;
45SV *associated_metaclass;
46SV *wrap;
c94afdc4 47
48
49#define check_package_cache_flag(stash) mop_check_package_cache_flag(aTHX_ stash)
1d4cf2a9 50#if PERL_VERSION >= 10
c94afdc4 51
52static UV
53mop_check_package_cache_flag(pTHX_ HV* stash) {
54 assert(SvTYPE(stash) == SVt_PVHV);
55
1d4cf2a9 56 /* here we're trying to implement a c version of mro::get_pkg_gen($stash),
57 * however the perl core doesn't make it easy for us. It doesn't provide an
58 * api that just does what we want.
59 *
60 * However, we know that the information we want is, inside the core,
61 * available using HvMROMETA(stash)->pkg_gen. Unfortunately, although the
62 * HvMROMETA macro is public, it is implemented using Perl_mro_meta_init,
63 * which is not public and only available inside the core, as the mro
64 * interface as well as the structure returned by mro_meta_init isn't
65 * considered to be stable yet.
66 *
67 * Perl_mro_meta_init isn't declared static, so we could just define it
68 * ourselfs if perls headers don't do that for us, except that won't work
69 * on platforms where symbols need to be explicitly exported when linking
70 * shared libraries.
71 *
72 * So our, hopefully temporary, solution is to be even more evil and
73 * basically reimplement HvMROMETA in a very fragile way that'll blow up
74 * when the relevant parts of the mro implementation in core change.
75 *
76 * :-(
77 *
78 */
79
80 return HvAUX(stash)->xhv_mro_meta
81 ? HvAUX(stash)->xhv_mro_meta->pkg_gen
82 : 0;
c94afdc4 83}
84
85#else /* pre 5.10.0 */
86
87static UV
00c93f7a 88mop_check_package_cache_flag(pTHX_ HV *stash) {
c94afdc4 89 PERL_UNUSED_ARG(stash);
90 assert(SvTYPE(stash) == SVt_PVHV);
91
92 return PL_sub_generation;
93}
94#endif
95
96#define call0(s, m) mop_call0(aTHX_ s, m)
00c93f7a 97static SV *
98mop_call0(pTHX_ SV *const self, SV *const method) {
c94afdc4 99 dSP;
00c93f7a 100 SV *ret;
c94afdc4 101
102 PUSHMARK(SP);
103 XPUSHs(self);
104 PUTBACK;
105
106 call_sv(method, G_SCALAR | G_METHOD);
107
108 SPAGAIN;
109 ret = POPs;
110 PUTBACK;
111
112 return ret;
113}
114
ee82a43e 115static int
0e0b5b8d 116get_code_info (SV *coderef, char **pkg, char **name)
117{
118 if (!SvOK(coderef) || !SvROK(coderef) || SvTYPE(SvRV(coderef)) != SVt_PVCV) {
119 return 0;
120 }
6bd19edb 121
0e0b5b8d 122 coderef = SvRV(coderef);
123 /* I think this only gets triggered with a mangled coderef, but if
124 we hit it without the guard, we segfault. The slightly odd return
125 value strikes me as an improvement (mst)
126 */
127#ifdef isGV_with_GP
128 if ( isGV_with_GP(CvGV(coderef)) ) {
cb0ec494 129#endif
0e0b5b8d 130 *pkg = HvNAME( GvSTASH(CvGV(coderef)) );
131 *name = GvNAME( CvGV(coderef) );
132#ifdef isGV_with_GP
133 } else {
134 *pkg = "__UNKNOWN__";
135 *name = "__ANON__";
c94afdc4 136 }
0e0b5b8d 137#endif
138
139 return 1;
c94afdc4 140}
141
b49ee39f 142typedef enum {
143 TYPE_FILTER_NONE,
144 TYPE_FILTER_CODE,
145 TYPE_FILTER_ARRAY,
146 TYPE_FILTER_IO,
147 TYPE_FILTER_HASH,
148 TYPE_FILTER_SCALAR,
149} type_filter_t;
150
151static HV *
152get_all_package_symbols(HV *stash, type_filter_t filter)
153{
154 HE *he;
155 HV *ret = newHV();
156
157 (void)hv_iterinit(stash);
158
159 if (filter == TYPE_FILTER_NONE) {
160 while ( (he = hv_iternext(stash)) ) {
161 STRLEN keylen;
162 char *key = HePV(he, keylen);
7291ecef 163 if (!hv_store(ret, key, keylen, SvREFCNT_inc(HeVAL(he)), 0)) {
164 croak("failed to store glob ref");
165 }
b49ee39f 166 }
167
168 return ret;
169 }
170
171 while ( (he = hv_iternext(stash)) ) {
172 SV *const gv = HeVAL(he);
173 SV *sv = NULL;
174 char *key;
175 STRLEN keylen;
176 char *package;
177 SV *fq;
178
179 switch( SvTYPE(gv) ) {
180#ifndef SVt_RV
181 case SVt_RV:
182#endif
183 case SVt_PV:
184 case SVt_IV:
185 /* expand the gv into a real typeglob if it
186 * contains stub functions and we were asked to
187 * return CODE symbols */
188 if (filter == TYPE_FILTER_CODE) {
189 if (SvROK(gv)) {
190 /* we don't really care about the length,
191 but that's the API */
192 key = HePV(he, keylen);
193 package = HvNAME(stash);
194 fq = newSVpvf("%s::%s", package, key);
195 sv = (SV *)get_cv(SvPV_nolen(fq), 0);
196 break;
197 }
198
199 key = HePV(he, keylen);
200 gv_init((GV *)gv, stash, key, keylen, GV_ADDMULTI);
201 }
202 /* fall through */
203 case SVt_PVGV:
204 switch (filter) {
205 case TYPE_FILTER_CODE: sv = (SV *)GvCVu(gv); break;
206 case TYPE_FILTER_ARRAY: sv = (SV *)GvAV(gv); break;
207 case TYPE_FILTER_IO: sv = (SV *)GvIO(gv); break;
208 case TYPE_FILTER_HASH: sv = (SV *)GvHV(gv); break;
209 case TYPE_FILTER_SCALAR: sv = (SV *)GvSV(gv); break;
210 default:
211 croak("Unknown type");
212 }
213 break;
214 default:
215 continue;
216 }
217
218 if (sv) {
219 char *key = HePV(he, keylen);
7291ecef 220 if (!hv_store(ret, key, keylen, newRV_inc(sv), 0)) {
221 croak("failed to store symbol ref");
222 }
b49ee39f 223 }
224 }
225
226 return ret;
227}
c94afdc4 228
0e0b5b8d 229
230static void
00c93f7a 231mop_update_method_map(pTHX_ SV *const self, SV *const class_name, HV *const stash, HV *const map) {
232 const char *const class_name_pv = HvNAME(stash); /* must be HvNAME(stash), not SvPV_nolen_const(class_name) */
233 SV *method_metaclass_name;
234 char *method_name;
0e0b5b8d 235 I32 method_name_len;
00c93f7a 236 SV *coderef;
237 HV *symbols;
0e0b5b8d 238 dSP;
239
240 symbols = get_all_package_symbols(stash, TYPE_FILTER_CODE);
241
242 (void)hv_iterinit(symbols);
243 while ( (coderef = hv_iternextsv(symbols, &method_name, &method_name_len)) ) {
00c93f7a 244 CV *cv = (CV *)SvRV(coderef);
245 char *cvpkg_name;
246 char *cv_name;
247 SV *method_slot;
248 SV *method_object;
0e0b5b8d 249
250 if (!get_code_info(coderef, &cvpkg_name, &cv_name)) {
251 continue;
252 }
253
254 /* this checks to see that the subroutine is actually from our package */
255 if ( !(strEQ(cvpkg_name, "constant") && strEQ(cv_name, "__ANON__")) ) {
256 if ( strNE(cvpkg_name, class_name_pv) ) {
257 continue;
258 }
259 }
260
261 method_slot = *hv_fetch(map, method_name, method_name_len, TRUE);
262 if ( SvOK(method_slot) ) {
6d915932 263 SV *const body = call0(method_slot, key_body); /* $method_object->body() */
00c93f7a 264 if ( SvROK(body) && ((CV *) SvRV(body)) == cv ) {
0e0b5b8d 265 continue;
266 }
267 }
268
269 method_metaclass_name = call0(self, method_metaclass); /* $self->method_metaclass() */
270
271 /*
272 $method_object = $method_metaclass->wrap(
273 $cv,
274 associated_metaclass => $self,
275 package_name => $class_name,
276 name => $method_name
277 );
278 */
279 ENTER;
280 SAVETMPS;
281
282 PUSHMARK(SP);
283 EXTEND(SP, 8);
284 PUSHs(method_metaclass_name); /* invocant */
00c93f7a 285 mPUSHs(newRV_inc((SV *)cv));
0e0b5b8d 286 PUSHs(associated_metaclass);
287 PUSHs(self);
288 PUSHs(key_package_name);
289 PUSHs(class_name);
290 PUSHs(key_name);
291 mPUSHs(newSVpv(method_name, method_name_len));
292 PUTBACK;
293
294 call_sv(wrap, G_SCALAR | G_METHOD);
295 SPAGAIN;
296 method_object = POPs;
297 PUTBACK;
298 /* $map->{$method_name} = $method_object */
299 sv_setsv(method_slot, method_object);
300
301 FREETMPS;
302 LEAVE;
303 }
304}
305
e0e4674a 306/*
e0e4674a 307get_code_info:
308 Pass in a coderef, returns:
309 [ $pkg_name, $coderef_name ] ie:
310 [ 'Foo::Bar', 'new' ]
311*/
312
313MODULE = Class::MOP PACKAGE = Class::MOP
314
cc856b56 315BOOT:
1654881c 316 PREHASH_KEY(name);
317 PREHASH_KEY(body);
318 PREHASH_KEY(package);
319 PREHASH_KEY(package_name);
320 PREHASH_KEY(methods);
321 PREHASH_KEY(ISA);
45a46f7b 322 PREHASH_KEY(VERSION);
1654881c 323 PREHASH_KEY_WITH_VALUE(package_cache_flag, "_package_cache_flag");
cc856b56 324
c94afdc4 325 method_metaclass = newSVpvs("method_metaclass");
326 wrap = newSVpvs("wrap");
327 associated_metaclass = newSVpvs("associated_metaclass");
328
cc856b56 329
36756faf 330PROTOTYPES: DISABLE
cc856b56 331
36756faf 332# use prototype here to be compatible with get_code_info from Sub::Identify
e0e4674a 333void
334get_code_info(coderef)
00c93f7a 335 SV *coderef
36756faf 336 PROTOTYPE: $
0e0b5b8d 337 PREINIT:
6d915932 338 char *pkg = NULL;
339 char *name = NULL;
0e0b5b8d 340 PPCODE:
341 if (get_code_info(coderef, &pkg, &name)) {
342 EXTEND(SP, 2);
343 PUSHs(newSVpv(pkg, 0));
344 PUSHs(newSVpv(name, 0));
345 }
e0e4674a 346
9cb15af7 347# This is some pretty grotty logic. It _should_ be parallel to the
348# pure Perl version in lib/Class/MOP.pm, so if you want to understand
349# it we suggest you start there.
863178c8 350void
351is_class_loaded(klass=&PL_sv_undef)
352 SV *klass
353 PREINIT:
354 HV *stash;
355 char *key;
356 I32 keylen;
5f715d98 357 SV *gv;
863178c8 358 PPCODE:
359 if (!SvPOK(klass) || !SvCUR(klass)) {
360 XSRETURN_NO;
361 }
362
363 stash = gv_stashsv(klass, 0);
364 if (!stash) {
365 XSRETURN_NO;
366 }
367
d508fabd 368 if (hv_exists_ent (stash, key_VERSION, hash_VERSION)) {
369 HE *version = hv_fetch_ent(stash, key_VERSION, 0, hash_VERSION);
b7e6420b 370 SV *version_sv;
371 if (version && HeVAL(version) && (version_sv = GvSV(HeVAL(version)))) {
372 if (SvROK(version_sv)) {
373 SV *version_sv_ref = SvRV(version_sv);
374
375 if (SvOK(version_sv_ref)) {
376 XSRETURN_YES;
377 }
378 }
379 else if (SvOK(version_sv)) {
380 XSRETURN_YES;
381 }
863178c8 382 }
383 }
384
d508fabd 385 if (hv_exists_ent (stash, key_ISA, hash_ISA)) {
386 HE *isa = hv_fetch_ent(stash, key_ISA, 0, hash_ISA);
387 if (isa && HeVAL(isa) && GvAV(HeVAL(isa))) {
863178c8 388 XSRETURN_YES;
389 }
390 }
391
392 (void)hv_iterinit(stash);
5f715d98 393 while ((gv = hv_iternextsv(stash, &key, &keylen))) {
863178c8 394 if (keylen <= 0) {
395 continue;
396 }
397
398 if (key[keylen - 1] == ':' && key[keylen - 2] == ':') {
399 continue;
400 }
401
5f715d98 402 if (!isGV(gv) || GvCV(gv)) {
863178c8 403 XSRETURN_YES;
404 }
405 }
406
407 XSRETURN_NO;
15273f3c 408
409MODULE = Class::MOP PACKAGE = Class::MOP::Package
410
411void
b49ee39f 412get_all_package_symbols(self, filter=TYPE_FILTER_NONE)
cc856b56 413 SV *self
b49ee39f 414 type_filter_t filter
15273f3c 415 PREINIT:
cc856b56 416 HV *stash = NULL;
b49ee39f 417 HV *symbols = NULL;
75705e60 418 register HE *he;
15273f3c 419 PPCODE:
a7f711e5 420 if ( ! SvROK(self) ) {
988fb42e 421 die("Cannot call get_all_package_symbols as a class method");
422 }
15273f3c 423
b49ee39f 424 if (GIMME_V == G_VOID) {
425 XSRETURN_EMPTY;
426 }
427
15273f3c 428 PUTBACK;
429
b49ee39f 430 if ( (he = hv_fetch_ent((HV *)SvRV(self), key_package, 0, hash_package)) ) {
431 stash = gv_stashsv(HeVAL(he), 0);
432 }
15273f3c 433
15273f3c 434
b49ee39f 435 if (!stash) {
a4bb3172 436 XSRETURN_UNDEF;
b49ee39f 437 }
15273f3c 438
b49ee39f 439 symbols = get_all_package_symbols(stash, filter);
a4bb3172 440 PUSHs(sv_2mortal(newRV_noinc((SV *)symbols)));
b49ee39f 441
e2c189ae 442void
cc856b56 443name(self)
444 SV *self
445 PREINIT:
446 register HE *he;
447 PPCODE:
a7f711e5 448 if ( ! SvROK(self) ) {
988fb42e 449 die("Cannot call name as a class method");
450 }
451
e7b69038 452 if ( (he = hv_fetch_ent((HV *)SvRV(self), key_package, 0, hash_package)) )
cc856b56 453 XPUSHs(HeVAL(he));
454 else
455 ST(0) = &PL_sv_undef;
456
dcbfe027 457MODULE = Class::MOP PACKAGE = Class::MOP::Attribute
cc856b56 458
e2c189ae 459void
cc856b56 460name(self)
461 SV *self
462 PREINIT:
463 register HE *he;
464 PPCODE:
a7f711e5 465 if ( ! SvROK(self) ) {
988fb42e 466 die("Cannot call name as a class method");
467 }
468
e7b69038 469 if ( (he = hv_fetch_ent((HV *)SvRV(self), key_name, 0, hash_name)) )
cc856b56 470 XPUSHs(HeVAL(he));
471 else
472 ST(0) = &PL_sv_undef;
473
dcbfe027 474MODULE = Class::MOP PACKAGE = Class::MOP::Method
cc856b56 475
e2c189ae 476void
da88f307 477name(self)
478 SV *self
479 PREINIT:
480 register HE *he;
481 PPCODE:
a7f711e5 482 if ( ! SvROK(self) ) {
da88f307 483 die("Cannot call name as a class method");
484 }
485
e7b69038 486 if ( (he = hv_fetch_ent((HV *)SvRV(self), key_name, 0, hash_name)) )
da88f307 487 XPUSHs(HeVAL(he));
488 else
489 ST(0) = &PL_sv_undef;
490
e2c189ae 491void
da88f307 492package_name(self)
493 SV *self
494 PREINIT:
495 register HE *he;
496 PPCODE:
a7f711e5 497 if ( ! SvROK(self) ) {
da88f307 498 die("Cannot call package_name as a class method");
499 }
500
e7b69038 501 if ( (he = hv_fetch_ent((HV *)SvRV(self), key_package_name, 0, hash_package_name)) )
da88f307 502 XPUSHs(HeVAL(he));
503 else
504 ST(0) = &PL_sv_undef;
505
e2c189ae 506void
cc856b56 507body(self)
508 SV *self
509 PREINIT:
510 register HE *he;
511 PPCODE:
a7f711e5 512 if ( ! SvROK(self) ) {
da88f307 513 die("Cannot call body as a class method");
514 }
515
e7b69038 516 if ( (he = hv_fetch_ent((HV *)SvRV(self), key_body, 0, hash_body)) )
cc856b56 517 XPUSHs(HeVAL(he));
518 else
519 ST(0) = &PL_sv_undef;
c94afdc4 520
521
522MODULE = Class::MOP PACKAGE = Class::MOP::Class
523
524void
525get_method_map(self)
00c93f7a 526 SV *self
c200a770 527 PREINIT:
c686d0ed 528 HV *const obj = (HV *)SvRV(self);
529 SV *const class_name = HeVAL( hv_fetch_ent(obj, key_package, 0, hash_package) );
530 HV *const stash = gv_stashsv(class_name, 0);
c200a770 531 UV const current = check_package_cache_flag(stash);
c686d0ed 532 SV *const cache_flag = HeVAL( hv_fetch_ent(obj, key_package_cache_flag, TRUE, hash_package_cache_flag));
533 SV *const map_ref = HeVAL( hv_fetch_ent(obj, key_methods, TRUE, hash_methods));
c200a770 534 PPCODE:
c200a770 535 /* in $self->{methods} does not yet exist (or got deleted) */
c686d0ed 536 if ( !SvROK(map_ref) || SvTYPE(SvRV(map_ref)) != SVt_PVHV ) {
00c93f7a 537 SV *new_map_ref = newRV_noinc((SV *)newHV());
c200a770 538 sv_2mortal(new_map_ref);
539 sv_setsv(map_ref, new_map_ref);
540 }
c94afdc4 541
c686d0ed 542 if ( !SvOK(cache_flag) || SvUV(cache_flag) != current ) {
00c93f7a 543 mop_update_method_map(aTHX_ self, class_name, stash, (HV *)SvRV(map_ref));
c200a770 544 sv_setuv(cache_flag, check_package_cache_flag(stash)); /* update_cache_flag() */
c200a770 545 }
546
547 XPUSHs(map_ref);