Masked-mods

Squashed commit of the following:

commit f18eeab
Author: urob <978080+urob@users.noreply.github.com>
Date:   Thu Jul 28 15:59:55 2022 -0400

    Clean up expected test output

commit f05b251
Author: urob <978080+urob@users.noreply.github.com>
Date:   Thu Jul 28 09:32:43 2022 -0400

    Explicitly specify default masked_mods in test

    Just so that the test can be run on branches with different defaults

commit 278dc67
Author: urob <978080+urob@users.noreply.github.com>
Date:   Wed Jul 27 22:40:37 2022 -0400

    Document masked_mods limitation with hold-taps

commit 386b5d1
Author: urob <978080+urob@users.noreply.github.com>
Date:   Mon Jul 25 22:07:13 2022 -0400

    Update expected test output

    Explicit mods no longer clear implicit mods that are being held. See
    zmkfirmware#1114 (comment)
    for details

commit b4dad62
Author: urob <978080+urob@users.noreply.github.com>
Date:   Sun Jul 24 11:08:39 2022 -0400

    Explain how to fully disable masked_mods

commit 00a0235
Author: urob <978080+urob@users.noreply.github.com>
Date:   Sun Jul 24 11:05:44 2022 -0400

    Add mod-morph tests

commit bfba42f
Author: urob <978080+urob@users.noreply.github.com>
Date:   Sun Jul 24 02:17:34 2022 -0400

    Fix doc formatting

commit 67412ed
Author: urob <978080+urob@users.noreply.github.com>
Date:   Sun Jul 24 01:50:54 2022 -0400

    Fix clang-format

commit ebc127d
Author: urob <978080+urob@users.noreply.github.com>
Date:   Sun Jul 24 01:04:13 2022 -0400

    Update docs for mod-morph

commit 44297de
Author: urob <978080+urob@users.noreply.github.com>
Date:   Sun Jul 24 00:24:18 2022 -0400

    Set masked-mods to mods if unspecified

commit 7c647b0
Author: urob <978080+urob@users.noreply.github.com>
Date:   Mon Jul 18 20:31:24 2022 -0400

    Trigger-mods are unused

commit 4cf66a4
Author: urob <978080+urob@users.noreply.github.com>
Date:   Mon Jul 18 19:57:46 2022 -0400

    Don't mask implicit mods

commit 89dac4c
Author: Kostas Karachalios <vrinek@hey.com>
Date:   Tue Jun 28 09:43:02 2022 +0200

    Add some whitespace for clarity

commit e96f516
Merge: 2cac694 ef3eb33
Author: Kostas Karachalios <vrinek@hey.com>
Date:   Mon Jun 27 21:11:20 2022 +0200

    Merge remote-tracking branch 'origin/main' into masked-mod-morphs-untested

commit 2cac694
Author: Kostas Karachalios <vrinek@hey.com>
Date:   Thu Feb 3 19:00:03 2022 +0100

    feat(behaviors): Allow mod-morph to swallow mods

    Revert "fix(hid): Implicit mods on non-key page events"

    This reverts commit 6ef1e70.

    masked mods

    Unrevert "fix(hid): Implicit mods on non-key page events"

    Fix docs

    Lint code with clang-format

app/dts/bindings/behaviors/zmk,behavior-mod-morph.yaml

@@ -14,3 +14,6 @@ properties:
   mods:
     type: int
     required: true
+  masked_mods:
+    type: int
+    required: false

app/include/zmk/hid.h

@@ -227,6 +227,9 @@ int zmk_hid_unregister_mods(zmk_mod_flags_t explicit_modifiers);
 int zmk_hid_implicit_modifiers_press(zmk_mod_flags_t implicit_modifiers);
 int zmk_hid_implicit_modifiers_release();
 
+int zmk_hid_masked_modifiers_set(zmk_mod_flags_t masked_modifiers);
+int zmk_hid_masked_modifiers_clear();
+
 int zmk_hid_keyboard_press(zmk_key_t key);
 int zmk_hid_keyboard_release(zmk_key_t key);
 void zmk_hid_keyboard_clear();

app/src/behaviors/behavior_mod_morph.c

