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 XSPROTO(XS_Mouse_constraint_check);
19 NOTE: mouse_tc_check() handles GETMAGIC
22 mouse_tc_check(pTHX_ SV* const tc_code, SV* const sv) {
23 CV* const cv = (CV*)SvRV(tc_code);
24 assert(SvTYPE(cv) == SVt_PVCV);
26 if(CvXSUB(cv) == XS_Mouse_constraint_check){ /* built-in type constraints */
27 MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
29 assert(CvXSUBANY(cv).any_ptr != NULL);
30 assert(mg->mg_ptr != NULL);
33 /* call the check function directly, skipping call_sv() */
34 return CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv);
47 call_sv(tc_code, G_SCALAR);
61 The following type check functions return an integer, not a bool, to keep
63 so if you assign these return value to a bool variable, you must use
64 "expr ? TRUE : FALSE".
68 mouse_tc_Any(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv PERL_UNUSED_DECL) {
74 mouse_tc_Bool(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
78 if(SvPOKp(sv)){ /* "1" */
79 return SvCUR(sv) == 1 && SvPVX(sv)[0] == '1';
82 return SvIVX(sv) == 1;
85 return SvNVX(sv) == 1.0;
92 /* any false value is a boolean */
98 mouse_tc_Undef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
104 mouse_tc_Defined(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
110 mouse_tc_Value(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
112 return SvOK(sv) && !SvROK(sv);
116 mouse_tc_Num(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
118 return LooksLikeNumber(sv);
122 S_nv_is_integer(pTHX_ NV const nv) {
123 if(nv == (NV)(IV)nv){
127 char buf[64]; /* Must fit sprintf/Gconvert of longest NV */
129 (void)Gconvert(nv, NV_DIG, 0, buf);
146 mouse_tc_Int(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
149 int const num_type = grok_number(SvPVX(sv), SvCUR(sv), NULL);
150 return num_type && !(num_type & IS_NUMBER_NOT_INT);
155 else if(SvNOKp(sv)) {
156 return S_nv_is_integer(aTHX_ SvNVX(sv));
162 mouse_tc_Str(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
164 return SvOK(sv) && !SvROK(sv) && !isGV(sv);
168 mouse_tc_ClassName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv){
170 return is_class_loaded(sv);
174 mouse_tc_RoleName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
176 if(is_class_loaded(sv)){
182 ok = is_an_instance_of("Mouse::Meta::Role", get_metaclass(sv));
193 mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
199 mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* sv) {
203 return !SvOBJECT(sv) && (SvTYPE(sv) <= SVt_PVLV && !isGV(sv));
209 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
211 return IsArrayRef(sv);
215 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
217 return IsHashRef(sv);
221 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
223 return IsCodeRef(sv);
227 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
233 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
235 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
239 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
243 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
245 gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
246 if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
247 IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
249 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
254 return is_an_instance_of("IO::Handle", sv);
258 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
260 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
263 /* Parameterized type constraints */
266 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
268 AV* const av = (AV*)SvRV(sv);
269 I32 const len = av_len(av) + 1;
271 for(i = 0; i < len; i++){
272 SV* const value = *av_fetch(av, i, TRUE);
273 if(!mouse_tc_check(aTHX_ param, value)){
283 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
285 HV* const hv = (HV*)SvRV(sv);
289 while((he = hv_iternext(hv))){
290 SV* const value = hv_iterval(hv, he);
291 if(!mouse_tc_check(aTHX_ param, value)){
292 hv_iterinit(hv); /* reset */
302 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
304 return mouse_tc_check(aTHX_ param, sv);
310 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
311 I32 const len = AvFILLp(types) + 1;
314 for(i = 0; i < len; i++){
315 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
324 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
325 I32 const len = AvFILLp(types) + 1;
332 for(i = 0; i < len; i++){
333 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
345 * This class_type generator is taken from Scalar::Util::Instance
348 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
349 typedef struct sui_cxt{
355 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
356 #define MG_klass_pv(mg) ((mg)->mg_ptr)
357 #define MG_klass_len(mg) ((mg)->mg_len)
360 mouse_canonicalize_package_name(const char* name){
362 /* "::Foo" -> "Foo" */
363 if(name[0] == ':' && name[1] == ':'){
367 /* "main::main::main::Foo" -> "Foo" */
368 while(strnEQ(name, "main::", sizeof("main::")-1)){
369 name += sizeof("main::")-1;
376 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
377 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
378 SV** svp = AvARRAY(linearized_isa);
379 SV** const end = svp + AvFILLp(linearized_isa) + 1;
383 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
391 #define find_method_pvn(a, b, c) mouse_stash_find_method(aTHX_ a, b, c)
392 #define find_method_pvs(a, b) mouse_stash_find_method(aTHX_ a, STR_WITH_LEN(b))
395 mouse_stash_find_method(pTHX_ HV* const stash, const char* const name, I32 const namelen){
396 GV** const gvp = (GV**)hv_fetch(stash, name, namelen, FALSE);
397 if(gvp && isGV(*gvp) && GvCV(*gvp)){ /* shortcut */
401 return gv_fetchmeth_autoload(stash, name, namelen, 0);
405 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
407 assert(SvTYPE(stash) == SVt_PVHV);
409 if(IsObject(instance)){
411 HV* const instance_stash = SvSTASH(SvRV(instance));
412 GV* const myisa = find_method_pvs(instance_stash, "isa");
414 /* the instance has no own isa method */
415 if(myisa == NULL || GvCV(myisa) == GvCV(MY_CXT.universal_isa)){
416 return stash == instance_stash
417 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
419 /* the instance has its own isa method */
427 package = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
428 ok = sv_true(mcall1s(instance, "isa", sv_2mortal(package)));
440 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
441 PERL_UNUSED_ARG(data);
442 return SvROK(sv) && SvOBJECT(SvRV(sv));
446 mouse_can_methods(pTHX_ AV* const methods, SV* const instance){
447 if(IsObject(instance)){
449 HV* const mystash = SvSTASH(SvRV(instance));
450 GV* const mycan = find_method_pvs(mystash, "can");
451 bool const use_builtin = (mycan == NULL || GvCV(mycan) == GvCV(MY_CXT.universal_can)) ? TRUE : FALSE;
452 I32 const len = AvFILLp(methods) + 1;
454 for(i = 0; i < len; i++){
455 SV* const name = MOUSE_av_at(methods, i);
458 if(!find_method_pvn(mystash, SvPVX(name), SvCUR(name))){
468 ok = sv_true(mcall1s(instance, "can", sv_mortalcopy(name)));
483 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
486 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
489 xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
490 CvXSUBANY(xsub).any_ptr = sv_magicext(
492 param, /* mg_obj: refcnt will be increased */
494 &mouse_util_type_constraints_vtbl,
495 (char*)fptr, /* mg_ptr */
496 0 /* mg_len: 0 for static data */
500 sv_2mortal((SV*)xsub);
507 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
509 const char* klass_pv = SvPV_const(klass, klass_len);
513 klass_pv = mouse_canonicalize_package_name(klass_pv);
515 if(strNE(klass_pv, "UNIVERSAL")){
516 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
517 fptr = (check_fptr_t)mouse_is_an_instance_of;
522 fptr = (check_fptr_t)mouse_is_an_instance_of_universal;
525 return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
529 mouse_generate_can_predicate_for(pTHX_ SV* const methods, const char* const predicate_name){
531 AV* const param = newAV_mortal();
535 must_ref(methods, "an ARRAY ref for method names", SVt_PVAV);
536 av = (AV*)SvRV(methods);
538 len = av_len(av) + 1;
539 for(i = 0; i < len; i++){
540 SV* const name = *av_fetch(av, i, TRUE);
542 const char* const pv = SvPV_const(name, pvlen);
544 av_push(param, newSVpvn_share(pv, pvlen, 0U));
547 return mouse_tc_generate(aTHX_ predicate_name, (check_fptr_t)mouse_can_methods, (SV*)param);
551 XSPROTO(XS_Mouse_constraint_check) {
554 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
558 croak("Too few arguments for type constraint check functions");
563 ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv) );
568 XSPROTO(XS_Mouse_TypeConstraint_fallback) {
571 PERL_UNUSED_VAR(items);
576 setup_my_cxt(pTHX_ pMY_CXT){
577 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
578 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
580 MY_CXT.universal_can = gv_fetchpvs("UNIVERSAL::can", GV_ADD, SVt_PVCV);
581 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_can);
584 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
586 #define MTC_CLASS "Mouse::Meta::TypeConstraint"
588 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
591 VERSIONCHECK: DISABLE
596 setup_my_cxt(aTHX_ aMY_CXT);
598 /* setup built-in type constraints */
608 DEFINE_TC(ScalarRef);
613 DEFINE_TC(FileHandle);
614 DEFINE_TC(RegexpRef);
616 DEFINE_TC(ClassName);
627 setup_my_cxt(aTHX_ aMY_CXT);
628 PERL_UNUSED_VAR(items);
631 #endif /* !USE_ITHREADS */
633 #define MOUSE_TC_MAYBE 0
634 #define MOUSE_TC_ARRAY_REF 1
635 #define MOUSE_TC_HASH_REF 2
638 _parameterize_ArrayRef_for(SV* param)
640 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
641 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
642 _parameterize_Maybe_for = MOUSE_TC_MAYBE
646 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
647 if(!IsCodeRef(tc_code)){
648 croak("_compiled_type_constraint didn't return a CODE reference");
652 case MOUSE_TC_ARRAY_REF:
653 fptr = mouse_parameterized_ArrayRef;
655 case MOUSE_TC_HASH_REF:
656 fptr = mouse_parameterized_HashRef;
658 default: /* Maybe type */
659 fptr = mouse_parameterized_Maybe;
661 RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
666 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
669 INSTALL_SIMPLE_READER(TypeConstraint, name);
670 INSTALL_SIMPLE_READER(TypeConstraint, parent);
671 INSTALL_SIMPLE_READER(TypeConstraint, message);
673 INSTALL_SIMPLE_READER(TypeConstraint, type_parameter);
675 INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
677 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
678 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, __is_parameterized, type_parameter); /* Mouse specific */
681 PL_amagic_generation++;
682 (void)newXS( MTC_CLASS "::()",
683 XS_Mouse_TypeConstraint_fallback, file);
687 get_sv( MTC_CLASS "::()", GV_ADD ),
691 /* '""' => '_as_string' */
693 SV* const code_ref = sv_2mortal(newRV_inc(
694 (SV*)get_cv( MTC_CLASS "::_as_string", GV_ADD )));
696 (SV*)gv_fetchpvs( MTC_CLASS "::(\"\"", GV_ADDMULTI, SVt_PVCV ),
700 /* '0+' => '_identity' */
702 SV* const code_ref = sv_2mortal(newRV_inc(
703 (SV*)get_cv( MTC_CLASS "::_identity", GV_ADD )));
705 (SV*)gv_fetchpvs( MTC_CLASS "::(0+", GV_ADDMULTI, SVt_PVCV ),
709 /* '|' => '_unite' */
711 SV* const code_ref = sv_2mortal(newRV_inc(
712 (SV*)get_cv( MTC_CLASS "::_unite", GV_ADD )));
714 (SV*)gv_fetchpvs( MTC_CLASS "::(|", GV_ADDMULTI, SVt_PVCV ),
719 _identity(SV* self, ...)
723 croak("Invalid object instance: '%"SVf"'", self);
725 RETVAL = PTR2UV(SvRV(self));
731 compile_type_constraint(SV* self)
734 AV* const checks = newAV_mortal();
735 SV* check; /* check function */
739 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
740 check = get_slots(parent, "hand_optimized_type_constraint");
741 if(check && SvOK(check)){
742 if(!IsCodeRef(check)){
743 croak("Not a CODE reference");
745 av_unshift(checks, 1);
746 av_store(checks, 0, newSVsv(check));
747 break; /* a hand optimized constraint must include all the parent */
750 check = get_slots(parent, "constraint");
751 if(check && SvOK(check)){
752 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
753 croak("Not a CODE reference");
755 av_unshift(checks, 1);
756 av_store(checks, 0, newSVsv(check));
760 check = get_slots(self, "constraint");
761 if(check && SvOK(check)){
762 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
763 croak("Not a CODE reference");
765 av_push(checks, newSVsv(check));
768 types_ref = get_slots(self, "type_constraints");
769 if(types_ref && SvOK(types_ref)){ /* union type */
776 if(!IsArrayRef(types_ref)){
777 croak("Not an ARRAY reference");
779 types = (AV*)SvRV(types_ref);
780 len = av_len(types) + 1;
782 union_checks = newAV_mortal();
784 for(i = 0; i < len; i++){
785 SV* const tc = *av_fetch(types, i, TRUE);
786 SV* const c = get_slots(tc, "compiled_type_constraint");
787 if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
788 mouse_throw_error(self, c, "'%"SVf"' has no compiled type constraint", self);
790 av_push(union_checks, newSVsv(c));
793 union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
794 av_push(checks, newRV_inc((SV*)union_check));
797 if(AvFILLp(checks) < 0){
798 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
801 check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
803 (void)set_slots(self, "compiled_type_constraint", check);
807 check(SV* self, SV* sv, ...)
810 SV* const check = get_slots(self, "compiled_type_constraint");
811 if(!(check && IsCodeRef(check))){
812 mouse_throw_error(self, check,
813 "'%"SVf"' has no compiled type constraint", self);
815 RETVAL = mouse_tc_check(aTHX_ check, sv) ? TRUE : FALSE;