Relocate grave keycode processing (#8082)

* Relocate grave keycode processing

* Tidy up code

* Refactor grave -> grave_esc

2 files changed, 91 insertions, 0 deletions

diff --git a/quantum/process_keycode/process_grave_esc.c b/quantum/process_keycode/process_grave_esc.c
new file mode 100644
index 000000000..41c50f5cb
--- /dev/null
+++ b/quantum/process_keycode/process_grave_esc.c
@@ -0,0 +1,71 @@
+/* Copyright 2020
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include "process_grave_esc.h"
+
+/* true if the last press of GRAVE_ESC was shifted (i.e. GUI or SHIFT were pressed), false otherwise.
+ * Used to ensure that the correct keycode is released if the key is released.
+ */
+static bool grave_esc_was_shifted = false;
+
+bool process_grave_esc(uint16_t keycode, keyrecord_t *record) {
+    if (keycode == GRAVE_ESC) {
+        const uint8_t mods    = get_mods();
+        uint8_t       shifted = mods & MOD_MASK_SG;
+
+#ifdef GRAVE_ESC_ALT_OVERRIDE
+        // if ALT is pressed, ESC is always sent
+        // this is handy for the cmd+opt+esc shortcut on macOS, among other things.
+        if (mods & MOD_MASK_ALT) {
+            shifted = 0;
+        }
+#endif
+
+#ifdef GRAVE_ESC_CTRL_OVERRIDE
+        // if CTRL is pressed, ESC is always sent
+        // this is handy for the ctrl+shift+esc shortcut on windows, among other things.
+        if (mods & MOD_MASK_CTRL) {
+            shifted = 0;
+        }
+#endif
+
+#ifdef GRAVE_ESC_GUI_OVERRIDE
+        // if GUI is pressed, ESC is always sent
+        if (mods & MOD_MASK_GUI) {
+            shifted = 0;
+        }
+#endif
+
+#ifdef GRAVE_ESC_SHIFT_OVERRIDE
+        // if SHIFT is pressed, ESC is always sent
+        if (mods & MOD_MASK_SHIFT) {
+            shifted = 0;
+        }
+#endif
+
+        if (record->event.pressed) {
+            grave_esc_was_shifted = shifted;
+            add_key(shifted ? KC_GRAVE : KC_ESCAPE);
+        } else {
+            del_key(grave_esc_was_shifted ? KC_GRAVE : KC_ESCAPE);
+        }
+
+        send_keyboard_report();
+        return false;
+    }
+
+    // Not a grave keycode so continue processing
+    return true;
+}
diff --git a/quantum/process_keycode/process_grave_esc.h b/quantum/process_keycode/process_grave_esc.h
new file mode 100644
index 000000000..bbf448376
--- /dev/null
+++ b/quantum/process_keycode/process_grave_esc.h
@@ -0,0 +1,20 @@
+/* Copyright 2020
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include "quantum.h"
+
+bool process_grave_esc(uint16_t keycode, keyrecord_t *record);