diff options
Diffstat (limited to 'common/action.c')
-rw-r--r-- | common/action.c | 547 |
1 files changed, 273 insertions, 274 deletions
diff --git a/common/action.c b/common/action.c index 4fafbfa79..c218808ab 100644 --- a/common/action.c +++ b/common/action.c @@ -25,21 +25,17 @@ along with this program. If not, see <http://www.gnu.org/licenses/>. #include "debug.h" #include "led.h" #include "layer_switch.h" +#include "action_oneshot.h" #include "action_macro.h" #include "action.h" static void process_action(keyrecord_t *record); -static bool process_tapping(keyrecord_t *record); -static void waiting_buffer_scan_tap(void); - static void debug_event(keyevent_t event); static void debug_record(keyrecord_t record); static void debug_action(action_t action); -static void debug_tapping_key(void); -static void debug_waiting_buffer(void); - +#ifndef NO_ACTION_TAPPING /* * Tapping */ @@ -70,94 +66,22 @@ static keyrecord_t tapping_key = {}; */ #define WAITING_BUFFER_SIZE 8 static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {}; - /* point to empty cell to enq */ static uint8_t waiting_buffer_head = 0; - /* point to the oldest data cell to deq */ static uint8_t waiting_buffer_tail = 0; -static bool waiting_buffer_enq(keyrecord_t record) -{ - if (IS_NOEVENT(record.event)) { - return true; - } - - if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) { - debug("waiting_buffer_enq: Over flow.\n"); - return false; - } - - waiting_buffer[waiting_buffer_head] = record; - waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE; - - debug("waiting_buffer_enq: "); debug_waiting_buffer(); - return true; -} - -static void waiting_buffer_clear(void) -{ - waiting_buffer_head = 0; - waiting_buffer_tail = 0; -} +static bool process_tapping(keyrecord_t *record); +static bool waiting_buffer_enq(keyrecord_t record); +static void waiting_buffer_clear(void); #if TAPPING_TERM >= 500 -static bool waiting_buffer_typed(keyevent_t event) -{ - for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { - if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed != waiting_buffer[i].event.pressed) { - return true; - } - } - return false; -} +static bool waiting_buffer_typed(keyevent_t event); +#endif +static void waiting_buffer_scan_tap(void); +static void debug_tapping_key(void); +static void debug_waiting_buffer(void); #endif - -bool waiting_buffer_has_anykey_pressed(void) -{ - for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { - if (waiting_buffer[i].event.pressed) return true; - } - return false; -} - - -/* Oneshot modifier - * - * Problem: Want to capitalize like 'The' but the result tends to be 'THe'. - * Solution: Oneshot modifier have its effect on only one key coming next. - * Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key. - * - * Hold: works as normal modifier. - * Tap: one shot modifier. - * 2 Tap: cancel one shot modifier. - * 5-Tap: toggles enable/disable oneshot feature. - */ -static struct { - uint8_t mods; - uint8_t time; - bool ready; - bool disabled; -} oneshot_state; - -static void oneshot_start(uint8_t mods, uint16_t time) -{ - oneshot_state.mods = mods; - oneshot_state.time = time; - oneshot_state.ready = true; -} - -static void oneshot_cancel(void) -{ - oneshot_state.mods = 0; - oneshot_state.time = 0; - oneshot_state.ready = false; -} - -static void oneshot_toggle(void) -{ - oneshot_state.disabled = !oneshot_state.disabled; -} @@ -170,13 +94,12 @@ void action_exec(keyevent_t event) keyrecord_t record = { .event = event }; - // pre-process on tapping +#ifndef NO_ACTION_TAPPING if (process_tapping(&record)) { if (!IS_NOEVENT(record.event)) { debug("processed: "); debug_record(record); debug("\n"); } } else { - // enqueue if (!waiting_buffer_enq(record)) { // clear all in case of overflow. debug("OVERFLOW: CLEAR ALL STATES\n"); @@ -190,7 +113,6 @@ void action_exec(keyevent_t event) if (!IS_NOEVENT(event) && waiting_buffer_head != waiting_buffer_tail) { debug("---- action_exec: process waiting_buffer -----\n"); } - for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) { if (process_tapping(&waiting_buffer[waiting_buffer_tail])) { debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = "); @@ -202,6 +124,12 @@ void action_exec(keyevent_t event) if (!IS_NOEVENT(event)) { debug("\n"); } +#else + process_action(&record); + if (!IS_NOEVENT(record.event)) { + debug("processed: "); debug_record(record); debug("\n"); + } +#endif } static void process_action(keyrecord_t *record) @@ -244,12 +172,14 @@ static void process_action(keyrecord_t *record) } } 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.code) { + #ifndef NO_ACTION_ONESHOT case 0x00: // Oneshot modifier if (event.pressed) { @@ -259,7 +189,7 @@ static void process_action(keyrecord_t *record) } else if (tap_count == 1) { debug("MODS_TAP: Oneshot: start\n"); - oneshot_start(mods, event.time); + oneshot_start(mods); } else if (tap_count == TAPPING_TOGGLE) { debug("MODS_TAP: Oneshot: toggle\n"); @@ -290,6 +220,7 @@ static void process_action(keyrecord_t *record) } } break; + #endif default: if (event.pressed) { if (tap_count > 0) { @@ -319,10 +250,10 @@ static void process_action(keyrecord_t *record) } } break; - +#endif +#ifdef EXTRAKEY_ENABLE /* other HID usage */ case ACT_USAGE: -#ifdef EXTRAKEY_ENABLE switch (action.usage.page) { case PAGE_SYSTEM: if (event.pressed) { @@ -339,12 +270,11 @@ static void process_action(keyrecord_t *record) } break; } -#endif break; - +#endif +#ifdef MOUSEKEY_ENABLE /* Mouse key */ case ACT_MOUSEKEY: -#ifdef MOUSEKEY_ENABLE if (event.pressed) { mousekey_on(action.key.code); mousekey_send(); @@ -352,9 +282,9 @@ static void process_action(keyrecord_t *record) mousekey_off(action.key.code); mousekey_send(); } -#endif break; - +#endif +#ifndef NO_ACTION_KEYMAP case ACT_KEYMAP: switch (action.layer.code) { /* Keymap clear */ @@ -516,7 +446,8 @@ static void process_action(keyrecord_t *record) break; } break; - +#endif +#ifndef NO_ACTION_OVERLAY case ACT_OVERLAY: switch (action.layer.code) { // Overlay Invert bit4 @@ -670,21 +601,218 @@ static void process_action(keyrecord_t *record) break; } break; - +#endif /* Extentions */ +#ifndef NO_ACTION_MACRO case ACT_MACRO: action_macro_play(action_get_macro(record, action.func.id, action.func.opt)); break; +#endif case ACT_COMMAND: break; +#ifndef NO_ACTION_FUNCTION case ACT_FUNCTION: action_function(record, action.func.id, action.func.opt); break; +#endif default: break; } } + + + +/* + * 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_KEYMAP: + case ACT_OVERLAY: + 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 + */ +static void debug_event(keyevent_t event) +{ + debug_hex16((event.key.row<<8) | event.key.col); + if (event.pressed) debug("d("); else debug("u("); + debug_dec(event.time); debug(")"); +} + +static void debug_record(keyrecord_t record) +{ + debug_event(record.event); debug(":"); debug_dec(record.tap.count); + if (record.tap.interrupted) debug("-"); +} + +static void debug_action(action_t action) +{ + 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_KEYMAP: debug("ACT_KEYMAP"); break; + case ACT_OVERLAY: debug("ACT_OVERLAY"); break; + 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("]"); +} + + + +#ifndef NO_ACTION_TAPPING /* Tapping * * Rule: Tap key is typed(pressed and released) within TAPPING_TERM. @@ -857,215 +985,85 @@ static bool process_tapping(keyrecord_t *keyp) } } -/* scan buffer for tapping */ -static void waiting_buffer_scan_tap(void) -{ - // tapping already is settled - if (tapping_key.tap.count > 0) return; - // invalid state: tapping_key released && tap.count == 0 - if (!tapping_key.event.pressed) return; - - for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { - if (IS_TAPPING_KEY(waiting_buffer[i].event.key) && - !waiting_buffer[i].event.pressed && - WITHIN_TAPPING_TERM(waiting_buffer[i].event)) { - tapping_key.tap.count = 1; - waiting_buffer[i].tap.count = 1; - process_action(&tapping_key); - - debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n"); - debug_waiting_buffer(); - return; - } - } -} - - /* - * Utilities for actions. + * Waiting buffer */ -void register_code(uint8_t code) +static bool waiting_buffer_enq(keyrecord_t record) { - if (code == KC_NO) { - return; + if (IS_NOEVENT(record.event)) { + return true; } -#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(); + + if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) { + debug("waiting_buffer_enq: Over flow.\n"); + return false; } -#endif - else if IS_KEY(code) { - // TODO: should push command_proc out of this block? - if (command_proc(code)) return; - if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) { - uint8_t tmp_mods = host_get_mods(); - host_add_mods(oneshot_state.mods); - host_add_key(code); - host_send_keyboard_report(); + waiting_buffer[waiting_buffer_head] = record; + waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE; - host_set_mods(tmp_mods); - oneshot_state.ready = false; - } else { - host_add_key(code); - host_send_keyboard_report(); - } - } - else if IS_MOD(code) { - host_add_mods(MOD_BIT(code)); - host_send_keyboard_report(); - } + debug("waiting_buffer_enq: "); debug_waiting_buffer(); + return true; } -void unregister_code(uint8_t code) +static void waiting_buffer_clear(void) { - 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(); - } + waiting_buffer_head = 0; + waiting_buffer_tail = 0; } -void add_mods(uint8_t mods) +#if TAPPING_TERM >= 500 +static bool waiting_buffer_typed(keyevent_t event) { - if (mods) { - host_add_mods(mods); - host_send_keyboard_report(); + for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { + if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed != waiting_buffer[i].event.pressed) { + return true; + } } + return false; } +#endif -void del_mods(uint8_t mods) +bool waiting_buffer_has_anykey_pressed(void) { - if (mods) { - host_del_mods(mods); - host_send_keyboard_report(); + for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { + if (waiting_buffer[i].event.pressed) return true; } + return false; } - -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) +/* scan buffer for tapping */ +static void waiting_buffer_scan_tap(void) { - return (host_has_anykey() || host_mouse_in_use() || - host_last_sysytem_report() || host_last_consumer_report()); -} + // tapping already is settled + if (tapping_key.tap.count > 0) return; + // invalid state: tapping_key released && tap.count == 0 + if (!tapping_key.event.pressed) return; -bool is_tap_key(key_t key) -{ - action_t action = layer_switch_get_action(key); + for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { + if (IS_TAPPING_KEY(waiting_buffer[i].event.key) && + !waiting_buffer[i].event.pressed && + WITHIN_TAPPING_TERM(waiting_buffer[i].event)) { + tapping_key.tap.count = 1; + waiting_buffer[i].tap.count = 1; + process_action(&tapping_key); - switch (action.kind.id) { - case ACT_LMODS_TAP: - case ACT_RMODS_TAP: - return true; - case ACT_KEYMAP: - case ACT_OVERLAY: - 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; + debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n"); + debug_waiting_buffer(); + return; + } } - return false; } /* * debug print */ -static void debug_event(keyevent_t event) -{ - debug_hex16((event.key.row<<8) | event.key.col); - if (event.pressed) debug("d("); else debug("u("); - debug_dec(event.time); debug(")"); -} -static void debug_record(keyrecord_t record) -{ - debug_event(record.event); debug(":"); debug_dec(record.tap.count); - if (record.tap.interrupted) debug("-"); -} -static void debug_action(action_t action) -{ - 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_KEYMAP: debug("ACT_KEYMAP"); break; - case ACT_OVERLAY: debug("ACT_OVERLAY"); break; - 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("]"); -} static void debug_tapping_key(void) { debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n"); } + static void debug_waiting_buffer(void) { debug("{ "); @@ -1074,3 +1072,4 @@ static void debug_waiting_buffer(void) } debug("}\n"); } +#endif |