action_layer.c 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
  1. #include <stdint.h>
  2. #include "keyboard.h"
  3. #include "action.h"
  4. #include "util.h"
  5. #include "action_layer.h"
  6. #ifdef DEBUG_ACTION
  7. #include "debug.h"
  8. #else
  9. #include "nodebug.h"
  10. #endif
  11. /** \brief Default Layer State
  12. */
  13. uint32_t default_layer_state = 0;
  14. /** \brief Default Layer State Set At user Level
  15. *
  16. * FIXME: Needs docs
  17. */
  18. __attribute__((weak))
  19. uint32_t default_layer_state_set_user(uint32_t state) {
  20. return state;
  21. }
  22. /** \brief Default Layer State Set At Keyboard Level
  23. *
  24. * FIXME: Needs docs
  25. */
  26. __attribute__((weak))
  27. uint32_t default_layer_state_set_kb(uint32_t state) {
  28. return default_layer_state_set_user(state);
  29. }
  30. /** \brief Default Layer State Set
  31. *
  32. * FIXME: Needs docs
  33. */
  34. static void default_layer_state_set(uint32_t state)
  35. {
  36. state = default_layer_state_set_kb(state);
  37. debug("default_layer_state: ");
  38. default_layer_debug(); debug(" to ");
  39. default_layer_state = state;
  40. default_layer_debug(); debug("\n");
  41. clear_keyboard_but_mods(); // To avoid stuck keys
  42. }
  43. /** \brief Default Layer Print
  44. *
  45. * FIXME: Needs docs
  46. */
  47. void default_layer_debug(void)
  48. {
  49. dprintf("%08lX(%u)", default_layer_state, biton32(default_layer_state));
  50. }
  51. /** \brief Default Layer Set
  52. *
  53. * FIXME: Needs docs
  54. */
  55. void default_layer_set(uint32_t state)
  56. {
  57. default_layer_state_set(state);
  58. }
  59. #ifndef NO_ACTION_LAYER
  60. /** \brief Default Layer Or
  61. *
  62. * FIXME: Needs docs
  63. */
  64. void default_layer_or(uint32_t state)
  65. {
  66. default_layer_state_set(default_layer_state | state);
  67. }
  68. /** \brief Default Layer And
  69. *
  70. * FIXME: Needs docs
  71. */
  72. void default_layer_and(uint32_t state)
  73. {
  74. default_layer_state_set(default_layer_state & state);
  75. }
  76. /** \brief Default Layer Xor
  77. *
  78. * FIXME: Needs docs
  79. */
  80. void default_layer_xor(uint32_t state)
  81. {
  82. default_layer_state_set(default_layer_state ^ state);
  83. }
  84. #endif
  85. #ifndef NO_ACTION_LAYER
  86. /** \brief Keymap Layer State
  87. */
  88. uint32_t layer_state = 0;
  89. /** \brief Layer state set user
  90. *
  91. * FIXME: Needs docs
  92. */
  93. __attribute__((weak))
  94. uint32_t layer_state_set_user(uint32_t state) {
  95. return state;
  96. }
  97. /** \brief Layer state set keyboard
  98. *
  99. * FIXME: Needs docs
  100. */
  101. __attribute__((weak))
  102. uint32_t layer_state_set_kb(uint32_t state) {
  103. return layer_state_set_user(state);
  104. }
  105. /** \brief Layer state set
  106. *
  107. * FIXME: Needs docs
  108. */
  109. void layer_state_set(uint32_t state)
  110. {
  111. state = layer_state_set_kb(state);
  112. dprint("layer_state: ");
  113. layer_debug(); dprint(" to ");
  114. layer_state = state;
  115. layer_debug(); dprintln();
  116. clear_keyboard_but_mods(); // To avoid stuck keys
  117. }
  118. /** \brief Layer clear
  119. *
  120. * FIXME: Needs docs
  121. */
  122. void layer_clear(void)
  123. {
  124. layer_state_set(0);
  125. }
  126. /** \brief Layer state is
  127. *
  128. * FIXME: Needs docs
  129. */
  130. bool layer_state_is(uint8_t layer)
  131. {
  132. return layer_state_cmp(layer_state, layer);
  133. }
  134. /** \brief Layer state compare
  135. *
  136. * FIXME: Needs docs
  137. */
  138. bool layer_state_cmp(uint32_t cmp_layer_state, uint8_t layer) {
  139. if (!cmp_layer_state) { return layer == 0; }
  140. return (cmp_layer_state & (1UL<<layer)) != 0;
  141. }
  142. /** \brief Layer move
  143. *
  144. * FIXME: Needs docs
  145. */
  146. void layer_move(uint8_t layer)
  147. {
  148. layer_state_set(1UL<<layer);
  149. }
  150. /** \brief Layer on
  151. *
  152. * FIXME: Needs docs
  153. */
  154. void layer_on(uint8_t layer)
  155. {
  156. layer_state_set(layer_state | (1UL<<layer));
  157. }
  158. /** \brief Layer off
  159. *
  160. * FIXME: Needs docs
  161. */
  162. void layer_off(uint8_t layer)
  163. {
  164. layer_state_set(layer_state & ~(1UL<<layer));
  165. }
  166. /** \brief Layer invert
  167. *
  168. * FIXME: Needs docs
  169. */
  170. void layer_invert(uint8_t layer)
  171. {
  172. layer_state_set(layer_state ^ (1UL<<layer));
  173. }
  174. /** \brief Layer or
  175. *
  176. * FIXME: Needs docs
  177. */
  178. void layer_or(uint32_t state)
  179. {
  180. layer_state_set(layer_state | state);
  181. }
  182. /** \brief Layer and
  183. *
  184. * FIXME: Needs docs
  185. */
  186. void layer_and(uint32_t state)
  187. {
  188. layer_state_set(layer_state & state);
  189. }
  190. /** \brief Layer xor
  191. *
  192. * FIXME: Needs docs
  193. */
  194. void layer_xor(uint32_t state)
  195. {
  196. layer_state_set(layer_state ^ state);
  197. }
  198. /** \brief Layer debug printing
  199. *
  200. * FIXME: Needs docs
  201. */
  202. void layer_debug(void)
  203. {
  204. dprintf("%08lX(%u)", layer_state, biton32(layer_state));
  205. }
  206. #endif
  207. #if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
  208. uint8_t source_layers_cache[(MATRIX_ROWS * MATRIX_COLS + 7) / 8][MAX_LAYER_BITS] = {{0}};
  209. void update_source_layers_cache(keypos_t key, uint8_t layer)
  210. {
  211. const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
  212. const uint8_t storage_row = key_number / 8;
  213. const uint8_t storage_bit = key_number % 8;
  214. for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
  215. source_layers_cache[storage_row][bit_number] ^=
  216. (-((layer & (1U << bit_number)) != 0)
  217. ^ source_layers_cache[storage_row][bit_number])
  218. & (1U << storage_bit);
  219. }
  220. }
  221. uint8_t read_source_layers_cache(keypos_t key)
  222. {
  223. const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
  224. const uint8_t storage_row = key_number / 8;
  225. const uint8_t storage_bit = key_number % 8;
  226. uint8_t layer = 0;
  227. for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
  228. layer |=
  229. ((source_layers_cache[storage_row][bit_number]
  230. & (1U << storage_bit)) != 0)
  231. << bit_number;
  232. }
  233. return layer;
  234. }
  235. #endif
  236. /** \brief Store or get action (FIXME: Needs better summary)
  237. *
  238. * Make sure the action triggered when the key is released is the same
  239. * one as the one triggered on press. It's important for the mod keys
  240. * when the layer is switched after the down event but before the up
  241. * event as they may get stuck otherwise.
  242. */
  243. action_t store_or_get_action(bool pressed, keypos_t key)
  244. {
  245. #if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
  246. if (disable_action_cache) {
  247. return layer_switch_get_action(key);
  248. }
  249. uint8_t layer;
  250. if (pressed) {
  251. layer = layer_switch_get_layer(key);
  252. update_source_layers_cache(key, layer);
  253. }
  254. else {
  255. layer = read_source_layers_cache(key);
  256. }
  257. return action_for_key(layer, key);
  258. #else
  259. return layer_switch_get_action(key);
  260. #endif
  261. }
  262. /** \brief Layer switch get layer
  263. *
  264. * FIXME: Needs docs
  265. */
  266. int8_t layer_switch_get_layer(keypos_t key)
  267. {
  268. #ifndef NO_ACTION_LAYER
  269. action_t action;
  270. action.code = ACTION_TRANSPARENT;
  271. uint32_t layers = layer_state | default_layer_state;
  272. /* check top layer first */
  273. for (int8_t i = 31; i >= 0; i--) {
  274. if (layers & (1UL<<i)) {
  275. action = action_for_key(i, key);
  276. if (action.code != ACTION_TRANSPARENT) {
  277. return i;
  278. }
  279. }
  280. }
  281. /* fall back to layer 0 */
  282. return 0;
  283. #else
  284. return biton32(default_layer_state);
  285. #endif
  286. }
  287. /** \brief Layer switch get layer
  288. *
  289. * FIXME: Needs docs
  290. */
  291. action_t layer_switch_get_action(keypos_t key)
  292. {
  293. return action_for_key(layer_switch_get_layer(key), key);
  294. }