3 * - Mouse::Util::TypeConstraints (including OptimizedConstraionts)
4 * - Mouse::Meta::TypeConstraint
10 #define SvRXOK(sv) (SvROK(sv) && SvMAGICAL(SvRV(sv)) && mg_find(SvRV(sv), PERL_MAGIC_qr))
13 typedef int (*check_fptr_t)(pTHX_ SV* const data, SV* const sv);
16 NOTE: mouse_tc_check() handles GETMAGIC
19 mouse_tc_check(pTHX_ SV* const tc_code, SV* const sv) {
20 CV* const cv = (CV*)SvRV(tc_code);
21 assert(SvTYPE(cv) == SVt_PVCV);
23 if(CvXSUB(cv) == XS_Mouse_constraint_check){ /* built-in type constraints */
24 MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
26 assert(CvXSUBANY(cv).any_ptr != NULL);
27 assert(mg->mg_ptr != NULL);
30 /* call the check function directly, skipping call_sv() */
31 return CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv);
44 call_sv(tc_code, G_SCALAR);
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".
63 mouse_tc_Any(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv PERL_UNUSED_DECL) {
69 mouse_tc_Bool(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
74 return SvIVX(sv) == 1;
77 return SvNVX(sv) == 1.0;
79 else if(SvPOKp(sv)){ /* "1" */
80 return SvCUR(sv) == 1 && SvPVX(sv)[0] == '1';
87 /* any false value must be boolean */
93 mouse_tc_Undef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
99 mouse_tc_Defined(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
105 mouse_tc_Value(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
107 return SvOK(sv) && !SvROK(sv);
111 mouse_tc_Num(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
113 return LooksLikeNumber(sv);
117 S_nv_is_integer(pTHX_ NV const nv) {
118 if(nv == (NV)(IV)nv){
122 char buf[64]; /* Must fit sprintf/Gconvert of longest NV */
124 (void)Gconvert(nv, NV_DIG, 0, buf);
141 mouse_tc_Int(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
146 else if(SvNOKp(sv)) {
147 return S_nv_is_integer(aTHX_ SvNVX(sv));
150 int const num_type = grok_number(SvPVX(sv), SvCUR(sv), NULL);
152 return !(num_type & IS_NUMBER_NOT_INT);
159 mouse_tc_Str(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
161 return SvOK(sv) && !SvROK(sv) && !isGV(sv);
165 mouse_tc_ClassName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv){
167 return is_class_loaded(sv);
171 mouse_tc_RoleName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
173 if(is_class_loaded(sv)){
179 ok = is_an_instance_of("Mouse::Meta::Role", get_metaclass(sv));
190 mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
196 mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* sv) {
200 return !SvOBJECT(sv) && (SvTYPE(sv) <= SVt_PVLV && !isGV(sv));
206 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
208 return IsArrayRef(sv);
212 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
214 return IsHashRef(sv);
218 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
220 return IsCodeRef(sv);
224 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
230 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
232 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
236 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
240 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
242 gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
243 if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
244 IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
246 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
251 return is_an_instance_of("IO::Handle", sv);
255 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
257 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
260 /* Parameterized type constraints */
263 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
265 AV* const av = (AV*)SvRV(sv);
266 I32 const len = av_len(av) + 1;
268 for(i = 0; i < len; i++){
269 SV* const value = *av_fetch(av, i, TRUE);
270 if(!mouse_tc_check(aTHX_ param, value)){
280 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
281 if(mouse_tc_HashRef(aTHX_ NULL, sv)){
282 HV* const hv = (HV*)SvRV(sv);
286 while((he = hv_iternext(hv))){
287 SV* const value = hv_iterval(hv, he);
288 if(!mouse_tc_check(aTHX_ param, value)){
289 hv_iterinit(hv); /* reset */
299 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
301 return mouse_tc_check(aTHX_ param, sv);
307 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
308 I32 const len = AvFILLp(types) + 1;
311 for(i = 0; i < len; i++){
312 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
321 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
322 I32 const len = AvFILLp(types) + 1;
329 for(i = 0; i < len; i++){
330 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
342 * This class_type generator is taken from Scalar::Util::Instance
345 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
346 typedef struct sui_cxt{
352 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
353 #define MG_klass_pv(mg) ((mg)->mg_ptr)
354 #define MG_klass_len(mg) ((mg)->mg_len)
357 mouse_canonicalize_package_name(const char* name){
359 /* "::Foo" -> "Foo" */
360 if(name[0] == ':' && name[1] == ':'){
364 /* "main::main::main::Foo" -> "Foo" */
365 while(strnEQ(name, "main::", sizeof("main::")-1)){
366 name += sizeof("main::")-1;
373 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
374 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
375 SV** svp = AvARRAY(linearized_isa);
376 SV** const end = svp + AvFILLp(linearized_isa) + 1;
380 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
388 #define find_method_pvn(a, b, c) mouse_stash_find_method(aTHX_ a, b, c)
389 #define find_method_pvs(a, b) mouse_stash_find_method(aTHX_ a, STR_WITH_LEN(b))
392 mouse_stash_find_method(pTHX_ HV* const stash, const char* const name, I32 const namelen){
393 GV** const gvp = (GV**)hv_fetch(stash, name, namelen, FALSE);
394 if(gvp && isGV(*gvp) && GvCV(*gvp)){ /* shortcut */
398 return gv_fetchmeth_autoload(stash, name, namelen, 0);
402 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
404 assert(SvTYPE(stash) == SVt_PVHV);
406 if(IsObject(instance)){
408 HV* const instance_stash = SvSTASH(SvRV(instance));
409 GV* const myisa = find_method_pvs(instance_stash, "isa");
411 /* the instance has no own isa method */
412 if(myisa == NULL || GvCV(myisa) == GvCV(MY_CXT.universal_isa)){
413 return stash == instance_stash
414 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
416 /* the instance has its own isa method */
424 package = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
425 ok = sv_true(mcall1s(instance, "isa", sv_2mortal(package)));
437 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
438 PERL_UNUSED_ARG(data);
439 return SvROK(sv) && SvOBJECT(SvRV(sv));
443 mouse_can_methods(pTHX_ AV* const methods, SV* const instance){
444 if(IsObject(instance)){
446 HV* const mystash = SvSTASH(SvRV(instance));
447 GV* const mycan = find_method_pvs(mystash, "can");
448 bool const use_builtin = (mycan == NULL || GvCV(mycan) == GvCV(MY_CXT.universal_can)) ? TRUE : FALSE;
449 I32 const len = AvFILLp(methods) + 1;
451 for(i = 0; i < len; i++){
452 SV* const name = MOUSE_av_at(methods, i);
455 if(!find_method_pvn(mystash, SvPVX(name), SvCUR(name))){
465 ok = sv_true(mcall1s(instance, "can", sv_mortalcopy(name)));
480 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
483 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
486 xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
487 CvXSUBANY(xsub).any_ptr = sv_magicext(
489 param, /* mg_obj: refcnt will be increased */
491 &mouse_util_type_constraints_vtbl,
492 (char*)fptr, /* mg_ptr */
493 0 /* mg_len: 0 for static data */
497 sv_2mortal((SV*)xsub);
504 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
506 const char* klass_pv = SvPV_const(klass, klass_len);
510 klass_pv = mouse_canonicalize_package_name(klass_pv);
512 if(strNE(klass_pv, "UNIVERSAL")){
513 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
514 fptr = (check_fptr_t)mouse_is_an_instance_of;
519 fptr = (check_fptr_t)mouse_is_an_instance_of_universal;
522 return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
526 mouse_generate_can_predicate_for(pTHX_ SV* const methods, const char* const predicate_name){
528 AV* const param = newAV_mortal();
532 must_ref(methods, "an ARRAY ref for method names", SVt_PVAV);
533 av = (AV*)SvRV(methods);
535 len = av_len(av) + 1;
536 for(i = 0; i < len; i++){
537 SV* const name = *av_fetch(av, i, TRUE);
539 const char* const pv = SvPV_const(name, pvlen);
541 av_push(param, newSVpvn_share(pv, pvlen, 0U));
544 return mouse_tc_generate(aTHX_ predicate_name, (check_fptr_t)mouse_can_methods, (SV*)param);
548 XS(XS_Mouse_constraint_check) {
551 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
555 croak("Too few arguments for type constraint check functions");
560 ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv) );
564 XS(XS_Mouse_TypeConstraint_fallback); /* -Wmissing-prototypes */
565 XS(XS_Mouse_TypeConstraint_fallback) {
568 PERL_UNUSED_VAR(items);
573 setup_my_cxt(pTHX_ pMY_CXT){
574 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
575 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
577 MY_CXT.universal_can = gv_fetchpvs("UNIVERSAL::can", GV_ADD, SVt_PVCV);
578 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_can);
581 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
583 #define MTC_CLASS "Mouse::Meta::TypeConstraint"
585 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
588 VERSIONCHECK: DISABLE
593 setup_my_cxt(aTHX_ aMY_CXT);
595 /* setup built-in type constraints */
605 DEFINE_TC(ScalarRef);
610 DEFINE_TC(FileHandle);
611 DEFINE_TC(RegexpRef);
613 DEFINE_TC(ClassName);
624 setup_my_cxt(aTHX_ aMY_CXT);
625 PERL_UNUSED_VAR(items);
628 #endif /* !USE_ITHREADS */
630 #define MOUSE_TC_MAYBE 0
631 #define MOUSE_TC_ARRAY_REF 1
632 #define MOUSE_TC_HASH_REF 2
635 _parameterize_ArrayRef_for(SV* param)
637 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
638 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
639 _parameterize_Maybe_for = MOUSE_TC_MAYBE
643 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
644 if(!IsCodeRef(tc_code)){
645 croak("_compiled_type_constraint didn't return a CODE reference");
649 case MOUSE_TC_ARRAY_REF:
650 fptr = mouse_parameterized_ArrayRef;
652 case MOUSE_TC_HASH_REF:
653 fptr = mouse_parameterized_HashRef;
655 default: /* Maybe type */
656 fptr = mouse_parameterized_Maybe;
658 RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
663 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
666 INSTALL_SIMPLE_READER(TypeConstraint, name);
667 INSTALL_SIMPLE_READER(TypeConstraint, parent);
668 INSTALL_SIMPLE_READER(TypeConstraint, message);
670 INSTALL_SIMPLE_READER(TypeConstraint, type_parameter);
672 INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
673 INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
675 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
676 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, __is_parameterized, type_parameter); /* Mouse specific */
679 PL_amagic_generation++;
680 (void)newXS( MTC_CLASS "::()",
681 XS_Mouse_TypeConstraint_fallback, file);
685 get_sv( MTC_CLASS "::()", GV_ADD ),
689 /* '""' => '_as_string' */
691 SV* const code_ref = sv_2mortal(newRV_inc(
692 (SV*)get_cv( MTC_CLASS "::_as_string", GV_ADD )));
694 (SV*)gv_fetchpvs( MTC_CLASS "::(\"\"", GV_ADDMULTI, SVt_PVCV ),
698 /* '0+' => '_identity' */
700 SV* const code_ref = sv_2mortal(newRV_inc(
701 (SV*)get_cv( MTC_CLASS "::_identity", GV_ADD )));
703 (SV*)gv_fetchpvs( MTC_CLASS "::(0+", GV_ADDMULTI, SVt_PVCV ),
707 /* '|' => '_unite' */
709 SV* const code_ref = sv_2mortal(newRV_inc(
710 (SV*)get_cv( MTC_CLASS "::_unite", GV_ADD )));
712 (SV*)gv_fetchpvs( MTC_CLASS "::(|", GV_ADDMULTI, SVt_PVCV ),
718 compile_type_constraint(SV* self)
721 AV* const checks = newAV_mortal();
722 SV* check; /* check function */
726 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
727 check = get_slots(parent, "hand_optimized_type_constraint");
728 if(check && SvOK(check)){
729 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
730 croak("Not a CODE reference");
732 av_unshift(checks, 1);
733 av_store(checks, 0, newSVsv(check));
734 break; /* a hand optimized constraint must include all the parent */
737 check = get_slots(parent, "constraint");
738 if(check && SvOK(check)){
739 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
740 croak("Not a CODE reference");
742 av_unshift(checks, 1);
743 av_store(checks, 0, newSVsv(check));
747 check = get_slots(self, "constraint");
748 if(check && SvOK(check)){
749 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
750 croak("Not a CODE reference");
752 av_push(checks, newSVsv(check));
755 types_ref = get_slots(self, "type_constraints");
756 if(types_ref && SvOK(types_ref)){ /* union type */
763 if(!IsArrayRef(types_ref)){
764 croak("Not an ARRAY reference");
766 types = (AV*)SvRV(types_ref);
767 len = av_len(types) + 1;
769 union_checks = newAV_mortal();
771 for(i = 0; i < len; i++){
772 SV* const tc = *av_fetch(types, i, TRUE);
773 SV* const c = get_slots(tc, "compiled_type_constraint");
774 if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
775 mouse_throw_error(self, c, "'%"SVf"' has no compiled type constraint", self);
777 av_push(union_checks, newSVsv(c));
780 union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
781 av_push(checks, newRV_inc((SV*)union_check));
784 if(AvFILLp(checks) < 0){
785 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
788 check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
790 (void)set_slots(self, "compiled_type_constraint", check);
794 check(SV* self, SV* sv)
797 SV* const check = get_slots(self, "compiled_type_constraint");
798 if(!(check && mouse_tc_CodeRef(aTHX_ NULL, check))){
799 mouse_throw_error(self, check, "'%"SVf"' has no compiled type constraint", self);
801 RETVAL = mouse_tc_check(aTHX_ check, sv) ? TRUE : FALSE;