2 Copyright 2012,2013 Jun Wako <wakojun@gmail.com>
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 static void process_action(keyrecord_t *record);
30 static bool process_tapping(keyrecord_t *record);
31 static void waiting_buffer_scan_tap(void);
33 static void debug_event(keyevent_t event);
34 static void debug_record(keyrecord_t record);
35 static void debug_action(action_t action);
36 static void debug_tapping_key(void);
37 static void debug_waiting_buffer(void);
43 /* period of tapping(ms) */
45 #define TAPPING_TERM 200
48 /* tap count needed for toggling a feature */
49 #ifndef TAPPING_TOGGLE
50 #define TAPPING_TOGGLE 5
53 /* stores a key event of current tap. */
54 static keyrecord_t tapping_key = {};
56 #define IS_TAPPING() !IS_NOEVENT(tapping_key.event)
57 #define IS_TAPPING_PRESSED() (IS_TAPPING() && tapping_key.event.pressed)
58 #define IS_TAPPING_RELEASED() (IS_TAPPING() && !tapping_key.event.pressed)
59 #define IS_TAPPING_KEY(k) (IS_TAPPING() && KEYEQ(tapping_key.event.key, (k)))
60 #define WITHIN_TAPPING_TERM(e) (TIMER_DIFF_16(e.time, tapping_key.event.time) < TAPPING_TERM)
66 * stores key events waiting for settling current tap.
68 #define WAITING_BUFFER_SIZE 8
69 static keyrecord_t waiting_buffer[WAITING_BUFFER_SIZE] = {};
71 /* point to empty cell to enq */
72 static uint8_t waiting_buffer_head = 0;
74 /* point to the oldest data cell to deq */
75 static uint8_t waiting_buffer_tail = 0;
77 static bool waiting_buffer_enq(keyrecord_t record)
79 if (IS_NOEVENT(record.event)) {
83 if ((waiting_buffer_head + 1) % WAITING_BUFFER_SIZE == waiting_buffer_tail) {
84 debug("waiting_buffer_enq: Over flow.\n");
88 waiting_buffer[waiting_buffer_head] = record;
89 waiting_buffer_head = (waiting_buffer_head + 1) % WAITING_BUFFER_SIZE;
91 debug("waiting_buffer_enq: "); debug_waiting_buffer();
95 static void waiting_buffer_clear(void)
97 waiting_buffer_head = 0;
98 waiting_buffer_tail = 0;
101 #if TAPPING_TERM >= 500
102 static bool waiting_buffer_typed(keyevent_t event)
104 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
105 if (KEYEQ(event.key, waiting_buffer[i].event.key) && event.pressed != waiting_buffer[i].event.pressed) {
113 static bool waiting_buffer_has_anykey_pressed(void)
115 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
116 if (waiting_buffer[i].event.pressed) return true;
124 * Problem: Want to capitalize like 'The' but the result tends to be 'THe'.
125 * Solution: Oneshot modifier have its effect on only one key coming next.
126 * Tap Shift, then type 't', 'h' and 'e'. Not need to hold Shift key.
128 * Hold: works as normal modifier.
129 * Tap: one shot modifier.
130 * 2 Tap: cancel one shot modifier.
131 * 5-Tap: toggles enable/disable oneshot feature.
140 static void oneshot_start(uint8_t mods, uint16_t time)
142 oneshot_state.mods = mods;
143 oneshot_state.time = time;
144 oneshot_state.ready = true;
147 static void oneshot_cancel(void)
149 oneshot_state.mods = 0;
150 oneshot_state.time = 0;
151 oneshot_state.ready = false;
154 static void oneshot_toggle(void)
156 oneshot_state.disabled = !oneshot_state.disabled;
161 void action_exec(keyevent_t event)
163 if (!IS_NOEVENT(event)) {
164 debug("\n---- action_exec: start -----\n");
165 debug("EVENT: "); debug_event(event); debug("\n");
168 keyrecord_t record = { .event = event };
170 // pre-process on tapping
171 if (process_tapping(&record)) {
172 if (!IS_NOEVENT(record.event)) {
173 debug("processed: "); debug_record(record); debug("\n");
177 if (!waiting_buffer_enq(record)) {
178 // clear all in case of overflow.
179 debug("OVERFLOW: CLEAR ALL STATES\n");
181 waiting_buffer_clear();
182 tapping_key = (keyrecord_t){};
186 // process waiting_buffer
187 if (!IS_NOEVENT(event) && waiting_buffer_head != waiting_buffer_tail) {
188 debug("---- action_exec: process waiting_buffer -----\n");
191 for (; waiting_buffer_tail != waiting_buffer_head; waiting_buffer_tail = (waiting_buffer_tail + 1) % WAITING_BUFFER_SIZE) {
192 if (process_tapping(&waiting_buffer[waiting_buffer_tail])) {
193 debug("processed: waiting_buffer["); debug_dec(waiting_buffer_tail); debug("] = ");
194 debug_record(waiting_buffer[waiting_buffer_tail]); debug("\n\n");
199 if (!IS_NOEVENT(event)) {
204 static void process_action(keyrecord_t *record)
206 keyevent_t event = record->event;
207 uint8_t tap_count = record->tap_count;
209 if (IS_NOEVENT(event)) { return; }
211 action_t action = keymap_get_action(current_layer, event.key.pos.row, event.key.pos.col);
212 //debug("action: "); debug_hex16(action.code); if (event.pressed) debug("d\n"); else debug("u\n");
213 debug("ACTION: "); debug_action(action); debug("\n");
215 switch (action.kind.id) {
220 uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
223 uint8_t tmp_mods = host_get_mods();
226 host_send_keyboard_report();
228 register_code(action.key.code);
229 if (mods && action.key.code) {
230 host_set_mods(tmp_mods);
231 host_send_keyboard_report();
234 if (mods && !action.key.code) {
236 host_send_keyboard_report();
238 unregister_code(action.key.code);
245 uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
247 switch (action.layer.code) {
251 if (tap_count == 0) {
252 debug("MODS_TAP: Oneshot: add_mods\n");
255 else if (tap_count == 1) {
256 debug("MODS_TAP: Oneshot: start\n");
257 oneshot_start(mods, event.time);
259 else if (tap_count == 5) {
260 debug("MODS_TAP: Oneshot: toggle\n");
264 debug("MODS_TAP: Oneshot: cancel&add_mods\n");
265 // double tap cancels oneshot and works as normal modifier.
270 if (tap_count == 0) {
271 debug("MODS_TAP: Oneshot: cancel/del_mods\n");
272 // cancel oneshot by holding.
276 else if (tap_count == 1) {
277 debug("MODS_TAP: Oneshot: del_mods\n");
282 debug("MODS_TAP: Oneshot: del_mods\n");
291 if (waiting_buffer_has_anykey_pressed()) {
292 debug("MODS_TAP: Tap: Cancel: add_mods\n");
293 // ad hoc: set 0 to cancel tap
294 record->tap_count = 0;
297 debug("MODS_TAP: Tap: register_code\n");
298 register_code(action.key.code);
301 debug("MODS_TAP: No tap: add_mods\n");
306 debug("MODS_TAP: Tap: unregister_code\n");
307 unregister_code(action.key.code);
309 debug("MODS_TAP: No tap: add_mods\n");
318 /* other HID usage */
320 #ifdef EXTRAKEY_ENABLE
321 switch (action.usage.page) {
322 case ACTION_USAGE_PAGE_SYSTEM:
324 host_system_send(action.usage.code);
329 case ACTION_USAGE_PAGE_CONSUMER:
331 host_consumer_send(action.usage.code);
333 host_consumer_send(0);
342 #ifdef MOUSEKEY_ENABLE
344 mousekey_on(action.key.code);
347 mousekey_off(action.key.code);
354 case ACT_LAYER_PRESSED:
355 // layer action when pressed
356 switch (action.layer.code) {
359 layer_switch(action.layer.opt);
365 if (tap_count < TAPPING_TOGGLE) {
366 layer_switch(action.layer.opt);
369 if (tap_count >= TAPPING_TOGGLE) {
370 debug("LAYER_PRESSED: tap toggle.\n");
371 layer_switch(action.layer.opt);
376 // change default layer
378 default_layer = action.layer.opt;
379 layer_switch(default_layer);
386 debug("LAYER_PRESSED: Tap: register_code\n");
387 register_code(action.layer.code);
389 debug("LAYER_PRESSED: No tap: layer_switch\n");
390 layer_switch(action.layer.opt);
394 debug("LAYER_PRESSED: Tap: unregister_code\n");
395 unregister_code(action.layer.code);
397 debug("LAYER_PRESSED: No tap: NO ACTION\n");
403 case ACT_LAYER_RELEASED:
404 switch (action.layer.code) {
406 if (!event.pressed) {
407 layer_switch(action.layer.opt);
413 if (tap_count >= TAPPING_TOGGLE) {
414 debug("LAYER_RELEASED: tap toggle.\n");
415 layer_switch(action.layer.opt);
418 if (tap_count < TAPPING_TOGGLE) {
419 layer_switch(action.layer.opt);
424 // change default layer
425 if (!event.pressed) {
426 default_layer = action.layer.opt;
427 layer_switch(default_layer);
434 debug("LAYER_RELEASED: Tap: register_code\n");
435 register_code(action.layer.code);
437 debug("LAYER_RELEASED: No tap: NO ACTION\n");
441 debug("LAYER_RELEASED: Tap: unregister_code\n");
442 unregister_code(action.layer.code);
444 debug("LAYER_RELEASED: No tap: layer_switch\n");
445 layer_switch(action.layer.opt);
452 switch (action.layer.code) {
455 layer_switch(current_layer | action.layer.opt);
457 layer_switch(current_layer & ~action.layer.opt);
463 if (tap_count < TAPPING_TOGGLE) {
464 debug("LAYER_BIT: tap toggle(press).\n");
465 layer_switch(current_layer | action.layer.opt);
468 if (tap_count < TAPPING_TOGGLE) {
469 debug("LAYER_BIT: tap toggle(release).\n");
470 layer_switch(current_layer & ~action.layer.opt);
472 debug("LAYER_BIT: tap toggle.\n");
473 layer_switch(current_layer | action.layer.opt);
478 // change default layer
480 default_layer = current_layer | action.layer.opt;
481 layer_switch(default_layer);
483 default_layer = current_layer & ~action.layer.opt;
484 layer_switch(default_layer);
490 if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
491 debug("LAYER_BIT: Tap: register_code\n");
492 register_code(action.layer.code);
494 debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
495 layer_switch(current_layer | action.layer.opt);
498 if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
499 debug("LAYER_BIT: Tap: unregister_code\n");
500 unregister_code(action.layer.code);
502 debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
503 layer_switch(current_layer & ~action.layer.opt);
510 switch (action.layer.opt) {
512 // set default layer when pressed
513 switch (action.layer.code) {
516 layer_switch(default_layer);
522 if (tap_count < TAPPING_TOGGLE) {
523 layer_switch(default_layer);
526 if (tap_count >= TAPPING_TOGGLE) {
527 debug("LAYER_EXT_PRESSED: tap toggle.\n");
528 layer_switch(default_layer);
533 // change default layer
535 default_layer = current_layer;
536 layer_switch(default_layer);
543 debug("LAYER_EXT_PRESSED: Tap: register_code\n");
544 register_code(action.layer.code);
546 debug("LAYER_EXT_PRESSED: No tap: layer_switch\n");
547 layer_switch(default_layer);
551 debug("LAYER_EXT_PRESSED: Tap: unregister_code\n");
552 unregister_code(action.layer.code);
554 debug("LAYER_EXT_PRESSED: No tap: NO ACTION\n");
561 // set default layer when released
562 switch (action.layer.code) {
564 if (!event.pressed) {
565 layer_switch(default_layer);
571 if (tap_count >= TAPPING_TOGGLE) {
572 debug("LAYER_EXT_RELEASED: tap toggle.\n");
573 layer_switch(default_layer);
576 if (tap_count < TAPPING_TOGGLE) {
577 layer_switch(default_layer);
582 // change default layer
583 if (!event.pressed) {
584 default_layer = current_layer;
585 layer_switch(default_layer);
592 debug("LAYER_EXT_RELEASED: Tap: register_code\n");
593 register_code(action.layer.code);
595 debug("LAYER_EXT_RELEASED: No tap: NO ACTION\n");
599 debug("LAYER_EXT_RELEASED: Tap: unregister_code\n");
600 unregister_code(action.layer.code);
602 debug("LAYER_EXT_RELEASED: No tap: layer_switch\n");
603 layer_switch(default_layer);
619 action_call_function(event, action.func.id);
628 * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
629 * (without interfering by typing other key)
631 /* return true when key event is processed or consumed. */
632 static bool process_tapping(keyrecord_t *keyp)
634 keyevent_t event = keyp->event;
637 if (IS_TAPPING_PRESSED()) {
638 if (WITHIN_TAPPING_TERM(event)) {
639 if (tapping_key.tap_count == 0) {
640 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
642 debug("Tapping: First tap(0->1).\n");
643 tapping_key.tap_count = 1;
645 process_action(&tapping_key);
648 keyp->tap_count = tapping_key.tap_count;
651 #if TAPPING_TERM >= 500
652 /* This can prevent from typing some tap keys in a row at a time. */
653 else if (!event.pressed && waiting_buffer_typed(event)) {
654 // other key typed. not tap.
655 debug("Tapping: End. No tap. Interfered by typing key\n");
656 process_action(&tapping_key);
657 tapping_key = (keyrecord_t){};
665 // other key events shall be enq'd till tapping state settles.
671 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
672 debug("Tapping: Tap release("); debug_dec(tapping_key.tap_count); debug(")\n");
673 keyp->tap_count = tapping_key.tap_count;
674 process_action(keyp);
679 else if (is_tap_key(keyp->event.key) && event.pressed) {
680 if (tapping_key.tap_count > 1) {
681 debug("Tapping: Start new tap with releasing last tap(>1).\n");
683 process_action(&(keyrecord_t){
684 .tap_count = tapping_key.tap_count,
685 .event.key = tapping_key.event.key,
686 .event.time = event.time,
687 .event.pressed = false
690 debug("Tapping: Start while last tap(1).\n");
693 waiting_buffer_scan_tap();
698 if (!IS_NOEVENT(keyp->event)) {
699 debug("Tapping: key event while last tap(>0).\n");
701 process_action(keyp);
706 // after TAPPING_TERM
708 if (tapping_key.tap_count == 0) {
709 debug("Tapping: End. Timeout. Not tap(0): ");
710 debug_event(event); debug("\n");
711 process_action(&tapping_key);
712 tapping_key = (keyrecord_t){};
716 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
717 debug("Tapping: End. last timeout tap release(>0).");
718 keyp->tap_count = tapping_key.tap_count;
719 process_action(keyp);
720 tapping_key = (keyrecord_t){};
723 else if (is_tap_key(keyp->event.key) && event.pressed) {
724 if (tapping_key.tap_count > 1) {
725 debug("Tapping: Start new tap with releasing last timeout tap(>1).\n");
727 process_action(&(keyrecord_t){
728 .tap_count = tapping_key.tap_count,
729 .event.key = tapping_key.event.key,
730 .event.time = event.time,
731 .event.pressed = false
734 debug("Tapping: Start while last timeout tap(1).\n");
737 waiting_buffer_scan_tap();
742 if (!IS_NOEVENT(keyp->event)) {
743 debug("Tapping: key event while last timeout tap(>0).\n");
745 process_action(keyp);
750 } else if (IS_TAPPING_RELEASED()) {
751 if (WITHIN_TAPPING_TERM(event)) {
752 if (tapping_key.tap_count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
754 keyp->tap_count = tapping_key.tap_count + 1;
755 debug("Tapping: Tap press("); debug_dec(keyp->tap_count); debug(")\n");
756 process_action(keyp);
760 } else if (event.pressed && is_tap_key(event.key)) {
761 // Sequential tap can be interfered with other tap key.
762 debug("Tapping: Start with interfering other tap.\n");
764 waiting_buffer_scan_tap();
768 if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n");
769 process_action(keyp);
773 // timeout. no sequential tap.
774 debug("Tapping: End(Timeout after releasing last tap): ");
775 debug_event(event); debug("\n");
776 tapping_key = (keyrecord_t){};
778 process_action(keyp);
782 // not tapping satate
784 if (event.pressed && is_tap_key(event.key)) {
785 debug("Tapping: Start(Press tap key).\n");
787 waiting_buffer_scan_tap();
791 process_action(keyp);
797 /* scan buffer for tapping */
798 static void waiting_buffer_scan_tap(void)
800 // tapping already is settled
801 if (tapping_key.tap_count > 0) return;
802 // invalid state: tapping_key released && tap_count == 0
803 if (!tapping_key.event.pressed) return;
805 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
806 if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
807 !waiting_buffer[i].event.pressed &&
808 WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
809 tapping_key.tap_count = 1;
810 waiting_buffer[i].tap_count = 1;
811 process_action(&tapping_key);
813 debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
814 debug_waiting_buffer();
823 * Utilities for actions.
825 void register_code(uint8_t code)
830 else if IS_KEY(code) {
831 // TODO: should push command_proc out of this block?
832 if (command_proc(code)) return;
834 if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) {
835 uint8_t tmp_mods = host_get_mods();
836 host_add_mods(oneshot_state.mods);
838 host_send_keyboard_report();
840 host_set_mods(tmp_mods);
841 oneshot_state.ready = false;
844 host_send_keyboard_report();
847 else if IS_MOD(code) {
848 host_add_mods(MOD_BIT(code));
849 host_send_keyboard_report();
853 void unregister_code(uint8_t code)
857 host_send_keyboard_report();
859 else if IS_MOD(code) {
860 host_del_mods(MOD_BIT(code));
861 host_send_keyboard_report();
865 void add_mods(uint8_t mods)
869 host_send_keyboard_report();
873 void del_mods(uint8_t mods)
877 host_send_keyboard_report();
881 void set_mods(uint8_t mods)
884 host_send_keyboard_report();
887 void clear_keyboard(void)
890 clear_keyboard_but_mods();
893 void clear_keyboard_but_mods(void)
896 host_send_keyboard_report();
897 #ifdef MOUSEKEY_ENABLE
901 #ifdef EXTRAKEY_ENABLE
903 host_consumer_send(0);
907 bool sending_anykey(void)
909 return (host_has_anykey() || host_mouse_in_use() ||
910 host_last_sysytem_report() || host_last_consumer_report());
913 void layer_switch(uint8_t new_layer)
915 if (current_layer != new_layer) {
916 debug("Layer Switch: "); debug_hex(current_layer);
917 debug(" -> "); debug_hex(new_layer); debug("\n");
919 current_layer = new_layer;
920 clear_keyboard_but_mods(); // To avoid stuck keys
921 // NOTE: update mods with full scan of matrix? if modifier changes between layers
925 bool is_tap_key(key_t key)
927 action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
928 switch (action.kind.id) {
932 case ACT_LAYER_PRESSED:
934 switch (action.layer.code) {
944 if (action.func.opt & 0x1) {
956 static void debug_event(keyevent_t event)
958 debug_hex16(event.key.raw);
959 if (event.pressed) debug("d("); else debug("u(");
960 debug_dec(event.time); debug(")");
962 static void debug_record(keyrecord_t record)
964 debug_event(record.event); debug(":"); debug_dec(record.tap_count);
966 static void debug_action(action_t action)
968 switch (action.kind.id) {
969 case ACT_LMODS: debug("ACT_LMODS"); break;
970 case ACT_RMODS: debug("ACT_RMODS"); break;
971 case ACT_LMODS_TAP: debug("ACT_LMODS_TAP"); break;
972 case ACT_RMODS_TAP: debug("ACT_RMODS_TAP"); break;
973 case ACT_USAGE: debug("ACT_USAGE"); break;
974 case ACT_MOUSEKEY: debug("ACT_MOUSEKEY"); break;
975 case ACT_LAYER_PRESSED: debug("ACT_LAYER_PRESSED"); break;
976 case ACT_LAYER_RELEASED: debug("ACT_LAYER_RELEASED"); break;
977 case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); break;
978 case ACT_LAYER_EXT: debug("ACT_LAYER_EXT"); break;
979 case ACT_MACRO: debug("ACT_MACRO"); break;
980 case ACT_COMMAND: debug("ACT_COMMAND"); break;
981 case ACT_FUNCTION: debug("ACT_FUNCTION"); break;
982 default: debug("UNKNOWN"); break;
985 debug_hex4(action.kind.param>>8);
987 debug_hex8(action.kind.param & 0xff);
990 static void debug_tapping_key(void)
992 debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
994 static void debug_waiting_buffer(void)
997 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
998 debug("["); debug_dec(i); debug("]="); debug_record(waiting_buffer[i]); debug(" ");