From 261e7668c660620b09916d181ae5ad8c71d5a17d Mon Sep 17 00:00:00 2001 From: syntax-magic Date: Thu, 8 Dec 2022 08:09:43 -0800 Subject: Added mouse clicks to RBG layer (#19105) Co-authored-by: Drashna Jaelre Co-authored-by: syntax-magic --- .../keymaps/dan/features/custom_shift_keys.c | 76 +++++++++++++++++ .../keymaps/dan/features/custom_shift_keys.h | 99 ++++++++++++++++++++++ 2 files changed, 175 insertions(+) create mode 100644 keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.c create mode 100644 keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.h (limited to 'keyboards/kprepublic/bm40hsrgb/keymaps/dan/features') diff --git a/keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.c b/keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.c new file mode 100644 index 0000000000..5576612f9a --- /dev/null +++ b/keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.c @@ -0,0 +1,76 @@ +// 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.c + * @brief Custom Shift Keys implementation + * + * For full documentation, see + * + */ + +#include "custom_shift_keys.h" + +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 + // Search for a custom key with keycode equal to `keycode`. + for (int i = 0; i < NUM_CUSTOM_SHIFT_KEYS; ++i) + { + + if (keycode == custom_shift_keys[i].keycode) + { + // Continue default handling if this is a tap-hold key being held. + if (((QK_MOD_TAP <= keycode && keycode <= QK_MOD_TAP_MAX) || (QK_LAYER_TAP <= keycode && keycode <= QK_LAYER_TAP_MAX)) && record->tap.count == 0) + { + return true; + } + +#ifndef NO_ACTION_ONESHOT + del_oneshot_mods(MOD_MASK_SHIFT); +#endif // NO_ACTION_ONESHOT + del_mods(MOD_MASK_SHIFT); + del_weak_mods(MOD_MASK_SHIFT); + send_keyboard_report(); + registered_keycode = custom_shift_keys[i].shifted_keycode; + register_code16(registered_keycode); + set_mods(mods); // Restore the mods. + return false; + } + } + } + } + + return true; // Continue with default handling. +} diff --git a/keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.h b/keyboards/kprepublic/bm40hsrgb/keymaps/dan/features/custom_shift_keys.h new file mode 100644 index 0000000000..d6cb7a9fdd --- /dev/null +++ b/keyboards/kprepublic/bm40hsrgb/keymaps/dan/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 -- cgit v1.2.3