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 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);
24 if(CvXSUB(cv) == XS_Mouse_constraint_check){ /* built-in type constraints */
25 MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
27 assert(CvXSUBANY(cv).any_ptr != NULL);
28 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 mouse_tc_Int(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
123 NV const nv = SvNVX(sv);
124 return nv > 0 ? (nv == (NV)(UV)nv) : (nv == (NV)(IV)nv);
127 int const num_type = grok_number(SvPVX(sv), SvCUR(sv), NULL);
129 return !(num_type & IS_NUMBER_NOT_INT);
136 mouse_tc_Str(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
138 return SvOK(sv) && !SvROK(sv) && !isGV(sv);
142 mouse_tc_ClassName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv){
144 return is_class_loaded(sv);
148 mouse_tc_RoleName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
150 if(is_class_loaded(sv)){
156 ok = is_an_instance_of("Mouse::Meta::Role", get_metaclass(sv));
167 mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
173 mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
175 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && (SvTYPE(SvRV(sv)) <= SVt_PVLV && !isGV(SvRV(sv)));
179 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
181 return IsArrayRef(sv);
185 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
187 return IsHashRef(sv);
191 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
193 return IsCodeRef(sv);
197 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
203 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
205 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
209 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
213 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
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;
219 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
224 return is_an_instance_of("IO::Handle", sv);
228 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
230 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
233 /* Parameterized type constraints */
236 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
238 AV* const av = (AV*)SvRV(sv);
239 I32 const len = av_len(av) + 1;
241 for(i = 0; i < len; i++){
242 SV* const value = *av_fetch(av, i, TRUE);
244 if(!mouse_tc_check(aTHX_ param, value)){
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);
260 while((he = hv_iternext(hv))){
261 SV* const value = hv_iterval(hv, he);
263 if(!mouse_tc_check(aTHX_ param, value)){
264 hv_iterinit(hv); /* reset */
274 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
276 return mouse_tc_check(aTHX_ param, sv);
282 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
283 I32 const len = AvFILLp(types) + 1;
286 for(i = 0; i < len; i++){
287 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
296 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
297 I32 const len = AvFILLp(types) + 1;
304 for(i = 0; i < len; i++){
305 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
317 * This class_type generator is taken from Scalar::Util::Instance
320 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
321 typedef struct sui_cxt{
327 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
328 #define MG_klass_pv(mg) ((mg)->mg_ptr)
329 #define MG_klass_len(mg) ((mg)->mg_len)
332 mouse_canonicalize_package_name(const char* name){
334 /* "::Foo" -> "Foo" */
335 if(name[0] == ':' && name[1] == ':'){
339 /* "main::main::main::Foo" -> "Foo" */
340 while(strnEQ(name, "main::", sizeof("main::")-1)){
341 name += sizeof("main::")-1;
348 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
349 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
350 SV** svp = AvARRAY(linearized_isa);
351 SV** const end = svp + AvFILLp(linearized_isa) + 1;
355 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
363 #define find_method_pvn(a, b, c) mouse_stash_find_method(aTHX_ a, b, c)
364 #define find_method_pvs(a, b) mouse_stash_find_method(aTHX_ a, STR_WITH_LEN(b))
367 mouse_stash_find_method(pTHX_ HV* const stash, const char* const name, I32 const namelen){
368 GV** const gvp = (GV**)hv_fetch(stash, name, namelen, FALSE);
369 if(gvp && isGV(*gvp) && GvCV(*gvp)){ /* shortcut */
373 return gv_fetchmeth_autoload(stash, name, namelen, 0);
377 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
379 assert(SvTYPE(stash) == SVt_PVHV);
381 if(IsObject(instance)){
383 HV* const instance_stash = SvSTASH(SvRV(instance));
384 GV* const instance_isa = find_method_pvs(instance_stash, "isa");
386 /* the instance has no own isa method */
387 if(instance_isa == NULL || GvCV(instance_isa) == GvCV(MY_CXT.universal_isa)){
388 return stash == instance_stash
389 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
391 /* the instance has its own isa method */
402 mPUSHp(HvNAME_get(stash), HvNAMELEN_get(stash));
405 call_sv((SV*)instance_isa, G_SCALAR);
409 retval = SvTRUEx(POPs);
423 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
424 PERL_UNUSED_ARG(data);
425 return SvROK(sv) && SvOBJECT(SvRV(sv));
429 mouse_can_methods(pTHX_ AV* const methods, SV* const instance){
430 if(IsObject(instance)){
432 HV* const mystash = SvSTASH(SvRV(instance));
433 GV* const mycan = find_method_pvs(mystash, "can");
434 bool const use_builtin = (mycan == NULL || GvCV(mycan) == GvCV(MY_CXT.universal_can)) ? TRUE : FALSE;
435 I32 const len = AvFILLp(methods) + 1;
437 for(i = 0; i < len; i++){
438 SV* const name = MOUSE_av_at(methods, i);
441 if(!find_method_pvn(mystash, SvPVX(name), SvCUR(name))){
455 PUSHs(sv_mortalcopy(name));
458 call_method("can", G_SCALAR);
478 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
481 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
484 xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
485 CvXSUBANY(xsub).any_ptr = sv_magicext(
487 param, /* mg_obj: refcnt will be increased */
489 &mouse_util_type_constraints_vtbl,
490 (void*)fptr, /* mg_ptr */
491 0 /* mg_len: 0 for static data */
495 sv_2mortal((SV*)xsub);
502 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
504 const char* klass_pv = SvPV_const(klass, klass_len);
508 klass_pv = mouse_canonicalize_package_name(klass_pv);
510 if(strNE(klass_pv, "UNIVERSAL")){
511 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
512 fptr = (void*)mouse_is_an_instance_of;
517 fptr = (void*)mouse_is_an_instance_of_universal;
520 return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
524 mouse_generate_can_predicate_for(pTHX_ SV* const methods, const char* const predicate_name){
526 AV* const param = newAV_mortal();
531 if(!IsArrayRef(methods)){
532 croak("You must pass an ARRAY ref method names");
534 av = (AV*)SvRV(methods);
536 len = av_len(av) + 1;
537 for(i = 0; i < len; i++){
538 SV* const name = *av_fetch(av, i, TRUE);
540 const char* const pv = SvPV_const(name, pvlen);
542 av_push(param, newSVpvn_share(pv, pvlen, 0U));
545 return mouse_tc_generate(aTHX_ predicate_name, (check_fptr_t)mouse_can_methods, (SV*)param);
549 XS(XS_Mouse_constraint_check) {
552 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
555 croak("Too few arguments for type constraint check functions");
559 ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, ST(0)) );
564 setup_my_cxt(pTHX_ pMY_CXT){
565 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
566 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
568 MY_CXT.universal_can = gv_fetchpvs("UNIVERSAL::can", GV_ADD, SVt_PVCV);
569 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_can);
572 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
574 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
577 VERSIONCHECK: DISABLE
582 setup_my_cxt(aTHX_ aMY_CXT);
584 /* setup built-in type constraints */
594 DEFINE_TC(ScalarRef);
599 DEFINE_TC(FileHandle);
600 DEFINE_TC(RegexpRef);
602 DEFINE_TC(ClassName);
613 setup_my_cxt(aTHX_ aMY_CXT);
614 PERL_UNUSED_VAR(items);
617 #endif /* !USE_ITHREADS */
619 #define MOUSE_TC_MAYBE 0
620 #define MOUSE_TC_ARRAY_REF 1
621 #define MOUSE_TC_HASH_REF 2
624 _parameterize_ArrayRef_for(SV* param)
626 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
627 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
628 _parameterize_Maybe_for = MOUSE_TC_MAYBE
632 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
633 if(!IsCodeRef(tc_code)){
634 croak("_compiled_type_constraint didn't return a CODE reference");
638 case MOUSE_TC_ARRAY_REF:
639 fptr = mouse_parameterized_ArrayRef;
641 case MOUSE_TC_HASH_REF:
642 fptr = mouse_parameterized_HashRef;
644 default: /* Maybe type */
645 fptr = mouse_parameterized_Maybe;
647 RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
652 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
655 INSTALL_SIMPLE_READER(TypeConstraint, name);
656 INSTALL_SIMPLE_READER(TypeConstraint, parent);
657 INSTALL_SIMPLE_READER(TypeConstraint, message);
659 INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
660 INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
662 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
665 compile_type_constraint(SV* self)
668 AV* const checks = newAV_mortal();
669 SV* check; /* check function */
673 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
674 check = get_slots(parent, "hand_optimized_type_constraint");
675 if(check && SvOK(check)){
676 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
677 croak("Not a CODE reference");
679 av_unshift(checks, 1);
680 av_store(checks, 0, newSVsv(check));
681 break; /* a hand optimized constraint must include all the parent */
684 check = get_slots(parent, "constraint");
685 if(check && SvOK(check)){
686 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
687 croak("Not a CODE reference");
689 av_unshift(checks, 1);
690 av_store(checks, 0, newSVsv(check));
694 check = get_slots(self, "constraint");
695 if(check && SvOK(check)){
696 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
697 croak("Not a CODE reference");
699 av_push(checks, newSVsv(check));
702 types_ref = get_slots(self, "type_constraints");
703 if(types_ref && SvOK(types_ref)){ /* union type */
710 if(!IsArrayRef(types_ref)){
711 croak("Not an ARRAY reference");
713 types = (AV*)SvRV(types_ref);
714 len = av_len(types) + 1;
716 union_checks = newAV_mortal();
718 for(i = 0; i < len; i++){
719 SV* const tc = *av_fetch(types, i, TRUE);
720 SV* const c = get_slots(tc, "compiled_type_constraint");
721 if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
723 croak("'%"SVf"' has no compiled type constraint", self);
725 av_push(union_checks, newSVsv(c));
728 union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
729 av_push(checks, newRV_inc((SV*)union_check));
732 if(AvFILLp(checks) < 0){
733 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
736 check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
738 set_slots(self, "compiled_type_constraint", check);