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/>.
24 #include "action_layer.h"
25 #include "action_tapping.h"
26 #include "action_oneshot.h"
27 #include "action_macro.h"
31 void action_exec(keyevent_t event)
33 if (!IS_NOEVENT(event)) {
34 debug("\n---- action_exec: start -----\n");
35 debug("EVENT: "); debug_event(event); debug("\n");
38 keyrecord_t record = { .event = event };
40 #ifndef NO_ACTION_TAPPING
41 action_tapping_process(record);
43 process_action(&record);
44 if (!IS_NOEVENT(record.event)) {
45 debug("processed: "); debug_record(record); debug("\n");
50 void process_action(keyrecord_t *record)
52 keyevent_t event = record->event;
53 #ifndef NO_ACTION_TAPPING
54 uint8_t tap_count = record->tap.count;
57 if (IS_NOEVENT(event)) { return; }
59 action_t action = layer_switch_get_action(event.key);
60 debug("ACTION: "); debug_action(action);
61 #ifndef NO_ACTION_LAYER
62 debug(" layer_state: "); layer_debug();
63 debug(" default_layer_state: "); default_layer_debug();
67 switch (action.kind.id) {
72 uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
77 host_send_keyboard_report();
79 register_code(action.key.code);
81 unregister_code(action.key.code);
84 host_send_keyboard_report();
89 #ifndef NO_ACTION_TAPPING
93 uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
95 switch (action.layer_tap.code) {
96 #ifndef NO_ACTION_ONESHOT
100 if (tap_count == 0) {
101 debug("MODS_TAP: Oneshot: add_mods\n");
104 else if (tap_count == 1) {
105 debug("MODS_TAP: Oneshot: start\n");
108 else if (tap_count == TAPPING_TOGGLE) {
109 debug("MODS_TAP: Oneshot: toggle\n");
113 debug("MODS_TAP: Oneshot: cancel&add_mods\n");
114 // double tap cancels oneshot and works as normal modifier.
119 if (tap_count == 0) {
120 debug("MODS_TAP: Oneshot: cancel/del_mods\n");
121 // cancel oneshot on hold
125 else if (tap_count == 1) {
126 debug("MODS_TAP: Oneshot: del_mods\n");
131 debug("MODS_TAP: Oneshot: del_mods\n");
141 if (record->tap.interrupted) {
142 debug("MODS_TAP: Tap: Cancel: add_mods\n");
143 // ad hoc: set 0 to cancel tap
144 record->tap.count = 0;
147 debug("MODS_TAP: Tap: register_code\n");
148 register_code(action.key.code);
151 debug("MODS_TAP: No tap: add_mods\n");
156 debug("MODS_TAP: Tap: unregister_code\n");
157 unregister_code(action.key.code);
159 debug("MODS_TAP: No tap: add_mods\n");
168 #ifdef EXTRAKEY_ENABLE
169 /* other HID usage */
171 switch (action.usage.page) {
174 host_system_send(action.usage.code);
181 host_consumer_send(action.usage.code);
183 host_consumer_send(0);
189 #ifdef MOUSEKEY_ENABLE
193 mousekey_on(action.key.code);
196 mousekey_off(action.key.code);
201 #ifndef NO_ACTION_LAYER
203 if (action.layer_bitop.on == 0) {
204 /* Default Layer Bitwise Operation */
205 if (!event.pressed) {
206 uint8_t shift = action.layer_bitop.part*4;
207 uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
208 uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
209 switch (action.layer_bitop.op) {
210 case OP_BIT_AND: default_layer_and(bits | mask); break;
211 case OP_BIT_OR: default_layer_or(bits | mask); break;
212 case OP_BIT_XOR: default_layer_xor(bits | mask); break;
213 case OP_BIT_SET: default_layer_and(mask); default_layer_or(bits); break;
217 /* Layer Bitwise Operation */
218 if (event.pressed ? (action.layer_bitop.on & ON_PRESS) :
219 (action.layer_bitop.on & ON_RELEASE)) {
220 uint8_t shift = action.layer_bitop.part*4;
221 uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
222 uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
223 switch (action.layer_bitop.op) {
224 case OP_BIT_AND: layer_and(bits | mask); break;
225 case OP_BIT_OR: layer_or(bits | mask); break;
226 case OP_BIT_XOR: layer_xor(bits | mask); break;
227 case OP_BIT_SET: layer_and(mask); layer_or(bits); break;
232 #ifndef NO_ACTION_TAPPING
235 switch (action.layer_tap.code) {
239 if (tap_count < TAPPING_TOGGLE) {
240 layer_invert(action.layer_tap.val);
243 if (tap_count <= TAPPING_TOGGLE) {
244 layer_invert(action.layer_tap.val);
249 event.pressed ? layer_on(action.layer_tap.val) :
250 layer_off(action.layer_tap.val);
253 event.pressed ? layer_off(action.layer_tap.val) :
254 layer_on(action.layer_tap.val);
257 event.pressed ? layer_move(action.layer_tap.val) :
264 debug("KEYMAP_TAP_KEY: Tap: register_code\n");
265 register_code(action.layer_tap.code);
267 debug("KEYMAP_TAP_KEY: No tap: On on press\n");
268 layer_on(action.layer_tap.val);
272 debug("KEYMAP_TAP_KEY: Tap: unregister_code\n");
273 unregister_code(action.layer_tap.code);
275 debug("KEYMAP_TAP_KEY: No tap: Off on release\n");
276 layer_off(action.layer_tap.val);
285 #ifndef NO_ACTION_MACRO
287 action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
292 #ifndef NO_ACTION_FUNCTION
294 action_function(record, action.func.id, action.func.opt);
306 * Utilities for actions.
308 void register_code(uint8_t code)
313 #ifdef CAPSLOCK_LOCKING_ENABLE
314 else if (KC_LOCKING_CAPS == code) {
315 #ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
316 // Resync: ignore if caps lock already is on
317 if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
319 host_add_key(KC_CAPSLOCK);
320 host_send_keyboard_report();
321 host_del_key(KC_CAPSLOCK);
322 host_send_keyboard_report();
325 else if IS_KEY(code) {
326 // TODO: should push command_proc out of this block?
327 if (command_proc(code)) return;
329 #ifndef NO_ACTION_ONESHOT
330 if (oneshot_state.mods && !oneshot_state.disabled) {
331 uint8_t tmp_mods = host_get_mods();
332 host_add_mods(oneshot_state.mods);
335 host_send_keyboard_report();
337 host_set_mods(tmp_mods);
343 host_send_keyboard_report();
346 else if IS_MOD(code) {
347 host_add_mods(MOD_BIT(code));
348 host_send_keyboard_report();
352 void unregister_code(uint8_t code)
357 #ifdef CAPSLOCK_LOCKING_ENABLE
358 else if (KC_LOCKING_CAPS == code) {
359 #ifdef CAPSLOCK_LOCKING_RESYNC_ENABLE
360 // Resync: ignore if caps lock already is off
361 if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
363 host_add_key(KC_CAPSLOCK);
364 host_send_keyboard_report();
365 host_del_key(KC_CAPSLOCK);
366 host_send_keyboard_report();
369 else if IS_KEY(code) {
371 host_send_keyboard_report();
373 else if IS_MOD(code) {
374 host_del_mods(MOD_BIT(code));
375 host_send_keyboard_report();
379 void add_mods(uint8_t mods)
383 host_send_keyboard_report();
387 void del_mods(uint8_t mods)
391 host_send_keyboard_report();
395 void set_mods(uint8_t mods)
398 host_send_keyboard_report();
401 void clear_keyboard(void)
404 clear_keyboard_but_mods();
407 void clear_keyboard_but_mods(void)
410 host_send_keyboard_report();
411 #ifdef MOUSEKEY_ENABLE
415 #ifdef EXTRAKEY_ENABLE
417 host_consumer_send(0);
421 bool sending_anykey(void)
423 return (host_has_anykey() || host_mouse_in_use() ||
424 host_last_sysytem_report() || host_last_consumer_report());
427 bool is_tap_key(key_t key)
429 action_t action = layer_switch_get_action(key);
431 switch (action.kind.id) {
439 if (action.func.opt & FUNC_TAP) { return true; }
449 void debug_event(keyevent_t event)
451 debug_hex16((event.key.row<<8) | event.key.col);
452 if (event.pressed) debug("d("); else debug("u(");
453 debug_dec(event.time); debug(")");
456 void debug_record(keyrecord_t record)
458 debug_event(record.event);
459 #ifndef NO_ACTION_TAPPING
460 debug(":"); debug_dec(record.tap.count);
461 if (record.tap.interrupted) debug("-");
465 void debug_action(action_t action)
467 switch (action.kind.id) {
468 case ACT_LMODS: debug("ACT_LMODS"); break;
469 case ACT_RMODS: debug("ACT_RMODS"); break;
470 case ACT_LMODS_TAP: debug("ACT_LMODS_TAP"); break;
471 case ACT_RMODS_TAP: debug("ACT_RMODS_TAP"); break;
472 case ACT_USAGE: debug("ACT_USAGE"); break;
473 case ACT_MOUSEKEY: debug("ACT_MOUSEKEY"); break;
474 case ACT_LAYER: debug("ACT_LAYER"); break;
475 case ACT_LAYER_TAP: debug("ACT_LAYER_TAP"); break;
476 case ACT_LAYER_TAP1: debug("ACT_LAYER_TAP1"); break;
477 case ACT_MACRO: debug("ACT_MACRO"); break;
478 case ACT_COMMAND: debug("ACT_COMMAND"); break;
479 case ACT_FUNCTION: debug("ACT_FUNCTION"); break;
480 default: debug("UNKNOWN"); break;
483 debug_hex4(action.kind.param>>8);
485 debug_hex8(action.kind.param & 0xff);