]> git.donarmstrong.com Git - tmk_firmware.git/blobdiff - common/action.c
Add overlay framework
[tmk_firmware.git] / common / action.c
index 28d9a95f5d2cba486a43fa5874933581082fbe77..3703b4e8ccf8645262507507e0c0519e35c141a9 100644 (file)
@@ -24,6 +24,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "util.h"
 #include "debug.h"
 #include "action.h"
+#include "layer_switch.h"
 
 
 static void process_action(keyrecord_t *record);
@@ -110,7 +111,7 @@ static bool waiting_buffer_typed(keyevent_t event)
 }
 #endif
 
-static bool waiting_buffer_has_anykey_pressed(void)
+bool waiting_buffer_has_anykey_pressed(void)
 {
     for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
         if (waiting_buffer[i].event.pressed) return true;
@@ -208,9 +209,11 @@ static void process_action(keyrecord_t *record)
 
     if (IS_NOEVENT(event)) { return; }
 
-    action_t action = keymap_get_action(current_layer, event.key.pos.row, event.key.pos.col);
-    //debug("action: "); debug_hex16(action.code); if (event.pressed) debug("d\n"); else debug("u\n");
-    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 */
@@ -256,7 +259,7 @@ static void process_action(keyrecord_t *record)
                                 debug("MODS_TAP: Oneshot: start\n");
                                 oneshot_start(mods, event.time);
                             }
