]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Macro/PartialMap/macro.c
Fixing release state for keys
[kiibohd-controller.git] / Macro / PartialMap / macro.c
index 3e31bb35d2f8338d863c0dd6c0ca5445a177a8ba..072ce8d461a98dfecfb9b5f9d784c3a124180e13 100644 (file)
@@ -28,7 +28,8 @@
 // Keymaps
 #include "usb_hid.h"
 #include <defaultMap.h>
-#include "generatedKeymap.h" // TODO Use actual generated version
+#include "templateKeymap.h" // TODO Use actual generated version
+//#include "generatedKeymap.h" // TODO Use actual generated version
 
 // Local Includes
 #include "macro.h"
@@ -56,12 +57,13 @@ void cliFunc_macroStep ( char* args );
 
 // Bit positions are important, passes (correct key) always trump incorrect key votes
 typedef enum TriggerMacroVote {
-       TriggerMacroVote_Release      = 0x8, // Correct key
-       TriggerMacroVote_PassRelease  = 0xC, // Correct key (both pass and release)
-       TriggerMacroVote_Pass         = 0x4, // Correct key
-       TriggerMacroVote_DoNothing    = 0x2, // Incorrect key
-       TriggerMacroVote_Fail         = 0x1, // Incorrect key
-       TriggerMacroVote_Invalid      = 0x0, // Invalid state
+       TriggerMacroVote_Release          = 0x10, // Correct key
+       TriggerMacroVote_PassRelease      = 0x18, // Correct key (both pass and release)
+       TriggerMacroVote_Pass             = 0x8,  // Correct key
+       TriggerMacroVote_DoNothingRelease = 0x4,  // Incorrect key
+       TriggerMacroVote_DoNothing        = 0x2,  // Incorrect key
+       TriggerMacroVote_Fail             = 0x1,  // Incorrect key
+       TriggerMacroVote_Invalid          = 0x0,  // Invalid state
 } TriggerMacroVote;
 
 typedef enum TriggerMacroEval {
@@ -123,7 +125,7 @@ unsigned int macroTriggerMacroPendingListSize = 0;
 
 // Layer Index Stack
 //  * When modifying layer state and the state is non-0x0, the stack must be adjusted
-unsigned int macroLayerIndexStack[ LayerNum ] = { 0 };
+unsigned int macroLayerIndexStack[ LayerNum + 1 ] = { 0 };
 unsigned int macroLayerIndexStackSize = 0;
 
 // Pending Result Macro Index List
@@ -135,25 +137,9 @@ unsigned int macroResultMacroPendingListSize = 0;
 
 // ----- Capabilities -----
 
-// Modifies the specified Layer control byte
-// Argument #1: Layer Index -> unsigned int
-// Argument #2: Toggle byte -> uint8_t
-void Macro_layerStateToggle_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+// Sets the given layer with the specified layerState
+void Macro_layerState( uint8_t state, uint8_t stateType, uint16_t layer, uint8_t layerState )
 {
-       // Display capability name
-       if ( stateType == 0xFF && state == 0xFF )
-       {
-               print("Macro_layerState(layerIndex,toggleByte)");
-               return;
-       }
-
-       // Get layer index from arguments
-       // Cast pointer to uint8_t to unsigned int then access that memory location
-       unsigned int layer = *(unsigned int*)(&args[0]);
-
-       // Get layer toggle byte
-       uint8_t toggleByte = args[ sizeof(unsigned int) ];
-
        // Is layer in the LayerIndexStack?
        uint8_t inLayerIndexStack = 0;
        unsigned int stackItem = 0;
@@ -171,15 +157,15 @@ void Macro_layerStateToggle_capability( uint8_t state, uint8_t stateType, uint8_
        }
 
        // Toggle Layer State Byte
-       if ( LayerIndex[ layer ].state & toggleByte )
+       if ( LayerIndex[ layer ].state & layerState )
        {
                // Unset
-               LayerIndex[ layer ].state &= ~toggleByte;
+               LayerIndex[ layer ].state &= ~layerState;
        }
        else
        {
                // Set
-               LayerIndex[ layer ].state |= toggleByte;
+               LayerIndex[ layer ].state |= layerState;
        }
 
        // If the layer was not in the LayerIndexStack add it
@@ -204,6 +190,110 @@ void Macro_layerStateToggle_capability( uint8_t state, uint8_t stateType, uint8_
        }
 }
 
+// Modifies the specified Layer control byte
+// Argument #1: Layer Index -> uint16_t
+// Argument #2: Layer State -> uint8_t
+void Macro_layerState_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Macro_layerState(layerIndex,layerState)");
+               return;
+       }
+
+       // Only use capability on press or release
+       // TODO Analog
+       // XXX This may cause issues, might be better to implement state table here to decide -HaaTa
+       if ( stateType == 0x00 && state == 0x02 ) // Hold condition
+               return;
+
+       // Get layer index from arguments
+       // Cast pointer to uint8_t to unsigned int then access that memory location
+       uint16_t layer = *(uint16_t*)(&args[0]);
+
+       // Get layer toggle byte
+       uint8_t layerState = args[ sizeof(uint16_t) ];
+
+       Macro_layerState( state, stateType, layer, layerState );
+}
+
+
+// Latches given layer
+// Argument #1: Layer Index -> uint16_t
+void Macro_layerLatch_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Macro_layerLatch(layerIndex)");
+               return;
+       }
+
+       // Only use capability on press
+       // TODO Analog
+       // XXX To make sense, this code be on press or release. Or it could even be a sticky shift (why? dunno) -HaaTa
+       if ( stateType == 0x00 && state != 0x01 ) // All normal key conditions except press
+               return;
+
+       // Get layer index from arguments
+       // Cast pointer to uint8_t to unsigned int then access that memory location
+       uint16_t layer = *(uint16_t*)(&args[0]);
+
+       Macro_layerState( state, stateType, layer, 0x02 );
+}
+
+
+// Locks given layer
+// Argument #1: Layer Index -> uint16_t
+void Macro_layerLock_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Macro_layerLock(layerIndex)");
+               return;
+       }
+
+       // Only use capability on press
+       // TODO Analog
+       // XXX Could also be on release, but that's sorta dumb -HaaTa
+       if ( stateType == 0x00 && state != 0x01 ) // All normal key conditions except press
+               return;
+
+       // Get layer index from arguments
+       // Cast pointer to uint8_t to unsigned int then access that memory location
+       uint16_t layer = *(uint16_t*)(&args[0]);
+
+       Macro_layerState( state, stateType, layer, 0x04 );
+}
+
+
+// Shifts given layer
+// Argument #1: Layer Index -> uint16_t
+void Macro_layerShift_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Macro_layerShift(layerIndex)");
+               return;
+       }
+
+       // Only use capability on press or release
+       // TODO Analog
+       if ( stateType == 0x00 && ( state == 0x00 || state == 0x02 ) ) // Only pass press or release conditions
+               return;
+
+       print("YAY");
+
+       // Get layer index from arguments
+       // Cast pointer to uint8_t to unsigned int then access that memory location
+       uint16_t layer = *(uint16_t*)(&args[0]);
+
+       Macro_layerState( state, stateType, layer, 0x01 );
+}
+
 
 
 // ----- Functions -----
