add strict_constructor => Bool optin to make_immutable (EXPERIMENTAL)

[gitmo/Mouse.git] / xs-src / Mouse.xs

diff --git a/xs-src/Mouse.xs b/xs-src/Mouse.xs
index 0a94ec8..cea3275 100644 (file)
--- a/xs-src/Mouse.xs
+++ b/xs-src/Mouse.xs
@@ -20,6 +20,9 @@ enum mouse_xc_flags_t {
     MOUSEf_XC_IS_ANON        = 0x0002,
     MOUSEf_XC_HAS_BUILDARGS  = 0x0004,
 
+    MOUSEf_XC_HAS_STRICT_CONSTRUCTOR
+                             = 0x0008,
+
     MOUSEf_XC_mask           = 0xFFFF /* not used */
 };
 
@@ -113,6 +116,10 @@ mouse_class_update_xc(pTHX_ SV* const metaclass PERL_UNUSED_DECL, HV* const stas
         flags |= MOUSEf_XC_HAS_BUILDARGS;
     }
 
+    if(predicate_calls(metaclass, "_has_strict_constructor")){
+        flags |= MOUSEf_XC_HAS_STRICT_CONSTRUCTOR;
+    }
+
     av_store(xc, MOUSE_XC_FLAGS,       newSVuv(flags));
     av_store(xc, MOUSE_XC_ATTRALL,     (SV*)attrall);
     av_store(xc, MOUSE_XC_BUILDALL,    (SV*)buildall);
@@ -238,11 +245,38 @@ mouse_buildargs(pTHX_ SV* metaclass, SV* const klass, I32 ax, I32 items) {
 }
 
 static void
+mouse_report_unmatched_keys(pTHX_ SV* const meta, AV* const attrs, HV* const args) {
+    HV* const attr_map = newHV_mortal();
+    I32 const len      = AvFILLp(attrs) + 1;
+    I32 i;
+    SV* const unknown = newSVpvs_flags("", SVs_TEMP);
+    HE* he;
+
+    for(i = 0; i < len; i++){
+        SV* const attr = MOUSE_av_at(attrs, i);
+        (void)hv_store_ent(attr_map, mcall0(attr, mouse_name), &PL_sv_yes, 0U);
+    }
+
+    hv_iterinit(args);
+    while((he = hv_iternext(args))){
+        SV* const key = hv_iterkeysv(he);
+        if(!hv_exists_ent(attr_map, key, 0U)){
+            sv_catpvf(unknown, " %"SVf",", key);
+        }
+    }
+    SvCUR(unknown)--; /* chop "," */
+    mouse_throw_error(meta, NULL,
+        "Unknown attribute init_arg passed to the constructor of %"SVf": %"SVf,
+        mcall0(meta, mouse_name), unknown);
+}
+
+static void
 mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const args, bool const ignore_triggers) {
     AV* const xc    = mouse_get_xc(aTHX_ meta);
     AV* const attrs = MOUSE_xc_attrall(xc);
     I32 len         = AvFILLp(attrs) + 1;
     I32 i;
+    I32 used = 0;
     AV* triggers_queue = NULL;
 
     assert(meta || object);
@@ -281,6 +315,8 @@ mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const
 
                 av_push(triggers_queue, (SV*)pair);
             }
