PoC: Swap Escape and Caps

[osamuaoki]

Add "Swap Escape and CapsLock" and "Unswap ..." capability dynamically via magic key.

Description

This is just a proof-of-concept patch to swap Escape and Caps

• Adding flag in between existing bit field causes bug (BS \ swap)
• Adding quantum code in more proper comment requires to update comment.

It worked on my QMK keyboard (handwired 4x14 ortholinear compact.) When a host PC with GNOME tweak sets to swap Escape and Caps, I had to do this to obtain in sane key location on my QMK keyboard while keeping that note PC usable with vim.

If you like this idea, I will add needed things for general consumption.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

• NEW FEATURE added to swap Escape and Caps. (Different machine, different OS config, so it will be nice it is dynamically changed.
• GPL2+ /GPL3+
• Documentation is not updated yet
• Aesthetically ugly location for qantum keycodes ... funny thin happend as I tried to insert... so this is least invasive patch as was the recent commit by others :
  • 2726856 ("Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK (Implement MAGIC_TOGGLE_CONTROL_CAPSLOCK #15368)", 2021-12-01)

This patch is tested on my branch containing my handwired keyboard.

• https://github.com/osamuaoki/qmk_firmware (osamu1 stable branch)
• https://github.com/osamuaoki/qmk_firmware/tree/osamu2 (osamu2 branch rebased to develop)
  Both are working fine with AT90USB1286 based project (Rev 02)
• https://github.com/osamuaoki/cg56 (More on case design memo.)

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Osamu Aoki [email protected]

[osamuaoki]

Swapping Grave-Esc, Caps-Ctrl is popular option with large foot print keyboard. But for small foot print keyboard with MT(MOD_LCTL, KC_TAB)-key, adding swap for ESC-Caps is a nice addition. GNOME Tweak already supports such things. (but that also cause regression on swapped mapping keyboard.)

Without this swap support, we need to do extra things to be flexible over different installation. So far this is working here.

As for the demand of this kind feature, I used google to get non-scientific research by google:

• "swap escape caps lock" -- About 7,540,000 results (0.66 seconds)
• "swap control caps lock" -- About 6,850,000 results (0.60 seconds)

VIM user seems to be target for both. Anyway, this is almost at the same level of interest as already included feature.

Please consider including this since this is rather small binary increment type code.

[osamuaoki]

I updated pull request with a clean squashed code patch and added corresponding documentation.

[osamuaoki]

Just updated to resolve a conflict caused by the recent commit with force push

[osamuaoki]

I now updated to target "devel" branch.
　

[osamuaoki]

Thanks