From 609ca8548ce7063f8adff2b86b4a99ba9ec15592 Mon Sep 17 00:00:00 2001 From: Kjetil Orbekk Date: Fri, 5 Apr 2024 09:22:29 -0400 Subject: graphite shift keys --- .../keymaps/default/features/custom_shift_keys.c | 87 +++++++++++++++++++ .../keymaps/default/features/custom_shift_keys.h | 99 ++++++++++++++++++++++ keyboards/orbekk_dactyl/keymaps/default/keymap.c | 19 +++++ keyboards/orbekk_dactyl/rules.mk | 1 + 4 files changed, 206 insertions(+) create mode 100644 keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.c create mode 100644 keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.h diff --git a/keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.c b/keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.c new file mode 100644 index 0000000000..cb371ae339 --- /dev/null +++ b/keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.c @@ -0,0 +1,87 @@ +// Copyright 2021-2024 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 + * + */ + +#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 saved_mods = get_mods(); +#ifndef NO_ACTION_ONESHOT + const uint8_t mods = saved_mods | get_weak_mods() | get_oneshot_mods(); +#else + const uint8_t mods = saved_mods | get_weak_mods(); +#endif // NO_ACTION_ONESHOT + if ((mods & MOD_MASK_SHIFT) != 0 // Shift is held. +#if CUSTOM_SHIFT_KEYS_NEGMODS != 0 + // Nothing in CUSTOM_SHIFT_KEYS_NEGMODS is held. + && (mods & (CUSTOM_SHIFT_KEYS_NEGMODS)) == 0 +#endif // CUSTOM_SHIFT_KEYS_NEGMODS != 0 + ) { + // 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(saved_mods); + } + return false; + } + } + } + } + + return true; // Continue with default handling. +} + +#endif // version check diff --git a/keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.h b/keyboards/orbekk_dactyl/keymaps/default/features/custom_shift_keys.h new file mode 100644 index 0000000000..d6cb7a9fdd --- /dev/null +++ b/keyboards/orbekk_dactyl/keymaps/default/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 + * + */ + +#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 diff --git a/keyboards/orbekk_dactyl/keymaps/default/keymap.c b/keyboards/orbekk_dactyl/keymaps/default/keymap.c index 586dfbfaa1..f82c7979e3 100644 --- a/keyboards/orbekk_dactyl/keymaps/default/keymap.c +++ b/keyboards/orbekk_dactyl/keymaps/default/keymap.c @@ -1,5 +1,6 @@ #include QMK_KEYBOARD_H #include "layout.h" +#include "features/custom_shift_keys.h" // Based on: // https://github.com/getreuer/qmk-keymap/blob/main/keymap.c @@ -98,3 +99,21 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { ), }; + +const custom_shift_key_t custom_shift_keys[] = { + {KC_DOT , KC_GT}, + {KC_SLASH, KC_LT}, + {KC_MINS, KC_DOUBLE_QUOTE}, + {KC_QUOTE, KC_UNDERSCORE}, +}; +uint8_t NUM_CUSTOM_SHIFT_KEYS = + sizeof(custom_shift_keys) / sizeof(custom_shift_key_t); + +bool process_record_user(uint16_t keycode, keyrecord_t* record) { + if (layer_state_cmp(default_layer_state, GR) && + !process_custom_shift_keys(keycode, record)) { + return false; + } + + return true; +} diff --git a/keyboards/orbekk_dactyl/rules.mk b/keyboards/orbekk_dactyl/rules.mk index ebbd33e000..6d9e288937 100644 --- a/keyboards/orbekk_dactyl/rules.mk +++ b/keyboards/orbekk_dactyl/rules.mk @@ -1,3 +1,4 @@ # This file intentionally left blank SERIAL_DRIVER = vendor TRI_LAYER_ENABLE = yes +SRC += features/custom_shift_keys.c -- cgit v1.2.3