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);
475 // change default layer
477 default_layer = current_layer ^ action.layer.opt;
478 layer_switch(default_layer);
480 default_layer = current_layer ^ action.layer.opt;
481 layer_switch(default_layer);
487 if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
488 debug("LAYER_BIT: Tap: register_code\n");
489 register_code(action.layer.code);
491 debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
492 layer_switch(current_layer ^ action.layer.opt);
495 if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
496 debug("LAYER_BIT: Tap: unregister_code\n");
497 unregister_code(action.layer.code);
499 debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
500 layer_switch(current_layer ^ action.layer.opt);
507 switch (action.layer.opt) {
509 // set default layer when pressed
510 switch (action.layer.code) {
513 layer_switch(default_layer);
519 if (tap_count < TAPPING_TOGGLE) {
520 layer_switch(default_layer);
523 if (tap_count >= TAPPING_TOGGLE) {
524 debug("LAYER_EXT_PRESSED: tap toggle.\n");
525 layer_switch(default_layer);
530 // change default layer
532 default_layer = current_layer;
533 layer_switch(default_layer);
540 debug("LAYER_EXT_PRESSED: Tap: register_code\n");
541 register_code(action.layer.code);
543 debug("LAYER_EXT_PRESSED: No tap: layer_switch\n");
544 layer_switch(default_layer);
548 debug("LAYER_EXT_PRESSED: Tap: unregister_code\n");
549 unregister_code(action.layer.code);
551 debug("LAYER_EXT_PRESSED: No tap: NO ACTION\n");
558 // set default layer when released
559 switch (action.layer.code) {
561 if (!event.pressed) {
562 layer_switch(default_layer);
568 if (tap_count >= TAPPING_TOGGLE) {
569 debug("LAYER_EXT_RELEASED: tap toggle.\n");
570 layer_switch(default_layer);
573 if (tap_count < TAPPING_TOGGLE) {
574 layer_switch(default_layer);
579 // change default layer
580 if (!event.pressed) {
581 default_layer = current_layer;
582 layer_switch(default_layer);
589 debug("LAYER_EXT_RELEASED: Tap: register_code\n");
590 register_code(action.layer.code);
592 debug("LAYER_EXT_RELEASED: No tap: NO ACTION\n");
596 debug("LAYER_EXT_RELEASED: Tap: unregister_code\n");
597 unregister_code(action.layer.code);
599 debug("LAYER_EXT_RELEASED: No tap: layer_switch\n");
600 layer_switch(default_layer);
616 action_call_function(event, action.func.id);
625 * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
626 * (without interfering by typing other key)
628 /* return true when key event is processed or consumed. */
629 static bool process_tapping(keyrecord_t *keyp)
631 keyevent_t event = keyp->event;
634 if (IS_TAPPING_PRESSED()) {
635 if (WITHIN_TAPPING_TERM(event)) {
636 if (tapping_key.tap_count == 0) {
637 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
639 debug("Tapping: First tap(0->1).\n");
640 tapping_key.tap_count = 1;
642 process_action(&tapping_key);
645 keyp->tap_count = tapping_key.tap_count;
648 #if TAPPING_TERM >= 500
649 /* This can prevent from typing some tap keys in a row at a time. */
650 else if (!event.pressed && waiting_buffer_typed(event)) {
651 // other key typed. not tap.
652 debug("Tapping: End. No tap. Interfered by typing key\n");
653 process_action(&tapping_key);
654 tapping_key = (keyrecord_t){};
662 // other key events shall be enq'd till tapping state settles.
668 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
669 debug("Tapping: Tap release("); debug_dec(tapping_key.tap_count); debug(")\n");
670 keyp->tap_count = tapping_key.tap_count;
671 process_action(keyp);
676 else if (is_tap_key(keyp->event.key) && event.pressed) {
677 if (tapping_key.tap_count > 1) {
678 debug("Tapping: Start new tap with releasing last tap(>1).\n");
680 process_action(&(keyrecord_t){
681 .tap_count = tapping_key.tap_count,
682 .event.key = tapping_key.event.key,
683 .event.time = event.time,
684 .event.pressed = false
687 debug("Tapping: Start while last tap(1).\n");
690 waiting_buffer_scan_tap();
695 if (!IS_NOEVENT(keyp->event)) {
696 debug("Tapping: key event while last tap(>0).\n");
698 process_action(keyp);
703 // after TAPPING_TERM
705 if (tapping_key.tap_count == 0) {
706 debug("Tapping: End. Timeout. Not tap(0): ");
707 debug_event(event); debug("\n");
708 process_action(&tapping_key);
709 tapping_key = (keyrecord_t){};
713 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
714 debug("Tapping: End. last timeout tap release(>0).");
715 keyp->tap_count = tapping_key.tap_count;
716 process_action(keyp);
717 tapping_key = (keyrecord_t){};
720 else if (is_tap_key(keyp->event.key) && event.pressed) {
721 if (tapping_key.tap_count > 1) {
722 debug("Tapping: Start new tap with releasing last timeout tap(>1).\n");
724 process_action(&(keyrecord_t){
725 .tap_count = tapping_key.tap_count,
726 .event.key = tapping_key.event.key,
727 .event.time = event.time,
728 .event.pressed = false
731 debug("Tapping: Start while last timeout tap(1).\n");
734 waiting_buffer_scan_tap();
739 if (!IS_NOEVENT(keyp->event)) {
740 debug("Tapping: key event while last timeout tap(>0).\n");
742 process_action(keyp);
747 } else if (IS_TAPPING_RELEASED()) {
748 if (WITHIN_TAPPING_TERM(event)) {
749 if (tapping_key.tap_count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
751 keyp->tap_count = tapping_key.tap_count + 1;
752 debug("Tapping: Tap press("); debug_dec(keyp->tap_count); debug(")\n");
753 process_action(keyp);
757 } else if (event.pressed && is_tap_key(event.key)) {
758 // Sequential tap can be interfered with other tap key.
759 debug("Tapping: Start with interfering other tap.\n");
761 waiting_buffer_scan_tap();
765 if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n");
766 process_action(keyp);
770 // timeout. no sequential tap.
771 debug("Tapping: End(Timeout after releasing last tap): ");
772 debug_event(event); debug("\n");
773 tapping_key = (keyrecord_t){};
778 // not tapping satate
780 if (event.pressed && is_tap_key(event.key)) {
781 debug("Tapping: Start(Press tap key).\n");
783 waiting_buffer_scan_tap();
787 process_action(keyp);
793 /* scan buffer for tapping */
794 static void waiting_buffer_scan_tap(void)
796 // tapping already is settled
797 if (tapping_key.tap_count > 0) return;
798 // invalid state: tapping_key released && tap_count == 0
799 if (!tapping_key.event.pressed) return;
801 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
802 if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
803 !waiting_buffer[i].event.pressed &&
804 WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
805 tapping_key.tap_count = 1;
806 waiting_buffer[i].tap_count = 1;
807 process_action(&tapping_key);
809 debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
810 debug_waiting_buffer();
819 * Utilities for actions.
821 void register_code(uint8_t code)
826 else if IS_KEY(code) {
827 // TODO: should push command_proc out of this block?
828 if (command_proc(code)) return;
830 if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) {
831 uint8_t tmp_mods = host_get_mods();
832 host_add_mods(oneshot_state.mods);
834 host_send_keyboard_report();
836 host_set_mods(tmp_mods);
837 oneshot_state.ready = false;
840 host_send_keyboard_report();
843 else if IS_MOD(code) {
844 host_add_mods(MOD_BIT(code));
845 host_send_keyboard_report();
849 void unregister_code(uint8_t code)
853 host_send_keyboard_report();
855 else if IS_MOD(code) {
856 host_del_mods(MOD_BIT(code));
857 host_send_keyboard_report();
861 void add_mods(uint8_t mods)
865 host_send_keyboard_report();
869 void del_mods(uint8_t mods)
873 host_send_keyboard_report();
877 void set_mods(uint8_t mods)
880 host_send_keyboard_report();
883 void clear_keyboard(void)
886 clear_keyboard_but_mods();
889 void clear_keyboard_but_mods(void)
892 host_send_keyboard_report();
893 #ifdef MOUSEKEY_ENABLE
897 #ifdef EXTRAKEY_ENABLE
899 host_consumer_send(0);
903 bool sending_anykey(void)
905 return (host_has_anykey() || host_mouse_in_use() ||
906 host_last_sysytem_report() || host_last_consumer_report());
909 void layer_switch(uint8_t new_layer)
911 if (current_layer != new_layer) {
912 debug("Layer Switch: "); debug_hex(current_layer);
913 debug(" -> "); debug_hex(new_layer); debug("\n");
915 current_layer = new_layer;
916 clear_keyboard_but_mods(); // To avoid stuck keys
917 // NOTE: update mods with full scan of matrix? if modifier changes between layers
921 bool is_tap_key(key_t key)
923 action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
924 switch (action.kind.id) {
928 case ACT_LAYER_PRESSED:
930 switch (action.layer.code) {
940 if (action.func.opt & 0x1) {
952 static void debug_event(keyevent_t event)
954 debug_hex16(event.key.raw);
955 if (event.pressed) debug("d("); else debug("u(");
956 debug_dec(event.time); debug(")");
958 static void debug_record(keyrecord_t record)
960 debug_event(record.event); debug(":"); debug_dec(record.tap_count);
962 static void debug_action(action_t action)
964 switch (action.kind.id) {
965 case ACT_LMODS: debug("ACT_LMODS"); break;
966 case ACT_RMODS: debug("ACT_RMODS"); break;
967 case ACT_LMODS_TAP: debug("ACT_LMODS_TAP"); break;
968 case ACT_RMODS_TAP: debug("ACT_RMODS_TAP"); break;
969 case ACT_USAGE: debug("ACT_USAGE"); break;
970 case ACT_MOUSEKEY: debug("ACT_MOUSEKEY"); break;
971 case ACT_LAYER_PRESSED: debug("ACT_LAYER_PRESSED"); break;
972 case ACT_LAYER_RELEASED: debug("ACT_LAYER_RELEASED"); break;
973 case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); break;
974 case ACT_LAYER_EXT: debug("ACT_LAYER_EXT"); break;
975 case ACT_MACRO: debug("ACT_MACRO"); break;
976 case ACT_COMMAND: debug("ACT_COMMAND"); break;
977 case ACT_FUNCTION: debug("ACT_FUNCTION"); break;
978 default: debug("UNKNOWN"); break;
981 debug_hex4(action.kind.param>>8);
983 debug_hex8(action.kind.param & 0xff);
986 static void debug_tapping_key(void)
988 debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
990 static void debug_waiting_buffer(void)
993 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
994 debug("["); debug_dec(i); debug("]="); debug_record(waiting_buffer[i]); debug(" ");