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
  25 /*
  26  * Default Layer
  27  */
  28 extern uint32_t default_layer_state;
  29 void default_layer_debug(void);
  30 void default_layer_set(uint32_t state);
  31
  32 __attribute__((weak))
  33 uint32_t default_layer_state_set_kb(uint32_t state);
  34
  35 #ifndef NO_ACTION_LAYER
  36 /* bitwise operation */
  37 void default_layer_or(uint32_t state);
  38 void default_layer_and(uint32_t state);
  39 void default_layer_xor(uint32_t state);
  40 #else
  41 #define default_layer_or(state)
  42 #define default_layer_and(state)
  43 #define default_layer_xor(state)
  44 #endif
  45
  46
  47 /*
  48  * Keymap Layer
  49  */
  50 #ifndef NO_ACTION_LAYER
  51 extern uint32_t layer_state;
  52 void layer_debug(void);
  53 void layer_clear(void);
  54 void layer_move(uint8_t layer);
  55 void layer_on(uint8_t layer);
  56 void layer_off(uint8_t layer);
  57 void layer_invert(uint8_t layer);
  58 /* bitwise operation */
  59 void layer_or(uint32_t state);
  60 void layer_and(uint32_t state);
  61 void layer_xor(uint32_t state);
  62 #else
  63 #define layer_state             0
  64 #define layer_clear()
  65 #define layer_move(layer)
  66 #define layer_on(layer)
  67 #define layer_off(layer)
  68 #define layer_invert(layer)
  69
  70 #define layer_or(state)
  71 #define layer_and(state)
  72 #define layer_xor(state)
  73 #define layer_debug()
  74
  75 __attribute__((weak))
  76 uint32_t layer_state_set_user(uint32_t state);
  77 __attribute__((weak))
  78 uint32_t layer_state_set_kb(uint32_t state);
  79 #endif
  80
  81 /* pressed actions cache */
  82 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
  83 /* The number of bits needed to represent the layer number: log2(32). */
  84 #define MAX_LAYER_BITS 5
  85 void update_source_layers_cache(keypos_t key, uint8_t layer);
  86 uint8_t read_source_layers_cache(keypos_t key);
  87 #endif
  88 action_t store_or_get_action(bool pressed, keypos_t key);
  89
  90 /* return the topmost non-transparent layer currently associated with key */
  91 int8_t layer_switch_get_layer(keypos_t key);
  92
  93 /* return action depending on current layer status */
  94 action_t layer_switch_get_action(keypos_t key);
  95
  96 #endif