+
+            used++;
         }
         else { /* no init arg */
             if(flags & (MOUSEf_ATTR_HAS_DEFAULT | MOUSEf_ATTR_HAS_BUILDER)){
@@ -305,6 +341,10 @@ mouse_class_initialize_object(pTHX_ SV* const meta, SV* const object, HV* const
         }
     }
 
+    if(MOUSE_xc_flags(xc) & MOUSEf_XC_HAS_STRICT_CONSTRUCTOR && used < HvUSEDKEYS(args)){
+        mouse_report_unmatched_keys(aTHX_ meta, attrs, args);
+    }
+
     if(MOUSE_xc_flags(xc) & MOUSEf_XC_IS_ANON){
         set_slot(object, newSVpvs_flags("__METACLASS__", SVs_TEMP), meta);
     }
@@ -335,6 +375,24 @@ mouse_initialize_metaclass(pTHX_ SV* const klass) {
     return meta;
 }
 
+static void
+mouse_buildall(pTHX_ AV* const xc, SV* const object, SV* const args) {
+    AV* const buildall = MOUSE_xc_buildall(xc);
+    I32 const len      = AvFILLp(buildall) + 1;
+    I32 i;
+    for(i = 0; i < len; i++){
+        dSP;
+
+        PUSHMARK(SP);
+        EXTEND(SP, 2);
+        PUSHs(object);
+        PUSHs(args);
+        PUTBACK;
+
+        call_sv(AvARRAY(buildall)[i], G_VOID | G_DISCARD);
+    }
+}
+
 MODULE = Mouse  PACKAGE = Mouse
 
 PROTOTYPES: DISABLE
@@ -436,6 +494,8 @@ MODULE = Mouse  PACKAGE = Mouse::Meta::Class
 BOOT:
     INSTALL_SIMPLE_READER(Class, roles);
     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
+    INSTALL_SIMPLE_READER(Class, is_immutable);
+    INSTALL_SIMPLE_READER_WITH_KEY(Class, has_strict_constructor, _strict_constructor);
 
     INSTALL_CLASS_HOLDER(Class, method_metaclass,     "Mouse::Meta::Method");
     INSTALL_CLASS_HOLDER(Class, attribute_metaclass,  "Mouse::Meta::Attribute");
@@ -520,11 +580,10 @@ CODE:
     AV* const xc   = mouse_get_xc(aTHX_ meta);
     UV const flags = MOUSE_xc_flags(xc);
     SV* args;
-    AV* buildall;
-    I32 len, i;
 
     /* BUILDARGS */
     if(flags & MOUSEf_XC_HAS_BUILDARGS){
+        I32 i;
         SPAGAIN;
 
         PUSHMARK(SP);
@@ -552,32 +611,24 @@ CODE:
     RETVAL = mouse_instance_create(aTHX_ MOUSE_xc_stash(xc));
     mouse_class_initialize_object(aTHX_ meta, RETVAL, (HV*)SvRV(args), FALSE);
 
-    /* BUILDALL */
-    buildall = MOUSE_xc_buildall(xc);
-    len      = AvFILLp(buildall) + 1;
-    for(i = 0; i < len; i++){
-        dSP;
-
-        PUSHMARK(SP);
-        EXTEND(SP, 2);
-        PUSHs(RETVAL); /* self */
-        PUSHs(args);
-        PUTBACK;
-
-        call_sv(AvARRAY(buildall)[i], G_VOID | G_DISCARD);
-    }
+    mouse_buildall(aTHX_ xc, RETVAL, args);
 }
 OUTPUT:
     RETVAL
 
 void
 DESTROY(SV* object)
+ALIAS:
+    DESTROY     = 0
+    DEMOLISHALL = 1
 CODE:
 {
     SV* const meta = get_metaclass(object);
     AV* demolishall;
     I32 len, i;
 
+    PERL_UNUSED_VAR(ix);
+
     if(!IsObject(object)){
         croak("You must not call DESTROY as a class method");
     }
@@ -587,7 +638,7 @@ CODE:
 
         demolishall = MOUSE_xc_demolishall(xc);
     }
-    else {
+    else { /* The metaclass is already destroyed */
         AV* const linearized_isa = mro_get_linear_isa(SvSTASH(SvRV(object)));
 
         len = AvFILLp(linearized_isa) + 1;
@@ -603,17 +654,16 @@ CODE:
         }
     }
 
-    /* DEMOLISHALL */
     len      = AvFILLp(demolishall) + 1;
     if(len > 0){
         GV* const statusvalue = gv_fetchpvs("?", 0, SVt_PV);
         SAVESPTR(GvSV(statusvalue)); /* local $? */
         SAVESPTR(ERRSV); /* local $@ */
 
-        GvSV(statusvalue) = sv_2mortal(newSViv(0));
-        ERRSV             = sv_2mortal(newSVpvs(""));
+        GvSV(statusvalue) = sv_newmortal();
+        ERRSV             = newSVpvs_flags("", SVs_TEMP);
         for(i = 0; i < len; i++){
-            dSP;
+            SPAGAIN;
 
             PUSHMARK(SP);
             XPUSHs(object);
@@ -644,3 +694,18 @@ OUTPUT:
     RETVAL
 
 
+void
+BUILDALL(SV* self, SV* args)
+CODE:
+{
+    SV* const meta = get_metaclass(self);
+    AV* const xc   = mouse_get_xc(aTHX_ meta);
+
+    if(!IsHashRef(args)){
+        croak("You must pass a HASH reference to BUILDALL");
+    }
+    if(mg_find(SvRV(args), PERL_MAGIC_tied)){
+        croak("You cannot use tie HASH reference as args");
+    }
+    mouse_buildall(aTHX_ xc, self, args);
+}