]> git.donarmstrong.com Git - tmk_firmware.git/blobdiff - common/action.c
Rewrite layer action with layer_switch
[tmk_firmware.git] / common / action.c
index d0c9ddb0adbeaf38d05ac0d9a714cd8e710a61fc..246fd99d8ab5f8d54fe8f3aab09ad6c8e9607ce6 100644 (file)
@@ -24,12 +24,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "util.h"
 #include "debug.h"
 #include "action.h"
-
-
-/* default layer indicates base layer */
-uint8_t default_layer = 0;
-/* current layer indicates active layer at this time */
-uint8_t current_layer = 0;
+#include "layer_switch.h"
 
 
 static void process_action(keyrecord_t *record);
@@ -163,85 +158,6 @@ static void oneshot_toggle(void)
 }
 
 
-/*
- * Layer stack
- */
-#define LAYER_STACK_SIZE 8
-typedef struct {
-    uint8_t layer:4;
-    uint8_t next:3;
-    bool    used;
-} layer_item_t;
-
-static uint8_t top_layer = 0;
-// [0] is sentinel and not used. [0] is null item.
-static layer_item_t layer_stack[LAYER_STACK_SIZE] = {};
-
-static bool layer_push(uint8_t layer)
-{
-    for (uint8_t i = 1; i < LAYER_STACK_SIZE; i++) {
-        if (!layer_stack[i].used) {
-            layer_stack[i] = (layer_item_t){ .layer = layer,
-                                              .next = top_layer,
-                                              .used = true };
-            top_layer = i;
-            return true;
-        }
-    }
-    return false;
-}
-static bool layer_pop(void)
-{
-    if (layer_stack[top_layer].used) {
-        uint8_t popped = top_layer;
-        top_layer = layer_stack[popped].next;
-        layer_stack[popped] = (layer_item_t){};
-        return true;
-    }
-    return false;
-}
-static bool layer_remove(uint8_t layer)
-{
-    if (layer_stack[top_layer].used && layer_stack[top_layer].layer == layer) {
-        layer_pop();
-        debug("layer_remove: top_layer\n");
-        return true;
-    }
-
-    for (uint8_t i = top_layer; layer_stack[i].used; i = layer_stack[i].next) {
-        debug("layer_remove: ["); debug_dec(i); debug("]");
-        debug_dec(layer_stack[i].layer); debug("\n");
-        uint8_t removed = layer_stack[i].next;
-        if (layer_stack[removed].used && layer_stack[removed].layer == layer) {
-            layer_stack[i].next = layer_stack[removed].next;
-            layer_stack[removed] = (layer_item_t){};
-            debug("layer_remove: removed.\n");
-            return true;
-        }
-    }
-    return false;
-}
-static bool layer_remove_then_push(uint8_t layer)
-{
-    layer_remove(layer);
-    return layer_push(layer);
-}
-static bool layer_remove_or_push(uint8_t layer)
-{
-    return (layer_remove(layer)) || layer_push(layer);
-}
-static void debug_layer_stack(void)
-{
-    debug("layer_stack: ");
-    layer_item_t item = layer_stack[top_layer];
-    while (item.used) {
-        debug_dec(item.layer);
-        debug("["); debug_dec(item.next); debug("]");
-        item = layer_stack[item.next];
-    }
-    debug("\n");
-}
-
 
 void action_exec(keyevent_t event)
 {
@@ -289,26 +205,17 @@ void action_exec(keyevent_t event)
 static action_t get_action(key_t key)
 {
     action_t action;
+    action.code = ACTION_NO;
 
-    /* layer stack */
-    for (layer_item_t i = layer_stack[top_layer]; i.used; i = layer_stack[i.next]) {
-        action = action_for_key(i.layer, key);
-        if (action.code != ACTION_TRANSPARENT) {
-            debug_layer_stack();
-            debug("layer_stack: used. "); debug_dec(i.layer); debug("\n");
-            return action;
-        }
-        debug("layer_stack: through. "); debug_dec(i.layer); debug("\n");
+    /* layer_switch */
+    action = layer_switch_get_action(key);
+    if (action.code != ACTION_TRANSPARENT) {
+        return action;
     }
 
-    /* current layer */
-    action = action_for_key(current_layer, key);
-
     /* default layer */
-    if (action.code == ACTION_TRANSPARENT) {
-        debug("TRNASPARENT: "); debug_hex16(action.code); debug("\n");
-        action = action_for_key(default_layer, key);
-    }
+    //debug("get_aciton: default layer: "); debug_dec(default_layer); debug("\n");
+    action = action_for_key(default_layer, key);
     return action;
 }
 
@@ -320,7 +227,8 @@ static void process_action(keyrecord_t *record)
     if (IS_NOEVENT(event)) { return; }
 
     action_t action = get_action(event.key);
-    debug("ACTION: "); debug_action(action); debug("\n");
+    debug("ACTION: "); debug_action(action); debug(" ");
+    layer_switch_debug(); debug("["); debug_dec(default_layer); debug("]\n");
 
     switch (action.kind.id) {
         /* Key and Mods */
@@ -461,57 +369,57 @@ static void process_action(keyrecord_t *record)
             break;
 
         /* Layer key */
-        case ACT_LAYER:
+        case ACT_LAYER_SET:
             switch (action.layer.code) {
                 case LAYER_MOMENTARY:  /* momentary */
                     if (event.pressed) {
-                        layer_switch(action.layer.val);
+                        layer_switch_move(action.layer.val);
                     }
                     else {
                         // NOTE: This is needed by legacy keymap support
-                        layer_switch(default_layer);
+                        layer_switch_move(0);
                     }
                     break;
                 case LAYER_ON_PRESS:
                     if (event.pressed) {
-                        layer_switch(action.layer.val);
+                        layer_switch_move(action.layer.val);
                     }
                     break;
                 case LAYER_ON_RELEASE:
                     if (!event.pressed) {
-                        layer_switch(action.layer.val);
+                        layer_switch_move(action.layer.val);
                     }
                     break;
                 case LAYER_ON_BOTH:
-                    layer_switch(action.layer.val);
+                    layer_switch_move(action.layer.val);
                     break;
                 case LAYER_TAP_TOGGLE:  /* switch on hold and toggle on several taps */
                     if (event.pressed) {
                         if (tap_count < TAPPING_TOGGLE) {
-                            layer_switch(action.layer.val);
+                            layer_switch_move(action.layer.val);
                         }
                     } else {
                         if (tap_count >= TAPPING_TOGGLE) {
                             debug("LAYER_PRESSED: tap toggle.\n");
-                            layer_switch(action.layer.val);
+                            layer_switch_move(action.layer.val);
                         }
                     }
                     break;
                 case LAYER_SET_DEFAULT_ON_PRESS:
                     if (event.pressed) {
                         default_layer = action.layer.val;
-                        layer_switch(default_layer);
+                        layer_switch_move(0);
                     }
                     break;
                 case LAYER_SET_DEFAULT_ON_RELEASE:
                     if (!event.pressed) {
                         default_layer = action.layer.val;
-                        layer_switch(default_layer);
+                        layer_switch_move(0);
                     }
                     break;
                 case LAYER_SET_DEFAULT_ON_BOTH:
                     default_layer = action.layer.val;
-                    layer_switch(default_layer);
+                    layer_switch_move(0);
                     break;
                 default:
                     /* tap key */
@@ -521,7 +429,7 @@ static void process_action(keyrecord_t *record)
                              register_code(action.layer.code);
                         } else {
                              debug("LAYER_SET: No tap: layer_set(on press)\n");
-                             layer_switch(action.layer.val);
+                             layer_switch_move(action.layer.val);
                         }
                     } else {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
@@ -530,7 +438,7 @@ static void process_action(keyrecord_t *record)
                         } else {
                             // NOTE: This is needed by legacy keymap support
                             debug("LAYER_SET: No tap: return to default layer(on release)\n");
-                            layer_switch(default_layer);
+                            layer_switch_move(0);
                         }
                     }
                     break;
@@ -540,52 +448,52 @@ static void process_action(keyrecord_t *record)
             switch (action.layer.code) {
                 case LAYER_MOMENTARY:  /* momentary */
                     if (event.pressed) {
-                        layer_switch(current_layer | action.layer.val);
+                        layer_switch_move(layer_switch_get_layer() | action.layer.val);
                     } else {
-                        layer_switch(current_layer & ~action.layer.val);
+                        layer_switch_move(layer_switch_get_layer() & ~action.layer.val);
                     }
                     break;
                 case LAYER_ON_PRESS:
                     if (event.pressed) {
-                        layer_switch(current_layer ^ action.layer.val);
+                        layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                     }
                     break;
                 case LAYER_ON_RELEASE:
                     if (!event.pressed) {
-                        layer_switch(current_layer ^ action.layer.val);
+                        layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                     }
                     break;
                 case LAYER_ON_BOTH:
-                    layer_switch(current_layer ^ action.layer.val);
+                    layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                     break;
                 case LAYER_TAP_TOGGLE:  /* switch on hold and toggle on several taps */
                     if (event.pressed) {
                         if (tap_count < TAPPING_TOGGLE) {
                             debug("LAYER_BIT: tap toggle(press).\n");
-                            layer_switch(current_layer ^ action.layer.val);
+                            layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                         }
                     } else {
                         if (tap_count <= TAPPING_TOGGLE) {
                             debug("LAYER_BIT: tap toggle(release).\n");
-                            layer_switch(current_layer ^ action.layer.val);
+                            layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                         }
                     }
                     break;
                 case LAYER_SET_DEFAULT_ON_PRESS:
                     if (event.pressed) {
-                        default_layer = current_layer ^ action.layer.val;
-                        layer_switch(default_layer);
+                        default_layer = default_layer ^ action.layer.val;
+                        layer_switch_move(default_layer);
                     }
                     break;
                 case LAYER_SET_DEFAULT_ON_RELEASE:
                     if (!event.pressed) {
-                        default_layer = current_layer ^ action.layer.val;
-                        layer_switch(default_layer);
+                        default_layer = default_layer ^ action.layer.val;
+                        layer_switch_move(default_layer);
                     }
                     break;
                 case LAYER_SET_DEFAULT_ON_BOTH:
-                    default_layer = current_layer ^ action.layer.val;
-                    layer_switch(default_layer);
+                    default_layer = default_layer ^ action.layer.val;
+                    layer_switch_move(default_layer);
                     break;
                 default:
                     // tap key
@@ -595,7 +503,7 @@ static void process_action(keyrecord_t *record)
                             register_code(action.layer.code);
                         } else {
                             debug("LAYER_BIT: No tap: layer_bit(on press)\n");
-                            layer_switch(current_layer ^ action.layer.val);
+                            layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                         }
                     } else {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
@@ -603,51 +511,44 @@ static void process_action(keyrecord_t *record)
                             unregister_code(action.layer.code);
                         } else {
                             debug("LAYER_BIT: No tap: layer_bit(on release)\n");
-                            layer_switch(current_layer ^ action.layer.val);
+                            layer_switch_move(layer_switch_get_layer() ^ action.layer.val);
                         }
                     }
                     break;
             }
             break;
