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 /** \brief Default Layer State
  15  */
  16 uint32_t default_layer_state = 0;
  17
  18 /** \brief Default Layer State Set At Keyboard Level
  19  *
  20  * FIXME: Needs docs
  21  */
  22 __attribute__((weak))
  23 uint32_t default_layer_state_set_kb(uint32_t state) {
  24     return state;
  25 }
  26
  27 /** \brief Default Layer State Set
  28  *
  29  * FIXME: Needs docs
  30  */
  31 static void default_layer_state_set(uint32_t state)
  32 {
  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
  39 }
  40
  41 /** \brief Default Layer Print
  42  *
  43  * FIXME: Needs docs
  44  */
  45 void default_layer_debug(void)
  46 {
  47     dprintf("%08lX(%u)", default_layer_state, biton32(default_layer_state));
  48 }
  49
  50 /** \brief Default Layer Set
  51  *
  52  * FIXME: Needs docs
  53  */
  54 void default_layer_set(uint32_t state)
  55 {
  56     default_layer_state_set(state);
  57 }
  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
  86
  87 #ifndef NO_ACTION_LAYER
  88 /** \brief Keymap Layer State
  89  */
  90 uint32_t layer_state = 0;
  91
  92 /** \brief Layer state set user
  93  *
  94  * FIXME: Needs docs
  95  */
  96 __attribute__((weak))
  97 uint32_t layer_state_set_user(uint32_t state) {
  98     return state;
  99 }
 100
 101 /** \brief Layer state set keyboard
 102  *
 103  * FIXME: Needs docs
 104  */
 105 __attribute__((weak))
 106 uint32_t layer_state_set_kb(uint32_t state) {
 107     return layer_state_set_user(state);
 108 }
 109
 110 /** \brief Layer state set
 111  *
 112  * FIXME: Needs docs
 113  */
 114 void layer_state_set(uint32_t state)
 115 {
 116     state = layer_state_set_kb(state);
 117     dprint("layer_state: ");
 118     layer_debug(); dprint(" to ");
 119     layer_state = state;
 120     layer_debug(); dprintln();
 121     clear_keyboard_but_mods(); // To avoid stuck keys
 122 }
 123
 124 /** \brief Layer clear
 125  *
 126  * FIXME: Needs docs
 127  */
 128 void layer_clear(void)
 129 {
 130     layer_state_set(0);
 131 }
 132
 133 /** \brief Layer state is
 134  *
 135  * FIXME: Needs docs
 136  */
 137 bool layer_state_is(uint8_t layer)
 138 {
 139     return layer_state_cmp(layer_state, layer);
 140 }
 141
 142 /** \brief Layer state compare
 143  *
 144  * FIXME: Needs docs
 145  */
 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;
 149 }
 150
 151 /** \brief Layer move
 152  *
 153  * FIXME: Needs docs
 154  */
 155 void layer_move(uint8_t layer)
 156 {
 157     layer_state_set(1UL<<layer);
 158 }
 159
 160 /** \brief Layer on
 161  *
 162  * FIXME: Needs docs
 163  */
 164 void layer_on(uint8_t layer)
 165 {
 166     layer_state_set(layer_state | (1UL<<layer));
 167 }
 168
 169 /** \brief Layer off
 170  *
 171  * FIXME: Needs docs
 172  */
 173 void layer_off(uint8_t layer)
 174 {
 175     layer_state_set(layer_state & ~(1UL<<layer));
 176 }
 177
 178 /** \brief Layer invert
 179  *
 180  * FIXME: Needs docs
 181  */
 182 void layer_invert(uint8_t layer)
 183 {
 184     layer_state_set(layer_state ^ (1UL<<layer));
 185 }
 186
 187 /** \brief Layer or
 188  *
 189  * FIXME: Needs docs
 190  */
 191 void layer_or(uint32_t state)
 192 {
 193     layer_state_set(layer_state | state);
 194 }
 195 /** \brief Layer and
 196  *
 197  * FIXME: Needs docs
 198  */
 199 void layer_and(uint32_t state)
 200 {
 201     layer_state_set(layer_state & state);
 202 }
 203 /** \brief Layer xor
 204  *
 205  * FIXME: Needs docs
 206  */
 207 void layer_xor(uint32_t state)
 208 {
 209     layer_state_set(layer_state ^ state);
 210 }
 211
 212 /** \brief Layer debug printing
 213  *
 214  * FIXME: Needs docs
 215  */
 216 void layer_debug(void)
 217 {
 218     dprintf("%08lX(%u)", layer_state, biton32(layer_state));
 219 }
 220 #endif
 221
 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}};
 224
 225 void update_source_layers_cache(keypos_t key, uint8_t layer)
 226 {
 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;
 230
 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);
 236     }
 237 }
 238
 239 uint8_t read_source_layers_cache(keypos_t key)
 240 {
 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;
 244     uint8_t layer = 0;
 245
 246     for (uint8_t bit_number = 0; bit_number < MAX_LAYER_BITS; bit_number++) {
 247         layer |=
 248             ((source_layers_cache[storage_row][bit_number]
 249               & (1U << storage_bit)) != 0)
 250             << bit_number;
 251     }
 252
 253     return layer;
 254 }
 255 #endif
 256
 257 /** \brief Store or get action (FIXME: Needs better summary)
 258  *
 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.
 263  */
 264 action_t store_or_get_action(bool pressed, keypos_t key)
 265 {
 266 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
 267     if (disable_action_cache) {
 268         return layer_switch_get_action(key);
 269     }
 270
 271     uint8_t layer;
 272
 273     if (pressed) {
 274         layer = layer_switch_get_layer(key);
 275         update_source_layers_cache(key, layer);
 276     }
 277     else {
 278         layer = read_source_layers_cache(key);
 279     }
 280     return action_for_key(layer, key);
 281 #else
 282     return layer_switch_get_action(key);
 283 #endif
 284 }
 285
 286
 287 /** \brief Layer switch get layer
 288  *
 289  * FIXME: Needs docs
 290  */
 291 int8_t layer_switch_get_layer(keypos_t key)
 292 {
 293 #ifndef NO_ACTION_LAYER
 294     action_t action;
 295     action.code = ACTION_TRANSPARENT;
 296
 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) {
 303                 return i;
 304             }
 305         }
 306     }
 307     /* fall back to layer 0 */
 308     return 0;
 309 #else
 310     return biton32(default_layer_state);
 311 #endif
 312 }
 313
 314 /** \brief Layer switch get layer
 315  *
 316  * FIXME: Needs docs
 317  */
 318 action_t layer_switch_get_action(keypos_t key)
 319 {
 320     return action_for_key(layer_switch_get_layer(key), key);
 321 }