@@ -27,6 +27,7 @@ struct behavior_mod_morph_config {
     struct zmk_behavior_binding normal_binding;
     struct zmk_behavior_binding morph_binding;
     zmk_mod_flags_t mods;
+    zmk_mod_flags_t masked_mods;
 };
 
 struct behavior_mod_morph_data {
@@ -45,6 +46,7 @@ static int on_mod_morph_binding_pressed(struct zmk_behavior_binding *binding,
     }
 
     if (zmk_hid_get_explicit_mods() & cfg->mods) {
+        zmk_hid_masked_modifiers_set(cfg->masked_mods);
         data->pressed_binding = (struct zmk_behavior_binding *)&cfg->morph_binding;
     } else {
         data->pressed_binding = (struct zmk_behavior_binding *)&cfg->normal_binding;
@@ -64,6 +66,7 @@ static int on_mod_morph_binding_released(struct zmk_behavior_binding *binding,
 
     struct zmk_behavior_binding *pressed_binding = data->pressed_binding;
     data->pressed_binding = NULL;
+    zmk_hid_masked_modifiers_clear();
     return behavior_keymap_binding_released(pressed_binding, event);
 }
 
@@ -88,6 +91,8 @@ static int behavior_mod_morph_init(const struct device *dev) { return 0; }
         .normal_binding = _TRANSFORM_ENTRY(0, n),                                                  \
         .morph_binding = _TRANSFORM_ENTRY(1, n),                                                   \
         .mods = DT_INST_PROP(n, mods),                                                             \
+        .masked_mods = COND_CODE_0(DT_INST_NODE_HAS_PROP(n, masked_mods), (DT_INST_PROP(n, mods)), \
+                                   (DT_INST_PROP(n, masked_mods))),                                \
     };                                                                                             \
     static struct behavior_mod_morph_data behavior_mod_morph_data_##n = {};                        \
     DEVICE_DT_INST_DEFINE(n, behavior_mod_morph_init, NULL, &behavior_mod_morph_data_##n,          \

app/src/hid.c

@@ -23,10 +23,12 @@ static struct zmk_hid_mouse_report mouse_report = {
 // Only release the modifier if the count is 0.
 static int explicit_modifier_counts[8] = {0, 0, 0, 0, 0, 0, 0, 0};
 static zmk_mod_flags_t explicit_modifiers = 0;
+static zmk_mod_flags_t implicit_modifiers = 0;
+static zmk_mod_flags_t masked_modifiers = 0;
 
 #define SET_MODIFIERS(mods)                                                                        \
     {                                                                                              \
-        keyboard_report.body.modifiers = mods;                                                     \
+        keyboard_report.body.modifiers = (mods & ~masked_modifiers) | implicit_modifiers;          \
         LOG_DBG("Modifiers set to 0x%02X", keyboard_report.body.modifiers);                        \
     }
 
@@ -161,13 +163,29 @@ static inline int check_keyboard_usage(zmk_key_t usage) {
         }                                                                                          \
     }
 
-int zmk_hid_implicit_modifiers_press(zmk_mod_flags_t implicit_modifiers) {
+int zmk_hid_implicit_modifiers_press(zmk_mod_flags_t new_implicit_modifiers) {
+    implicit_modifiers = new_implicit_modifiers;
     zmk_mod_flags_t current = GET_MODIFIERS;
-    SET_MODIFIERS(explicit_modifiers | implicit_modifiers);
+    SET_MODIFIERS(explicit_modifiers);
     return current == GET_MODIFIERS ? 0 : 1;
 }
 
 int zmk_hid_implicit_modifiers_release() {
+    implicit_modifiers = 0;
+    zmk_mod_flags_t current = GET_MODIFIERS;
+    SET_MODIFIERS(explicit_modifiers);
+    return current == GET_MODIFIERS ? 0 : 1;
+}
+
+int zmk_hid_masked_modifiers_set(zmk_mod_flags_t new_masked_modifiers) {
+    masked_modifiers = new_masked_modifiers;
+    zmk_mod_flags_t current = GET_MODIFIERS;
+    SET_MODIFIERS(explicit_modifiers);
+    return current == GET_MODIFIERS ? 0 : 1;
+}
+
+int zmk_hid_masked_modifiers_clear() {
+    masked_modifiers = 0;
     zmk_mod_flags_t current = GET_MODIFIERS;
     SET_MODIFIERS(explicit_modifiers);
     return current == GET_MODIFIERS ? 0 : 1;

app/tests/mod-morph/default_mask_no_implicit/events.patterns

@@ -0,0 +1,8 @@
+s/.*hid_listener_keycode_pressed.*keycode/--- pressed: keycode/p
+s/.*hid_listener_keycode_released.*keycode/--- released: keycode/p
+s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
+s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
+s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
+s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
+s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
+s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

app/tests/mod-morph/default_mask_no_implicit/keycode_events.snapshot

@@ -0,0 +1,46 @@
+--- pressed: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+reg implicit: Modifiers set to 0x00
+unmask mods: Modifiers set to 0x00
+--- released: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x00
+--- pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x02
+reg implicit: Modifiers set to 0x02
+mask mods: Modifiers set to 0x00
+--- pressed: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+reg implicit: Modifiers set to 0x00
+unmask mods: Modifiers set to 0x02
+--- released: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x02
+--- released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x00
+unreg implicit: Modifiers set to 0x00
+--- pressed: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x04
+reg implicit: Modifiers set to 0x04
+--- pressed: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+reg implicit: Modifiers set to 0x04
+unmask mods: Modifiers set to 0x04
+--- released: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x04
+--- released: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x00
+unreg implicit: Modifiers set to 0x00
+--- pressed: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x04
+reg implicit: Modifiers set to 0x04
+--- pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x06
+reg implicit: Modifiers set to 0x06
+mask mods: Modifiers set to 0x04
+--- pressed: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+reg implicit: Modifiers set to 0x04
+unmask mods: Modifiers set to 0x06
+--- released: keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x06
+--- released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x04
+unreg implicit: Modifiers set to 0x04
+--- released: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x00
+unreg implicit: Modifiers set to 0x00

app/tests/mod-morph/default_mask_no_implicit/native_posix_64.keymap

@@ -0,0 +1,56 @@
+#include <dt-bindings/zmk/keys.h>
+#include <behaviors.dtsi>
+#include <dt-bindings/zmk/kscan_mock.h>
+
+
+&kscan {
+	events = <
+        /* A */
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+
+        /* B */
+		ZMK_MOCK_PRESS(1,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(1,0,10)
+
+        /* LALT + A */
+		ZMK_MOCK_PRESS(0,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(0,0,10)
+
+        /* LALT + B */
+		ZMK_MOCK_PRESS(0,0,10)
+		ZMK_MOCK_PRESS(1,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(1,0,10)
+		ZMK_MOCK_RELEASE(0,0,10)
+	>;
+};
+
+/ {
+    behaviors {
+        mod_morph: mod_morph {
+            compatible = "zmk,behavior-mod-morph";
+            label = "MOD_MORPH_TEST";
+            #binding-cells = <0>;
+            bindings = <&kp A>, <&kp B>;
+            mods = <(MOD_LSFT|MOD_RSFT)>;
+        };
+    };
+
+	keymap {
+		compatible = "zmk,keymap";
+		label ="Default keymap";
+
+		default_layer {
+			bindings = <
+				&kp LEFT_ALT &mod_morph
+				&kp LEFT_SHIFT &kp RIGHT_SHIFT
+			>;
+		};
+	};
+};

app/tests/mod-morph/default_mask_yes_implicit/events.patterns

@@ -0,0 +1,8 @@
+s/.*hid_listener_keycode_pressed.*keycode/--- pressed: keycode/p
+s/.*hid_listener_keycode_released.*keycode/--- released: keycode/p
+s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
+s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
+s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
+s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
+s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
+s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

app/tests/mod-morph/default_mask_yes_implicit/keycode_events.snapshot

@@ -0,0 +1,46 @@
+--- pressed: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+reg implicit: Modifiers set to 0x00
+unmask mods: Modifiers set to 0x00
+--- released: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x00
+--- pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x02
+reg implicit: Modifiers set to 0x02
+mask mods: Modifiers set to 0x00
+--- pressed: keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
+reg implicit: Modifiers set to 0x02
+unmask mods: Modifiers set to 0x02
+--- released: keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x02
+--- released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x00
+unreg implicit: Modifiers set to 0x00
+--- pressed: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x04
+reg implicit: Modifiers set to 0x04
+--- pressed: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+reg implicit: Modifiers set to 0x04
+unmask mods: Modifiers set to 0x04
+--- released: keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x04
+--- released: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x00
+unreg implicit: Modifiers set to 0x00
+--- pressed: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x04
+reg implicit: Modifiers set to 0x04
+--- pressed: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+reg explicit: Modifiers set to 0x06
+reg implicit: Modifiers set to 0x06
+mask mods: Modifiers set to 0x04
+--- pressed: keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
+reg implicit: Modifiers set to 0x06
+unmask mods: Modifiers set to 0x06
+--- released: keycode 0x05 implicit_mods 0x02 explicit_mods 0x00
+unreg implicit: Modifiers set to 0x06
+--- released: keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x04
+unreg implicit: Modifiers set to 0x04
+--- released: keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+unreg explicit: Modifiers set to 0x00
+unreg implicit: Modifiers set to 0x00

app/tests/mod-morph/default_mask_yes_implicit/native_posix_64.keymap

@@ -0,0 +1,56 @@
+#include <dt-bindings/zmk/keys.h>
+#include <behaviors.dtsi>
+#include <dt-bindings/zmk/kscan_mock.h>
+
+
+&kscan {
+	events = <
+        /* A */
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+
+        /* LSFT + B */
+		ZMK_MOCK_PRESS(1,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(1,0,10)
+
+        /* LALT + A */
+		ZMK_MOCK_PRESS(0,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(0,0,10)
+
+        /* LALT + LSFT + B */
+		ZMK_MOCK_PRESS(0,0,10)
+		ZMK_MOCK_PRESS(1,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(1,0,10)
+		ZMK_MOCK_RELEASE(0,0,10)
+	>;
+};
+
+/ {
+    behaviors {
+        mod_morph: mod_morph {
+            compatible = "zmk,behavior-mod-morph";
+            label = "MOD_MORPH_TEST";
+            #binding-cells = <0>;
+            bindings = <&kp A>, <&kp LS(B)>;
+            mods = <(MOD_LSFT|MOD_RSFT)>;
+        };
+    };
+
+	keymap {
+		compatible = "zmk,keymap";
+		label ="Default keymap";
+
+		default_layer {
+			bindings = <
+				&kp LEFT_ALT &mod_morph
+				&kp LEFT_SHIFT &kp RIGHT_SHIFT
+			>;
+		};
+	};
+};

app/tests/mod-morph/morph-into-hold-tap/events.patterns

@@ -0,0 +1,8 @@
+s/.*hid_listener_keycode_pressed.*keycode/--- pressed: keycode/p
+s/.*hid_listener_keycode_released.*keycode/--- released: keycode/p
+s/.*hid_register_mod.*Modifiers set to /reg explicit: Modifiers set to /p
+s/.*hid_unregister_mod.*Modifiers set to /unreg explicit: Modifiers set to /p
+s/.*hid_implicit_modifiers_press.*Modifiers set to /reg implicit: Modifiers set to /p
+s/.*hid_implicit_modifiers_release.*Modifiers set to /unreg implicit: Modifiers set to /p
+s/.*hid_masked_modifiers_set.*Modifiers set to /mask mods: Modifiers set to /p
+s/.*hid_masked_modifiers_clear.*Modifiers set to /unmask mods: Modifiers set to /p

app/tests/mod-morph/morph-into-hold-tap/native_posix_64.keymap

@@ -0,0 +1,59 @@
+#include <dt-bindings/zmk/keys.h>
+#include <behaviors.dtsi>
+#include <dt-bindings/zmk/kscan_mock.h>
+
+/*
+This test fails when the hold-tap resolves as tap, because &mod_morph is then released
+when the hold-tap decision is made but before the keypress is registered.
+*/
+
+&kscan {
+	events = <
+        /* Shift + tap &mod_morph --> expect B (but get Shift + B) */
+		ZMK_MOCK_PRESS(0,0,10)
+		ZMK_MOCK_PRESS(0,1,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(0,0,10)
+
+        /* Shift + hold &mod_morph --> expect and get D (no shift) */
+		ZMK_MOCK_PRESS(0,0,10)
+		ZMK_MOCK_PRESS(0,1,200)
+		ZMK_MOCK_PRESS(1,0,10)
+		ZMK_MOCK_RELEASE(1,0,10)
+		ZMK_MOCK_RELEASE(0,1,10)
+		ZMK_MOCK_RELEASE(0,0,10)
+	>;
+};
+
+/ {
+    behaviors {
+        mod_morph: mod_morph {
+            compatible = "zmk,behavior-mod-morph";
+            label = "MOD_MORPH_TEST";
+            #binding-cells = <0>;
+            bindings = <&kp A>, <&lt 1 B>;
+            mods = <(MOD_LSFT|MOD_RSFT)>;
+            masked_mods = <(MOD_LSFT|MOD_RSFT)>;  // same as default, added in case default gets changed
+        };
+
+    };
+
+	keymap {
+		compatible = "zmk,keymap";
+		label ="Default keymap";
+
+		default_layer {
+			bindings = <
+				&kp LEFT_SHIFT &mod_morph
+				&kp C &none
+			>;
+		};
+
+        second_layer {
+			bindings = <
+				&trans &trans
+				&kp D &none
+			>;
+		};
+	};
+};

app/tests/mod-morph/morph-into-hold-tap/pending

@@ -0,0 +1,7 @@
+This test fails when the hold-tap is decided to resolve as tap. In this case, as soon as
+the hold-tap decision is made, the mod-morph is released. This triggers the
+`.binding_released` function of the `mod-morph` behavior, clearing the `masked_mods`
+before the actual tap-binding of the `hold-tap` gets registered.
+
+If the hold-tap is decided to resolve as hold, the mod-morph isn't released, and
+`masked_mods` are cleared correctly.