qmk_firmware/common/action.c

570 lines
18 KiB
C
Raw Normal View History

2013-01-28 06:06:42 +01: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 18:32:07 +01:00
#include "host.h"
#include "keycode.h"
#include "keyboard.h"
#include "mousekey.h"
#include "command.h"
#include "debug.h"
#include "led.h"
2013-02-15 10:48:36 +01:00
#include "layer_switch.h"
#include "action_tapping.h"
2013-03-21 06:42:40 +01:00
#include "action_oneshot.h"
2013-02-25 07:30:37 +01:00
#include "action_macro.h"
#include "action.h"
2012-12-15 18:32:07 +01:00
2013-01-26 18:42:48 +01:00
void action_exec(keyevent_t event)
{
if (!IS_NOEVENT(event)) {
2013-01-29 02:40:43 +01:00
debug("\n---- action_exec: start -----\n");
debug("EVENT: "); debug_event(event); debug("\n");
2013-01-26 18:42:48 +01:00
}
keyrecord_t record = { .event = event };
#ifndef NO_ACTION_TAPPING
action_tapping_process(record);
#else
process_action(&record);
if (!IS_NOEVENT(record.event)) {
debug("processed: "); debug_record(record); debug("\n");
}
#endif
}
void process_action(keyrecord_t *record)
{
2013-01-26 18:42:48 +01:00
keyevent_t event = record->event;
2013-02-26 08:27:09 +01:00
uint8_t tap_count = record->tap.count;
2013-01-26 18:42:48 +01:00
2013-01-20 07:03:07 +01:00
if (IS_NOEVENT(event)) { return; }
2013-02-20 03:16:13 +01:00
action_t action = layer_switch_get_action(event.key);
debug("ACTION: "); debug_action(action);
debug(" keymaps: "); keymap_debug();
debug(" default_layer: "); debug_dec(default_layer); debug("\n");
2012-12-15 18:32:07 +01:00
switch (action.kind.id) {
/* Key and Mods */
2012-12-15 18:32:07 +01:00
case ACT_LMODS:
case ACT_RMODS:
2013-01-27 08:38:19 +01:00
{
uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
action.key.mods<<4;
if (event.pressed) {
uint8_t tmp_mods = host_get_mods();
if (mods) {
host_add_mods(mods);
host_send_keyboard_report();
}
register_code(action.key.code);
if (mods && action.key.code) {
host_set_mods(tmp_mods);
host_send_keyboard_report();
}
} else {
if (mods && !action.key.code) {
host_del_mods(mods);
host_send_keyboard_report();
}
unregister_code(action.key.code);
}
2012-12-15 18:32:07 +01:00
}
break;
#ifndef NO_ACTION_TAPPING
case ACT_LMODS_TAP:
2013-01-20 07:03:07 +01:00
case ACT_RMODS_TAP:
{
2013-01-27 08:38:19 +01:00
uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
action.key.mods<<4;
switch (action.layer.code) {
2013-03-21 06:42:40 +01:00
#ifndef NO_ACTION_ONESHOT
2013-01-27 08:38:19 +01:00
case 0x00:
// Oneshot modifier
if (event.pressed) {
if (tap_count == 0) {
debug("MODS_TAP: Oneshot: add_mods\n");
add_mods(mods);
}
else if (tap_count == 1) {
debug("MODS_TAP: Oneshot: start\n");
2013-03-21 06:42:40 +01:00
oneshot_start(mods);
2013-01-27 08:38:19 +01:00
}
2013-02-01 06:48:11 +01:00
else if (tap_count == TAPPING_TOGGLE) {
2013-01-27 08:38:19 +01:00
debug("MODS_TAP: Oneshot: toggle\n");
oneshot_toggle();
}
else {
debug("MODS_TAP: Oneshot: cancel&add_mods\n");
// double tap cancels oneshot and works as normal modifier.
oneshot_cancel();
add_mods(mods);
}
} else {
2013-01-27 08:38:19 +01:00
if (tap_count == 0) {
debug("MODS_TAP: Oneshot: cancel/del_mods\n");
2013-02-14 07:22:59 +01:00
// cancel oneshot on hold
2013-01-27 08:38:19 +01:00
oneshot_cancel();
del_mods(mods);
}
else if (tap_count == 1) {
debug("MODS_TAP: Oneshot: del_mods\n");
// retain Oneshot
del_mods(mods);
}
else {
debug("MODS_TAP: Oneshot: del_mods\n");
// cancel Mods
del_mods(mods);
}
}
2013-01-27 08:38:19 +01:00
break;
2013-03-21 06:42:40 +01:00
#endif
2013-01-27 08:38:19 +01:00
default:
if (event.pressed) {
if (tap_count > 0) {
if (record->tap.interrupted) {
2013-01-27 08:38:19 +01:00
debug("MODS_TAP: Tap: Cancel: add_mods\n");
// ad hoc: set 0 to cancel tap
2013-02-26 08:27:09 +01:00
record->tap.count = 0;
2013-01-27 08:38:19 +01:00
add_mods(mods);
} else {
debug("MODS_TAP: Tap: register_code\n");
register_code(action.key.code);
}
} else {
debug("MODS_TAP: No tap: add_mods\n");
add_mods(mods);
}
} else {
if (tap_count > 0) {
debug("MODS_TAP: Tap: unregister_code\n");
unregister_code(action.key.code);
} else {
debug("MODS_TAP: No tap: add_mods\n");
del_mods(mods);
}
}
break;
}
}
2013-01-09 14:33:33 +01:00
break;
#endif
#ifdef EXTRAKEY_ENABLE
/* other HID usage */
2013-01-09 14:33:33 +01:00
case ACT_USAGE:
switch (action.usage.page) {
2013-02-07 16:50:51 +01:00
case PAGE_SYSTEM:
2012-12-15 18:32:07 +01:00
if (event.pressed) {
2013-01-09 14:33:33 +01:00
host_system_send(action.usage.code);
2012-12-15 18:32:07 +01:00
} else {
2013-01-09 14:33:33 +01:00
host_system_send(0);
2012-12-15 18:32:07 +01:00
}
break;
2013-02-07 16:50:51 +01:00
case PAGE_CONSUMER:
2013-01-09 14:33:33 +01:00
if (event.pressed) {
host_consumer_send(action.usage.code);
} else {
host_consumer_send(0);
}
2012-12-15 18:32:07 +01:00
break;
2013-01-09 14:33:33 +01:00
}
break;
#endif
#ifdef MOUSEKEY_ENABLE
/* Mouse key */
2013-01-09 14:33:33 +01: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:
case ACT_LAYER1:
2013-01-09 14:33:33 +01:00
switch (action.layer.code) {
2013-02-20 07:52:32 +01:00
/* Keymap clear */
2013-02-20 03:16:13 +01:00
case OP_RESET:
2013-02-20 07:52:32 +01:00
switch (action.layer.val & 0x03) {
case 0:
2013-03-04 18:42:28 +01:00
// NOTE: reserved
2013-02-20 07:52:32 +01:00
keymap_clear();
break;
case ON_PRESS:
if (event.pressed) {
keymap_clear();
}
break;
case ON_RELEASE:
if (!event.pressed) {
keymap_clear();
}
break;
case ON_BOTH:
keymap_clear();
break;
2013-03-04 18:42:28 +01:00
/* NOTE: 4-7 rserved */
2013-02-20 07:52:32 +01:00
}
2012-12-15 18:32:07 +01:00
break;
2013-02-20 03:16:13 +01:00
/* Keymap Reset default layer */
case (OP_RESET | ON_PRESS):
2013-02-07 16:50:51 +01:00
if (event.pressed) {
2013-02-20 07:52:32 +01:00
default_layer_set(action.layer.val);
2013-02-07 16:50:51 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_RESET | ON_RELEASE):
2013-02-07 16:50:51 +01:00
if (!event.pressed) {
2013-02-20 07:52:32 +01:00
default_layer_set(action.layer.val);
2013-02-07 16:50:51 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_RESET | ON_BOTH):
2013-02-20 07:52:32 +01:00
default_layer_set(action.layer.val);
2013-02-07 16:50:51 +01:00
break;
2013-02-20 03:16:13 +01:00
/* Keymap Bit invert */
case OP_INV:
/* with tap toggle */
2013-01-28 03:30:23 +01:00
if (event.pressed) {
2013-01-28 06:06:42 +01:00
if (tap_count < TAPPING_TOGGLE) {
2013-02-20 03:16:13 +01:00
debug("KEYMAP_INV: tap toggle(press).\n");
keymap_invert(action.layer.val);
2013-01-28 03:30:23 +01:00
}
} else {
2013-02-20 03:16:13 +01:00
if (tap_count <= TAPPING_TOGGLE) {
debug("KEYMAP_INV: tap toggle(release).\n");
keymap_invert(action.layer.val);
2013-01-28 03:30:23 +01:00
}
}
2012-12-15 18:32:07 +01:00
break;
2013-02-20 03:16:13 +01:00
case (OP_INV | ON_PRESS):
2013-01-09 14:33:33 +01:00
if (event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_invert(action.layer.val);
2013-01-09 14:33:33 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_INV | ON_RELEASE):
2013-02-14 07:22:59 +01:00
if (!event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_invert(action.layer.val);
2013-02-14 07:22:59 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_INV | ON_BOTH):
keymap_invert(action.layer.val);
2013-02-14 07:22:59 +01:00
break;
2013-02-20 03:16:13 +01:00
/* Keymap Bit on */
case OP_ON:
2012-12-15 18:32:07 +01:00
if (event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_on(action.layer.val);
2012-12-15 18:32:07 +01:00
} else {
2013-02-20 03:16:13 +01:00
keymap_off(action.layer.val);
2012-12-15 18:32:07 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_ON | ON_PRESS):
2013-01-28 03:30:23 +01:00
if (event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_on(action.layer.val);
}
break;
case (OP_ON | ON_RELEASE):
if (!event.pressed) {
keymap_on(action.layer.val);
}
break;
case (OP_ON | ON_BOTH):
keymap_on(action.layer.val);
break;
/* Keymap Bit off */
case OP_OFF:
if (event.pressed) {
keymap_off(action.layer.val);
2013-01-28 03:30:23 +01:00
} else {
2013-02-20 03:16:13 +01:00
keymap_on(action.layer.val);
2013-01-09 14:33:33 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_OFF | ON_PRESS):
2013-01-28 03:30:23 +01:00
if (event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_off(action.layer.val);
2013-01-28 03:30:23 +01:00
}
2013-01-09 14:33:33 +01:00
break;
2013-02-20 03:16:13 +01:00
case (OP_OFF | ON_RELEASE):
2013-02-07 16:50:51 +01:00
if (!event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_off(action.layer.val);
2012-12-15 18:32:07 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_OFF | ON_BOTH):
keymap_off(action.layer.val);
2013-02-14 07:22:59 +01:00
break;
2013-02-20 03:16:13 +01:00
/* Keymap Bit set */
case OP_SET:
2013-01-28 03:30:23 +01:00
if (event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_set(action.layer.val);
2013-01-28 03:30:23 +01:00
} else {
2013-02-20 03:16:13 +01:00
keymap_clear();
2013-01-28 03:30:23 +01:00
}
2013-01-09 14:33:33 +01:00
break;
2013-02-20 03:16:13 +01:00
case (OP_SET | ON_PRESS):
2012-12-15 18:32:07 +01:00
if (event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_set(action.layer.val);
2013-02-14 07:22:59 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_SET | ON_RELEASE):
2013-02-14 07:22:59 +01:00
if (!event.pressed) {
2013-02-20 03:16:13 +01:00
keymap_set(action.layer.val);
2013-01-09 14:33:33 +01:00
}
break;
2013-02-20 03:16:13 +01:00
case (OP_SET | ON_BOTH):
keymap_set(action.layer.val);
2013-02-14 07:22:59 +01:00
break;
2013-02-20 03:16:13 +01:00
/* Keymap Bit invert with tap key */
2013-01-09 14:33:33 +01:00
default:
if (event.pressed) {
if (tap_count > 0) {
2013-02-20 03:16:13 +01:00
debug("KEYMAP_TAP_KEY: Tap: register_code\n");
2013-01-09 14:33:33 +01:00
register_code(action.layer.code);
2013-01-20 07:03:07 +01:00
} else {
debug("KEYMAP_TAP_KEY: No tap: On on press\n");
keymap_on(action.layer.val);
2013-01-09 14:33:33 +01:00
}
} else {
if (tap_count > 0) {
2013-02-20 03:16:13 +01:00
debug("KEYMAP_TAP_KEY: Tap: unregister_code\n");
2013-01-20 07:03:07 +01:00
unregister_code(action.layer.code);
} else {
debug("KEYMAP_TAP_KEY: No tap: Off on release\n");
keymap_off(action.layer.val);
2013-01-09 14:33:33 +01:00
}
2012-12-15 18:32:07 +01:00
}
break;
}
2013-01-28 03:30:23 +01:00
break;
2013-03-19 16:26:01 +01:00
#endif
/* Extentions */
2013-03-19 16:37:32 +01:00
#ifndef NO_ACTION_MACRO
2012-12-15 18:32:07 +01:00
case ACT_MACRO:
2013-02-25 07:30:37 +01:00
action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
2013-01-23 15:53:51 +01:00
break;
2013-03-19 16:37:32 +01:00
#endif
2012-12-15 18:32:07 +01:00
case ACT_COMMAND:
2013-01-23 15:53:51 +01:00
break;
2013-03-19 16:37:32 +01:00
#ifndef NO_ACTION_FUNCTION
2012-12-15 18:32:07 +01:00
case ACT_FUNCTION:
2013-02-13 03:47:19 +01:00
action_function(record, action.func.id, action.func.opt);
2013-01-23 15:53:51 +01:00
break;
2013-03-19 16:37:32 +01:00
#endif
2012-12-15 18:32:07 +01:00
default:
break;
}
}
2013-03-21 07:24:48 +01:00
/*
* Utilities for actions.
*/
void register_code(uint8_t code)
{
if (code == KC_NO) {
return;
}
#ifdef CAPSLOCK_LOCKING_ENABLE
else if (KC_LOCKING_CAPS == code) {
#ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
// Resync: ignore if caps lock already is on
if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
#endif
host_add_key(KC_CAPSLOCK);
host_send_keyboard_report();
host_del_key(KC_CAPSLOCK);
host_send_keyboard_report();
}
#endif
else if IS_KEY(code) {
// TODO: should push command_proc out of this block?
if (command_proc(code)) return;
#ifndef NO_ACTION_ONESHOT
if (oneshot_state.mods && !oneshot_state.disabled) {
uint8_t tmp_mods = host_get_mods();
host_add_mods(oneshot_state.mods);
host_add_key(code);
host_send_keyboard_report();
host_set_mods(tmp_mods);
oneshot_cancel();
} else
#endif
{
host_add_key(code);
host_send_keyboard_report();
}
}
else if IS_MOD(code) {
host_add_mods(MOD_BIT(code));
host_send_keyboard_report();
}
}
void unregister_code(uint8_t code)
{
if (code == KC_NO) {
return;
}
#ifdef CAPSLOCK_LOCKING_ENABLE
else if (KC_LOCKING_CAPS == code) {
#ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
// Resync: ignore if caps lock already is off
if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
#endif
host_add_key(KC_CAPSLOCK);
host_send_keyboard_report();
host_del_key(KC_CAPSLOCK);
host_send_keyboard_report();
}
#endif
else if IS_KEY(code) {
host_del_key(code);
host_send_keyboard_report();
}
else if IS_MOD(code) {
host_del_mods(MOD_BIT(code));
host_send_keyboard_report();
}
}
void add_mods(uint8_t mods)
{
if (mods) {
host_add_mods(mods);
host_send_keyboard_report();
}
}
void del_mods(uint8_t mods)
{
if (mods) {
host_del_mods(mods);
host_send_keyboard_report();
}
}
void set_mods(uint8_t mods)
{
host_set_mods(mods);
host_send_keyboard_report();
}
void clear_keyboard(void)
{
host_clear_mods();
clear_keyboard_but_mods();
}
void clear_keyboard_but_mods(void)
{
host_clear_keys();
host_send_keyboard_report();
#ifdef MOUSEKEY_ENABLE
mousekey_clear();
mousekey_send();
#endif
#ifdef EXTRAKEY_ENABLE
host_system_send(0);
host_consumer_send(0);
#endif
}
bool sending_anykey(void)
{
return (host_has_anykey() || host_mouse_in_use() ||
host_last_sysytem_report() || host_last_consumer_report());
}
bool is_tap_key(key_t key)
{
action_t action = layer_switch_get_action(key);
switch (action.kind.id) {
case ACT_LMODS_TAP:
case ACT_RMODS_TAP:
return true;
case ACT_LAYER:
2013-03-21 07:24:48 +01:00
switch (action.layer.code) {
case 0x04 ... 0xEF: /* tap key */
case OP_INV:
return true;
default:
return false;
}
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 07:24:48 +01:00
{
debug_hex16((event.key.row<<8) | event.key.col);
if (event.pressed) debug("d("); else debug("u(");
debug_dec(event.time); debug(")");
}
void debug_record(keyrecord_t record)
2013-03-21 07:24:48 +01:00
{
debug_event(record.event);
#ifndef NO_ACTION_TAPPING
debug(":"); debug_dec(record.tap.count);
2013-03-21 07:24:48 +01:00
if (record.tap.interrupted) debug("-");
#endif
2013-03-21 07:24:48 +01:00
}
void debug_action(action_t action)
2013-03-21 07:24:48 +01:00
{
switch (action.kind.id) {
case ACT_LMODS: debug("ACT_LMODS"); break;
case ACT_RMODS: debug("ACT_RMODS"); break;
case ACT_LMODS_TAP: debug("ACT_LMODS_TAP"); break;
case ACT_RMODS_TAP: debug("ACT_RMODS_TAP"); break;
case ACT_USAGE: debug("ACT_USAGE"); break;
case ACT_MOUSEKEY: debug("ACT_MOUSEKEY"); break;
case ACT_LAYER: debug("ACT_LAYER"); break;
case ACT_LAYER_BITOP: debug("ACT_LAYER_BITOP"); break;
2013-03-21 07:24:48 +01:00
case ACT_MACRO: debug("ACT_MACRO"); break;
case ACT_COMMAND: debug("ACT_COMMAND"); break;
case ACT_FUNCTION: debug("ACT_FUNCTION"); break;
default: debug("UNKNOWN"); break;
}
debug("[");
debug_hex4(action.kind.param>>8);
debug(":");
debug_hex8(action.kind.param & 0xff);
debug("]");
}