Workaround RT #69939
[gitmo/Mouse.git] / xs-src / MouseUtil.xs
CommitLineData
646c0371 1#include "mouse.h"
2
fd168725 3#define MY_CXT_KEY "Mouse::Util::_guts" XS_VERSION
4typedef struct {
5 HV* metas;
6} my_cxt_t;
7START_MY_CXT
8
646c0371 9#define ISA_CACHE "::LINEALIZED_ISA_CACHE::"
10
11#ifdef no_mro_get_linear_isa
12AV*
13mouse_mro_get_linear_isa(pTHX_ HV* const stash){
6582d0e3 14 GV* const cachegv = *(GV**)hv_fetchs(stash, ISA_CACHE, TRUE);
15 AV* isa;
16 SV* gen;
17 CV* get_linear_isa;
18
19 if(!isGV(cachegv))
20 gv_init(cachegv, stash, ISA_CACHE, sizeof(ISA_CACHE)-1, TRUE);
21
22 isa = GvAVn(cachegv);
23 gen = GvSVn(cachegv);
24
25
26 if(SvIOK(gen) && SvIVX(gen) == (IV)mro_get_pkg_gen(stash)){
27 return isa; /* returns the cache if available */
28 }
29 else{
cd658d1f 30 SvREFCNT_dec(isa);
31 GvAV(cachegv) = isa = newAV();
6582d0e3 32 }
33
34 get_linear_isa = get_cv("Mouse::Util::get_linear_isa", TRUE);
35
36 {
37 SV* avref;
38 dSP;
39
40 ENTER;
41 SAVETMPS;
42
43 PUSHMARK(SP);
44 mXPUSHp(HvNAME_get(stash), HvNAMELEN_get(stash));
45 PUTBACK;
46
47 call_sv((SV*)get_linear_isa, G_SCALAR);
48
49 SPAGAIN;
50 avref = POPs;
51 PUTBACK;
52
80aa5731 53 if(IsArrayRef(avref)){
6582d0e3 54 AV* const av = (AV*)SvRV(avref);
55 I32 const len = AvFILLp(av) + 1;
56 I32 i;
57
58 for(i = 0; i < len; i++){
59 HV* const stash = gv_stashsv(AvARRAY(av)[i], FALSE);
60 if(stash)
61 av_push(isa, newSVpv(HvNAME(stash), 0));
62 }
63 SvREADONLY_on(isa);
64 }
65 else{
66 Perl_croak(aTHX_ "Mouse:Util::get_linear_isa() didn't return an ARRAY reference");
67 }
68
69 FREETMPS;
70 LEAVE;
71 }
72
73 sv_setiv(gen, (IV)mro_get_pkg_gen(stash));
cd658d1f 74 return isa;
646c0371 75}
76#endif /* !no_mor_get_linear_isa */
77
78#ifdef DEBUGGING
79SV**
80mouse_av_at_safe(pTHX_ AV* const av, I32 const ix){
81 assert(av);
82 assert(SvTYPE(av) == SVt_PVAV);
83 assert(AvMAX(av) >= ix);
84 return &AvARRAY(av)[ix];
85}
86#endif
87
88void
89mouse_throw_error(SV* const metaobject, SV* const data /* not used */, const char* const fmt, ...){
90 dTHX;
91 va_list args;
92 SV* message;
93
646c0371 94 assert(metaobject);
95 assert(fmt);
96
97 va_start(args, fmt);
98 message = vnewSVpvf(fmt, &args);
99 va_end(args);
100
101 {
102 dSP;
103 PUSHMARK(SP);
077f2efd 104 EXTEND(SP, 6);
646c0371 105
106 PUSHs(metaobject);
107 mPUSHs(message);
108
431e4817 109 if(data){ /* extra arg, might be useful for debugging */
077f2efd 110 mPUSHs(newSVpvs("data"));
431e4817 111 PUSHs(data);
112 mPUSHs(newSVpvs("depth"));
113 mPUSHi(-1);
114 }
646c0371 115
116 PUTBACK;
117
118 call_method("throw_error", G_VOID);
119 croak("throw_error() did not throw the error (%"SVf")", message);
120 }
121}
122
b3cd4c14 123/* workaround RT #69939 */
124I32
125mouse_call_sv_safe(pTHX_ SV* const sv, I32 const flags) {
126 assert( (flags & G_EVAL) == 0 );
127
128 if(!PL_in_eval) {
129 I32 count;
130 SAVESPTR(ERRSV);
131 ERRSV = sv_newmortal();
132
133 count = Perl_call_sv(aTHX_ sv, flags | G_EVAL);
134
135 if(sv_true(ERRSV)){
136 croak(NULL); /* rethrow */
137 }
138 return count;
139 }
140 else {
141 return Perl_call_sv(aTHX_ sv, flags);
142 }
143}
144
d06d9266 145void
146mouse_must_defined(pTHX_ SV* const value, const char* const name) {
147 assert(value);
148 assert(name);
149
150 SvGETMAGIC(value);
151 if(!SvOK(value)){
152 croak("You must define %s", name);
153 }
154}
155
156void
157mouse_must_ref(pTHX_ SV* const value, const char* const name, svtype const t) {
158 assert(value);
159 assert(name);
160
161 SvGETMAGIC(value);
162 if(!(SvROK(value) && (t == SVt_NULL || SvTYPE(SvRV(value)) == t))) {
163 croak("You must pass %s, not %s",
164 name, SvOK(value) ? SvPV_nolen(value) : "undef");
165 }
166}
167
168
646c0371 169bool
170mouse_is_class_loaded(pTHX_ SV * const klass){
171 HV *stash;
172 GV** gvp;
173 HE* he;
174
175 if (!(SvPOKp(klass) && SvCUR(klass))) { /* XXX: SvPOK does not work with magical scalars */
176 return FALSE;
177 }
178
179 stash = gv_stashsv(klass, FALSE);
180 if (!stash) {
181 return FALSE;
182 }
183
184 if (( gvp = (GV**)hv_fetchs(stash, "VERSION", FALSE) )) {
185 if(isGV(*gvp) && GvSV(*gvp) && SvOK(GvSV(*gvp))){
186 return TRUE;
187 }
188 }
189
190 if (( gvp = (GV**)hv_fetchs(stash, "ISA", FALSE) )) {
191 if(isGV(*gvp) && GvAV(*gvp) && av_len(GvAV(*gvp)) != -1){
192 return TRUE;
193 }
194 }
195
196 hv_iterinit(stash);
197 while(( he = hv_iternext(stash) )){
198 GV* const gv = (GV*)HeVAL(he);
199
200 if(isGV(gv)){
fa4ac648 201 if(GvCVu(gv)){ /* is GV and has CV */
202 hv_iterinit(stash); /* reset */
646c0371 203 return TRUE;
204 }
205 }
fa4ac648 206 else if(SvOK(gv)){ /* is a stub or constant */
207 hv_iterinit(stash); /* reset */
646c0371 208 return TRUE;
209 }
210 }
211 return FALSE;
212}
213
214
0aad0266 215SV*
216mouse_call0 (pTHX_ SV* const self, SV* const method) {
646c0371 217 dSP;
218 SV *ret;
219
220 PUSHMARK(SP);
221 XPUSHs(self);
222 PUTBACK;
223
b3cd4c14 224 call_sv_safe(method, G_SCALAR | G_METHOD);
646c0371 225
226 SPAGAIN;
227 ret = POPs;
228 PUTBACK;
229
230 return ret;
231}
232
0aad0266 233SV*
234mouse_call1 (pTHX_ SV* const self, SV* const method, SV* const arg1) {
646c0371 235 dSP;
236 SV *ret;
237
238 PUSHMARK(SP);
239 EXTEND(SP, 2);
240 PUSHs(self);
241 PUSHs(arg1);
242 PUTBACK;
243
b3cd4c14 244 call_sv_safe(method, G_SCALAR | G_METHOD);
646c0371 245
246 SPAGAIN;
247 ret = POPs;
248 PUTBACK;
249
250 return ret;
251}
252
0aad0266 253int
254mouse_predicate_call(pTHX_ SV* const self, SV* const method) {
6ad77996 255 return sv_true( mcall0(self, method) );
0aad0266 256}
257
a39e9541 258SV*
aa2d2e2c 259mouse_get_metaclass(pTHX_ SV* metaclass_name){
fd168725 260 dMY_CXT;
261 HE* he;
a39e9541 262
aa2d2e2c 263 assert(metaclass_name);
fd168725 264 assert(MY_CXT.metas);
265
aa2d2e2c 266 if(IsObject(metaclass_name)){
a5c683f6 267 HV* const stash = SvSTASH(SvRV(metaclass_name));
aa2d2e2c 268
269 metaclass_name = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
270 sv_2mortal(metaclass_name);
271 }
272
fd168725 273 he = hv_fetch_ent(MY_CXT.metas, metaclass_name, FALSE, 0U);
a39e9541 274
fd168725 275 return he ? HeVAL(he) : &PL_sv_undef;
a39e9541 276}
277
646c0371 278MAGIC*
279mouse_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags){
280 MAGIC* mg;
281
282 assert(sv != NULL);
283 for(mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic){
284 if(mg->mg_virtual == vtbl){
285 return mg;
286 }
287 }
288
289 if(flags & MOUSEf_DIE_ON_FAIL){
290 croak("mouse_mg_find: no MAGIC found for %"SVf, sv_2mortal(newRV_inc(sv)));
291 }
292 return NULL;
293}
294
a39e9541 295GV*
296mouse_stash_fetch(pTHX_ HV* const stash, const char* const name, I32 const namelen, I32 const create) {
297 GV** const gvp = (GV**)hv_fetch(stash, name, namelen, create);
298
299 if(gvp){
300 if(!isGV(*gvp)){
301 gv_init(*gvp, stash, name, namelen, GV_ADDMULTI);
302 }
303 return *gvp;
304 }
305 else{
306 return NULL;
307 }
308}
309
d67f600d 310void
311mouse_install_sub(pTHX_ GV* const gv, SV* const code_ref) {
312 CV* cv;
313
314 assert(gv != NULL);
315 assert(code_ref != NULL);
316 assert(isGV(gv));
317 assert(IsCodeRef(code_ref));
318
319 if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
320 SvREFCNT_dec(GvCV(gv));
321 GvCV(gv) = NULL;
322 }
d06d9266 323
d67f600d 324 sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
325
326 /* name the CODE ref if it's anonymous */
327 cv = (CV*)SvRV(code_ref);
328 if(CvANON(cv)
329 && CvGV(cv) /* a cv under construction has no gv */ ){
330 HV* dbsub;
331
332 /* update %DB::sub to make NYTProf happy */
333 if((PL_perldb & (PERLDBf_SUBLINE|PERLDB_NAMEANON))
334 && PL_DBsub && (dbsub = GvHV(PL_DBsub))
335 ){
336 /* see Perl_newATTRSUB() in op.c */
337 SV* const subname = sv_newmortal();
338 HE* orig;
339
340 gv_efullname3(subname, CvGV(cv), NULL);
341 orig = hv_fetch_ent(dbsub, subname, FALSE, 0U);
342 if(orig){
343 gv_efullname3(subname, gv, NULL);
344 (void)hv_store_ent(dbsub, subname, HeVAL(orig), 0U);
345 SvREFCNT_inc_simple_void_NN(HeVAL(orig));
346 }
347 }
348
349 CvGV(cv) = gv;
350 CvANON_off(cv);
351 }
352}
353
646c0371 354MODULE = Mouse::Util PACKAGE = Mouse::Util
355
356PROTOTYPES: DISABLE
357VERSIONCHECK: DISABLE
358
fd168725 359BOOT:
360{
361 MY_CXT_INIT;
362 MY_CXT.metas = NULL;
363}
364
365void
366__register_metaclass_storage(HV* metas, bool cloning)
367CODE:
368{
369 if(cloning){
370 MY_CXT_CLONE;
371 MY_CXT.metas = NULL;
372 }
373 {
374 dMY_CXT;
25ba356e 375 if(MY_CXT.metas && ckWARN(WARN_REDEFINE)){
376 Perl_warner(aTHX_ packWARN(WARN_REDEFINE), "Metaclass storage more than once");
377 }
fd168725 378 MY_CXT.metas = metas;
379 SvREFCNT_inc_simple_void_NN(metas);
380 }
381}
382
646c0371 383bool
0ffc4183 384is_valid_class_name(SV* sv)
385CODE:
386{
387 SvGETMAGIC(sv);
388 if(SvPOKp(sv) && SvCUR(sv) > 0){
389 UV i;
390 RETVAL = TRUE;
391 for(i = 0; i < SvCUR(sv); i++){
392 char const c = SvPVX(sv)[i];
393 if(!(isALNUM(c) || c == ':')){
394 RETVAL = FALSE;
395 break;
396 }
397 }
398 }
399 else{
400 RETVAL = SvNIOKp(sv) ? TRUE : FALSE;
401 }
402}
403OUTPUT:
404 RETVAL
405
406bool
646c0371 407is_class_loaded(SV* sv)
408
409void
410get_code_info(CV* code)
411PREINIT:
412 GV* gv;
413 HV* stash;
414PPCODE:
415 if((gv = CvGV(code)) && isGV(gv) && (stash = GvSTASH(gv))){
416 EXTEND(SP, 2);
417 mPUSHs(newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U));
418 mPUSHs(newSVpvn_share(GvNAME_get(gv), GvNAMELEN_get(gv), 0U));
419 }
420
421SV*
422get_code_package(CV* code)
423PREINIT:
424 HV* stash;
425CODE:
426 if(CvGV(code) && isGV(CvGV(code)) && (stash = GvSTASH(CvGV(code)))){
427 RETVAL = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
428 }
429 else{
430 RETVAL = &PL_sv_no;
431 }
432OUTPUT:
433 RETVAL
434
435CV*
436get_code_ref(SV* package, SV* name)
437CODE:
438{
439 HV* stash;
a39e9541 440 STRLEN name_len;
441 const char* name_pv;
442 GV* gv;
646c0371 443
d06d9266 444 must_defined(package, "a package name");
445 must_defined(name, "a subroutine name");
646c0371 446
447 stash = gv_stashsv(package, FALSE);
448 if(!stash){
449 XSRETURN_UNDEF;
450 }
a39e9541 451
452 name_pv = SvPV_const(name, name_len);
453 gv = stash_fetch(stash, name_pv, name_len, FALSE);
454 RETVAL = gv ? GvCVu(gv) : NULL;
646c0371 455
456 if(!RETVAL){
457 XSRETURN_UNDEF;
458 }
459}
460OUTPUT:
461 RETVAL
462
463void
ebe91068 464generate_isa_predicate_for(SV* arg, SV* predicate_name = NULL)
465ALIAS:
466 generate_isa_predicate_for = 0
467 generate_can_predicate_for = 1
646c0371 468PPCODE:
469{
441964ce 470 const char* name_pv = NULL;
646c0371 471 CV* xsub;
472
d06d9266 473 must_defined(arg, ix == 0 ? "a class_name" : "method names");
646c0371 474
441964ce 475 if(predicate_name){
d06d9266 476 must_defined(predicate_name, "a predicate name");
441964ce 477 name_pv = SvPV_nolen_const(predicate_name);
646c0371 478 }
479
ebe91068 480 if(ix == 0){
481 xsub = mouse_generate_isa_predicate_for(aTHX_ arg, name_pv);
482 }
483 else{
484 xsub = mouse_generate_can_predicate_for(aTHX_ arg, name_pv);
485 }
441964ce 486
646c0371 487 if(predicate_name == NULL){ /* anonymous predicate */
73337709 488 mXPUSHs( newRV_inc((SV*)xsub) );
646c0371 489 }
490}
d67f600d 491
492# This xsub will redefine &Mouse::Util::install_subroutines()
493void
494install_subroutines(SV* into, ...)
495CODE:
496{
497 HV* stash;
498 I32 i;
499
d06d9266 500 must_defined(into, "a package name");
d67f600d 501 stash = gv_stashsv(into, TRUE);
502
503 if( ((items-1) % 2) != 0 ){
504 croak_xs_usage(cv, "into, name => coderef [, other_name, other_coderef ...]");
505 }
506
507 for(i = 1; i < items; i += 2) {
508 SV* const name = ST(i);
509 SV* const code = ST(i+1);
510 STRLEN len;
511 const char* pv;
512 GV* gv;
513
d06d9266 514 must_defined(name, "a subroutine name");
515 must_ref(code, "a CODE reference", SVt_PVCV);
d67f600d 516
517 pv = SvPV_const(name, len);
518 gv = stash_fetch(stash, pv, len, TRUE);
519
520 mouse_install_sub(aTHX_ gv, code);
521 }
522}