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__Util__TypeConstraints_Item){ /* built-in */
25 assert(CvXSUBANY(cv).any_iv > 0);
27 return mouse_builtin_tc_check(aTHX_ CvXSUBANY(cv).any_iv, sv);
29 else if(CvXSUB(cv) == XS_Mouse_parameterized_check){ /* built-in, parameterizad */
30 MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
32 assert(CvXSUBANY(cv).any_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 mouse_builtin_tc_check(pTHX_ mouse_tc const tc, SV* const sv) {
64 case MOUSE_TC_ANY: return mouse_tc_Any(aTHX_ sv);
65 case MOUSE_TC_ITEM: return mouse_tc_Any(aTHX_ sv);
66 case MOUSE_TC_MAYBE: return mouse_tc_Any(aTHX_ sv);
67 case MOUSE_TC_UNDEF: return mouse_tc_Undef(aTHX_ sv);
68 case MOUSE_TC_DEFINED: return mouse_tc_Defined(aTHX_ sv);
69 case MOUSE_TC_BOOL: return mouse_tc_Bool(aTHX_ sv);
70 case MOUSE_TC_VALUE: return mouse_tc_Value(aTHX_ sv);
71 case MOUSE_TC_REF: return mouse_tc_Ref(aTHX_ sv);
72 case MOUSE_TC_STR: return mouse_tc_Str(aTHX_ sv);
73 case MOUSE_TC_NUM: return mouse_tc_Num(aTHX_ sv);
74 case MOUSE_TC_INT: return mouse_tc_Int(aTHX_ sv);
75 case MOUSE_TC_SCALAR_REF: return mouse_tc_ScalarRef(aTHX_ sv);
76 case MOUSE_TC_ARRAY_REF: return mouse_tc_ArrayRef(aTHX_ sv);
77 case MOUSE_TC_HASH_REF: return mouse_tc_HashRef(aTHX_ sv);
78 case MOUSE_TC_CODE_REF: return mouse_tc_CodeRef(aTHX_ sv);
79 case MOUSE_TC_GLOB_REF: return mouse_tc_GlobRef(aTHX_ sv);
80 case MOUSE_TC_FILEHANDLE: return mouse_tc_FileHandle(aTHX_ sv);
81 case MOUSE_TC_REGEXP_REF: return mouse_tc_RegexpRef(aTHX_ sv);
82 case MOUSE_TC_OBJECT: return mouse_tc_Object(aTHX_ sv);
83 case MOUSE_TC_CLASS_NAME: return mouse_tc_ClassName(aTHX_ sv);
84 case MOUSE_TC_ROLE_NAME: return mouse_tc_RoleName(aTHX_ sv);
89 croak("Mouse-panic: unrecognized type constraint id: %d", (int)tc);
90 return FALSE; /* not reached */
95 The following type check functions return an integer, not a bool, to keep them simple,
96 so if you assign these return value to bool variable, you must use "expr ? TRUE : FALSE".
100 mouse_tc_Any(pTHX_ SV* const sv PERL_UNUSED_DECL) {
106 mouse_tc_Bool(pTHX_ SV* const sv) {
111 return SvIVX(sv) == 1;
114 return SvNVX(sv) == 1.0;
116 else if(SvPOKp(sv)){ /* "1" */
117 return SvCUR(sv) == 1 && SvPVX(sv)[0] == '1';
124 /* false must be boolean */
130 mouse_tc_Undef(pTHX_ SV* const sv) {
136 mouse_tc_Defined(pTHX_ SV* const sv) {
142 mouse_tc_Value(pTHX_ SV* const sv) {
144 return SvOK(sv) && !SvROK(sv);
148 mouse_tc_Num(pTHX_ SV* const sv) {
150 return LooksLikeNumber(sv);
154 mouse_tc_Int(pTHX_ SV* const sv) {
160 NV const nv = SvNVX(sv);
161 return nv > 0 ? (nv == (NV)(UV)nv) : (nv == (NV)(IV)nv);
164 int const num_type = grok_number(SvPVX(sv), SvCUR(sv), NULL);
166 return !(num_type & IS_NUMBER_NOT_INT);
173 mouse_tc_Str(pTHX_ SV* const sv) {
175 return SvOK(sv) && !SvROK(sv) && !isGV(sv);
179 mouse_tc_ClassName(pTHX_ SV* const sv){
181 return is_class_loaded(sv);
185 mouse_tc_RoleName(pTHX_ SV* const sv) {
187 if(is_class_loaded(sv)){
198 call_pv("Mouse::Util::get_metaclass_by_name", G_SCALAR);
203 ok = is_an_instance_of("Mouse::Meta::Role", meta);
214 mouse_tc_Ref(pTHX_ SV* const sv) {
220 mouse_tc_ScalarRef(pTHX_ SV* const sv) {
222 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && (SvTYPE(SvRV(sv)) <= SVt_PVLV && !isGV(SvRV(sv)));
226 mouse_tc_ArrayRef(pTHX_ SV* const sv) {
228 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV;
232 mouse_tc_HashRef(pTHX_ SV* const sv) {
234 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV;
238 mouse_tc_CodeRef(pTHX_ SV* const sv) {
240 return SvROK(sv) && !SvOBJECT(SvRV(sv))&& SvTYPE(SvRV(sv)) == SVt_PVCV;
244 mouse_tc_RegexpRef(pTHX_ SV* const sv) {
250 mouse_tc_GlobRef(pTHX_ SV* const sv) {
252 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
256 mouse_tc_FileHandle(pTHX_ SV* const sv) {
260 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
262 gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
263 if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
264 IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
266 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
271 return is_an_instance_of("IO::Handle", sv);
275 mouse_tc_Object(pTHX_ SV* const sv) {
277 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
280 /* Parameterized type constraints */
283 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
284 if(mouse_tc_ArrayRef(aTHX_ sv)){
285 AV* const av = (AV*)SvRV(sv);
286 I32 const len = av_len(av) + 1;
288 for(i = 0; i < len; i++){
289 SV* const value = *av_fetch(av, i, TRUE);
291 if(!mouse_tc_check(aTHX_ param, value)){
301 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
302 if(mouse_tc_HashRef(aTHX_ sv)){
303 HV* const hv = (HV*)SvRV(sv);
307 while((he = hv_iternext(hv))){
308 SV* const value = hv_iterval(hv, he);
310 if(!mouse_tc_check(aTHX_ param, value)){
320 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
322 return mouse_tc_check(aTHX_ param, sv);
328 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
329 I32 const len = AvFILLp(types) + 1;
332 for(i = 0; i < len; i++){
333 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
342 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
343 I32 const len = AvFILLp(types) + 1;
350 for(i = 0; i < len; i++){
351 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
363 * This class_type generator is taken from Scalar::Util::Instance
366 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
367 typedef struct sui_cxt{
372 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
373 #define MG_klass_pv(mg) ((mg)->mg_ptr)
374 #define MG_klass_len(mg) ((mg)->mg_len)
377 mouse_canonicalize_package_name(const char* name){
379 /* "::Foo" -> "Foo" */
380 if(name[0] == ':' && name[1] == ':'){
384 /* "main::main::main::Foo" -> "Foo" */
385 while(strnEQ(name, "main::", sizeof("main::")-1)){
386 name += sizeof("main::")-1;
393 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
394 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
395 SV** svp = AvARRAY(linearized_isa);
396 SV** const end = svp + AvFILLp(linearized_isa) + 1;
400 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
409 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
411 assert(SvTYPE(stash) == SVt_PVHV);
413 if(IsObject(instance)){
415 HV* const instance_stash = SvSTASH(SvRV(instance));
416 GV* const instance_isa = gv_fetchmeth_autoload(instance_stash, "isa", sizeof("isa")-1, 0);
418 /* the instance has no own isa method */
419 if(instance_isa == NULL || GvCV(instance_isa) == GvCV(MY_CXT.universal_isa)){
420 return stash == instance_stash
421 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
423 /* the instance has its own isa method */
434 mPUSHp(HvNAME_get(stash), HvNAMELEN_get(stash));
437 call_sv((SV*)instance_isa, G_SCALAR);
441 retval = SvTRUEx(POPs);
455 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
456 PERL_UNUSED_ARG(data);
457 return SvROK(sv) && SvOBJECT(SvRV(sv));
460 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
463 mouse_tc_parameterize(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
466 xsub = newXS(name, XS_Mouse_parameterized_check, __FILE__);
467 CvXSUBANY(xsub).any_ptr = sv_magicext(
469 param, /* mg_obj: refcnt will be increased */
471 &mouse_util_type_constraints_vtbl,
472 (void*)fptr, /* mg_ptr */
473 0 /* mg_len: 0 for static data */
477 sv_2mortal((SV*)xsub);
484 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
486 const char* klass_pv = SvPV_const(klass, klass_len);
490 klass_pv = mouse_canonicalize_package_name(klass_pv);
492 if(strNE(klass_pv, "UNIVERSAL")){
493 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
494 fptr = (void*)mouse_is_an_instance_of;
499 fptr = (void*)mouse_is_an_instance_of_universal;
502 return mouse_tc_parameterize(aTHX_ predicate_name, fptr, param);
505 XS(XS_Mouse_parameterized_check) {
508 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
511 croak("Too few arguments for parameterized check functions");
515 ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, ST(0)) );
520 setup_my_cxt(pTHX_ pMY_CXT){
521 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
522 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
525 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
528 VERSIONCHECK: DISABLE
533 setup_my_cxt(aTHX_ aMY_CXT);
543 setup_my_cxt(aTHX_ aMY_CXT);
544 PERL_UNUSED_VAR(items);
547 #endif /* !USE_ITHREADS */
550 Item(SV* sv = &PL_sv_undef)
554 Undef = MOUSE_TC_UNDEF
555 Defined = MOUSE_TC_DEFINED
557 Value = MOUSE_TC_VALUE
562 ScalarRef = MOUSE_TC_SCALAR_REF
563 ArrayRef = MOUSE_TC_ARRAY_REF
564 HashRef = MOUSE_TC_HASH_REF
565 CodeRef = MOUSE_TC_CODE_REF
566 GlobRef = MOUSE_TC_GLOB_REF
567 FileHandle = MOUSE_TC_FILEHANDLE
568 RegexpRef = MOUSE_TC_REGEXP_REF
569 Object = MOUSE_TC_OBJECT
570 ClassName = MOUSE_TC_CLASS_NAME
571 RoleName = MOUSE_TC_ROLE_NAME
574 ST(0) = boolSV( mouse_builtin_tc_check(aTHX_ ix, sv) );
579 _parameterize_ArrayRef_for(SV* param)
581 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
582 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
583 _parameterize_Maybe_for = MOUSE_TC_MAYBE
587 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
588 if(!(SvROK(tc_code) && SvTYPE(SvRV(tc_code)) == SVt_PVCV)){
589 croak("_compiled_type_constraint didn't return a CODE reference");
593 case MOUSE_TC_ARRAY_REF:
594 fptr = mouse_parameterized_ArrayRef;
596 case MOUSE_TC_HASH_REF:
597 fptr = mouse_parameterized_HashRef;
599 default: /* Maybe type */
600 fptr = mouse_parameterized_Maybe;
602 RETVAL = mouse_tc_parameterize(aTHX_ NULL, fptr, tc_code);
607 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
610 compile_type_constraint(SV* self)
613 AV* const checks = newAV();
614 SV* check; /* check function */
618 sv_2mortal((SV*)checks);
620 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
621 check = get_slots(parent, "hand_optimized_type_constraint");
622 if(check && SvOK(check)){
623 if(!mouse_tc_CodeRef(aTHX_ check)){
624 croak("Not a CODE reference");
626 av_unshift(checks, 1);
627 av_store(checks, 0, newSVsv(check));
628 break; /* a hand optimized constraint must include all the parent */
631 check = get_slots(parent, "constraint");
632 if(check && SvOK(check)){
633 if(!mouse_tc_CodeRef(aTHX_ check)){
634 croak("Not a CODE reference");
636 av_unshift(checks, 1);
637 av_store(checks, 0, newSVsv(check));
641 check = get_slots(self, "constraint");
642 if(check && SvOK(check)){
643 if(!mouse_tc_CodeRef(aTHX_ check)){
644 croak("Not a CODE reference");
646 av_push(checks, newSVsv(check));
649 types_ref = get_slots(self, "type_constraints");
650 if(types_ref && SvOK(types_ref)){ /* union type */
657 if(!mouse_tc_ArrayRef(aTHX_ types_ref)){
658 croak("Not an ARRAY reference");
660 types = (AV*)SvRV(types_ref);
661 len = av_len(types) + 1;
663 union_checks = newAV();
664 sv_2mortal((SV*)union_checks);
666 for(i = 0; i < len; i++){
667 SV* const tc = *av_fetch(types, i, TRUE);
668 SV* const c = get_slots(tc, "compiled_type_constraint");
669 if(!(c && mouse_tc_CodeRef(aTHX_ c))){
671 croak("'%"SVf"' has no compiled type constraint", self);
673 av_push(union_checks, newSVsv(c));
676 union_check = mouse_tc_parameterize(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
677 av_push(checks, newRV_inc((SV*)union_check));
680 if(AvFILLp(checks) < 0){
681 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
684 check = newRV_inc((SV*)mouse_tc_parameterize(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
686 set_slots(self, "compiled_type_constraint", check);