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 /* false 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)){
161 call_pv("Mouse::Util::get_metaclass_by_name", G_SCALAR);
166 ok = is_an_instance_of("Mouse::Meta::Role", meta);
177 mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
183 mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
185 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && (SvTYPE(SvRV(sv)) <= SVt_PVLV && !isGV(SvRV(sv)));
189 mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
191 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV;
195 mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
197 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV;
201 mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
203 return SvROK(sv) && !SvOBJECT(SvRV(sv))&& SvTYPE(SvRV(sv)) == SVt_PVCV;
207 mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
213 mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
215 return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
219 mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
223 /* see pp_fileno() in pp_sys.c and Scalar::Util::openhandle() */
225 gv = (GV*)(SvROK(sv) ? SvRV(sv) : sv);
226 if(isGV(gv) || SvTYPE(gv) == SVt_PVIO){
227 IO* const io = isGV(gv) ? GvIO(gv) : (IO*)gv;
229 if(io && ( IoIFP(io) || SvTIED_mg((SV*)io, PERL_MAGIC_tiedscalar) )){
234 return is_an_instance_of("IO::Handle", sv);
238 mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
240 return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
243 /* Parameterized type constraints */
246 mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
247 if(mouse_tc_ArrayRef(aTHX_ NULL, sv)){
248 AV* const av = (AV*)SvRV(sv);
249 I32 const len = av_len(av) + 1;
251 for(i = 0; i < len; i++){
252 SV* const value = *av_fetch(av, i, TRUE);
254 if(!mouse_tc_check(aTHX_ param, value)){
264 mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
265 if(mouse_tc_HashRef(aTHX_ NULL, sv)){
266 HV* const hv = (HV*)SvRV(sv);
270 while((he = hv_iternext(hv))){
271 SV* const value = hv_iterval(hv, he);
273 if(!mouse_tc_check(aTHX_ param, value)){
283 mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
285 return mouse_tc_check(aTHX_ param, sv);
291 mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
292 I32 const len = AvFILLp(types) + 1;
295 for(i = 0; i < len; i++){
296 if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
305 mouse_types_check(pTHX_ AV* const types, SV* const sv) {
306 I32 const len = AvFILLp(types) + 1;
313 for(i = 0; i < len; i++){
314 if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
326 * This class_type generator is taken from Scalar::Util::Instance
329 #define MY_CXT_KEY "Mouse::Util::TypeConstraints::_guts" XS_VERSION
330 typedef struct sui_cxt{
335 #define MG_klass_stash(mg) ((HV*)(mg)->mg_obj)
336 #define MG_klass_pv(mg) ((mg)->mg_ptr)
337 #define MG_klass_len(mg) ((mg)->mg_len)
340 mouse_canonicalize_package_name(const char* name){
342 /* "::Foo" -> "Foo" */
343 if(name[0] == ':' && name[1] == ':'){
347 /* "main::main::main::Foo" -> "Foo" */
348 while(strnEQ(name, "main::", sizeof("main::")-1)){
349 name += sizeof("main::")-1;
356 mouse_lookup_isa(pTHX_ HV* const instance_stash, const char* const klass_pv){
357 AV* const linearized_isa = mro_get_linear_isa(instance_stash);
358 SV** svp = AvARRAY(linearized_isa);
359 SV** const end = svp + AvFILLp(linearized_isa) + 1;
363 if(strEQ(klass_pv, mouse_canonicalize_package_name(SvPVX(*svp)))){
372 mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
374 assert(SvTYPE(stash) == SVt_PVHV);
376 if(IsObject(instance)){
378 HV* const instance_stash = SvSTASH(SvRV(instance));
379 GV* const instance_isa = gv_fetchmeth_autoload(instance_stash, "isa", sizeof("isa")-1, 0);
381 /* the instance has no own isa method */
382 if(instance_isa == NULL || GvCV(instance_isa) == GvCV(MY_CXT.universal_isa)){
383 return stash == instance_stash
384 || mouse_lookup_isa(aTHX_ instance_stash, HvNAME_get(stash));
386 /* the instance has its own isa method */
397 mPUSHp(HvNAME_get(stash), HvNAMELEN_get(stash));
400 call_sv((SV*)instance_isa, G_SCALAR);
404 retval = SvTRUEx(POPs);
418 mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
419 PERL_UNUSED_ARG(data);
420 return SvROK(sv) && SvOBJECT(SvRV(sv));
423 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
426 mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
429 xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
430 CvXSUBANY(xsub).any_ptr = sv_magicext(
432 param, /* mg_obj: refcnt will be increased */
434 &mouse_util_type_constraints_vtbl,
435 (void*)fptr, /* mg_ptr */
436 0 /* mg_len: 0 for static data */
440 sv_2mortal((SV*)xsub);
447 mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
449 const char* klass_pv = SvPV_const(klass, klass_len);
453 klass_pv = mouse_canonicalize_package_name(klass_pv);
455 if(strNE(klass_pv, "UNIVERSAL")){
456 param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
457 fptr = (void*)mouse_is_an_instance_of;
462 fptr = (void*)mouse_is_an_instance_of_universal;
465 return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
468 XS(XS_Mouse_constraint_check) {
471 MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
474 croak("Too few arguments for type constraint check functions");
478 ST(0) = boolSV( CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, ST(0)) );
483 setup_my_cxt(pTHX_ pMY_CXT){
484 MY_CXT.universal_isa = gv_fetchpvs("UNIVERSAL::isa", GV_ADD, SVt_PVCV);
485 SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
488 #define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
490 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Util::TypeConstraints
493 VERSIONCHECK: DISABLE
498 setup_my_cxt(aTHX_ aMY_CXT);
500 /* setup built-in type constraints */
510 DEFINE_TC(ScalarRef);
515 DEFINE_TC(FileHandle);
516 DEFINE_TC(RegexpRef);
518 DEFINE_TC(ClassName);
529 setup_my_cxt(aTHX_ aMY_CXT);
530 PERL_UNUSED_VAR(items);
533 #endif /* !USE_ITHREADS */
535 #define MOUSE_TC_MAYBE 0
536 #define MOUSE_TC_ARRAY_REF 1
537 #define MOUSE_TC_HASH_REF 2
540 _parameterize_ArrayRef_for(SV* param)
542 _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
543 _parameterize_HashRef_for = MOUSE_TC_HASH_REF
544 _parameterize_Maybe_for = MOUSE_TC_MAYBE
548 SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
549 if(!(SvROK(tc_code) && SvTYPE(SvRV(tc_code)) == SVt_PVCV)){
550 croak("_compiled_type_constraint didn't return a CODE reference");
554 case MOUSE_TC_ARRAY_REF:
555 fptr = mouse_parameterized_ArrayRef;
557 case MOUSE_TC_HASH_REF:
558 fptr = mouse_parameterized_HashRef;
560 default: /* Maybe type */
561 fptr = mouse_parameterized_Maybe;
563 RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
568 MODULE = Mouse::Util::TypeConstraints PACKAGE = Mouse::Meta::TypeConstraint
571 INSTALL_SIMPLE_READER(TypeConstraint, name);
572 INSTALL_SIMPLE_READER(TypeConstraint, parent);
573 INSTALL_SIMPLE_READER(TypeConstraint, message);
575 INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
576 INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
578 INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
581 compile_type_constraint(SV* self)
584 AV* const checks = newAV();
585 SV* check; /* check function */
589 sv_2mortal((SV*)checks);
591 for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
592 check = get_slots(parent, "hand_optimized_type_constraint");
593 if(check && SvOK(check)){
594 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
595 croak("Not a CODE reference");
597 av_unshift(checks, 1);
598 av_store(checks, 0, newSVsv(check));
599 break; /* a hand optimized constraint must include all the parent */
602 check = get_slots(parent, "constraint");
603 if(check && SvOK(check)){
604 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
605 croak("Not a CODE reference");
607 av_unshift(checks, 1);
608 av_store(checks, 0, newSVsv(check));
612 check = get_slots(self, "constraint");
613 if(check && SvOK(check)){
614 if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
615 croak("Not a CODE reference");
617 av_push(checks, newSVsv(check));
620 types_ref = get_slots(self, "type_constraints");
621 if(types_ref && SvOK(types_ref)){ /* union type */
628 if(!mouse_tc_ArrayRef(aTHX_ NULL, types_ref)){
629 croak("Not an ARRAY reference");
631 types = (AV*)SvRV(types_ref);
632 len = av_len(types) + 1;
634 union_checks = newAV();
635 sv_2mortal((SV*)union_checks);
637 for(i = 0; i < len; i++){
638 SV* const tc = *av_fetch(types, i, TRUE);
639 SV* const c = get_slots(tc, "compiled_type_constraint");
640 if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
642 croak("'%"SVf"' has no compiled type constraint", self);
644 av_push(union_checks, newSVsv(c));
647 union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
648 av_push(checks, newRV_inc((SV*)union_check));
651 if(AvFILLp(checks) < 0){
652 check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
655 check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
657 set_slots(self, "compiled_type_constraint", check);