qmk_firmware/tmk_core/common/action.c

1061 lines
33 KiB
C
Raw Normal View History

/*
Copyright 2012,2013 Jun Wako <wakojun@gmail.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "host.h"
#include "keycode.h"
#include "keyboard.h"
#include "mousekey.h"
#include "command.h"
#include "led.h"
#include "action_layer.h"
#include "action_tapping.h"
#include "action_macro.h"
#include "action_util.h"
#include "action.h"
#include "wait.h"
#ifdef BACKLIGHT_ENABLE
# include "backlight.h"
#endif
2016-04-29 03:23:33 +00:00
#ifdef DEBUG_ACTION
2019-08-30 18:19:03 +00:00
# include "debug.h"
2016-04-29 03:23:33 +00:00
#else
2019-08-30 18:19:03 +00:00
# include "nodebug.h"
2016-04-29 03:23:33 +00:00
#endif
2017-05-26 18:35:31 +00:00
int tp_buttons;
#ifdef RETRO_TAPPING
int retro_tapping_counter = 0;
#endif
2017-02-13 01:03:07 +00:00
#ifdef FAUXCLICKY_ENABLE
2019-08-30 18:19:03 +00:00
# include <fauxclicky.h>
2017-02-13 01:03:07 +00:00
#endif
#ifdef IGNORE_MOD_TAP_INTERRUPT_PER_KEY
__attribute__((weak)) bool get_ignore_mod_tap_interrupt(uint16_t keycode) { return false; }
#endif
#ifndef TAP_CODE_DELAY
2019-08-30 18:19:03 +00:00
# define TAP_CODE_DELAY 0
#endif
#ifndef TAP_HOLD_CAPS_DELAY
2019-08-30 18:19:03 +00:00
# define TAP_HOLD_CAPS_DELAY 80
#endif
/** \brief Called to execute an action.
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void action_exec(keyevent_t event) {
if (!IS_NOEVENT(event)) {
dprint("\n---- action_exec: start -----\n");
2019-08-30 18:19:03 +00:00
dprint("EVENT: ");
debug_event(event);
dprintln();
#ifdef RETRO_TAPPING
retro_tapping_counter++;
#endif
}
2017-02-13 01:03:07 +00:00
#ifdef FAUXCLICKY_ENABLE
if (IS_PRESSED(event)) {
FAUXCLICKY_ACTION_PRESS;
}
if (IS_RELEASED(event)) {
FAUXCLICKY_ACTION_RELEASE;
}
fauxclicky_check();
#endif
#ifdef SWAP_HANDS_ENABLE
if (!IS_NOEVENT(event)) {
process_hand_swap(&event);
}
#endif
2019-08-30 18:19:03 +00:00
keyrecord_t record = {.event = event};
#ifndef NO_ACTION_ONESHOT
# if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
if (has_oneshot_layer_timed_out()) {
clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED);
}
2017-06-17 22:42:32 +00:00
if (has_oneshot_mods_timed_out()) {
clear_oneshot_mods();
}
# endif
#endif
#ifndef NO_ACTION_TAPPING
action_tapping_process(record);
#else
process_record(&record);
if (!IS_NOEVENT(record.event)) {
2019-08-30 18:19:03 +00:00
dprint("processed: ");
debug_record(record);
dprintln();
}
#endif
}
#ifdef SWAP_HANDS_ENABLE
bool swap_hands = false;
2019-08-30 18:19:03 +00:00
bool swap_held = false;
/** \brief Process Hand Swap
*
* FIXME: Needs documentation.
*/
void process_hand_swap(keyevent_t *event) {
static swap_state_row_t swap_state[MATRIX_ROWS];
2019-08-30 18:19:03 +00:00
keypos_t pos = event->key;
swap_state_row_t col_bit = (swap_state_row_t)1 << pos.col;
bool do_swap = event->pressed ? swap_hands : swap_state[pos.row] & (col_bit);
if (do_swap) {
event->key = hand_swap_config[pos.row][pos.col];
swap_state[pos.row] |= col_bit;
} else {
swap_state[pos.row] &= ~(col_bit);
}
}
#endif
#if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
bool disable_action_cache = false;
2019-08-30 18:19:03 +00:00
void process_record_nocache(keyrecord_t *record) {
disable_action_cache = true;
process_record(record);
disable_action_cache = false;
}
#else
2019-08-30 18:19:03 +00:00
void process_record_nocache(keyrecord_t *record) { process_record(record); }
#endif
2019-08-30 18:19:03 +00:00
__attribute__((weak)) bool process_record_quantum(keyrecord_t *record) { return true; }
__attribute__((weak)) void post_process_record_quantum(keyrecord_t *record) {}
#ifndef NO_ACTION_TAPPING
/** \brief Allows for handling tap-hold actions immediately instead of waiting for TAPPING_TERM or another keypress.
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void process_record_tap_hint(keyrecord_t *record) {
action_t action = layer_switch_get_action(record->event.key);
switch (action.kind.id) {
2019-08-30 18:19:03 +00:00
# ifdef SWAP_HANDS_ENABLE
case ACT_SWAP_HANDS:
switch (action.swap.code) {
case OP_SH_TAP_TOGGLE:
default:
swap_hands = !swap_hands;
2019-08-30 18:19:03 +00:00
swap_held = true;
}
break;
2019-08-30 18:19:03 +00:00
# endif
}
}
#endif
/** \brief Take a key event (key press or key release) and processes it.
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void process_record(keyrecord_t *record) {
if (IS_NOEVENT(record->event)) {
return;
2019-08-30 18:19:03 +00:00
}
if (!process_record_quantum(record)) return;
process_record_handler(record);
post_process_record_quantum(record);
}
void process_record_handler(keyrecord_t *record) {
action_t action = store_or_get_action(record->event.pressed, record->event.key);
2019-08-30 18:19:03 +00:00
dprint("ACTION: ");
debug_action(action);
#ifndef NO_ACTION_LAYER
2019-08-30 18:19:03 +00:00
dprint(" layer_state: ");
layer_debug();
dprint(" default_layer_state: ");
default_layer_debug();
#endif
dprintln();
process_action(record, action);
}
/** \brief Take an action and processes it.
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void process_action(keyrecord_t *record, action_t action) {
keyevent_t event = record->event;
#ifndef NO_ACTION_TAPPING
uint8_t tap_count = record->tap.count;
#endif
if (event.pressed) {
// clear the potential weak mods left by previously pressed keys
clear_weak_mods();
}
#ifndef NO_ACTION_ONESHOT
bool do_release_oneshot = false;
// notice we only clear the one shot layer if the pressed key is not a modifier.
if (is_oneshot_layer_active() && event.pressed && !IS_MOD(action.key.code)) {
clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED);
do_release_oneshot = !is_oneshot_layer_active();
}
#endif
switch (action.kind.id) {
/* Key and Mods */
case ACT_LMODS:
2019-08-30 18:19:03 +00:00
case ACT_RMODS: {
uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods : action.key.mods << 4;
if (event.pressed) {
if (mods) {
if (IS_MOD(action.key.code) || action.key.code == KC_NO) {
// e.g. LSFT(KC_LGUI): we don't want the LSFT to be weak as it would make it useless.
// This also makes LSFT(KC_LGUI) behave exactly the same as LGUI(KC_LSFT).
// Same applies for some keys like KC_MEH which are declared as MEH(KC_NO).
add_mods(mods);
} else {
add_weak_mods(mods);
}
2019-08-30 18:19:03 +00:00
send_keyboard_report();
}
register_code(action.key.code);
} else {
unregister_code(action.key.code);
if (mods) {
if (IS_MOD(action.key.code) || action.key.code == KC_NO) {
del_mods(mods);
} else {
del_weak_mods(mods);
}
2019-08-30 18:19:03 +00:00
send_keyboard_report();
}
}
2019-08-30 18:19:03 +00:00
} break;
#ifndef NO_ACTION_TAPPING
case ACT_LMODS_TAP:
2019-08-30 18:19:03 +00:00
case ACT_RMODS_TAP: {
uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods : action.key.mods << 4;
switch (action.layer_tap.code) {
# ifndef NO_ACTION_ONESHOT
case MODS_ONESHOT:
// Oneshot modifier
if (event.pressed) {
if (tap_count == 0) {
dprint("MODS_TAP: Oneshot: 0\n");
register_mods(mods | get_oneshot_mods());
} else if (tap_count == 1) {
dprint("MODS_TAP: Oneshot: start\n");
set_oneshot_mods(mods | get_oneshot_mods());
# if defined(ONESHOT_TAP_TOGGLE) && ONESHOT_TAP_TOGGLE > 1
} else if (tap_count == ONESHOT_TAP_TOGGLE) {
dprint("MODS_TAP: Toggling oneshot");
clear_oneshot_mods();
set_oneshot_locked_mods(mods);
register_mods(mods);
# endif
} else {
2019-08-30 18:19:03 +00:00
register_mods(mods | get_oneshot_mods());
}
} else {
if (tap_count == 0) {
clear_oneshot_mods();
unregister_mods(mods);
} else if (tap_count == 1) {
// Retain Oneshot mods
# if defined(ONESHOT_TAP_TOGGLE) && ONESHOT_TAP_TOGGLE > 1
if (mods & get_mods()) {
clear_oneshot_locked_mods();
clear_oneshot_mods();
unregister_mods(mods);
}
2019-08-30 18:19:03 +00:00
} else if (tap_count == ONESHOT_TAP_TOGGLE) {
// Toggle Oneshot Layer
# endif
} else {
clear_oneshot_mods();
unregister_mods(mods);
}
2019-08-30 18:19:03 +00:00
}
break;
# endif
case MODS_TAP_TOGGLE:
if (event.pressed) {
if (tap_count <= TAPPING_TOGGLE) {
register_mods(mods);
}
} else {
if (tap_count < TAPPING_TOGGLE) {
unregister_mods(mods);
}
}
break;
default:
if (event.pressed) {
if (tap_count > 0) {
# if !defined(IGNORE_MOD_TAP_INTERRUPT) || defined(IGNORE_MOD_TAP_INTERRUPT_PER_KEY)
if (
# ifdef IGNORE_MOD_TAP_INTERRUPT_PER_KEY
!get_ignore_mod_tap_interrupt(get_event_keycode(record->event)) &&
# endif
record->tap.interrupted) {
2019-08-30 18:19:03 +00:00
dprint("mods_tap: tap: cancel: add_mods\n");
// ad hoc: set 0 to cancel tap
record->tap.count = 0;
register_mods(mods);
2019-08-30 18:19:03 +00:00
} else
# endif
{
dprint("MODS_TAP: Tap: register_code\n");
register_code(action.key.code);
}
} else {
2019-08-30 18:19:03 +00:00
dprint("MODS_TAP: No tap: add_mods\n");
register_mods(mods);
}
2019-08-30 18:19:03 +00:00
} else {
if (tap_count > 0) {
dprint("MODS_TAP: Tap: unregister_code\n");
if (action.layer_tap.code == KC_CAPS) {
wait_ms(TAP_HOLD_CAPS_DELAY);
}
2019-08-30 18:19:03 +00:00
unregister_code(action.key.code);
} else {
2019-08-30 18:19:03 +00:00
dprint("MODS_TAP: No tap: add_mods\n");
unregister_mods(mods);
}
2019-08-30 18:19:03 +00:00
}
break;
}
2019-08-30 18:19:03 +00:00
} break;
#endif
#ifdef EXTRAKEY_ENABLE
/* other HID usage */
case ACT_USAGE:
switch (action.usage.page) {
case PAGE_SYSTEM:
if (event.pressed) {
host_system_send(action.usage.code);
} else {
host_system_send(0);
}
break;
case PAGE_CONSUMER:
if (event.pressed) {
host_consumer_send(action.usage.code);
} else {
host_consumer_send(0);
}
break;
}
break;
#endif
#ifdef MOUSEKEY_ENABLE
/* Mouse key */
case ACT_MOUSEKEY:
if (event.pressed) {
2017-05-26 18:35:31 +00:00
switch (action.key.code) {
case KC_MS_BTN1:
2019-08-30 18:19:03 +00:00
tp_buttons |= (1 << 0);
2017-05-26 18:35:31 +00:00
break;
case KC_MS_BTN2:
2019-08-30 18:19:03 +00:00
tp_buttons |= (1 << 1);
2017-05-26 18:35:31 +00:00
break;
case KC_MS_BTN3:
2019-08-30 18:19:03 +00:00
tp_buttons |= (1 << 2);
2017-05-26 18:35:31 +00:00
break;
default:
2017-05-29 17:21:38 +00:00
break;
2017-05-26 18:35:31 +00:00
}
2017-05-29 17:21:38 +00:00
mousekey_on(action.key.code);
mousekey_send();
} else {
2017-05-26 18:35:31 +00:00
switch (action.key.code) {
case KC_MS_BTN1:
2019-08-30 18:19:03 +00:00
tp_buttons &= ~(1 << 0);
2017-05-26 18:35:31 +00:00
break;
case KC_MS_BTN2:
2019-08-30 18:19:03 +00:00
tp_buttons &= ~(1 << 1);
2017-05-26 18:35:31 +00:00
break;
case KC_MS_BTN3:
2019-08-30 18:19:03 +00:00
tp_buttons &= ~(1 << 2);
2017-05-26 18:35:31 +00:00
break;
default:
2017-05-29 17:21:38 +00:00
break;
2017-05-26 18:35:31 +00:00
}
2017-05-29 17:21:38 +00:00
mousekey_off(action.key.code);
mousekey_send();
}
break;
#endif
#ifndef NO_ACTION_LAYER
case ACT_LAYER:
if (action.layer_bitop.on == 0) {
/* Default Layer Bitwise Operation */
if (!event.pressed) {
2019-08-30 18:19:03 +00:00
uint8_t shift = action.layer_bitop.part * 4;
layer_state_t bits = ((layer_state_t)action.layer_bitop.bits) << shift;
layer_state_t mask = (action.layer_bitop.xbit) ? ~(((layer_state_t)0xf) << shift) : 0;
switch (action.layer_bitop.op) {
2019-08-30 18:19:03 +00:00
case OP_BIT_AND:
default_layer_and(bits | mask);
break;
case OP_BIT_OR:
default_layer_or(bits | mask);
break;
case OP_BIT_XOR:
default_layer_xor(bits | mask);
break;
case OP_BIT_SET:
default_layer_set(bits | mask);
break;
}
}
} else {
/* Layer Bitwise Operation */
2019-08-30 18:19:03 +00:00
if (event.pressed ? (action.layer_bitop.on & ON_PRESS) : (action.layer_bitop.on & ON_RELEASE)) {
uint8_t shift = action.layer_bitop.part * 4;
layer_state_t bits = ((layer_state_t)action.layer_bitop.bits) << shift;
layer_state_t mask = (action.layer_bitop.xbit) ? ~(((layer_state_t)0xf) << shift) : 0;
switch (action.layer_bitop.op) {
2019-08-30 18:19:03 +00:00
case OP_BIT_AND:
layer_and(bits | mask);
break;
case OP_BIT_OR:
layer_or(bits | mask);
break;
case OP_BIT_XOR:
layer_xor(bits | mask);
break;
case OP_BIT_SET:
layer_state_set(bits | mask);
break;
}
}
}
break;
case ACT_LAYER_MODS:
if (event.pressed) {
layer_on(action.layer_mods.layer);
register_mods(action.layer_mods.mods);
} else {
unregister_mods(action.layer_mods.mods);
layer_off(action.layer_mods.layer);
}
break;
2019-08-30 18:19:03 +00:00
# ifndef NO_ACTION_TAPPING
case ACT_LAYER_TAP:
case ACT_LAYER_TAP_EXT:
switch (action.layer_tap.code) {
case OP_TAP_TOGGLE:
/* tap toggle */
if (event.pressed) {
if (tap_count < TAPPING_TOGGLE) {
layer_invert(action.layer_tap.val);
}
} else {
if (tap_count <= TAPPING_TOGGLE) {
layer_invert(action.layer_tap.val);
}
}
break;
case OP_ON_OFF:
2019-08-30 18:19:03 +00:00
event.pressed ? layer_on(action.layer_tap.val) : layer_off(action.layer_tap.val);
break;
case OP_OFF_ON:
2019-08-30 18:19:03 +00:00
event.pressed ? layer_off(action.layer_tap.val) : layer_on(action.layer_tap.val);
break;
case OP_SET_CLEAR:
2019-08-30 18:19:03 +00:00
event.pressed ? layer_move(action.layer_tap.val) : layer_clear();
break;
2019-08-30 18:19:03 +00:00
# ifndef NO_ACTION_ONESHOT
case OP_ONESHOT:
// Oneshot modifier
2019-08-30 18:19:03 +00:00
# if defined(ONESHOT_TAP_TOGGLE) && ONESHOT_TAP_TOGGLE > 1
do_release_oneshot = false;
if (event.pressed) {
del_mods(get_oneshot_locked_mods());
if (get_oneshot_layer_state() == ONESHOT_TOGGLED) {
reset_oneshot_layer();
layer_off(action.layer_tap.val);
break;
} else if (tap_count < ONESHOT_TAP_TOGGLE) {
layer_on(action.layer_tap.val);
set_oneshot_layer(action.layer_tap.val, ONESHOT_START);
}
} else {
add_mods(get_oneshot_locked_mods());
if (tap_count >= ONESHOT_TAP_TOGGLE) {
reset_oneshot_layer();
clear_oneshot_locked_mods();
set_oneshot_layer(action.layer_tap.val, ONESHOT_TOGGLED);
} else {
clear_oneshot_layer_state(ONESHOT_PRESSED);
}
}
2019-08-30 18:19:03 +00:00
# else
if (event.pressed) {
layer_on(action.layer_tap.val);
set_oneshot_layer(action.layer_tap.val, ONESHOT_START);
} else {
clear_oneshot_layer_state(ONESHOT_PRESSED);
if (tap_count > 1) {
clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED);
}
}
2019-08-30 18:19:03 +00:00
# endif
break;
2019-08-30 18:19:03 +00:00
# endif
default:
/* tap key */
if (event.pressed) {
if (tap_count > 0) {
dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
register_code(action.layer_tap.code);
} else {
dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
layer_on(action.layer_tap.val);
}
} else {
if (tap_count > 0) {
dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
if (action.layer_tap.code == KC_CAPS) {
wait_ms(TAP_HOLD_CAPS_DELAY);
} else {
wait_ms(TAP_CODE_DELAY);
2019-08-30 18:19:03 +00:00
}
unregister_code(action.layer_tap.code);
} else {
dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
layer_off(action.layer_tap.val);
}
}
break;
}
break;
2019-08-30 18:19:03 +00:00
# endif
#endif
2019-08-30 18:19:03 +00:00
/* Extentions */
#ifndef NO_ACTION_MACRO
case ACT_MACRO:
action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
break;
#endif
#ifdef SWAP_HANDS_ENABLE
case ACT_SWAP_HANDS:
switch (action.swap.code) {
case OP_SH_TOGGLE:
if (event.pressed) {
swap_hands = !swap_hands;
}
break;
case OP_SH_ON_OFF:
swap_hands = event.pressed;
break;
case OP_SH_OFF_ON:
swap_hands = !event.pressed;
break;
case OP_SH_ON:
if (!event.pressed) {
swap_hands = true;
}
break;
case OP_SH_OFF:
if (!event.pressed) {
swap_hands = false;
}
break;
2019-08-30 18:19:03 +00:00
# ifndef NO_ACTION_TAPPING
case OP_SH_TAP_TOGGLE:
/* tap toggle */
if (event.pressed) {
if (swap_held) {
swap_held = false;
} else {
swap_hands = !swap_hands;
}
} else {
if (tap_count < TAPPING_TOGGLE) {
swap_hands = !swap_hands;
}
}
break;
default:
/* tap key */
if (tap_count > 0) {
if (swap_held) {
2019-08-30 18:19:03 +00:00
swap_hands = !swap_hands; // undo hold set up in _tap_hint
swap_held = false;
}
if (event.pressed) {
register_code(action.swap.code);
} else {
wait_ms(TAP_CODE_DELAY);
unregister_code(action.swap.code);
2019-08-30 18:19:03 +00:00
*record = (keyrecord_t){}; // hack: reset tap mode
}
} else {
if (swap_held && !event.pressed) {
2019-08-30 18:19:03 +00:00
swap_hands = !swap_hands; // undo hold set up in _tap_hint
swap_held = false;
}
}
2019-08-30 18:19:03 +00:00
# endif
}
#endif
#ifndef NO_ACTION_FUNCTION
case ACT_FUNCTION:
action_function(record, action.func.id, action.func.opt);
break;
#endif
default:
break;
}
#ifndef NO_ACTION_LAYER
// if this event is a layer action, update the leds
switch (action.kind.id) {
case ACT_LAYER:
case ACT_LAYER_MODS:
2019-08-30 18:19:03 +00:00
# ifndef NO_ACTION_TAPPING
case ACT_LAYER_TAP:
case ACT_LAYER_TAP_EXT:
2019-08-30 18:19:03 +00:00
# endif
led_set(host_keyboard_leds());
break;
default:
break;
}
#endif
#ifndef NO_ACTION_TAPPING
2019-08-30 18:19:03 +00:00
# ifdef RETRO_TAPPING
if (!is_tap_action(action)) {
retro_tapping_counter = 0;
2019-08-30 18:19:03 +00:00
} else {
if (event.pressed) {
if (tap_count > 0) {
retro_tapping_counter = 0;
} else {
}
} else {
if (tap_count > 0) {
retro_tapping_counter = 0;
} else {
if (retro_tapping_counter == 2) {
tap_code(action.layer_tap.code);
}
retro_tapping_counter = 0;
}
}
}
2019-08-30 18:19:03 +00:00
# endif
#endif
#ifndef NO_ACTION_ONESHOT
/* Because we switch layers after a oneshot event, we need to release the
* key before we leave the layer or no key up event will be generated.
*/
2019-08-30 18:19:03 +00:00
if (do_release_oneshot && !(get_oneshot_layer_state() & ONESHOT_PRESSED)) {
record->event.pressed = false;
layer_on(get_oneshot_layer());
process_record(record);
layer_off(get_oneshot_layer());
}
#endif
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void register_code(uint8_t code) {
if (code == KC_NO) {
return;
}
#ifdef LOCKING_SUPPORT_ENABLE
else if (KC_LOCKING_CAPS == code) {
2019-08-30 18:19:03 +00:00
# ifdef LOCKING_RESYNC_ENABLE
// Resync: ignore if caps lock already is on
2019-08-30 18:19:03 +00:00
if (host_keyboard_leds() & (1 << USB_LED_CAPS_LOCK)) return;
# endif
add_key(KC_CAPSLOCK);
send_keyboard_report();
wait_ms(100);
del_key(KC_CAPSLOCK);
send_keyboard_report();
}
else if (KC_LOCKING_NUM == code) {
2019-08-30 18:19:03 +00:00
# ifdef LOCKING_RESYNC_ENABLE
if (host_keyboard_leds() & (1 << USB_LED_NUM_LOCK)) return;
# endif
add_key(KC_NUMLOCK);
send_keyboard_report();
wait_ms(100);
del_key(KC_NUMLOCK);
send_keyboard_report();
}
else if (KC_LOCKING_SCROLL == code) {
2019-08-30 18:19:03 +00:00
# ifdef LOCKING_RESYNC_ENABLE
if (host_keyboard_leds() & (1 << USB_LED_SCROLL_LOCK)) return;
# endif
add_key(KC_SCROLLLOCK);
send_keyboard_report();
wait_ms(100);
del_key(KC_SCROLLLOCK);
send_keyboard_report();
}
#endif
2019-08-30 18:19:03 +00:00
else if
IS_KEY(code) {
// TODO: should push command_proc out of this block?
if (command_proc(code)) return;
#ifndef NO_ACTION_ONESHOT
/* TODO: remove
if (oneshot_state.mods && !oneshot_state.disabled) {
uint8_t tmp_mods = get_mods();
add_mods(oneshot_state.mods);
add_key(code);
send_keyboard_report();
set_mods(tmp_mods);
send_keyboard_report();
oneshot_cancel();
2015-10-28 02:19:13 +00:00
} else
*/
#endif
2019-08-30 18:19:03 +00:00
{
// Force a new key press if the key is already pressed
// without this, keys with the same keycode, but different
// modifiers will be reported incorrectly, see issue #1708
if (is_key_pressed(keyboard_report, code)) {
del_key(code);
send_keyboard_report();
}
2019-08-30 18:19:03 +00:00
add_key(code);
send_keyboard_report();
}
}
else if
IS_MOD(code) {
add_mods(MOD_BIT(code));
send_keyboard_report();
}
#ifdef EXTRAKEY_ENABLE
2019-08-30 18:19:03 +00:00
else if
IS_SYSTEM(code) { host_system_send(KEYCODE2SYSTEM(code)); }
else if
IS_CONSUMER(code) { host_consumer_send(KEYCODE2CONSUMER(code)); }
#endif
2019-08-30 18:19:03 +00:00
#ifdef MOUSEKEY_ENABLE
else if
IS_MOUSEKEY(code) {
mousekey_on(code);
mousekey_send();
}
#endif
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void unregister_code(uint8_t code) {
if (code == KC_NO) {
return;
}
#ifdef LOCKING_SUPPORT_ENABLE
else if (KC_LOCKING_CAPS == code) {
2019-08-30 18:19:03 +00:00
# ifdef LOCKING_RESYNC_ENABLE
// Resync: ignore if caps lock already is off
2019-08-30 18:19:03 +00:00
if (!(host_keyboard_leds() & (1 << USB_LED_CAPS_LOCK))) return;
# endif
add_key(KC_CAPSLOCK);
send_keyboard_report();
del_key(KC_CAPSLOCK);
send_keyboard_report();
}
else if (KC_LOCKING_NUM == code) {
2019-08-30 18:19:03 +00:00
# ifdef LOCKING_RESYNC_ENABLE
if (!(host_keyboard_leds() & (1 << USB_LED_NUM_LOCK))) return;
# endif
add_key(KC_NUMLOCK);
send_keyboard_report();
del_key(KC_NUMLOCK);
send_keyboard_report();
}
else if (KC_LOCKING_SCROLL == code) {
2019-08-30 18:19:03 +00:00
# ifdef LOCKING_RESYNC_ENABLE
if (!(host_keyboard_leds() & (1 << USB_LED_SCROLL_LOCK))) return;
# endif
add_key(KC_SCROLLLOCK);
send_keyboard_report();
del_key(KC_SCROLLLOCK);
send_keyboard_report();
}
#endif
2019-08-30 18:19:03 +00:00
else if
IS_KEY(code) {
del_key(code);
send_keyboard_report();
}
else if
IS_MOD(code) {
del_mods(MOD_BIT(code));
send_keyboard_report();
}
else if
IS_SYSTEM(code) { host_system_send(0); }
else if
IS_CONSUMER(code) { host_consumer_send(0); }
#ifdef MOUSEKEY_ENABLE
else if
IS_MOUSEKEY(code) {
mousekey_off(code);
mousekey_send();
}
#endif
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
void tap_code(uint8_t code) {
2019-08-30 18:19:03 +00:00
register_code(code);
if (code == KC_CAPS) {
wait_ms(TAP_HOLD_CAPS_DELAY);
} else {
wait_ms(TAP_CODE_DELAY);
}
unregister_code(code);
}
/** \brief Adds the given physically pressed modifiers and sends a keyboard report immediately.
*
* \param mods A bitfield of modifiers to unregister.
*/
2019-08-30 18:19:03 +00:00
void register_mods(uint8_t mods) {
if (mods) {
add_mods(mods);
send_keyboard_report();
}
}
/** \brief Removes the given physically pressed modifiers and sends a keyboard report immediately.
*
* \param mods A bitfield of modifiers to unregister.
*/
2019-08-30 18:19:03 +00:00
void unregister_mods(uint8_t mods) {
if (mods) {
del_mods(mods);
send_keyboard_report();
}
}
/** \brief Adds the given weak modifiers and sends a keyboard report immediately.
*
* \param mods A bitfield of modifiers to register.
*/
void register_weak_mods(uint8_t mods) {
if (mods) {
add_weak_mods(mods);
send_keyboard_report();
}
}
/** \brief Removes the given weak modifiers and sends a keyboard report immediately.
*
* \param mods A bitfield of modifiers to unregister.
*/
void unregister_weak_mods(uint8_t mods) {
if (mods) {
del_weak_mods(mods);
send_keyboard_report();
}
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void clear_keyboard(void) {
clear_mods();
clear_keyboard_but_mods();
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void clear_keyboard_but_mods(void) {
clear_keys();
clear_keyboard_but_mods_and_keys();
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void clear_keyboard_but_mods_and_keys() {
clear_weak_mods();
clear_macro_mods();
send_keyboard_report();
#ifdef MOUSEKEY_ENABLE
mousekey_clear();
mousekey_send();
#endif
#ifdef EXTRAKEY_ENABLE
host_system_send(0);
host_consumer_send(0);
#endif
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
bool is_tap_key(keypos_t key) {
action_t action = layer_switch_get_action(key);
return is_tap_action(action);
}
/** \brief Utilities for actions. (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
bool is_tap_action(action_t action) {
switch (action.kind.id) {
case ACT_LMODS_TAP:
case ACT_RMODS_TAP:
case ACT_LAYER_TAP:
case ACT_LAYER_TAP_EXT:
2015-04-23 11:15:35 +00:00
switch (action.layer_tap.code) {
case KC_NO ... KC_RGUI:
2015-04-23 11:15:35 +00:00
case OP_TAP_TOGGLE:
case OP_ONESHOT:
2015-04-23 11:15:35 +00:00
return true;
}
return false;
case ACT_SWAP_HANDS:
switch (action.swap.code) {
case KC_NO ... KC_RGUI:
case OP_SH_TAP_TOGGLE:
return true;
}
return false;
case ACT_MACRO:
case ACT_FUNCTION:
2019-08-30 18:19:03 +00:00
if (action.func.opt & FUNC_TAP) {
return true;
}
return false;
}
return false;
}
/** \brief Debug print (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void debug_event(keyevent_t event) { dprintf("%04X%c(%u)", (event.key.row << 8 | event.key.col), (event.pressed ? 'd' : 'u'), event.time); }
/** \brief Debug print (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void debug_record(keyrecord_t record) {
debug_event(record.event);
#ifndef NO_ACTION_TAPPING
dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
#endif
}
/** \brief Debug print (FIXME: Needs better description)
*
* FIXME: Needs documentation.
*/
2019-08-30 18:19:03 +00:00
void debug_action(action_t action) {
switch (action.kind.id) {
2019-08-30 18:19:03 +00:00
case ACT_LMODS:
dprint("ACT_LMODS");
break;
case ACT_RMODS:
dprint("ACT_RMODS");
break;
case ACT_LMODS_TAP:
dprint("ACT_LMODS_TAP");
break;
case ACT_RMODS_TAP:
dprint("ACT_RMODS_TAP");
break;
case ACT_USAGE:
dprint("ACT_USAGE");
break;
case ACT_MOUSEKEY:
dprint("ACT_MOUSEKEY");
break;
case ACT_LAYER:
dprint("ACT_LAYER");
break;
case ACT_LAYER_MODS:
dprint("ACT_LAYER_MODS");
break;
case ACT_LAYER_TAP:
dprint("ACT_LAYER_TAP");
break;
case ACT_LAYER_TAP_EXT:
dprint("ACT_LAYER_TAP_EXT");
break;
case ACT_MACRO:
dprint("ACT_MACRO");
break;
case ACT_FUNCTION:
dprint("ACT_FUNCTION");
break;
case ACT_SWAP_HANDS:
dprint("ACT_SWAP_HANDS");
break;
default:
dprint("UNKNOWN");
break;
}
2019-08-30 18:19:03 +00:00
dprintf("[%X:%02X]", action.kind.param >> 8, action.kind.param & 0xff);
}