Generalize type constraint generation
[gitmo/Mouse.git] / xs-src / MouseTypeConstraints.xs
index 60fa4c4..225e1fe 100644 (file)
 #define SvRXOK(sv) (SvROK(sv) && SvMAGICAL(SvRV(sv)) && mg_find(SvRV(sv), PERL_MAGIC_qr))
 #endif
 
+typedef int (*check_fptr_t)(pTHX_ SV* const data, SV* const sv);
+
 int
 mouse_tc_check(pTHX_ SV* const tc_code, SV* const sv) {
-    if(SvIOK(tc_code)){ /* built-in type constraints */
-        return mouse_builtin_tc_check(aTHX_ SvIVX(tc_code), sv);
+    CV* const cv = (CV*)SvRV(tc_code);
+    assert(SvTYPE(cv) == SVt_PVCV);
+
+    if(CvXSUB(cv) == XS_Mouse_constraint_check){ /* built-in type constraints */
+        MAGIC* const mg = (MAGIC*)CvXSUBANY(cv).any_ptr;
+
+        assert(CvXSUBANY(cv).any_ptr != NULL);
+        assert(mg->mg_ptr            != NULL);
+
+        /* call the check function directly, skipping call_sv() */
+        return CALL_FPTR((check_fptr_t)mg->mg_ptr)(aTHX_ mg->mg_obj, sv);
     }
-    else {
+    else { /* custom */
         int ok;
         dSP;
 
@@ -43,99 +54,67 @@ mouse_tc_check(pTHX_ SV* const tc_code, SV* const sv) {
     }
 }
 
-int
-mouse_builtin_tc_check(pTHX_ mouse_tc const tc, SV* const sv) {
-    switch(tc){
-    case MOUSE_TC_ANY:        return mouse_tc_Any(aTHX_ sv);
-    case MOUSE_TC_ITEM:       return mouse_tc_Any(aTHX_ sv);
-    case MOUSE_TC_UNDEF:      return mouse_tc_Undef(aTHX_ sv);
-    case MOUSE_TC_DEFINED:    return mouse_tc_Defined(aTHX_ sv);
-    case MOUSE_TC_BOOL:       return mouse_tc_Bool(aTHX_ sv);
-    case MOUSE_TC_VALUE:      return mouse_tc_Value(aTHX_ sv);
-    case MOUSE_TC_REF:        return mouse_tc_Ref(aTHX_ sv);
-    case MOUSE_TC_STR:        return mouse_tc_Str(aTHX_ sv);
-    case MOUSE_TC_NUM:        return mouse_tc_Num(aTHX_ sv);
-    case MOUSE_TC_INT:        return mouse_tc_Int(aTHX_ sv);
-    case MOUSE_TC_SCALAR_REF: return mouse_tc_ScalarRef(aTHX_ sv);
-    case MOUSE_TC_ARRAY_REF:  return mouse_tc_ArrayRef(aTHX_ sv);
-    case MOUSE_TC_HASH_REF:   return mouse_tc_HashRef(aTHX_ sv);
-    case MOUSE_TC_CODE_REF:   return mouse_tc_CodeRef(aTHX_ sv);
-    case MOUSE_TC_GLOB_REF:   return mouse_tc_GlobRef(aTHX_ sv);
-    case MOUSE_TC_FILEHANDLE: return mouse_tc_FileHandle(aTHX_ sv);
-    case MOUSE_TC_REGEXP_REF: return mouse_tc_RegexpRef(aTHX_ sv);
-    case MOUSE_TC_OBJECT:     return mouse_tc_Object(aTHX_ sv);
-    case MOUSE_TC_CLASS_NAME: return mouse_tc_ClassName(aTHX_ sv);
-    case MOUSE_TC_ROLE_NAME:  return mouse_tc_RoleName(aTHX_ sv);
-    default:
-        /* custom type constraints */
-        NOOP;
-    }
-
-    croak("Custom type constraint is not yet implemented");
-    return FALSE; /* not reached */
-}
-
-
 /*
     The following type check functions return an integer, not a bool, to keep them simple,
     so if you assign these return value to bool variable, you must use "expr ? TRUE : FALSE".
 */
 
 int
-mouse_tc_Any(pTHX_ SV* const sv PERL_UNUSED_DECL) {
+mouse_tc_Any(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv PERL_UNUSED_DECL) {
     assert(sv);
     return TRUE;
 }
 
 int
-mouse_tc_Bool(pTHX_ SV* const sv) {
+mouse_tc_Bool(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
-    if(SvOK(sv)){
+
+    if(SvTRUE(sv)){
         if(SvIOKp(sv)){
-            return SvIVX(sv) == 1 || SvIVX(sv) == 0;
+            return SvIVX(sv) == 1;
         }
         else if(SvNOKp(sv)){
-            return SvNVX(sv) == 1.0 || SvNVX(sv) == 0.0;
+            return SvNVX(sv) == 1.0;
         }
-        else if(SvPOKp(sv)){ /* "" or "1" or "0" */
-            return SvCUR(sv) == 0
-                || ( SvCUR(sv) == 1 && ( SvPVX(sv)[0] == '1' || SvPVX(sv)[0] == '0' ) );
+        else if(SvPOKp(sv)){ /* "1" */
+            return SvCUR(sv) == 1 && SvPVX(sv)[0] == '1';
         }
         else{
             return FALSE;
         }
     }
     else{
+        /* false must be boolean */
         return TRUE;
     }
 }
 
 int
-mouse_tc_Undef(pTHX_ SV* const sv) {
+mouse_tc_Undef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return !SvOK(sv);
 }
 
 int
-mouse_tc_Defined(pTHX_ SV* const sv) {
+mouse_tc_Defined(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvOK(sv);
 }
 
 int
-mouse_tc_Value(pTHX_ SV* const sv) {
+mouse_tc_Value(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvOK(sv) && !SvROK(sv);
 }
 
 int
-mouse_tc_Num(pTHX_ SV* const sv) {
+mouse_tc_Num(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return LooksLikeNumber(sv);
 }
 
 int
-mouse_tc_Int(pTHX_ SV* const sv) {
+mouse_tc_Int(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     if(SvIOKp(sv)){
         return TRUE;
@@ -154,19 +133,19 @@ mouse_tc_Int(pTHX_ SV* const sv) {
 }
 
 int
-mouse_tc_Str(pTHX_ SV* const sv) {
+mouse_tc_Str(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvOK(sv) && !SvROK(sv) && !isGV(sv);
 }
 
 int
-mouse_tc_ClassName(pTHX_ SV* const sv){ 
+mouse_tc_ClassName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv){ 
     assert(sv);
     return is_class_loaded(sv);
 }
 
 int
-mouse_tc_RoleName(pTHX_ SV* const sv) {
+mouse_tc_RoleName(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     if(is_class_loaded(sv)){
         int ok;
@@ -184,7 +163,7 @@ mouse_tc_RoleName(pTHX_ SV* const sv) {
         meta = POPs;
         PUTBACK;
 
-        ok =  is_instance_of(meta, newSVpvs_flags("Mouse::Meta::Role", SVs_TEMP));
+        ok =  is_an_instance_of("Mouse::Meta::Role", meta);
 
         FREETMPS;
         LEAVE;
@@ -195,49 +174,49 @@ mouse_tc_RoleName(pTHX_ SV* const sv) {
 }
 
 int
-mouse_tc_Ref(pTHX_ SV* const sv) {
+mouse_tc_Ref(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv);
 }
 
 int
-mouse_tc_ScalarRef(pTHX_ SV* const sv) {
+mouse_tc_ScalarRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv) && !SvOBJECT(SvRV(sv)) && (SvTYPE(SvRV(sv)) <= SVt_PVLV && !isGV(SvRV(sv)));
 }
 
 int
-mouse_tc_ArrayRef(pTHX_ SV* const sv) {
+mouse_tc_ArrayRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV;
 }
 
 int
-mouse_tc_HashRef(pTHX_ SV* const sv) {
+mouse_tc_HashRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV;
 }
 
 int
-mouse_tc_CodeRef(pTHX_ SV* const sv) {
+mouse_tc_CodeRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv)  && !SvOBJECT(SvRV(sv))&& SvTYPE(SvRV(sv)) == SVt_PVCV;
 }
 
 int
-mouse_tc_RegexpRef(pTHX_ SV* const sv) {
+mouse_tc_RegexpRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvRXOK(sv);
 }
 
 int
-mouse_tc_GlobRef(pTHX_ SV* const sv) {
+mouse_tc_GlobRef(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv) && !SvOBJECT(SvRV(sv)) && isGV(SvRV(sv));
 }
 
 int
-mouse_tc_FileHandle(pTHX_ SV* const sv) {
+mouse_tc_FileHandle(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     GV* gv;
     assert(sv);
 
@@ -252,15 +231,97 @@ mouse_tc_FileHandle(pTHX_ SV* const sv) {
         }
     }
 
-    return is_instance_of(sv, newSVpvs_flags("IO::Handle", SVs_TEMP));
+    return is_an_instance_of("IO::Handle", sv);
 }
 
 int
-mouse_tc_Object(pTHX_ SV* const sv) {
+mouse_tc_Object(pTHX_ SV* const data PERL_UNUSED_DECL, SV* const sv) {
     assert(sv);
     return SvROK(sv) && SvOBJECT(SvRV(sv)) && !SvRXOK(sv);
 }
 
+/* Parameterized type constraints */
+
+static int
+mouse_parameterized_ArrayRef(pTHX_ SV* const param, SV* const sv) {
+    if(mouse_tc_ArrayRef(aTHX_ NULL, sv)){
+        AV* const av  = (AV*)SvRV(sv);
+        I32 const len = av_len(av) + 1;
+        I32 i;
+        for(i = 0; i < len; i++){
+            SV* const value = *av_fetch(av, i, TRUE);
+            SvGETMAGIC(value);
+            if(!mouse_tc_check(aTHX_ param, value)){
+                return FALSE;
+            }
+        }
+        return TRUE;
+    }
+    return FALSE;
+}
+
+static int
+mouse_parameterized_HashRef(pTHX_ SV* const param, SV* const sv) {
+    if(mouse_tc_HashRef(aTHX_ NULL, sv)){
+        HV* const hv  = (HV*)SvRV(sv);
+        HE* he;
+
+        hv_iterinit(hv);
+        while((he = hv_iternext(hv))){
+            SV* const value = hv_iterval(hv, he);
+            SvGETMAGIC(value);
+            if(!mouse_tc_check(aTHX_ param, value)){
+                return FALSE;
+            }
+        }
+        return TRUE;
+    }
+    return FALSE;
+}
+
+static int
+mouse_parameterized_Maybe(pTHX_ SV* const param, SV* const sv) {
+    if(SvOK(sv)){
+        return mouse_tc_check(aTHX_ param, sv);
+    }
+    return TRUE;
+}
+
+static int
+mouse_types_union_check(pTHX_ AV* const types, SV* const sv) {
+    I32 const len = AvFILLp(types) + 1;
+    I32 i;
+
+    for(i = 0; i < len; i++){
+        if(mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
+            return TRUE;
+        }
+    }
+
+    return FALSE;
+}
+
+static int
+mouse_types_check(pTHX_ AV* const types, SV* const sv) {
+    I32 const len = AvFILLp(types) + 1;
+    I32 i;
+
+    ENTER;
+    SAVE_DEFSV;
+    DEFSV_set(sv);
+
+    for(i = 0; i < len; i++){
+        if(!mouse_tc_check(aTHX_ AvARRAY(types)[i], sv)){
+            LEAVE;
+            return FALSE;
+        }
+    }
+
+    LEAVE;
+
+    return TRUE;
+}
+
 /*
  *  This class_type generator is taken from Scalar::Util::Instance
  */
@@ -312,7 +373,7 @@ mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance){
     assert(stash);
     assert(SvTYPE(stash) == SVt_PVHV);
 
-    if(SvROK(instance) && SvOBJECT(SvRV(instance))){
+    if(IsObject(instance)){
         dMY_CXT;
         HV* const instance_stash = SvSTASH(SvRV(instance));
         GV* const instance_isa   = gv_fetchmeth_autoload(instance_stash, "isa", sizeof("isa")-1, 0);
@@ -361,52 +422,56 @@ mouse_is_an_instance_of_universal(pTHX_ SV* const data, SV* const sv){
 
 static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
 
-CV*
-generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
-    STRLEN klass_len;
-    const char* klass_pv = SvPV_const(klass, klass_len);
+static CV*
+mouse_tc_generate(pTHX_ const char* const name, check_fptr_t const fptr, SV* const param) {
     CV* xsub;
-    SV*   mg_obj;
-    void* mg_ptr;
-
-    klass_pv = mouse_canonicalize_package_name(klass_pv);
-
-    if(strNE(klass_pv, "UNIVERSAL")){
-        mg_obj = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
-        mg_ptr = (void*)mouse_is_an_instance_of;
-
-    }
-    else{
-        mg_obj = NULL;
-        mg_ptr = (void*)mouse_is_an_instance_of_universal;
-    }
-
-    xsub = newXS(predicate_name, XS_Mouse_parameterized_check, __FILE__);
 
+    xsub = newXS(name, XS_Mouse_constraint_check, __FILE__);
     CvXSUBANY(xsub).any_ptr = sv_magicext(
         (SV*)xsub,
-        mg_obj,
+        param,       /* mg_obj: refcnt will be increased */
         PERL_MAGIC_ext,
         &mouse_util_type_constraints_vtbl,
-        mg_ptr,
-        0   /* indicates static data */
+        (void*)fptr, /* mg_ptr */
+        0            /* mg_len: 0 for static data */
     );
 
-    if(!predicate_name){
+    if(!name){
         sv_2mortal((SV*)xsub);
     }
 
     return xsub;
 }
 
-XS(XS_Mouse_parameterized_check) {
+CV*
+mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name){
+    STRLEN klass_len;
+    const char* klass_pv = SvPV_const(klass, klass_len);
+    SV*   param;
+    void* fptr;
+
+    klass_pv = mouse_canonicalize_package_name(klass_pv);
+
+    if(strNE(klass_pv, "UNIVERSAL")){
+        param = (SV*)gv_stashpvn(klass_pv, klass_len, GV_ADD);
+        fptr = (void*)mouse_is_an_instance_of;
+
+    }
+    else{
+        param = NULL;
+        fptr = (void*)mouse_is_an_instance_of_universal;
+    }
+
+    return mouse_tc_generate(aTHX_ predicate_name, fptr, param);
+}
+
+XS(XS_Mouse_constraint_check) {
     dVAR;
     dXSARGS;
     MAGIC* const mg = (MAGIC*)XSANY.any_ptr;
-    typedef int (*check_fptr_t)(pTHX_ SV* const data, SV* const sv);
 
     if(items < 1){
-        croak("Too few arguments for parameterized check functions");
+        croak("Too few arguments for type constraint check functions");
     }
 
     SvGETMAGIC( ST(0) );
@@ -420,6 +485,8 @@ setup_my_cxt(pTHX_ pMY_CXT){
     SvREFCNT_inc_simple_void_NN(MY_CXT.universal_isa);
 }
 
+#define DEFINE_TC(name) mouse_tc_generate(aTHX_ "Mouse::Util::TypeConstraints::" STRINGIFY(name), CAT2(mouse_tc_, name), NULL)
+
 MODULE = Mouse::Util::TypeConstraints    PACKAGE = Mouse::Util::TypeConstraints
 
 PROTOTYPES:   DISABLE
@@ -429,6 +496,27 @@ BOOT:
 {
     MY_CXT_INIT;
     setup_my_cxt(aTHX_ aMY_CXT);
+
+    /* setup built-in type constraints */
+    DEFINE_TC(Any);
+    DEFINE_TC(Undef);
+    DEFINE_TC(Defined);
+    DEFINE_TC(Bool);
+    DEFINE_TC(Value);
+    DEFINE_TC(Ref);
+    DEFINE_TC(Str);
+    DEFINE_TC(Num);
+    DEFINE_TC(Int);
+    DEFINE_TC(ScalarRef);
+    DEFINE_TC(ArrayRef);
+    DEFINE_TC(HashRef);
+    DEFINE_TC(CodeRef);
+    DEFINE_TC(GlobRef);
+    DEFINE_TC(FileHandle);
+    DEFINE_TC(RegexpRef);
+    DEFINE_TC(Object);
+    DEFINE_TC(ClassName);
+    DEFINE_TC(RoleName);
 }
 
 #ifdef USE_ITHREADS
@@ -444,32 +532,118 @@ CODE:
 
 #endif /* !USE_ITHREADS */
 
-void
-Item(SV* sv = &PL_sv_undef)
+#define MOUSE_TC_MAYBE     0
+#define MOUSE_TC_ARRAY_REF 1
+#define MOUSE_TC_HASH_REF  2
+
+CV*
+_parameterize_ArrayRef_for(SV* param)
 ALIAS:
-    Any        = MOUSE_TC_ANY
-    Item       = MOUSE_TC_ITEM
-    Undef      = MOUSE_TC_UNDEF
-    Defined    = MOUSE_TC_DEFINED
-    Bool       = MOUSE_TC_BOOL
-    Value      = MOUSE_TC_VALUE
-    Ref        = MOUSE_TC_REF
-    Str        = MOUSE_TC_STR
-    Num        = MOUSE_TC_NUM
-    Int        = MOUSE_TC_INT
-    ScalarRef  = MOUSE_TC_SCALAR_REF
-    ArrayRef   = MOUSE_TC_ARRAY_REF
-    HashRef    = MOUSE_TC_HASH_REF
-    CodeRef    = MOUSE_TC_CODE_REF
-    GlobRef    = MOUSE_TC_GLOB_REF
-    FileHandle = MOUSE_TC_FILEHANDLE
-    RegexpRef  = MOUSE_TC_REGEXP_REF
-    Object     = MOUSE_TC_OBJECT
-    ClassName  = MOUSE_TC_CLASS_NAME
-    RoleName   = MOUSE_TC_ROLE_NAME
+    _parameterize_ArrayRef_for = MOUSE_TC_ARRAY_REF
+    _parameterize_HashRef_for  = MOUSE_TC_HASH_REF
+    _parameterize_Maybe_for    = MOUSE_TC_MAYBE
 CODE:
-    SvGETMAGIC(sv);
-    ST(0) = boolSV( mouse_builtin_tc_check(aTHX_ ix, sv) );
-    XSRETURN(1);
+{
+    check_fptr_t fptr;
+    SV* const tc_code = mcall0s(param, "_compiled_type_constraint");
+    if(!(SvROK(tc_code) && SvTYPE(SvRV(tc_code)) == SVt_PVCV)){
+        croak("_compiled_type_constraint didn't return a CODE reference");
+    }
+
+    switch(ix){
+    case MOUSE_TC_ARRAY_REF:
+        fptr = mouse_parameterized_ArrayRef;
+        break;
+    case MOUSE_TC_HASH_REF:
+        fptr = mouse_parameterized_HashRef;
+        break;
+    default: /* Maybe type */
+        fptr = mouse_parameterized_Maybe;
+    }
+    RETVAL = mouse_tc_generate(aTHX_ NULL, fptr, tc_code);
+}
+OUTPUT:
+    RETVAL
+
+MODULE = Mouse::Util::TypeConstraints    PACKAGE = Mouse::Meta::TypeConstraint
+
+void
+compile_type_constraint(SV* self)
+CODE:
+{
+    AV* const checks = newAV();
+    SV* check; /* check function */
+    SV* parent;
+    SV* types_ref;
+
+    sv_2mortal((SV*)checks);
+
+    for(parent = get_slots(self, "parent"); parent; parent = get_slots(parent, "parent")){
+        check = get_slots(parent, "hand_optimized_type_constraint");
+        if(check && SvOK(check)){
+            if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
+                croak("Not a CODE reference");
+            }
+            av_unshift(checks, 1);
+            av_store(checks, 0, newSVsv(check));
+            break; /* a hand optimized constraint must include all the parent */
+        }
+
+        check = get_slots(parent, "constraint");
+        if(check && SvOK(check)){
+            if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
+                croak("Not a CODE reference");
+            }
+            av_unshift(checks, 1);
+            av_store(checks, 0, newSVsv(check));
+        }
+    }
+
+    check = get_slots(self, "constraint");
+    if(check && SvOK(check)){
+        if(!mouse_tc_CodeRef(aTHX_ NULL, check)){
+            croak("Not a CODE reference");
+        }
+        av_push(checks, newSVsv(check));
+    }
+
+    types_ref = get_slots(self, "type_constraints");
+    if(types_ref && SvOK(types_ref)){ /* union type */
+        AV* types;
+        AV* union_checks;
+        CV* union_check;
+        I32 len;
+        I32 i;
+
+        if(!mouse_tc_ArrayRef(aTHX_ NULL, types_ref)){
+            croak("Not an ARRAY reference");
+        }
+        types = (AV*)SvRV(types_ref);
+        len = av_len(types) + 1;
+
+        union_checks = newAV();
+        sv_2mortal((SV*)union_checks);
+
+        for(i = 0; i < len; i++){
+            SV* const tc = *av_fetch(types, i, TRUE);
+            SV* const c  = get_slots(tc, "compiled_type_constraint");
+            if(!(c && mouse_tc_CodeRef(aTHX_ NULL, c))){
+                sv_dump(self);
+                croak("'%"SVf"' has no compiled type constraint", self);
+            }
+            av_push(union_checks, newSVsv(c));
+        }
+
+        union_check = mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_union_check, (SV*)union_checks);
+        av_push(checks, newRV_inc((SV*)union_check));
+    }
 
+    if(AvFILLp(checks) < 0){
+        check = newRV_inc((SV*)get_cv("Mouse::Util::TypeConstraints::Any", TRUE));
+    }
+    else{
+        check = newRV_inc((SV*)mouse_tc_generate(aTHX_ NULL, (check_fptr_t)mouse_types_check, (SV*)checks));
+    }
+    set_slots(self, "compiled_type_constraint", check);
+}