1
0
Fork 0
qmk_firmware/common/action.c

556 lines
18 KiB
C
Raw Normal View History

2013-01-28 05:06:42 +00:00
/*
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/>.
*/
2012-12-15 17:32:07 +00:00
#include "host.h"
#include "keycode.h"
#include "keyboard.h"
#include "mousekey.h"
#include "command.h"
#include "led.h"
2013-05-30 18:24:39 +00:00
#include "backlight.h"
#include "action_layer.h"
#include "action_tapping.h"
2013-02-25 06:30:37 +00:00
#include "action_macro.h"
#include "action_util.h"
2013-02-25 06:30:37 +00:00
#include "action.h"
2012-12-15 17:32:07 +00:00
2013-05-14 07:18:22 +00:00
#ifdef DEBUG_ACTION
#include "debug.h"
#else
#include "nodebug.h"
#endif
2012-12-15 17:32:07 +00:00
2013-01-26 17:42:48 +00:00
void action_exec(keyevent_t event)
{
if (!IS_NOEVENT(event)) {
2013-05-14 07:18:22 +00:00
dprint("\n---- action_exec: start -----\n");
dprint("EVENT: "); debug_event(event); dprintln();
2013-01-26 17:42:48 +00:00
}
keyrecord_t record = { .event = event };
#ifndef NO_ACTION_TAPPING
action_tapping_process(record);
#else
process_action(&record);
if (!IS_NOEVENT(record.event)) {
2013-05-14 07:18:22 +00:00
dprint("processed: "); debug_record(record); dprintln();
}
#endif
}
void process_action(keyrecord_t *record)
{
2013-01-26 17:42:48 +00:00
keyevent_t event = record->event;
#ifndef NO_ACTION_TAPPING
2013-02-26 07:27:09 +00:00
uint8_t tap_count = record->tap.count;
#endif
2013-01-26 17:42:48 +00:00
2013-01-20 06:03:07 +00:00
if (IS_NOEVENT(event)) { return; }
2013-02-20 02:16:13 +00:00
action_t action = layer_switch_get_action(event.key);
2013-05-14 07:18:22 +00:00
dprint("ACTION: "); debug_action(action);
#ifndef NO_ACTION_LAYER
2013-05-14 07:18:22 +00:00
dprint(" layer_state: "); layer_debug();
dprint(" default_layer_state: "); default_layer_debug();
#endif
2013-05-14 07:18:22 +00:00
dprintln();
2012-12-15 17:32:07 +00:00
switch (action.kind.id) {
/* Key and Mods */
2012-12-15 17:32:07 +00:00
case ACT_LMODS:
case ACT_RMODS:
2013-01-27 07:38:19 +00:00
{
uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
action.key.mods<<4;
if (event.pressed) {
if (mods) {
add_weak_mods(mods);
send_keyboard_report();
2013-01-27 07:38:19 +00:00
}
register_code(action.key.code);
} else {
unregister_code(action.key.code);
if (mods) {
del_weak_mods(mods);
send_keyboard_report();
2013-01-27 07:38:19 +00:00
}
}
2012-12-15 17:32:07 +00:00
}
break;
#ifndef NO_ACTION_TAPPING
case ACT_LMODS_TAP:
2013-01-20 06:03:07 +00:00
case ACT_RMODS_TAP:
{
2013-01-27 07:38:19 +00:00
uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
action.key.mods<<4;
switch (action.layer_tap.code) {
2013-03-21 05:42:40 +00:00
#ifndef NO_ACTION_ONESHOT
2013-10-07 14:28:17 +00:00
case MODS_ONESHOT:
2013-01-27 07:38:19 +00:00
// Oneshot modifier
if (event.pressed) {
if (tap_count == 0) {
register_mods(mods);
2013-01-27 07:38:19 +00:00
}
else if (tap_count == 1) {
2013-05-14 07:18:22 +00:00
dprint("MODS_TAP: Oneshot: start\n");
set_oneshot_mods(mods);
2013-01-27 07:38:19 +00:00
}
else {
register_mods(mods);
2013-01-27 07:38:19 +00:00
}
} else {
2013-01-27 07:38:19 +00:00
if (tap_count == 0) {
clear_oneshot_mods();
unregister_mods(mods);
2013-01-27 07:38:19 +00:00
}
else if (tap_count == 1) {
2013-10-07 14:28:17 +00:00
// Retain Oneshot mods
2013-01-27 07:38:19 +00:00
}
else {
2013-10-07 14:28:17 +00:00
clear_oneshot_mods();
unregister_mods(mods);
2013-01-27 07:38:19 +00:00
}
}
2013-01-27 07:38:19 +00:00
break;
2013-03-21 05:42:40 +00:00
#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;
2013-01-27 07:38:19 +00:00
default:
if (event.pressed) {
if (tap_count > 0) {
if (record->tap.interrupted) {
2013-05-14 07:18:22 +00:00
dprint("MODS_TAP: Tap: Cancel: add_mods\n");
2013-01-27 07:38:19 +00:00
// ad hoc: set 0 to cancel tap
2013-02-26 07:27:09 +00:00
record->tap.count = 0;
register_mods(mods);
2013-01-27 07:38:19 +00:00
} else {
2013-05-14 07:18:22 +00:00
dprint("MODS_TAP: Tap: register_code\n");
2013-01-27 07:38:19 +00:00
register_code(action.key.code);
}
} else {
2013-05-14 07:18:22 +00:00
dprint("MODS_TAP: No tap: add_mods\n");
register_mods(mods);
2013-01-27 07:38:19 +00:00
}
} else {
if (tap_count > 0) {
2013-05-14 07:18:22 +00:00
dprint("MODS_TAP: Tap: unregister_code\n");
2013-01-27 07:38:19 +00:00
unregister_code(action.key.code);
} else {
2013-05-14 07:18:22 +00:00
dprint("MODS_TAP: No tap: add_mods\n");
unregister_mods(mods);
2013-01-27 07:38:19 +00:00
}
}
break;
}
}
2013-01-09 13:33:33 +00:00
break;
#endif
#ifdef EXTRAKEY_ENABLE
/* other HID usage */
2013-01-09 13:33:33 +00:00
case ACT_USAGE:
switch (action.usage.page) {
2013-02-07 15:50:51 +00:00
case PAGE_SYSTEM:
2012-12-15 17:32:07 +00:00
if (event.pressed) {
2013-01-09 13:33:33 +00:00
host_system_send(action.usage.code);
2012-12-15 17:32:07 +00:00
} else {
2013-01-09 13:33:33 +00:00
host_system_send(0);
2012-12-15 17:32:07 +00:00
}
break;
2013-02-07 15:50:51 +00:00
case PAGE_CONSUMER:
2013-01-09 13:33:33 +00:00
if (event.pressed) {
host_consumer_send(action.usage.code);
} else {
host_consumer_send(0);
}
2012-12-15 17:32:07 +00:00
break;
2013-01-09 13:33:33 +00:00
}
break;
#endif
#ifdef MOUSEKEY_ENABLE
/* Mouse key */
2013-01-09 13:33:33 +00:00
case ACT_MOUSEKEY:
if (event.pressed) {
mousekey_on(action.key.code);
mousekey_send();
} else {
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) {
uint8_t shift = action.layer_bitop.part*4;
uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_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_and(mask); default_layer_or(bits); break;
2013-02-20 06:52:32 +00:00
}
}
} 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;
uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_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_and(mask); layer_or(bits); break;
2013-02-07 15:50:51 +00:00
}
}
}
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 */
2013-01-28 02:30:23 +00:00
if (event.pressed) {
2013-01-28 05:06:42 +00:00
if (tap_count < TAPPING_TOGGLE) {
layer_invert(action.layer_tap.val);
2013-01-28 02:30:23 +00:00
}
} else {
2013-02-20 02:16:13 +00:00
if (tap_count <= TAPPING_TOGGLE) {
layer_invert(action.layer_tap.val);
2013-01-28 02:30:23 +00:00
}
}
2012-12-15 17:32:07 +00:00
break;
case OP_ON_OFF:
event.pressed ? layer_on(action.layer_tap.val) :
layer_off(action.layer_tap.val);
2013-01-09 13:33:33 +00:00
break;
case OP_OFF_ON:
event.pressed ? layer_off(action.layer_tap.val) :
layer_on(action.layer_tap.val);
2013-02-14 06:22:59 +00:00
break;
case OP_SET_CLEAR:
event.pressed ? layer_move(action.layer_tap.val) :
layer_clear();
2013-02-14 06:22:59 +00:00
break;
2013-01-09 13:33:33 +00:00
default:
/* tap key */
2013-01-09 13:33:33 +00:00
if (event.pressed) {
if (tap_count > 0) {
2013-05-14 07:18:22 +00:00
dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
register_code(action.layer_tap.code);
2013-01-20 06:03:07 +00:00
} else {
2013-05-14 07:18:22 +00:00
dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
layer_on(action.layer_tap.val);
2013-01-09 13:33:33 +00:00
}
} else {
if (tap_count > 0) {
2013-05-14 07:18:22 +00:00
dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
unregister_code(action.layer_tap.code);
2013-01-20 06:03:07 +00:00
} else {
2013-05-14 07:18:22 +00:00
dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
layer_off(action.layer_tap.val);
2013-01-09 13:33:33 +00:00
}
2012-12-15 17:32:07 +00:00
}
break;
}
2013-01-28 02:30:23 +00:00
break;
#endif
2013-03-19 15:26:01 +00:00
#endif
/* Extentions */
2013-03-19 15:37:32 +00:00
#ifndef NO_ACTION_MACRO
2012-12-15 17:32:07 +00:00
case ACT_MACRO:
2013-02-25 06:30:37 +00:00
action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
2013-01-23 14:53:51 +00:00
break;
2013-05-30 18:24:39 +00:00
#endif
#ifdef BACKLIGHT_ENABLE
case ACT_BACKLIGHT:
if (!event.pressed) {
switch (action.backlight.opt) {
2013-05-30 18:24:39 +00:00
case BACKLIGHT_INCREASE:
backlight_increase();
break;
case BACKLIGHT_DECREASE:
backlight_decrease();
break;
case BACKLIGHT_TOGGLE:
backlight_toggle();
break;
case BACKLIGHT_STEP:
backlight_step();
break;
case BACKLIGHT_LEVEL:
backlight_level(action.backlight.level);
break;
2013-05-30 18:24:39 +00:00
}
}
break;
2013-03-19 15:37:32 +00:00
#endif
2012-12-15 17:32:07 +00:00
case ACT_COMMAND:
2013-01-23 14:53:51 +00:00
break;
2013-03-19 15:37:32 +00:00
#ifndef NO_ACTION_FUNCTION
2012-12-15 17:32:07 +00:00
case ACT_FUNCTION:
2013-02-13 02:47:19 +00:00
action_function(record, action.func.id, action.func.opt);
2013-01-23 14:53:51 +00:00
break;
2013-03-19 15:37:32 +00:00
#endif
2012-12-15 17:32:07 +00:00
default:
break;
}
}
2013-03-21 06:24:48 +00:00
/*
* Utilities for actions.
*/
void register_code(uint8_t code)
{
if (code == KC_NO) {
return;
}
#ifdef LOCKING_SUPPORT_ENABLE
2013-03-21 06:24:48 +00:00
else if (KC_LOCKING_CAPS == code) {
#ifdef LOCKING_RESYNC_ENABLE
2013-03-21 06:24:48 +00:00
// Resync: ignore if caps lock already is on
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();
2013-03-21 06:24:48 +00:00
}
else if (KC_LOCKING_NUM == code) {
#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) {
#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();
}
2013-03-21 06:24:48 +00:00
#endif
2013-03-21 06:24:48 +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
2013-03-21 06:24:48 +00:00
if (oneshot_state.mods && !oneshot_state.disabled) {
uint8_t tmp_mods = get_mods();
add_mods(oneshot_state.mods);
2013-03-21 06:24:48 +00:00
add_key(code);
send_keyboard_report();
2013-03-21 06:24:48 +00:00
set_mods(tmp_mods);
send_keyboard_report();
2013-03-21 06:24:48 +00:00
oneshot_cancel();
} else
*/
2013-03-21 06:24:48 +00:00
#endif
{
add_key(code);
send_keyboard_report();
2013-03-21 06:24:48 +00:00
}
}
else if IS_MOD(code) {
add_mods(MOD_BIT(code));
send_keyboard_report();
2013-03-21 06:24:48 +00:00
}
else if IS_SYSTEM(code) {
host_system_send(KEYCODE2SYSTEM(code));
}
else if IS_CONSUMER(code) {
host_consumer_send(KEYCODE2CONSUMER(code));
}
2013-03-21 06:24:48 +00:00
}
void unregister_code(uint8_t code)
{
if (code == KC_NO) {
return;
}
#ifdef LOCKING_SUPPORT_ENABLE
2013-03-21 06:24:48 +00:00
else if (KC_LOCKING_CAPS == code) {
#ifdef LOCKING_RESYNC_ENABLE
2013-03-21 06:24:48 +00:00
// Resync: ignore if caps lock already is off
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();
2013-03-21 06:24:48 +00:00
}
else if (KC_LOCKING_NUM == code) {
#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) {
#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();
}
2013-03-21 06:24:48 +00:00
#endif
2013-03-21 06:24:48 +00:00
else if IS_KEY(code) {
del_key(code);
send_keyboard_report();
2013-03-21 06:24:48 +00:00
}
else if IS_MOD(code) {
del_mods(MOD_BIT(code));
send_keyboard_report();
2013-03-21 06:24:48 +00:00
}
else if IS_SYSTEM(code) {
host_system_send(0);
}
else if IS_CONSUMER(code) {
host_consumer_send(0);
}
2013-03-21 06:24:48 +00:00
}
void register_mods(uint8_t mods)
2013-03-21 06:24:48 +00:00
{
if (mods) {
add_mods(mods);
send_keyboard_report();
2013-03-21 06:24:48 +00:00
}
}
void unregister_mods(uint8_t mods)
2013-03-21 06:24:48 +00:00
{
if (mods) {
del_mods(mods);
send_keyboard_report();
2013-03-21 06:24:48 +00:00
}
}
void clear_keyboard(void)
{
clear_mods();
2013-03-21 06:24:48 +00:00
clear_keyboard_but_mods();
}
void clear_keyboard_but_mods(void)
{
clear_weak_mods();
clear_keys();
send_keyboard_report();
2013-03-21 06:24:48 +00:00
#ifdef MOUSEKEY_ENABLE
mousekey_clear();
mousekey_send();
#endif
#ifdef EXTRAKEY_ENABLE
host_system_send(0);
host_consumer_send(0);
#endif
}
2014-06-16 15:57:59 +00:00
bool is_tap_key(keypos_t key)
2013-03-21 06:24:48 +00:00
{
action_t action = layer_switch_get_action(key);
switch (action.kind.id) {
case ACT_LMODS_TAP:
case ACT_RMODS_TAP:
case ACT_LAYER_TAP:
case ACT_LAYER_TAP_EXT:
2013-03-21 06:24:48 +00:00
return true;
case ACT_MACRO:
case ACT_FUNCTION:
if (action.func.opt & FUNC_TAP) { return true; }
return false;
}
return false;
}
/*
* debug print
*/
void debug_event(keyevent_t event)
2013-03-21 06:24:48 +00:00
{
2013-05-14 07:18:22 +00:00
dprintf("%04X%c(%u)", (event.key.row<<8 | event.key.col), (event.pressed ? 'd' : 'u'), event.time);
2013-03-21 06:24:48 +00:00
}
void debug_record(keyrecord_t record)
2013-03-21 06:24:48 +00:00
{
debug_event(record.event);
#ifndef NO_ACTION_TAPPING
2013-05-14 07:18:22 +00:00
dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
#endif
2013-03-21 06:24:48 +00:00
}
void debug_action(action_t action)
2013-03-21 06:24:48 +00:00
{
switch (action.kind.id) {
2013-05-14 07:18:22 +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_TAP: dprint("ACT_LAYER_TAP"); break;
case ACT_LAYER_TAP_EXT: dprint("ACT_LAYER_TAP_EXT"); break;
2013-05-14 07:18:22 +00:00
case ACT_MACRO: dprint("ACT_MACRO"); break;
case ACT_COMMAND: dprint("ACT_COMMAND"); break;
case ACT_FUNCTION: dprint("ACT_FUNCTION"); break;
default: dprint("UNKNOWN"); break;
2013-03-21 06:24:48 +00:00
}
2013-05-14 07:18:22 +00:00
dprintf("[%X:%02X]", action.kind.param>>8, action.kind.param&0xff);
2013-03-21 06:24:48 +00:00
}