-                            else if (tap_count == 5) {
+                            else if (tap_count == TAPPING_TOGGLE) {
                                 debug("MODS_TAP: Oneshot: toggle\n");
                                 oneshot_toggle();
                             }
@@ -269,7 +272,7 @@ static void process_action(keyrecord_t *record)
                         } else {
                             if (tap_count == 0) {
                                 debug("MODS_TAP: Oneshot: cancel/del_mods\n");
-                                // cancel oneshot by holding.
+                                // cancel oneshot on hold
                                 oneshot_cancel();
                                 del_mods(mods);
                             }
@@ -319,14 +322,14 @@ static void process_action(keyrecord_t *record)
         case ACT_USAGE:
 #ifdef EXTRAKEY_ENABLE
             switch (action.usage.page) {
-                case ACTION_USAGE_PAGE_SYSTEM:
+                case PAGE_SYSTEM:
                     if (event.pressed) {
                         host_system_send(action.usage.code);
                     } else {
                         host_system_send(0);
                     }
                     break;
-                case ACTION_USAGE_PAGE_CONSUMER:
+                case PAGE_CONSUMER:
                     if (event.pressed) {
                         host_consumer_send(action.usage.code);
                     } else {
@@ -350,273 +353,306 @@ static void process_action(keyrecord_t *record)
 #endif
             break;
 
-        /* Layer key */
-        case ACT_LAYER_PRESSED:
-            // layer action when pressed
+        case ACT_KEYMAP:
             switch (action.layer.code) {
-                case 0x00:
+                /* Keymap Reset */
+                case OP_RESET:
+                    default_layer_set(action.layer.val);
+                    break;
+                /* Keymap Reset default layer */
+                case (OP_RESET | ON_PRESS):
                     if (event.pressed) {
-                        layer_switch(action.layer.opt);
+                        default_layer_set(action.layer.val);
+                        overlay_clear();
                     }
                     break;
-                case 0xF0:
-                    // tap toggle
+                case (OP_RESET | ON_RELEASE):
+                    if (!event.pressed) {
+                        default_layer_set(action.layer.val);
+                        overlay_clear();
+                    }
+                    break;
+                case (OP_RESET | ON_BOTH):
+                    default_layer_set(action.layer.val);
+                    overlay_clear();
+                    break;
+
+                /* Keymap Bit invert */
+                case OP_INV:
+                    /* with tap toggle */
                     if (event.pressed) {
                         if (tap_count < TAPPING_TOGGLE) {
-                            layer_switch(action.layer.opt);
+                            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.opt);
+                        if (tap_count <= TAPPING_TOGGLE) {
+                            debug("KEYMAP_INV: tap toggle(release).\n");
+                            keymap_invert(action.layer.val);
                         }
                     }
                     break;
-                case 0xFF:
-                    // change default layer
+                case (OP_INV | ON_PRESS):
                     if (event.pressed) {
-                        default_layer = action.layer.opt;
-                        layer_switch(default_layer);
+                        keymap_invert(action.layer.val);
                     }
                     break;
-                default:
-                    // with tap key
+                case (OP_INV | ON_RELEASE):
+                    if (!event.pressed) {
+                        keymap_invert(action.layer.val);
+                    }
+                    break;
+                case (OP_INV | ON_BOTH):
+                    keymap_invert(action.layer.val);
+                    break;
+
+                /* Keymap Bit on */
+                case OP_ON:
                     if (event.pressed) {
-                       if (tap_count > 0) {
-                            debug("LAYER_PRESSED: Tap: register_code\n");
-                            register_code(action.layer.code);
-                       } else {
-                            debug("LAYER_PRESSED: No tap: layer_switch\n");
-                            layer_switch(action.layer.opt);
-                       }
+                        keymap_on(action.layer.val);
                     } else {
-                        if (tap_count > 0) {
-                            debug("LAYER_PRESSED: Tap: unregister_code\n");
-                            unregister_code(action.layer.code);
-                        } else {
-                            debug("LAYER_PRESSED: No tap: NO ACTION\n");
-                        }
+                        keymap_off(action.layer.val);
                     }
                     break;
-            }
-            break;
-        case ACT_LAYER_RELEASED:
-            switch (action.layer.code) {
-                case 0x00:
+                case (OP_ON | ON_PRESS):
+                    if (event.pressed) {
+                        keymap_on(action.layer.val);
+                    }
+                    break;
+                case (OP_ON | ON_RELEASE):
                     if (!event.pressed) {
-                        layer_switch(action.layer.opt);
+                        keymap_on(action.layer.val);
                     }
                     break;
-                case 0xF0:
-                    // tap toggle
+                case (OP_ON | ON_BOTH):
+                    keymap_on(action.layer.val);
+                    break;
+
+                /* Keymap Bit off */
+                case OP_OFF:
                     if (event.pressed) {
-                        if (tap_count >= TAPPING_TOGGLE) {
-                            debug("LAYER_RELEASED: tap toggle.\n");
-                            layer_switch(action.layer.opt);
-                        }
+                        keymap_off(action.layer.val);
                     } else {
-                        if (tap_count < TAPPING_TOGGLE) {
-                            layer_switch(action.layer.opt);
-                        }
+                        keymap_on(action.layer.val);
+                    }
+                    break;
+                case (OP_OFF | ON_PRESS):
+                    if (event.pressed) {
+                        keymap_off(action.layer.val);
                     }
                     break;
-                case 0xFF:
-                    // change default layer
+                case (OP_OFF | ON_RELEASE):
                     if (!event.pressed) {
-                        default_layer = action.layer.opt;
-                        layer_switch(default_layer);
+                        keymap_off(action.layer.val);
                     }
                     break;
+                case (OP_OFF | ON_BOTH):
+                    keymap_off(action.layer.val);
+                    break;
+
+                /* Keymap Bit set */
+                case OP_SET:
+                    if (event.pressed) {
+                        keymap_set(action.layer.val);
+                    } else {
+                        keymap_clear();
+                    }
+                    break;
+                case (OP_SET | ON_PRESS):
+                    if (event.pressed) {
+                        keymap_set(action.layer.val);
+                    }
+                    break;
+                case (OP_SET | ON_RELEASE):
+                    if (!event.pressed) {
+                        keymap_set(action.layer.val);
+                    }
+                    break;
+                case (OP_SET | ON_BOTH):
+                    keymap_set(action.layer.val);
+                    break;
+
+                /* Keymap Bit invert with tap key */
                 default:
-                    // with tap key
                     if (event.pressed) {
-                       if (tap_count > 0) {
-                            debug("LAYER_RELEASED: Tap: register_code\n");
+                        if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+                            debug("KEYMAP_TAP_KEY: Tap: register_code\n");
                             register_code(action.layer.code);
-                       } else {
-                            debug("LAYER_RELEASED: No tap: NO ACTION\n");
-                       }
+                        } else {
+                            debug("KEYMAP_TAP_KEY: No tap: invert on press\n");
+                            keymap_invert(action.layer.val);
+                        }
                     } else {
-                        if (tap_count > 0) {
-                            debug("LAYER_RELEASED: Tap: unregister_code\n");
+                        if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
+                            debug("KEYMAP_TAP_KEY: Tap: unregister_code\n");
                             unregister_code(action.layer.code);
                         } else {
-                            debug("LAYER_RELEASED: No tap: layer_switch\n");
-                            layer_switch(action.layer.opt);
+                            debug("KEYMAP_TAP_KEY: No tap: invert on release\n");
+                            keymap_invert(action.layer.val);
                         }
                     }
                     break;
             }
             break;
-        case ACT_LAYER_BIT:
+
+        case ACT_OVERLAY:
             switch (action.layer.code) {
-                case 0x00:
-                    if (event.pressed) {
-                        layer_switch(current_layer | action.layer.opt);
+                // Overlay Invert bit4
+                case OP_INV4 | 0:
+                    if (action.layer.val == 0) {
+                        overlay_clear();
+                    } else {
+                        overlay_set(overlay_stat ^ action.layer.val);
+                    }
+                    break;
+                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 OP_INV4 | 2:
+                    if (action.layer.val == 0) {
+                        if (!event.pressed) overlay_clear();
                     } else {
-                        layer_switch(current_layer & ~action.layer.opt);
+                        overlay_set(overlay_stat ^ action.layer.val<<8);
                     }
                     break;
-                case 0xF0:
-                    // tap toggle
+                case OP_INV4 | 3:
+                    if (action.layer.val == 0) {
+                        overlay_clear();
+                    } else {
+                        overlay_set(overlay_stat ^ action.layer.val<<12);
+                    }
+                    break;
+
+                /* Overlay Bit invert */
+                case OP_INV:
+                    /* with tap toggle */
                     if (event.pressed) {
                         if (tap_count < TAPPING_TOGGLE) {
-                            debug("LAYER_BIT: tap toggle(press).\n");
-                            layer_switch(current_layer | action.layer.opt);
+                            debug("OVERLAY_INV: tap toggle(press).\n");
+                            overlay_invert(action.layer.val);
                         }
                     } else {
-                        if (tap_count < TAPPING_TOGGLE) {
-                            debug("LAYER_BIT: tap toggle(release).\n");
-                            layer_switch(current_layer & ~action.layer.opt);
-                        } else {
-                            debug("LAYER_BIT: tap toggle.\n");
-                            layer_switch(current_layer | action.layer.opt);
+                        if (tap_count <= TAPPING_TOGGLE) {
+                            debug("OVERLAY_INV: tap toggle(release).\n");
+                            overlay_invert(action.layer.val);
                         }
                     }
                     break;
-                case 0xFF:
-                    // change default layer
+                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) {
-                        default_layer = current_layer | action.layer.opt;
-                        layer_switch(default_layer);
+                        overlay_off(action.layer.val);
                     } else {
-                        default_layer = current_layer & ~action.layer.opt;
-                        layer_switch(default_layer);
+                        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:
-                    // with tap key
                     if (event.pressed) {
                         if (IS_TAPPING_KEY(event.key) && tap_count > 0) {
-                            debug("LAYER_BIT: Tap: register_code\n");
+                            debug("OVERLAY_TAP_KEY: Tap: register_code\n");
                             register_code(action.layer.code);
                         } else {
-                            debug("LAYER_BIT: No tap: layer_switch(bit on)\n");
-                            layer_switch(current_layer | action.layer.opt);
+                            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_BIT: Tap: unregister_code\n");
+                            debug("OVERLAY_TAP_KEY: Tap: unregister_code\n");
                             unregister_code(action.layer.code);
                         } else {
-                            debug("LAYER_BIT: No tap: layer_switch(bit off)\n");
-                            layer_switch(current_layer & ~action.layer.opt);
+                            debug("OVERLAY_TAP_KEY: No tap: invert on release\n");
+                            overlay_invert(action.layer.val);
                         }
                     }
                     break;
             }
             break;
-        case ACT_LAYER_EXT:
-            switch (action.layer.opt) {
-                case 0x00:
-                    // set default layer when pressed
-                    switch (action.layer.code) {
-                        case 0x00:
-                            if (event.pressed) {
-                                layer_switch(default_layer);
-                            }
-                            break;
-                        case 0xF0:
-                            // tap toggle
-                            if (event.pressed) {
-                                if (tap_count < TAPPING_TOGGLE) {
-                                    layer_switch(default_layer);
-                                }
-                            } else {
-                                if (tap_count >= TAPPING_TOGGLE) {
-                                    debug("LAYER_EXT_PRESSED: tap toggle.\n");
-                                    layer_switch(default_layer);
-                                }
-                            }
-                            break;
-                        case 0xFF:
-                            // change default layer
-                            if (event.pressed) {
-                                default_layer = current_layer;
-                                layer_switch(default_layer);
-                            }
-                            break;
-                        default:
-                            // with tap key
-                            if (event.pressed) {
-                               if (tap_count > 0) {
-                                    debug("LAYER_EXT_PRESSED: Tap: register_code\n");
-                                    register_code(action.layer.code);
-                               } else {
-                                    debug("LAYER_EXT_PRESSED: No tap: layer_switch\n");
-                                    layer_switch(default_layer);
-                               }
-                            } else {
-                                if (tap_count > 0) {
-                                    debug("LAYER_EXT_PRESSED: Tap: unregister_code\n");
-                                    unregister_code(action.layer.code);
-                                } else {
-                                    debug("LAYER_EXT_PRESSED: No tap: NO ACTION\n");
-                                }
-                            }
-                            break;
-                    }
-                    break;
-                case 0x01:
-                    // set default layer when released
-                    switch (action.layer.code) {
-                        case 0x00:
-                            if (!event.pressed) {
-                                layer_switch(default_layer);
-                            }
-                            break;
-                        case 0xF0:
-                            // tap toggle
-                            if (event.pressed) {
-                                if (tap_count >= TAPPING_TOGGLE) {
-                                    debug("LAYER_EXT_RELEASED: tap toggle.\n");
-                                    layer_switch(default_layer);
-                                }
-                            } else {
-                                if (tap_count < TAPPING_TOGGLE) {
-                                    layer_switch(default_layer);
-                                }
-                            }
-                            break;
-                        case 0xFF:
-                            // change default layer
-                            if (!event.pressed) {
-                                default_layer = current_layer;
-                                layer_switch(default_layer);
-                            }
-                            break;
-                        default:
-                            // with tap key
-                            if (event.pressed) {
-                               if (tap_count > 0) {
-                                    debug("LAYER_EXT_RELEASED: Tap: register_code\n");
-                                    register_code(action.layer.code);
-                               } else {
-                                    debug("LAYER_EXT_RELEASED: No tap: NO ACTION\n");
-                               }
-                            } else {
-                                if (tap_count > 0) {
-                                    debug("LAYER_EXT_RELEASED: Tap: unregister_code\n");
-                                    unregister_code(action.layer.code);
-                                } else {
-                                    debug("LAYER_EXT_RELEASED: No tap: layer_switch\n");
-                                    layer_switch(default_layer);
-                                }
-                            }
-                            break;
-                    }
-                    break;
-            }
-            break;
 
         /* Extentions */
         case ACT_MACRO:
+            // TODO
             break;
         case ACT_COMMAND:
             break;
         case ACT_FUNCTION:
-            // TODO
-            action_call_function(event, action.func.id);
+            action_function(record, action.func.id, action.func.opt);
             break;
         default:
             break;
@@ -775,8 +811,7 @@ static bool process_tapping(keyrecord_t *keyp)
             debug_event(event); debug("\n");
             tapping_key = (keyrecord_t){};
             debug_tapping_key();
-            process_action(keyp);
-            return true;
+            return false;
         }
     }
     // not tapping satate
@@ -910,40 +945,25 @@ 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 = keymap_get_action(current_layer, key.pos.row, key.pos.col);
+    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_PRESSED:
-        case ACT_LAYER_BIT:
+        case ACT_KEYMAP:
+        case ACT_OVERLAY:
             switch (action.layer.code) {
-                case 0x00:
-                case 0xF1 ... 0xFF:
-                    return false;
-                case 0xF0:
-                default:
+                case 0x04 ... 0xEF:    /* tap key */
+                case OP_INV:
                     return true;
+                default:
+                    return false;
             }
-            return false;
         case ACT_FUNCTION:
-            if (action.func.opt & 0x1) {
-                return true;
-            }
+            if (action.func.opt & FUNC_TAP) { return true; }
             return false;
     }
     return false;
@@ -955,7 +975,7 @@ bool is_tap_key(key_t key)
  */
 static void debug_event(keyevent_t event)
 {
-    debug_hex16(event.key.raw);
+    debug_hex16((event.key.row<<8) | event.key.col);
     if (event.pressed) debug("d("); else debug("u(");
     debug_dec(event.time); debug(")");
 }
@@ -972,10 +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_PRESSED:     debug("ACT_LAYER_PRESSED");     break;
-        case ACT_LAYER_RELEASED:    debug("ACT_LAYER_RELEASED");    break;
-        case ACT_LAYER_BIT:         debug("ACT_LAYER_BIT");         break;
-        case ACT_LAYER_EXT:         debug("ACT_LAYER_EXT");         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;