Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
Este repositório está arquivado. Você pode visualizar os arquivos e realizar clone, mas não poderá realizar push nem abrir issues e pull requests.

action.c 18KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566
  1. /*
  2. Copyright 2012,2013 Jun Wako <[email protected]>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. #include "host.h"
  15. #include "keycode.h"
  16. #include "keyboard.h"
  17. #include "mousekey.h"
  18. #include "command.h"
  19. #include "led.h"
  20. #include "backlight.h"
  21. #include "action_layer.h"
  22. #include "action_tapping.h"
  23. #include "action_macro.h"
  24. #include "action_util.h"
  25. #include "action.h"
  26. #ifdef DEBUG_ACTION
  27. #include "debug.h"
  28. #else
  29. #include "nodebug.h"
  30. #endif
  31. void action_exec(keyevent_t event)
  32. {
  33. if (!IS_NOEVENT(event)) {
  34. dprint("\n---- action_exec: start -----\n");
  35. dprint("EVENT: "); debug_event(event); dprintln();
  36. }
  37. keyrecord_t record = { .event = event };
  38. action_keyevent(event);
  39. #ifndef NO_ACTION_TAPPING
  40. action_tapping_process(record);
  41. #else
  42. process_action(&record);
  43. if (!IS_NOEVENT(record.event)) {
  44. dprint("processed: "); debug_record(record); dprintln();
  45. }
  46. #endif
  47. }
  48. void process_action(keyrecord_t *record)
  49. {
  50. keyevent_t event = record->event;
  51. #ifndef NO_ACTION_TAPPING
  52. uint8_t tap_count = record->tap.count;
  53. #endif
  54. if (IS_NOEVENT(event)) { return; }
  55. action_t action = layer_switch_get_action(event.key);
  56. dprint("ACTION: "); debug_action(action);
  57. #ifndef NO_ACTION_LAYER
  58. dprint(" layer_state: "); layer_debug();
  59. dprint(" default_layer_state: "); default_layer_debug();
  60. #endif
  61. dprintln();
  62. switch (action.kind.id) {
  63. /* Key and Mods */
  64. case ACT_LMODS:
  65. case ACT_RMODS:
  66. {
  67. uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
  68. action.key.mods<<4;
  69. if (event.pressed) {
  70. if (mods) {
  71. add_weak_mods(mods);
  72. send_keyboard_report();
  73. }
  74. register_code(action.key.code);
  75. } else {
  76. unregister_code(action.key.code);
  77. if (mods) {
  78. del_weak_mods(mods);
  79. send_keyboard_report();
  80. }
  81. }
  82. }
  83. break;
  84. #ifndef NO_ACTION_TAPPING
  85. case ACT_LMODS_TAP:
  86. case ACT_RMODS_TAP:
  87. {
  88. uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
  89. action.key.mods<<4;
  90. switch (action.layer_tap.code) {
  91. #ifndef NO_ACTION_ONESHOT
  92. case MODS_ONESHOT:
  93. // Oneshot modifier
  94. if (event.pressed) {
  95. if (tap_count == 0) {
  96. register_mods(mods);
  97. }
  98. else if (tap_count == 1) {
  99. dprint("MODS_TAP: Oneshot: start\n");
  100. set_oneshot_mods(mods);
  101. }
  102. else {
  103. register_mods(mods);
  104. }
  105. } else {
  106. if (tap_count == 0) {
  107. clear_oneshot_mods();
  108. unregister_mods(mods);
  109. }
  110. else if (tap_count == 1) {
  111. // Retain Oneshot mods
  112. }
  113. else {
  114. clear_oneshot_mods();
  115. unregister_mods(mods);
  116. }
  117. }
  118. break;
  119. #endif
  120. case MODS_TAP_TOGGLE:
  121. if (event.pressed) {
  122. if (tap_count <= TAPPING_TOGGLE) {
  123. register_mods(mods);
  124. }
  125. } else {
  126. if (tap_count < TAPPING_TOGGLE) {
  127. unregister_mods(mods);
  128. }
  129. }
  130. break;
  131. default:
  132. if (event.pressed) {
  133. if (tap_count > 0) {
  134. if (record->tap.interrupted) {
  135. dprint("MODS_TAP: Tap: Cancel: add_mods\n");
  136. // ad hoc: set 0 to cancel tap
  137. record->tap.count = 0;
  138. register_mods(mods);
  139. } else {
  140. dprint("MODS_TAP: Tap: register_code\n");
  141. register_code(action.key.code);
  142. }
  143. } else {
  144. dprint("MODS_TAP: No tap: add_mods\n");
  145. register_mods(mods);
  146. }
  147. } else {
  148. if (tap_count > 0) {
  149. dprint("MODS_TAP: Tap: unregister_code\n");
  150. unregister_code(action.key.code);
  151. } else {
  152. dprint("MODS_TAP: No tap: add_mods\n");
  153. unregister_mods(mods);
  154. }
  155. }
  156. break;
  157. }
  158. }
  159. break;
  160. #endif
  161. #ifdef EXTRAKEY_ENABLE
  162. /* other HID usage */
  163. case ACT_USAGE:
  164. switch (action.usage.page) {
  165. case PAGE_SYSTEM:
  166. if (event.pressed) {
  167. host_system_send(action.usage.code);
  168. } else {
  169. host_system_send(0);
  170. }
  171. break;
  172. case PAGE_CONSUMER:
  173. if (event.pressed) {
  174. host_consumer_send(action.usage.code);
  175. } else {
  176. host_consumer_send(0);
  177. }
  178. break;
  179. }
  180. break;
  181. #endif
  182. #ifdef MOUSEKEY_ENABLE
  183. /* Mouse key */
  184. case ACT_MOUSEKEY:
  185. if (event.pressed) {
  186. mousekey_on(action.key.code);
  187. mousekey_send();
  188. } else {
  189. mousekey_off(action.key.code);
  190. mousekey_send();
  191. }
  192. break;
  193. #endif
  194. #ifndef NO_ACTION_LAYER
  195. case ACT_LAYER:
  196. if (action.layer_bitop.on == 0) {
  197. /* Default Layer Bitwise Operation */
  198. if (!event.pressed) {
  199. uint8_t shift = action.layer_bitop.part*4;
  200. uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
  201. uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
  202. switch (action.layer_bitop.op) {
  203. case OP_BIT_AND: default_layer_and(bits | mask); break;
  204. case OP_BIT_OR: default_layer_or(bits | mask); break;
  205. case OP_BIT_XOR: default_layer_xor(bits | mask); break;
  206. case OP_BIT_SET: default_layer_and(mask); default_layer_or(bits); break;
  207. }
  208. }
  209. } else {
  210. /* Layer Bitwise Operation */
  211. if (event.pressed ? (action.layer_bitop.on & ON_PRESS) :
  212. (action.layer_bitop.on & ON_RELEASE)) {
  213. uint8_t shift = action.layer_bitop.part*4;
  214. uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
  215. uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
  216. switch (action.layer_bitop.op) {
  217. case OP_BIT_AND: layer_and(bits | mask); break;
  218. case OP_BIT_OR: layer_or(bits | mask); break;
  219. case OP_BIT_XOR: layer_xor(bits | mask); break;
  220. case OP_BIT_SET: layer_and(mask); layer_or(bits); break;
  221. }
  222. }
  223. }
  224. break;
  225. #ifndef NO_ACTION_TAPPING
  226. case ACT_LAYER_TAP:
  227. case ACT_LAYER_TAP_EXT:
  228. switch (action.layer_tap.code) {
  229. case OP_TAP_TOGGLE:
  230. /* tap toggle */
  231. if (event.pressed) {
  232. if (tap_count < TAPPING_TOGGLE) {
  233. layer_invert(action.layer_tap.val);
  234. }
  235. } else {
  236. if (tap_count <= TAPPING_TOGGLE) {
  237. layer_invert(action.layer_tap.val);
  238. }
  239. }
  240. break;
  241. case OP_ON_OFF:
  242. event.pressed ? layer_on(action.layer_tap.val) :
  243. layer_off(action.layer_tap.val);
  244. break;
  245. case OP_OFF_ON:
  246. event.pressed ? layer_off(action.layer_tap.val) :
  247. layer_on(action.layer_tap.val);
  248. break;
  249. case OP_SET_CLEAR:
  250. event.pressed ? layer_move(action.layer_tap.val) :
  251. layer_clear();
  252. break;
  253. default:
  254. /* tap key */
  255. if (event.pressed) {
  256. if (tap_count > 0) {
  257. dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
  258. register_code(action.layer_tap.code);
  259. } else {
  260. dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
  261. layer_on(action.layer_tap.val);
  262. }
  263. } else {
  264. if (tap_count > 0) {
  265. dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
  266. unregister_code(action.layer_tap.code);
  267. } else {
  268. dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
  269. layer_off(action.layer_tap.val);
  270. }
  271. }
  272. break;
  273. }
  274. break;
  275. #endif
  276. #endif
  277. /* Extentions */
  278. #ifndef NO_ACTION_MACRO
  279. case ACT_MACRO:
  280. action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
  281. break;
  282. #endif
  283. #ifdef BACKLIGHT_ENABLE
  284. case ACT_BACKLIGHT:
  285. if (!event.pressed) {
  286. /* Backwards compatibility */
  287. if (action.backlight.level != 0 && action.backlight.opt != BACKLIGHT_LEVEL) {
  288. action.backlight.opt = action.backlight.level;
  289. }
  290. switch (action.backlight.opt) {
  291. case BACKLIGHT_INCREASE:
  292. backlight_increase();
  293. break;
  294. case BACKLIGHT_DECREASE:
  295. backlight_decrease();
  296. break;
  297. case BACKLIGHT_TOGGLE:
  298. backlight_toggle();
  299. break;
  300. case BACKLIGHT_STEP:
  301. backlight_step();
  302. break;
  303. case BACKLIGHT_LEVEL:
  304. backlight_level(action.backlight.level);
  305. break;
  306. }
  307. }
  308. break;
  309. #endif
  310. case ACT_COMMAND:
  311. break;
  312. #ifndef NO_ACTION_FUNCTION
  313. case ACT_FUNCTION:
  314. action_function(record, action.func.id, action.func.opt);
  315. break;
  316. #endif
  317. default:
  318. break;
  319. }
  320. }
  321. /*
  322. * Utilities for actions.
  323. */
  324. void register_code(uint8_t code)
  325. {
  326. if (code == KC_NO) {
  327. return;
  328. }
  329. #ifdef LOCKING_SUPPORT_ENABLE
  330. else if (KC_LOCKING_CAPS == code) {
  331. #ifdef LOCKING_RESYNC_ENABLE
  332. // Resync: ignore if caps lock already is on
  333. if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
  334. #endif
  335. add_key(KC_CAPSLOCK);
  336. send_keyboard_report();
  337. del_key(KC_CAPSLOCK);
  338. send_keyboard_report();
  339. }
  340. else if (KC_LOCKING_NUM == code) {
  341. #ifdef LOCKING_RESYNC_ENABLE
  342. if (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) return;
  343. #endif
  344. add_key(KC_NUMLOCK);
  345. send_keyboard_report();
  346. del_key(KC_NUMLOCK);
  347. send_keyboard_report();
  348. }
  349. else if (KC_LOCKING_SCROLL == code) {
  350. #ifdef LOCKING_RESYNC_ENABLE
  351. if (host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK)) return;
  352. #endif
  353. add_key(KC_SCROLLLOCK);
  354. send_keyboard_report();
  355. del_key(KC_SCROLLLOCK);
  356. send_keyboard_report();
  357. }
  358. #endif
  359. else if IS_KEY(code) {
  360. // TODO: should push command_proc out of this block?
  361. if (command_proc(code)) return;
  362. #ifndef NO_ACTION_ONESHOT
  363. /* TODO: remove
  364. if (oneshot_state.mods && !oneshot_state.disabled) {
  365. uint8_t tmp_mods = get_mods();
  366. add_mods(oneshot_state.mods);
  367. add_key(code);
  368. send_keyboard_report();
  369. set_mods(tmp_mods);
  370. send_keyboard_report();
  371. oneshot_cancel();
  372. } else
  373. */
  374. #endif
  375. {
  376. add_key(code);
  377. send_keyboard_report();
  378. }
  379. }
  380. else if IS_MOD(code) {
  381. add_mods(MOD_BIT(code));
  382. send_keyboard_report();
  383. }
  384. else if IS_SYSTEM(code) {
  385. host_system_send(KEYCODE2SYSTEM(code));
  386. }
  387. else if IS_CONSUMER(code) {
  388. host_consumer_send(KEYCODE2CONSUMER(code));
  389. }
  390. }
  391. void unregister_code(uint8_t code)
  392. {
  393. if (code == KC_NO) {
  394. return;
  395. }
  396. #ifdef LOCKING_SUPPORT_ENABLE
  397. else if (KC_LOCKING_CAPS == code) {
  398. #ifdef LOCKING_RESYNC_ENABLE
  399. // Resync: ignore if caps lock already is off
  400. if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
  401. #endif
  402. add_key(KC_CAPSLOCK);
  403. send_keyboard_report();
  404. del_key(KC_CAPSLOCK);
  405. send_keyboard_report();
  406. }
  407. else if (KC_LOCKING_NUM == code) {
  408. #ifdef LOCKING_RESYNC_ENABLE
  409. if (!(host_keyboard_leds() & (1<<USB_LED_NUM_LOCK))) return;
  410. #endif
  411. add_key(KC_NUMLOCK);
  412. send_keyboard_report();
  413. del_key(KC_NUMLOCK);
  414. send_keyboard_report();
  415. }
  416. else if (KC_LOCKING_SCROLL == code) {
  417. #ifdef LOCKING_RESYNC_ENABLE
  418. if (!(host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK))) return;
  419. #endif
  420. add_key(KC_SCROLLLOCK);
  421. send_keyboard_report();
  422. del_key(KC_SCROLLLOCK);
  423. send_keyboard_report();
  424. }
  425. #endif
  426. else if IS_KEY(code) {
  427. del_key(code);
  428. send_keyboard_report();
  429. }
  430. else if IS_MOD(code) {
  431. del_mods(MOD_BIT(code));
  432. send_keyboard_report();
  433. }
  434. else if IS_SYSTEM(code) {
  435. host_system_send(0);
  436. }
  437. else if IS_CONSUMER(code) {
  438. host_consumer_send(0);
  439. }
  440. }
  441. void register_mods(uint8_t mods)
  442. {
  443. if (mods) {
  444. add_mods(mods);
  445. send_keyboard_report();
  446. }
  447. }
  448. void unregister_mods(uint8_t mods)
  449. {
  450. if (mods) {
  451. del_mods(mods);
  452. send_keyboard_report();
  453. }
  454. }
  455. void clear_keyboard(void)
  456. {
  457. clear_mods();
  458. clear_keyboard_but_mods();
  459. }
  460. void clear_keyboard_but_mods(void)
  461. {
  462. clear_weak_mods();
  463. clear_keys();
  464. send_keyboard_report();
  465. #ifdef MOUSEKEY_ENABLE
  466. mousekey_clear();
  467. mousekey_send();
  468. #endif
  469. #ifdef EXTRAKEY_ENABLE
  470. host_system_send(0);
  471. host_consumer_send(0);
  472. #endif
  473. }
  474. bool is_tap_key(key_t key)
  475. {
  476. action_t action = layer_switch_get_action(key);
  477. switch (action.kind.id) {
  478. case ACT_LMODS_TAP:
  479. case ACT_RMODS_TAP:
  480. case ACT_LAYER_TAP:
  481. case ACT_LAYER_TAP_EXT:
  482. return true;
  483. case ACT_MACRO:
  484. case ACT_FUNCTION:
  485. if (action.func.opt & FUNC_TAP) { return true; }
  486. return false;
  487. }
  488. return false;
  489. }
  490. /*
  491. * debug print
  492. */
  493. void debug_event(keyevent_t event)
  494. {
  495. dprintf("%04X%c(%u)", (event.key.row<<8 | event.key.col), (event.pressed ? 'd' : 'u'), event.time);
  496. }
  497. void debug_record(keyrecord_t record)
  498. {
  499. debug_event(record.event);
  500. #ifndef NO_ACTION_TAPPING
  501. dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
  502. #endif
  503. }
  504. void debug_action(action_t action)
  505. {
  506. switch (action.kind.id) {
  507. case ACT_LMODS: dprint("ACT_LMODS"); break;
  508. case ACT_RMODS: dprint("ACT_RMODS"); break;
  509. case ACT_LMODS_TAP: dprint("ACT_LMODS_TAP"); break;
  510. case ACT_RMODS_TAP: dprint("ACT_RMODS_TAP"); break;
  511. case ACT_USAGE: dprint("ACT_USAGE"); break;
  512. case ACT_MOUSEKEY: dprint("ACT_MOUSEKEY"); break;
  513. case ACT_LAYER: dprint("ACT_LAYER"); break;
  514. case ACT_LAYER_TAP: dprint("ACT_LAYER_TAP"); break;
  515. case ACT_LAYER_TAP_EXT: dprint("ACT_LAYER_TAP_EXT"); break;
  516. case ACT_MACRO: dprint("ACT_MACRO"); break;
  517. case ACT_COMMAND: dprint("ACT_COMMAND"); break;
  518. case ACT_FUNCTION: dprint("ACT_FUNCTION"); break;
  519. default: dprint("UNKNOWN"); break;
  520. }
  521. dprintf("[%X:%02X]", action.kind.param>>8, action.kind.param&0xff);
  522. }
  523. __attribute__ ((weak))
  524. void action_keyevent(keyevent_t event)
  525. {
  526. }