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 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 == TAPPING_TOGGLE) {
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) {
324 host_system_send(action.usage.code);
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);
355 switch (action.layer.code) {
356 case LAYER_MOMENTARY: /* momentary */
358 layer_switch(action.layer.val);
361 // NOTE: This is needed by legacy keymap support
362 layer_switch(default_layer);
367 layer_switch(action.layer.val);
370 case LAYER_ON_RELEASE:
371 if (!event.pressed) {
372 layer_switch(action.layer.val);
375 case LAYER_DEFAULT: /* default layer */
376 switch (action.layer.val) {
377 case DEFAULT_ON_BOTH:
378 layer_switch(default_layer);
380 case DEFAULT_ON_PRESS:
382 layer_switch(default_layer);
385 case DEFAULT_ON_RELEASE:
386 if (!event.pressed) {
387 layer_switch(default_layer);
392 case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
394 if (tap_count < TAPPING_TOGGLE) {
395 layer_switch(action.layer.val);
398 if (tap_count >= TAPPING_TOGGLE) {
399 debug("LAYER_PRESSED: tap toggle.\n");
400 layer_switch(action.layer.val);
404 case LAYER_CHANGE_DEFAULT: /* change default layer */
406 default_layer = action.layer.val;
407 layer_switch(default_layer);
410 default: /* switch layer on hold and key on tap*/
413 debug("LAYER_PRESSED: Tap: register_code\n");
414 register_code(action.layer.code);
416 debug("LAYER_PRESSED: No tap: layer_switch\n");
417 layer_switch(action.layer.val);
421 debug("LAYER_PRESSED: Tap: unregister_code\n");
422 unregister_code(action.layer.code);
424 //debug("LAYER_PRESSED: No tap: NO ACTION\n");
425 // NOTE: This is needed by legacy keymap support
426 debug("LAYER_PRESSED: No tap: return to default layer\n");
427 layer_switch(default_layer);
434 switch (action.layer.code) {
435 case LAYER_MOMENTARY: /* momentary */
437 layer_switch(current_layer ^ action.layer.val);
439 layer_switch(current_layer ^ action.layer.val);
444 layer_switch(current_layer ^ action.layer.val);
447 case LAYER_ON_RELEASE:
448 if (!event.pressed) {
449 layer_switch(current_layer ^ action.layer.val);
452 case LAYER_TAP_TOGGLE: /* switch on hold and toggle on several taps */
454 if (tap_count < TAPPING_TOGGLE) {
455 debug("LAYER_BIT: tap toggle(press).\n");
456 layer_switch(current_layer ^ action.layer.val);
459 if (tap_count <= TAPPING_TOGGLE) {
460 debug("LAYER_BIT: tap toggle(release).\n");
461 layer_switch(current_layer ^ action.layer.val);
466 // change default layer
468 default_layer = current_layer ^ action.layer.val;
469 layer_switch(default_layer);
471 default_layer = current_layer ^ action.layer.val;
472 layer_switch(default_layer);
478 if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
479 debug("LAYER_BIT: Tap: register_code\n");
480 register_code(action.layer.code);
482 debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
483 layer_switch(current_layer ^ action.layer.val);
486 if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
487 debug("LAYER_BIT: Tap: unregister_code\n");
488 unregister_code(action.layer.code);
490 debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
491 layer_switch(current_layer ^ action.layer.val);
505 keymap_call_function(record, action.func.id, action.func.opt);
514 * Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
515 * (without interfering by typing other key)
517 /* return true when key event is processed or consumed. */
518 static bool process_tapping(keyrecord_t *keyp)
520 keyevent_t event = keyp->event;
523 if (IS_TAPPING_PRESSED()) {
524 if (WITHIN_TAPPING_TERM(event)) {
525 if (tapping_key.tap_count == 0) {
526 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
528 debug("Tapping: First tap(0->1).\n");
529 tapping_key.tap_count = 1;
531 process_action(&tapping_key);
534 keyp->tap_count = tapping_key.tap_count;
537 #if TAPPING_TERM >= 500
538 /* This can prevent from typing some tap keys in a row at a time. */
539 else if (!event.pressed && waiting_buffer_typed(event)) {
540 // other key typed. not tap.
541 debug("Tapping: End. No tap. Interfered by typing key\n");
542 process_action(&tapping_key);
543 tapping_key = (keyrecord_t){};
551 // other key events shall be enq'd till tapping state settles.
557 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
558 debug("Tapping: Tap release("); debug_dec(tapping_key.tap_count); debug(")\n");
559 keyp->tap_count = tapping_key.tap_count;
560 process_action(keyp);
565 else if (is_tap_key(keyp->event.key) && event.pressed) {
566 if (tapping_key.tap_count > 1) {
567 debug("Tapping: Start new tap with releasing last tap(>1).\n");
569 process_action(&(keyrecord_t){
570 .tap_count = tapping_key.tap_count,
571 .event.key = tapping_key.event.key,
572 .event.time = event.time,
573 .event.pressed = false
576 debug("Tapping: Start while last tap(1).\n");
579 waiting_buffer_scan_tap();
584 if (!IS_NOEVENT(keyp->event)) {
585 debug("Tapping: key event while last tap(>0).\n");
587 process_action(keyp);
592 // after TAPPING_TERM
594 if (tapping_key.tap_count == 0) {
595 debug("Tapping: End. Timeout. Not tap(0): ");
596 debug_event(event); debug("\n");
597 process_action(&tapping_key);
598 tapping_key = (keyrecord_t){};
602 if (IS_TAPPING_KEY(event.key) && !event.pressed) {
603 debug("Tapping: End. last timeout tap release(>0).");
604 keyp->tap_count = tapping_key.tap_count;
605 process_action(keyp);
606 tapping_key = (keyrecord_t){};
609 else if (is_tap_key(keyp->event.key) && event.pressed) {
610 if (tapping_key.tap_count > 1) {
611 debug("Tapping: Start new tap with releasing last timeout tap(>1).\n");
613 process_action(&(keyrecord_t){
614 .tap_count = tapping_key.tap_count,
615 .event.key = tapping_key.event.key,
616 .event.time = event.time,
617 .event.pressed = false
620 debug("Tapping: Start while last timeout tap(1).\n");
623 waiting_buffer_scan_tap();
628 if (!IS_NOEVENT(keyp->event)) {
629 debug("Tapping: key event while last timeout tap(>0).\n");
631 process_action(keyp);
636 } else if (IS_TAPPING_RELEASED()) {
637 if (WITHIN_TAPPING_TERM(event)) {
638 if (tapping_key.tap_count > 0 && IS_TAPPING_KEY(event.key) && event.pressed) {
640 keyp->tap_count = tapping_key.tap_count + 1;
641 debug("Tapping: Tap press("); debug_dec(keyp->tap_count); debug(")\n");
642 process_action(keyp);
646 } else if (event.pressed && is_tap_key(event.key)) {
647 // Sequential tap can be interfered with other tap key.
648 debug("Tapping: Start with interfering other tap.\n");
650 waiting_buffer_scan_tap();
654 if (!IS_NOEVENT(keyp->event)) debug("Tapping: other key just after tap.\n");
655 process_action(keyp);
659 // timeout. no sequential tap.
660 debug("Tapping: End(Timeout after releasing last tap): ");
661 debug_event(event); debug("\n");
662 tapping_key = (keyrecord_t){};
667 // not tapping satate
669 if (event.pressed && is_tap_key(event.key)) {
670 debug("Tapping: Start(Press tap key).\n");
672 waiting_buffer_scan_tap();
676 process_action(keyp);
682 /* scan buffer for tapping */
683 static void waiting_buffer_scan_tap(void)
685 // tapping already is settled
686 if (tapping_key.tap_count > 0) return;
687 // invalid state: tapping_key released && tap_count == 0
688 if (!tapping_key.event.pressed) return;
690 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
691 if (IS_TAPPING_KEY(waiting_buffer[i].event.key) &&
692 !waiting_buffer[i].event.pressed &&
693 WITHIN_TAPPING_TERM(waiting_buffer[i].event)) {
694 tapping_key.tap_count = 1;
695 waiting_buffer[i].tap_count = 1;
696 process_action(&tapping_key);
698 debug("waiting_buffer_scan_tap: found at ["); debug_dec(i); debug("]\n");
699 debug_waiting_buffer();
708 * Utilities for actions.
710 void register_code(uint8_t code)
715 else if IS_KEY(code) {
716 // TODO: should push command_proc out of this block?
717 if (command_proc(code)) return;
719 if (oneshot_state.mods && oneshot_state.ready && !oneshot_state.disabled) {
720 uint8_t tmp_mods = host_get_mods();
721 host_add_mods(oneshot_state.mods);
723 host_send_keyboard_report();
725 host_set_mods(tmp_mods);
726 oneshot_state.ready = false;
729 host_send_keyboard_report();
732 else if IS_MOD(code) {
733 host_add_mods(MOD_BIT(code));
734 host_send_keyboard_report();
738 void unregister_code(uint8_t code)
742 host_send_keyboard_report();
744 else if IS_MOD(code) {
745 host_del_mods(MOD_BIT(code));
746 host_send_keyboard_report();
750 void add_mods(uint8_t mods)
754 host_send_keyboard_report();
758 void del_mods(uint8_t mods)
762 host_send_keyboard_report();
766 void set_mods(uint8_t mods)
769 host_send_keyboard_report();
772 void clear_keyboard(void)
775 clear_keyboard_but_mods();
778 void clear_keyboard_but_mods(void)
781 host_send_keyboard_report();
782 #ifdef MOUSEKEY_ENABLE
786 #ifdef EXTRAKEY_ENABLE
788 host_consumer_send(0);
792 bool sending_anykey(void)
794 return (host_has_anykey() || host_mouse_in_use() ||
795 host_last_sysytem_report() || host_last_consumer_report());
798 void layer_switch(uint8_t new_layer)
800 if (current_layer != new_layer) {
801 debug("Layer Switch: "); debug_hex(current_layer);
802 debug(" -> "); debug_hex(new_layer); debug("\n");
804 current_layer = new_layer;
805 clear_keyboard_but_mods(); // To avoid stuck keys
806 // NOTE: update mods with full scan of matrix? if modifier changes between layers
810 bool is_tap_key(key_t key)
812 action_t action = keymap_get_action(current_layer, key.pos.row, key.pos.col);
813 switch (action.kind.id) {
819 switch (action.layer.code) {
820 case LAYER_MOMENTARY:
822 case LAYER_ON_RELEASE:
825 case LAYER_TAP_TOGGLE:
826 default: /* tap key */
831 if (action.func.opt & FUNC_TAP) { return true; }
841 static void debug_event(keyevent_t event)
843 debug_hex16(event.key.raw);
844 if (event.pressed) debug("d("); else debug("u(");
845 debug_dec(event.time); debug(")");
847 static void debug_record(keyrecord_t record)
849 debug_event(record.event); debug(":"); debug_dec(record.tap_count);
851 static void debug_action(action_t action)
853 switch (action.kind.id) {
854 case ACT_LMODS: debug("ACT_LMODS"); break;
855 case ACT_RMODS: debug("ACT_RMODS"); break;
856 case ACT_LMODS_TAP: debug("ACT_LMODS_TAP"); break;
857 case ACT_RMODS_TAP: debug("ACT_RMODS_TAP"); break;
858 case ACT_USAGE: debug("ACT_USAGE"); break;
859 case ACT_MOUSEKEY: debug("ACT_MOUSEKEY"); break;
860 case ACT_LAYER: debug("ACT_LAYER"); break;
861 case ACT_LAYER_BIT: debug("ACT_LAYER_BIT"); break;
862 case ACT_MACRO: debug("ACT_MACRO"); break;
863 case ACT_COMMAND: debug("ACT_COMMAND"); break;
864 case ACT_FUNCTION: debug("ACT_FUNCTION"); break;
865 default: debug("UNKNOWN"); break;
868 debug_hex4(action.kind.param>>8);
870 debug_hex8(action.kind.param & 0xff);
873 static void debug_tapping_key(void)
875 debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
877 static void debug_waiting_buffer(void)
880 for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
881 debug("["); debug_dec(i); debug("]="); debug_record(waiting_buffer[i]); debug(" ");