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     const PERL_CONTEXT* const cx = &cxstack[cxstack_ix];
 127     assert( (flags & G_EVAL) == 0 );
 128     //warn("%d 0x%x 0x%x", (int)cx->cx_type, (int)cx->cx_type, (int)PL_in_eval);
 129     if(!(cx->cx_type & (CXt_EVAL|CXp_TRYBLOCK))) {
 130         I32 count;
 131         //SAVESPTR(ERRSV);
 132         //ERRSV = sv_newmortal();
 133
 134         count = Perl_call_sv(aTHX_ sv, flags | G_EVAL);
 135
 136         if(sv_true(ERRSV)){
 137             croak(NULL); /* rethrow */
 138         }
 139         return count;
 140     }
 141     else {
 142         return Perl_call_sv(aTHX_ sv, flags);
 143     }
 144 }
 145
 146 void
 147 mouse_must_defined(pTHX_ SV* const value, const char* const name) {
 148     assert(value);
 149     assert(name);
 150
 151     SvGETMAGIC(value);
 152     if(!SvOK(value)){
 153         croak("You must define %s", name);
 154     }
 155 }
 156
 157 void
 158 mouse_must_ref(pTHX_ SV* const value, const char* const name, svtype const t) {
 159     assert(value);
 160     assert(name);
 161
 162     SvGETMAGIC(value);
 163     if(!(SvROK(value) && (t == SVt_NULL || SvTYPE(SvRV(value)) == t))) {
 164         croak("You must pass %s, not %s",
 165             name, SvOK(value) ? SvPV_nolen(value) : "undef");
 166     }
 167 }
 168
 169
 170 bool
 171 mouse_is_class_loaded(pTHX_ SV * const klass){
 172     HV *stash;
 173     GV** gvp;
 174     HE* he;
 175
 176     if (!(SvPOKp(klass) && SvCUR(klass))) { /* XXX: SvPOK does not work with magical scalars */
 177         return FALSE;
 178     }
 179
 180     stash = gv_stashsv(klass, FALSE);
 181     if (!stash) {
 182         return FALSE;
 183     }
 184
 185     if (( gvp = (GV**)hv_fetchs(stash, "VERSION", FALSE) )) {
 186         if(isGV(*gvp) && GvSV(*gvp) && SvOK(GvSV(*gvp))){
 187             return TRUE;
 188         }
 189     }
 190
 191     if (( gvp = (GV**)hv_fetchs(stash, "ISA", FALSE) )) {
 192         if(isGV(*gvp) && GvAV(*gvp) && av_len(GvAV(*gvp)) != -1){
 193             return TRUE;
 194         }
 195     }
 196
 197     hv_iterinit(stash);
 198     while(( he = hv_iternext(stash) )){
 199         GV* const gv = (GV*)HeVAL(he);
 200
 201         if(isGV(gv)){
 202             if(GvCVu(gv)){ /* is GV and has CV */
 203                 hv_iterinit(stash); /* reset */
 204                 return TRUE;
 205             }
 206         }
 207         else if(SvOK(gv)){ /* is a stub or constant */
 208             hv_iterinit(stash); /* reset */
 209             return TRUE;
 210         }
 211     }
 212     return FALSE;
 213 }
 214
 215
 216 SV*
 217 mouse_call0 (pTHX_ SV* const self, SV* const method) {
 218     dSP;
 219     SV *ret;
 220
 221     PUSHMARK(SP);
 222     XPUSHs(self);
 223     PUTBACK;
 224
 225     call_sv_safe(method, G_SCALAR | G_METHOD);
 226
 227     SPAGAIN;
 228     ret = POPs;
 229     PUTBACK;
 230
 231     return ret;
 232 }
 233
 234 SV*
 235 mouse_call1 (pTHX_ SV* const self, SV* const method, SV* const arg1) {
 236     dSP;
 237     SV *ret;
 238
 239     PUSHMARK(SP);
 240     EXTEND(SP, 2);
 241     PUSHs(self);
 242     PUSHs(arg1);
 243     PUTBACK;
 244
 245     call_sv_safe(method, G_SCALAR | G_METHOD);
 246
 247     SPAGAIN;
 248     ret = POPs;
 249     PUTBACK;
 250
 251     return ret;
 252 }
 253
 254 int
 255 mouse_predicate_call(pTHX_ SV* const self, SV* const method) {
 256     return sv_true( mcall0(self, method) );
 257 }
 258
 259 SV*
 260 mouse_get_metaclass(pTHX_ SV* metaclass_name){
 261     dMY_CXT;
 262     HE* he;
 263
 264     assert(metaclass_name);
 265     assert(MY_CXT.metas);
 266
 267     if(IsObject(metaclass_name)){
 268         HV* const stash = SvSTASH(SvRV(metaclass_name));
 269
 270         metaclass_name = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
 271         sv_2mortal(metaclass_name);
 272     }
 273
 274     he = hv_fetch_ent(MY_CXT.metas, metaclass_name, FALSE, 0U);
 275
 276     return he ? HeVAL(he) : &PL_sv_undef;
 277 }
 278
 279 MAGIC*
 280 mouse_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags){
 281     MAGIC* mg;
 282
 283     assert(sv != NULL);
 284     for(mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic){
 285         if(mg->mg_virtual == vtbl){
 286             return mg;
 287         }
 288     }
 289
 290     if(flags & MOUSEf_DIE_ON_FAIL){
 291         croak("mouse_mg_find: no MAGIC found for %"SVf, sv_2mortal(newRV_inc(sv)));
 292     }
 293     return NULL;
 294 }
 295
 296 GV*
 297 mouse_stash_fetch(pTHX_ HV* const stash, const char* const name, I32 const namelen, I32 const create) {
 298     GV** const gvp = (GV**)hv_fetch(stash, name, namelen, create);
 299
 300     if(gvp){
 301         if(!isGV(*gvp)){
 302             gv_init(*gvp, stash, name, namelen, GV_ADDMULTI);
 303         }
 304         return *gvp;
 305     }
 306     else{
 307         return NULL;
 308     }
 309 }
 310
 311 void
 312 mouse_install_sub(pTHX_ GV* const gv, SV* const code_ref) {
 313     CV* cv;
 314
 315     assert(gv != NULL);
 316     assert(code_ref != NULL);
 317     assert(isGV(gv));
 318     assert(IsCodeRef(code_ref));
 319
 320     if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
 321         SvREFCNT_dec(GvCV(gv));
 322         GvCV(gv) = NULL;
 323     }
 324
 325     sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
 326
 327     /* name the CODE ref if it's anonymous */
 328     cv = (CV*)SvRV(code_ref);
 329     if(CvANON(cv)
 330         && CvGV(cv) /* a cv under construction has no gv */ ){
 331         HV* dbsub;
 332
 333         /* update %DB::sub to make NYTProf happy */
 334         if((PL_perldb & (PERLDBf_SUBLINE|PERLDB_NAMEANON))
 335             && PL_DBsub && (dbsub = GvHV(PL_DBsub))
 336         ){
 337             /* see Perl_newATTRSUB() in op.c */
 338             SV* const subname = sv_newmortal();
 339             HE* orig;
 340
 341             gv_efullname3(subname, CvGV(cv), NULL);
 342             orig = hv_fetch_ent(dbsub, subname, FALSE, 0U);
 343             if(orig){
 344                 gv_efullname3(subname, gv, NULL);
 345                 (void)hv_store_ent(dbsub, subname, HeVAL(orig), 0U);
 346                 SvREFCNT_inc_simple_void_NN(HeVAL(orig));
 347             }
 348         }
 349
 350         CvGV(cv) = gv;
 351         CvANON_off(cv);
 352     }
 353 }
 354
 355 MODULE = Mouse::Util  PACKAGE = Mouse::Util
 356
 357 PROTOTYPES:   DISABLE
 358 VERSIONCHECK: DISABLE
 359
 360 BOOT:
 361 {
 362     MY_CXT_INIT;
 363     MY_CXT.metas = NULL;
 364 }
 365
 366 void
 367 __register_metaclass_storage(HV* metas, bool cloning)
 368 CODE:
 369 {
 370     if(cloning){
 371         MY_CXT_CLONE;
 372         MY_CXT.metas = NULL;
 373     }
 374     {
 375         dMY_CXT;
 376         if(MY_CXT.metas && ckWARN(WARN_REDEFINE)){
 377             Perl_warner(aTHX_ packWARN(WARN_REDEFINE), "Metaclass storage more than once");
 378         }
 379         MY_CXT.metas = metas;
 380         SvREFCNT_inc_simple_void_NN(metas);
 381     }
 382 }
 383
 384 bool
 385 is_valid_class_name(SV* sv)
 386 CODE:
 387 {
 388     SvGETMAGIC(sv);
 389     if(SvPOKp(sv) && SvCUR(sv) > 0){
 390         UV i;
 391         RETVAL = TRUE;
 392         for(i = 0; i < SvCUR(sv); i++){
 393             char const c = SvPVX(sv)[i];
 394             if(!(isALNUM(c) || c == ':')){
 395                 RETVAL = FALSE;
 396                 break;
 397             }
 398         }
 399     }
 400     else{
 401         RETVAL = SvNIOKp(sv) ? TRUE : FALSE;
 402     }
 403 }
 404 OUTPUT:
 405     RETVAL
 406
 407 bool
 408 is_class_loaded(SV* sv)
 409
 410 void
 411 get_code_info(CV* code)
 412 PREINIT:
 413     GV* gv;
 414     HV* stash;
 415 PPCODE:
 416     if((gv = CvGV(code)) && isGV(gv) && (stash = GvSTASH(gv))){
 417         EXTEND(SP, 2);
 418         mPUSHs(newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U));
 419         mPUSHs(newSVpvn_share(GvNAME_get(gv), GvNAMELEN_get(gv), 0U));
 420     }
 421
 422 SV*
 423 get_code_package(CV* code)
 424 PREINIT:
 425     HV* stash;
 426 CODE:
 427     if(CvGV(code) && isGV(CvGV(code)) && (stash = GvSTASH(CvGV(code)))){
 428         RETVAL = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
 429     }
 430     else{
 431         RETVAL = &PL_sv_no;
 432     }
 433 OUTPUT:
 434     RETVAL
 435
 436 CV*
 437 get_code_ref(SV* package, SV* name)
 438 CODE:
 439 {
 440     HV* stash;
 441     STRLEN name_len;
 442     const char* name_pv;
 443     GV* gv;
 444
 445     must_defined(package, "a package name");
 446     must_defined(name,    "a subroutine name");
 447
 448     stash = gv_stashsv(package, FALSE);
 449     if(!stash){
 450         XSRETURN_UNDEF;
 451     }
 452
 453     name_pv = SvPV_const(name, name_len);
 454     gv = stash_fetch(stash, name_pv, name_len, FALSE);
 455     RETVAL = gv ? GvCVu(gv) : NULL;
 456
 457     if(!RETVAL){
 458         XSRETURN_UNDEF;
 459     }
 460 }
 461 OUTPUT:
 462     RETVAL
 463
 464 void
 465 generate_isa_predicate_for(SV* arg, SV* predicate_name = NULL)
 466 ALIAS:
 467     generate_isa_predicate_for = 0
 468     generate_can_predicate_for = 1
 469 PPCODE:
 470 {
 471     const char* name_pv = NULL;
 472     CV* xsub;
 473
 474     must_defined(arg, ix == 0 ? "a class_name" : "method names");
 475
 476     if(predicate_name){
 477         must_defined(predicate_name, "a predicate name");
 478         name_pv = SvPV_nolen_const(predicate_name);
 479     }
 480
 481     if(ix == 0){
 482         xsub = mouse_generate_isa_predicate_for(aTHX_ arg, name_pv);
 483     }
 484     else{
 485         xsub = mouse_generate_can_predicate_for(aTHX_ arg, name_pv);
 486     }
 487
 488     if(predicate_name == NULL){ /* anonymous predicate */
 489         mXPUSHs( newRV_inc((SV*)xsub) );
 490     }
 491 }
 492
 493 # This xsub will redefine &Mouse::Util::install_subroutines()
 494 void
 495 install_subroutines(SV* into, ...)
 496 CODE:
 497 {
 498     HV* stash;
 499     I32 i;
 500
 501     must_defined(into, "a package name");
 502     stash = gv_stashsv(into, TRUE);
 503
 504     if( ((items-1) % 2) != 0 ){
 505         croak_xs_usage(cv, "into, name => coderef [, other_name, other_coderef ...]");
 506     }
 507
 508     for(i = 1; i < items; i += 2) {
 509         SV* const name = ST(i);
 510         SV* const code = ST(i+1);
 511         STRLEN len;
 512         const char* pv;
 513         GV* gv;
 514
 515         must_defined(name, "a subroutine name");
 516         must_ref(code, "a CODE reference", SVt_PVCV);
 517
 518         pv = SvPV_const(name, len);
 519         gv = stash_fetch(stash, pv, len, TRUE);
 520
 521         mouse_install_sub(aTHX_ gv, code);
 522     }
 523 }