1186 lines
40 KiB
C
1186 lines
40 KiB
C
/*
|
|
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 <limits.h>
|
|
|
|
#include "host.h"
|
|
#include "keycode.h"
|
|
#include "keyboard.h"
|
|
#include "keymap.h"
|
|
#include "mousekey.h"
|
|
#include "programmable_button.h"
|
|
#include "command.h"
|
|
#include "led.h"
|
|
#include "action_layer.h"
|
|
#include "action_tapping.h"
|
|
#include "action_util.h"
|
|
#include "action.h"
|
|
#include "wait.h"
|
|
#include "keycode_config.h"
|
|
|
|
#ifdef BACKLIGHT_ENABLE
|
|
# include "backlight.h"
|
|
#endif
|
|
|
|
#ifdef POINTING_DEVICE_ENABLE
|
|
# include "pointing_device.h"
|
|
#endif
|
|
|
|
int tp_buttons;
|
|
|
|
#if defined(RETRO_TAPPING) || defined(RETRO_TAPPING_PER_KEY) || (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT))
|
|
int retro_tapping_counter = 0;
|
|
#endif
|
|
|
|
#if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT) && !defined(NO_ACTION_TAPPING)
|
|
# include "process_auto_shift.h"
|
|
#endif
|
|
|
|
#ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY
|
|
__attribute__((weak)) bool get_hold_on_other_key_press(uint16_t keycode, keyrecord_t *record) {
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
#ifdef RETRO_TAPPING_PER_KEY
|
|
__attribute__((weak)) bool get_retro_tapping(uint16_t keycode, keyrecord_t *record) {
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
__attribute__((weak)) bool pre_process_record_quantum(keyrecord_t *record) {
|
|
return true;
|
|
}
|
|
|
|
/** \brief Called to execute an action.
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
void action_exec(keyevent_t event) {
|
|
if (IS_EVENT(event)) {
|
|
ac_dprintf("\n---- action_exec: start -----\n");
|
|
ac_dprintf("EVENT: ");
|
|
debug_event(event);
|
|
ac_dprintf("\n");
|
|
#if defined(RETRO_TAPPING) || defined(RETRO_TAPPING_PER_KEY) || (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT))
|
|
retro_tapping_counter++;
|
|
#endif
|
|
}
|
|
|
|
if (event.pressed) {
|
|
// clear the potential weak mods left by previously pressed keys
|
|
clear_weak_mods();
|
|
}
|
|
|
|
#ifdef SWAP_HANDS_ENABLE
|
|
// Swap hands handles both keys and encoders, if ENCODER_MAP_ENABLE is defined.
|
|
if (IS_EVENT(event)) {
|
|
process_hand_swap(&event);
|
|
}
|
|
#endif
|
|
|
|
keyrecord_t record = {.event = event};
|
|
|
|
#ifndef NO_ACTION_ONESHOT
|
|
if (keymap_config.oneshot_enable) {
|
|
# if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
if (has_oneshot_layer_timed_out()) {
|
|
clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED);
|
|
}
|
|
if (has_oneshot_mods_timed_out()) {
|
|
clear_oneshot_mods();
|
|
}
|
|
# ifdef SWAP_HANDS_ENABLE
|
|
if (has_oneshot_swaphands_timed_out()) {
|
|
clear_oneshot_swaphands();
|
|
}
|
|
# endif
|
|
# endif
|
|
}
|
|
#endif
|
|
|
|
#ifndef NO_ACTION_TAPPING
|
|
# if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
|
|
if (event.pressed) {
|
|
retroshift_poll_time(&event);
|
|
}
|
|
# endif
|
|
if (IS_NOEVENT(record.event) || pre_process_record_quantum(&record)) {
|
|
action_tapping_process(record);
|
|
}
|
|
#else
|
|
if (IS_NOEVENT(record.event) || pre_process_record_quantum(&record)) {
|
|
process_record(&record);
|
|
}
|
|
if (IS_EVENT(record.event)) {
|
|
ac_dprintf("processed: ");
|
|
debug_record(record);
|
|
dprintln();
|
|
}
|
|
#endif
|
|
}
|
|
|
|
#ifdef SWAP_HANDS_ENABLE
|
|
extern const keypos_t PROGMEM hand_swap_config[MATRIX_ROWS][MATRIX_COLS];
|
|
# ifdef ENCODER_MAP_ENABLE
|
|
extern const uint8_t PROGMEM encoder_hand_swap_config[NUM_ENCODERS];
|
|
# endif // ENCODER_MAP_ENABLE
|
|
|
|
bool swap_hands = false;
|
|
bool swap_held = false;
|
|
|
|
bool should_swap_hands(size_t index, uint8_t *swap_state, bool pressed) {
|
|
size_t array_index = index / (CHAR_BIT);
|
|
size_t bit_index = index % (CHAR_BIT);
|
|
uint8_t bit_val = 1 << bit_index;
|
|
bool do_swap = pressed ? swap_hands : swap_state[array_index] & bit_val;
|
|
return do_swap;
|
|
}
|
|
|
|
void set_swap_hands_state(size_t index, uint8_t *swap_state, bool on) {
|
|
size_t array_index = index / (CHAR_BIT);
|
|
size_t bit_index = index % (CHAR_BIT);
|
|
uint8_t bit_val = 1 << bit_index;
|
|
if (on) {
|
|
swap_state[array_index] |= bit_val;
|
|
} else {
|
|
swap_state[array_index] &= ~bit_val;
|
|
}
|
|
}
|
|
|
|
bool is_swap_hands_on(void) {
|
|
return swap_hands;
|
|
}
|
|
|
|
/** \brief Process Hand Swap
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
void process_hand_swap(keyevent_t *event) {
|
|
keypos_t pos = event->key;
|
|
if (pos.row < MATRIX_ROWS && pos.col < MATRIX_COLS) {
|
|
static uint8_t matrix_swap_state[((MATRIX_ROWS * MATRIX_COLS) + (CHAR_BIT)-1) / (CHAR_BIT)];
|
|
size_t index = (size_t)(pos.row * MATRIX_COLS) + pos.col;
|
|
bool do_swap = should_swap_hands(index, matrix_swap_state, event->pressed);
|
|
if (do_swap) {
|
|
event->key.row = pgm_read_byte(&hand_swap_config[pos.row][pos.col].row);
|
|
event->key.col = pgm_read_byte(&hand_swap_config[pos.row][pos.col].col);
|
|
set_swap_hands_state(index, matrix_swap_state, true);
|
|
} else {
|
|
set_swap_hands_state(index, matrix_swap_state, false);
|
|
}
|
|
}
|
|
# ifdef ENCODER_MAP_ENABLE
|
|
else if (pos.row == KEYLOC_ENCODER_CW || pos.row == KEYLOC_ENCODER_CCW) {
|
|
static uint8_t encoder_swap_state[((NUM_ENCODERS) + (CHAR_BIT)-1) / (CHAR_BIT)];
|
|
size_t index = pos.col;
|
|
bool do_swap = should_swap_hands(index, encoder_swap_state, event->pressed);
|
|
if (do_swap) {
|
|
event->key.row = pos.row;
|
|
event->key.col = pgm_read_byte(&encoder_hand_swap_config[pos.col]);
|
|
set_swap_hands_state(index, encoder_swap_state, true);
|
|
} else {
|
|
set_swap_hands_state(index, encoder_swap_state, false);
|
|
}
|
|
}
|
|
# endif // ENCODER_MAP_ENABLE
|
|
}
|
|
#endif
|
|
|
|
#if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
|
|
bool disable_action_cache = false;
|
|
|
|
void process_record_nocache(keyrecord_t *record) {
|
|
disable_action_cache = true;
|
|
process_record(record);
|
|
disable_action_cache = false;
|
|
}
|
|
#else
|
|
void process_record_nocache(keyrecord_t *record) {
|
|
process_record(record);
|
|
}
|
|
#endif
|
|
|
|
__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.
|
|
*/
|
|
void process_record_tap_hint(keyrecord_t *record) {
|
|
action_t action = layer_switch_get_action(record->event.key);
|
|
|
|
switch (action.kind.id) {
|
|
# ifdef SWAP_HANDS_ENABLE
|
|
case ACT_SWAP_HANDS:
|
|
switch (action.swap.code) {
|
|
case OP_SH_ONESHOT:
|
|
break;
|
|
case OP_SH_TAP_TOGGLE:
|
|
default:
|
|
swap_hands = !swap_hands;
|
|
swap_held = true;
|
|
}
|
|
break;
|
|
# endif
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/** \brief Take a key event (key press or key release) and processes it.
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
void process_record(keyrecord_t *record) {
|
|
if (IS_NOEVENT(record->event)) {
|
|
return;
|
|
}
|
|
|
|
if (!process_record_quantum(record)) {
|
|
#ifndef NO_ACTION_ONESHOT
|
|
if (is_oneshot_layer_active() && record->event.pressed && keymap_config.oneshot_enable) {
|
|
clear_oneshot_layer_state(ONESHOT_OTHER_KEY_PRESSED);
|
|
}
|
|
#endif
|
|
return;
|
|
}
|
|
|
|
process_record_handler(record);
|
|
post_process_record_quantum(record);
|
|
}
|
|
|
|
void process_record_handler(keyrecord_t *record) {
|
|
#ifdef COMBO_ENABLE
|
|
action_t action;
|
|
if (record->keycode) {
|
|
action = action_for_keycode(record->keycode);
|
|
} else {
|
|
action = store_or_get_action(record->event.pressed, record->event.key);
|
|
}
|
|
#else
|
|
action_t action = store_or_get_action(record->event.pressed, record->event.key);
|
|
#endif
|
|
ac_dprintf("ACTION: ");
|
|
debug_action(action);
|
|
#ifndef NO_ACTION_LAYER
|
|
ac_dprintf(" layer_state: ");
|
|
layer_debug();
|
|
ac_dprintf(" default_layer_state: ");
|
|
default_layer_debug();
|
|
#endif
|
|
ac_dprintf("\n");
|
|
|
|
process_action(record, action);
|
|
}
|
|
|
|
/**
|
|
* @brief handles all the messy mouse stuff
|
|
*
|
|
* Handles all the edgecases and special stuff that is needed for coexistense
|
|
* of the multiple mouse subsystems.
|
|
*
|
|
* @param mouse_keycode[in] uint8_t mouse keycode
|
|
* @param pressed[in] bool
|
|
*/
|
|
|
|
void register_mouse(uint8_t mouse_keycode, bool pressed) {
|
|
#ifdef MOUSEKEY_ENABLE
|
|
// if mousekeys is enabled, let it do the brunt of the work
|
|
if (pressed) {
|
|
mousekey_on(mouse_keycode);
|
|
} else {
|
|
mousekey_off(mouse_keycode);
|
|
}
|
|
// should mousekeys send report, or does something else handle this?
|
|
switch (mouse_keycode) {
|
|
# if defined(PS2_MOUSE_ENABLE) || defined(POINTING_DEVICE_ENABLE)
|
|
case KC_MS_BTN1 ... KC_MS_BTN8:
|
|
// let pointing device handle the buttons
|
|
// expand if/when it handles more of the code
|
|
# if defined(POINTING_DEVICE_ENABLE)
|
|
pointing_device_keycode_handler(mouse_keycode, pressed);
|
|
# endif
|
|
break;
|
|
# endif
|
|
default:
|
|
mousekey_send();
|
|
break;
|
|
}
|
|
#elif defined(POINTING_DEVICE_ENABLE)
|
|
// if mousekeys isn't enabled, and pointing device is enabled, then
|
|
// let pointing device do all the heavy lifting, then
|
|
if (IS_MOUSE_KEYCODE(mouse_keycode)) {
|
|
pointing_device_keycode_handler(mouse_keycode, pressed);
|
|
}
|
|
#endif
|
|
|
|
#ifdef PS2_MOUSE_ENABLE
|
|
// make sure that ps2 mouse has button report synced
|
|
if (KC_MS_BTN1 <= mouse_keycode && mouse_keycode <= KC_MS_BTN3) {
|
|
uint8_t tmp_button_msk = MOUSE_BTN_MASK(mouse_keycode - KC_MS_BTN1);
|
|
tp_buttons = pressed ? tp_buttons | tmp_button_msk : tp_buttons & ~tmp_button_msk;
|
|
}
|
|
#endif
|
|
}
|
|
|
|
/** \brief Take an action and processes it.
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
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
|
|
|
|
#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 &&
|
|
(action.kind.id == ACT_USAGE || !(IS_MODIFIER_KEYCODE(action.key.code)
|
|
# ifndef NO_ACTION_TAPPING
|
|
|| (tap_count == 0 && (action.kind.id == ACT_LMODS_TAP || action.kind.id == ACT_RMODS_TAP))
|
|
# endif
|
|
))
|
|
# ifdef SWAP_HANDS_ENABLE
|
|
&& !(action.kind.id == ACT_SWAP_HANDS && action.swap.code == OP_SH_ONESHOT)
|
|
# endif
|
|
&& keymap_config.oneshot_enable) {
|
|
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:
|
|
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_MODIFIER_KEYCODE(action.key.code) || action.key.code == KC_NO) {
|
|
// e.g. LSFT(KC_LEFT_GUI): we don't want the LSFT to be weak as it would make it useless.
|
|
// This also makes LSFT(KC_LEFT_GUI) behave exactly the same as LGUI(KC_LEFT_SHIFT).
|
|
// Same applies for some keys like KC_MEH which are declared as MEH(KC_NO).
|
|
add_mods(mods);
|
|
} else {
|
|
add_weak_mods(mods);
|
|
}
|
|
send_keyboard_report();
|
|
}
|
|
register_code(action.key.code);
|
|
} else {
|
|
unregister_code(action.key.code);
|
|
if (mods) {
|
|
if (IS_MODIFIER_KEYCODE(action.key.code) || action.key.code == KC_NO) {
|
|
del_mods(mods);
|
|
} else {
|
|
del_weak_mods(mods);
|
|
}
|
|
send_keyboard_report();
|
|
}
|
|
}
|
|
} break;
|
|
#ifndef NO_ACTION_TAPPING
|
|
case ACT_LMODS_TAP:
|
|
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 (!keymap_config.oneshot_enable) {
|
|
if (event.pressed) {
|
|
if (mods) {
|
|
if (IS_MODIFIER_KEYCODE(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);
|
|
}
|
|
send_keyboard_report();
|
|
}
|
|
register_code(action.key.code);
|
|
} else {
|
|
unregister_code(action.key.code);
|
|
if (mods) {
|
|
if (IS_MODIFIER_KEYCODE(action.key.code) || action.key.code == KC_NO) {
|
|
del_mods(mods);
|
|
} else {
|
|
del_weak_mods(mods);
|
|
}
|
|
send_keyboard_report();
|
|
}
|
|
}
|
|
} else {
|
|
if (event.pressed) {
|
|
if (tap_count == 0) {
|
|
ac_dprintf("MODS_TAP: Oneshot: 0\n");
|
|
register_mods(mods | get_oneshot_mods());
|
|
} else if (tap_count == 1) {
|
|
ac_dprintf("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) {
|
|
ac_dprintf("MODS_TAP: Toggling oneshot");
|
|
register_mods(mods);
|
|
clear_oneshot_mods();
|
|
set_oneshot_locked_mods(mods | get_oneshot_locked_mods());
|
|
# endif
|
|
} else {
|
|
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()) {
|
|
unregister_mods(mods);
|
|
clear_oneshot_mods();
|
|
set_oneshot_locked_mods(~mods & get_oneshot_locked_mods());
|
|
}
|
|
} else if (tap_count == ONESHOT_TAP_TOGGLE) {
|
|
// Toggle Oneshot Layer
|
|
# endif
|
|
} else {
|
|
unregister_mods(mods);
|
|
clear_oneshot_mods();
|
|
}
|
|
}
|
|
}
|
|
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(HOLD_ON_OTHER_KEY_PRESS_PER_KEY)
|
|
if (
|
|
# ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY
|
|
get_hold_on_other_key_press(get_event_keycode(record->event, false), record) &&
|
|
# endif
|
|
record->tap.interrupted) {
|
|
ac_dprintf("mods_tap: tap: cancel: add_mods\n");
|
|
// ad hoc: set 0 to cancel tap
|
|
record->tap.count = 0;
|
|
register_mods(mods);
|
|
} else
|
|
# endif
|
|
{
|
|
ac_dprintf("MODS_TAP: Tap: register_code\n");
|
|
register_code(action.key.code);
|
|
}
|
|
} else {
|
|
ac_dprintf("MODS_TAP: No tap: add_mods\n");
|
|
register_mods(mods);
|
|
}
|
|
} else {
|
|
if (tap_count > 0) {
|
|
ac_dprintf("MODS_TAP: Tap: unregister_code\n");
|
|
if (action.layer_tap.code == KC_CAPS_LOCK) {
|
|
wait_ms(TAP_HOLD_CAPS_DELAY);
|
|
} else {
|
|
wait_ms(TAP_CODE_DELAY);
|
|
}
|
|
unregister_code(action.key.code);
|
|
} else {
|
|
ac_dprintf("MODS_TAP: No tap: add_mods\n");
|
|
unregister_mods(mods);
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
} break;
|
|
#endif
|
|
#ifdef EXTRAKEY_ENABLE
|
|
/* other HID usage */
|
|
case ACT_USAGE:
|
|
switch (action.usage.page) {
|
|
case PAGE_SYSTEM:
|
|
host_system_send(event.pressed ? action.usage.code : 0);
|
|
break;
|
|
case PAGE_CONSUMER:
|
|
host_consumer_send(event.pressed ? action.usage.code : 0);
|
|
break;
|
|
}
|
|
break;
|
|
#endif
|
|
/* Mouse key */
|
|
case ACT_MOUSEKEY:
|
|
register_mouse(action.key.code, event.pressed);
|
|
break;
|
|
#ifndef NO_ACTION_LAYER
|
|
case ACT_LAYER:
|
|
if (action.layer_bitop.on == 0) {
|
|
/* Default Layer Bitwise Operation */
|
|
if (!event.pressed) {
|
|
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) {
|
|
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 */
|
|
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) {
|
|
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;
|
|
# 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:
|
|
event.pressed ? layer_on(action.layer_tap.val) : layer_off(action.layer_tap.val);
|
|
break;
|
|
case OP_OFF_ON:
|
|
event.pressed ? layer_off(action.layer_tap.val) : layer_on(action.layer_tap.val);
|
|
break;
|
|
case OP_SET_CLEAR:
|
|
event.pressed ? layer_move(action.layer_tap.val) : layer_clear();
|
|
break;
|
|
# ifndef NO_ACTION_ONESHOT
|
|
case OP_ONESHOT:
|
|
// Oneshot modifier
|
|
if (!keymap_config.oneshot_enable) {
|
|
if (event.pressed) {
|
|
layer_on(action.layer_tap.val);
|
|
} else {
|
|
layer_off(action.layer_tap.val);
|
|
}
|
|
} else {
|
|
# if defined(ONESHOT_TAP_TOGGLE) && ONESHOT_TAP_TOGGLE > 1
|
|
do_release_oneshot = false;
|
|
if (event.pressed) {
|
|
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 {
|
|
if (tap_count >= ONESHOT_TAP_TOGGLE) {
|
|
reset_oneshot_layer();
|
|
set_oneshot_layer(action.layer_tap.val, ONESHOT_TOGGLED);
|
|
} else {
|
|
clear_oneshot_layer_state(ONESHOT_PRESSED);
|
|
}
|
|
}
|
|
# 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);
|
|
}
|
|
}
|
|
# endif
|
|
}
|
|
break;
|
|
# endif
|
|
default:
|
|
/* tap key */
|
|
if (event.pressed) {
|
|
if (tap_count > 0) {
|
|
ac_dprintf("KEYMAP_TAP_KEY: Tap: register_code\n");
|
|
register_code(action.layer_tap.code);
|
|
} else {
|
|
ac_dprintf("KEYMAP_TAP_KEY: No tap: On on press\n");
|
|
layer_on(action.layer_tap.val);
|
|
}
|
|
} else {
|
|
if (tap_count > 0) {
|
|
ac_dprintf("KEYMAP_TAP_KEY: Tap: unregister_code\n");
|
|
if (action.layer_tap.code == KC_CAPS_LOCK) {
|
|
wait_ms(TAP_HOLD_CAPS_DELAY);
|
|
} else {
|
|
wait_ms(TAP_CODE_DELAY);
|
|
}
|
|
unregister_code(action.layer_tap.code);
|
|
} else {
|
|
ac_dprintf("KEYMAP_TAP_KEY: No tap: Off on release\n");
|
|
layer_off(action.layer_tap.val);
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
break;
|
|
# endif
|
|
#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;
|
|
# ifndef NO_ACTION_ONESHOT
|
|
case OP_SH_ONESHOT:
|
|
if (event.pressed) {
|
|
set_oneshot_swaphands();
|
|
} else {
|
|
release_oneshot_swaphands();
|
|
}
|
|
break;
|
|
# endif
|
|
|
|
# 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) {
|
|
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);
|
|
*record = (keyrecord_t){}; // hack: reset tap mode
|
|
}
|
|
} else {
|
|
if (swap_held && !event.pressed) {
|
|
swap_hands = !swap_hands; // undo hold set up in _tap_hint
|
|
swap_held = false;
|
|
}
|
|
}
|
|
# endif
|
|
}
|
|
#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:
|
|
# ifndef NO_ACTION_TAPPING
|
|
case ACT_LAYER_TAP:
|
|
case ACT_LAYER_TAP_EXT:
|
|
# endif
|
|
led_set(host_keyboard_leds());
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
#endif
|
|
|
|
#ifndef NO_ACTION_TAPPING
|
|
# if defined(RETRO_TAPPING) || defined(RETRO_TAPPING_PER_KEY) || (defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT))
|
|
if (!is_tap_action(action)) {
|
|
retro_tapping_counter = 0;
|
|
} else {
|
|
if (event.pressed) {
|
|
if (tap_count > 0) {
|
|
retro_tapping_counter = 0;
|
|
}
|
|
} else {
|
|
if (tap_count > 0) {
|
|
retro_tapping_counter = 0;
|
|
} else {
|
|
if (
|
|
# ifdef RETRO_TAPPING_PER_KEY
|
|
get_retro_tapping(get_event_keycode(record->event, false), record) &&
|
|
# endif
|
|
retro_tapping_counter == 2) {
|
|
# if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
|
|
process_auto_shift(action.layer_tap.code, record);
|
|
# else
|
|
tap_code(action.layer_tap.code);
|
|
# endif
|
|
}
|
|
retro_tapping_counter = 0;
|
|
}
|
|
}
|
|
}
|
|
# endif
|
|
#endif
|
|
|
|
#ifdef SWAP_HANDS_ENABLE
|
|
# ifndef NO_ACTION_ONESHOT
|
|
if (event.pressed && !(action.kind.id == ACT_SWAP_HANDS && action.swap.code == OP_SH_ONESHOT)) {
|
|
use_oneshot_swaphands();
|
|
}
|
|
# 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.
|
|
*/
|
|
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.
|
|
*/
|
|
__attribute__((weak)) void register_code(uint8_t code) {
|
|
if (code == KC_NO) {
|
|
return;
|
|
|
|
#ifdef LOCKING_SUPPORT_ENABLE
|
|
} else if (KC_LOCKING_CAPS_LOCK == code) {
|
|
# ifdef LOCKING_RESYNC_ENABLE
|
|
// Resync: ignore if caps lock already is on
|
|
if (host_keyboard_leds() & (1 << USB_LED_CAPS_LOCK)) return;
|
|
# endif
|
|
add_key(KC_CAPS_LOCK);
|
|
send_keyboard_report();
|
|
wait_ms(TAP_HOLD_CAPS_DELAY);
|
|
del_key(KC_CAPS_LOCK);
|
|
send_keyboard_report();
|
|
|
|
} else if (KC_LOCKING_NUM_LOCK == code) {
|
|
# ifdef LOCKING_RESYNC_ENABLE
|
|
if (host_keyboard_leds() & (1 << USB_LED_NUM_LOCK)) return;
|
|
# endif
|
|
add_key(KC_NUM_LOCK);
|
|
send_keyboard_report();
|
|
wait_ms(100);
|
|
del_key(KC_NUM_LOCK);
|
|
send_keyboard_report();
|
|
|
|
} else if (KC_LOCKING_SCROLL_LOCK == code) {
|
|
# ifdef LOCKING_RESYNC_ENABLE
|
|
if (host_keyboard_leds() & (1 << USB_LED_SCROLL_LOCK)) return;
|
|
# endif
|
|
add_key(KC_SCROLL_LOCK);
|
|
send_keyboard_report();
|
|
wait_ms(100);
|
|
del_key(KC_SCROLL_LOCK);
|
|
send_keyboard_report();
|
|
#endif
|
|
|
|
} else if (IS_BASIC_KEYCODE(code)) {
|
|
// TODO: should push command_proc out of this block?
|
|
if (command_proc(code)) return;
|
|
|
|
// 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();
|
|
}
|
|
add_key(code);
|
|
send_keyboard_report();
|
|
} else if (IS_MODIFIER_KEYCODE(code)) {
|
|
add_mods(MOD_BIT(code));
|
|
send_keyboard_report();
|
|
|
|
#ifdef EXTRAKEY_ENABLE
|
|
} else if (IS_SYSTEM_KEYCODE(code)) {
|
|
host_system_send(KEYCODE2SYSTEM(code));
|
|
} else if (IS_CONSUMER_KEYCODE(code)) {
|
|
host_consumer_send(KEYCODE2CONSUMER(code));
|
|
#endif
|
|
|
|
} else if (IS_MOUSE_KEYCODE(code)) {
|
|
register_mouse(code, true);
|
|
}
|
|
}
|
|
|
|
/** \brief Utilities for actions. (FIXME: Needs better description)
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
__attribute__((weak)) void unregister_code(uint8_t code) {
|
|
if (code == KC_NO) {
|
|
return;
|
|
|
|
#ifdef LOCKING_SUPPORT_ENABLE
|
|
} else if (KC_LOCKING_CAPS_LOCK == code) {
|
|
# ifdef LOCKING_RESYNC_ENABLE
|
|
// Resync: ignore if caps lock already is off
|
|
if (!(host_keyboard_leds() & (1 << USB_LED_CAPS_LOCK))) return;
|
|
# endif
|
|
add_key(KC_CAPS_LOCK);
|
|
send_keyboard_report();
|
|
del_key(KC_CAPS_LOCK);
|
|
send_keyboard_report();
|
|
|
|
} else if (KC_LOCKING_NUM_LOCK == code) {
|
|
# ifdef LOCKING_RESYNC_ENABLE
|
|
if (!(host_keyboard_leds() & (1 << USB_LED_NUM_LOCK))) return;
|
|
# endif
|
|
add_key(KC_NUM_LOCK);
|
|
send_keyboard_report();
|
|
del_key(KC_NUM_LOCK);
|
|
send_keyboard_report();
|
|
|
|
} else if (KC_LOCKING_SCROLL_LOCK == code) {
|
|
# ifdef LOCKING_RESYNC_ENABLE
|
|
if (!(host_keyboard_leds() & (1 << USB_LED_SCROLL_LOCK))) return;
|
|
# endif
|
|
add_key(KC_SCROLL_LOCK);
|
|
send_keyboard_report();
|
|
del_key(KC_SCROLL_LOCK);
|
|
send_keyboard_report();
|
|
#endif
|
|
|
|
} else if (IS_BASIC_KEYCODE(code)) {
|
|
del_key(code);
|
|
send_keyboard_report();
|
|
} else if (IS_MODIFIER_KEYCODE(code)) {
|
|
del_mods(MOD_BIT(code));
|
|
send_keyboard_report();
|
|
|
|
#ifdef EXTRAKEY_ENABLE
|
|
} else if (IS_SYSTEM_KEYCODE(code)) {
|
|
host_system_send(0);
|
|
} else if (IS_CONSUMER_KEYCODE(code)) {
|
|
host_consumer_send(0);
|
|
#endif
|
|
|
|
} else if (IS_MOUSE_KEYCODE(code)) {
|
|
register_mouse(code, false);
|
|
}
|
|
}
|
|
|
|
/** \brief Tap a keycode with a delay.
|
|
*
|
|
* \param code The basic keycode to tap.
|
|
* \param delay The amount of time in milliseconds to leave the keycode registered, before unregistering it.
|
|
*/
|
|
__attribute__((weak)) void tap_code_delay(uint8_t code, uint16_t delay) {
|
|
register_code(code);
|
|
for (uint16_t i = delay; i > 0; i--) {
|
|
wait_ms(1);
|
|
}
|
|
unregister_code(code);
|
|
}
|
|
|
|
/** \brief Tap a keycode with the default delay.
|
|
*
|
|
* \param code The basic keycode to tap. If `code` is `KC_CAPS_LOCK`, the delay will be `TAP_HOLD_CAPS_DELAY`, otherwise `TAP_CODE_DELAY`, if defined.
|
|
*/
|
|
__attribute__((weak)) void tap_code(uint8_t code) {
|
|
tap_code_delay(code, code == KC_CAPS_LOCK ? TAP_HOLD_CAPS_DELAY : TAP_CODE_DELAY);
|
|
}
|
|
|
|
/** \brief Adds the given physically pressed modifiers and sends a keyboard report immediately.
|
|
*
|
|
* \param mods A bitfield of modifiers to register.
|
|
*/
|
|
__attribute__((weak)) 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.
|
|
*/
|
|
__attribute__((weak)) 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.
|
|
*/
|
|
__attribute__((weak)) 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.
|
|
*/
|
|
__attribute__((weak)) 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.
|
|
*/
|
|
void clear_keyboard(void) {
|
|
clear_mods();
|
|
clear_keyboard_but_mods();
|
|
}
|
|
|
|
/** \brief Utilities for actions. (FIXME: Needs better description)
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
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.
|
|
*/
|
|
void clear_keyboard_but_mods_and_keys(void) {
|
|
#ifdef EXTRAKEY_ENABLE
|
|
host_system_send(0);
|
|
host_consumer_send(0);
|
|
#endif
|
|
clear_weak_mods();
|
|
send_keyboard_report();
|
|
#ifdef MOUSEKEY_ENABLE
|
|
mousekey_clear();
|
|
mousekey_send();
|
|
#endif
|
|
#ifdef PROGRAMMABLE_BUTTON_ENABLE
|
|
programmable_button_clear();
|
|
#endif
|
|
}
|
|
|
|
/** \brief Utilities for actions. (FIXME: Needs better description)
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
bool is_tap_record(keyrecord_t *record) {
|
|
if (IS_NOEVENT(record->event)) {
|
|
return false;
|
|
}
|
|
|
|
#ifdef COMBO_ENABLE
|
|
action_t action;
|
|
if (record->keycode) {
|
|
action = action_for_keycode(record->keycode);
|
|
} else {
|
|
action = layer_switch_get_action(record->event.key);
|
|
}
|
|
#else
|
|
action_t action = layer_switch_get_action(record->event.key);
|
|
#endif
|
|
return is_tap_action(action);
|
|
}
|
|
|
|
/** \brief Utilities for actions. (FIXME: Needs better description)
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
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:
|
|
switch (action.layer_tap.code) {
|
|
case KC_NO ... KC_RIGHT_GUI:
|
|
case OP_TAP_TOGGLE:
|
|
case OP_ONESHOT:
|
|
return true;
|
|
}
|
|
return false;
|
|
case ACT_SWAP_HANDS:
|
|
switch (action.swap.code) {
|
|
case KC_NO ... KC_RIGHT_GUI:
|
|
case OP_SH_TAP_TOGGLE:
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/** \brief Debug print (FIXME: Needs better description)
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
void debug_event(keyevent_t event) {
|
|
ac_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.
|
|
*/
|
|
void debug_record(keyrecord_t record) {
|
|
debug_event(record.event);
|
|
#ifndef NO_ACTION_TAPPING
|
|
ac_dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
|
|
#endif
|
|
}
|
|
|
|
/** \brief Debug print (FIXME: Needs better description)
|
|
*
|
|
* FIXME: Needs documentation.
|
|
*/
|
|
void debug_action(action_t action) {
|
|
switch (action.kind.id) {
|
|
case ACT_LMODS:
|
|
ac_dprintf("ACT_LMODS");
|
|
break;
|
|
case ACT_RMODS:
|
|
ac_dprintf("ACT_RMODS");
|
|
break;
|
|
case ACT_LMODS_TAP:
|
|
ac_dprintf("ACT_LMODS_TAP");
|
|
break;
|
|
case ACT_RMODS_TAP:
|
|
ac_dprintf("ACT_RMODS_TAP");
|
|
break;
|
|
case ACT_USAGE:
|
|
ac_dprintf("ACT_USAGE");
|
|
break;
|
|
case ACT_MOUSEKEY:
|
|
ac_dprintf("ACT_MOUSEKEY");
|
|
break;
|
|
case ACT_LAYER:
|
|
ac_dprintf("ACT_LAYER");
|
|
break;
|
|
case ACT_LAYER_MODS:
|
|
ac_dprintf("ACT_LAYER_MODS");
|
|
break;
|
|
case ACT_LAYER_TAP:
|
|
ac_dprintf("ACT_LAYER_TAP");
|
|
break;
|
|
case ACT_LAYER_TAP_EXT:
|
|
ac_dprintf("ACT_LAYER_TAP_EXT");
|
|
break;
|
|
case ACT_SWAP_HANDS:
|
|
ac_dprintf("ACT_SWAP_HANDS");
|
|
break;
|
|
default:
|
|
ac_dprintf("UNKNOWN");
|
|
break;
|
|
}
|
|
ac_dprintf("[%X:%02X]", action.kind.param >> 8, action.kind.param & 0xff);
|
|
}
|