]> git.donarmstrong.com Git - tmk_firmware.git/blobdiff - common/action.c
Add overlay framework
[tmk_firmware.git] / common / action.c
index 38c5933ee3bce4edc51b107982dcc2d3351d8ffa..3703b4e8ccf8645262507507e0c0519e35c141a9 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)
 {
@@ -286,37 +202,6 @@ 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");
-    }
-
-    /* current layer: 0 means default layer */
-    if (current_layer) {
-        action = action_for_key(current_layer, key);
-        if (action.code != ACTION_TRANSPARENT) {
-            debug("current layer: used. "); debug_dec(current_layer); debug("\n");
-            return action;
-        }
-    }
-
-    /* default layer */
-    debug("default layer: used. \n");
-    action = action_for_key(default_layer, key);
-    return action;
-}
-
 static void process_action(keyrecord_t *record)
 {
     keyevent_t event = record->event;
@@ -324,8 +209,11 @@ 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");
+    action_t action = layer_switch_get_action(event.key);
+    debug("ACTION: "); debug_action(action);
+    debug(" overlays: "); overlay_debug();
+    debug(" keymaps: "); keymap_debug();
+    debug(" default_layer: "); debug_dec(default_layer); debug("\n");
 
     switch (action.kind.id) {
         /* Key and Mods */
@@ -465,216 +353,292 @@ static void process_action(keyrecord_t *record)
 #endif
             break;
 
-        /* Layer key */
-        case ACT_LAYER:
+        case ACT_KEYMAP:
             switch (action.layer.code) {
-                case LAYER_MOMENTARY:  /* momentary */
-                    if (event.pressed) {
-                        layer_switch(action.layer.val);
-                    }
-                    else {
-                        // NOTE: This is needed by legacy keymap support
-                        layer_switch(0);
-                    }
+                /* Keymap Reset */
+                case OP_RESET:
+                    default_layer_set(action.layer.val);
                     break;
-                case LAYER_ON_PRESS:
+                /* Keymap Reset default layer */
+                case (OP_RESET | ON_PRESS):
                     if (event.pressed) {
-                        layer_switch(action.layer.val);
+                        default_layer_set(action.layer.val);
+                        overlay_clear();
                     }
                     break;
-                case LAYER_ON_RELEASE:
+                case (OP_RESET | ON_RELEASE):
                     if (!event.pressed) {
-                        layer_switch(action.layer.val);
+                        default_layer_set(action.layer.val);
+                        overlay_clear();
                     }
                     break;
-                case LAYER_ON_BOTH:
-                    layer_switch(action.layer.val);
+                case (OP_RESET | ON_BOTH):
+                    default_layer_set(action.layer.val);
+                    overlay_clear();
                     break;
-                case LAYER_TAP_TOGGLE:  /* switch on hold and toggle on several taps */
+
+                /* Keymap Bit invert */
+                case OP_INV:
+                    /* with tap toggle */
                     if (event.pressed) {
                         if (tap_count < TAPPING_TOGGLE) {
-                            layer_switch(action.layer.val);
+                            debug("KEYMAP_INV: tap toggle(press).\n");
+                            keymap_invert(action.layer.val);
                         }
                     } else {
-                        if (tap_count >= TAPPING_TOGGLE) {
-                            debug("LAYER_PRESSED: tap toggle.\n");
-                            layer_switch(action.layer.val);
+                        if (tap_count <= TAPPING_TOGGLE) {
+                            debug("KEYMAP_INV: tap toggle(release).\n");
+                            keymap_invert(action.layer.val);
                         }
                     }
                     break;
-                case LAYER_SET_DEFAULT_ON_PRESS:
+                case (OP_INV | ON_PRESS):
                     if (event.pressed) {
-                        default_layer = action.layer.val;
-                        layer_switch(0);
+                        keymap_invert(action.layer.val);
                     }
                     break;
-                case LAYER_SET_DEFAULT_ON_RELEASE:
+                case (OP_INV | ON_RELEASE):
                     if (!event.pressed) {
-                        default_layer = action.layer.val;
-                        layer_switch(0);
+                        keymap_invert(action.layer.val);
                     }
                     break;
-                case LAYER_SET_DEFAULT_ON_BOTH:
-                    default_layer = action.layer.val;
-                    layer_switch(0);
+                case (OP_INV | ON_BOTH):
+                    keymap_invert(action.layer.val);
                     break;
-                default:
-                    /* tap key */
+
+                /* Keymap Bit on */
+                case OP_ON:
                     if (event.pressed) {
-                        if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                             debug("LAYER_SET: Tap: register_code\n");
-                             register_code(action.layer.code);
-                        } else {
-                             debug("LAYER_SET: No tap: layer_set(on press)\n");
-                             layer_switch(action.layer.val);
-                        }
+                        keymap_on(action.layer.val);
                     } else {
-                        if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_SET: Tap: unregister_code\n");
-                            unregister_code(action.layer.code);
-                        } else {
-                            // NOTE: This is needed by legacy keymap support
-                            debug("LAYER_SET: No tap: return to default layer(on release)\n");
-                            layer_switch(0);
-                        }
+                        keymap_off(action.layer.val);
                     }
                     break;
-            }
-            break;
-        case ACT_LAYER_BIT:
-            switch (action.layer.code) {
-                case LAYER_MOMENTARY:  /* momentary */
+                case (OP_ON | ON_PRESS):
+                    if (event.pressed) {
+                        keymap_on(action.layer.val);
+                    }
+                    break;
+                case (OP_ON | ON_RELEASE):
+                    if (!event.pressed) {
+                        keymap_on(action.layer.val);
+                    }
+                    break;
+                case (OP_ON | ON_BOTH):
+                    keymap_on(action.layer.val);
+                    break;
+
+                /* Keymap Bit off */
+                case OP_OFF:
                     if (event.pressed) {
-                        layer_switch(current_layer | action.layer.val);
+                        keymap_off(action.layer.val);
                     } else {
-                        layer_switch(current_layer & ~action.layer.val);
+                        keymap_on(action.layer.val);
                     }
                     break;
-                case LAYER_ON_PRESS:
+                case (OP_OFF | ON_PRESS):
                     if (event.pressed) {
-                        layer_switch(current_layer ^ action.layer.val);
+                        keymap_off(action.layer.val);
                     }
                     break;
-                case LAYER_ON_RELEASE:
+                case (OP_OFF | ON_RELEASE):
                     if (!event.pressed) {
-                        layer_switch(current_layer ^ action.layer.val);
+                        keymap_off(action.layer.val);
                     }
                     break;
-                case LAYER_ON_BOTH:
-                    layer_switch(current_layer ^ action.layer.val);
+                case (OP_OFF | ON_BOTH):
+                    keymap_off(action.layer.val);
                     break;
-                case LAYER_TAP_TOGGLE:  /* switch on hold and toggle on several taps */
+
+                /* Keymap Bit set */
+                case OP_SET:
                     if (event.pressed) {
-                        if (tap_count < TAPPING_TOGGLE) {
-                            debug("LAYER_BIT: tap toggle(press).\n");
-                            layer_switch(current_layer ^ action.layer.val);
-                        }
+                        keymap_set(action.layer.val);
                     } else {
-                        if (tap_count <= TAPPING_TOGGLE) {
-                            debug("LAYER_BIT: tap toggle(release).\n");
-                            layer_switch(current_layer ^ action.layer.val);
-                        }
+                        keymap_clear();
                     }
                     break;
-                case LAYER_SET_DEFAULT_ON_PRESS:
+                case (OP_SET | ON_PRESS):
                     if (event.pressed) {
-                        default_layer = default_layer ^ action.layer.val;
-                        layer_switch(0);
+                        keymap_set(action.layer.val);
                     }
                     break;
-                case LAYER_SET_DEFAULT_ON_RELEASE:
+                case (OP_SET | ON_RELEASE):
                     if (!event.pressed) {
-                        default_layer = default_layer ^ action.layer.val;
-                        layer_switch(0);
+                        keymap_set(action.layer.val);
                     }
                     break;
-                case LAYER_SET_DEFAULT_ON_BOTH:
-                    default_layer = default_layer ^ action.layer.val;
-                    layer_switch(0);
+                case (OP_SET | ON_BOTH):
+                    keymap_set(action.layer.val);
                     break;
+
+                /* Keymap Bit invert with tap key */
                 default:
-                    // tap key
                     if (event.pressed) {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_BIT: Tap: register_code\n");
+                            debug("KEYMAP_TAP_KEY: Tap: register_code\n");
                             register_code(action.layer.code);
                         } else {
-                            debug("LAYER_BIT: No tap: layer_bit(on press)\n");
-                            layer_switch(current_layer ^ action.layer.val);
+                            debug("KEYMAP_TAP_KEY: No tap: invert on press\n");
+                            keymap_invert(action.layer.val);
                         }
                     } else {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_BIT: Tap: unregister_code\n");
+                            debug("KEYMAP_TAP_KEY: Tap: unregister_code\n");
                             unregister_code(action.layer.code);
                         } else {
-                            debug("LAYER_BIT: No tap: layer_bit(on release)\n");
-                            layer_switch(current_layer ^ action.layer.val);
+                            debug("KEYMAP_TAP_KEY: No tap: invert on release\n");
+                            keymap_invert(action.layer.val);
                         }
                     }
                     break;
             }
             break;
