+/*
+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/>.
+*/
#include "host.h"
#include "timer.h"
#include "keymap.h"
#include "command.h"
#include "util.h"
#include "debug.h"
+#include "led.h"
+#include "layer_switch.h"
+#include "action_macro.h"
#include "action.h"
-#define Kdebug(s) do { if (debug_keyboard) debug(s); } while(0)
-#define Kdebug_P(s) do { if (debug_keyboard) debug_P(s); } while(0)
-#define Kdebug_hex(s) do { if (debug_keyboard) debug_hex(s); } while(0)
+
+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)
+
+
+/*
+ * Waiting buffer
*
- * Event/State|IDLE PRESSING DELAYING[f] WAITING[f,k]
- * -----------+------------------------------------------------------------------
- * Fn Down |(L+) -*1 WAITING(Sk) IDLE(Rf,Ps)*7
- * Up |(L-) IDLE(L-)*8 IDLE(L-)*8 IDLE(L-)*8
- * Fnk Down |DELAYING(Sf)* (Rf) WAITING(Sk) IDLE(Rf,Ps,Rf)
- * Up |(L-) IDLE(L-/Uf)*8 IDLE(Rf,Uf/L-)*3 IDLE(Rf,Ps,Uf/L-)*3
- * Key Down |PRESSING(Rk) (Rk) WAITING(Sk) IDLE(Rf,Ps,Rk)
- * Up |(Uk) IDLE(Uk)*4 (Uk) IDLE(L+,Ps,Pk)/(Uk)*a
- * |
- * Delay |- - IDLE(L+) IDLE(L+,Ps)
- * Magic Key |COMMAND*5
- *
- * *1: ignore Fn if other key is down.
- * *2: register Fnk if any key is pressing
- * *3: register/unregister delayed Fnk and move to IDLE if code == delayed Fnk, else *8
- * *4: if no keys registered to host
- * *5: unregister all keys
- * *6: only if no keys down
- * *7: ignore Fn because Fnk key and stored key are down.
- * *8: move to IDLE if layer switch(off) occurs, else stay at current state
- * *9: repeat key if pressing Fnk twice quickly(move to PRESSING)
- * *a: layer switch and process waiting key and code if code == wainting key, else unregister key
- *
- * States:
- * IDLE: No key is down except modifiers
- * DELAYING: delay layer switch after pressing Fn with alt keycode
- * WAITING: key is pressed during DELAYING
- *
- * Events:
- * Fn: Fn key without alternative keycode
- * Fnk: Fn key with alternative keycode
- * -: ignore
- * Delay: layer switch delay term is elapsed
- *
- * Actions:
- * Rk: register key
- * Uk: unregister key
- * Rf: register Fn(alt keycode)
- * Uf: unregister Fn(alt keycode)
- * Rs: register stored key
- * Us: unregister stored key
- * Sk: Store key(waiting Key)
- * Sf: Store Fn(delayed Fn)
- * Ps: Process stored key
- * Ps: Process key
- * Is: Interpret stored keys in current layer
- * L+: Switch to new layer(*unregister* all keys but modifiers)
- * L-: Switch back to last layer(*unregister* all keys but modifiers)
- * Ld: Switch back to default layer(*unregister* all keys but modifiers)
+ * 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;
-typedef enum { IDLE, DELAYING, WAITING, PRESSING } kbdstate_t;
-#define NEXT(state) do { \
- Kdebug("NEXT: "); Kdebug_P(state_str(kbdstate)); \
- kbdstate = state; \
- Kdebug(" -> "); Kdebug_P(state_str(kbdstate)); Kdebug("\n"); \
-} while (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;
+ }
-static kbdstate_t kbdstate = IDLE;
-static uint8_t fn_state_bits = 0;
+ 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 const char *state_str(kbdstate_t state)
+static void waiting_buffer_clear(void)
{
- if (state == IDLE) return PSTR("IDLE");
- if (state == DELAYING) return PSTR("DELAYING");
- if (state == WAITING) return PSTR("WAITING");
- if (state == PRESSING) return PSTR("PRESSING");
- return PSTR("UNKNOWN");
+ waiting_buffer_head = 0;
+ waiting_buffer_tail = 0;
}
-static bool anykey_sent_to_host(void)
+
+#if TAPPING_TERM >= 500
+static bool waiting_buffer_typed(keyevent_t event)
{
- return (host_has_anykey() || host_mouse_in_use() ||
- host_last_sysytem_report() || host_last_consumer_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
+
+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;
}
-static void register_code(uint8_t code);
-static void unregister_code(uint8_t code);
-static void register_mods(uint8_t mods);
-static void unregister_mods(uint8_t mods);
-static void clear_keyboard(void);
-static void clear_keyboard_but_mods(void);
-static void layer_switch(uint8_t new_layer);
+/* 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;
+}
-/* tap */
-#define TAP_TIME 200
-#define LAYER_DELAY 200
-static keyevent_t last_event = {};
-static uint16_t last_event_time = 0;
-static uint8_t tap_count = 0;
+static void oneshot_toggle(void)
+{
+ oneshot_state.disabled = !oneshot_state.disabled;
+}
-/* layer */
-uint8_t default_layer = 0;
-uint8_t current_layer = 0;
-keyrecord_t delaying_layer = {};
void action_exec(keyevent_t event)
{
- /* 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++;
+ 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 {
- tap_count = 0;
+ // 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){};
+ }
}
- /* layer switch after LAYER_DELAY */
- if (delaying_layer.action.code && timer_elapsed(delaying_layer.event.time) > LAYER_DELAY) {
- 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;
+ // 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;
}
- delaying_layer = (keyrecord_t){};
}
- action_t action = keymap_get_action(current_layer, event.key.row, event.key.col);
+ if (!IS_NOEVENT(event)) {
+ debug("\n");
+ }
+}
- debug("action: "); debug_hex16(action.code); debug("\n");
- debug("kind.id: "); debug_hex(action.kind.id); debug("\n");
- debug("kind.param: "); debug_hex16(action.kind.param); debug("\n");
- debug("key.code: "); debug_hex(action.key.code); debug("\n");
- debug("key.mods: "); debug_hex(action.key.mods); 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) {
- register_mods(action.key.mods);
- register_code(action.key.code);
- } else {
- unregister_code(action.key.code);
- unregister_mods(action.key.mods);
- }
- break;
case ACT_RMODS:
- if (event.pressed) {
- register_mods(action.key.mods<<4);
- register_code(action.key.code);
- } else {
- unregister_code(action.key.code);
- unregister_mods(action.key.mods<<4);
+ {
+ 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;
- case ACT_LMOD_TAP:
- break;
- case ACT_RMOD_TAP:
+ 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;
+
+ /* 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 {
}
#endif
break;
+
+ /* Mouse key */
case ACT_MOUSEKEY:
#ifdef MOUSEKEY_ENABLE
if (event.pressed) {
}
#endif
break;
- 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) {
+ 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) {
- layer_switch(action.layer.opt);
+ keymap_invert(action.layer.val);
+ }
+ break;
+ case (OP_INV | ON_RELEASE):
+ if (!event.pressed) {
+ keymap_invert(action.layer.val);
}
break;
- case 0xF0:
- // TODO: tap toggle
+ 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 0xFF:
+ case (OP_ON | ON_PRESS):
if (event.pressed) {
- default_layer = action.layer.opt;
- layer_switch(default_layer);
+ 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
- debug("tap: "); debug_hex(tap_count); debug("\n");
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) {
+ 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 {
- // type key after tap
- if (tap_count == 1) {
- delaying_layer = (keyrecord_t){};
- register_code(action.layer.code);
+ 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);
}
- unregister_code(action.layer.code);
}
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
- debug("tap: "); debug_hex(tap_count); debug("\n");
+ 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) {
- 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;
}
break;
+
+ /* 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;
}
+}
+
+/* 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;
- /* last event */
- last_event = event;
- last_event_time = timer_read();
+ // 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;
+ }
+ }
}
-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<<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)) {
+ 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();
+
+ host_set_mods(tmp_mods);
+ oneshot_state.ready = false;
+ } else {
host_add_key(code);
host_send_keyboard_report();
}
}
}
-static void unregister_code(uint8_t code)
+void unregister_code(uint8_t code)
{
- if IS_KEY(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();
}
}
}
-static void register_mods(uint8_t mods)
+void add_mods(uint8_t mods)
{
- if (!mods) return;
- host_add_mods(mods);
- host_send_keyboard_report();
+ 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();
+ }
}
-static void unregister_mods(uint8_t mods)
+void set_mods(uint8_t mods)
{
- if (!mods) return;
- host_del_mods(mods);
+ host_set_mods(mods);
host_send_keyboard_report();
}
-static void clear_keyboard(void)
+void clear_keyboard(void)
{
host_clear_mods();
clear_keyboard_but_mods();
}
-static void clear_keyboard_but_mods(void)
+void clear_keyboard_but_mods(void)
{
host_clear_keys();
host_send_keyboard_report();
#endif
}
-static void layer_switch(uint8_t new_layer)
+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)
{
- if (current_layer != new_layer) {
- Kdebug("Layer Switch: "); Kdebug_hex(current_layer);
- Kdebug(" -> "); Kdebug_hex(new_layer); Kdebug("\n");
+ action_t action = layer_switch_get_action(key);
- current_layer = new_layer;
- clear_keyboard_but_mods(); // To avoid stuck keys
+ 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("]");
+}
+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");
}
projects / tmk_firmware.git / blobdiff