xs-src/MouseUtil.xs

   1 #include "mouse.h"
   2
   3 #define MY_CXT_KEY "Mouse::Util::_guts" XS_VERSION
   4 typedef struct {
   5     HV* metas;
   6 } my_cxt_t;
   7 START_MY_CXT
   8
   9 #define ISA_CACHE "::LINEALIZED_ISA_CACHE::"
  10
  11 #ifdef no_mro_get_linear_isa
  12 AV*
  13 mouse_mro_get_linear_isa(pTHX_ HV* const stash){
  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{
  30         SvREFCNT_dec(isa);
  31         GvAV(cachegv) = isa = newAV();
  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
  53         if(IsArrayRef(avref)){
  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));
  74     return isa;
  75 }
  76 #endif /* !no_mor_get_linear_isa */
  77
  78 #ifdef DEBUGGING
  79 SV**
  80 mouse_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
  88 void
  89 mouse_throw_error(SV* const metaobject, SV* const data /* not used */, const char* const fmt, ...){
  90     dTHX;
  91     va_list args;
  92     SV* message;
  93
  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);
 104         EXTEND(SP, 6);
 105
 106         PUSHs(metaobject);
 107         mPUSHs(message);
 108
 109         if(data){ /* extra arg, might be useful for debugging */
 110             mPUSHs(newSVpvs("data"));
 111             PUSHs(data);
 112             mPUSHs(newSVpvs("depth"));
 113             mPUSHi(-1);
 114         }
 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
 123 /* workaround RT #69939 */
 124 I32
 125 mouse_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
 145 void
 146 mouse_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
 156 void
 157 mouse_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
 169 bool
 170 mouse_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)){
 201             if(GvCVu(gv)){ /* is GV and has CV */
 202                 hv_iterinit(stash); /* reset */
 203                 return TRUE;
 204             }
 205         }
 206         else if(SvOK(gv)){ /* is a stub or constant */
 207             hv_iterinit(stash); /* reset */
 208             return TRUE;
 209         }
 210     }
 211     return FALSE;
 212 }
 213
 214
 215 SV*
 216 mouse_call0 (pTHX_ SV* const self, SV* const method) {
 217     dSP;
 218     SV *ret;
 219
 220     PUSHMARK(SP);
 221     XPUSHs(self);
 222     PUTBACK;
 223
 224     call_sv_safe(method, G_SCALAR | G_METHOD);
 225
 226     SPAGAIN;
 227     ret = POPs;
 228     PUTBACK;
 229
 230     return ret;
 231 }
 232
 233 SV*
 234 mouse_call1 (pTHX_ SV* const self, SV* const method, SV* const arg1) {
 235     dSP;
 236     SV *ret;
 237
 238     PUSHMARK(SP);
 239     EXTEND(SP, 2);
 240     PUSHs(self);
 241     PUSHs(arg1);
 242     PUTBACK;
 243
 244     call_sv_safe(method, G_SCALAR | G_METHOD);
 245
 246     SPAGAIN;
 247     ret = POPs;
 248     PUTBACK;
 249
 250     return ret;
 251 }
 252
 253 int
 254 mouse_predicate_call(pTHX_ SV* const self, SV* const method) {
 255     return sv_true( mcall0(self, method) );
 256 }
 257
 258 SV*
 259 mouse_get_metaclass(pTHX_ SV* metaclass_name){
 260     dMY_CXT;
 261     HE* he;
 262
 263     assert(metaclass_name);
 264     assert(MY_CXT.metas);
 265
 266     if(IsObject(metaclass_name)){
 267         HV* const stash = SvSTASH(SvRV(metaclass_name));
 268
 269         metaclass_name = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
 270         sv_2mortal(metaclass_name);
 271     }
 272
 273     he = hv_fetch_ent(MY_CXT.metas, metaclass_name, FALSE, 0U);
 274
 275     return he ? HeVAL(he) : &PL_sv_undef;
 276 }
 277
 278 MAGIC*
 279 mouse_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
 295 GV*
 296 mouse_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
 310 void
 311 mouse_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     }
 323
 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
 354 MODULE = Mouse::Util  PACKAGE = Mouse::Util
 355
 356 PROTOTYPES:   DISABLE
 357 VERSIONCHECK: DISABLE
 358
 359 BOOT:
 360 {
 361     MY_CXT_INIT;
 362     MY_CXT.metas = NULL;
 363 }
 364
 365 void
 366 __register_metaclass_storage(HV* metas, bool cloning)
 367 CODE:
 368 {
 369     if(cloning){
 370         MY_CXT_CLONE;
 371         MY_CXT.metas = NULL;
 372     }
 373     {
 374         dMY_CXT;
 375         if(MY_CXT.metas && ckWARN(WARN_REDEFINE)){
 376             Perl_warner(aTHX_ packWARN(WARN_REDEFINE), "Metaclass storage more than once");
 377         }
 378         MY_CXT.metas = metas;
 379         SvREFCNT_inc_simple_void_NN(metas);
 380     }
 381 }
 382
 383 bool
 384 is_valid_class_name(SV* sv)
 385 CODE:
 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 }
 403 OUTPUT:
 404     RETVAL
 405
 406 bool
 407 is_class_loaded(SV* sv)
 408
 409 void
 410 get_code_info(CV* code)
 411 PREINIT:
 412     GV* gv;
 413     HV* stash;
 414 PPCODE:
 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
 421 SV*
 422 get_code_package(CV* code)
 423 PREINIT:
 424     HV* stash;
 425 CODE:
 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     }
 432 OUTPUT:
 433     RETVAL
 434
 435 CV*
 436 get_code_ref(SV* package, SV* name)
 437 CODE:
 438 {
 439     HV* stash;
 440     STRLEN name_len;
 441     const char* name_pv;
 442     GV* gv;
 443
 444     must_defined(package, "a package name");
 445     must_defined(name,    "a subroutine name");
 446
 447     stash = gv_stashsv(package, FALSE);
 448     if(!stash){
 449         XSRETURN_UNDEF;
 450     }
 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;
 455
 456     if(!RETVAL){
 457         XSRETURN_UNDEF;
 458     }
 459 }
 460 OUTPUT:
 461     RETVAL
 462
 463 void
 464 generate_isa_predicate_for(SV* arg, SV* predicate_name = NULL)
 465 ALIAS:
 466     generate_isa_predicate_for = 0
 467     generate_can_predicate_for = 1
 468 PPCODE:
 469 {
 470     const char* name_pv = NULL;
 471     CV* xsub;
 472
 473     must_defined(arg, ix == 0 ? "a class_name" : "method names");
 474
 475     if(predicate_name){
 476         must_defined(predicate_name, "a predicate name");
 477         name_pv = SvPV_nolen_const(predicate_name);
 478     }
 479
 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     }
 486
 487     if(predicate_name == NULL){ /* anonymous predicate */
 488         mXPUSHs( newRV_inc((SV*)xsub) );
 489     }
 490 }
 491
 492 # This xsub will redefine &Mouse::Util::install_subroutines()
 493 void
 494 install_subroutines(SV* into, ...)
 495 CODE:
 496 {
 497     HV* stash;
 498     I32 i;
 499
 500     must_defined(into, "a package name");
 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
 514         must_defined(name, "a subroutine name");
 515         must_ref(code, "a CODE reference", SVt_PVCV);
 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 }