tmk_core/common/action_layer.c

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