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