-        case ACT_LAYER_STACK:
+        case ACT_LAYER_SWITCH:
             switch (action.layer.code) {
                 case LAYER_MOMENTARY:  /* momentary */
                     if (event.pressed) {
-                        layer_remove_then_push(action.layer.val);
-                        debug_layer_stack();
+                        layer_switch_on(action.layer.val);
                     } else {
-                        layer_remove(action.layer.val);
-                        debug_layer_stack();
+                        layer_switch_off(action.layer.val);
                     }
                     break;
                 case LAYER_ON_PRESS:
                     if (event.pressed) {
-                        layer_remove_or_push(action.layer.val);
-                        debug_layer_stack();
+                        layer_switch_invert(action.layer.val);
                     }
                     break;
                 case LAYER_ON_RELEASE:
                     if (!event.pressed) {
-                        layer_remove_or_push(action.layer.val);
-                        debug_layer_stack();
+                        layer_switch_invert(action.layer.val);
                     }
                     break;
                 case LAYER_ON_BOTH:
-                    layer_remove_or_push(action.layer.val);
-                    debug_layer_stack();
+                    layer_switch_invert(action.layer.val);
                     break;
                 case LAYER_TAP_TOGGLE:  /* switch on hold and toggle on several taps */
                     if (event.pressed) {
                         if (tap_count < TAPPING_TOGGLE) {
-                            debug("LAYER_STACK: tap toggle(press).\n");
-                            layer_remove_or_push(action.layer.val);
-                            debug_layer_stack();
+                            debug("LAYER_SWITCH: tap toggle(press).\n");
+                            layer_switch_invert(action.layer.val);
                         }
                     } else {
                         if (tap_count <= TAPPING_TOGGLE) {
-                            debug("LAYER_STACK: tap toggle(release).\n");
-                            layer_remove_or_push(action.layer.val);
-                            debug_layer_stack();
+                            debug("LAYER_SWITCH: tap toggle(release).\n");
+                            layer_switch_invert(action.layer.val);
                         }
                     }
                     break;
@@ -655,21 +556,19 @@ static void process_action(keyrecord_t *record)
                     // tap key
                     if (event.pressed) {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_STACK: Tap: register_code\n");
+                            debug("LAYER_SWITCH: Tap: register_code\n");
                             register_code(action.layer.code);
                         } else {
-                            debug("LAYER_STACK: No tap: layer_stack(on press)\n");
-                            layer_remove_or_push(action.layer.val);
-                            debug_layer_stack();
+                            debug("LAYER_SWITCH: No tap: layer_switch on press\n");
+                            layer_switch_invert(action.layer.val);
                         }
                     } else {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_STACK: Tap: unregister_code\n");
+                            debug("LAYER_SWITCH: Tap: unregister_code\n");
                             unregister_code(action.layer.code);
                         } else {
-                            debug("LAYER_STACK: No tap: layer_stack(on release)\n");
-                            layer_remove_or_push(action.layer.val);
-                            debug_layer_stack();
+                            debug("LAYER_SWITCH: No tap: layer_switch on release\n");
+                            layer_switch_invert(action.layer.val);
                         }
                     }
                     break;
