perltidy this test file
[gitmo/Class-MOP.git] / MOP.xs
1 /* There's a lot of cases of doubled parens in here like this:
2
3   while ( (he = ...) ) {
4
5 This shuts up warnings from gcc -Wall
6 */
7
8 #include "EXTERN.h"
9 #include "perl.h"
10 #include "XSUB.h"
11
12 #define NEED_newRV_noinc
13 #define NEED_sv_2pv_flags
14 #define NEED_sv_2pv_nolen
15 #include "ppport.h"
16
17 #define DECLARE_KEY(name) SV *key_##name; U32 hash_##name;
18
19 #define PREHASH_KEY_WITH_VALUE(name, value) do { \
20     key_##name = newSVpvs(value); \
21     PERL_HASH(hash_##name, value, sizeof(value) - 1); \
22 } while (0)
23
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)
34
35 DECLARE_KEY(name);
36 DECLARE_KEY(package);
37 DECLARE_KEY(package_name);
38 DECLARE_KEY(body);
39 DECLARE_KEY(package_cache_flag);
40 DECLARE_KEY(methods);
41 DECLARE_KEY(VERSION);
42 DECLARE_KEY(ISA);
43
44 SV *method_metaclass;
45 SV *associated_metaclass;
46 SV *wrap;
47
48
49 #define check_package_cache_flag(stash) mop_check_package_cache_flag(aTHX_ stash)
50 #if PERL_VERSION >= 10
51
52 static UV
53 mop_check_package_cache_flag(pTHX_ HV* stash) {
54     assert(SvTYPE(stash) == SVt_PVHV);
55
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;
83 }
84
85 #else /* pre 5.10.0 */
86
87 static UV
88 mop_check_package_cache_flag(pTHX_ HV *stash) {
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)
97 static SV *
98 mop_call0(pTHX_ SV *const self, SV *const method) {
99     dSP;
100     SV *ret;
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
115 static int
116 get_code_info (SV *coderef, char **pkg, char **name)
117 {
118     if (!SvOK(coderef) || !SvROK(coderef) || SvTYPE(SvRV(coderef)) != SVt_PVCV) {
119         return 0;
120     }
121
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)) ) {
129 #endif
130         *pkg     = HvNAME( GvSTASH(CvGV(coderef)) );
131         *name    = GvNAME( CvGV(coderef) );
132 #ifdef isGV_with_GP
133     } else {
134         *pkg     = "__UNKNOWN__";
135         *name    = "__ANON__";
136     }
137 #endif
138
139     return 1;
140 }
141
142 typedef 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
151 static HV *
152 get_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);
163             if (!hv_store(ret, key, keylen, SvREFCNT_inc(HeVAL(he)), 0)) {
164                 croak("failed to store glob ref");
165             }
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);
220             if (!hv_store(ret, key, keylen, newRV_inc(sv), 0)) {
221                 croak("failed to store symbol ref");
222             }
223         }
224     }
225
226     return ret;
227 }
228
229
230 static void
231 mop_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;
235     I32   method_name_len;
236     SV   *coderef;
237     HV   *symbols;
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)) ) {
244         CV *cv = (CV *)SvRV(coderef);
245         char *cvpkg_name;
246         char *cv_name;
247         SV *method_slot;
248         SV *method_object;
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) ) {
263             SV *const body = call0(method_slot, key_body); /* $method_object->body() */
264             if ( SvROK(body) && ((CV *) SvRV(body)) == cv ) {
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 */
285         mPUSHs(newRV_inc((SV *)cv));
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
306 /*
307 get_code_info:
308   Pass in a coderef, returns:
309   [ $pkg_name, $coderef_name ] ie:
310   [ 'Foo::Bar', 'new' ]
311 */
312
313 MODULE = Class::MOP   PACKAGE = Class::MOP
314
315 BOOT:
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);
322     PREHASH_KEY(VERSION);
323     PREHASH_KEY_WITH_VALUE(package_cache_flag, "_package_cache_flag");
324
325     method_metaclass     = newSVpvs("method_metaclass");
326     wrap                 = newSVpvs("wrap");
327     associated_metaclass = newSVpvs("associated_metaclass");
328
329
330 PROTOTYPES: DISABLE
331
332 # use prototype here to be compatible with get_code_info from Sub::Identify
333 void
334 get_code_info(coderef)
335     SV *coderef
336     PROTOTYPE: $
337     PREINIT:
338         char *pkg  = NULL;
339         char *name = NULL;
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         }
346
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.
350 void
351 is_class_loaded(klass=&PL_sv_undef)
352     SV *klass
353     PREINIT:
354         HV *stash;
355         char *key;
356         I32 keylen;
357         SV *gv;
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
368         if (hv_exists_ent (stash, key_VERSION, hash_VERSION)) {
369             HE *version = hv_fetch_ent(stash, key_VERSION, 0, hash_VERSION);
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                 }
382             }
383         }
384
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))) {
388                 XSRETURN_YES;
389             }
390         }
391
392         (void)hv_iterinit(stash);
393         while ((gv = hv_iternextsv(stash, &key, &keylen))) {
394             if (keylen <= 0) {
395                 continue;
396             }
397
398             if (key[keylen - 1] == ':' && key[keylen - 2] == ':') {
399                 continue;
400             }
401
402             if (!isGV(gv) || GvCV(gv)) {
403                 XSRETURN_YES;
404             }
405         }
406
407         XSRETURN_NO;
408
409 MODULE = Class::MOP   PACKAGE = Class::MOP::Package
410
411 void
412 get_all_package_symbols(self, filter=TYPE_FILTER_NONE)
413     SV *self
414     type_filter_t filter
415     PREINIT:
416         HV *stash = NULL;
417         HV *symbols = NULL;
418         register HE *he;
419     PPCODE:
420         if ( ! SvROK(self) ) {
421             die("Cannot call get_all_package_symbols as a class method");
422         }
423
424         if (GIMME_V == G_VOID) {
425             XSRETURN_EMPTY;
426         }
427
428         PUTBACK;
429
430         if ( (he = hv_fetch_ent((HV *)SvRV(self), key_package, 0, hash_package)) ) {
431             stash = gv_stashsv(HeVAL(he), 0);
432         }
433
434
435         if (!stash) {
436             XSRETURN_UNDEF;
437         }
438
439         symbols = get_all_package_symbols(stash, filter);
440         PUSHs(sv_2mortal(newRV_noinc((SV *)symbols)));
441
442 void
443 name(self)
444     SV *self
445     PREINIT:
446         register HE *he;
447     PPCODE:
448         if ( ! SvROK(self) ) {
449             die("Cannot call name as a class method");
450         }
451
452         if ( (he = hv_fetch_ent((HV *)SvRV(self), key_package, 0, hash_package)) )
453             XPUSHs(HeVAL(he));
454         else
455             ST(0) = &PL_sv_undef;
456
457 MODULE = Class::MOP   PACKAGE = Class::MOP::Attribute
458
459 void
460 name(self)
461     SV *self
462     PREINIT:
463         register HE *he;
464     PPCODE:
465         if ( ! SvROK(self) ) {
466             die("Cannot call name as a class method");
467         }
468
469         if ( (he = hv_fetch_ent((HV *)SvRV(self), key_name, 0, hash_name)) )
470             XPUSHs(HeVAL(he));
471         else
472             ST(0) = &PL_sv_undef;
473
474 MODULE = Class::MOP   PACKAGE = Class::MOP::Method
475
476 void
477 name(self)
478     SV *self
479     PREINIT:
480         register HE *he;
481     PPCODE:
482         if ( ! SvROK(self) ) {
483             die("Cannot call name as a class method");
484         }
485
486         if ( (he = hv_fetch_ent((HV *)SvRV(self), key_name, 0, hash_name)) )
487             XPUSHs(HeVAL(he));
488         else
489             ST(0) = &PL_sv_undef;
490
491 void
492 package_name(self)
493     SV *self
494     PREINIT:
495         register HE *he;
496     PPCODE:
497         if ( ! SvROK(self) ) {
498             die("Cannot call package_name as a class method");
499         }
500
501         if ( (he = hv_fetch_ent((HV *)SvRV(self), key_package_name, 0, hash_package_name)) )
502             XPUSHs(HeVAL(he));
503         else
504             ST(0) = &PL_sv_undef;
505
506 void
507 body(self)
508     SV *self
509     PREINIT:
510         register HE *he;
511     PPCODE:
512         if ( ! SvROK(self) ) {
513             die("Cannot call body as a class method");
514         }
515
516         if ( (he = hv_fetch_ent((HV *)SvRV(self), key_body, 0, hash_body)) )
517             XPUSHs(HeVAL(he));
518         else
519             ST(0) = &PL_sv_undef;
520
521
522 MODULE = Class::MOP    PACKAGE = Class::MOP::Class
523
524 void
525 get_method_map(self)
526     SV *self
527     PREINIT:
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);
531         UV  const current    = check_package_cache_flag(stash);
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));
534     PPCODE:
535         /* in  $self->{methods} does not yet exist (or got deleted) */
536         if ( !SvROK(map_ref) || SvTYPE(SvRV(map_ref)) != SVt_PVHV ) {
537             SV *new_map_ref = newRV_noinc((SV *)newHV());
538             sv_2mortal(new_map_ref);
539             sv_setsv(map_ref, new_map_ref);
540         }
541
542         if ( !SvOK(cache_flag) || SvUV(cache_flag) != current ) {
543             mop_update_method_map(aTHX_ self, class_name, stash, (HV *)SvRV(map_ref));
544             sv_setuv(cache_flag, check_package_cache_flag(stash)); /* update_cache_flag() */
545         }
546
547         XPUSHs(map_ref);