2 Copyright 2013 Jun Wako <wakojun@gmail.com>
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.
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.
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/>.
17 #ifndef ACTION_LAYER_H
18 #define ACTION_LAYER_H
24 #if defined(LAYER_STATE_8BIT) || ( defined(DYNAMIC_KEYMAP_ENABLE) && DYNAMIC_KEYMAP_LAYER_COUNT >= 8 )
25 typedef uint8_t layer_state_t;
26 #elif defined(LAYER_STATE_16BIT)
27 typedef uint16_t layer_state_t;
29 typedef uint32_t layer_state_t;
36 extern layer_state_t default_layer_state;
37 void default_layer_debug(void);
38 void default_layer_set(layer_state_t state);
41 layer_state_t default_layer_state_set_kb(layer_state_t state);
43 layer_state_t default_layer_state_set_user(layer_state_t state);
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);
51 #define default_layer_or(state)
52 #define default_layer_and(state)
53 #define default_layer_xor(state)
60 #ifndef NO_ACTION_LAYER
61 extern layer_state_t layer_state;
63 void layer_state_set(layer_state_t state);
64 bool layer_state_is(uint8_t layer);
65 bool layer_state_cmp(layer_state_t layer1, uint8_t layer2);
67 void layer_debug(void);
68 void layer_clear(void);
69 void layer_move(uint8_t layer);
70 void layer_on(uint8_t layer);
71 void layer_off(uint8_t layer);
72 void layer_invert(uint8_t layer);
73 /* bitwise operation */
74 void layer_or(layer_state_t state);
75 void layer_and(layer_state_t state);
76 void layer_xor(layer_state_t state);
80 #define layer_state_set(layer)
81 #define layer_state_is(layer) (layer == 0)
82 #define layer_state_cmp(state, layer) (state == 0 ? layer == 0 : (state & 1UL << layer) != 0)
86 #define layer_move(layer)
87 #define layer_on(layer)
88 #define layer_off(layer)
89 #define layer_invert(layer)
90 #define layer_or(state)
91 #define layer_and(state)
92 #define layer_xor(state)
95 layer_state_t layer_state_set_user(layer_state_t state);
96 layer_state_t layer_state_set_kb(layer_state_t state);
98 /* pressed actions cache */
99 #if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
100 /* The number of bits needed to represent the layer number: log2(32). */
101 #define MAX_LAYER_BITS 5
102 void update_source_layers_cache(keypos_t key, uint8_t layer);
103 uint8_t read_source_layers_cache(keypos_t key);
105 action_t store_or_get_action(bool pressed, keypos_t key);
107 /* return the topmost non-transparent layer currently associated with key */
108 uint8_t layer_switch_get_layer(keypos_t key);
110 /* return action depending on current layer status */
111 action_t layer_switch_get_action(keypos_t key);