Add custom shift keys. Organise code

combos.h

@@ -0,0 +1,94 @@
+#include "quantum.h"
+#include "hrm.h"
+
+/**
+ * Num row symbols.
+ */
+#define COMBO_DEF(var, ...) \
+  const uint16_t PROGMEM var[] = {__VA_ARGS__, COMBO_END}
+
+COMBO_DEF(c_at, KC_W, HM_R);
+COMBO_DEF(c_pound, KC_F, HM_S);
+COMBO_DEF(c_dollar, KC_P, HM_T);
+COMBO_DEF(c_percent, KC_B, KC_G);
+
+COMBO_DEF(c_carat, KC_J, KC_M);
+COMBO_DEF(c_and, KC_L, HM_N);
+COMBO_DEF(c_star, KC_U, HM_E);
+COMBO_DEF(c_slash, KC_Y, HM_I);
+
+/**
+ * Parenthesis.
+ *
+ * Open on left hand, close on right hand.
+ */
+COMBO_DEF(c_lparen, HM_T, HM_S);
+COMBO_DEF(c_rparen, HM_N, HM_E);
+
+COMBO_DEF(c_lbracket, HM_T, HM_R);
+COMBO_DEF(c_rbracket, HM_N, HM_I);
+
+COMBO_DEF(c_lbrace, HM_S, HM_R);
+COMBO_DEF(c_rbrace, HM_E, HM_I);
+
+COMBO_DEF(c_langle, HM_T, HM_S, HM_R);
+COMBO_DEF(c_rangle, HM_N, HM_E, HM_I);
+
+/**
+ * Common symbols.
+ */
+COMBO_DEF(c_hyphen, KC_B, KC_J);
+COMBO_DEF(c_equals, KC_G, KC_M);
+COMBO_DEF(c_underscore, KC_V, KC_K);
+
+/**
+ * Functional keys.
+ */
+COMBO_DEF(c_backspace, KC_L, KC_U);
+COMBO_DEF(c_delete, KC_U, KC_Y);
+
+enum COMBO_INDICES {
+  C_LPAREN,
+  C_RPAREN,
+  C_LBRACKET,
+  C_RBRACKET,
+  C_LBRACE,
+  C_RBRACE,
+  C_LANGLE,
+  C_RANGLE,
+};
+
+
+combo_t key_combos[] = {
+  // Parenthesis
+  [C_LPAREN] = COMBO(c_lparen, LSFT(KC_9)),
+  [C_RPAREN] = COMBO(c_rparen, LSFT(KC_0)),
+
+  [C_LBRACKET] = COMBO(c_lbracket, KC_LEFT_BRACKET),
+  [C_RBRACKET] = COMBO(c_rbracket, KC_RIGHT_BRACKET),
+
+  [C_LBRACE] = COMBO(c_lbrace, LSFT(KC_LEFT_BRACKET)),
+  [C_RBRACE] = COMBO(c_rbrace, LSFT(KC_RIGHT_BRACKET)),
+
+  [C_LANGLE] = COMBO(c_langle, LSFT(KC_COMMA)),
+  [C_RANGLE] = COMBO(c_rangle, LSFT(KC_DOT)),
+
+  // Upper Symbols
+  COMBO(c_at,      LSFT(KC_2)),
+  COMBO(c_pound,   LSFT(KC_3)),
+  COMBO(c_dollar,  LSFT(KC_4)),
+  COMBO(c_percent, LSFT(KC_5)),
+  COMBO(c_carat,   LSFT(KC_6)),
+  COMBO(c_and,     LSFT(KC_7)),
+  COMBO(c_star,    LSFT(KC_8)),
+  COMBO(c_slash,   LSFT(KC_9)),
+
+  // Common symbols
+  COMBO(c_hyphen, KC_MINUS),
+  COMBO(c_equals, KC_EQUAL),
+  COMBO(c_underscore, LSFT(KC_MINUS)),
+
+  COMBO(c_backspace, KC_BACKSPACE),
+  COMBO(c_delete, KC_DELETE),
+};
+

config.h

@@ -6,6 +6,7 @@
 #define TAP_TERM_PER_KEY
 #define TAPPING_TERM 250
 
+#define COMBO_TERM 50
 #define COMBO_TERM_PER_COMBO
 
 #define DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD

features/custom_shift_keys.c

