+/*
+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 "action.h"
-static void process(keyevent_t event);
-static void register_code(uint8_t code);
-static void unregister_code(uint8_t code);
-static void add_mods(uint8_t mods);
-static void del_mods(uint8_t mods);
-static void set_mods(uint8_t mods);
-static void clear_keyboard(void);
-static void clear_keyboard_but_mods(void);
-static bool sending_anykey(void);
-static void layer_switch(uint8_t new_layer);
+/* default layer indicates base layer */
+uint8_t default_layer = 0;
+/* current layer indicates active layer at this time */
+uint8_t current_layer = 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);
-/* tap */
-#define TAP_TIME 200
-static keyevent_t last_event = {};
-static uint8_t tap_count = 0;
-/* layer */
-uint8_t default_layer = 0;
-uint8_t current_layer = 0;
+/*
+ * 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 = {};
-// time 0 means no event.
-#define IS_TAPPING (tapping_key.event.time != 0)
-/* TODO:
-#define IS_TAPPING_KEY(key) (tapping_key.event.time != 0 && KEYEQ(tapping_key.event.key, key))
+
+#define IS_TAPPING() !IS_NOEVENT(tapping_key.event)
+#define IS_TAPPING_PRESSED() (IS_TAPPING() && tapping_key.event.pressed)
+#define IS_TAPPING_RELEASED() (IS_TAPPING() && !tapping_key.event.pressed)
+#define IS_TAPPING_KEY(k) (IS_TAPPING() && KEYEQ(tapping_key.event.key, (k)))
+#define WITHIN_TAPPING_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < TAPPING_TERM)
+
+
+/*
+ * Waiting buffer
+ *
+ * stores key events waiting for settling current tap.
*/
+#define WAITING_BUFFER_SIZE 8
+static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {};
-/* waiting keys buffer */
-#define WAITING_KEYS_BUFFER 3
-static keyrecord_t waiting_keys[WAITING_KEYS_BUFFER] = {};
-// TODO: double buffer?
-static keyrecord_t waiting_keys0[WAITING_KEYS_BUFFER] = {};
-static keyrecord_t waiting_keys1[WAITING_KEYS_BUFFER] = {};
-static uint8_t waiting_keys_head = 0;
-static bool waiting_keys_enqueue(keyevent_t event)
-{
- debug("waiting_keys["); debug_dec(waiting_keys_head); debug("] = ");
- debug_hex16(event.key.raw); debug("\n");
- if (waiting_keys_head < WAITING_KEYS_BUFFER) {
- waiting_keys[waiting_keys_head++] = (keyrecord_t){ .event = event,
- .mods = host_get_mods() };
- } else {
+/* point to empty cell to enq */
+static uint8_t waiting_buffer_head = 0;
+
+/* point to the oldest data cell to deq */
+static uint8_t waiting_buffer_tail = 0;
+
+static bool waiting_buffer_enq(keyrecord_t record)
+{
+ if (IS_NOEVENT(record.event)) {
return true;
}
+
+ if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
+ debug("waiting_buffer_enq: Over flow.\n");
+ return false;
+ }
+
+ waiting_buffer[waiting_buffer_head] = record;
+ waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
+
+ debug("waiting_buffer_enq: "); debug_waiting_buffer();
+ return true;
+}
+
+static void waiting_buffer_clear(void)
+{
+ waiting_buffer_head = 0;
+ waiting_buffer_tail = 0;
+}
+
+#if TAPPING_TERM >= 500
+static bool waiting_buffer_typed(keyevent_t event)
+{
+ for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
+ if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed != waiting_buffer[i].event.pressed) {
+ return true;
+ }
+ }
+ return false;
+}
+#endif
+
+bool waiting_buffer_has_anykey_pressed(void)
+{
+ for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
+ if (waiting_buffer[i].event.pressed) return true;
+ }
+ return false;
+}
+
+
+/* Oneshot modifier
+ *
+ * Problem: Want to capitalize like 'The' but the result tends to be 'THe'.
+ * Solution: Oneshot modifier have its effect on only one key coming next.
+ * Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key.
+ *
+ * Hold: works as normal modifier.
+ * Tap: one shot modifier.
+ * 2 Tap: cancel one shot modifier.
+ * 5-Tap: toggles enable/disable oneshot feature.
+ */
+static struct {
+ uint8_t mods;
+ uint8_t time;
+ bool ready;
+ bool disabled;
+} oneshot_state;
+
+static void oneshot_start(uint8_t mods, uint16_t time)
+{
+ oneshot_state.mods = mods;
+ oneshot_state.time = time;
+ oneshot_state.ready = true;
+}
+
+static void oneshot_cancel(void)
+{
+ oneshot_state.mods = 0;
+ oneshot_state.time = 0;
+ oneshot_state.ready = false;
+}
+
+static void oneshot_toggle(void)
+{
+ oneshot_state.disabled = !oneshot_state.disabled;
+}
+
+
+/*
+ * Layer stack
+ */
+#define LAYER_STACK_SIZE 8
+typedef struct {
+ uint8_t layer:4;
+ uint8_t next:3;
+ bool used;
+} layer_item_t;
+
+static uint8_t top_layer = 0;
+// [0] is sentinel and not used. [0] is null item.
+static layer_item_t layer_stack[LAYER_STACK_SIZE] = {};
+
+static bool layer_push(uint8_t layer)
+{
+ for (uint8_t i = 1; i < LAYER_STACK_SIZE; i++) {
+ if (!layer_stack[i].used) {
+ layer_stack[i] = (layer_item_t){ .layer = layer,
+ .next = top_layer,
+ .used = true };
+ top_layer = i;
+ return true;
+ }
+ }
+ return false;
}
-static void waiting_keys_clear(void)
+static bool layer_pop(void)
{
- waiting_keys_head = 0;
+ if (layer_stack[top_layer].used) {
+ uint8_t popped = top_layer;
+ top_layer = layer_stack[popped].next;
+ layer_stack[popped] = (layer_item_t){};
+ return true;
+ }
+ return false;
}
-static bool waiting_keys_has(key_t key)
+static bool layer_remove(uint8_t layer)
{
- for (uint8_t i = 0; i < waiting_keys_head; i++) {
- if KEYEQ(key, waiting_keys[i].event.key) return true;
+ if (layer_stack[top_layer].used && layer_stack[top_layer].layer == layer) {
+ layer_pop();
+ debug("layer_remove: top_layer\n");
+ return true;
+ }
+
+ for (uint8_t i = top_layer; layer_stack[i].used; i = layer_stack[i].next) {
+ debug("layer_remove: ["); debug_dec(i); debug("]");
+ debug_dec(layer_stack[i].layer); debug("\n");
+ uint8_t removed = layer_stack[i].next;
+ if (layer_stack[removed].used && layer_stack[removed].layer == layer) {
+ layer_stack[i].next = layer_stack[removed].next;
+ layer_stack[removed] = (layer_item_t){};
+ debug("layer_remove: removed.\n");
+ return true;
+ }
}
return false;
}
-static void waiting_keys_process_in_current_layer(void)
+static bool layer_remove_then_push(uint8_t layer)
{
- // TODO: in case of including layer key in waiting keys
- for (uint8_t i = 0; i < waiting_keys_head; i++) {
- debug("waiting_keys_process_in_current_layer["); debug_dec(i); debug("]\n");
- process(waiting_keys[i].event);
+ layer_remove(layer);
+ return layer_push(layer);
+}
+static bool layer_remove_or_push(uint8_t layer)
+{
+ return (layer_remove(layer)) || layer_push(layer);
+}
+static void debug_layer_stack(void)
+{
+ debug("layer_stack: ");
+ layer_item_t item = layer_stack[top_layer];
+ while (item.used) {
+ debug_dec(item.layer);
+ debug("["); debug_dec(item.next); debug("]");
+ item = layer_stack[item.next];
}
- waiting_keys_clear();
+ debug("\n");
}
void action_exec(keyevent_t event)
{
if (!IS_NOEVENT(event)) {
- debug("event: "); 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");
}
- if (IS_TAPPING) {
- /* when tap time elapses or waiting key is released */
- if ((timer_elapsed(tapping_key.event.time) > TAP_TIME) ||
- (!event.pressed && waiting_keys_has(event.key))) {
-
- // TODO process tapping_key: layer swich, modifier, ...
- // action is needed?
- debug("notap: process tapping_key.\n");
- process(tapping_key.event);
-
- /* Process waiting keys in new layer */
- waiting_keys_process_in_current_layer();
+
+ 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");
}
- /* when tapping key is released within tap time */
- else if (!event.pressed && KEYEQ(event.key, tapping_key.event.key)) {
- /* tap key down */
- debug("tap("); debug_hex8(tap_count); debug(")[tapping_key](register): "); debug_hex8(tapping_key.action.layer.code); debug("\n");
- register_code(tapping_key.action.layer.code);
+ } else {
+ // enqueue
+ if (!waiting_buffer_enq(record)) {
+ // clear all in case of overflow.
+ debug("OVERFLOW: CLEAR ALL STATES\n");
+ clear_keyboard();
+ waiting_buffer_clear();
tapping_key = (keyrecord_t){};
-
- /* process waiting keys */
- waiting_keys_process_in_current_layer();
}
}
- // not real event. event just to handle time out of tapping key.
- if (IS_NOEVENT(event)) {
- return;
+ // process waiting_buffer
+ if (!IS_NOEVENT(event) && waiting_buffer_head != waiting_buffer_tail) {
+ debug("---- action_exec: process waiting_buffer -----\n");
}
- /* count up tap when key is up */
- // key: d u d u d
- // tap: 0 1 1 2 2
- // key: u d u d u
- // tap: 0 0 1 1 2
- if (KEYEQ(event.key, last_event.key) && timer_elapsed(last_event.time) <= TAP_TIME) {
- if (!event.pressed) tap_count++;
- } else {
- tap_count = 0;
+ for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
+ if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
+ debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = ");
+ debug_record(waiting_buffer[waiting_buffer_tail]); debug("\n\n");
+ } else {
+ break;
+ }
}
+ if (!IS_NOEVENT(event)) {
+ debug("\n");
+ }
+}
- /* store key events while tapping */
- if (IS_TAPPING) {
- // TODO: action is needed?
- waiting_keys_enqueue(event);
- } else {
- process(event);
+static action_t get_action(key_t key)
+{
+ action_t action;
+ action.code = ACTION_NO;
+
+ /* layer stack */
+ for (layer_item_t i = layer_stack[top_layer]; i.used; i = layer_stack[i.next]) {
+ action = action_for_key(i.layer, key);
+ if (action.code != ACTION_TRANSPARENT) {
+ debug_layer_stack();
+ debug("layer_stack: used. "); debug_dec(i.layer); debug("\n");
+ return action;
+ }
+ debug("layer_stack: through. "); debug_dec(i.layer); debug("\n");
}
- /* last event */
- last_event = event;
-}
+ /* current layer: 0 means default layer */
+ if (current_layer) {
+ action = action_for_key(current_layer, key);
+ if (action.code != ACTION_TRANSPARENT) {
+ debug("current layer: used. "); debug_dec(current_layer); debug("\n");
+ return action;
+ }
+ }
+ /* default layer */
+ debug("default layer: used. \n");
+ action = action_for_key(default_layer, key);
+ return action;
+}
-static void process(keyevent_t event)
+static void process_action(keyrecord_t *record)
{
- 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");
+ keyevent_t event = record->event;
+ uint8_t tap_count = record->tap_count;
+
+ if (IS_NOEVENT(event)) { return; }
+
+ action_t action = get_action(event.key);
+ debug("ACTION: "); debug_action(action); debug("\n");
switch (action.kind.id) {
/* Key and Mods */
case ACT_LMODS:
- // |pressed |released
- // --------------+---------------------------------+------------
- // key |down(key) |up(key)
- // mods |add(mods) |del(mods)
- // key with mods |add(mods), down(key), unset(mods)|up(key)
- if (event.pressed) {
- uint8_t tmp_mods = host_get_mods();
- if (action.key.mods) {
- host_add_mods(action.key.mods);
- host_send_keyboard_report();
- }
- register_code(action.key.code);
- if (action.key.mods && action.key.code) {
- host_set_mods(tmp_mods);
- host_send_keyboard_report();
- }
- } else {
- if (action.key.mods && !action.key.code) {
- host_del_mods(action.key.mods);
- host_send_keyboard_report();
- }
- unregister_code(action.key.code);
- }
- break;
case ACT_RMODS:
- // |pressed |released
- // --------------+---------------------------------+------------
- // key |down(key) |up(key)
- // mods |add(mods) |del(mods)
- // key with mods |add(mods), down(key), unset(mods)|up(key)
- if (event.pressed) {
- uint8_t tmp_mods = host_get_mods();
- if (action.key.mods) {
- host_add_mods(action.key.mods<<4);
- host_send_keyboard_report();
- }
- register_code(action.key.code);
- if (action.key.mods && action.key.code) {
- host_set_mods(tmp_mods);
- host_send_keyboard_report();
- }
- } else {
- if (action.key.mods && !action.key.code) {
- host_del_mods(action.key.mods<<4);
- host_send_keyboard_report();
- }
- unregister_code(action.key.code);
- }
- break;
- case ACT_LMODS_TAP:
- if (event.pressed) {
- if (tap_count == 0) {
- if (host_has_anykey()) {
- // This key is a modifier essentially.
- // Prioritize mods when key jam or rollover
- add_mods(action.key.mods);
- } else {
- if (IS_TAPPING && KEYEQ(tapping_key.event.key, event.key)) {
- // no tapping
- add_mods(action.key.mods);
- tapping_key = (keyrecord_t){};
- } else {
- debug("tapping lmods("); debug_hex8(action.key.mods); debug(")\n");
- tapping_key = (keyrecord_t){
- .event = event,
- .action = action,
- .mods = host_get_mods()
- };
- }
+ {
+ 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();
}
- } else {
- // pressed after tapping
- debug("tap("); debug_hex(tap_count); debug(")[lmods](register): "); debug_hex8(action.key.code); debug("\n");
register_code(action.key.code);
- }
- } else {
- if (tap_count == 0) {
- debug("tap(00)[lmods](del_mods): "); debug_hex8(action.key.mods); debug("\n");
- del_mods(action.key.mods);
- } else if (tap_count == 1) {
- debug("tap(01)[lmods](del_mods/unregister): "); debug_hex8(action.key.mods); debug(" "); debug_hex8(action.key.code); debug("\n");
- del_mods(action.key.mods);
- unregister_code(action.key.code);
+ if (mods && action.key.code) {
+ host_set_mods(tmp_mods);
+ host_send_keyboard_report();
+ }
} else {
- debug("tap("); debug_hex(tap_count); debug(")[lmods](unregister): "); debug_hex8(action.key.code); debug("\n");
+ if (mods && !action.key.code) {
+ host_del_mods(mods);
+ host_send_keyboard_report();
+ }
unregister_code(action.key.code);
}
}
break;
+ case ACT_LMODS_TAP:
case ACT_RMODS_TAP:
- if (event.pressed) {
- if (tap_count == 0) {
- if (host_has_anykey()) {
- // This key is a modifier essentially.
- // Prioritize mods when key jam or rollover
- add_mods(action.key.mods<<4);
- } else {
- if (IS_TAPPING && KEYEQ(tapping_key.event.key, event.key)) {
- // no tapping
- add_mods(action.key.mods<<4);
- tapping_key = (keyrecord_t){};
+ {
+ 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 {
- debug("tapping rmods("); debug_hex8(action.key.mods); debug(")\n");
- tapping_key = (keyrecord_t){
- .event = event,
- .action = action,
- .mods = host_get_mods()
- };
+ 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);
+ }
}
- }
- } else {
- // pressed after tapping
- debug("tap("); debug_hex(tap_count); debug(")[rmods](register): "); debug_hex8(action.key.code); debug("\n");
- register_code(action.key.code);
- }
- } else {
- if (tap_count == 0) {
- debug("tap(00)[rmods](del_mods): "); debug_hex8(action.key.mods); debug("\n");
- del_mods(action.key.mods<<4);
- } else if (tap_count == 1) {
- debug("tap(01)[rmods](del_mods/unregister): "); debug_hex8(action.key.mods); debug(" "); debug_hex8(action.key.code); debug("\n");
- del_mods(action.key.mods<<4);
- unregister_code(action.key.code);
- } else {
- debug("tap("); debug_hex(tap_count); debug(")[rmods](unregister): "); debug_hex8(action.key.code); debug("\n");
- unregister_code(action.key.code);
+ 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;
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:
switch (action.layer.code) {
- case 0x00:
+ case LAYER_MOMENTARY: /* momentary */
if (event.pressed) {
- layer_switch(action.layer.opt);
+ layer_switch(action.layer.val);
+ }
+ else {
+ // NOTE: This is needed by legacy keymap support
+ layer_switch(0);
}
break;
- case 0xF0:
- // TODO: tap toggle
+ 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 0xFF:
+ case LAYER_ON_BOTH:
+ layer_switch(action.layer.val);
+ break;
+ case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
+ if (event.pressed) {
+ if (tap_count < TAPPING_TOGGLE) {
+ layer_switch(action.layer.val);
+ }
+ } else {
+ if (tap_count >= TAPPING_TOGGLE) {
+ debug("LAYER_PRESSED: tap toggle.\n");
+ layer_switch(action.layer.val);
+ }
+ }
+ break;
+ 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(0);
+ }
+ break;
+ case LAYER_SET_DEFAULT_ON_RELEASE:
+ if (!event.pressed) {
+ default_layer = action.layer.val;
+ layer_switch(0);
}
break;
+ case LAYER_SET_DEFAULT_ON_BOTH:
+ default_layer = action.layer.val;
+ layer_switch(0);
+ break;
default:
- // with tap key
+ /* tap key */
if (event.pressed) {
- if (tap_count == 0) {
- if (host_has_anykey()) {
- // This key is a normal key than a leyar key essentially.
- // Prioritize 'tap key' when key jam or rollover
- register_code(action.layer.code);
- } else {
- if (IS_TAPPING && KEYEQ(tapping_key.event.key, event.key)) {
- layer_switch(action.layer.opt);
- tapping_key = (keyrecord_t){};
- } else {
- debug("tapping layer("); debug_hex8(action.layer.opt); debug(")\n");
- tapping_key = (keyrecord_t){
- .event = event,
- .action = action,
- .mods = host_get_mods()
- };
- }
- }
- } else if (tap_count > 0) {
- // pressed after tapping
- debug("tap[layer](register): "); debug_hex(tap_count); debug("\n");
- register_code(action.layer.code);
+ 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(action.layer.val);
}
} else {
- // released after tapping
- debug("tap[layer](unregister): "); debug_hex(tap_count); debug("\n");
- unregister_code(action.layer.code);
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_SET: Tap: unregister_code\n");
+ unregister_code(action.layer.code);
+ } else {
+ // NOTE: This is needed by legacy keymap support
+ debug("LAYER_SET: No tap: return to default layer(on release)\n");
+ layer_switch(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(current_layer | action.layer.val);
+ } else {
+ layer_switch(current_layer & ~action.layer.val);
+ }
+ break;
+ case LAYER_ON_PRESS:
+ if (event.pressed) {
+ layer_switch(current_layer ^ action.layer.val);
+ }
+ break;
+ case LAYER_ON_RELEASE:
if (!event.pressed) {
- layer_switch(action.layer.opt);
+ layer_switch(current_layer ^ action.layer.val);
}
break;
- case 0xF0:
- // Ignored. LAYER_RELEASED with tap toggle is invalid action.
+ case LAYER_ON_BOTH:
+ layer_switch(current_layer ^ action.layer.val);
break;
- case 0xFF:
+ case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
+ if (event.pressed) {
+ if (tap_count < TAPPING_TOGGLE) {
+ debug("LAYER_BIT: tap toggle(press).\n");
+ layer_switch(current_layer ^ action.layer.val);
+ }
+ } else {
+ if (tap_count <= TAPPING_TOGGLE) {
+ debug("LAYER_BIT: tap toggle(release).\n");
+ layer_switch(current_layer ^ action.layer.val);
+ }
+ }
+ break;
+ case LAYER_SET_DEFAULT_ON_PRESS:
+ if (event.pressed) {
+ default_layer = default_layer ^ action.layer.val;
+ layer_switch(0);
+ }
+ 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(0);
}
break;
+ case LAYER_SET_DEFAULT_ON_BOTH:
+ default_layer = default_layer ^ action.layer.val;
+ layer_switch(0);
+ break;
default:
- // Ignored. LAYER_RELEASED with tap key is invalid action.
+ // tap key
+ if (event.pressed) {
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_BIT: Tap: register_code\n");
+ register_code(action.layer.code);
+ } else {
+ debug("LAYER_BIT: No tap: layer_bit(on press)\n");
+ layer_switch(current_layer ^ action.layer.val);
+ }
+ } else {
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_BIT: Tap: unregister_code\n");
+ unregister_code(action.layer.code);
+ } else {
+ debug("LAYER_BIT: No tap: layer_bit(on release)\n");
+ layer_switch(current_layer ^ action.layer.val);
+ }
+ }
break;
}
break;
- case ACT_LAYER_BIT:
+ case ACT_LAYER_STACK:
switch (action.layer.code) {
- case 0x00:
+ case LAYER_MOMENTARY: /* momentary */
if (event.pressed) {
- layer_switch(current_layer | action.layer.opt);
+ layer_remove_then_push(action.layer.val);
+ debug_layer_stack();
} else {
- layer_switch(current_layer & ~action.layer.opt);
+ layer_remove(action.layer.val);
+ debug_layer_stack();
}
break;
- case 0xF0:
- // TODO: tap toggle
+ case LAYER_ON_PRESS:
+ if (event.pressed) {
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
+ }
break;
- case 0xFF:
- // change default layer
+ case LAYER_ON_RELEASE:
+ if (!event.pressed) {
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
+ }
+ break;
+ case LAYER_ON_BOTH:
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
+ 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_STACK: tap toggle(press).\n");
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
+ }
} else {
- default_layer = current_layer & ~action.layer.opt;
- layer_switch(default_layer);
+ if (tap_count <= TAPPING_TOGGLE) {
+ debug("LAYER_STACK: tap toggle(release).\n");
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
+ }
}
break;
default:
- // TODO: see ACT_LAYER_PRESSED code
- // with tap key
+ // tap key
if (event.pressed) {
- if (tap_count == 0) {
- if (host_has_anykey()) {
- register_code(action.layer.code);
- } else {
- tapping_key = (keyrecord_t){
- .event = event,
- .action = action,
- .mods = keyboard_report->mods
- };
- }
- } else if (tap_count > 0) {
- debug("tap[layer_bit](register): "); debug_hex(tap_count); debug("\n");
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_STACK: Tap: register_code\n");
register_code(action.layer.code);
+ } else {
+ debug("LAYER_STACK: No tap: layer_stack(on press)\n");
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
}
} 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);
+ if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+ debug("LAYER_STACK: Tap: unregister_code\n");
+ unregister_code(action.layer.code);
+ } else {
+ debug("LAYER_STACK: No tap: layer_stack(on release)\n");
+ layer_remove_or_push(action.layer.val);
+ debug_layer_stack();
}
- unregister_code(action.layer.code);
- }
- 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;
- }
- 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;
}
break;
}
/* Extentions */
case ACT_MACRO:
+ // TODO
+ break;
case ACT_COMMAND:
+ break;
case ACT_FUNCTION:
+ action_function(record, action.func.id, action.func.opt);
+ break;
default:
break;
}
}
-static void register_code(uint8_t code)
+/* 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.
+ */
+void register_code(uint8_t code)
{
if (code == KC_NO) {
return;
}
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) {
host_del_key(code);
}
}
-static void add_mods(uint8_t mods)
+void add_mods(uint8_t mods)
{
if (mods) {
host_add_mods(mods);
}
}
-static void del_mods(uint8_t mods)
+void del_mods(uint8_t mods)
{
if (mods) {
host_del_mods(mods);
}
}
-static void set_mods(uint8_t mods)
+void set_mods(uint8_t 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 bool sending_anykey(void)
+bool sending_anykey(void)
{
return (host_has_anykey() || host_mouse_in_use() ||
host_last_sysytem_report() || host_last_consumer_report());
}
-static void layer_switch(uint8_t new_layer)
+void layer_switch(uint8_t new_layer)
{
if (current_layer != new_layer) {
debug("Layer Switch: "); debug_hex(current_layer);
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
+ // NOTE: update mods with full scan of matrix? if modifier changes between layers
+ }
+}
+
+bool is_tap_key(key_t key)
+{
+ action_t action = get_action(key);
+
+ 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 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 LAYER_TAP_TOGGLE:
+ default: /* tap key */
+ return true;
+ }
+ return false;
+ 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);
+}
+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_LAYER_STACK: debug("ACT_LAYER_STACK"); 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