You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
150 lines
4.3 KiB
150 lines
4.3 KiB
// 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.
|
|
//
|
|
//
|
|
// For full documentation, see
|
|
// https://getreuer.info/posts/keyboards/caps-word
|
|
|
|
#include "caps_word.h"
|
|
|
|
static bool caps_word_active = false;
|
|
|
|
#if CAPS_WORD_IDLE_TIMEOUT > 0
|
|
#if CAPS_WORD_IDLE_TIMEOUT < 100 || CAPS_WORD_IDLE_TIMEOUT > 30000
|
|
// Constrain timeout to a sensible range. With the 16-bit timer, the longest
|
|
// representable timeout is 32768 ms, rounded here to 30000 ms = half a minute.
|
|
#error "caps_word: CAPS_WORD_IDLE_TIMEOUT must be between 100 and 30000 ms"
|
|
#endif
|
|
|
|
static uint16_t idle_timer = 0;
|
|
|
|
void caps_word_task(void) {
|
|
if (caps_word_active && timer_expired(timer_read(), idle_timer)) {
|
|
caps_word_set(false);
|
|
}
|
|
}
|
|
#endif // CAPS_WORD_IDLE_TIMEOUT > 0
|
|
|
|
bool process_caps_word(uint16_t keycode, keyrecord_t* record) {
|
|
#ifndef NO_ACTION_ONESHOT
|
|
const uint8_t mods = get_mods() | get_oneshot_mods();
|
|
#else
|
|
const uint8_t mods = get_mods();
|
|
#endif // NO_ACTION_ONESHOT
|
|
|
|
if (!caps_word_active) {
|
|
// Pressing both shift keys at the same time enables caps word.
|
|
if ((mods & MOD_MASK_SHIFT) == MOD_MASK_SHIFT) {
|
|
caps_word_set(true); // Activate Caps Word.
|
|
return false;
|
|
}
|
|
return true;
|
|
} else {
|
|
#if CAPS_WORD_IDLE_TIMEOUT > 0
|
|
idle_timer = record->event.time + CAPS_WORD_IDLE_TIMEOUT;
|
|
#endif // CAPS_WORD_IDLE_TIMEOUT > 0
|
|
}
|
|
|
|
if (!record->event.pressed) { return true; }
|
|
|
|
if (!(mods & ~MOD_MASK_SHIFT)) {
|
|
switch (keycode) {
|
|
// Ignore MO, TO, TG, TT, and OSL layer switch keys.
|
|
case QK_MOMENTARY ... QK_MOMENTARY_MAX:
|
|
case QK_TO ... QK_TO_MAX:
|
|
case QK_TOGGLE_LAYER ... QK_TOGGLE_LAYER_MAX:
|
|
case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
|
|
case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX:
|
|
return true;
|
|
|
|
#ifndef NO_ACTION_TAPPING
|
|
case QK_MOD_TAP ... QK_MOD_TAP_MAX:
|
|
if (record->tap.count == 0) {
|
|
// Deactivate if a mod becomes active through holding a mod-tap key.
|
|
caps_word_set(false);
|
|
return true;
|
|
}
|
|
keycode &= 0xff;
|
|
break;
|
|
|
|
#ifndef NO_ACTION_LAYER
|
|
case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
|
|
#endif // NO_ACTION_LAYER
|
|
if (record->tap.count == 0) { return true; }
|
|
keycode &= 0xff;
|
|
break;
|
|
#endif // NO_ACTION_TAPPING
|
|
|
|
#ifdef SWAP_HANDS_ENABLE
|
|
case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
|
|
if (keycode > 0x56F0 || record->tap.count == 0) { return true; }
|
|
keycode &= 0xff;
|
|
break;
|
|
#endif // SWAP_HANDS_ENABLE
|
|
}
|
|
|
|
if (caps_word_press_user(keycode)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
caps_word_set(false); // Deactivate Caps Word.
|
|
return true;
|
|
}
|
|
|
|
void caps_word_set(bool active) {
|
|
if (active != caps_word_active) {
|
|
if (active) {
|
|
clear_mods();
|
|
#ifndef NO_ACTION_ONESHOT
|
|
clear_oneshot_mods();
|
|
#endif // NO_ACTION_ONESHOT
|
|
#if CAPS_WORD_IDLE_TIMEOUT > 0
|
|
idle_timer = timer_read() + CAPS_WORD_IDLE_TIMEOUT;
|
|
#endif // CAPS_WORD_IDLE_TIMEOUT > 0
|
|
} else if ((get_weak_mods() & MOD_BIT(KC_LSFT)) != 0) {
|
|
// If the weak shift mod is still on, turn it off and send an update to
|
|
// the host computer.
|
|
del_weak_mods(MOD_BIT(KC_LSFT));
|
|
send_keyboard_report();
|
|
}
|
|
|
|
caps_word_active = active;
|
|
caps_word_set_user(active);
|
|
}
|
|
}
|
|
|
|
bool caps_word_get(void) { return caps_word_active; }
|
|
|
|
__attribute__((weak)) void caps_word_set_user(bool active) {}
|
|
|
|
__attribute__((weak)) bool caps_word_press_user(uint16_t keycode) {
|
|
switch (keycode) {
|
|
// Keycodes that continue Caps Word, with shift applied.
|
|
case KC_A ... KC_Z:
|
|
add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to the next key.
|
|
return true;
|
|
|
|
// Keycodes that continue Caps Word, without shifting.
|
|
case KC_1 ... KC_0:
|
|
case KC_BSPC:
|
|
case KC_MINS:
|
|
case KC_UNDS:
|
|
return true;
|
|
|
|
default:
|
|
return false; // Deactivate Caps Word.
|
|
}
|
|
}
|
|
|