@@ -0,0 +1,81 @@
+// Copyright 2021-2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @file custom_shift_keys.c
+ * @brief Custom Shift Keys implementation
+ *
+ * For full documentation, see
+ * <https://getreuer.info/posts/keyboards/custom-shift-keys>
+ */
+
+#include "custom_shift_keys.h"
+
+#if !defined(IS_QK_MOD_TAP)
+// Attempt to detect out-of-date QMK installation, which would fail with
+// implicit-function-declaration errors in the code below.
+#error "custom_shift_keys: QMK version is too old to build. Please update QMK."
+#else
+
+bool process_custom_shift_keys(uint16_t keycode, keyrecord_t *record) {
+  static uint16_t registered_keycode = KC_NO;
+
+  // If a custom shift key is registered, then this event is either releasing
+  // it or manipulating another key at the same time. Either way, we release
+  // the currently registered key.
+  if (registered_keycode != KC_NO) {
+    unregister_code16(registered_keycode);
+    registered_keycode = KC_NO;
+  }
+
+  if (record->event.pressed) {  // Press event.
+    const uint8_t mods = get_mods();
+#ifndef NO_ACTION_ONESHOT
+    if ((mods | get_weak_mods() | get_oneshot_mods()) & MOD_MASK_SHIFT) {
+#else
+    if ((mods | get_weak_mods()) & MOD_MASK_SHIFT) {  // Shift is held.
+#endif  // NO_ACTION_ONESHOT
+      // Continue default handling if this is a tap-hold key being held.
+      if ((IS_QK_MOD_TAP(keycode) || IS_QK_LAYER_TAP(keycode)) &&
+          record->tap.count == 0) {
+        return true;
+      }
+
+      // Search for a custom shift key whose keycode is `keycode`.
+      for (int i = 0; i < NUM_CUSTOM_SHIFT_KEYS; ++i) {
+        if (keycode == custom_shift_keys[i].keycode) {
+          registered_keycode = custom_shift_keys[i].shifted_keycode;
+          if (IS_QK_MODS(registered_keycode) &&  // Should keycode be shifted?
+              (QK_MODS_GET_MODS(registered_keycode) & MOD_LSFT) != 0) {
+            register_code16(registered_keycode);  // If so, press it directly.
+          } else {
+            // Otherwise cancel shift mods, press the key, and restore mods.
+            del_weak_mods(MOD_MASK_SHIFT);
+#ifndef NO_ACTION_ONESHOT
+            del_oneshot_mods(MOD_MASK_SHIFT);
+#endif  // NO_ACTION_ONESHOT
+            unregister_mods(MOD_MASK_SHIFT);
+            register_code16(registered_keycode);
+            set_mods(mods);
+          }
+          return false;
+        }
+      }
+    }
+  }
+
+  return true;  // Continue with default handling.
+}
+
+#endif  // version check

features/custom_shift_keys.h

@@ -0,0 +1,99 @@
+// Copyright 2021-2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @file custom_shift_keys.h
+ * @brief Custom shift keys: customize what keycode is produced when shifted.
+ *
+ * Overview
+ * --------
+ *
+ * This library implements custom shift keys, keys where you can customize
+ * what keycode is produced when shifted.
+ *
+ * Step 1: In your keymap.c, define a table of custom shift keys like
+ *
+ *     #include "features/custom_shift_keys.h"
+ *
+ *     const custom_shift_key_t custom_shift_keys[] = {
+ *       {KC_DOT , KC_QUES}, // Shift . is ?
+ *       {KC_COMM, KC_EXLM}, // Shift , is !
+ *       {KC_MINS, KC_EQL }, // Shift - is =
+ *       {KC_COLN, KC_SCLN}, // Shift : is ;
+ *     };
+ *
+ * Each row defines one key. The first field is the keycode as it appears in
+ * your layout and determines what is typed normally. The second entry is what
+ * you want the key to type when shifted.
+ *
+ * Step 2: Handle custom shift keys from your `process_record_user` function as
+ *
+ *     bool process_record_user(uint16_t keycode, keyrecord_t* record) {
+ *       if (!process_custom_shift_keys(keycode, record)) { return false; }
+ *       // Your macros ...
+ *
+ *       return true;
+ *     }
+ *
+ * Step 3: add `features/custom_shift_keys.c` to your rules.mk as
+ *
+ *     SRC += features/custom_shift_keys.c
+ *
+ *
+ * For full documentation, see
+ * <https://getreuer.info/posts/keyboards/custom-shift-keys>
+ */
+
+#pragma once
+
+#include "quantum.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * Custom shift key entry. The `keycode` field is the keycode as it appears in
+ * your layout and determines what is typed normally. The `shifted_keycode` is
+ * what you want the key to type when shifted.
+ */
+typedef struct {
+  uint16_t keycode;
+  uint16_t shifted_keycode;
+} custom_shift_key_t;
+
+/** Table of custom shift keys. */
+extern const custom_shift_key_t custom_shift_keys[];
+/** Number of entries in the `custom_shift_keys` table. */
+extern uint8_t NUM_CUSTOM_SHIFT_KEYS;
+
+/**
+ * Handler function for custom shift keys.
+ *
+ * In keymap.c, call this function from your `process_record_user` function as
+ *
+ *     #include "features/custom_shift_keys.h"
+ *
+ *     bool process_record_user(uint16_t keycode, keyrecord_t* record) {
+ *       if (!process_custom_shift_keys(keycode, record)) { return false; }
+ *       // Your macros ...
+ *
+ *       return true;
+ *     }
+ */
+bool process_custom_shift_keys(uint16_t keycode, keyrecord_t *record);
+
+#ifdef __cplusplus
+}
+#endif