@@ 26,43 26,15 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include "action.h"
-static bool process_tapping(keyrecord_t *record);
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)
-{
- 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_PRESSED: debug("ACT_LAYER_PRESSED"); break;
- case ACT_LAYER_RELEASED: debug("ACT_LAYER_RELEASED"); break;
- case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); break;
- case ACT_LAYER_EXT: debug("ACT_LAYER_EXT"); 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_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);
/*
@@ 102,14 74,6 @@ static uint8_t waiting_buffer_head = 0;
/* point to the oldest data cell to deq */
static uint8_t waiting_buffer_tail = 0;
-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");
-}
static bool waiting_buffer_enq(keyrecord_t record)
{
if (IS_NOEVENT(record.event)) {
@@ 127,26 91,14 @@ static bool waiting_buffer_enq(keyrecord_t record)
debug("waiting_buffer_enq: "); debug_waiting_buffer();
return true;
}
-/*
-static keyrecord_t waiting_buffer_deq(void)
-{
- if (waiting_buffer_head == waiting_buffer_tail) {
- return (keyrecord_t){};
- }
- uint8_t last_tail = waiting_buffer_tail;
- waiting_buffer_tail = waiting_buffer_tail + 1 % WAITING_BUFFER_SIZE;
- return waiting_buffer[last_tail];
-}
-static bool waiting_buffer_is_empty(void)
-{
- return (waiting_buffer_head == waiting_buffer_tail);
-}
-*/
+
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) {
@@ 156,6 108,8 @@ static bool waiting_buffer_typed(keyevent_t event)
}
return false;
}
+#endif
+
static bool waiting_buffer_has_anykey_pressed(void)
{
for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
@@ 182,18 136,21 @@ static struct {
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;
@@ 219,6 176,7 @@ void action_exec(keyevent_t event)
// 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){};
@@ 229,6 187,7 @@ void action_exec(keyevent_t event)
if (!IS_NOEVENT(event) && waiting_buffer_head != waiting_buffer_tail) {
debug("---- action_exec: process waiting_buffer -----\n");
}
+
for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = ");
@@ 666,10 625,10 @@ static void process_action(keyrecord_t *record)
/* Tapping
*
- * Rule: Tap key is typed(pressed and released) within TAPPING_TERM
- * without interfaring by typing other key.
+ * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
+ * (without interfering by typing other key)
*/
-/* return true when key event is processed. */
+/* return true when key event is processed or consumed. */
static bool process_tapping(keyrecord_t *keyp)
{
keyevent_t event = keyp->event;
@@ 680,74 639,109 @@ static bool process_tapping(keyrecord_t *keyp)
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: First tap: tapping_key="); debug_record(tapping_key); debug("\n");
+ debug_tapping_key();
process_action(&tapping_key);
// enqueue
keyp->tap_count = tapping_key.tap_count;
return false;
- } else if (!event.pressed && waiting_buffer_typed(event)) {
+ }
+#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: tapping_key={}\n");
+ debug("Tapping: End. No tap. Interfered by typing key\n");
process_action(&tapping_key);
tapping_key = (keyrecord_t){};
+ debug_tapping_key();
// enqueue
return false;
- } else {
- // other key events shall be stored till tapping state settles.
+ }
+#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: tapping_key="); debug_record(*keyp); debug("\n");
+ process_action(keyp);
tapping_key = *keyp;
- return false;
+ debug_tapping_key();
+ return true;
}
else if (is_tap_key(keyp->event.key) && event.pressed) {
- debug("Tapping: Start with forcing to release last tap: tapping_key=");
- debug_record(*keyp); debug("\n");
-// TODO: need only when tap > 1?
- process_action(&(keyrecord_t){
- .tap_count = tapping_key.tap_count,
- .event.key = tapping_key.event.key,
- .event.time = event.time,
- .event.pressed = false
- });
+ 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,
+ .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;
- return false;
+ waiting_buffer_scan_tap();
+ debug_tapping_key();
+ return true;
}
else {
if (!IS_NOEVENT(keyp->event)) {
- debug("Tapping: key event while tap: tapping_key=");
- debug_record(tapping_key); debug("\n");
+ debug("Tapping: key event while last tap(>0).\n");
}
process_action(keyp);
return true;
}
}
}
- // not within TAPPING_TERM
+ // after TAPPING_TERM
else {
if (tapping_key.tap_count == 0) {
- // timeout. not tap.
- debug("Tapping: End. Not tap(time out): tapping_key={}: "); debug_record(*keyp); debug("\n");
+ 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. tap release.");
+ debug("Tapping: End. last timeout tap release(>0).");
keyp->tap_count = tapping_key.tap_count;
process_action(keyp);
tapping_key = (keyrecord_t){};
return true;
- } else {
- // other key after tap time out.
+ }
+ 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_count = tapping_key.tap_count,
+ .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;
}
@@ 758,14 752,17 @@ static bool process_tapping(keyrecord_t *keyp)
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");
+ 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");
@@ 774,16 771,21 @@ static bool process_tapping(keyrecord_t *keyp)
}
} else {
// timeout. no sequential tap.
- debug("Tapping: End(Time out after releasing last tap).\n");
+ debug("Tapping: End(Timeout after releasing last tap): ");
+ debug_event(event); debug("\n");
tapping_key = (keyrecord_t){};
+ debug_tapping_key();
process_action(keyp);
return true;
}
- } else {
+ }
+ // not tapping satate
+ else {
if (event.pressed && is_tap_key(event.key)) {
debug("Tapping: Start(Press tap key).\n");
tapping_key = *keyp;
- debug("tapping_key="); debug_record(*keyp); debug("\n");
+ waiting_buffer_scan_tap();
+ debug_tapping_key();
return true;
} else {
process_action(keyp);
@@ 792,6 794,29 @@ static bool process_tapping(keyrecord_t *keyp)
}
}
+/* scan buffer for tapping */
+static void waiting_buffer_scan_tap(void)
+{
+ // tapping already is settled
+ if (tapping_key.tap_count > 0) return;
+ // invalid state: tapping_key released && tap_count == 0
+ if (!tapping_key.event.pressed) return;
+
+ for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
+ if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
+ !waiting_buffer[i].event.pressed &&
+ WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
+ tapping_key.tap_count = 1;
+ waiting_buffer[i].tap_count = 1;
+ process_action(&tapping_key);
+
+ debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
+ debug_waiting_buffer();
+ return;
+ }
+ }
+}
+
/*
@@ 923,3 948,54 @@ bool is_tap_key(key_t key)
}
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_PRESSED: debug("ACT_LAYER_PRESSED"); break;
+ case ACT_LAYER_RELEASED: debug("ACT_LAYER_RELEASED"); break;
+ case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); break;
+ case ACT_LAYER_EXT: debug("ACT_LAYER_EXT"); 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");
+}