tmk_core/common/action_layer.h

   1 /*
   2 Copyright 2013 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17 #ifndef ACTION_LAYER_H
  18 #define ACTION_LAYER_H
  19
  20 #include <stdint.h>
  21 #include "keyboard.h"
  22 #include "action.h"
  23
  24 #if defined(LAYER_STATE_8BIT)
  25 typedef uint8_t layer_state_t;
  26 #    define get_highest_layer(state) biton(state)
  27 #elif defined(LAYER_STATE_16BIT)
  28 typedef uint16_t layer_state_t;
  29 #    define get_highest_layer(state) biton16(state)
  30 #else
  31 typedef uint32_t layer_state_t;
  32 #    define get_highest_layer(state) biton32(state)
  33 #endif
  34
  35 /*
  36  * Default Layer
  37  */
  38 extern layer_state_t default_layer_state;
  39 void                 default_layer_debug(void);
  40 void                 default_layer_set(layer_state_t state);
  41
  42 __attribute__((weak)) layer_state_t default_layer_state_set_kb(layer_state_t state);
  43 __attribute__((weak)) layer_state_t default_layer_state_set_user(layer_state_t state);
  44
  45 #ifndef NO_ACTION_LAYER
  46 /* bitwise operation */
  47 void default_layer_or(layer_state_t state);
  48 void default_layer_and(layer_state_t state);
  49 void default_layer_xor(layer_state_t state);
  50 #else
  51 #    define default_layer_or(state)
  52 #    define default_layer_and(state)
  53 #    define default_layer_xor(state)
  54 #endif
  55
  56 /*
  57  * Keymap Layer
  58  */
  59 #ifndef NO_ACTION_LAYER
  60 extern layer_state_t layer_state;
  61
  62 void layer_state_set(layer_state_t state);
  63 bool layer_state_is(uint8_t layer);
  64 bool layer_state_cmp(layer_state_t layer1, uint8_t layer2);
  65
  66 void layer_debug(void);
  67 void layer_clear(void);
  68 void layer_move(uint8_t layer);
  69 void layer_on(uint8_t layer);
  70 void layer_off(uint8_t layer);
  71 void layer_invert(uint8_t layer);
  72 /* bitwise operation */
  73 void layer_or(layer_state_t state);
  74 void layer_and(layer_state_t state);
  75 void layer_xor(layer_state_t state);
  76 #else
  77 #    define layer_state 0
  78
  79 #    define layer_state_set(layer)
  80 #    define layer_state_is(layer) (layer == 0)
  81 #    define layer_state_cmp(state, layer) (state == 0 ? layer == 0 : (state & 1UL << layer) != 0)
  82
  83 #    define layer_debug()
  84 #    define layer_clear()
  85 #    define layer_move(layer)
  86 #    define layer_on(layer)
  87 #    define layer_off(layer)
  88 #    define layer_invert(layer)
  89 #    define layer_or(state)
  90 #    define layer_and(state)
  91 #    define layer_xor(state)
  92 #endif
  93
  94 layer_state_t layer_state_set_user(layer_state_t state);
  95 layer_state_t layer_state_set_kb(layer_state_t state);
  96
  97 /* pressed actions cache */
  98 #if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
  99 /* The number of bits needed to represent the layer number: log2(32). */
 100 #    define MAX_LAYER_BITS 5
 101 void    update_source_layers_cache(keypos_t key, uint8_t layer);
 102 uint8_t read_source_layers_cache(keypos_t key);
 103 #endif
 104 action_t store_or_get_action(bool pressed, keypos_t key);
 105
 106 /* return the topmost non-transparent layer currently associated with key */
 107 uint8_t layer_switch_get_layer(keypos_t key);
 108
 109 /* return action depending on current layer status */
 110 action_t layer_switch_get_action(keypos_t key);
 111
 112 #endif