make MAGIC_SWAP_* work with mod-tap

[osamuaoki]

Currently, we have 2 nicely working features:

• mod-tap such as MT(MOD_LCTL, KC_ESC)
• MAGIC such as MAGIC_SWAP_ESCAPE_CAPS (Thiaks for including this feature request from me.)

They work as expected as long as they are not used together.

But if they are used together, SWAP is not used since switch in quantum/keycode_config.c uses bare keycode without mask.

This is not just for this particular MAGIC but seems to be a generic issue around MAGIC handling code.

Feature Request Type

• [v ] Core functionality
• Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
• [v ] Alteration (enhancement/optimization) of existing feature(s)
• [] New behavior

Description

For local workaround, I patched as below by masking high 8 bits for some MAGIC handling. (devel branch)

 quantum/keycode_config.c | 26 +++++++++++++++++---------
 1 file changed, 17 insertions(+), 9 deletions(-)

diff --git a/quantum/keycode_config.c b/quantum/keycode_config.c
index 5b5cc5d28e..cbb6fc2bf2 100644
--- a/quantum/keycode_config.c
+++ b/quantum/keycode_config.c
@@ -90,28 +90,36 @@ uint16_t keycode_config(uint16_t keycode) {
                 return KC_NO;
             }
             return KC_RIGHT_GUI;
+    }
+    switch (keycode & ~(0xff <<8)) { // ignore action code
+        case KC_CAPS_LOCK:
+        case KC_LOCKING_CAPS_LOCK:
+            if (keymap_config.swap_escape_capslock) {
+                return KC_ESCAPE | (keycode & (0xff <<8));
+            }
+            return keycode;
         case KC_GRAVE:
             if (keymap_config.swap_grave_esc) {
-                return KC_ESCAPE;
+                return KC_ESCAPE | (keycode & (0xff <<8));
             }
-            return KC_GRAVE;
+            return keycode;
         case KC_ESCAPE:
             if (keymap_config.swap_grave_esc) {
-                return KC_GRAVE;
+                return KC_GRAVE | (keycode & (0xff <<8));
             } else if (keymap_config.swap_escape_capslock) {
-                return KC_CAPS_LOCK;
+                return KC_CAPS_LOCK | (keycode & (0xff <<8));
             }
-            return KC_ESCAPE;
+            return keycode;
         case KC_BACKSLASH:
             if (keymap_config.swap_backslash_backspace) {
-                return KC_BACKSPACE;
+                return KC_BACKSPACE | (keycode & (0xff <<8));
             }
-            return KC_BACKSLASH;
+            return keycode;
         case KC_BACKSPACE:
             if (keymap_config.swap_backslash_backspace) {
-                return KC_BACKSLASH;
+                return KC_BACKSLASH | (keycode & (0xff <<8));
             }
-            return KC_BACKSPACE;
+            return keycode;
         default:
             return keycode;
     }
-- 
2.35.1

This seems to fix situation for me as I just played but I don't know side effect to mouse key and other possible regressions. Besides, I didn't test this much. This is merely here to indicate issues to be solved..

Someone with good understanding of action code needs to think through this problem.

Regards,

Osamu

[osamuaoki]

FYI: I have a bit over complicated equation for mask value since I initially tested equation for mask with 0x1f. That didn't work well. May be replace them with 0xff00 and 0x00ff..

[sigprof]

There is a pending PR that does a similar thing:

• Make Magic handling more consistent in Action Keycode handling #9126

Maybe that PR should be moved forward (there are some concerns that it also changes the behavior of keycodes with modifiers, which may look strange, but then if you are doing things like OS-specific layers, you probably don't need those magic switches at all).

[osamuaoki]

After some trials, I cleaned up my modification. At least some of my initial concern points were addressed.

[github-actions]

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs.
For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.

[github-actions]

This issue has been automatically closed because it has not had activity in the last 30 days. If this issue is still valid, re-open the issue and let us know.
// [stale-action-closed]