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* sv) {
177 return !SvOBJECT(sv) && (SvTYPE(sv) <= SVt_PVLV && !isGV(sv));
183 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
185 return IsArrayRef(sv);
189 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
191 return IsHashRef(sv);
195 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
197 return IsCodeRef(sv);
201 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
207 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
209 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
213 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
217 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
219 gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
220 if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
221 IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
223 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
228 return is_an_instance_of("IO::Handle", sv);
232 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
234 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
237 /* Parameterized type constraints */
240 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
242 AV* const av = (AV*)SvRV(sv);
243 I32 const len = av_len(av) + 1;
245 for(i = 0; i < len; i++){
246 SV* const value = *av_fetch(av, i, TRUE);
248 if(!mouse_tc_check(aTHX_ param, value)){
258 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
259 if(mouse_tc_HashRef(aTHX_ NULL, sv)){
260 HV* const hv = (HV*)SvRV(sv);
264 while((he = hv_iternext(hv))){
265 SV* const value = hv_iterval(hv, he);
267 if(!mouse_tc_check(aTHX_ param, value)){
268 hv_iterinit(hv); /* reset */
278 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
280 return mouse_tc_check(aTHX_ param, sv);
286 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
287 I32 const len = AvFILLp(types) + 1;
290 for(i = 0; i < len; i++){
291 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
300 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
301 I32 const len = AvFILLp(types) + 1;
308 for(i = 0; i < len; i++){
309 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
321 * This class_type generator is taken from Scalar::Util::Instance
324 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
325 typedef struct sui_cxt{
331 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
332 #define MG_klass_pv(mg) ((mg)->mg_ptr)
333 #define MG_klass_len(mg) ((mg)->mg_len)
336 mouse_canonicalize_package_name(const char* name){
338 /* "::Foo" -> "Foo" */
339 if(name[0] == ':' && name[1] == ':'){
343 /* "main::main::main::Foo" -> "Foo" */
344 while(strnEQ(name, "main::", sizeof("main::")-1)){
345 name += sizeof("main::")-1;
352 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
353 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
354 SV** svp = AvARRAY(linearized_isa);
355 SV** const end = svp + AvFILLp(linearized_isa) + 1;
359 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
367 #define find_method_pvn(a, b, c) mouse_stash_find_method(aTHX_ a, b, c)
368 #define find_method_pvs(a, b) mouse_stash_find_method(aTHX_ a, STR_WITH_LEN(b))
371 mouse_stash_find_method(pTHX_ HV* const stash, const char* const name, I32 const namelen){
372 GV** const gvp = (GV**)hv_fetch(stash, name, namelen, FALSE);
373 if(gvp && isGV(*gvp) && GvCV(*gvp)){ /* shortcut */
377 return gv_fetchmeth_autoload(stash, name, namelen, 0);
381 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
383 assert(SvTYPE(stash) == SVt_PVHV);
385 if(IsObject(instance)){
387 HV* const instance_stash = SvSTASH(SvRV(instance));
388 GV* const instance_isa = find_method_pvs(instance_stash, "isa");
390 /* the instance has no own isa method */
391 if(instance_isa == NULL || GvCV(instance_isa) == GvCV(MY_CXT.universal_isa)){
392 return stash == instance_stash
393 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
395 /* the instance has its own isa method */
406 mPUSHp(HvNAME_get(stash), HvNAMELEN_get(stash));
409 call_sv((SV*)instance_isa, G_SCALAR);
412 retval = sv_true(POPs);
425 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
426 PERL_UNUSED_ARG(data);
427 return SvROK(sv) && SvOBJECT(SvRV(sv));
431 mouse_can_methods(pTHX_ AV* const methods, SV* const instance){
432 if(IsObject(instance)){
434 HV* const mystash = SvSTASH(SvRV(instance));
435 GV* const mycan = find_method_pvs(mystash, "can");
436 bool const use_builtin = (mycan == NULL || GvCV(mycan) == GvCV(MY_CXT.universal_can)) ? TRUE : FALSE;
437 I32 const len = AvFILLp(methods) + 1;
439 for(i = 0; i < len; i++){
440 SV* const name = MOUSE_av_at(methods, i);
443 if(!find_method_pvn(mystash, SvPVX(name), SvCUR(name))){
457 PUSHs(sv_mortalcopy(name));
460 call_method("can", G_SCALAR);
479 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
482 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
485 xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
486 CvXSUBANY(xsub).any_ptr = sv_magicext(
488 param, /* mg_obj: refcnt will be increased */
490 &mouse_util_type_constraints_vtbl,
491 (char*)fptr, /* mg_ptr */
492 0 /* mg_len: 0 for static data */
496 sv_2mortal((SV*)xsub);
503 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
505 const char* klass_pv = SvPV_const(klass, klass_len);
509 klass_pv = mouse_canonicalize_package_name(klass_pv);
511 if(strNE(klass_pv, "UNIVERSAL")){
512 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
513 fptr = (check_fptr_t)mouse_is_an_instance_of;
518 fptr = (check_fptr_t)mouse_is_an_instance_of_universal;
521 return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
525 mouse_generate_can_predicate_for(pTHX_ SV* const methods, const char* const predicate_name){
527 AV* const param = newAV_mortal();
532 if(!IsArrayRef(methods)){
533 croak("You must pass an ARRAY ref method names");
535 av = (AV*)SvRV(methods);
537 len = av_len(av) + 1;
538 for(i = 0; i < len; i++){
539 SV* const name = *av_fetch(av, i, TRUE);
541 const char* const pv = SvPV_const(name, pvlen);
543 av_push(param, newSVpvn_share(pv, pvlen, 0U));
546 return mouse_tc_generate(aTHX_ predicate_name, (check_fptr_t)mouse_can_methods, (SV*)param);
550 XS(XS_Mouse_constraint_check) {
553 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
556 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, ST(0)) );
565 setup_my_cxt(pTHX_ pMY_CXT){
566 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
567 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
569 MY_CXT.universal_can = gv_fetchpvs("UNIVERSAL::can", GV_ADD, SVt_PVCV);
570 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_can);
573 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
575 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
578 VERSIONCHECK: DISABLE
583 setup_my_cxt(aTHX_ aMY_CXT);
585 /* setup built-in type constraints */
595 DEFINE_TC(ScalarRef);
600 DEFINE_TC(FileHandle);
601 DEFINE_TC(RegexpRef);
603 DEFINE_TC(ClassName);
614 setup_my_cxt(aTHX_ aMY_CXT);
615 PERL_UNUSED_VAR(items);
618 #endif /* !USE_ITHREADS */
620 #define MOUSE_TC_MAYBE 0
621 #define MOUSE_TC_ARRAY_REF 1
622 #define MOUSE_TC_HASH_REF 2
625 _parameterize_ArrayRef_for(SV* param)
627 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
628 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
629 _parameterize_Maybe_for = MOUSE_TC_MAYBE
633 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
634 if(!IsCodeRef(tc_code)){
635 croak("_compiled_type_constraint didn't return a CODE reference");
639 case MOUSE_TC_ARRAY_REF:
640 fptr = mouse_parameterized_ArrayRef;
642 case MOUSE_TC_HASH_REF:
643 fptr = mouse_parameterized_HashRef;
645 default: /* Maybe type */
646 fptr = mouse_parameterized_Maybe;
648 RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
653 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
656 INSTALL_SIMPLE_READER(TypeConstraint, name);
657 INSTALL_SIMPLE_READER(TypeConstraint, parent);
658 INSTALL_SIMPLE_READER(TypeConstraint, message);
660 INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
661 INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
663 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
666 compile_type_constraint(SV* self)
669 AV* const checks = newAV_mortal();
670 SV* check; /* check function */
674 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
675 check = get_slots(parent, "hand_optimized_type_constraint");
676 if(check && SvOK(check)){
677 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
678 croak("Not a CODE reference");
680 av_unshift(checks, 1);
681 av_store(checks, 0, newSVsv(check));
682 break; /* a hand optimized constraint must include all the parent */
685 check = get_slots(parent, "constraint");
686 if(check && SvOK(check)){
687 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
688 croak("Not a CODE reference");
690 av_unshift(checks, 1);
691 av_store(checks, 0, newSVsv(check));
695 check = get_slots(self, "constraint");
696 if(check && SvOK(check)){
697 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
698 croak("Not a CODE reference");
700 av_push(checks, newSVsv(check));
703 types_ref = get_slots(self, "type_constraints");
704 if(types_ref && SvOK(types_ref)){ /* union type */
711 if(!IsArrayRef(types_ref)){
712 croak("Not an ARRAY reference");
714 types = (AV*)SvRV(types_ref);
715 len = av_len(types) + 1;
717 union_checks = newAV_mortal();
719 for(i = 0; i < len; i++){
720 SV* const tc = *av_fetch(types, i, TRUE);
721 SV* const c = get_slots(tc, "compiled_type_constraint");
722 if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
724 croak("'%"SVf"' has no compiled type constraint", self);
726 av_push(union_checks, newSVsv(c));
729 union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
730 av_push(checks, newRV_inc((SV*)union_check));
733 if(AvFILLp(checks) < 0){
734 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
737 check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
739 set_slots(self, "compiled_type_constraint", check);