@@ -976,18 +875,6 @@ bool sending_anykey(void)
             host_last_sysytem_report() || host_last_consumer_report());
 }
 
-void layer_switch(uint8_t new_layer)
-{
-    if (current_layer != new_layer) {
-        debug("Layer Switch: "); debug_hex(current_layer);
-        debug(" -> "); debug_hex(new_layer); debug("\n");
-
-        current_layer = new_layer;
-        clear_keyboard_but_mods(); // To avoid stuck keys
-        // NOTE: update mods with full scan of matrix? if modifier changes between layers
-    }
-}
-
 bool is_tap_key(key_t key)
 {
     action_t action = get_action(key);
@@ -996,7 +883,7 @@ bool is_tap_key(key_t key)
         case ACT_LMODS_TAP:
         case ACT_RMODS_TAP:
             return true;
-        case ACT_LAYER:
+        case ACT_LAYER_SET:
         case ACT_LAYER_BIT:
             switch (action.layer.code) {
                 case LAYER_MOMENTARY:
@@ -1042,9 +929,9 @@ static void debug_action(action_t action)
         case ACT_RMODS_TAP:         debug("ACT_RMODS_TAP");         break;
         case ACT_USAGE:             debug("ACT_USAGE");             break;
         case ACT_MOUSEKEY:          debug("ACT_MOUSEKEY");          break;
-        case ACT_LAYER:             debug("ACT_LAYER");             break;
+        case ACT_LAYER_SET:         debug("ACT_LAYER_SET");         break;
         case ACT_LAYER_BIT:         debug("ACT_LAYER_BIT");         break;
-        case ACT_LAYER_STACK:       debug("ACT_LAYER_STACK");       break;
+        case ACT_LAYER_SWITCH:      debug("ACT_LAYER_SWITCH");      break;
         case ACT_MACRO:             debug("ACT_MACRO");             break;
         case ACT_COMMAND:           debug("ACT_COMMAND");           break;
         case ACT_FUNCTION:          debug("ACT_FUNCTION");          break;