2 * full definition of built-in type constraints (ware in Moose::Util::TypeConstraints::OptimizedConstraints)
7 #if PERL_BCDVERSION >= 0x5008005
8 #define LooksLikeNumber(sv) looks_like_number(sv)
10 #define LooksLikeNumber(sv) ( SvPOKp(sv) ? looks_like_number(sv) : SvNIOKp(sv) )
14 #define SvRXOK(sv) (SvROK(sv) && SvMAGICAL(SvRV(sv)) && mg_find(SvRV(sv), PERL_MAGIC_qr))
17 typedef int (*check_fptr_t)(pTHX_ SV* const data, SV* const sv);
20 NOTE: mouse_tc_check() handles GETMAGIC
23 mouse_tc_check(pTHX_ SV* const tc_code, SV* const sv) {
24 CV* const cv = (CV*)SvRV(tc_code);
25 assert(SvTYPE(cv) == SVt_PVCV);
27 if(CvXSUB(cv) == XS_Mouse_constraint_check){ /* built-in type constraints */
28 MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
30 assert(CvXSUBANY(cv).any_ptr != NULL);
31 assert(mg->mg_ptr != NULL);
34 /* call the check function directly, skipping call_sv() */
35 return CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv);
48 call_sv(tc_code, G_SCALAR);
62 The following type check functions return an integer, not a bool, to keep them simple,
63 so if you assign these return value to bool variable, you must use "expr ? TRUE : FALSE".
67 mouse_tc_Any(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv PERL_UNUSED_DECL) {
73 mouse_tc_Bool(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
78 return SvIVX(sv) == 1;
81 return SvNVX(sv) == 1.0;
83 else if(SvPOKp(sv)){ /* "1" */
84 return SvCUR(sv) == 1 && SvPVX(sv)[0] == '1';
91 /* any false value must be boolean */
97 mouse_tc_Undef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
103 mouse_tc_Defined(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
109 mouse_tc_Value(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
111 return SvOK(sv) && !SvROK(sv);
115 mouse_tc_Num(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
117 return LooksLikeNumber(sv);
121 S_nv_is_integer(pTHX_ NV const nv) {
122 if(nv == (NV)(IV)nv){
126 char buf[64]; /* Must fit sprintf/Gconvert of longest NV */
128 Gconvert(nv, NV_DIG, 0, buf);
145 mouse_tc_Int(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
150 else if(SvNOKp(sv)) {
151 return S_nv_is_integer(aTHX_ SvNVX(sv));
154 int const num_type = grok_number(SvPVX(sv), SvCUR(sv), NULL);
156 return !(num_type & IS_NUMBER_NOT_INT);
163 mouse_tc_Str(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
165 return SvOK(sv) && !SvROK(sv) && !isGV(sv);
169 mouse_tc_ClassName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv){
171 return is_class_loaded(sv);
175 mouse_tc_RoleName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
177 if(is_class_loaded(sv)){
183 ok = is_an_instance_of("Mouse::Meta::Role", get_metaclass(sv));
194 mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
200 mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* sv) {
204 return !SvOBJECT(sv) && (SvTYPE(sv) <= SVt_PVLV && !isGV(sv));
210 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
212 return IsArrayRef(sv);
216 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
218 return IsHashRef(sv);
222 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
224 return IsCodeRef(sv);
228 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
234 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
236 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
240 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
244 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
246 gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
247 if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
248 IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
250 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
255 return is_an_instance_of("IO::Handle", sv);
259 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
261 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
264 /* Parameterized type constraints */
267 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
269 AV* const av = (AV*)SvRV(sv);
270 I32 const len = av_len(av) + 1;
272 for(i = 0; i < len; i++){
273 SV* const value = *av_fetch(av, i, TRUE);
274 if(!mouse_tc_check(aTHX_ param, value)){
284 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
285 if(mouse_tc_HashRef(aTHX_ NULL, sv)){
286 HV* const hv = (HV*)SvRV(sv);
290 while((he = hv_iternext(hv))){
291 SV* const value = hv_iterval(hv, he);
292 if(!mouse_tc_check(aTHX_ param, value)){
293 hv_iterinit(hv); /* reset */
303 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
305 return mouse_tc_check(aTHX_ param, sv);
311 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
312 I32 const len = AvFILLp(types) + 1;
315 for(i = 0; i < len; i++){
316 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
325 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
326 I32 const len = AvFILLp(types) + 1;
333 for(i = 0; i < len; i++){
334 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
346 * This class_type generator is taken from Scalar::Util::Instance
349 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
350 typedef struct sui_cxt{
356 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
357 #define MG_klass_pv(mg) ((mg)->mg_ptr)
358 #define MG_klass_len(mg) ((mg)->mg_len)
361 mouse_canonicalize_package_name(const char* name){
363 /* "::Foo" -> "Foo" */
364 if(name[0] == ':' && name[1] == ':'){
368 /* "main::main::main::Foo" -> "Foo" */
369 while(strnEQ(name, "main::", sizeof("main::")-1)){
370 name += sizeof("main::")-1;
377 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
378 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
379 SV** svp = AvARRAY(linearized_isa);
380 SV** const end = svp + AvFILLp(linearized_isa) + 1;
384 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
392 #define find_method_pvn(a, b, c) mouse_stash_find_method(aTHX_ a, b, c)
393 #define find_method_pvs(a, b) mouse_stash_find_method(aTHX_ a, STR_WITH_LEN(b))
396 mouse_stash_find_method(pTHX_ HV* const stash, const char* const name, I32 const namelen){
397 GV** const gvp = (GV**)hv_fetch(stash, name, namelen, FALSE);
398 if(gvp && isGV(*gvp) && GvCV(*gvp)){ /* shortcut */
402 return gv_fetchmeth_autoload(stash, name, namelen, 0);
406 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
408 assert(SvTYPE(stash) == SVt_PVHV);
410 if(IsObject(instance)){
412 HV* const instance_stash = SvSTASH(SvRV(instance));
413 GV* const myisa = find_method_pvs(instance_stash, "isa");
415 /* the instance has no own isa method */
416 if(myisa == NULL || GvCV(myisa) == GvCV(MY_CXT.universal_isa)){
417 return stash == instance_stash
418 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
420 /* the instance has its own isa method */
428 package = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
429 ok = sv_true(mcall1s(instance, "isa", sv_2mortal(package)));
441 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
442 PERL_UNUSED_ARG(data);
443 return SvROK(sv) && SvOBJECT(SvRV(sv));
447 mouse_can_methods(pTHX_ AV* const methods, SV* const instance){
448 if(IsObject(instance)){
450 HV* const mystash = SvSTASH(SvRV(instance));
451 GV* const mycan = find_method_pvs(mystash, "can");
452 bool const use_builtin = (mycan == NULL || GvCV(mycan) == GvCV(MY_CXT.universal_can)) ? TRUE : FALSE;
453 I32 const len = AvFILLp(methods) + 1;
455 for(i = 0; i < len; i++){
456 SV* const name = MOUSE_av_at(methods, i);
459 if(!find_method_pvn(mystash, SvPVX(name), SvCUR(name))){
469 ok = sv_true(mcall1s(instance, "can", sv_mortalcopy(name)));
484 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
487 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
490 xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
491 CvXSUBANY(xsub).any_ptr = sv_magicext(
493 param, /* mg_obj: refcnt will be increased */
495 &mouse_util_type_constraints_vtbl,
496 (char*)fptr, /* mg_ptr */
497 0 /* mg_len: 0 for static data */
501 sv_2mortal((SV*)xsub);
508 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
510 const char* klass_pv = SvPV_const(klass, klass_len);
514 klass_pv = mouse_canonicalize_package_name(klass_pv);
516 if(strNE(klass_pv, "UNIVERSAL")){
517 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
518 fptr = (check_fptr_t)mouse_is_an_instance_of;
523 fptr = (check_fptr_t)mouse_is_an_instance_of_universal;
526 return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
530 mouse_generate_can_predicate_for(pTHX_ SV* const methods, const char* const predicate_name){
532 AV* const param = newAV_mortal();
536 must_ref(methods, "an ARRAY ref for method names", SVt_PVAV);
537 av = (AV*)SvRV(methods);
539 len = av_len(av) + 1;
540 for(i = 0; i < len; i++){
541 SV* const name = *av_fetch(av, i, TRUE);
543 const char* const pv = SvPV_const(name, pvlen);
545 av_push(param, newSVpvn_share(pv, pvlen, 0U));
548 return mouse_tc_generate(aTHX_ predicate_name, (check_fptr_t)mouse_can_methods, (SV*)param);
552 XS(XS_Mouse_constraint_check) {
555 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
558 croak("Too few arguments for type constraint check functions");
562 ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, ST(0)) );
567 setup_my_cxt(pTHX_ pMY_CXT){
568 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
569 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
571 MY_CXT.universal_can = gv_fetchpvs("UNIVERSAL::can", GV_ADD, SVt_PVCV);
572 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_can);
575 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
577 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
580 VERSIONCHECK: DISABLE
585 setup_my_cxt(aTHX_ aMY_CXT);
587 /* setup built-in type constraints */
597 DEFINE_TC(ScalarRef);
602 DEFINE_TC(FileHandle);
603 DEFINE_TC(RegexpRef);
605 DEFINE_TC(ClassName);
616 setup_my_cxt(aTHX_ aMY_CXT);
617 PERL_UNUSED_VAR(items);
620 #endif /* !USE_ITHREADS */
622 #define MOUSE_TC_MAYBE 0
623 #define MOUSE_TC_ARRAY_REF 1
624 #define MOUSE_TC_HASH_REF 2
627 _parameterize_ArrayRef_for(SV* param)
629 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
630 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
631 _parameterize_Maybe_for = MOUSE_TC_MAYBE
635 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
636 if(!IsCodeRef(tc_code)){
637 croak("_compiled_type_constraint didn't return a CODE reference");
641 case MOUSE_TC_ARRAY_REF:
642 fptr = mouse_parameterized_ArrayRef;
644 case MOUSE_TC_HASH_REF:
645 fptr = mouse_parameterized_HashRef;
647 default: /* Maybe type */
648 fptr = mouse_parameterized_Maybe;
650 RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
655 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
658 INSTALL_SIMPLE_READER(TypeConstraint, name);
659 INSTALL_SIMPLE_READER(TypeConstraint, parent);
660 INSTALL_SIMPLE_READER(TypeConstraint, message);
662 INSTALL_SIMPLE_READER(TypeConstraint, type_parameter);
664 INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
665 INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
667 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
668 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, __is_parameterized, type_parameter); /* Mouse specific */
671 compile_type_constraint(SV* self)
674 AV* const checks = newAV_mortal();
675 SV* check; /* check function */
679 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
680 check = get_slots(parent, "hand_optimized_type_constraint");
681 if(check && SvOK(check)){
682 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
683 croak("Not a CODE reference");
685 av_unshift(checks, 1);
686 av_store(checks, 0, newSVsv(check));
687 break; /* a hand optimized constraint must include all the parent */
690 check = get_slots(parent, "constraint");
691 if(check && SvOK(check)){
692 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
693 croak("Not a CODE reference");
695 av_unshift(checks, 1);
696 av_store(checks, 0, newSVsv(check));
700 check = get_slots(self, "constraint");
701 if(check && SvOK(check)){
702 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
703 croak("Not a CODE reference");
705 av_push(checks, newSVsv(check));
708 types_ref = get_slots(self, "type_constraints");
709 if(types_ref && SvOK(types_ref)){ /* union type */
716 if(!IsArrayRef(types_ref)){
717 croak("Not an ARRAY reference");
719 types = (AV*)SvRV(types_ref);
720 len = av_len(types) + 1;
722 union_checks = newAV_mortal();
724 for(i = 0; i < len; i++){
725 SV* const tc = *av_fetch(types, i, TRUE);
726 SV* const c = get_slots(tc, "compiled_type_constraint");
727 if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
728 mouse_throw_error(self, c, "'%"SVf"' has no compiled type constraint", self);
730 av_push(union_checks, newSVsv(c));
733 union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
734 av_push(checks, newRV_inc((SV*)union_check));
737 if(AvFILLp(checks) < 0){
738 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
741 check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
743 (void)set_slots(self, "compiled_type_constraint", check);
747 check(SV* self, SV* sv)
750 SV* const check = get_slots(self, "compiled_type_constraint");
751 if(!(check && mouse_tc_CodeRef(aTHX_ NULL, check))){
752 mouse_throw_error(self, check, "'%"SVf"' has no compiled type constraint", self);
754 RETVAL = mouse_tc_check(aTHX_ check, sv) ? TRUE : FALSE;