1 /* Copyright (C) 2014-2015 by Jacob Alexander
3 * This file is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 3 of the License, or
6 * (at your option) any later version.
8 * This file is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this file. If not, see <http://www.gnu.org/licenses/>.
17 // ----- Includes -----
20 #include <Lib/MacroLib.h>
26 #include <scan_loop.h>
30 #include <generatedKeymap.h> // Generated using kll at compile time, in build directory
33 #if defined(ConnectEnabled_define)
34 #include <connect_scan.h>
42 // ----- Function Declarations -----
44 void cliFunc_capList ( char* args );
45 void cliFunc_capSelect ( char* args );
46 void cliFunc_keyHold ( char* args );
47 void cliFunc_keyPress ( char* args );
48 void cliFunc_keyRelease( char* args );
49 void cliFunc_layerDebug( char* args );
50 void cliFunc_layerList ( char* args );
51 void cliFunc_layerState( char* args );
52 void cliFunc_macroDebug( char* args );
53 void cliFunc_macroList ( char* args );
54 void cliFunc_macroProc ( char* args );
55 void cliFunc_macroShow ( char* args );
56 void cliFunc_macroStep ( char* args );
62 // Bit positions are important, passes (correct key) always trump incorrect key votes
63 typedef enum TriggerMacroVote {
64 TriggerMacroVote_Release = 0x10, // Correct key
65 TriggerMacroVote_PassRelease = 0x18, // Correct key (both pass and release)
66 TriggerMacroVote_Pass = 0x8, // Correct key
67 TriggerMacroVote_DoNothingRelease = 0x4, // Incorrect key
68 TriggerMacroVote_DoNothing = 0x2, // Incorrect key
69 TriggerMacroVote_Fail = 0x1, // Incorrect key
70 TriggerMacroVote_Invalid = 0x0, // Invalid state
73 typedef enum TriggerMacroEval {
74 TriggerMacroEval_DoNothing,
75 TriggerMacroEval_DoResult,
76 TriggerMacroEval_DoResultAndRemove,
77 TriggerMacroEval_Remove,
80 typedef enum ResultMacroEval {
81 ResultMacroEval_DoNothing,
82 ResultMacroEval_Remove,
87 // ----- Variables -----
89 // Macro Module command dictionary
90 CLIDict_Entry( capList, "Prints an indexed list of all non USB keycode capabilities." );
91 CLIDict_Entry( capSelect, "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B" );
92 CLIDict_Entry( keyHold, "Send key-hold events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" );
93 CLIDict_Entry( keyPress, "Send key-press events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" );
94 CLIDict_Entry( keyRelease, "Send key-release event to macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" );
95 CLIDict_Entry( layerDebug, "Layer debug mode. Shows layer stack and any changes." );
96 CLIDict_Entry( layerList, "List available layers." );
97 CLIDict_Entry( layerState, "Modify specified indexed layer state <layer> <state byte>." NL "\t\t\033[35mL2\033[0m Indexed Layer 0x02" NL "\t\t0 Off, 1 Shift, 2 Latch, 4 Lock States" );
98 CLIDict_Entry( macroDebug, "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes." );
99 CLIDict_Entry( macroList, "List the defined trigger and result macros." );
100 CLIDict_Entry( macroProc, "Pause/Resume macro processing." );
101 CLIDict_Entry( macroShow, "Show the macro corresponding to the given index." NL "\t\t\033[35mT16\033[0m Indexed Trigger Macro 0x10, \033[35mR12\033[0m Indexed Result Macro 0x0C" );
102 CLIDict_Entry( macroStep, "Do N macro processing steps. Defaults to 1." );
104 CLIDict_Def( macroCLIDict, "Macro Module Commands" ) = {
105 CLIDict_Item( capList ),
106 CLIDict_Item( capSelect ),
107 CLIDict_Item( keyHold ),
108 CLIDict_Item( keyPress ),
109 CLIDict_Item( keyRelease ),
110 CLIDict_Item( layerDebug ),
111 CLIDict_Item( layerList ),
112 CLIDict_Item( layerState ),
113 CLIDict_Item( macroDebug ),
114 CLIDict_Item( macroList ),
115 CLIDict_Item( macroProc ),
116 CLIDict_Item( macroShow ),
117 CLIDict_Item( macroStep ),
118 { 0, 0, 0 } // Null entry for dictionary end
122 // Layer debug flag - If set, displays any changes to layers and the full layer stack on change
123 uint8_t layerDebugMode = 0;
125 // Macro debug flag - If set, clears the USB Buffers after signalling processing completion
126 uint8_t macroDebugMode = 0;
128 // Macro pause flag - If set, the macro module pauses processing, unless unset, or the step counter is non-zero
129 uint8_t macroPauseMode = 0;
131 // Macro step counter - If non-zero, the step counter counts down every time the macro module does one processing loop
132 uint16_t macroStepCounter = 0;
135 // Key Trigger List Buffer and Layer Cache
136 // The layer cache is set on press only, hold and release events refer to the value set on press
137 TriggerGuide macroTriggerListBuffer[ MaxScanCode ];
138 uint8_t macroTriggerListBufferSize = 0;
139 var_uint_t macroTriggerListLayerCache[ MaxScanCode ];
141 // Pending Trigger Macro Index List
142 // * Any trigger macros that need processing from a previous macro processing loop
143 // TODO, figure out a good way to scale this array size without wasting too much memory, but not rejecting macros
144 // Possibly could be calculated by the KLL compiler
145 // XXX It may be possible to calculate the worst case using the KLL compiler
146 uint16_t macroTriggerMacroPendingList[ TriggerMacroNum ] = { 0 };
147 uint16_t macroTriggerMacroPendingListSize = 0;
150 // * When modifying layer state and the state is non-0x0, the stack must be adjusted
151 uint16_t macroLayerIndexStack[ LayerNum + 1 ] = { 0 };
152 uint16_t macroLayerIndexStackSize = 0;
154 // Pending Result Macro Index List
155 // * Any result macro that needs processing from a previous macro processing loop
156 uint16_t macroResultMacroPendingList[ ResultMacroNum ] = { 0 };
157 uint16_t macroResultMacroPendingListSize = 0;
159 // Interconnect ScanCode Cache
160 #if defined(ConnectEnabled_define)
161 // TODO This can be shrunk by the size of the max node 0 ScanCode
162 TriggerGuide macroInterconnectCache[ MaxScanCode ];
163 uint8_t macroInterconnectCacheSize = 0;
168 // ----- Capabilities -----
170 // Sets the given layer with the specified layerState
171 void Macro_layerState( uint8_t state, uint8_t stateType, uint16_t layer, uint8_t layerState )
173 // Ignore if layer does not exist
174 if ( layer >= LayerNum )
177 // Is layer in the LayerIndexStack?
178 uint8_t inLayerIndexStack = 0;
179 uint16_t stackItem = 0;
180 while ( stackItem < macroLayerIndexStackSize )
182 // Flag if layer is already in the LayerIndexStack
183 if ( macroLayerIndexStack[ stackItem ] == layer )
185 inLayerIndexStack = 1;
189 // Increment to next item
193 // Toggle Layer State Byte
194 if ( LayerState[ layer ] & layerState )
197 LayerState[ layer ] &= ~layerState;
202 LayerState[ layer ] |= layerState;
205 // If the layer was not in the LayerIndexStack add it
206 if ( !inLayerIndexStack )
208 macroLayerIndexStack[ macroLayerIndexStackSize++ ] = layer;
211 // If the layer is in the LayerIndexStack and the state is 0x00, remove
212 if ( LayerState[ layer ] == 0x00 && inLayerIndexStack )
214 // Remove the layer from the LayerIndexStack
215 // Using the already positioned stackItem variable from the loop above
216 while ( stackItem < macroLayerIndexStackSize )
218 macroLayerIndexStack[ stackItem ] = macroLayerIndexStack[ stackItem + 1 ];
222 // Reduce LayerIndexStack size
223 macroLayerIndexStackSize--;
227 if ( layerDebugMode )
231 // Iterate over each of the layers displaying the state as a hex value
232 for ( uint16_t index = 0; index < LayerNum; index++ )
234 printHex_op( LayerState[ index ], 0 );
237 // Always show the default layer (it's always 0)
240 // Iterate over the layer stack starting from the bottom of the stack
241 for ( uint16_t index = macroLayerIndexStackSize; index > 0; index-- )
244 printHex_op( macroLayerIndexStack[ index - 1 ], 0 );
251 // Modifies the specified Layer control byte
252 // Argument #1: Layer Index -> uint16_t
253 // Argument #2: Layer State -> uint8_t
254 void Macro_layerState_capability( uint8_t state, uint8_t stateType, uint8_t *args )
256 // Display capability name
257 if ( stateType == 0xFF && state == 0xFF )
259 print("Macro_layerState(layerIndex,layerState)");
263 // Only use capability on press or release
265 // XXX This may cause issues, might be better to implement state table here to decide -HaaTa
266 if ( stateType == 0x00 && state == 0x02 ) // Hold condition
269 // Get layer index from arguments
270 // Cast pointer to uint8_t to uint16_t then access that memory location
271 uint16_t layer = *(uint16_t*)(&args[0]);
273 // Get layer toggle byte
274 uint8_t layerState = args[ sizeof(uint16_t) ];
276 Macro_layerState( state, stateType, layer, layerState );
280 // Latches given layer
281 // Argument #1: Layer Index -> uint16_t
282 void Macro_layerLatch_capability( uint8_t state, uint8_t stateType, uint8_t *args )
284 // Display capability name
285 if ( stateType == 0xFF && state == 0xFF )
287 print("Macro_layerLatch(layerIndex)");
291 // Only use capability on press
293 if ( stateType == 0x00 && state != 0x03 ) // Only on release
296 // Get layer index from arguments
297 // Cast pointer to uint8_t to uint16_t then access that memory location
298 uint16_t layer = *(uint16_t*)(&args[0]);
300 Macro_layerState( state, stateType, layer, 0x02 );
305 // Argument #1: Layer Index -> uint16_t
306 void Macro_layerLock_capability( uint8_t state, uint8_t stateType, uint8_t *args )
308 // Display capability name
309 if ( stateType == 0xFF && state == 0xFF )
311 print("Macro_layerLock(layerIndex)");
315 // Only use capability on press
317 // XXX Could also be on release, but that's sorta dumb -HaaTa
318 if ( stateType == 0x00 && state != 0x01 ) // All normal key conditions except press
321 // Get layer index from arguments
322 // Cast pointer to uint8_t to uint16_t then access that memory location
323 uint16_t layer = *(uint16_t*)(&args[0]);
325 Macro_layerState( state, stateType, layer, 0x04 );
329 // Shifts given layer
330 // Argument #1: Layer Index -> uint16_t
331 void Macro_layerShift_capability( uint8_t state, uint8_t stateType, uint8_t *args )
333 // Display capability name
334 if ( stateType == 0xFF && state == 0xFF )
336 print("Macro_layerShift(layerIndex)");
340 // Only use capability on press or release
342 if ( stateType == 0x00 && ( state == 0x00 || state == 0x02 ) ) // Only pass press or release conditions
345 // Get layer index from arguments
346 // Cast pointer to uint8_t to uint16_t then access that memory location
347 uint16_t layer = *(uint16_t*)(&args[0]);
349 Macro_layerState( state, stateType, layer, 0x01 );
354 // ----- Functions -----
356 // Looks up the trigger list for the given scan code (from the active layer)
357 // NOTE: Calling function must handle the NULL pointer case
358 nat_ptr_t *Macro_layerLookup( TriggerGuide *guide, uint8_t latch_expire )
360 uint8_t scanCode = guide->scanCode;
363 // If a normal key, and not pressed, do a layer cache lookup
364 if ( guide->type == 0x00 && guide->state != 0x01 )
367 var_uint_t cachedLayer = macroTriggerListLayerCache[ scanCode ];
369 // Lookup map, then layer
370 nat_ptr_t **map = (nat_ptr_t**)LayerIndex[ cachedLayer ].triggerMap;
371 const Layer *layer = &LayerIndex[ cachedLayer ];
373 return map[ scanCode - layer->first ];
376 // If no trigger macro is defined at the given layer, fallthrough to the next layer
377 for ( uint16_t layerIndex = 0; layerIndex < macroLayerIndexStackSize; layerIndex++ )
380 const Layer *layer = &LayerIndex[ macroLayerIndexStack[ layerIndex ] ];
382 // Check if latch has been pressed for this layer
383 // XXX Regardless of whether a key is found, the latch is removed on first lookup
384 uint8_t latch = LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x02;
385 if ( latch && latch_expire )
387 Macro_layerState( 0, 0, macroLayerIndexStack[ layerIndex ], 0x02 );
390 // Only use layer, if state is valid
391 // XOR each of the state bits
392 // If only two are enabled, do not use this state
393 if ( (LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x01) ^ (latch>>1) ^ ((LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x04)>>2) )
396 nat_ptr_t **map = (nat_ptr_t**)layer->triggerMap;
398 // Determine if layer has key defined
399 // Make sure scanCode is between layer first and last scancodes
401 && scanCode <= layer->last
402 && scanCode >= layer->first
403 && *map[ scanCode - layer->first ] != 0 )
405 // Set the layer cache
406 macroTriggerListLayerCache[ scanCode ] = macroLayerIndexStack[ layerIndex ];
408 return map[ scanCode - layer->first ];
413 // Do lookup on default layer
414 nat_ptr_t **map = (nat_ptr_t**)LayerIndex[0].triggerMap;
416 // Lookup default layer
417 const Layer *layer = &LayerIndex[0];
419 // Make sure scanCode is between layer first and last scancodes
421 && scanCode <= layer->last
422 && scanCode >= layer->first
423 && *map[ scanCode - layer->first ] != 0 )
425 // Set the layer cache to default map
426 macroTriggerListLayerCache[ scanCode ] = 0;
428 return map[ scanCode - layer->first ];
431 // Otherwise no defined Trigger Macro
432 erro_msg("Scan Code has no defined Trigger Macro: ");
433 printHex( scanCode );
439 // Add an interconnect ScanCode
440 // These are handled differently (less information is sent, hold/off states must be assumed)
441 #if defined(ConnectEnabled_define)
442 inline void Macro_interconnectAdd( void *trigger_ptr )
444 TriggerGuide *trigger = (TriggerGuide*)trigger_ptr;
448 switch ( trigger->type )
450 case 0x00: // Normal key
451 switch ( trigger->state )
459 erro_msg("Invalid key state - ");
465 // Invalid TriggerGuide type
467 erro_msg("Invalid type - ");
472 // Check if ScanCode is out of range
473 if ( scanCode > MaxScanCode )
475 warn_msg("ScanCode is out of range/not defined - ");
479 // Display TriggerGuide
482 printHex( trigger->type );
484 printHex( trigger->state );
486 printHex( trigger->scanCode );
491 // Add trigger to the Interconnect Cache
492 // During each processing loop, a scancode may be re-added depending on it's state
493 for ( uint8_t c = 0; c < macroInterconnectCacheSize; c++ )
495 // Check if the same ScanCode
496 if ( macroInterconnectCache[ c ].scanCode == trigger->scanCode )
499 macroInterconnectCache[ c ].state = trigger->state;
504 // If not in the list, add it
505 macroInterconnectCache[ macroInterconnectCacheSize++ ] = *trigger;
510 // Update the scancode key state
516 // * 0x04 - Unpressed (this is currently ignored)
517 inline void Macro_keyState( uint8_t scanCode, uint8_t state )
519 #if defined(ConnectEnabled_define)
520 // Only compile in if a Connect node module is available
521 if ( !Connect_master )
523 // ScanCodes are only added if there was a state change (on/off)
533 // Only add to macro trigger list if one of three states
536 case 0x01: // Pressed
538 case 0x03: // Released
539 // Check if ScanCode is out of range
540 if ( scanCode > MaxScanCode )
542 warn_msg("ScanCode is out of range/not defined: ");
543 printHex( scanCode );
548 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
549 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
550 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x00; // Normal key
551 macroTriggerListBufferSize++;
557 // Update the scancode analog state
561 // * 0x02-0xFF - Analog value (low to high)
562 inline void Macro_analogState( uint8_t scanCode, uint8_t state )
564 // Only add to macro trigger list if non-off
565 // TODO Handle change for interconnect
568 // Check if ScanCode is out of range
569 if ( scanCode > MaxScanCode )
571 warn_msg("ScanCode is out of range/not defined: ");
572 printHex( scanCode );
577 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
578 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
579 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x02; // Analog key
580 macroTriggerListBufferSize++;
589 inline void Macro_ledState( uint8_t ledCode, uint8_t state )
591 // Only add to macro trigger list if non-off
592 // TODO Handle change for interconnect
595 // Check if LedCode is out of range
598 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = ledCode;
599 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
600 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x01; // LED key
601 macroTriggerListBufferSize++;
606 // Append result macro to pending list, checking for duplicates
607 // Do nothing if duplicate
608 inline void Macro_appendResultMacroToPendingList( const TriggerMacro *triggerMacro )
610 // Lookup result macro index
611 var_uint_t resultMacroIndex = triggerMacro->result;
613 // Iterate through result macro pending list, making sure this macro hasn't been added yet
614 for ( var_uint_t macro = 0; macro < macroResultMacroPendingListSize; macro++ )
616 // If duplicate found, do nothing
617 if ( macroResultMacroPendingList[ macro ] == resultMacroIndex )
621 // No duplicates found, add to pending list
622 macroResultMacroPendingList[ macroResultMacroPendingListSize++ ] = resultMacroIndex;
624 // Lookup scanCode of the last key in the last combo
626 for ( uint8_t comboLength = triggerMacro->guide[0]; comboLength > 0; )
628 pos += TriggerGuideSize * comboLength + 1;
629 comboLength = triggerMacro->guide[ pos ];
632 uint8_t scanCode = ((TriggerGuide*)&triggerMacro->guide[ pos - TriggerGuideSize ])->scanCode;
634 // Lookup scanCode in buffer list for the current state and stateType
635 for ( uint8_t keyIndex = 0; keyIndex < macroTriggerListBufferSize; keyIndex++ )
637 if ( macroTriggerListBuffer[ keyIndex ].scanCode == scanCode )
639 ResultMacroRecordList[ resultMacroIndex ].state = macroTriggerListBuffer[ keyIndex ].state;
640 ResultMacroRecordList[ resultMacroIndex ].stateType = macroTriggerListBuffer[ keyIndex ].type;
644 // Reset the macro position
645 ResultMacroRecordList[ resultMacroIndex ].pos = 0;
649 // Determine if long ResultMacro (more than 1 seqence element)
650 inline uint8_t Macro_isLongResultMacro( const ResultMacro *macro )
652 // Check the second sequence combo length
653 // If non-zero return non-zero (long sequence)
654 // 0 otherwise (short sequence)
655 var_uint_t position = 1;
656 for ( var_uint_t result = 0; result < macro->guide[0]; result++ )
657 position += ResultGuideSize( (ResultGuide*)¯o->guide[ position ] );
658 return macro->guide[ position ];
662 // Determine if long TriggerMacro (more than 1 sequence element)
663 inline uint8_t Macro_isLongTriggerMacro( const TriggerMacro *macro )
665 // Check the second sequence combo length
666 // If non-zero return non-zero (long sequence)
667 // 0 otherwise (short sequence)
668 return macro->guide[ macro->guide[0] * TriggerGuideSize + 1 ];
672 // Votes on the given key vs. guide, short macros
673 inline TriggerMacroVote Macro_evalShortTriggerMacroVote( TriggerGuide *key, TriggerGuide *guide )
675 // Depending on key type
676 switch ( guide->type )
680 // For short TriggerMacros completely ignore incorrect keys
681 if ( guide->scanCode == key->scanCode )
683 switch ( key->state )
685 // Correct key, pressed, possible passing
687 return TriggerMacroVote_Pass;
689 // Correct key, held, possible passing or release
691 return TriggerMacroVote_PassRelease;
693 // Correct key, released, possible release
695 return TriggerMacroVote_Release;
699 return TriggerMacroVote_DoNothing;
703 erro_print("LED State Type - Not implemented...");
708 erro_print("Analog State Type - Not implemented...");
711 // Invalid State Type
713 erro_print("Invalid State Type. This is a bug.");
717 // XXX Shouldn't reach here
718 return TriggerMacroVote_Invalid;
722 // Votes on the given key vs. guide, long macros
723 // A long macro is defined as a guide with more than 1 combo
724 inline TriggerMacroVote Macro_evalLongTriggerMacroVote( TriggerGuide *key, TriggerGuide *guide )
726 // Depending on key type
727 switch ( guide->type )
731 // Depending on the state of the buffered key, make voting decision
733 if ( guide->scanCode != key->scanCode )
735 switch ( key->state )
737 // Wrong key, pressed, fail
739 return TriggerMacroVote_Fail;
741 // Wrong key, held, do not pass (no effect)
743 return TriggerMacroVote_DoNothing;
745 // Wrong key released, fail out if pos == 0
747 return TriggerMacroVote_DoNothing | TriggerMacroVote_DoNothingRelease;
754 switch ( key->state )
756 // Correct key, pressed, possible passing
758 return TriggerMacroVote_Pass;
760 // Correct key, held, possible passing or release
762 return TriggerMacroVote_PassRelease;
764 // Correct key, released, possible release
766 return TriggerMacroVote_Release;
774 erro_print("LED State Type - Not implemented...");
779 erro_print("Analog State Type - Not implemented...");
782 // Invalid State Type
784 erro_print("Invalid State Type. This is a bug.");
788 // XXX Shouldn't reach here
789 return TriggerMacroVote_Invalid;
793 // Evaluate/Update TriggerMacro
794 TriggerMacroEval Macro_evalTriggerMacro( var_uint_t triggerMacroIndex )
796 // Lookup TriggerMacro
797 const TriggerMacro *macro = &TriggerMacroList[ triggerMacroIndex ];
798 TriggerMacroRecord *record = &TriggerMacroRecordList[ triggerMacroIndex ];
800 // Check if macro has finished and should be incremented sequence elements
801 if ( record->state == TriggerMacro_Release )
803 record->state = TriggerMacro_Waiting;
804 record->pos = record->pos + macro->guide[ record->pos ] * TriggerGuideSize + 1;
807 // Current Macro position
808 var_uint_t pos = record->pos;
810 // Length of the combo being processed
811 uint8_t comboLength = macro->guide[ pos ] * TriggerGuideSize;
813 // If no combo items are left, remove the TriggerMacro from the pending list
814 if ( comboLength == 0 )
816 return TriggerMacroEval_Remove;
819 // Check if this is a long Trigger Macro
820 uint8_t longMacro = Macro_isLongTriggerMacro( macro );
822 // Iterate through the items in the combo, voting the on the key state
823 // If any of the pressed keys do not match, fail the macro
825 // The macro is waiting for input when in the TriggerMacro_Waiting state
826 // Once all keys have been pressed/held (only those keys), entered TriggerMacro_Press state (passing)
827 // Transition to the next combo (if it exists) when a single key is released (TriggerMacro_Release state)
828 // On scan after position increment, change to TriggerMacro_Waiting state
829 // TODO Add support for system LED states (NumLock, CapsLock, etc.)
830 // TODO Add support for analog key states
831 // TODO Add support for 0x00 Key state (not pressing a key, not all that useful in general)
832 // TODO Add support for Press/Hold/Release differentiation when evaluating (not sure if useful)
833 TriggerMacroVote overallVote = TriggerMacroVote_Invalid;
834 for ( uint8_t comboItem = pos + 1; comboItem < pos + comboLength + 1; comboItem += TriggerGuideSize )
836 // Assign TriggerGuide element (key type, state and scancode)
837 TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ comboItem ]);
839 TriggerMacroVote vote = TriggerMacroVote_Invalid;
840 // Iterate through the key buffer, comparing to each key in the combo
841 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
843 // Lookup key information
844 TriggerGuide *keyInfo = ¯oTriggerListBuffer[ key ];
846 // If vote is a pass (>= 0x08, no more keys in the combo need to be looked at)
847 // Also mask all of the non-passing votes
849 ? Macro_evalLongTriggerMacroVote( keyInfo, guide )
850 : Macro_evalShortTriggerMacroVote( keyInfo, guide );
851 if ( vote >= TriggerMacroVote_Pass )
853 vote &= TriggerMacroVote_Release | TriggerMacroVote_PassRelease | TriggerMacroVote_Pass;
858 // If no pass vote was found after scanning all of the keys
859 // Fail the combo, if this is a short macro (long macros already will have a fail vote)
860 if ( !longMacro && vote < TriggerMacroVote_Pass )
861 vote |= TriggerMacroVote_Fail;
863 // After voting, append to overall vote
867 // If no pass vote was found after scanning the entire combo
868 // And this is the first position in the combo, just remove it (nothing important happened)
869 if ( longMacro && overallVote & TriggerMacroVote_DoNothingRelease && pos == 0 )
870 overallVote |= TriggerMacroVote_Fail;
872 // Decide new state of macro after voting
873 // Fail macro, remove from pending list
874 if ( overallVote & TriggerMacroVote_Fail )
876 return TriggerMacroEval_Remove;
878 // Do nothing, incorrect key is being held or released
879 else if ( overallVote & TriggerMacroVote_DoNothing && longMacro )
881 // Just doing nothing :)
883 // If ready for transition and in Press state, set to Waiting and increment combo position
884 // Position is incremented (and possibly remove the macro from the pending list) on the next iteration
885 else if ( overallVote & TriggerMacroVote_Release && record->state == TriggerMacro_Press )
887 record->state = TriggerMacro_Release;
889 // If this is the last combo in the sequence, remove from the pending list
890 if ( macro->guide[ record->pos + macro->guide[ record->pos ] * TriggerGuideSize + 1 ] == 0 )
891 return TriggerMacroEval_DoResultAndRemove;
893 // If passing and in Waiting state, set macro state to Press
894 else if ( overallVote & TriggerMacroVote_Pass
895 && ( record->state == TriggerMacro_Waiting || record->state == TriggerMacro_Press ) )
897 record->state = TriggerMacro_Press;
899 // If in press state, and this is the final combo, send request for ResultMacro
900 // Check to see if the result macro only has a single element
901 // If this result macro has more than 1 key, only send once
902 // TODO Add option to have long macro repeat rate
903 if ( macro->guide[ pos + comboLength + 1 ] == 0 )
905 // Long result macro (more than 1 combo)
906 if ( Macro_isLongResultMacro( &ResultMacroList[ macro->result ] ) )
908 // Only ever trigger result once, on press
909 if ( overallVote == TriggerMacroVote_Pass )
911 return TriggerMacroEval_DoResultAndRemove;
914 // Short result macro
917 // Only trigger result once, on press, if long trigger (more than 1 combo)
918 if ( Macro_isLongTriggerMacro( macro ) )
920 return TriggerMacroEval_DoResultAndRemove;
922 // Otherwise, trigger result continuously
925 return TriggerMacroEval_DoResult;
930 // Otherwise, just remove the macro on key release
931 // One more result has to be called to indicate to the ResultMacro that the key transitioned to the release state
932 else if ( overallVote & TriggerMacroVote_Release )
934 return TriggerMacroEval_DoResultAndRemove;
937 // If this is a short macro, just remove it
938 // The state can be rebuilt on the next iteration
940 return TriggerMacroEval_Remove;
942 return TriggerMacroEval_DoNothing;
946 // Evaluate/Update ResultMacro
947 inline ResultMacroEval Macro_evalResultMacro( var_uint_t resultMacroIndex )
949 // Lookup ResultMacro
950 const ResultMacro *macro = &ResultMacroList[ resultMacroIndex ];
951 ResultMacroRecord *record = &ResultMacroRecordList[ resultMacroIndex ];
953 // Current Macro position
954 var_uint_t pos = record->pos;
956 // Length of combo being processed
957 uint8_t comboLength = macro->guide[ pos ];
959 // Function Counter, used to keep track of the combo items processed
960 var_uint_t funcCount = 0;
962 // Combo Item Position within the guide
963 var_uint_t comboItem = pos + 1;
965 // Iterate through the Result Combo
966 while ( funcCount < comboLength )
968 // Assign TriggerGuide element (key type, state and scancode)
969 ResultGuide *guide = (ResultGuide*)(¯o->guide[ comboItem ]);
971 // Do lookup on capability function
972 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
975 capability( record->state, record->stateType, &guide->args );
977 // Increment counters
979 comboItem += ResultGuideSize( (ResultGuide*)(¯o->guide[ comboItem ]) );
982 // Move to next item in the sequence
983 record->pos = comboItem;
985 // If the ResultMacro is finished, remove
986 if ( macro->guide[ comboItem ] == 0 )
989 return ResultMacroEval_Remove;
992 // Otherwise leave the macro in the list
993 return ResultMacroEval_DoNothing;
997 // Update pending trigger list
998 inline void Macro_updateTriggerMacroPendingList()
1000 // Iterate over the macroTriggerListBuffer to add any new Trigger Macros to the pending list
1001 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
1004 // TODO Analog Switches
1005 // Only add TriggerMacro to pending list if key was pressed (not held, released or off)
1006 if ( macroTriggerListBuffer[ key ].state == 0x00 && macroTriggerListBuffer[ key ].state != 0x01 )
1010 // If this is a release case, indicate to layer lookup for possible latch expiry
1011 uint8_t latch_expire = macroTriggerListBuffer[ key ].state == 0x03;
1013 // Lookup Trigger List
1014 nat_ptr_t *triggerList = Macro_layerLookup( ¯oTriggerListBuffer[ key ], latch_expire );
1016 // If there was an error during lookup, skip
1017 if ( triggerList == 0 )
1020 // Number of Triggers in list
1021 nat_ptr_t triggerListSize = triggerList[0];
1023 // Iterate over triggerList to see if any TriggerMacros need to be added
1024 // First item is the number of items in the TriggerList
1025 for ( var_uint_t macro = 1; macro < triggerListSize + 1; macro++ )
1027 // Lookup trigger macro index
1028 var_uint_t triggerMacroIndex = triggerList[ macro ];
1030 // Iterate over macroTriggerMacroPendingList to see if any macro in the scancode's
1031 // triggerList needs to be added
1032 var_uint_t pending = 0;
1033 for ( ; pending < macroTriggerMacroPendingListSize; pending++ )
1035 // Stop scanning if the trigger macro index is found in the pending list
1036 if ( macroTriggerMacroPendingList[ pending ] == triggerMacroIndex )
1040 // If the triggerMacroIndex (macro) was not found in the macroTriggerMacroPendingList
1041 // Add it to the list
1042 if ( pending == macroTriggerMacroPendingListSize )
1044 macroTriggerMacroPendingList[ macroTriggerMacroPendingListSize++ ] = triggerMacroIndex;
1046 // Reset macro position
1047 TriggerMacroRecordList[ triggerMacroIndex ].pos = 0;
1048 TriggerMacroRecordList[ triggerMacroIndex ].state = TriggerMacro_Waiting;
1055 // Macro Procesing Loop
1056 // Called once per USB buffer send
1057 inline void Macro_process()
1059 #if defined(ConnectEnabled_define)
1060 // Only compile in if a Connect node module is available
1061 // If this is a interconnect slave node, send all scancodes to master node
1062 if ( !Connect_master )
1064 if ( macroTriggerListBufferSize > 0 )
1066 Connect_send_ScanCode( Connect_id, macroTriggerListBuffer, macroTriggerListBufferSize );
1067 macroTriggerListBufferSize = 0;
1073 // Only do one round of macro processing between Output Module timer sends
1074 if ( USBKeys_Sent != 0 )
1077 #if defined(ConnectEnabled_define)
1078 // Check if there are any ScanCodes in the interconnect cache to process
1079 if ( Connect_master && macroInterconnectCacheSize > 0 )
1081 // Iterate over all the cache ScanCodes
1082 uint8_t currentInterconnectCacheSize = macroInterconnectCacheSize;
1083 macroInterconnectCacheSize = 0;
1084 for ( uint8_t c = 0; c < currentInterconnectCacheSize; c++ )
1086 // Add to the trigger list
1087 macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = macroInterconnectCache[ c ];
1089 // TODO Handle other TriggerGuide types (e.g. analog)
1090 switch ( macroInterconnectCache[ c ].type )
1092 // Normal (Press/Hold/Release)
1094 // Decide what to do based on the current state
1095 switch ( macroInterconnectCache[ c ].state )
1097 // Re-add to interconnect cache in hold state
1099 //case 0x02: // Hold // XXX Why does this not work? -HaaTa
1100 macroInterconnectCache[ c ].state = 0x02;
1101 macroInterconnectCache[ macroInterconnectCacheSize++ ] = macroInterconnectCache[ c ];
1103 case 0x03: // Remove
1105 // Otherwise, do not re-add
1112 // If the pause flag is set, only process if the step counter is non-zero
1113 if ( macroPauseMode )
1115 if ( macroStepCounter == 0 )
1118 // Proceed, decrementing the step counter
1120 dbug_print("Macro Step");
1123 // Update pending trigger list, before processing TriggerMacros
1124 Macro_updateTriggerMacroPendingList();
1126 // Tail pointer for macroTriggerMacroPendingList
1127 // Macros must be explicitly re-added
1128 var_uint_t macroTriggerMacroPendingListTail = 0;
1130 // Iterate through the pending TriggerMacros, processing each of them
1131 for ( var_uint_t macro = 0; macro < macroTriggerMacroPendingListSize; macro++ )
1133 switch ( Macro_evalTriggerMacro( macroTriggerMacroPendingList[ macro ] ) )
1135 // Trigger Result Macro (purposely falling through)
1136 case TriggerMacroEval_DoResult:
1137 // Append ResultMacro to PendingList
1138 Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
1141 macroTriggerMacroPendingList[ macroTriggerMacroPendingListTail++ ] = macroTriggerMacroPendingList[ macro ];
1144 // Trigger Result Macro and Remove (purposely falling through)
1145 case TriggerMacroEval_DoResultAndRemove:
1146 // Append ResultMacro to PendingList
1147 Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
1149 // Remove Macro from Pending List, nothing to do, removing by default
1150 case TriggerMacroEval_Remove:
1155 // Update the macroTriggerMacroPendingListSize with the tail pointer
1156 macroTriggerMacroPendingListSize = macroTriggerMacroPendingListTail;
1159 // Tail pointer for macroResultMacroPendingList
1160 // Macros must be explicitly re-added
1161 var_uint_t macroResultMacroPendingListTail = 0;
1163 // Iterate through the pending ResultMacros, processing each of them
1164 for ( var_uint_t macro = 0; macro < macroResultMacroPendingListSize; macro++ )
1166 switch ( Macro_evalResultMacro( macroResultMacroPendingList[ macro ] ) )
1168 // Re-add macros to pending list
1169 case ResultMacroEval_DoNothing:
1171 macroResultMacroPendingList[ macroResultMacroPendingListTail++ ] = macroResultMacroPendingList[ macro ];
1174 // Remove Macro from Pending List, nothing to do, removing by default
1175 case ResultMacroEval_Remove:
1180 // Update the macroResultMacroPendingListSize with the tail pointer
1181 macroResultMacroPendingListSize = macroResultMacroPendingListTail;
1183 // Signal buffer that we've used it
1184 Scan_finishedWithMacro( macroTriggerListBufferSize );
1186 // Reset TriggerList buffer
1187 macroTriggerListBufferSize = 0;
1189 // If Macro debug mode is set, clear the USB Buffer
1190 if ( macroDebugMode )
1192 USBKeys_Modifiers = 0;
1198 inline void Macro_setup()
1200 // Register Macro CLI dictionary
1201 CLI_registerDictionary( macroCLIDict, macroCLIDictName );
1203 // Disable Macro debug mode
1206 // Disable Macro pause flag
1209 // Set Macro step counter to zero
1210 macroStepCounter = 0;
1212 // Make sure macro trigger buffer is empty
1213 macroTriggerListBufferSize = 0;
1215 // Initialize TriggerMacro states
1216 for ( var_uint_t macro = 0; macro < TriggerMacroNum; macro++ )
1218 TriggerMacroRecordList[ macro ].pos = 0;
1219 TriggerMacroRecordList[ macro ].state = TriggerMacro_Waiting;
1222 // Initialize ResultMacro states
1223 for ( var_uint_t macro = 0; macro < ResultMacroNum; macro++ )
1225 ResultMacroRecordList[ macro ].pos = 0;
1226 ResultMacroRecordList[ macro ].state = 0;
1227 ResultMacroRecordList[ macro ].stateType = 0;
1232 // ----- CLI Command Functions -----
1234 void cliFunc_capList( char* args )
1237 info_msg("Capabilities List ");
1238 printHex( CapabilitiesNum );
1240 // Iterate through all of the capabilities and display them
1241 for ( var_uint_t cap = 0; cap < CapabilitiesNum; cap++ )
1247 // Display/Lookup Capability Name (utilize debug mode of capability)
1248 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
1249 capability( 0xFF, 0xFF, 0 );
1253 void cliFunc_capSelect( char* args )
1255 // Parse code from argument
1258 char* arg2Ptr = args;
1260 // Total number of args to scan (must do a lookup if a keyboard capability is selected)
1261 var_uint_t totalArgs = 2; // Always at least two args
1264 // Arguments used for keyboard capability function
1265 var_uint_t argSetCount = 0;
1266 uint8_t *argSet = (uint8_t*)args;
1269 for ( var_uint_t c = 0; argSetCount < totalArgs; c++ )
1272 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1274 // Stop processing args if no more are found
1275 // Extra arguments are ignored
1276 if ( *arg1Ptr == '\0' )
1279 // For the first argument, choose the capability
1280 if ( c == 0 ) switch ( arg1Ptr[0] )
1282 // Keyboard Capability
1284 // Determine capability index
1285 cap = numToInt( &arg1Ptr[1] );
1287 // Lookup the number of args
1288 totalArgs += CapabilitiesList[ cap ].argCount;
1292 // Because allocating memory isn't doable, and the argument count is arbitrary
1293 // The argument pointer is repurposed as the argument list (much smaller anyways)
1294 argSet[ argSetCount++ ] = (uint8_t)numToInt( arg1Ptr );
1296 // Once all the arguments are prepared, call the keyboard capability function
1297 if ( argSetCount == totalArgs )
1299 // Indicate that the capability was called
1304 printHex( argSet[0] );
1306 printHex( argSet[1] );
1308 printHex( argSet[2] );
1311 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
1312 capability( argSet[0], argSet[1], &argSet[2] );
1317 void cliFunc_keyHold( char* args )
1319 // Parse codes from arguments
1322 char* arg2Ptr = args;
1328 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1330 // Stop processing args if no more are found
1331 if ( *arg1Ptr == '\0' )
1334 // Ignore non-Scancode numbers
1335 switch ( arg1Ptr[0] )
1339 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x02 ); // Hold scancode
1345 void cliFunc_keyPress( char* args )
1347 // Parse codes from arguments
1350 char* arg2Ptr = args;
1356 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1358 // Stop processing args if no more are found
1359 if ( *arg1Ptr == '\0' )
1362 // Ignore non-Scancode numbers
1363 switch ( arg1Ptr[0] )
1367 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x01 ); // Press scancode
1373 void cliFunc_keyRelease( char* args )
1375 // Parse codes from arguments
1378 char* arg2Ptr = args;
1384 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1386 // Stop processing args if no more are found
1387 if ( *arg1Ptr == '\0' )
1390 // Ignore non-Scancode numbers
1391 switch ( arg1Ptr[0] )
1395 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x03 ); // Release scancode
1401 void cliFunc_layerDebug( char *args )
1403 // Toggle layer debug mode
1404 layerDebugMode = layerDebugMode ? 0 : 1;
1407 info_msg("Layer Debug Mode: ");
1408 printInt8( layerDebugMode );
1411 void cliFunc_layerList( char* args )
1414 info_msg("Layer List");
1416 // Iterate through all of the layers and display them
1417 for ( uint16_t layer = 0; layer < LayerNum; layer++ )
1423 // Display layer name
1424 dPrint( (char*)LayerIndex[ layer ].name );
1428 print(" \033[1m(default)\033[0m");
1431 print( NL "\t\t Layer State: " );
1432 printHex( LayerState[ layer ] );
1434 // First -> Last Indices
1435 print(" First -> Last Indices: ");
1436 printHex( LayerIndex[ layer ].first );
1438 printHex( LayerIndex[ layer ].last );
1442 void cliFunc_layerState( char* args )
1444 // Parse codes from arguments
1447 char* arg2Ptr = args;
1452 // Process first two args
1453 for ( uint8_t c = 0; c < 2; c++ )
1456 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1458 // Stop processing args if no more are found
1459 if ( *arg1Ptr == '\0' )
1464 // First argument (e.g. L1)
1466 if ( arg1Ptr[0] != 'L' )
1469 arg1 = (uint8_t)numToInt( &arg1Ptr[1] );
1471 // Second argument (e.g. 4)
1473 arg2 = (uint8_t)numToInt( arg1Ptr );
1475 // Display operation (to indicate that it worked)
1477 info_msg("Setting Layer L");
1482 // Set the layer state
1483 LayerState[ arg1 ] = arg2;
1489 void cliFunc_macroDebug( char* args )
1491 // Toggle macro debug mode
1492 macroDebugMode = macroDebugMode ? 0 : 1;
1495 info_msg("Macro Debug Mode: ");
1496 printInt8( macroDebugMode );
1499 void cliFunc_macroList( char* args )
1501 // Show pending key events
1503 info_msg("Pending Key Events: ");
1504 printInt16( (uint16_t)macroTriggerListBufferSize );
1506 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
1508 printHex( macroTriggerListBuffer[ key ].scanCode );
1512 // Show pending trigger macros
1514 info_msg("Pending Trigger Macros: ");
1515 printInt16( (uint16_t)macroTriggerMacroPendingListSize );
1517 for ( var_uint_t macro = 0; macro < macroTriggerMacroPendingListSize; macro++ )
1519 printHex( macroTriggerMacroPendingList[ macro ] );
1523 // Show pending result macros
1525 info_msg("Pending Result Macros: ");
1526 printInt16( (uint16_t)macroResultMacroPendingListSize );
1528 for ( var_uint_t macro = 0; macro < macroResultMacroPendingListSize; macro++ )
1530 printHex( macroResultMacroPendingList[ macro ] );
1534 // Show available trigger macro indices
1536 info_msg("Trigger Macros Range: T0 -> T");
1537 printInt16( (uint16_t)TriggerMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
1539 // Show available result macro indices
1541 info_msg("Result Macros Range: R0 -> R");
1542 printInt16( (uint16_t)ResultMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
1544 // Show Trigger to Result Macro Links
1546 info_msg("Trigger : Result Macro Pairs");
1547 for ( var_uint_t macro = 0; macro < TriggerMacroNum; macro++ )
1551 printInt16( (uint16_t)macro ); // Hopefully large enough :P (can't assume 32-bit)
1553 printInt16( (uint16_t)TriggerMacroList[ macro ].result ); // Hopefully large enough :P (can't assume 32-bit)
1557 void cliFunc_macroProc( char* args )
1559 // Toggle macro pause mode
1560 macroPauseMode = macroPauseMode ? 0 : 1;
1563 info_msg("Macro Processing Mode: ");
1564 printInt8( macroPauseMode );
1567 void macroDebugShowTrigger( var_uint_t index )
1569 // Only proceed if the macro exists
1570 if ( index >= TriggerMacroNum )
1573 // Trigger Macro Show
1574 const TriggerMacro *macro = &TriggerMacroList[ index ];
1575 TriggerMacroRecord *record = &TriggerMacroRecordList[ index ];
1578 info_msg("Trigger Macro Index: ");
1579 printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
1582 // Read the comboLength for combo in the sequence (sequence of combos)
1584 uint8_t comboLength = macro->guide[ pos ];
1586 // Iterate through and interpret the guide
1587 while ( comboLength != 0 )
1589 // Initial position of the combo
1590 var_uint_t comboPos = ++pos;
1592 // Iterate through the combo
1593 while ( pos < comboLength * TriggerGuideSize + comboPos )
1595 // Assign TriggerGuide element (key type, state and scancode)
1596 TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ pos ]);
1598 // Display guide information about trigger key
1599 printHex( guide->scanCode );
1601 printHex( guide->type );
1603 printHex( guide->state );
1605 // Increment position
1606 pos += TriggerGuideSize;
1608 // Only show combo separator if there are combos left in the sequence element
1609 if ( pos < comboLength * TriggerGuideSize + comboPos )
1613 // Read the next comboLength
1614 comboLength = macro->guide[ pos ];
1616 // Only show sequence separator if there is another combo to process
1617 if ( comboLength != 0 )
1621 // Display current position
1622 print( NL "Position: " );
1623 printInt16( (uint16_t)record->pos ); // Hopefully large enough :P (can't assume 32-bit)
1625 // Display result macro index
1626 print( NL "Result Macro Index: " );
1627 printInt16( (uint16_t)macro->result ); // Hopefully large enough :P (can't assume 32-bit)
1629 // Display trigger macro state
1630 print( NL "Trigger Macro State: " );
1631 switch ( record->state )
1633 case TriggerMacro_Press: print("Press"); break;
1634 case TriggerMacro_Release: print("Release"); break;
1635 case TriggerMacro_Waiting: print("Waiting"); break;
1639 void macroDebugShowResult( var_uint_t index )
1641 // Only proceed if the macro exists
1642 if ( index >= ResultMacroNum )
1645 // Trigger Macro Show
1646 const ResultMacro *macro = &ResultMacroList[ index ];
1647 ResultMacroRecord *record = &ResultMacroRecordList[ index ];
1650 info_msg("Result Macro Index: ");
1651 printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
1654 // Read the comboLength for combo in the sequence (sequence of combos)
1656 uint8_t comboLength = macro->guide[ pos++ ];
1658 // Iterate through and interpret the guide
1659 while ( comboLength != 0 )
1661 // Function Counter, used to keep track of the combos processed
1662 var_uint_t funcCount = 0;
1664 // Iterate through the combo
1665 while ( funcCount < comboLength )
1667 // Assign TriggerGuide element (key type, state and scancode)
1668 ResultGuide *guide = (ResultGuide*)(¯o->guide[ pos ]);
1670 // Display Function Index
1671 printHex( guide->index );
1674 // Display Function Ptr Address
1675 printHex( (nat_ptr_t)CapabilitiesList[ guide->index ].func );
1678 // Display/Lookup Capability Name (utilize debug mode of capability)
1679 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
1680 capability( 0xFF, 0xFF, 0 );
1682 // Display Argument(s)
1684 for ( var_uint_t arg = 0; arg < CapabilitiesList[ guide->index ].argCount; arg++ )
1686 // Arguments are only 8 bit values
1687 printHex( (&guide->args)[ arg ] );
1689 // Only show arg separator if there are args left
1690 if ( arg + 1 < CapabilitiesList[ guide->index ].argCount )
1695 // Increment position
1696 pos += ResultGuideSize( guide );
1698 // Increment function count
1701 // Only show combo separator if there are combos left in the sequence element
1702 if ( funcCount < comboLength )
1706 // Read the next comboLength
1707 comboLength = macro->guide[ pos++ ];
1709 // Only show sequence separator if there is another combo to process
1710 if ( comboLength != 0 )
1714 // Display current position
1715 print( NL "Position: " );
1716 printInt16( (uint16_t)record->pos ); // Hopefully large enough :P (can't assume 32-bit)
1718 // Display final trigger state/type
1719 print( NL "Final Trigger State (State/Type): " );
1720 printHex( record->state );
1722 printHex( record->stateType );
1725 void cliFunc_macroShow( char* args )
1727 // Parse codes from arguments
1730 char* arg2Ptr = args;
1736 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1738 // Stop processing args if no more are found
1739 if ( *arg1Ptr == '\0' )
1742 // Ignore invalid codes
1743 switch ( arg1Ptr[0] )
1745 // Indexed Trigger Macro
1747 macroDebugShowTrigger( numToInt( &arg1Ptr[1] ) );
1749 // Indexed Result Macro
1751 macroDebugShowResult( numToInt( &arg1Ptr[1] ) );
1757 void cliFunc_macroStep( char* args )
1759 // Parse number from argument
1760 // NOTE: Only first argument is used
1763 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
1765 // Default to 1, if no argument given
1766 var_uint_t count = (var_uint_t)numToInt( arg1Ptr );
1771 // Set the macro step counter, negative int's are cast to uint
1772 macroStepCounter = count;