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/>.
23 #include "backlight.h"
24 #include "action_layer.h"
25 #include "action_tapping.h"
26 #include "action_macro.h"
27 #include "action_util.h"
37 void action_exec(keyevent_t event)
39 if (!IS_NOEVENT(event)) {
40 dprint("\n---- action_exec: start -----\n");
41 dprint("EVENT: "); debug_event(event); dprintln();
44 keyrecord_t record = { .event = event };
46 #ifndef NO_ACTION_TAPPING
47 action_tapping_process(record);
49 process_action(&record);
50 if (!IS_NOEVENT(record.event)) {
51 dprint("processed: "); debug_record(record); dprintln();
56 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
57 bool disable_action_cache = false;
59 void process_action_nocache(keyrecord_t *record)
61 disable_action_cache = true;
62 process_action(record);
63 disable_action_cache = false;
68 * Make sure the action triggered when the key is released is the same
69 * one as the one triggered on press. It's important for the mod keys
70 * when the layer is switched after the down event but before the up
71 * event as they may get stuck otherwise.
73 action_t store_or_get_action(bool pressed, keypos_t key)
75 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
76 static action_t pressed_actions[MATRIX_ROWS][MATRIX_COLS];
78 if (disable_action_cache) {
79 return layer_switch_get_action(key);
83 pressed_actions[key.row][key.col] = layer_switch_get_action(key);
85 return pressed_actions[key.row][key.col];
87 return layer_switch_get_action(key);
91 void process_action(keyrecord_t *record)
93 keyevent_t event = record->event;
94 #ifndef NO_ACTION_TAPPING
95 uint8_t tap_count = record->tap.count;
98 if (IS_NOEVENT(event)) { return; }
100 action_t action = store_or_get_action(event.pressed, event.key);
101 dprint("ACTION: "); debug_action(action);
102 #ifndef NO_ACTION_LAYER
103 dprint(" layer_state: "); layer_debug();
104 dprint(" default_layer_state: "); default_layer_debug();
108 switch (action.kind.id) {
113 uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
118 send_keyboard_report();
120 register_code(action.key.code);
122 unregister_code(action.key.code);
125 send_keyboard_report();
130 #ifndef NO_ACTION_TAPPING
134 uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
136 switch (action.layer_tap.code) {
137 #ifndef NO_ACTION_ONESHOT
141 if (tap_count == 0) {
144 else if (tap_count == 1) {
145 dprint("MODS_TAP: Oneshot: start\n");
146 set_oneshot_mods(mods);
152 if (tap_count == 0) {
153 clear_oneshot_mods();
154 unregister_mods(mods);
156 else if (tap_count == 1) {
157 // Retain Oneshot mods
160 clear_oneshot_mods();
161 unregister_mods(mods);
166 case MODS_TAP_TOGGLE:
168 if (tap_count <= TAPPING_TOGGLE) {
172 if (tap_count < TAPPING_TOGGLE) {
173 unregister_mods(mods);
180 #ifndef IGNORE_MOD_TAP_INTERRUPT
181 if (record->tap.interrupted) {
182 dprint("mods_tap: tap: cancel: add_mods\n");
183 // ad hoc: set 0 to cancel tap
184 record->tap.count = 0;
189 dprint("MODS_TAP: Tap: register_code\n");
190 register_code(action.key.code);
193 dprint("MODS_TAP: No tap: add_mods\n");
198 dprint("MODS_TAP: Tap: unregister_code\n");
199 unregister_code(action.key.code);
201 dprint("MODS_TAP: No tap: add_mods\n");
202 unregister_mods(mods);
210 #ifdef EXTRAKEY_ENABLE
211 /* other HID usage */
213 switch (action.usage.page) {
216 host_system_send(action.usage.code);
223 host_consumer_send(action.usage.code);
225 host_consumer_send(0);
231 #ifdef MOUSEKEY_ENABLE
235 mousekey_on(action.key.code);
238 mousekey_off(action.key.code);
243 #ifndef NO_ACTION_LAYER
245 if (action.layer_bitop.on == 0) {
246 /* Default Layer Bitwise Operation */
247 if (!event.pressed) {
248 uint8_t shift = action.layer_bitop.part*4;
249 uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
250 uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
251 switch (action.layer_bitop.op) {
252 case OP_BIT_AND: default_layer_and(bits | mask); break;
253 case OP_BIT_OR: default_layer_or(bits | mask); break;
254 case OP_BIT_XOR: default_layer_xor(bits | mask); break;
255 case OP_BIT_SET: default_layer_and(mask); default_layer_or(bits); break;
259 /* Layer Bitwise Operation */
260 if (event.pressed ? (action.layer_bitop.on & ON_PRESS) :
261 (action.layer_bitop.on & ON_RELEASE)) {
262 uint8_t shift = action.layer_bitop.part*4;
263 uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
264 uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
265 switch (action.layer_bitop.op) {
266 case OP_BIT_AND: layer_and(bits | mask); break;
267 case OP_BIT_OR: layer_or(bits | mask); break;
268 case OP_BIT_XOR: layer_xor(bits | mask); break;
269 case OP_BIT_SET: layer_and(mask); layer_or(bits); break;
274 #ifndef NO_ACTION_TAPPING
276 case ACT_LAYER_TAP_EXT:
277 switch (action.layer_tap.code) {
279 /* layer On/Off with modifiers(left only) */
281 layer_on(action.layer_tap.val);
282 register_mods(action.layer_tap.code & 0x0f);
284 layer_off(action.layer_tap.val);
285 unregister_mods(action.layer_tap.code & 0x0f);
291 if (tap_count < TAPPING_TOGGLE) {
292 layer_invert(action.layer_tap.val);
295 if (tap_count <= TAPPING_TOGGLE) {
296 layer_invert(action.layer_tap.val);
301 event.pressed ? layer_on(action.layer_tap.val) :
302 layer_off(action.layer_tap.val);
305 event.pressed ? layer_off(action.layer_tap.val) :
306 layer_on(action.layer_tap.val);
309 event.pressed ? layer_move(action.layer_tap.val) :
316 dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
317 register_code(action.layer_tap.code);
319 dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
320 layer_on(action.layer_tap.val);
324 dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
325 unregister_code(action.layer_tap.code);
327 dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
328 layer_off(action.layer_tap.val);
337 #ifndef NO_ACTION_MACRO
339 action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
342 #ifdef BACKLIGHT_ENABLE
344 if (!event.pressed) {
345 switch (action.backlight.opt) {
346 case BACKLIGHT_INCREASE:
347 backlight_increase();
349 case BACKLIGHT_DECREASE:
350 backlight_decrease();
352 case BACKLIGHT_TOGGLE:
358 case BACKLIGHT_LEVEL:
359 backlight_level(action.backlight.level);
367 #ifndef NO_ACTION_FUNCTION
369 action_function(record, action.func.id, action.func.opt);
381 * Utilities for actions.
383 void register_code(uint8_t code)
389 #ifdef LOCKING_SUPPORT_ENABLE
390 else if (KC_LOCKING_CAPS == code) {
391 #ifdef LOCKING_RESYNC_ENABLE
392 // Resync: ignore if caps lock already is on
393 if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
395 add_key(KC_CAPSLOCK);
396 send_keyboard_report();
397 del_key(KC_CAPSLOCK);
398 send_keyboard_report();
401 else if (KC_LOCKING_NUM == code) {
402 #ifdef LOCKING_RESYNC_ENABLE
403 if (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) return;
406 send_keyboard_report();
408 send_keyboard_report();
411 else if (KC_LOCKING_SCROLL == code) {
412 #ifdef LOCKING_RESYNC_ENABLE
413 if (host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK)) return;
415 add_key(KC_SCROLLLOCK);
416 send_keyboard_report();
417 del_key(KC_SCROLLLOCK);
418 send_keyboard_report();
422 else if IS_KEY(code) {
423 // TODO: should push command_proc out of this block?
424 if (command_proc(code)) return;
426 #ifndef NO_ACTION_ONESHOT
428 if (oneshot_state.mods && !oneshot_state.disabled) {
429 uint8_t tmp_mods = get_mods();
430 add_mods(oneshot_state.mods);
433 send_keyboard_report();
436 send_keyboard_report();
443 send_keyboard_report();
446 else if IS_MOD(code) {
447 add_mods(MOD_BIT(code));
448 send_keyboard_report();
450 else if IS_SYSTEM(code) {
451 host_system_send(KEYCODE2SYSTEM(code));
453 else if IS_CONSUMER(code) {
454 host_consumer_send(KEYCODE2CONSUMER(code));
458 void unregister_code(uint8_t code)
464 #ifdef LOCKING_SUPPORT_ENABLE
465 else if (KC_LOCKING_CAPS == code) {
466 #ifdef LOCKING_RESYNC_ENABLE
467 // Resync: ignore if caps lock already is off
468 if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
470 add_key(KC_CAPSLOCK);
471 send_keyboard_report();
472 del_key(KC_CAPSLOCK);
473 send_keyboard_report();
476 else if (KC_LOCKING_NUM == code) {
477 #ifdef LOCKING_RESYNC_ENABLE
478 if (!(host_keyboard_leds() & (1<<USB_LED_NUM_LOCK))) return;
481 send_keyboard_report();
483 send_keyboard_report();
486 else if (KC_LOCKING_SCROLL == code) {
487 #ifdef LOCKING_RESYNC_ENABLE
488 if (!(host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK))) return;
490 add_key(KC_SCROLLLOCK);
491 send_keyboard_report();
492 del_key(KC_SCROLLLOCK);
493 send_keyboard_report();
497 else if IS_KEY(code) {
499 send_keyboard_report();
501 else if IS_MOD(code) {
502 del_mods(MOD_BIT(code));
503 send_keyboard_report();
505 else if IS_SYSTEM(code) {
508 else if IS_CONSUMER(code) {
509 host_consumer_send(0);
513 void register_mods(uint8_t mods)
517 send_keyboard_report();
521 void unregister_mods(uint8_t mods)
525 send_keyboard_report();
529 void clear_keyboard(void)
532 clear_keyboard_but_mods();
535 void clear_keyboard_but_mods(void)
539 send_keyboard_report();
540 #ifdef MOUSEKEY_ENABLE
544 #ifdef EXTRAKEY_ENABLE
546 host_consumer_send(0);
550 bool is_tap_key(keypos_t key)
552 action_t action = layer_switch_get_action(key);
554 switch (action.kind.id) {
558 case ACT_LAYER_TAP_EXT:
559 switch (action.layer_tap.code) {
567 if (action.func.opt & FUNC_TAP) { return true; }
577 void debug_event(keyevent_t event)
579 dprintf("%04X%c(%u)", (event.key.row<<8 | event.key.col), (event.pressed ? 'd' : 'u'), event.time);
582 void debug_record(keyrecord_t record)
584 debug_event(record.event);
585 #ifndef NO_ACTION_TAPPING
586 dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
590 void debug_action(action_t action)
592 switch (action.kind.id) {
593 case ACT_LMODS: dprint("ACT_LMODS"); break;
594 case ACT_RMODS: dprint("ACT_RMODS"); break;
595 case ACT_LMODS_TAP: dprint("ACT_LMODS_TAP"); break;
596 case ACT_RMODS_TAP: dprint("ACT_RMODS_TAP"); break;
597 case ACT_USAGE: dprint("ACT_USAGE"); break;
598 case ACT_MOUSEKEY: dprint("ACT_MOUSEKEY"); break;
599 case ACT_LAYER: dprint("ACT_LAYER"); break;
600 case ACT_LAYER_TAP: dprint("ACT_LAYER_TAP"); break;
601 case ACT_LAYER_TAP_EXT: dprint("ACT_LAYER_TAP_EXT"); break;
602 case ACT_MACRO: dprint("ACT_MACRO"); break;
603 case ACT_COMMAND: dprint("ACT_COMMAND"); break;
604 case ACT_FUNCTION: dprint("ACT_FUNCTION"); break;
605 default: dprint("UNKNOWN"); break;
607 dprintf("[%X:%02X]", action.kind.param>>8, action.kind.param&0xff);