@@ -450,10 +540,13 @@ inline TriggerMacroVote Macro_evalLongTriggerMacroVote( TriggerGuide *key, Trigg
                        case 0x01:
                                return TriggerMacroVote_Fail;
 
-                       // Wrong key, held or released, do not pass (no effect)
+                       // Wrong key, held, do not pass (no effect)
                        case 0x02:
-                       case 0x03:
                                return TriggerMacroVote_DoNothing;
+
+                       // Wrong key released, fail out if pos == 0
+                       case 0x03:
+                               return TriggerMacroVote_DoNothing | TriggerMacroVote_DoNothingRelease;
                        }
                }
 
@@ -572,6 +665,11 @@ inline TriggerMacroEval Macro_evalTriggerMacro( unsigned int triggerMacroIndex )
                overallVote |= vote;
        }
 
+       // If no pass vote was found after scanning the entire combo
+       // And this is the first position in the combo, just remove it (nothing important happened)
+       if ( longMacro && overallVote & TriggerMacroVote_DoNothingRelease && pos == 0 )
+               overallVote |= TriggerMacroVote_Fail;
+
        // Decide new state of macro after voting
        // Fail macro, remove from pending list
        if ( overallVote & TriggerMacroVote_Fail )
@@ -631,10 +729,10 @@ inline TriggerMacroEval Macro_evalTriggerMacro( unsigned int triggerMacroIndex )
                        return TriggerMacroEval_Remove;
        }
        // Otherwise, just remove the macro on key release
-       // XXX Might cause some issues
+       // One more result has to be called to indicate to the ResultMacro that the key transitioned to the release state
        else if ( overallVote & TriggerMacroVote_Release )
        {
-               return TriggerMacroEval_Remove;
+               return TriggerMacroEval_DoResultAndRemove;
        }
 
        // If this is a short macro, just remove it
@@ -780,22 +878,18 @@ inline void Macro_process()
                case TriggerMacroEval_DoResult:
                        // Append ResultMacro to PendingList
                        Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
-                       print("D");
 
                default:
                        macroTriggerMacroPendingList[ macroTriggerMacroPendingListTail++ ] = macroTriggerMacroPendingList[ macro ];
-                       print("A");
                        break;
 
                // Trigger Result Macro and Remove (purposely falling through)
                case TriggerMacroEval_DoResultAndRemove:
                        // Append ResultMacro to PendingList
                        Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
-                       print("&");
 
                // Remove Macro from Pending List, nothing to do, removing by default
                case TriggerMacroEval_Remove:
-                       print("R");
                        break;
                }
        }