]>
git.gir.st - tmk_keyboard.git/blob - tmk_core/common/action.c
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 void process_action(keyrecord_t
*record
)
58 keyevent_t event
= record
->event
;
59 #ifndef NO_ACTION_TAPPING
60 uint8_t tap_count
= record
->tap
.count
;
63 if (IS_NOEVENT(event
)) { return; }
65 action_t action
= layer_switch_get_action(event
.key
);
66 dprint("ACTION: "); debug_action(action
);
67 #ifndef NO_ACTION_LAYER
68 dprint(" layer_state: "); layer_debug();
69 dprint(" default_layer_state: "); default_layer_debug();
73 switch (action
.kind
.id
) {
78 uint8_t mods
= (action
.kind
.id
== ACT_LMODS
) ? action
.key
.mods
:
83 send_keyboard_report();
85 register_code(action
.key
.code
);
87 unregister_code(action
.key
.code
);
90 send_keyboard_report();
95 #ifndef NO_ACTION_TAPPING
99 uint8_t mods
= (action
.kind
.id
== ACT_LMODS_TAP
) ? action
.key
.mods
:
101 switch (action
.layer_tap
.code
) {
102 #ifndef NO_ACTION_ONESHOT
106 if (tap_count
== 0) {
109 else if (tap_count
== 1) {
110 dprint("MODS_TAP: Oneshot: start\n");
111 set_oneshot_mods(mods
);
117 if (tap_count
== 0) {
118 clear_oneshot_mods();
119 unregister_mods(mods
);
121 else if (tap_count
== 1) {
122 // Retain Oneshot mods
125 clear_oneshot_mods();
126 unregister_mods(mods
);
131 case MODS_TAP_TOGGLE
:
133 if (tap_count
<= TAPPING_TOGGLE
) {
137 if (tap_count
< TAPPING_TOGGLE
) {
138 unregister_mods(mods
);
145 if (record
->tap
.interrupted
) {
146 dprint("MODS_TAP: Tap: Cancel: add_mods\n");
147 // ad hoc: set 0 to cancel tap
148 record
->tap
.count
= 0;
151 dprint("MODS_TAP: Tap: register_code\n");
152 register_code(action
.key
.code
);
155 dprint("MODS_TAP: No tap: add_mods\n");
160 dprint("MODS_TAP: Tap: unregister_code\n");
161 unregister_code(action
.key
.code
);
163 dprint("MODS_TAP: No tap: add_mods\n");
164 unregister_mods(mods
);
172 #ifdef EXTRAKEY_ENABLE
173 /* other HID usage */
175 switch (action
.usage
.page
) {
178 host_system_send(action
.usage
.code
);
185 host_consumer_send(action
.usage
.code
);
187 host_consumer_send(0);
193 #ifdef MOUSEKEY_ENABLE
197 mousekey_on(action
.key
.code
);
200 mousekey_off(action
.key
.code
);
205 #ifndef NO_ACTION_LAYER
207 if (action
.layer_bitop
.on
== 0) {
208 /* Default Layer Bitwise Operation */
209 if (!event
.pressed
) {
210 uint8_t shift
= action
.layer_bitop
.part
*4;
211 uint32_t bits
= ((uint32_t)action
.layer_bitop
.bits
)<<shift
;
212 uint32_t mask
= (action
.layer_bitop
.xbit
) ? ~(((uint32_t)0xf)<<shift
) : 0;
213 switch (action
.layer_bitop
.op
) {
214 case OP_BIT_AND
: default_layer_and(bits
| mask
); break;
215 case OP_BIT_OR
: default_layer_or(bits
| mask
); break;
216 case OP_BIT_XOR
: default_layer_xor(bits
| mask
); break;
217 case OP_BIT_SET
: default_layer_and(mask
); default_layer_or(bits
); break;
221 /* Layer Bitwise Operation */
222 if (event
.pressed
? (action
.layer_bitop
.on
& ON_PRESS
) :
223 (action
.layer_bitop
.on
& ON_RELEASE
)) {
224 uint8_t shift
= action
.layer_bitop
.part
*4;
225 uint32_t bits
= ((uint32_t)action
.layer_bitop
.bits
)<<shift
;
226 uint32_t mask
= (action
.layer_bitop
.xbit
) ? ~(((uint32_t)0xf)<<shift
) : 0;
227 switch (action
.layer_bitop
.op
) {
228 case OP_BIT_AND
: layer_and(bits
| mask
); break;
229 case OP_BIT_OR
: layer_or(bits
| mask
); break;
230 case OP_BIT_XOR
: layer_xor(bits
| mask
); break;
231 case OP_BIT_SET
: layer_and(mask
); layer_or(bits
); break;
236 #ifndef NO_ACTION_TAPPING
238 case ACT_LAYER_TAP_EXT
:
239 switch (action
.layer_tap
.code
) {
241 /* layer On/Off with modifiers(left only) */
243 layer_on(action
.layer_tap
.val
);
244 register_mods(action
.layer_tap
.code
& 0x0f);
246 layer_off(action
.layer_tap
.val
);
247 unregister_mods(action
.layer_tap
.code
& 0x0f);
253 if (tap_count
< TAPPING_TOGGLE
) {
254 layer_invert(action
.layer_tap
.val
);
257 if (tap_count
<= TAPPING_TOGGLE
) {
258 layer_invert(action
.layer_tap
.val
);
263 event
.pressed
? layer_on(action
.layer_tap
.val
) :
264 layer_off(action
.layer_tap
.val
);
267 event
.pressed
? layer_off(action
.layer_tap
.val
) :
268 layer_on(action
.layer_tap
.val
);
271 event
.pressed
? layer_move(action
.layer_tap
.val
) :
278 dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
279 register_code(action
.layer_tap
.code
);
281 dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
282 layer_on(action
.layer_tap
.val
);
286 dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
287 unregister_code(action
.layer_tap
.code
);
289 dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
290 layer_off(action
.layer_tap
.val
);
299 #ifndef NO_ACTION_MACRO
301 action_macro_play(action_get_macro(record
, action
.func
.id
, action
.func
.opt
));
304 #ifdef BACKLIGHT_ENABLE
306 if (!event
.pressed
) {
307 switch (action
.backlight
.opt
) {
308 case BACKLIGHT_INCREASE
:
309 backlight_increase();
311 case BACKLIGHT_DECREASE
:
312 backlight_decrease();
314 case BACKLIGHT_TOGGLE
:
320 case BACKLIGHT_LEVEL
:
321 backlight_level(action
.backlight
.level
);
329 #ifndef NO_ACTION_FUNCTION
331 action_function(record
, action
.func
.id
, action
.func
.opt
);
343 * Utilities for actions.
345 void register_code(uint8_t code
)
351 #ifdef LOCKING_SUPPORT_ENABLE
352 else if (KC_LOCKING_CAPS
== code
) {
353 #ifdef LOCKING_RESYNC_ENABLE
354 // Resync: ignore if caps lock already is on
355 if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK
)) return;
357 add_key(KC_CAPSLOCK
);
358 send_keyboard_report();
359 del_key(KC_CAPSLOCK
);
360 send_keyboard_report();
363 else if (KC_LOCKING_NUM
== code
) {
364 #ifdef LOCKING_RESYNC_ENABLE
365 if (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK
)) return;
368 send_keyboard_report();
370 send_keyboard_report();
373 else if (KC_LOCKING_SCROLL
== code
) {
374 #ifdef LOCKING_RESYNC_ENABLE
375 if (host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK
)) return;
377 add_key(KC_SCROLLLOCK
);
378 send_keyboard_report();
379 del_key(KC_SCROLLLOCK
);
380 send_keyboard_report();
384 else if IS_KEY(code
) {
385 // TODO: should push command_proc out of this block?
386 if (command_proc(code
)) return;
388 #ifndef NO_ACTION_ONESHOT
390 if (oneshot_state.mods && !oneshot_state.disabled) {
391 uint8_t tmp_mods = get_mods();
392 add_mods(oneshot_state.mods);
395 send_keyboard_report();
398 send_keyboard_report();
405 send_keyboard_report();
408 else if IS_MOD(code
) {
409 add_mods(MOD_BIT(code
));
410 send_keyboard_report();
412 else if IS_SYSTEM(code
) {
413 host_system_send(KEYCODE2SYSTEM(code
));
415 else if IS_CONSUMER(code
) {
416 host_consumer_send(KEYCODE2CONSUMER(code
));
420 void unregister_code(uint8_t code
)
426 #ifdef LOCKING_SUPPORT_ENABLE
427 else if (KC_LOCKING_CAPS
== code
) {
428 #ifdef LOCKING_RESYNC_ENABLE
429 // Resync: ignore if caps lock already is off
430 if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK
))) return;
432 add_key(KC_CAPSLOCK
);
433 send_keyboard_report();
434 del_key(KC_CAPSLOCK
);
435 send_keyboard_report();
438 else if (KC_LOCKING_NUM
== code
) {
439 #ifdef LOCKING_RESYNC_ENABLE
440 if (!(host_keyboard_leds() & (1<<USB_LED_NUM_LOCK
))) return;
443 send_keyboard_report();
445 send_keyboard_report();
448 else if (KC_LOCKING_SCROLL
== code
) {
449 #ifdef LOCKING_RESYNC_ENABLE
450 if (!(host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK
))) return;
452 add_key(KC_SCROLLLOCK
);
453 send_keyboard_report();
454 del_key(KC_SCROLLLOCK
);
455 send_keyboard_report();
459 else if IS_KEY(code
) {
461 send_keyboard_report();
463 else if IS_MOD(code
) {
464 del_mods(MOD_BIT(code
));
465 send_keyboard_report();
467 else if IS_SYSTEM(code
) {
470 else if IS_CONSUMER(code
) {
471 host_consumer_send(0);
475 void register_mods(uint8_t mods
)
479 send_keyboard_report();
483 void unregister_mods(uint8_t mods
)
487 send_keyboard_report();
491 void clear_keyboard(void)
494 clear_keyboard_but_mods();
497 void clear_keyboard_but_mods(void)
501 send_keyboard_report();
502 #ifdef MOUSEKEY_ENABLE
506 #ifdef EXTRAKEY_ENABLE
508 host_consumer_send(0);
512 bool is_tap_key(keypos_t key
)
514 action_t action
= layer_switch_get_action(key
);
516 switch (action
.kind
.id
) {
520 case ACT_LAYER_TAP_EXT
:
521 switch (action
.layer_tap
.code
) {
529 if (action
.func
.opt
& FUNC_TAP
) { return true; }
539 void debug_event(keyevent_t event
)
541 dprintf("%04X%c(%u)", (event
.key
.row
<<8 | event
.key
.col
), (event
.pressed
? 'd' : 'u'), event
.time
);
544 void debug_record(keyrecord_t record
)
546 debug_event(record
.event
);
547 #ifndef NO_ACTION_TAPPING
548 dprintf(":%u%c", record
.tap
.count
, (record
.tap
.interrupted
? '-' : ' '));
552 void debug_action(action_t action
)
554 switch (action
.kind
.id
) {
555 case ACT_LMODS
: dprint("ACT_LMODS"); break;
556 case ACT_RMODS
: dprint("ACT_RMODS"); break;
557 case ACT_LMODS_TAP
: dprint("ACT_LMODS_TAP"); break;
558 case ACT_RMODS_TAP
: dprint("ACT_RMODS_TAP"); break;
559 case ACT_USAGE
: dprint("ACT_USAGE"); break;
560 case ACT_MOUSEKEY
: dprint("ACT_MOUSEKEY"); break;
561 case ACT_LAYER
: dprint("ACT_LAYER"); break;
562 case ACT_LAYER_TAP
: dprint("ACT_LAYER_TAP"); break;
563 case ACT_LAYER_TAP_EXT
: dprint("ACT_LAYER_TAP_EXT"); break;
564 case ACT_MACRO
: dprint("ACT_MACRO"); break;
565 case ACT_COMMAND
: dprint("ACT_COMMAND"); break;
566 case ACT_FUNCTION
: dprint("ACT_FUNCTION"); break;
567 default: dprint("UNKNOWN"); break;
569 dprintf("[%X:%02X]", action
.kind
.param
>>8, action
.kind
.param
&0xff);