+/*
+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 "util.h"
#include "debug.h"
#include "action.h"
+#include "layer_switch.h"
+
+static void process_action(keyrecord_t *record);
+static bool process_tapping(keyrecord_t *record);
+static void waiting_buffer_scan_tap(void);
-static void process(keyrecord_t *record);
+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);
-// TODO
-/* layer */
-uint8_t default_layer = 0;
-uint8_t current_layer = 0;
-/* tap term(ms) */
-#define TAP_TERM 200
-/* number of tap which fires toggle feature */
-#define TAP_TOGGLE 5
+/*
+ * 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
-/* This counts up when tap occurs */
-uint8_t tap_count = 0;
-keyevent_t tapping_event = {};
-keyrecord_t tapping_key = {};
+/* stores a key event of current tap. */
+static keyrecord_t tapping_key = {};
-/* TAPPING: This indicates that whether tap or not is not decided yet. */
-// NOTE: keyevent_t.time 0 means no event.
-#define IS_TAPPING() (tapping_key.event.time != 0)
+#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_TAP_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < TAP_TERM)
+#define WITHIN_TAPPING_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < TAPPING_TERM)
-/* waiting keys buffer */
+
+/*
+ * 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;
return false;
}
- debug("waiting_buffer_enq["); debug_dec(waiting_buffer_head); debug("] = ");
- debug_hex16(record.event.key.raw); debug("\n");
-
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 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) {
}
return false;
}
-static bool waiting_buffer_has_anykey_pressed(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;
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;
}
-/*
- * Rule to judge tap:
- * Tap key is typed(pressed and released) within TAP_TERM
- * without interfaring by typing other key.
- */
-/* return true when key event is processed. */
-static bool process_tap(keyrecord_t *keyp)
-{
- keyevent_t event = keyp->event;
-
- // if tapping
- if (IS_TAPPING_PRESSED()) {
- if (WITHIN_TAP_TERM(event)) {
- if (tapping_key.tap_count == 0) {
- if (IS_TAPPING_KEY(event.key) && !event.pressed) {
- // first tap!
- debug("Tapping: First tap.\n");
- tapping_key.tap_count = 1;
- process(&tapping_key);
-
- // enqueue
- keyp->tap_count = tapping_key.tap_count;
- return false;
- } else if (!event.pressed && waiting_buffer_typed(event)) {
- // other key typed. not tap.
- debug("Tapping: End(No tap. Interfered by typing key).\n");
- process(&tapping_key);
- tapping_key = (keyrecord_t){};
-
- // enqueue
- return false;
- } else {
- // other key events shall be stored till tapping state settles.
- return false;
- }
- } else {
- if (IS_TAPPING_KEY(event.key) && !event.pressed) {
- keyp->tap_count = tapping_key.tap_count;
- debug("Tapping: tap release("); debug_dec(keyp->tap_count); debug(")\n");
- tapping_key = *keyp;
- return false;
- }
- else if (is_tap_key(keyp->event.key) && event.pressed) {
- debug("Tapping: Start with forcing to release last tap.\n");
- process(&(keyrecord_t){
- .tap_count = tapping_key.tap_count,
- .event.key = tapping_key.event.key,
- .event.time = event.time,
- .event.pressed = false
- });
- tapping_key = *keyp;
- return false;
- }
- else {
- if (!IS_NOEVENT(keyp->event)) debug("Tapping: key event while tap.\n");
- process(keyp);
- return true;
- }
- }
- }
- // not within TAP_TERM
- else {
- if (tapping_key.tap_count == 0) {
- // timeout. not tap.
- debug("Tapping: End. Not tap(time out).\n");
- process(&tapping_key);
- tapping_key = (keyrecord_t){};
- return false;
- } else {
- if (IS_TAPPING_KEY(event.key) && !event.pressed) {
- debug("Tapping: End. tap release.");
- keyp->tap_count = tapping_key.tap_count;
- process(keyp);
- tapping_key = (keyrecord_t){};
- return true;
- } else {
- // other key after tap time out.
- process(keyp);
- return true;
- }
- }
- }
- } else if (IS_TAPPING_RELEASED()) {
- if (WITHIN_TAP_TERM(event)) {
- 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");
- process(keyp);
- tapping_key = *keyp;
- 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;
- return true;
- } else {
- if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n");
- process(keyp);
- return true;
- }
- } else {
- // timeout. no sequential tap.
- debug("Tapping: End(Time out after releasing last tap).\n");
- tapping_key = (keyrecord_t){};
- process(keyp);
- return true;
- }
- } else {
- if (event.pressed && is_tap_key(event.key)) {
- debug("Tapping: Start(Press tap key).\n");
- tapping_key = *keyp;
- return true;
- } else {
- process(keyp);
- return true;
- }
- }
-}
void action_exec(keyevent_t event)
{
if (!IS_NOEVENT(event)) {
- debug("event: ");
- debug_hex16(event.time); debug(": ");
- debug_hex16(event.key.raw);
- debug("[");
- if (event.pressed) debug("down"); else debug("up");
- debug("]\n");
+ debug("\n---- action_exec: start -----\n");
+ debug("EVENT: "); debug_event(event); debug("\n");
}
keyrecord_t record = { .event = event };
// pre-process on tapping
- if (process_tap(&record)) {
- if (!IS_NOEVENT(record.event)) debug("processed.\n");
+ if (process_tapping(&record)) {
+ if (!IS_NOEVENT(record.event)) {
+ debug("processed: "); debug_record(record); debug("\n");
+ }
} else {
- if (!IS_NOEVENT(record.event)) debug("enqueued.\n");
// 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_tap(&waiting_buffer[waiting_buffer_tail])) {
+ if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = ");
- debug_hex16(waiting_buffer[waiting_buffer_tail].event.key.raw); debug("\n");
+ debug_record(waiting_buffer[waiting_buffer_tail]); debug("\n\n");
} else {
break;
}
}
+ if (!IS_NOEVENT(event)) {
+ debug("\n");
+ }
+}
+
+static action_t get_action(key_t key)
+{
+ action_t action;
+ action.code = ACTION_NO;
+
+ /* layer_switch */
+ action = layer_switch_get_action(key);
+ if (action.code != ACTION_TRANSPARENT) {
+ return action;
+ }
+
+ /* default layer */
+ //debug("get_aciton: default layer: "); debug_dec(default_layer); debug("\n");
+ action = action_for_key(default_layer, key);
+ return action;
}
-static void process(keyrecord_t *record)
+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 = keymap_get_action(current_layer, event.key.pos.row, event.key.pos.col);
- debug("action: "); debug_hex16(action.code);
- if (event.pressed) debug("[down]\n"); else debug("[up]\n");
+ action_t action = get_action(event.key);
+ debug("ACTION: "); debug_action(action); debug(" ");
+ layer_switch_debug(); debug("["); debug_dec(default_layer); debug("]\n");
switch (action.kind.id) {
/* Key and Mods */
debug("MODS_TAP: Oneshot: start\n");
oneshot_start(mods, event.time);
}
- else if (tap_count == 5) {
+ else if (tap_count == TAPPING_TOGGLE) {
debug("MODS_TAP: Oneshot: toggle\n");
oneshot_toggle();
}
} 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);
}
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 {
break;
/* Layer key */
- case ACT_LAYER_PRESSED:
- // layer action when pressed
+ case ACT_LAYER_SET:
switch (action.layer.code) {
- case 0x00:
+ case LAYER_MOMENTARY: /* momentary */
+ if (event.pressed) {
+ layer_switch_move(action.layer.val);
+ }
+ else {
+ // NOTE: This is needed by legacy keymap support
+ layer_switch_move(0);
+ }
+ break;
+ case LAYER_ON_PRESS:
if (event.pressed) {
- layer_switch(action.layer.opt);
+ layer_switch_move(action.layer.val);
+ }
+ break;
+ case LAYER_ON_RELEASE:
+ if (!event.pressed) {
+ layer_switch_move(action.layer.val);
}
break;
- case 0xF0:
- // tap toggle
+ case LAYER_ON_BOTH:
+ layer_switch_move(action.layer.val);
+ break;
+ case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
if (event.pressed) {
- if (tap_count < TAP_TOGGLE) {
- layer_switch(action.layer.opt);
+ if (tap_count < TAPPING_TOGGLE) {
+ layer_switch_move(action.layer.val);
}
} else {
- if (tap_count >= TAP_TOGGLE) {
+ if (tap_count >= TAPPING_TOGGLE) {
debug("LAYER_PRESSED: tap toggle.\n");
- layer_switch(action.layer.opt);
+ layer_switch_move(action.layer.val);
}
}
break;
- case 0xFF:
- // change default layer
+ case LAYER_SET_DEFAULT_ON_PRESS:
if (event.pressed) {
- default_layer = action.layer.opt;
- layer_switch(default_layer);
+ default_layer = action.layer.val;
+ layer_switch_move(0);
}
break;
+ case LAYER_SET_DEFAULT_ON_RELEASE:
+ if (!event.pressed) {
+ default_layer = action.layer.val;
+ layer_switch_move(0);
+ }
+ break;
+ case LAYER_SET_DEFAULT_ON_BOTH:
+ default_layer = action.layer.val;
+ layer_switch_move(0);
+ break;
default:
- // with tap key
+ /* tap key */
if (event.pressed) {
- if (tap_count > 0) {
- debug("LAYER_PRESSED: Tap: register_code\n");
- register_code(action.layer.code);
- } else {
- debug("LAYER_PRESSED: No tap: layer_switch\n");
- layer_switch(action.layer.opt);
- }
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_SET: Tap: register_code\n");
+ register_code(action.layer.code);
+ } else {
+ debug("LAYER_SET: No tap: layer_set(on press)\n");
+ layer_switch_move(action.layer.val);
+ }
} else {
- if (tap_count > 0) {
- debug("LAYER_PRESSED: Tap: unregister_code\n");
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_SET: Tap: unregister_code\n");
unregister_code(action.layer.code);
} else {
- debug("LAYER_PRESSED: No tap: NO ACTION\n");
+ // NOTE: This is needed by legacy keymap support
+ debug("LAYER_SET: No tap: return to default layer(on release)\n");
+ layer_switch_move(0);
}
}
break;
}
break;
- case ACT_LAYER_RELEASED:
+ case ACT_LAYER_BIT:
switch (action.layer.code) {
- case 0x00:
+ case LAYER_MOMENTARY: /* momentary */
+ if (event.pressed) {
+ layer_switch_move(layer_switch_get_layer() | action.layer.val);
+ } else {
+ layer_switch_move(layer_switch_get_layer() & ~action.layer.val);
+ }
+ break;
+ case LAYER_ON_PRESS:
+ if (event.pressed) {
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
+ }
+ break;
+ case LAYER_ON_RELEASE:
if (!event.pressed) {
- layer_switch(action.layer.opt);
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
}
break;
- case 0xF0:
- // tap toggle
+ case LAYER_ON_BOTH:
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
+ break;
+ case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
if (event.pressed) {
- if (tap_count >= TAP_TOGGLE) {
- debug("LAYER_RELEASED: tap toggle.\n");
- layer_switch(action.layer.opt);
+ if (tap_count < TAPPING_TOGGLE) {
+ debug("LAYER_BIT: tap toggle(press).\n");
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
}
} else {
- if (tap_count < TAP_TOGGLE) {
- layer_switch(action.layer.opt);
+ if (tap_count <= TAPPING_TOGGLE) {
+ debug("LAYER_BIT: tap toggle(release).\n");
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
}
}
break;
- case 0xFF:
- // change default layer
+ case LAYER_SET_DEFAULT_ON_PRESS:
+ if (event.pressed) {
+ default_layer = default_layer ^ action.layer.val;
+ layer_switch_move(default_layer);
+ }
+ break;
+ case LAYER_SET_DEFAULT_ON_RELEASE:
if (!event.pressed) {
- default_layer = action.layer.opt;
- layer_switch(default_layer);
+ default_layer = default_layer ^ action.layer.val;
+ layer_switch_move(default_layer);
}
break;
+ case LAYER_SET_DEFAULT_ON_BOTH:
+ default_layer = default_layer ^ action.layer.val;
+ layer_switch_move(default_layer);
+ break;
default:
- // with tap key
+ // tap key
if (event.pressed) {
- if (tap_count > 0) {
- debug("LAYER_RELEASED: Tap: register_code\n");
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_BIT: Tap: register_code\n");
register_code(action.layer.code);
- } else {
- debug("LAYER_RELEASED: No tap: NO ACTION\n");
- }
+ } else {
+ debug("LAYER_BIT: No tap: layer_bit(on press)\n");
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
+ }
} else {
- if (tap_count > 0) {
- debug("LAYER_RELEASED: Tap: unregister_code\n");
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_BIT: Tap: unregister_code\n");
unregister_code(action.layer.code);
} else {
- debug("LAYER_RELEASED: No tap: layer_switch\n");
- layer_switch(action.layer.opt);
+ debug("LAYER_BIT: No tap: layer_bit(on release)\n");
+ layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
}
}
break;
}
break;
- case ACT_LAYER_BIT:
+ case ACT_LAYER_SWITCH:
switch (action.layer.code) {
- case 0x00:
+ case LAYER_MOMENTARY: /* momentary */
if (event.pressed) {
- layer_switch(current_layer | action.layer.opt);
+ layer_switch_on(action.layer.val);
} else {
- layer_switch(current_layer & ~action.layer.opt);
+ layer_switch_off(action.layer.val);
}
break;
- case 0xF0:
- // tap toggle
+ case LAYER_ON_PRESS:
if (event.pressed) {
- if (tap_count < TAP_TOGGLE) {
- debug("LAYER_BIT: tap toggle(press).\n");
- layer_switch(current_layer | action.layer.opt);
- }
- } else {
- if (tap_count < TAP_TOGGLE) {
- debug("LAYER_BIT: tap toggle(release).\n");
- layer_switch(current_layer & ~action.layer.opt);
- } else {
- debug("LAYER_BIT: tap toggle.\n");
- layer_switch(current_layer | action.layer.opt);
- }
+ layer_switch_invert(action.layer.val);
+ }
+ break;
+ case LAYER_ON_RELEASE:
+ if (!event.pressed) {
+ layer_switch_invert(action.layer.val);
}
break;
- case 0xFF:
- // change default layer
+ case LAYER_ON_BOTH:
+ layer_switch_invert(action.layer.val);
+ break;
+ case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
if (event.pressed) {
- default_layer = current_layer | action.layer.opt;
- layer_switch(default_layer);
+ if (tap_count < TAPPING_TOGGLE) {
+ debug("LAYER_SWITCH: tap toggle(press).\n");
+ layer_switch_invert(action.layer.val);
+ }
} else {
- default_layer = current_layer & ~action.layer.opt;
- layer_switch(default_layer);
+ if (tap_count <= TAPPING_TOGGLE) {
+ debug("LAYER_SWITCH: tap toggle(release).\n");
+ layer_switch_invert(action.layer.val);
+ }
}
break;
default:
- // with tap key
+ // tap key
if (event.pressed) {
if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
- debug("LAYER_BIT: Tap: register_code\n");
+ debug("LAYER_SWITCH: 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.opt);
+ debug("LAYER_SWITCH: No tap: layer_switch on press\n");
+ layer_switch_invert(action.layer.val);
}
} else {
if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
- debug("LAYER_BIT: Tap: unregister_code\n");
+ debug("LAYER_SWITCH: 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.opt);
+ debug("LAYER_SWITCH: No tap: layer_switch on release\n");
+ layer_switch_invert(action.layer.val);
}
}
break;
}
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:
- // tap toggle
- if (event.pressed) {
- if (tap_count < TAP_TOGGLE) {
- layer_switch(default_layer);
- }
- } else {
- if (tap_count >= TAP_TOGGLE) {
- debug("LAYER_EXT_PRESSED: tap toggle.\n");
- layer_switch(default_layer);
- }
- }
- break;
- case 0xFF:
- // change default layer
- if (event.pressed) {
- default_layer = current_layer;
- layer_switch(default_layer);
- }
- break;
- default:
- // with tap key
- if (event.pressed) {
- if (tap_count > 0) {
- debug("LAYER_EXT_PRESSED: Tap: register_code\n");
- register_code(action.layer.code);
- } else {
- debug("LAYER_EXT_PRESSED: No tap: layer_switch\n");
- layer_switch(default_layer);
- }
- } else {
- if (tap_count > 0) {
- debug("LAYER_EXT_PRESSED: Tap: unregister_code\n");
- unregister_code(action.layer.code);
- } else {
- debug("LAYER_EXT_PRESSED: No tap: NO ACTION\n");
- }
- }
- break;
- }
- break;
- case 0x01:
- // set default layer when released
- switch (action.layer.code) {
- case 0x00:
- if (!event.pressed) {
- layer_switch(default_layer);
- }
- break;
- case 0xF0:
- // tap toggle
- if (event.pressed) {
- if (tap_count >= TAP_TOGGLE) {
- debug("LAYER_EXT_RELEASED: tap toggle.\n");
- layer_switch(default_layer);
- }
- } else {
- if (tap_count < TAP_TOGGLE) {
- layer_switch(default_layer);
- }
- }
- break;
- case 0xFF:
- // change default layer
- if (!event.pressed) {
- default_layer = current_layer;
- layer_switch(default_layer);
- }
- break;
- default:
- // with tap key
- if (event.pressed) {
- if (tap_count > 0) {
- debug("LAYER_EXT_RELEASED: Tap: register_code\n");
- register_code(action.layer.code);
- } else {
- debug("LAYER_EXT_RELEASED: No tap: NO ACTION\n");
- }
- } else {
- if (tap_count > 0) {
- debug("LAYER_EXT_RELEASED: Tap: unregister_code\n");
- unregister_code(action.layer.code);
- } else {
- debug("LAYER_EXT_RELEASED: No tap: layer_switch\n");
- layer_switch(default_layer);
- }
- }
- break;
- }
- break;
- }
- break;
/* Extentions */
case ACT_MACRO:
+ // TODO
break;
case ACT_COMMAND:
break;
case ACT_FUNCTION:
- action_call_function(event, action.func.id);
+ 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;
+
+ // 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);
+
+ // 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();
+
+ // 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;
+ 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_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;
+ 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_count = tapping_key.tap_count;
+ 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_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;
+ }
+ }
+ }
+ } 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_count = tapping_key.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;
+ }
+ }
+}
+
+
/*
* Utilities for actions.
host_last_sysytem_report() || host_last_consumer_report());
}
-void layer_switch(uint8_t new_layer)
-{
- if (current_layer != new_layer) {
- debug("Layer Switch: "); debug_hex(current_layer);
- debug(" -> "); debug_hex(new_layer); debug("\n");
-
- current_layer = new_layer;
- clear_keyboard_but_mods(); // To avoid stuck keys
- // TODO: update mods with full scan of matrix? if modifier changes between layers
- }
-}
-
bool is_tap_key(key_t key)
{
- action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
+ action_t action = get_action(key);
+
switch (action.kind.id) {
case ACT_LMODS_TAP:
case ACT_RMODS_TAP:
return true;
- case ACT_LAYER_PRESSED:
+ case ACT_LAYER_SET:
case ACT_LAYER_BIT:
switch (action.layer.code) {
- case 0x00:
- case 0xF1 ... 0xFF:
+ case LAYER_MOMENTARY:
+ case LAYER_ON_PRESS:
+ case LAYER_ON_RELEASE:
+ case LAYER_ON_BOTH:
+ case LAYER_SET_DEFAULT_ON_PRESS:
+ case LAYER_SET_DEFAULT_ON_RELEASE:
+ case LAYER_SET_DEFAULT_ON_BOTH:
return false;
- case 0xF0:
- default:
+ case LAYER_TAP_TOGGLE:
+ default: /* tap key */
return true;
}
return false;
case ACT_FUNCTION:
- if (action.func.opt & 0x1) {
- return true;
- }
+ 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);
+}
+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_SET: debug("ACT_LAYER_SET"); break;
+ case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); break;
+ case ACT_LAYER_SWITCH: debug("ACT_LAYER_SWITCH"); 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");
+}