#include "command.h"
#include "util.h"
#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
*/
*/
#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;
-}
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");
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("] = ");
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;
+ uint8_t tap_count = record->tap.count;
if (IS_NOEVENT(event)) { return; }
- action_t action = keymap_get_action(current_layer, event.key.pos.row, event.key.pos.col);
- //debug("action: "); debug_hex16(action.code); if (event.pressed) debug("d\n"); else debug("u\n");
- debug("ACTION: "); debug_action(action); debug("\n");
+ 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 */
}
}
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) {
}
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");
} else {
if (tap_count == 0) {
debug("MODS_TAP: Oneshot: cancel/del_mods\n");
- // cancel oneshot by holding.
+ // cancel oneshot on hold
oneshot_cancel();
del_mods(mods);
}
}
}
break;
+ #endif
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;
+ record->tap.count = 0;
add_mods(mods);
} else {
debug("MODS_TAP: Tap: register_code\n");
}
}
break;
-
+#endif
+#ifdef EXTRAKEY_ENABLE
/* other HID usage */
case ACT_USAGE:
-#ifdef EXTRAKEY_ENABLE
switch (action.usage.page) {
case PAGE_SYSTEM:
if (event.pressed) {
}
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();
mousekey_off(action.key.code);
mousekey_send();
}
-#endif
break;
-
- /* Layer key */
- case ACT_LAYER:
+#endif
+#ifndef NO_ACTION_KEYMAP
+ case ACT_KEYMAP:
switch (action.layer.code) {
- case LAYER_MOMENTARY: /* momentary */
- if (event.pressed) {
- layer_switch(action.layer.val);
- }
- else {
- layer_switch(default_layer);
- }
- break;
- case LAYER_ON_PRESS:
- if (event.pressed) {
- layer_switch(action.layer.val);
- }
- break;
- case LAYER_ON_RELEASE:
- if (!event.pressed) {
- layer_switch(action.layer.val);
- }
- break;
- case LAYER_DEFAULT: /* default layer */
- switch (action.layer.val) {
- case DEFAULT_ON_BOTH:
- layer_switch(default_layer);
+ /* Keymap clear */
+ case OP_RESET:
+ switch (action.layer.val & 0x03) {
+ case 0:
+ // NOTE: reserved
+ overlay_clear();
+ keymap_clear();
break;
- case DEFAULT_ON_PRESS:
+ case ON_PRESS:
if (event.pressed) {
- layer_switch(default_layer);
+ overlay_clear();
+ keymap_clear();
}
break;
- case DEFAULT_ON_RELEASE:
+ case ON_RELEASE:
if (!event.pressed) {
- layer_switch(default_layer);
+ 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 LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
+ 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) {
- layer_switch(action.layer.val);
+ debug("KEYMAP_INV: tap toggle(press).\n");
+ keymap_invert(action.layer.val);
}
} else {
- if (tap_count >= TAPPING_TOGGLE) {
- debug("LAYER_PRESSED: tap toggle.\n");
- layer_switch(action.layer.val);
+ if (tap_count <= TAPPING_TOGGLE) {
+ debug("KEYMAP_INV: tap toggle(release).\n");
+ keymap_invert(action.layer.val);
}
}
break;
- case LAYER_CHANGE_DEFAULT: /* change default layer */
+ 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) {
- default_layer = action.layer.val;
- layer_switch(default_layer);
+ keymap_set(action.layer.val);
+ }
+ break;
+ case (OP_SET | ON_RELEASE):
+ if (!event.pressed) {
+ keymap_set(action.layer.val);
}
break;
- default: /* switch layer on hold and key on tap*/
+ 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("LAYER_PRESSED: Tap: register_code\n");
+ if (tap_count > 0) {
+ debug("KEYMAP_TAP_KEY: Tap: register_code\n");
register_code(action.layer.code);
- } else {
- debug("LAYER_PRESSED: No tap: layer_switch\n");
- layer_switch(action.layer.val);
- }
+ } else {
+ debug("KEYMAP_TAP_KEY: No tap: On on press\n");
+ keymap_on(action.layer.val);
+ }
} else {
if (tap_count > 0) {
- debug("LAYER_PRESSED: Tap: unregister_code\n");
+ debug("KEYMAP_TAP_KEY: Tap: unregister_code\n");
unregister_code(action.layer.code);
} else {
- //debug("LAYER_PRESSED: No tap: NO ACTION\n");
-//TODO: this is ok?
- debug("LAYER_PRESSED: No tap: return to default layer\n");
- layer_switch(default_layer);
+ debug("KEYMAP_TAP_KEY: No tap: Off on release\n");
+ keymap_off(action.layer.val);
}
}
break;
}
break;
- case ACT_LAYER_BIT:
+#endif
+#ifndef NO_ACTION_OVERLAY
+ case ACT_OVERLAY:
switch (action.layer.code) {
- case LAYER_MOMENTARY: /* momentary */
- if (event.pressed) {
- layer_switch(current_layer ^ action.layer.val);
+ // Overlay Invert bit4
+ case OP_INV4 | 0:
+ if (action.layer.val == 0) {
+ // NOTE: reserved for future use
+ overlay_clear();
} else {
- layer_switch(current_layer ^ action.layer.val);
+ overlay_set(overlay_stat ^ action.layer.val);
}
break;
- case LAYER_ON_PRESS:
- if (event.pressed) {
- layer_switch(current_layer ^ action.layer.val);
+ 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 LAYER_ON_RELEASE:
- if (!event.pressed) {
- layer_switch(current_layer ^ action.layer.val);
+ 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 LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
+ 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("LAYER_BIT: tap toggle(press).\n");
- layer_switch(current_layer ^ action.layer.val);
+ debug("OVERLAY_INV: tap toggle(press).\n");
+ overlay_invert(action.layer.val);
}
} else {
if (tap_count <= TAPPING_TOGGLE) {
- debug("LAYER_BIT: tap toggle(release).\n");
- layer_switch(current_layer ^ action.layer.val);
+ debug("OVERLAY_INV: tap toggle(release).\n");
+ overlay_invert(action.layer.val);
}
}
break;
- case 0xFF:
- // change default layer
+ 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) {
- default_layer = current_layer ^ action.layer.val;
- layer_switch(default_layer);
+ overlay_move(action.layer.val);
} else {
- default_layer = current_layer ^ action.layer.val;
- layer_switch(default_layer);
+ 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:
- // with tap key
if (event.pressed) {
- if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
- debug("LAYER_BIT: Tap: register_code\n");
+ if (tap_count > 0) {
+ debug("OVERLAY_TAP_KEY: Tap: register_code\n");
register_code(action.layer.code);
} else {
- debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
- layer_switch(current_layer ^ action.layer.val);
+ debug("OVERLAY_TAP_KEY: No tap: On on press\n");
+ overlay_on(action.layer.val);
}
} else {
- if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
- debug("LAYER_BIT: Tap: unregister_code\n");
+ if (tap_count > 0) {
+ debug("OVERLAY_TAP_KEY: Tap: unregister_code\n");
unregister_code(action.layer.code);
} else {
- debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
- layer_switch(current_layer ^ action.layer.val);
+ 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:
- // TODO
- keymap_call_function(record, action.func.id, action.func.opt);
+ action_function(record, action.func.id, action.func.opt);
break;
+#endif
default:
break;
}
}
-/* Tapping
- *
- * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
- * (without interfering by typing other key)
+
+
+
+/*
+ * Utilities for actions.
*/
-/* return true when key event is processed or consumed. */
-static bool process_tapping(keyrecord_t *keyp)
+void register_code(uint8_t code)
{
- keyevent_t event = keyp->event;
+ 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;
- // 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;
- debug_tapping_key();
- process_action(&tapping_key);
+#ifndef NO_ACTION_ONESHOT
+ if (oneshot_state.mods && !oneshot_state.disabled) {
+ uint8_t tmp_mods = host_get_mods();
+ host_add_mods(oneshot_state.mods);
- // enqueue
- keyp->tap_count = tapping_key.tap_count;
- 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();
+ host_add_key(code);
+ host_send_keyboard_report();
- // enqueue
- return false;
- }
+ host_set_mods(tmp_mods);
+ oneshot_cancel();
+ } else
#endif
- else {
- // other key events shall be enq'd till tapping state settles.
- return false;
+ {
+ 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.
+ * (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_count = tapping_key.tap_count;
+ 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) {
+ if (tapping_key.tap.count > 1) {
debug("Tapping: Start new tap with releasing last tap(>1).\n");
// unregister key
process_action(&(keyrecord_t){
- .tap_count = tapping_key.tap_count,
+ .tap = tapping_key.tap,
.event.key = tapping_key.event.key,
.event.time = event.time,
.event.pressed = false
}
// after TAPPING_TERM
else {
- if (tapping_key.tap_count == 0) {
+ if (tapping_key.tap.count == 0) {
debug("Tapping: End. Timeout. Not tap(0): ");
debug_event(event); debug("\n");
process_action(&tapping_key);
} else {
if (IS_TAPPING_KEY(event.key) && !event.pressed) {
debug("Tapping: End. last timeout tap release(>0).");
- keyp->tap_count = tapping_key.tap_count;
+ 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) {
+ 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_count = tapping_key.tap_count,
+ .tap = tapping_key.tap,
.event.key = tapping_key.event.key,
.event.time = event.time,
.event.pressed = false
}
} else if (IS_TAPPING_RELEASED()) {
if (WITHIN_TAPPING_TERM(event)) {
- if (tapping_key.tap_count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
+ if (tapping_key.tap.count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
// sequential tap.
- keyp->tap_count = tapping_key.tap_count + 1;
- debug("Tapping: Tap press("); debug_dec(keyp->tap_count); debug(")\n");
+ 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();
}
}
-/* 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;
- }
- 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();
-
- 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();
+ if (IS_NOEVENT(record.event)) {
+ return true;
}
-}
-void unregister_code(uint8_t code)
-{
- 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();
+ if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
+ debug("waiting_buffer_enq: Over flow.\n");
+ return false;
}
-}
-void add_mods(uint8_t mods)
-{
- if (mods) {
- host_add_mods(mods);
- host_send_keyboard_report();
- }
-}
+ waiting_buffer[waiting_buffer_head] = record;
+ waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
-void del_mods(uint8_t mods)
-{
- if (mods) {
- host_del_mods(mods);
- host_send_keyboard_report();
- }
+ debug("waiting_buffer_enq: "); debug_waiting_buffer();
+ return true;
}
-void set_mods(uint8_t mods)
+static void waiting_buffer_clear(void)
{
- host_set_mods(mods);
- host_send_keyboard_report();
+ waiting_buffer_head = 0;
+ waiting_buffer_tail = 0;
}
-void clear_keyboard(void)
+#if TAPPING_TERM >= 500
+static bool waiting_buffer_typed(keyevent_t event)
{
- host_clear_mods();
- clear_keyboard_but_mods();
+ 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;
}
-
-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)
+bool waiting_buffer_has_anykey_pressed(void)
{
- 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 (waiting_buffer[i].event.pressed) return true;
+ }
+ return false;
}
-
-void layer_switch(uint8_t new_layer)
+/* scan buffer for tapping */
+static void waiting_buffer_scan_tap(void)
{
- if (current_layer != new_layer) {
- debug("Layer Switch: "); debug_hex(current_layer);
- debug(" -> "); debug_hex(new_layer); debug("\n");
+ // 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;
- current_layer = new_layer;
- clear_keyboard_but_mods(); // To avoid stuck keys
- // NOTE: update mods with full scan of matrix? if modifier changes between layers
- }
-}
+ 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);
-bool is_tap_key(key_t key)
-{
- action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
- switch (action.kind.id) {
- case ACT_LMODS_TAP:
- case ACT_RMODS_TAP:
- return true;
- case ACT_LAYER:
- case ACT_LAYER_BIT:
- switch (action.layer.code) {
- case 0x00:
- case 0xF1 ... 0xFF:
- return false;
- case 0xF0:
- default:
- return true;
- }
- return false;
- 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.raw);
- 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);
-}
-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_LAYER: debug("ACT_LAYER"); break;
- case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); 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("{ ");
}
debug("}\n");
}
+#endif