/* 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" #include "keycode.h" #include "keyboard.h" #include "mousekey.h" #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); #ifndef NO_ACTION_TAPPING static bool process_tapping(keyrecord_t *record); static void waiting_buffer_scan_tap(void); #endif static void debug_event(keyevent_t event); static void debug_record(keyrecord_t record); static void debug_action(action_t action); #ifndef NO_ACTION_TAPPING static void debug_tapping_key(void); static void debug_waiting_buffer(void); #endif /* * 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 #ifndef NO_ACTION_TAPPING /* 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) /* * Waiting buffer * * stores key events waiting for settling current tap. */ #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; } #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; } #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; } #endif 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 }; #ifndef NO_ACTION_TAPPING // 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"); } #else process_action(&record); if (!IS_NOEVENT(record.event)) { debug("processed: "); debug_record(record); debug("\n"); } #endif } 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: 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); } } 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) { 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; } } break; #endif #ifdef EXTRAKEY_ENABLE /* other HID usage */ case ACT_USAGE: switch (action.usage.page) { case PAGE_SYSTEM: if (event.pressed) { host_system_send(action.usage.code); } else { host_system_send(0); } break; case PAGE_CONSUMER: if (event.pressed) { host_consumer_send(action.usage.code); } else { host_consumer_send(0); } break; } break; #endif #ifdef MOUSEKEY_ENABLE /* Mouse key */ case ACT_MOUSEKEY: if (event.pressed) { mousekey_on(action.key.code); mousekey_send(); } else { mousekey_off(action.key.code); mousekey_send(); } break; #endif case ACT_KEYMAP: switch (action.layer.code) { /* 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) { default_layer_set(action.layer.val); } break; case (OP_RESET | ON_RELEASE): if (!event.pressed) { default_layer_set(action.layer.val); } break; 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 (OP_INV | ON_PRESS): if (event.pressed) { 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: if (event.pressed) { 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 { 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); } } break; } break; #ifndef NO_ACTION_OVERLAY case ACT_OVERLAY: switch (action.layer.code) { // 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) { 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 (OP_INV | ON_PRESS): if (event.pressed) { overlay_invert(action.layer.val); } break; case (OP_INV | ON_RELEASE): if (!event.pressed) { overlay_invert(action.layer.val); } break; case (OP_INV | ON_BOTH): overlay_invert(action.layer.val); break; /* Overlay Bit on */ case OP_ON: if (event.pressed) { overlay_on(action.layer.val); } else { 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 (OP_ON | ON_BOTH): overlay_on(action.layer.val); break; /* Overlay Bit off */ case OP_OFF: if (event.pressed) { overlay_off(action.layer.val); } else { overlay_on(action.layer.val); } break; case (OP_OFF | ON_PRESS): if (event.pressed) { 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 { overlay_clear(); } break; case (OP_SET | ON_PRESS): if (event.pressed) { overlay_move(action.layer.val); } 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; } 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; } } #ifndef NO_ACTION_TAPPING /* 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) { keyevent_t event = keyp->event; // 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); // 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(); // 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 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; } } } /* 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; } } } #endif /* * 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<>8); debug(":"); debug_hex8(action.kind.param & 0xff); debug("]"); } #ifndef NO_ACTION_TAPPING 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"); } #endif