-        case ACT_LAYER_STACK:
+
+        case ACT_OVERLAY:
             switch (action.layer.code) {
-                case LAYER_MOMENTARY:  /* momentary */
-                    if (event.pressed) {
-                        layer_remove_then_push(action.layer.val);
-                        debug_layer_stack();
+                // Overlay Invert bit4
+                case OP_INV4 | 0:
+                    if (action.layer.val == 0) {
+                        overlay_clear();
                     } else {
-                        layer_remove(action.layer.val);
-                        debug_layer_stack();
+                        overlay_set(overlay_stat ^ action.layer.val);
                     }
                     break;
-                case LAYER_ON_PRESS:
-                    if (event.pressed) {
-                        layer_remove_or_push(action.layer.val);
-                        debug_layer_stack();
+                case OP_INV4 | 1:
+                    if (action.layer.val == 0) {
+                        if (event.pressed) overlay_clear();
+                    } else {
+                        overlay_set(overlay_stat ^ action.layer.val<<4);
                     }
                     break;
-                case LAYER_ON_RELEASE:
-                    if (!event.pressed) {
-                        layer_remove_or_push(action.layer.val);
-                        debug_layer_stack();
+                case OP_INV4 | 2:
+                    if (action.layer.val == 0) {
+                        if (!event.pressed) overlay_clear();
+                    } else {
+                        overlay_set(overlay_stat ^ action.layer.val<<8);
                     }
                     break;
-                case LAYER_ON_BOTH:
-                    layer_remove_or_push(action.layer.val);
-                    debug_layer_stack();
+                case OP_INV4 | 3:
+                    if (action.layer.val == 0) {
+                        overlay_clear();
+                    } else {
+                        overlay_set(overlay_stat ^ action.layer.val<<12);
+                    }
                     break;
-                case LAYER_TAP_TOGGLE:  /* switch on hold and toggle on several taps */
+
+                /* Overlay Bit invert */
+                case OP_INV:
+                    /* with tap toggle */
                     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("OVERLAY_INV: tap toggle(press).\n");
+                            overlay_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("OVERLAY_INV: tap toggle(release).\n");
+                            overlay_invert(action.layer.val);
                         }
                     }
                     break;
+                case (OP_INV | ON_PRESS):
+                    if (event.pressed) {
+                        overlay_invert(action.layer.val);
+                    }
+                    break;
+                case (OP_INV | ON_RELEASE):
+                    if (!event.pressed) {
+                        overlay_invert(action.layer.val);
+                    }
+                    break;
+                case (OP_INV | ON_BOTH):
+                    overlay_invert(action.layer.val);
+                    break;
+
+                /* Overlay Bit on */
+                case OP_ON:
+                    if (event.pressed) {
+                        overlay_on(action.layer.val);
+                    } else {
+                        overlay_off(action.layer.val);
+                    }
+                    break;
+                case (OP_ON | ON_PRESS):
+                    if (event.pressed) {
+                        overlay_on(action.layer.val);
+                    }
+                    break;
+                case (OP_ON | ON_RELEASE):
+                    if (!event.pressed) {
+                        overlay_on(action.layer.val);
+                    }
+                    break;
+                case (OP_ON | ON_BOTH):
+                    overlay_on(action.layer.val);
+                    break;
+
+                /* Overlay Bit off */
+                case OP_OFF:
+                    if (event.pressed) {
+                        overlay_off(action.layer.val);
+                    } else {
+                        overlay_on(action.layer.val);
+                    }
+                    break;
+                case (OP_OFF | ON_PRESS):
+                    if (event.pressed) {
+                        overlay_off(action.layer.val);
+                    }
+                    break;
+                case (OP_OFF | ON_RELEASE):
+                    if (!event.pressed) {
+                        overlay_off(action.layer.val);
+                    }
+                    break;
+                case (OP_OFF | ON_BOTH):
+                    overlay_off(action.layer.val);
+                    break;
+
+                /* Overlay Bit set */
+                case OP_SET:
+                    if (event.pressed) {
+                        overlay_move(action.layer.val);
+                    } else {
+                        overlay_clear();
+                    }
+                    break;
+                case (OP_SET | ON_PRESS):
+                    if (event.pressed) {
+                        overlay_move(action.layer.val);
+                    }
+                    break;
+                case (OP_SET | ON_RELEASE):
+                    if (!event.pressed) {
+                        overlay_move(action.layer.val);
+                    }
+                    break;
+                case (OP_SET | ON_BOTH):
+                    overlay_move(action.layer.val);
+                    break;
+
+                /* Overlay Bit invert with tap key */
                 default:
-                    // tap key
                     if (event.pressed) {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_STACK: Tap: register_code\n");
+                            debug("OVERLAY_TAP_KEY: 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("OVERLAY_TAP_KEY: No tap: invert on press\n");
+                            overlay_invert(action.layer.val);
                         }
                     } else {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_STACK: Tap: unregister_code\n");
+                            debug("OVERLAY_TAP_KEY: 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("OVERLAY_TAP_KEY: No tap: invert on release\n");
+                            overlay_invert(action.layer.val);
                         }
                     }
                     break;
@@ -981,42 +945,23 @@ 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);
+    action_t action = layer_switch_get_action(key);
 
     switch (action.kind.id) {
         case ACT_LMODS_TAP:
         case ACT_RMODS_TAP:
             return true;
-        case ACT_LAYER:
-        case ACT_LAYER_BIT:
+        case ACT_KEYMAP:
+        case ACT_OVERLAY:
             switch (action.layer.code) {
-                case LAYER_MOMENTARY:
-                case LAYER_ON_PRESS:
-                case LAYER_ON_RELEASE:
-                case LAYER_ON_BOTH:
-                case LAYER_SET_DEFAULT_ON_PRESS:
-                case LAYER_SET_DEFAULT_ON_RELEASE:
-                case LAYER_SET_DEFAULT_ON_BOTH:
-                    return false;
-                case LAYER_TAP_TOGGLE:
-                default:    /* tap key */
+                case 0x04 ... 0xEF:    /* tap key */
+                case OP_INV:
                     return true;
+                default:
+                    return false;
             }
-            return false;
         case ACT_FUNCTION:
             if (action.func.opt & FUNC_TAP) { return true; }
             return false;
@@ -1047,9 +992,8 @@ 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_BIT:         debug("ACT_LAYER_BIT");         break;
-        case ACT_LAYER_STACK:       debug("ACT_LAYER_STACK");       break;
+        case ACT_KEYMAP:            debug("ACT_KEYMAP");            break;
+        case ACT_OVERLAY:           debug("ACT_OVERLAY");           break;
         case ACT_MACRO:             debug("ACT_MACRO");             break;
         case ACT_COMMAND:           debug("ACT_COMMAND");           break;
         case ACT_FUNCTION:          debug("ACT_FUNCTION");          break;