5 #include "action_layer.h"
14 /** \brief Default Layer State
16 uint32_t default_layer_state = 0;
18 /** \brief Default Layer State Set At Keyboard Level
23 uint32_t default_layer_state_set_kb(uint32_t state) {
27 /** \brief Default Layer State Set
31 static void default_layer_state_set(uint32_t state)
33 state = default_layer_state_set_kb(state);
34 debug("default_layer_state: ");
35 default_layer_debug(); debug(" to ");
36 default_layer_state = state;
37 default_layer_debug(); debug("\n");
38 clear_keyboard_but_mods(); // To avoid stuck keys
41 /** \brief Default Layer Print
45 void default_layer_debug(void)
47 dprintf("%08lX(%u)", default_layer_state, biton32(default_layer_state));
50 /** \brief Default Layer Set
54 void default_layer_set(uint32_t state)
56 default_layer_state_set(state);
59 #ifndef NO_ACTION_LAYER
60 /** \brief Default Layer Or
64 void default_layer_or(uint32_t state)
66 default_layer_state_set(default_layer_state | state);
68 /** \brief Default Layer And
72 void default_layer_and(uint32_t state)
74 default_layer_state_set(default_layer_state & state);
76 /** \brief Default Layer Xor
80 void default_layer_xor(uint32_t state)
82 default_layer_state_set(default_layer_state ^ state);
87 #ifndef NO_ACTION_LAYER
88 /** \brief Keymap Layer State
90 uint32_t layer_state = 0;
92 /** \brief Layer state set user
97 uint32_t layer_state_set_user(uint32_t state) {
101 /** \brief Layer state set keyboard
105 __attribute__((weak))
106 uint32_t layer_state_set_kb(uint32_t state) {
107 return layer_state_set_user(state);
110 /** \brief Layer state set
114 void layer_state_set(uint32_t state)
116 state = layer_state_set_kb(state);
117 dprint("layer_state: ");
118 layer_debug(); dprint(" to ");
120 layer_debug(); dprintln();
121 clear_keyboard_but_mods(); // To avoid stuck keys
124 /** \brief Layer clear
128 void layer_clear(void)
133 /** \brief Layer state is
137 bool layer_state_is(uint8_t layer)
139 return layer_state_cmp(layer_state, layer);
142 /** \brief Layer state compare
146 bool layer_state_cmp(uint32_t cmp_layer_state, uint8_t layer) {
147 if (!cmp_layer_state) { return layer == 0; }
148 return (cmp_layer_state & (1UL<<layer)) != 0;
151 /** \brief Layer move
155 void layer_move(uint8_t layer)
157 layer_state_set(1UL<<layer);
164 void layer_on(uint8_t layer)
166 layer_state_set(layer_state | (1UL<<layer));
173 void layer_off(uint8_t layer)
175 layer_state_set(layer_state & ~(1UL<<layer));
178 /** \brief Layer invert
182 void layer_invert(uint8_t layer)
184 layer_state_set(layer_state ^ (1UL<<layer));
191 void layer_or(uint32_t state)
193 layer_state_set(layer_state | state);
199 void layer_and(uint32_t state)
201 layer_state_set(layer_state & state);
207 void layer_xor(uint32_t state)
209 layer_state_set(layer_state ^ state);
212 /** \brief Layer debug printing
216 void layer_debug(void)
218 dprintf("%08lX(%u)", layer_state, biton32(layer_state));
222 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
223 uint8_t source_layers_cache[(MATRIX_ROWS * MATRIX_COLS + 7) / 8][MAX_LAYER_BITS] = {{0}};
225 void update_source_layers_cache(keypos_t key, uint8_t layer)
227 const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
228 const uint8_t storage_row = key_number / 8;
229 const uint8_t storage_bit = key_number % 8;
231 for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
232 source_layers_cache[storage_row][bit_number] ^=
233 (-((layer & (1U << bit_number)) != 0)
234 ^ source_layers_cache[storage_row][bit_number])
235 & (1U << storage_bit);
239 uint8_t read_source_layers_cache(keypos_t key)
241 const uint8_t key_number = key.col + (key.row * MATRIX_COLS);
242 const uint8_t storage_row = key_number / 8;
243 const uint8_t storage_bit = key_number % 8;
246 for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
248 ((source_layers_cache[storage_row][bit_number]
249 & (1U << storage_bit)) != 0)
257 /** \brief Store or get action (FIXME: Needs better summary)
259 * Make sure the action triggered when the key is released is the same
260 * one as the one triggered on press. It's important for the mod keys
261 * when the layer is switched after the down event but before the up
262 * event as they may get stuck otherwise.
264 action_t store_or_get_action(bool pressed, keypos_t key)
266 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
267 if (disable_action_cache) {
268 return layer_switch_get_action(key);
274 layer = layer_switch_get_layer(key);
275 update_source_layers_cache(key, layer);
278 layer = read_source_layers_cache(key);
280 return action_for_key(layer, key);
282 return layer_switch_get_action(key);
287 /** \brief Layer switch get layer
291 int8_t layer_switch_get_layer(keypos_t key)
293 #ifndef NO_ACTION_LAYER
295 action.code = ACTION_TRANSPARENT;
297 uint32_t layers = layer_state | default_layer_state;
298 /* check top layer first */
299 for (int8_t i = 31; i >= 0; i--) {
300 if (layers & (1UL<<i)) {
301 action = action_for_key(i, key);
302 if (action.code != ACTION_TRANSPARENT) {
307 /* fall back to layer 0 */
310 return biton32(default_layer_state);
314 /** \brief Layer switch get layer
318 action_t layer_switch_get_action(keypos_t key)
320 return action_for_key(layer_switch_get_layer(key), key);