xs-src/MouseTypeConstraints.xs

   1 /*
   2  *   full definition of built-in type constraints (ware in Moose::Util::TypeConstraints::OptimizedConstraints)
   3  */
   4
   5 #include "mouse.h"
   6
   7 #if PERL_BCDVERSION >= 0x5008005
   8 #define LooksLikeNumber(sv) looks_like_number(sv)
   9 #else
  10 #define LooksLikeNumber(sv) ( SvPOKp(sv) ? looks_like_number(sv) : SvNIOKp(sv) )
  11 #endif
  12
  13 #ifndef SvRXOK
  14 #define SvRXOK(sv) (SvROK(sv) && SvMAGICAL(SvRV(sv)) && mg_find(SvRV(sv), PERL_MAGIC_qr))
  15 #endif
  16
  17 typedef int (*check_fptr_t)(pTHX_ SV* const data, SV* const sv);
  18
  19 int
  20 mouse_tc_check(pTHX_ SV* const tc_code, SV* const sv) {
  21     CV* const cv = (CV*)SvRV(tc_code);
  22     assert(SvTYPE(cv) == SVt_PVCV);
  23
  24     if(CvXSUB(cv) == XS_Mouse_constraint_check){ /* built-in type constraints */
  25         MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
  26
  27         assert(CvXSUBANY(cv).any_ptr != NULL);
  28         assert(mg->mg_ptr            != NULL);
  29
  30         /* call the check function directly, skipping call_sv() */
  31         return CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv);
  32     }
  33     else { /* custom */
  34         int ok;
  35         dSP;
  36
  37         ENTER;
  38         SAVETMPS;
  39
  40         PUSHMARK(SP);
  41         XPUSHs(sv);
  42         PUTBACK;
  43
  44         call_sv(tc_code, G_SCALAR);
  45
  46         SPAGAIN;
  47         ok = SvTRUEx(POPs);
  48         PUTBACK;
  49
  50         FREETMPS;
  51         LEAVE;
  52
  53         return ok;
  54     }
  55 }
  56
  57 /*
  58     The following type check functions return an integer, not a bool, to keep them simple,
  59     so if you assign these return value to bool variable, you must use "expr ? TRUE : FALSE".
  60 */
  61
  62 int
  63 mouse_tc_Any(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv PERL_UNUSED_DECL) {
  64     assert(sv);
  65     return TRUE;
  66 }
  67
  68 int
  69 mouse_tc_Bool(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
  70     assert(sv);
  71
  72     if(SvTRUE(sv)){
  73         if(SvIOKp(sv)){
  74             return SvIVX(sv) == 1;
  75         }
  76         else if(SvNOKp(sv)){
  77             return SvNVX(sv) == 1.0;
  78         }
  79         else if(SvPOKp(sv)){ /* "1" */
  80             return SvCUR(sv) == 1 && SvPVX(sv)[0] == '1';
  81         }
  82         else{
  83             return FALSE;
  84         }
  85     }
  86     else{
  87         /* false must be boolean */
  88         return TRUE;
  89     }
  90 }
  91
  92 int
  93 mouse_tc_Undef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
  94     assert(sv);
  95     return !SvOK(sv);
  96 }
  97
  98 int
  99 mouse_tc_Defined(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 100     assert(sv);
 101     return SvOK(sv);
 102 }
 103
 104 int
 105 mouse_tc_Value(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 106     assert(sv);
 107     return SvOK(sv) && !SvROK(sv);
 108 }
 109
 110 int
 111 mouse_tc_Num(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 112     assert(sv);
 113     return LooksLikeNumber(sv);
 114 }
 115
 116 int
 117 mouse_tc_Int(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 118     assert(sv);
 119     if(SvIOKp(sv)){
 120         return TRUE;
 121     }
 122     else if(SvNOKp(sv)){
 123         NV const nv = SvNVX(sv);
 124         return nv > 0 ? (nv == (NV)(UV)nv) : (nv == (NV)(IV)nv);
 125     }
 126     else if(SvPOKp(sv)){
 127         int const num_type = grok_number(SvPVX(sv), SvCUR(sv), NULL);
 128         if(num_type){
 129             return !(num_type & IS_NUMBER_NOT_INT);
 130         }
 131     }
 132     return FALSE;
 133 }
 134
 135 int
 136 mouse_tc_Str(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 137     assert(sv);
 138     return SvOK(sv) && !SvROK(sv) && !isGV(sv);
 139 }
 140
 141 int
 142 mouse_tc_ClassName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv){
 143     assert(sv);
 144     return is_class_loaded(sv);
 145 }
 146
 147 int
 148 mouse_tc_RoleName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 149     assert(sv);
 150     if(is_class_loaded(sv)){
 151         int ok;
 152
 153         ENTER;
 154         SAVETMPS;
 155
 156         ok =  is_an_instance_of("Mouse::Meta::Role", get_metaclass(sv));
 157
 158         FREETMPS;
 159         LEAVE;
 160
 161         return ok;
 162     }
 163     return FALSE;
 164 }
 165
 166 int
 167 mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 168     assert(sv);
 169     return SvROK(sv);
 170 }
 171
 172 int
 173 mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 174     assert(sv);
 175     return SvROK(sv) && !SvOBJECT(SvRV(sv)) && (SvTYPE(SvRV(sv)) <= SVt_PVLV && !isGV(SvRV(sv)));
 176 }
 177
 178 int
 179 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 180     assert(sv);
 181     return IsArrayRef(sv);
 182 }
 183
 184 int
 185 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 186     assert(sv);
 187     return IsHashRef(sv);
 188 }
 189
 190 int
 191 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 192     assert(sv);
 193     return IsCodeRef(sv);
 194 }
 195
 196 int
 197 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 198     assert(sv);
 199     return SvRXOK(sv);
 200 }
 201
 202 int
 203 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 204     assert(sv);
 205     return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
 206 }
 207
 208 int
 209 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 210     GV* gv;
 211     assert(sv);
 212
 213     /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
 214
 215     gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
 216     if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
 217         IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
 218
 219         if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
 220             return TRUE;
 221         }
 222     }
 223
 224     return is_an_instance_of("IO::Handle", sv);
 225 }
 226
 227 int
 228 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
 229     assert(sv);
 230     return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
 231 }
 232
 233 /* Parameterized type constraints */
 234
 235 static int
 236 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
 237     if(IsArrayRef(sv)){
 238         AV* const av  = (AV*)SvRV(sv);
 239         I32 const len = av_len(av) + 1;
 240         I32 i;
 241         for(i = 0; i < len; i++){
 242             SV* const value = *av_fetch(av, i, TRUE);
 243             SvGETMAGIC(value);
 244             if(!mouse_tc_check(aTHX_ param, value)){
 245                 return FALSE;
 246             }
 247         }
 248         return TRUE;
 249     }
 250     return FALSE;
 251 }
 252
 253 static int
 254 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
 255     if(mouse_tc_HashRef(aTHX_ NULL, sv)){
 256         HV* const hv  = (HV*)SvRV(sv);
 257         HE* he;
 258
 259         hv_iterinit(hv);
 260         while((he = hv_iternext(hv))){
 261             SV* const value = hv_iterval(hv, he);
 262             SvGETMAGIC(value);
 263             if(!mouse_tc_check(aTHX_ param, value)){
 264                 return FALSE;
 265             }
 266         }
 267         return TRUE;
 268     }
 269     return FALSE;
 270 }
 271
 272 static int
 273 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
 274     if(SvOK(sv)){
 275         return mouse_tc_check(aTHX_ param, sv);
 276     }
 277     return TRUE;
 278 }
 279
 280 static int
 281 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
 282     I32 const len = AvFILLp(types) + 1;
 283     I32 i;
 284
 285     for(i = 0; i < len; i++){
 286         if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
 287             return TRUE;
 288         }
 289     }
 290
 291     return FALSE;
 292 }
 293
 294 static int
 295 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
 296     I32 const len = AvFILLp(types) + 1;
 297     I32 i;
 298
 299     ENTER;
 300     SAVE_DEFSV;
 301     DEFSV_set(sv);
 302
 303     for(i = 0; i < len; i++){
 304         if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
 305             LEAVE;
 306             return FALSE;
 307         }
 308     }
 309
 310     LEAVE;
 311
 312     return TRUE;
 313 }
 314
 315 /*
 316  *  This class_type generator is taken from Scalar::Util::Instance
 317  */
 318
 319 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
 320 typedef struct sui_cxt{
 321     GV* universal_isa;
 322 } my_cxt_t;
 323 START_MY_CXT
 324
 325 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
 326 #define MG_klass_pv(mg)    ((mg)->mg_ptr)
 327 #define MG_klass_len(mg)   ((mg)->mg_len)
 328
 329 static const char*
 330 mouse_canonicalize_package_name(const char* name){
 331
 332     /* "::Foo" -> "Foo" */
 333     if(name[0] == ':' && name[1] == ':'){
 334         name += 2;
 335     }
 336
 337     /* "main::main::main::Foo" -> "Foo" */
 338     while(strnEQ(name, "main::", sizeof("main::")-1)){
 339         name += sizeof("main::")-1;
 340     }
 341
 342     return name;
 343 }
 344
 345 static int
 346 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
 347     AV*  const linearized_isa = mro_get_linear_isa(instance_stash);
 348     SV**       svp            = AvARRAY(linearized_isa);
 349     SV** const end            = svp + AvFILLp(linearized_isa) + 1;
 350
 351     while(svp != end){
 352         assert(SvPVX(*svp));
 353         if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
 354             return TRUE;
 355         }
 356         svp++;
 357     }
 358     return FALSE;
 359 }
 360
 361 int
 362 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
 363     assert(stash);
 364     assert(SvTYPE(stash) == SVt_PVHV);
 365
 366     if(IsObject(instance)){
 367         dMY_CXT;
 368         HV* const instance_stash = SvSTASH(SvRV(instance));
 369         GV* const instance_isa   = gv_fetchmeth_autoload(instance_stash, "isa", sizeof("isa")-1, 0);
 370
 371         /* the instance has no own isa method */
 372         if(instance_isa == NULL || GvCV(instance_isa) == GvCV(MY_CXT.universal_isa)){
 373             return stash == instance_stash
 374                 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
 375         }
 376         /* the instance has its own isa method */
 377         else {
 378             int retval;
 379             dSP;
 380
 381             ENTER;
 382             SAVETMPS;
 383
 384             PUSHMARK(SP);
 385             EXTEND(SP, 2);
 386             PUSHs(instance);
 387             mPUSHp(HvNAME_get(stash), HvNAMELEN_get(stash));
 388             PUTBACK;
 389
 390             call_sv((SV*)instance_isa, G_SCALAR);
 391
 392             SPAGAIN;
 393
 394             retval = SvTRUEx(POPs);
 395
 396             PUTBACK;
 397
 398             FREETMPS;
 399             LEAVE;
 400
 401             return retval;
 402         }
 403     }
 404     return FALSE;
 405 }
 406
 407 static int
 408 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
 409     PERL_UNUSED_ARG(data);
 410     return SvROK(sv) && SvOBJECT(SvRV(sv));
 411 }
 412
 413 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
 414
 415 static CV*
 416 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
 417     CV* xsub;
 418
 419     xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
 420     CvXSUBANY(xsub).any_ptr = sv_magicext(
 421         (SV*)xsub,
 422         param,       /* mg_obj: refcnt will be increased */
 423         PERL_MAGIC_ext,
 424         &mouse_util_type_constraints_vtbl,
 425         (void*)fptr, /* mg_ptr */
 426         0            /* mg_len: 0 for static data */
 427     );
 428
 429     if(!name){
 430         sv_2mortal((SV*)xsub);
 431     }
 432
 433     return xsub;
 434 }
 435
 436 CV*
 437 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
 438     STRLEN klass_len;
 439     const char* klass_pv = SvPV_const(klass, klass_len);
 440     SV*   param;
 441     void* fptr;
 442
 443     klass_pv = mouse_canonicalize_package_name(klass_pv);
 444
 445     if(strNE(klass_pv, "UNIVERSAL")){
 446         param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
 447         fptr = (void*)mouse_is_an_instance_of;
 448
 449     }
 450     else{
 451         param = NULL;
 452         fptr = (void*)mouse_is_an_instance_of_universal;
 453     }
 454
 455     return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
 456 }
 457
 458 XS(XS_Mouse_constraint_check) {
 459     dVAR;
 460     dXSARGS;
 461     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
 462
 463     if(items < 1){
 464         croak("Too few arguments for type constraint check functions");
 465     }
 466
 467     SvGETMAGIC( ST(0) );
 468     ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, ST(0)) );
 469     XSRETURN(1);
 470 }
 471
 472 static void
 473 setup_my_cxt(pTHX_ pMY_CXT){
 474     MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
 475     SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
 476 }
 477
 478 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
 479
 480 MODULE = Mouse::Util::TypeConstraints    PACKAGE = Mouse::Util::TypeConstraints
 481
 482 PROTOTYPES:   DISABLE
 483 VERSIONCHECK: DISABLE
 484
 485 BOOT:
 486 {
 487     MY_CXT_INIT;
 488     setup_my_cxt(aTHX_ aMY_CXT);
 489
 490     /* setup built-in type constraints */
 491     DEFINE_TC(Any);
 492     DEFINE_TC(Undef);
 493     DEFINE_TC(Defined);
 494     DEFINE_TC(Bool);
 495     DEFINE_TC(Value);
 496     DEFINE_TC(Ref);
 497     DEFINE_TC(Str);
 498     DEFINE_TC(Num);
 499     DEFINE_TC(Int);
 500     DEFINE_TC(ScalarRef);
 501     DEFINE_TC(ArrayRef);
 502     DEFINE_TC(HashRef);
 503     DEFINE_TC(CodeRef);
 504     DEFINE_TC(GlobRef);
 505     DEFINE_TC(FileHandle);
 506     DEFINE_TC(RegexpRef);
 507     DEFINE_TC(Object);
 508     DEFINE_TC(ClassName);
 509     DEFINE_TC(RoleName);
 510 }
 511
 512 #ifdef USE_ITHREADS
 513
 514 void
 515 CLONE(...)
 516 CODE:
 517 {
 518     MY_CXT_CLONE;
 519     setup_my_cxt(aTHX_ aMY_CXT);
 520     PERL_UNUSED_VAR(items);
 521 }
 522
 523 #endif /* !USE_ITHREADS */
 524
 525 #define MOUSE_TC_MAYBE     0
 526 #define MOUSE_TC_ARRAY_REF 1
 527 #define MOUSE_TC_HASH_REF  2
 528
 529 CV*
 530 _parameterize_ArrayRef_for(SV* param)
 531 ALIAS:
 532     _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
 533     _parameterize_HashRef_for  = MOUSE_TC_HASH_REF
 534     _parameterize_Maybe_for    = MOUSE_TC_MAYBE
 535 CODE:
 536 {
 537     check_fptr_t fptr;
 538     SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
 539     if(!IsCodeRef(tc_code)){
 540         croak("_compiled_type_constraint didn't return a CODE reference");
 541     }
 542
 543     switch(ix){
 544     case MOUSE_TC_ARRAY_REF:
 545         fptr = mouse_parameterized_ArrayRef;
 546         break;
 547     case MOUSE_TC_HASH_REF:
 548         fptr = mouse_parameterized_HashRef;
 549         break;
 550     default: /* Maybe type */
 551         fptr = mouse_parameterized_Maybe;
 552     }
 553     RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
 554 }
 555 OUTPUT:
 556     RETVAL
 557
 558 MODULE = Mouse::Util::TypeConstraints    PACKAGE = Mouse::Meta::TypeConstraint
 559
 560 BOOT:
 561     INSTALL_SIMPLE_READER(TypeConstraint, name);
 562     INSTALL_SIMPLE_READER(TypeConstraint, parent);
 563     INSTALL_SIMPLE_READER(TypeConstraint, message);
 564
 565     INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
 566     INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
 567
 568     INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
 569
 570 void
 571 compile_type_constraint(SV* self)
 572 CODE:
 573 {
 574     AV* const checks = newAV_mortal();
 575     SV* check; /* check function */
 576     SV* parent;
 577     SV* types_ref;
 578
 579     for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
 580         check = get_slots(parent, "hand_optimized_type_constraint");
 581         if(check && SvOK(check)){
 582             if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
 583                 croak("Not a CODE reference");
 584             }
 585             av_unshift(checks, 1);
 586             av_store(checks, 0, newSVsv(check));
 587             break; /* a hand optimized constraint must include all the parent */
 588         }
 589
 590         check = get_slots(parent, "constraint");
 591         if(check && SvOK(check)){
 592             if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
 593                 croak("Not a CODE reference");
 594             }
 595             av_unshift(checks, 1);
 596             av_store(checks, 0, newSVsv(check));
 597         }
 598     }
 599
 600     check = get_slots(self, "constraint");
 601     if(check && SvOK(check)){
 602         if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
 603             croak("Not a CODE reference");
 604         }
 605         av_push(checks, newSVsv(check));
 606     }
 607
 608     types_ref = get_slots(self, "type_constraints");
 609     if(types_ref && SvOK(types_ref)){ /* union type */
 610         AV* types;
 611         AV* union_checks;
 612         CV* union_check;
 613         I32 len;
 614         I32 i;
 615
 616         if(!IsArrayRef(types_ref)){
 617             croak("Not an ARRAY reference");
 618         }
 619         types = (AV*)SvRV(types_ref);
 620         len = av_len(types) + 1;
 621
 622         union_checks = newAV_mortal();
 623
 624         for(i = 0; i < len; i++){
 625             SV* const tc = *av_fetch(types, i, TRUE);
 626             SV* const c  = get_slots(tc, "compiled_type_constraint");
 627             if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
 628                 sv_dump(self);
 629                 croak("'%"SVf"' has no compiled type constraint", self);
 630             }
 631             av_push(union_checks, newSVsv(c));
 632         }
 633
 634         union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
 635         av_push(checks, newRV_inc((SV*)union_check));
 636     }
 637
 638     if(AvFILLp(checks) < 0){
 639         check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
 640     }
 641     else{
 642         check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
 643     }
 644     set_slots(self, "compiled_type_constraint", check);
 645 }
 646