]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - tmk_core/common/action_layer.h
Usbasploader bootloader option addition (#6304)
[qmk_firmware.git] / tmk_core / common / action_layer.h
index d89ed6e5ce8e1cb725f0262f7e7ac44b9b3ed1d4..7fa30c86d69f9c6f092a20d9309b3c472182dca1 100644 (file)
@@ -21,22 +21,32 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "keyboard.h"
 #include "action.h"
 
+#if defined(LAYER_STATE_8BIT) || ( defined(DYNAMIC_KEYMAP_ENABLE) && DYNAMIC_KEYMAP_LAYER_COUNT >= 8 )
+typedef uint8_t layer_state_t;
+#elif defined(LAYER_STATE_16BIT)
+typedef uint16_t layer_state_t;
+#else
+typedef uint32_t layer_state_t;
+#endif
+
 
 /*
  * Default Layer
  */
-extern uint32_t default_layer_state;
+extern layer_state_t default_layer_state;
 void default_layer_debug(void);
-void default_layer_set(uint32_t state);
+void default_layer_set(layer_state_t state);
 
 __attribute__((weak))
-uint32_t default_layer_state_set_kb(uint32_t state);
+layer_state_t default_layer_state_set_kb(layer_state_t state);
+__attribute__((weak))
+layer_state_t default_layer_state_set_user(layer_state_t state);
 
 #ifndef NO_ACTION_LAYER
 /* bitwise operation */
-void default_layer_or(uint32_t state);
-void default_layer_and(uint32_t state);
-void default_layer_xor(uint32_t state);
+void default_layer_or(layer_state_t state);
+void default_layer_and(layer_state_t state);
+void default_layer_xor(layer_state_t state);
 #else
 #define default_layer_or(state)
 #define default_layer_and(state)
@@ -48,7 +58,12 @@ void default_layer_xor(uint32_t state);
  * Keymap Layer
  */
 #ifndef NO_ACTION_LAYER
-extern uint32_t layer_state;
+extern layer_state_t layer_state;
+
+void layer_state_set(layer_state_t state);
+bool layer_state_is(uint8_t layer);
+bool layer_state_cmp(layer_state_t layer1, uint8_t layer2);
+
 void layer_debug(void);
 void layer_clear(void);
 void layer_move(uint8_t layer);
@@ -56,28 +71,32 @@ void layer_on(uint8_t layer);
 void layer_off(uint8_t layer);
 void layer_invert(uint8_t layer);
 /* bitwise operation */
-void layer_or(uint32_t state);
-void layer_and(uint32_t state);
-void layer_xor(uint32_t state);
+void layer_or(layer_state_t state);
+void layer_and(layer_state_t state);
+void layer_xor(layer_state_t state);
 #else
-#define layer_state             0
+#define layer_state                    0
+
+#define layer_state_set(layer)
+#define layer_state_is(layer)          (layer == 0)
+#define layer_state_cmp(state, layer)  (state == 0 ? layer == 0 : (state & 1UL << layer) != 0)
+
+#define layer_debug()
 #define layer_clear()
 #define layer_move(layer)
 #define layer_on(layer)
 #define layer_off(layer)
 #define layer_invert(layer)
-
 #define layer_or(state)
 #define layer_and(state)
 #define layer_xor(state)
-#define layer_debug()
-
-__attribute__((weak))
-uint32_t layer_state_set_kb(uint32_t state);
 #endif
 
+layer_state_t layer_state_set_user(layer_state_t state);
+layer_state_t layer_state_set_kb(layer_state_t state);
+
 /* pressed actions cache */
-#if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
+#if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
 /* The number of bits needed to represent the layer number: log2(32). */
 #define MAX_LAYER_BITS 5
 void update_source_layers_cache(keypos_t key, uint8_t layer);
@@ -86,7 +105,7 @@ uint8_t read_source_layers_cache(keypos_t key);
 action_t store_or_get_action(bool pressed, keypos_t key);
 
 /* return the topmost non-transparent layer currently associated with key */
-int8_t layer_switch_get_layer(keypos_t key);
+uint8_t layer_switch_get_layer(keypos_t key);
 
 /* return action depending on current layer status */
 action_t layer_switch_get_action(keypos_t key);