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.
272 lines
9.4 KiB
272 lines
9.4 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.
|
|
|
|
#include "process_caps_word.h"
|
|
#include "process_auto_shift.h"
|
|
#include "process_space_cadet.h"
|
|
#include "caps_word.h"
|
|
#include "keycodes.h"
|
|
#include "quantum_keycodes.h"
|
|
#include "modifiers.h"
|
|
#include "timer.h"
|
|
#include "action_tapping.h"
|
|
#include "action_util.h"
|
|
|
|
#ifdef CAPS_WORD_INVERT_ON_SHIFT
|
|
static uint8_t held_mods = 0;
|
|
|
|
static bool handle_shift(uint16_t keycode, keyrecord_t* record) {
|
|
switch (keycode) {
|
|
case OSM(MOD_LSFT):
|
|
keycode = KC_LSFT;
|
|
break;
|
|
case OSM(MOD_RSFT):
|
|
keycode = KC_RSFT;
|
|
break;
|
|
|
|
# ifndef NO_ACTION_TAPPING
|
|
case QK_MOD_TAP ... QK_MOD_TAP_MAX:
|
|
if (record->tap.count == 0) { // Mod-tap key is held.
|
|
switch (QK_MOD_TAP_GET_MODS(keycode)) {
|
|
case MOD_LSFT:
|
|
keycode = KC_LSFT;
|
|
break;
|
|
case MOD_RSFT:
|
|
keycode = KC_RSFT;
|
|
break;
|
|
}
|
|
}
|
|
# endif // NO_ACTION_TAPPING
|
|
}
|
|
|
|
if (keycode == KC_LSFT || keycode == KC_RSFT) {
|
|
const uint8_t mod = MOD_BIT(keycode);
|
|
|
|
if (is_caps_word_on()) {
|
|
if (record->event.pressed) {
|
|
held_mods |= mod;
|
|
} else {
|
|
held_mods &= ~mod;
|
|
}
|
|
return false;
|
|
} else if ((held_mods & mod) != 0) {
|
|
held_mods &= ~mod;
|
|
del_mods(mod);
|
|
return record->event.pressed;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
#endif // CAPS_WORD_INVERT_ON_SHIFT
|
|
|
|
bool process_caps_word(uint16_t keycode, keyrecord_t* record) {
|
|
if (keycode == QK_CAPS_WORD_TOGGLE) {
|
|
if (record->event.pressed) {
|
|
caps_word_toggle();
|
|
}
|
|
return false;
|
|
}
|
|
#ifdef CAPS_WORD_INVERT_ON_SHIFT
|
|
if (!handle_shift(keycode, record)) {
|
|
return false;
|
|
}
|
|
#endif // CAPS_WORD_INVERT_ON_SHIFT
|
|
|
|
#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 (!is_caps_word_on()) {
|
|
// The following optionally turns on Caps Word by holding left and
|
|
// right shifts or by double tapping left shift. This way Caps Word
|
|
// may be used without needing a dedicated key and also without
|
|
// needing combos or tap dance.
|
|
|
|
#ifdef BOTH_SHIFTS_TURNS_ON_CAPS_WORD
|
|
// Many keyboards enable the Command feature by default, which also
|
|
// uses left+right shift. It can be configured to use a different
|
|
// key combination by defining IS_COMMAND(). We make a non-fatal
|
|
// warning if Command is enabled but IS_COMMAND() is *not* defined.
|
|
# if defined(COMMAND_ENABLE) && !defined(IS_COMMAND)
|
|
# pragma message "BOTH_SHIFTS_TURNS_ON_CAPS_WORD and Command should not be enabled at the same time, since both use the Left Shift + Right Shift key combination. Please disable Command, or ensure that `IS_COMMAND` is not set to (get_mods() == MOD_MASK_SHIFT)."
|
|
# else
|
|
if (mods == MOD_MASK_SHIFT
|
|
# ifdef COMMAND_ENABLE
|
|
// Don't activate Caps Word at the same time as Command.
|
|
&& !(IS_COMMAND())
|
|
# endif // COMMAND_ENABLE
|
|
) {
|
|
caps_word_on();
|
|
# ifdef SPACE_CADET_ENABLE
|
|
reset_space_cadet();
|
|
# endif // SPACE_CADET_ENABLE
|
|
}
|
|
# endif // defined(COMMAND_ENABLE) && !defined(IS_COMMAND)
|
|
#endif // BOTH_SHIFTS_TURNS_ON_CAPS_WORD
|
|
|
|
#ifdef DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD
|
|
// Double tapping left shift turns on Caps Word.
|
|
//
|
|
// NOTE: This works with KC_LSFT and one-shot left shift. It
|
|
// wouldn't make sense with mod-tap or Space Cadet shift since
|
|
// double tapping would of course trigger the tapping action.
|
|
if (record->event.pressed) {
|
|
static bool tapped = false;
|
|
static uint16_t timer = 0;
|
|
if (keycode == KC_LSFT || keycode == OSM(MOD_LSFT)) {
|
|
if (tapped && !timer_expired(record->event.time, timer)) {
|
|
// Left shift was double tapped, activate Caps Word.
|
|
caps_word_on();
|
|
}
|
|
tapped = true;
|
|
timer = record->event.time + GET_TAPPING_TERM(keycode, record);
|
|
} else {
|
|
tapped = false; // Reset when any other key is pressed.
|
|
}
|
|
}
|
|
#endif // DOUBLE_TAP_SHIFT_TURNS_ON_CAPS_WORD
|
|
|
|
return true;
|
|
}
|
|
|
|
#if CAPS_WORD_IDLE_TIMEOUT > 0
|
|
caps_word_reset_idle_timer();
|
|
#endif // CAPS_WORD_IDLE_TIMEOUT > 0
|
|
|
|
// From here on, we only take action on press events.
|
|
if (!record->event.pressed) {
|
|
return true;
|
|
}
|
|
|
|
if (!(mods & ~(MOD_MASK_SHIFT | MOD_BIT(KC_RALT)))) {
|
|
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:
|
|
case QK_TRI_LAYER_LOWER ... QK_TRI_LAYER_UPPER:
|
|
// Ignore AltGr.
|
|
case KC_RALT:
|
|
case OSM(MOD_RALT):
|
|
return true;
|
|
|
|
#ifndef NO_ACTION_TAPPING
|
|
// Corresponding to mod keys above, a held mod-tap is handled as:
|
|
// * For shift mods, pass KC_LSFT or KC_RSFT to
|
|
// caps_word_press_user() to determine whether to continue.
|
|
// * For Shift + AltGr (MOD_RSFT | MOD_RALT), pass RSFT(KC_RALT).
|
|
// * AltGr (MOD_RALT) is ignored.
|
|
// * Otherwise stop Caps Word.
|
|
case QK_MOD_TAP ... QK_MOD_TAP_MAX:
|
|
if (record->tap.count == 0) { // Mod-tap key is held.
|
|
const uint8_t mods = QK_MOD_TAP_GET_MODS(keycode);
|
|
switch (mods) {
|
|
# ifndef CAPS_WORD_INVERT_ON_SHIFT
|
|
case MOD_LSFT:
|
|
keycode = KC_LSFT;
|
|
break;
|
|
case MOD_RSFT:
|
|
keycode = KC_RSFT;
|
|
break;
|
|
# endif // CAPS_WORD_INVERT_ON_SHIFT
|
|
case MOD_RSFT | MOD_RALT:
|
|
keycode = RSFT(KC_RALT);
|
|
break;
|
|
case MOD_RALT:
|
|
return true;
|
|
default:
|
|
caps_word_off();
|
|
# ifdef CAPS_WORD_INVERT_ON_SHIFT
|
|
add_mods(held_mods);
|
|
# endif // CAPS_WORD_INVERT_ON_SHIFT
|
|
return true;
|
|
}
|
|
} else {
|
|
keycode = QK_MOD_TAP_GET_TAP_KEYCODE(keycode);
|
|
}
|
|
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 = QK_LAYER_TAP_GET_TAP_KEYCODE(keycode);
|
|
break;
|
|
#endif // NO_ACTION_TAPPING
|
|
|
|
#ifdef SWAP_HANDS_ENABLE
|
|
case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
|
|
// Note: IS_SWAP_HANDS_KEYCODE() actually tests for the special action keycodes like SH_TOGG, SH_TT, ...,
|
|
// which currently overlap the SH_T(kc) range.
|
|
if (IS_SWAP_HANDS_KEYCODE(keycode)
|
|
# ifndef NO_ACTION_TAPPING
|
|
|| record->tap.count == 0
|
|
# endif // NO_ACTION_TAPPING
|
|
) {
|
|
return true;
|
|
}
|
|
keycode = QK_SWAP_HANDS_GET_TAP_KEYCODE(keycode);
|
|
break;
|
|
#endif // SWAP_HANDS_ENABLE
|
|
}
|
|
|
|
#ifdef AUTO_SHIFT_ENABLE
|
|
del_weak_mods(get_autoshift_state() ? ~MOD_BIT(KC_LSFT) : 0xff);
|
|
#else
|
|
clear_weak_mods();
|
|
#endif // AUTO_SHIFT_ENABLE
|
|
if (caps_word_press_user(keycode)) {
|
|
#ifdef CAPS_WORD_INVERT_ON_SHIFT
|
|
if (held_mods) {
|
|
set_weak_mods(get_weak_mods() ^ MOD_BIT(KC_LSFT));
|
|
}
|
|
#endif // CAPS_WORD_INVERT_ON_SHIFT
|
|
send_keyboard_report();
|
|
return true;
|
|
}
|
|
}
|
|
|
|
caps_word_off();
|
|
#ifdef CAPS_WORD_INVERT_ON_SHIFT
|
|
add_mods(held_mods);
|
|
#endif // CAPS_WORD_INVERT_ON_SHIFT
|
|
return true;
|
|
}
|
|
|
|
__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:
|
|
case KC_MINS:
|
|
add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to next key.
|
|
return true;
|
|
|
|
// Keycodes that continue Caps Word, without shifting.
|
|
case KC_1 ... KC_0:
|
|
case KC_BSPC:
|
|
case KC_DEL:
|
|
case KC_UNDS:
|
|
return true;
|
|
|
|
default:
|
|
return false; // Deactivate Caps Word.
|
|
}
|
|
}
|