X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=common%2Faction.c;h=4fafbfa79f58f86a0c1cf1638f859efa2fc3b1f2;hb=9a106537f64fe61af6048b41262f002ce6a716d9;hp=389fc5df1ba7f7073cf37e23cd4110ac0ad7bbd5;hpb=f609712da3b94ea36612a6f210bd6ce902b74631;p=max%2Ftmk_keyboard.git diff --git a/common/action.c b/common/action.c index 389fc5df..4fafbfa7 100644 --- a/common/action.c +++ b/common/action.c @@ -1,3 +1,19 @@ +/* +Copyright 2012,2013 Jun Wako + +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 . +*/ #include "host.h" #include "timer.h" #include "keymap.h" @@ -7,140 +23,315 @@ #include "command.h" #include "util.h" #include "debug.h" +#include "led.h" +#include "layer_switch.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); + + +/* + * Tapping + */ +/* period of tapping(ms) */ +#ifndef TAPPING_TERM +#define TAPPING_TERM 200 +#endif + +/* tap count needed for toggling a feature */ +#ifndef TAPPING_TOGGLE +#define TAPPING_TOGGLE 5 +#endif + +/* stores a key event of current tap. */ +static keyrecord_t tapping_key = {}; +#define IS_TAPPING() !IS_NOEVENT(tapping_key.event) +#define IS_TAPPING_PRESSED() (IS_TAPPING() && tapping_key.event.pressed) +#define IS_TAPPING_RELEASED() (IS_TAPPING() && !tapping_key.event.pressed) +#define IS_TAPPING_KEY(k) (IS_TAPPING() && KEYEQ(tapping_key.event.key, (k))) +#define WITHIN_TAPPING_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < TAPPING_TERM) -static void process(keyevent_t event, action_t action); -static void register_code(uint8_t code); -static void unregister_code(uint8_t code); -static void clear_keyboard(void); -static void clear_keyboard_but_mods(void); -static bool sending_anykey(void); -static void layer_switch(uint8_t new_layer); +/* + * Waiting buffer + * + * stores key events waiting for settling current tap. + */ +#define WAITING_BUFFER_SIZE 8 +static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {}; -/* tap */ -#define TAP_TIME 200 -static keyevent_t last_event = {}; -static uint16_t last_event_time = 0; -static uint8_t tap_count = 0; +/* point to empty cell to enq */ +static uint8_t waiting_buffer_head = 0; -/* layer */ -uint8_t default_layer = 0; -uint8_t current_layer = 0; -keyrecord_t delaying_layer = {}; +/* point to the oldest data cell to deq */ +static uint8_t waiting_buffer_tail = 0; -#define WAITING_KEYS_BUFFER 3 -static keyrecord_t waiting_keys[WAITING_KEYS_BUFFER] = {}; -static uint8_t waiting_keys_head = 0; -static bool waiting_keys_enqueue(keyevent_t event, action_t action) +static bool waiting_buffer_enq(keyrecord_t record) { - debug("waiting_keys["); debug_dec(waiting_keys_head); debug("] = "); - debug_hex16(action.code); debug("\n"); - if (waiting_keys_head < WAITING_KEYS_BUFFER) { - waiting_keys[waiting_keys_head++] = (keyrecord_t){ .event = event, - .action = action, - .mods = host_get_mods() }; - } else { + 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_keys_clear(void) + +static void waiting_buffer_clear(void) { - waiting_keys_head = 0; + waiting_buffer_head = 0; + waiting_buffer_tail = 0; } -static bool waiting_keys_has(keypos_t key) + +#if TAPPING_TERM >= 500 +static bool waiting_buffer_typed(keyevent_t event) { - for (uint8_t i = 0; i < waiting_keys_head; i++) { - if KEYEQ(key, waiting_keys[i].event.key) return true; + 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 void waiting_keys_process_in_current_layer(void) +#endif + +bool waiting_buffer_has_anykey_pressed(void) { - // TODO: in case of including layer key in waiting keys - uint8_t tmp_mods = host_get_mods(); - for (uint8_t i = 0; i < waiting_keys_head; i++) { - /* revive status of mods */ - host_set_mods(waiting_keys[i].mods); - process(waiting_keys[i].event, keymap_get_action(current_layer, - waiting_keys[i].event.key.row, - waiting_keys[i].event.key.col)); - debug("waiting_keys_process_in_current_layer["); debug_dec(i); debug("]\n"); + 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; } - host_set_mods(tmp_mods); - waiting_keys_clear(); + return false; } -static void process(keyevent_t event, action_t action) +/* 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) { - //action_t action = keymap_get_action(current_layer, event.key.row, event.key.col); - debug("action: "); debug_hex16(action.code); debug("\n"); + 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; +} + +void action_exec(keyevent_t event) +{ + if (!IS_NOEVENT(event)) { + debug("\n---- action_exec: start -----\n"); + debug("EVENT: "); debug_event(event); debug("\n"); + } + + keyrecord_t record = { .event = event }; + + // pre-process on 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"); + clear_keyboard(); + waiting_buffer_clear(); + tapping_key = (keyrecord_t){}; + } + } + + // process waiting_buffer + 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("] = "); + debug_record(waiting_buffer[waiting_buffer_tail]); debug("\n\n"); + } else { + break; + } + } + if (!IS_NOEVENT(event)) { + debug("\n"); + } +} + +static void process_action(keyrecord_t *record) +{ + keyevent_t event = record->event; + uint8_t tap_count = record->tap.count; + + if (IS_NOEVENT(event)) { return; } + + action_t action = layer_switch_get_action(event.key); + debug("ACTION: "); debug_action(action); + debug(" overlays: "); overlay_debug(); + debug(" keymaps: "); keymap_debug(); + debug(" default_layer: "); debug_dec(default_layer); debug("\n"); + switch (action.kind.id) { /* Key and Mods */ case ACT_LMODS: - // normal key or key plus mods - if (event.pressed) { - uint8_t tmp_mods = host_get_mods(); - if (action.key.mods) { - host_add_mods(action.key.mods); - host_send_keyboard_report(); - } - register_code(action.key.code); - if (action.key.mods && action.key.code) { - host_set_mods(tmp_mods); - host_send_keyboard_report(); - } - } else { - if (action.key.mods && !action.key.code) { - host_del_mods(action.key.mods); - host_send_keyboard_report(); + case ACT_RMODS: + { + 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); } - unregister_code(action.key.code); } break; - case ACT_RMODS: - if (event.pressed) { - uint8_t tmp_mods = host_get_mods(); - if (action.key.mods) { - host_add_mods(action.key.mods<<4); - host_send_keyboard_report(); - } - register_code(action.key.code); - if (action.key.mods && action.key.code) { - host_set_mods(tmp_mods); - host_send_keyboard_report(); - } - } else { - if (action.key.mods && !action.key.code) { - host_del_mods(action.key.mods<<4); - host_send_keyboard_report(); + 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) { + 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"); + oneshot_start(mods, event.time); + } + else if (tap_count == TAPPING_TOGGLE) { + 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 { + if (tap_count == 0) { + debug("MODS_TAP: Oneshot: cancel/del_mods\n"); + // cancel oneshot on hold + 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); + } + } + break; + default: + if (event.pressed) { + if (tap_count > 0) { + if (waiting_buffer_has_anykey_pressed()) { + debug("MODS_TAP: Tap: Cancel: add_mods\n"); + // ad hoc: set 0 to cancel tap + record->tap.count = 0; + 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; } - unregister_code(action.key.code); } break; - case ACT_LMOD_TAP: - break; - case ACT_RMOD_TAP: - break; /* other HID usage */ case ACT_USAGE: #ifdef EXTRAKEY_ENABLE switch (action.usage.page) { - case ACTION_USAGE_PAGE_SYSTEM: + case PAGE_SYSTEM: if (event.pressed) { host_system_send(action.usage.code); } else { host_system_send(0); } break; - case ACTION_USAGE_PAGE_CONSUMER: + case PAGE_CONSUMER: if (event.pressed) { host_consumer_send(action.usage.code); } else { @@ -164,176 +355,317 @@ static void process(keyevent_t event, action_t action) #endif break; - /* Layer key */ - case ACT_LAYER_PRESSED: - // layer action when pressed + case ACT_KEYMAP: switch (action.layer.code) { - case 0x00: + /* Keymap clear */ + case OP_RESET: + switch (action.layer.val & 0x03) { + case 0: + // NOTE: reserved + overlay_clear(); + keymap_clear(); + break; + case ON_PRESS: + if (event.pressed) { + overlay_clear(); + keymap_clear(); + } + break; + case ON_RELEASE: + if (!event.pressed) { + overlay_clear(); + keymap_clear(); + } + break; + case ON_BOTH: + overlay_clear(); + keymap_clear(); + break; + /* NOTE: 4-7 rserved */ + } + break; + /* Keymap Reset default layer */ + case (OP_RESET | ON_PRESS): if (event.pressed) { - layer_switch(action.layer.opt); + default_layer_set(action.layer.val); + } + break; + case (OP_RESET | ON_RELEASE): + if (!event.pressed) { + default_layer_set(action.layer.val); } break; - case 0xF0: - // TODO: tap toggle + case (OP_RESET | ON_BOTH): + default_layer_set(action.layer.val); + break; + + /* Keymap Bit invert */ + case OP_INV: + /* with tap toggle */ + if (event.pressed) { + if (tap_count < TAPPING_TOGGLE) { + debug("KEYMAP_INV: tap toggle(press).\n"); + keymap_invert(action.layer.val); + } + } else { + if (tap_count <= TAPPING_TOGGLE) { + debug("KEYMAP_INV: tap toggle(release).\n"); + keymap_invert(action.layer.val); + } + } break; - case 0xFF: + case (OP_INV | ON_PRESS): if (event.pressed) { - default_layer = action.layer.opt; - layer_switch(default_layer); + keymap_invert(action.layer.val); + } + break; + case (OP_INV | ON_RELEASE): + if (!event.pressed) { + keymap_invert(action.layer.val); + } + break; + case (OP_INV | ON_BOTH): + keymap_invert(action.layer.val); + break; + + /* Keymap Bit on */ + case OP_ON: + if (event.pressed) { + keymap_on(action.layer.val); + } else { + keymap_off(action.layer.val); + } + break; + case (OP_ON | ON_PRESS): + if (event.pressed) { + 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); + } else { + keymap_on(action.layer.val); } break; + case (OP_OFF | ON_PRESS): + if (event.pressed) { + keymap_off(action.layer.val); + } + break; + case (OP_OFF | ON_RELEASE): + if (!event.pressed) { + keymap_off(action.layer.val); + } + break; + case (OP_OFF | ON_BOTH): + keymap_off(action.layer.val); + break; + + /* Keymap Bit set */ + case OP_SET: + if (event.pressed) { + keymap_set(action.layer.val); + } else { + keymap_clear(); + } + break; + case (OP_SET | ON_PRESS): + if (event.pressed) { + keymap_set(action.layer.val); + } + break; + case (OP_SET | ON_RELEASE): + if (!event.pressed) { + keymap_set(action.layer.val); + } + break; + case (OP_SET | ON_BOTH): + keymap_set(action.layer.val); + break; + + /* Keymap Bit invert with tap key */ default: - // with tap key if (event.pressed) { - if (tap_count == 0) { - if (host_has_anykey()) { - register_code(action.layer.code); - } else { - debug("Delay switching layer("); debug_hex8(action.layer.opt); debug(")\n"); - delaying_layer = (keyrecord_t){ - .event = event, - .action = action, - .mods = host_get_mods() - }; - } - } else if (tap_count > 0) { - debug("tap: "); debug_hex(tap_count); debug("\n"); + if (tap_count > 0) { + debug("KEYMAP_TAP_KEY: Tap: register_code\n"); register_code(action.layer.code); + } else { + debug("KEYMAP_TAP_KEY: No tap: On on press\n"); + keymap_on(action.layer.val); } } else { - // tap key - if (KEYEQ(event.key, delaying_layer.event.key) && - timer_elapsed(delaying_layer.event.time) <= TAP_TIME) { - uint8_t tmp_mods = host_get_mods(); - host_set_mods(delaying_layer.mods); - register_code(delaying_layer.action.layer.code); - host_set_mods(tmp_mods); - unregister_code(delaying_layer.action.layer.code); - } else { + if (tap_count > 0) { + debug("KEYMAP_TAP_KEY: Tap: unregister_code\n"); unregister_code(action.layer.code); + } else { + debug("KEYMAP_TAP_KEY: No tap: Off on release\n"); + keymap_off(action.layer.val); } - delaying_layer = (keyrecord_t){}; } break; } break; - case ACT_LAYER_RELEASED: + + case ACT_OVERLAY: switch (action.layer.code) { - case 0x00: + // Overlay Invert bit4 + case OP_INV4 | 0: + if (action.layer.val == 0) { + // NOTE: reserved for future use + overlay_clear(); + } else { + overlay_set(overlay_stat ^ action.layer.val); + } + break; + case OP_INV4 | 1: + if (action.layer.val == 0) { + // on pressed + if (event.pressed) overlay_clear(); + } else { + overlay_set(overlay_stat ^ action.layer.val<<4); + } + break; + case OP_INV4 | 2: + if (action.layer.val == 0) { + // on released + if (!event.pressed) overlay_clear(); + } else { + overlay_set(overlay_stat ^ action.layer.val<<8); + } + break; + case OP_INV4 | 3: + if (action.layer.val == 0) { + // on both + overlay_clear(); + } else { + overlay_set(overlay_stat ^ action.layer.val<<12); + } + break; + + /* Overlay Bit invert */ + case OP_INV: + /* with tap toggle */ if (event.pressed) { - layer_switch(action.layer.opt); + if (tap_count < TAPPING_TOGGLE) { + debug("OVERLAY_INV: tap toggle(press).\n"); + overlay_invert(action.layer.val); + } + } else { + if (tap_count <= TAPPING_TOGGLE) { + debug("OVERLAY_INV: tap toggle(release).\n"); + overlay_invert(action.layer.val); + } } break; - case 0xF0: - // Ignored. LAYER_RELEASED with tap toggle is invalid action. + case (OP_INV | ON_PRESS): + if (event.pressed) { + overlay_invert(action.layer.val); + } break; - case 0xFF: + case (OP_INV | ON_RELEASE): if (!event.pressed) { - default_layer = action.layer.opt; - layer_switch(default_layer); + overlay_invert(action.layer.val); } break; - default: - // Ignored. LAYER_RELEASED with tap key is invalid action. + case (OP_INV | ON_BOTH): + overlay_invert(action.layer.val); break; - } - break; - case ACT_LAYER_BIT: - switch (action.layer.code) { - case 0x00: + + /* Overlay Bit on */ + case OP_ON: if (event.pressed) { - layer_switch(current_layer | action.layer.opt); + overlay_on(action.layer.val); } else { - layer_switch(current_layer & ~action.layer.opt); + overlay_off(action.layer.val); + } + break; + case (OP_ON | ON_PRESS): + if (event.pressed) { + overlay_on(action.layer.val); + } + break; + case (OP_ON | ON_RELEASE): + if (!event.pressed) { + overlay_on(action.layer.val); } break; - case 0xF0: - // TODO: tap toggle + case (OP_ON | ON_BOTH): + overlay_on(action.layer.val); break; - case 0xFF: - // change default layer + + /* Overlay Bit off */ + case OP_OFF: if (event.pressed) { - default_layer = current_layer | action.layer.opt; - layer_switch(default_layer); + overlay_off(action.layer.val); } else { - default_layer = current_layer & ~action.layer.opt; - layer_switch(default_layer); + overlay_on(action.layer.val); } break; - default: - // with tap key + case (OP_OFF | ON_PRESS): if (event.pressed) { - if (tap_count == 0) { - if (host_has_anykey()) { - register_code(action.layer.code); - } else { - delaying_layer = (keyrecord_t){ - .event = event, - .action = action, - .mods = keyboard_report->mods - }; - } - } else if (tap_count > 0) { - debug("tap: "); debug_hex(tap_count); debug("\n"); - register_code(action.layer.code); - } + overlay_off(action.layer.val); + } + break; + case (OP_OFF | ON_RELEASE): + if (!event.pressed) { + overlay_off(action.layer.val); + } + break; + case (OP_OFF | ON_BOTH): + overlay_off(action.layer.val); + break; + + /* Overlay Bit set */ + case OP_SET: + if (event.pressed) { + overlay_move(action.layer.val); } else { - if (tap_count == 0) { - // no tap - layer_switch(current_layer & ~action.layer.opt); - } else if (tap_count == 1) { - // tap - register_code(action.layer.code); - } - unregister_code(action.layer.code); + overlay_clear(); } break; - } - case ACT_LAYER_EXT: - switch (action.layer.opt) { - case 0x00: - // set default layer when pressed - switch (action.layer.code) { - case 0x00: - if (event.pressed) { - layer_switch(default_layer); - } - break; - case 0xF0: - // TODO: tap toggle - break; - case 0xFF: - if (event.pressed) { - default_layer = current_layer; - layer_switch(default_layer); - } - break; - default: - // TODO: tap key - break; + case (OP_SET | ON_PRESS): + if (event.pressed) { + overlay_move(action.layer.val); } break; - case 0x01: - // set default layer when released - switch (action.layer.code) { - case 0x00: - if (!event.pressed) { - layer_switch(default_layer); - } - break; - case 0xFF: - if (!event.pressed) { - default_layer = current_layer; - layer_switch(default_layer); - } - break; - case 0xF0: - default: - // Ignore tap. - if (!event.pressed) { - layer_switch(default_layer); - } - break; + case (OP_SET | ON_RELEASE): + if (!event.pressed) { + overlay_move(action.layer.val); + } + break; + case (OP_SET | ON_BOTH): + overlay_move(action.layer.val); + break; + + /* Overlay Bit invert with tap key */ + default: + if (event.pressed) { + if (tap_count > 0) { + debug("OVERLAY_TAP_KEY: Tap: register_code\n"); + register_code(action.layer.code); + } else { + debug("OVERLAY_TAP_KEY: No tap: On on press\n"); + overlay_on(action.layer.val); + } + } else { + if (tap_count > 0) { + debug("OVERLAY_TAP_KEY: Tap: unregister_code\n"); + unregister_code(action.layer.code); + } else { + debug("OVERLAY_TAP_KEY: No tap: Off on release\n"); + overlay_off(action.layer.val); + } } break; } @@ -341,92 +673,248 @@ static void process(keyevent_t event, action_t action) /* Extentions */ case ACT_MACRO: + action_macro_play(action_get_macro(record, action.func.id, action.func.opt)); + break; case ACT_COMMAND: + break; case ACT_FUNCTION: + action_function(record, action.func.id, action.func.opt); + break; default: break; } } -void action_exec(keyevent_t event) +/* Tapping + * + * Rule: Tap key is typed(pressed and released) within TAPPING_TERM. + * (without interfering by typing other key) + */ +/* return true when key event is processed or consumed. */ +static bool process_tapping(keyrecord_t *keyp) { -/* - debug("key["); debug_hex8(event.key.row); debug(":"); debug_hex8(event.key.col); - if (event.pressed) debug("]down\n"); else debug("]up\n"); -*/ + keyevent_t event = keyp->event; - /* When delaying layer switch */ - if (delaying_layer.action.code) { - /* Layer switch when tap time elapses or waiting key is released */ - if ((timer_elapsed(delaying_layer.event.time) > TAP_TIME) || - (!event.pressed && waiting_keys_has(event.key))) { - /* layer switch */ - switch (delaying_layer.action.kind.id) { - case ACT_LAYER_PRESSED: - layer_switch(delaying_layer.action.layer.opt); - break; - case ACT_LAYER_BIT: - layer_switch(current_layer | delaying_layer.action.layer.opt); - break; - } - delaying_layer = (keyrecord_t){}; + // if tapping + if (IS_TAPPING_PRESSED()) { + if (WITHIN_TAPPING_TERM(event)) { + if (tapping_key.tap.count == 0) { + if (IS_TAPPING_KEY(event.key) && !event.pressed) { + // first tap! + debug("Tapping: First tap(0->1).\n"); + tapping_key.tap.count = 1; + tapping_key.tap.interrupted = (waiting_buffer_has_anykey_pressed() ? true : false); + debug_tapping_key(); + process_action(&tapping_key); - /* Process waiting keys in new layer */ - waiting_keys_process_in_current_layer(); - } - /* when delaying layer key is released within delay term */ - else if (!event.pressed && KEYEQ(event.key, delaying_layer.event.key)) { - /* tap key down */ - uint8_t tmp_mods = host_get_mods(); - host_set_mods(delaying_layer.mods); - register_code(delaying_layer.action.layer.code); - delaying_layer = (keyrecord_t){}; - host_set_mods(tmp_mods); + // enqueue + keyp->tap = tapping_key.tap; + return false; + } +#if TAPPING_TERM >= 500 + /* This can prevent from typing some tap keys in a row at a time. */ + else if (!event.pressed && waiting_buffer_typed(event)) { + // other key typed. not tap. + debug("Tapping: End. No tap. Interfered by typing key\n"); + process_action(&tapping_key); + tapping_key = (keyrecord_t){}; + debug_tapping_key(); - /* process waiting keys */ - waiting_keys_process_in_current_layer(); + // enqueue + return false; + } +#endif + else { + // other key events shall be enq'd till tapping state settles. + return false; + } + } + // tap_count > 0 + else { + if (IS_TAPPING_KEY(event.key) && !event.pressed) { + debug("Tapping: Tap release("); debug_dec(tapping_key.tap.count); debug(")\n"); + keyp->tap = tapping_key.tap; + process_action(keyp); + tapping_key = *keyp; + debug_tapping_key(); + return true; + } + else if (is_tap_key(keyp->event.key) && event.pressed) { + if (tapping_key.tap.count > 1) { + debug("Tapping: Start new tap with releasing last tap(>1).\n"); + // unregister key + process_action(&(keyrecord_t){ + .tap = tapping_key.tap, + .event.key = tapping_key.event.key, + .event.time = event.time, + .event.pressed = false + }); + } else { + debug("Tapping: Start while last tap(1).\n"); + } + tapping_key = *keyp; + waiting_buffer_scan_tap(); + debug_tapping_key(); + return true; + } + else { + if (!IS_NOEVENT(keyp->event)) { + debug("Tapping: key event while last tap(>0).\n"); + } + process_action(keyp); + return true; + } + } + } + // after TAPPING_TERM + else { + if (tapping_key.tap.count == 0) { + debug("Tapping: End. Timeout. Not tap(0): "); + debug_event(event); debug("\n"); + process_action(&tapping_key); + tapping_key = (keyrecord_t){}; + debug_tapping_key(); + return false; + } else { + if (IS_TAPPING_KEY(event.key) && !event.pressed) { + debug("Tapping: End. last timeout tap release(>0)."); + keyp->tap = tapping_key.tap; + process_action(keyp); + tapping_key = (keyrecord_t){}; + return true; + } + else if (is_tap_key(keyp->event.key) && event.pressed) { + if (tapping_key.tap.count > 1) { + debug("Tapping: Start new tap with releasing last timeout tap(>1).\n"); + // unregister key + process_action(&(keyrecord_t){ + .tap = tapping_key.tap, + .event.key = tapping_key.event.key, + .event.time = event.time, + .event.pressed = false + }); + } else { + debug("Tapping: Start while last timeout tap(1).\n"); + } + tapping_key = *keyp; + waiting_buffer_scan_tap(); + debug_tapping_key(); + return true; + } + else { + if (!IS_NOEVENT(keyp->event)) { + debug("Tapping: key event while last timeout tap(>0).\n"); + } + process_action(keyp); + return true; + } + } + } + } else if (IS_TAPPING_RELEASED()) { + if (WITHIN_TAPPING_TERM(event)) { + if (tapping_key.tap.count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) { + // sequential tap. + keyp->tap = tapping_key.tap; + keyp->tap.count += 1; + debug("Tapping: Tap press("); debug_dec(keyp->tap.count); debug(")\n"); + process_action(keyp); + tapping_key = *keyp; + debug_tapping_key(); + return true; + } else if (event.pressed && is_tap_key(event.key)) { + // Sequential tap can be interfered with other tap key. + debug("Tapping: Start with interfering other tap.\n"); + tapping_key = *keyp; + waiting_buffer_scan_tap(); + debug_tapping_key(); + return true; + } else { + if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n"); + process_action(keyp); + return true; + } + } else { + // timeout. no sequential tap. + debug("Tapping: End(Timeout after releasing last tap): "); + debug_event(event); debug("\n"); + tapping_key = (keyrecord_t){}; + debug_tapping_key(); + return false; } } - - // not real event. event just to update delaying layer. - if (IS_NOEVENT(event)) { - return; + // not tapping satate + else { + if (event.pressed && is_tap_key(event.key)) { + debug("Tapping: Start(Press tap key).\n"); + tapping_key = *keyp; + waiting_buffer_scan_tap(); + debug_tapping_key(); + return true; + } else { + process_action(keyp); + return true; + } } +} - /* count tap when key is up */ - if (KEYEQ(event.key, last_event.key) && timer_elapsed(last_event.time) <= TAP_TIME) { - if (!event.pressed) tap_count++; - } else { - tap_count = 0; - } +/* 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; - action_t action = keymap_get_action(current_layer, event.key.row, event.key.col); + 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); - // TODO: all key events(pressed, released) should be recorded? - /* postpone key-down events while delaying layer */ - if (delaying_layer.action.code) { - if (event.pressed) { - waiting_keys_enqueue(event, action); - } else { - process(event, action); + debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n"); + debug_waiting_buffer(); + return; } - } else { - process(event, action); } - - /* last event */ - last_event = event; } -static void register_code(uint8_t code) + +/* + * 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< "); debug_hex(new_layer); debug("\n"); + 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; +} + - current_layer = new_layer; - clear_keyboard_but_mods(); // To avoid stuck keys - // TODO: update mods with full scan of matrix? if modifier changes between layers +/* + * 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("{ "); + for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) { + debug("["); debug_dec(i); debug("]="); debug_record(waiting_buffer[i]); debug(" "); } + debug("}\n"); }