1 /* Copyright (C) 2014 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 <defaultMap.h>
31 #include "templateKeymap.h" // TODO Use actual generated version
32 //#include "generatedKeymap.h" // TODO Use actual generated version
39 // ----- Function Declarations -----
41 void cliFunc_capList ( char* args );
42 void cliFunc_capSelect ( char* args );
43 void cliFunc_keyHold ( char* args );
44 void cliFunc_keyPress ( char* args );
45 void cliFunc_keyRelease( char* args );
46 void cliFunc_layerList ( char* args );
47 void cliFunc_layerState( char* args );
48 void cliFunc_macroDebug( char* args );
49 void cliFunc_macroList ( char* args );
50 void cliFunc_macroProc ( char* args );
51 void cliFunc_macroShow ( char* args );
52 void cliFunc_macroStep ( char* args );
58 // Bit positions are important, passes (correct key) always trump incorrect key votes
59 typedef enum TriggerMacroVote {
60 TriggerMacroVote_Release = 0x10, // Correct key
61 TriggerMacroVote_PassRelease = 0x18, // Correct key (both pass and release)
62 TriggerMacroVote_Pass = 0x8, // Correct key
63 TriggerMacroVote_DoNothingRelease = 0x4, // Incorrect key
64 TriggerMacroVote_DoNothing = 0x2, // Incorrect key
65 TriggerMacroVote_Fail = 0x1, // Incorrect key
66 TriggerMacroVote_Invalid = 0x0, // Invalid state
69 typedef enum TriggerMacroEval {
70 TriggerMacroEval_DoNothing,
71 TriggerMacroEval_DoResult,
72 TriggerMacroEval_DoResultAndRemove,
73 TriggerMacroEval_Remove,
76 typedef enum ResultMacroEval {
77 ResultMacroEval_DoNothing,
78 ResultMacroEval_Remove,
83 // ----- Variables -----
85 // Macro Module command dictionary
86 const char macroCLIDictName[] = "Macro Module Commands";
87 const CLIDictItem macroCLIDict[] = {
88 { "capList", "Prints an indexed list of all non USB keycode capabilities.", cliFunc_capList },
89 { "capSelect", "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B", cliFunc_capSelect },
90 { "keyHold", "Send key-hold events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyHold },
91 { "keyPress", "Send key-press events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyPress },
92 { "keyRelease", "Send key-release event to macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyRelease },
93 { "layerList", "List available layers.", cliFunc_layerList },
94 { "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", cliFunc_layerState },
95 { "macroDebug", "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes.", cliFunc_macroDebug },
96 { "macroList", "List the defined trigger and result macros.", cliFunc_macroList },
97 { "macroProc", "Pause/Resume macro processing.", cliFunc_macroProc },
98 { "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", cliFunc_macroShow },
99 { "macroStep", "Do N macro processing steps. Defaults to 1.", cliFunc_macroStep },
100 { 0, 0, 0 } // Null entry for dictionary end
104 // Macro debug flag - If set, clears the USB Buffers after signalling processing completion
105 uint8_t macroDebugMode = 0;
107 // Macro pause flag - If set, the macro module pauses processing, unless unset, or the step counter is non-zero
108 uint8_t macroPauseMode = 0;
110 // Macro step counter - If non-zero, the step counter counts down every time the macro module does one processing loop
111 unsigned int macroStepCounter = 0;
114 // Key Trigger List Buffer
115 TriggerGuide macroTriggerListBuffer[ MaxScanCode ];
116 uint8_t macroTriggerListBufferSize = 0;
118 // Pending Trigger Macro Index List
119 // * Any trigger macros that need processing from a previous macro processing loop
120 // TODO, figure out a good way to scale this array size without wasting too much memory, but not rejecting macros
121 // Possibly could be calculated by the KLL compiler
122 // XXX It may be possible to calculate the worst case using the KLL compiler
123 unsigned int macroTriggerMacroPendingList[ TriggerMacroNum ] = { 0 };
124 unsigned int macroTriggerMacroPendingListSize = 0;
127 // * When modifying layer state and the state is non-0x0, the stack must be adjusted
128 unsigned int macroLayerIndexStack[ LayerNum + 1 ] = { 0 };
129 unsigned int macroLayerIndexStackSize = 0;
131 // Pending Result Macro Index List
132 // * Any result macro that needs processing from a previous macro processing loop
133 unsigned int macroResultMacroPendingList[ ResultMacroNum ] = { 0 };
134 unsigned int macroResultMacroPendingListSize = 0;
138 // ----- Capabilities -----
140 // Sets the given layer with the specified layerState
141 void Macro_layerState( uint8_t state, uint8_t stateType, uint16_t layer, uint8_t layerState )
143 // Is layer in the LayerIndexStack?
144 uint8_t inLayerIndexStack = 0;
145 unsigned int stackItem = 0;
146 while ( stackItem < macroLayerIndexStackSize )
148 // Flag if layer is already in the LayerIndexStack
149 if ( macroLayerIndexStack[ stackItem ] == layer )
151 inLayerIndexStack = 1;
155 // Increment to next item
159 // Toggle Layer State Byte
160 if ( LayerIndex[ layer ].state & layerState )
163 LayerIndex[ layer ].state &= ~layerState;
168 LayerIndex[ layer ].state |= layerState;
171 // If the layer was not in the LayerIndexStack add it
172 if ( !inLayerIndexStack )
174 macroLayerIndexStack[ macroLayerIndexStackSize++ ] = layer;
177 // If the layer is in the LayerIndexStack and the state is 0x00, remove
178 if ( LayerIndex[ layer ].state == 0x00 && inLayerIndexStack )
180 // Remove the layer from the LayerIndexStack
181 // Using the already positioned stackItem variable from the loop above
182 while ( stackItem < macroLayerIndexStackSize )
184 macroLayerIndexStack[ stackItem ] = macroLayerIndexStack[ stackItem + 1 ];
188 // Reduce LayerIndexStack size
189 macroLayerIndexStackSize--;
193 // Modifies the specified Layer control byte
194 // Argument #1: Layer Index -> uint16_t
195 // Argument #2: Layer State -> uint8_t
196 void Macro_layerState_capability( uint8_t state, uint8_t stateType, uint8_t *args )
198 // Display capability name
199 if ( stateType == 0xFF && state == 0xFF )
201 print("Macro_layerState(layerIndex,layerState)");
205 // Get layer index from arguments
206 // Cast pointer to uint8_t to unsigned int then access that memory location
207 uint16_t layer = *(uint16_t*)(&args[0]);
209 // Get layer toggle byte
210 uint8_t layerState = args[ sizeof(uint16_t) ];
212 Macro_layerState( state, stateType, layer, layerState );
216 // Latches given layer
217 // Argument #1: Layer Index -> uint16_t
218 void Macro_layerLatch_capability( uint8_t state, uint8_t stateType, uint8_t *args )
220 // Display capability name
221 if ( stateType == 0xFF && state == 0xFF )
223 print("Macro_layerLatch(layerIndex)");
227 // Get layer index from arguments
228 // Cast pointer to uint8_t to unsigned int then access that memory location
229 uint16_t layer = *(uint16_t*)(&args[0]);
231 Macro_layerState( state, stateType, layer, 0x02 );
236 // Argument #1: Layer Index -> uint16_t
237 void Macro_layerLock_capability( uint8_t state, uint8_t stateType, uint8_t *args )
239 // Display capability name
240 if ( stateType == 0xFF && state == 0xFF )
242 print("Macro_layerLock(layerIndex)");
246 // Get layer index from arguments
247 // Cast pointer to uint8_t to unsigned int then access that memory location
248 uint16_t layer = *(uint16_t*)(&args[0]);
250 Macro_layerState( state, stateType, layer, 0x04 );
254 // Shifts given layer
255 // Argument #1: Layer Index -> uint16_t
256 void Macro_layerShift_capability( uint8_t state, uint8_t stateType, uint8_t *args )
258 // Display capability name
259 if ( stateType == 0xFF && state == 0xFF )
261 print("Macro_layerShift(layerIndex)");
265 // Get layer index from arguments
266 // Cast pointer to uint8_t to unsigned int then access that memory location
267 uint16_t layer = *(uint16_t*)(&args[0]);
269 Macro_layerState( state, stateType, layer, 0x01 );
274 // ----- Functions -----
276 // Looks up the trigger list for the given scan code (from the active layer)
277 // NOTE: Calling function must handle the NULL pointer case
278 unsigned int *Macro_layerLookup( uint8_t scanCode )
280 // If no trigger macro is defined at the given layer, fallthrough to the next layer
281 for ( unsigned int layerIndex = 0; layerIndex < macroLayerIndexStackSize; layerIndex++ )
284 Layer *layer = &LayerIndex[ macroLayerIndexStack[ layerIndex ] ];
286 // Check if latch has been pressed for this layer
287 // XXX Regardless of whether a key is found, the latch is removed on first lookup
288 uint8_t latch = layer->state & 0x02;
291 layer->state &= ~0x02;
294 // Only use layer, if state is valid
295 // XOR each of the state bits
296 // If only two are enabled, do not use this state
297 if ( (layer->state & 0x01) ^ (latch>>1) ^ ((layer->state & 0x04)>>2) )
300 unsigned int **map = (unsigned int**)layer->triggerMap;
302 // Determine if layer has key defined
303 if ( map != 0 && *map[ scanCode ] != 0 )
304 return map[ scanCode ];
308 // Do lookup on default layer
309 unsigned int **map = (unsigned int**)LayerIndex[0].triggerMap;
311 // Determine if layer has key defined
312 if ( map == 0 && *map[ scanCode ] == 0 )
314 erro_msg("Scan Code has no defined Trigger Macro: ");
315 printHex( scanCode );
319 // Return lookup result
320 return map[ scanCode ];
324 // Update the scancode key state
330 // * 0x04 - Unpressed (this is currently ignored)
331 inline void Macro_keyState( uint8_t scanCode, uint8_t state )
333 // Only add to macro trigger list if one of three states
336 case 0x01: // Pressed
338 case 0x03: // Released
339 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
340 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
341 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x00; // Normal key
342 macroTriggerListBufferSize++;
348 // Update the scancode analog state
352 // * 0x02-0xFF - Analog value (low to high)
353 inline void Macro_analogState( uint8_t scanCode, uint8_t state )
355 // Only add to macro trigger list if non-off
358 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
359 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
360 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x02; // Analog key
361 macroTriggerListBufferSize++;
370 inline void Macro_ledState( uint8_t ledCode, uint8_t state )
372 // Only add to macro trigger list if non-off
375 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = ledCode;
376 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
377 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x01; // LED key
378 macroTriggerListBufferSize++;
383 // Append result macro to pending list, checking for duplicates
384 // Do nothing if duplicate
385 inline void Macro_appendResultMacroToPendingList( TriggerMacro *triggerMacro )
387 // Lookup result macro index
388 unsigned int resultMacroIndex = triggerMacro->result;
390 // Iterate through result macro pending list, making sure this macro hasn't been added yet
391 for ( unsigned int macro = 0; macro < macroResultMacroPendingListSize; macro++ )
393 // If duplicate found, do nothing
394 if ( macroResultMacroPendingList[ macro ] == resultMacroIndex )
398 // No duplicates found, add to pending list
399 macroResultMacroPendingList[ macroResultMacroPendingListSize++ ] = resultMacroIndex;
401 // Lookup scanCode of the last key in the last combo
402 unsigned int pos = 0;
403 for ( uint8_t comboLength = triggerMacro->guide[0]; comboLength > 0; )
405 pos += TriggerGuideSize * comboLength + 1;
406 comboLength = triggerMacro->guide[ pos ];
409 uint8_t scanCode = ((TriggerGuide*)&triggerMacro->guide[ pos - TriggerGuideSize ])->scanCode;
411 // Lookup scanCode in buffer list for the current state and stateType
412 for ( uint8_t keyIndex = 0; keyIndex < macroTriggerListBufferSize; keyIndex++ )
414 if ( macroTriggerListBuffer[ keyIndex ].scanCode == scanCode )
416 ResultMacroList[ resultMacroIndex ].state = macroTriggerListBuffer[ keyIndex ].state;
417 ResultMacroList[ resultMacroIndex ].stateType = macroTriggerListBuffer[ keyIndex ].type;
421 // Reset the macro position
422 ResultMacroList[ resultMacroIndex ].pos = 0;
426 // Determine if long ResultMacro (more than 1 seqence element)
427 inline uint8_t Macro_isLongResultMacro( ResultMacro *macro )
429 // Check the second sequence combo length
430 // If non-zero return non-zero (long sequence)
431 // 0 otherwise (short sequence)
432 unsigned int position = 1;
433 for ( unsigned int result = 0; result < macro->guide[0]; result++ )
434 position += ResultGuideSize( (ResultGuide*)¯o->guide[ position ] );
435 return macro->guide[ position ];
439 // Determine if long TriggerMacro (more than 1 sequence element)
440 inline uint8_t Macro_isLongTriggerMacro( TriggerMacro *macro )
442 // Check the second sequence combo length
443 // If non-zero return non-zero (long sequence)
444 // 0 otherwise (short sequence)
445 return macro->guide[ macro->guide[0] * TriggerGuideSize + 1 ];
449 // Votes on the given key vs. guide, short macros
450 inline TriggerMacroVote Macro_evalShortTriggerMacroVote( TriggerGuide *key, TriggerGuide *guide )
452 // Depending on key type
453 switch ( guide->type )
457 // For short TriggerMacros completely ignore incorrect keys
458 if ( guide->scanCode == key->scanCode )
460 switch ( key->state )
462 // Correct key, pressed, possible passing
464 return TriggerMacroVote_Pass;
466 // Correct key, held, possible passing or release
468 return TriggerMacroVote_PassRelease;
470 // Correct key, released, possible release
472 return TriggerMacroVote_Release;
476 return TriggerMacroVote_DoNothing;
480 erro_print("LED State Type - Not implemented...");
485 erro_print("Analog State Type - Not implemented...");
488 // Invalid State Type
490 erro_print("Invalid State Type. This is a bug.");
494 // XXX Shouldn't reach here
495 return TriggerMacroVote_Invalid;
499 // Votes on the given key vs. guide, long macros
500 // A long macro is defined as a guide with more than 1 combo
501 inline TriggerMacroVote Macro_evalLongTriggerMacroVote( TriggerGuide *key, TriggerGuide *guide )
503 // Depending on key type
504 switch ( guide->type )
508 // Depending on the state of the buffered key, make voting decision
510 if ( guide->scanCode != key->scanCode )
512 switch ( key->state )
514 // Wrong key, pressed, fail
516 return TriggerMacroVote_Fail;
518 // Wrong key, held, do not pass (no effect)
520 return TriggerMacroVote_DoNothing;
522 // Wrong key released, fail out if pos == 0
524 return TriggerMacroVote_DoNothing | TriggerMacroVote_DoNothingRelease;
531 switch ( key->state )
533 // Correct key, pressed, possible passing
535 return TriggerMacroVote_Pass;
537 // Correct key, held, possible passing or release
539 return TriggerMacroVote_PassRelease;
541 // Correct key, released, possible release
543 return TriggerMacroVote_Release;
551 erro_print("LED State Type - Not implemented...");
556 erro_print("Analog State Type - Not implemented...");
559 // Invalid State Type
561 erro_print("Invalid State Type. This is a bug.");
565 // XXX Shouldn't reach here
566 return TriggerMacroVote_Invalid;
570 // Evaluate/Update TriggerMacro
571 inline TriggerMacroEval Macro_evalTriggerMacro( unsigned int triggerMacroIndex )
573 // Lookup TriggerMacro
574 TriggerMacro *macro = &TriggerMacroList[ triggerMacroIndex ];
576 // Check if macro has finished and should be incremented sequence elements
577 if ( macro->state == TriggerMacro_Release )
579 macro->state = TriggerMacro_Waiting;
580 macro->pos = macro->pos + macro->guide[ macro->pos ] * TriggerGuideSize + 1;
583 // Current Macro position
584 unsigned int pos = macro->pos;
586 // Length of the combo being processed
587 uint8_t comboLength = macro->guide[ pos ] * TriggerGuideSize;
589 // If no combo items are left, remove the TriggerMacro from the pending list
590 if ( comboLength == 0 )
592 return TriggerMacroEval_Remove;
595 // Check if this is a long Trigger Macro
596 uint8_t longMacro = Macro_isLongTriggerMacro( macro );
598 // Iterate through the items in the combo, voting the on the key state
599 // If any of the pressed keys do not match, fail the macro
601 // The macro is waiting for input when in the TriggerMacro_Waiting state
602 // Once all keys have been pressed/held (only those keys), entered TriggerMacro_Press state (passing)
603 // Transition to the next combo (if it exists) when a single key is released (TriggerMacro_Release state)
604 // On scan after position increment, change to TriggerMacro_Waiting state
605 // TODO Add support for system LED states (NumLock, CapsLock, etc.)
606 // TODO Add support for analog key states
607 // TODO Add support for 0x00 Key state (not pressing a key, not all that useful in general)
608 // TODO Add support for Press/Hold/Release differentiation when evaluating (not sure if useful)
609 TriggerMacroVote overallVote = TriggerMacroVote_Invalid;
610 for ( uint8_t comboItem = pos + 1; comboItem < pos + comboLength + 1; comboItem += TriggerGuideSize )
612 // Assign TriggerGuide element (key type, state and scancode)
613 TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ comboItem ]);
615 TriggerMacroVote vote = TriggerMacroVote_Invalid;
616 // Iterate through the key buffer, comparing to each key in the combo
617 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
619 // Lookup key information
620 TriggerGuide *keyInfo = ¯oTriggerListBuffer[ key ];
622 // If vote is a pass (>= 0x08, no more keys in the combo need to be looked at)
623 // Also mask all of the non-passing votes
625 ? Macro_evalLongTriggerMacroVote( keyInfo, guide )
626 : Macro_evalShortTriggerMacroVote( keyInfo, guide );
627 if ( vote >= TriggerMacroVote_Pass )
629 vote &= TriggerMacroVote_Release | TriggerMacroVote_PassRelease | TriggerMacroVote_Pass;
634 // If no pass vote was found after scanning all of the keys
635 // Fail the combo, if this is a short macro (long macros already will have a fail vote)
636 if ( !longMacro && vote < TriggerMacroVote_Pass )
637 vote |= TriggerMacroVote_Fail;
639 // After voting, append to overall vote
643 // If no pass vote was found after scanning the entire combo
644 // And this is the first position in the combo, just remove it (nothing important happened)
645 if ( longMacro && overallVote & TriggerMacroVote_DoNothingRelease && pos == 0 )
646 overallVote |= TriggerMacroVote_Fail;
648 // Decide new state of macro after voting
649 // Fail macro, remove from pending list
650 if ( overallVote & TriggerMacroVote_Fail )
652 return TriggerMacroEval_Remove;
654 // Do nothing, incorrect key is being held or released
655 else if ( overallVote & TriggerMacroVote_DoNothing && longMacro )
657 // Just doing nothing :)
659 // If passing and in Waiting state, set macro state to Press
660 else if ( overallVote & TriggerMacroVote_Pass
661 && ( macro->state == TriggerMacro_Waiting || macro->state == TriggerMacro_Press ) )
663 macro->state = TriggerMacro_Press;
665 // If in press state, and this is the final combo, send request for ResultMacro
666 // Check to see if the result macro only has a single element
667 // If this result macro has more than 1 key, only send once
668 // TODO Add option to have long macro repeat rate
669 if ( macro->guide[ pos + comboLength + 1 ] == 0 )
671 // Long result macro (more than 1 combo)
672 if ( Macro_isLongResultMacro( &ResultMacroList[ macro->result ] ) )
674 // Only ever trigger result once, on press
675 if ( overallVote == TriggerMacroVote_Pass )
677 return TriggerMacroEval_DoResultAndRemove;
680 // Short result macro
683 // Only trigger result once, on press, if long trigger (more than 1 combo)
684 if ( Macro_isLongTriggerMacro( macro ) )
686 return TriggerMacroEval_DoResultAndRemove;
688 // Otherwise, trigger result continuously
691 return TriggerMacroEval_DoResult;
696 // If ready for transition and in Press state, set to Waiting and increment combo position
697 // Position is incremented (and possibly remove the macro from the pending list) on the next iteration
698 else if ( overallVote & TriggerMacroVote_Release && macro->state == TriggerMacro_Press )
700 macro->state = TriggerMacro_Release;
702 // If this is the last combo in the sequence, remove from the pending list
703 if ( macro->guide[ macro->pos + macro->guide[ macro->pos ] * TriggerGuideSize + 1 ] == 0 )
704 return TriggerMacroEval_Remove;
706 // Otherwise, just remove the macro on key release
707 // XXX Might cause some issues
708 else if ( overallVote & TriggerMacroVote_Release )
710 return TriggerMacroEval_Remove;
713 // If this is a short macro, just remove it
714 // The state can be rebuilt on the next iteration
716 return TriggerMacroEval_Remove;
718 return TriggerMacroEval_DoNothing;
722 // Evaluate/Update ResultMacro
723 inline ResultMacroEval Macro_evalResultMacro( unsigned int resultMacroIndex )
725 // Lookup ResultMacro
726 ResultMacro *macro = &ResultMacroList[ resultMacroIndex ];
728 // Current Macro position
729 unsigned int pos = macro->pos;
731 // Length of combo being processed
732 uint8_t comboLength = macro->guide[ pos ];
734 // Function Counter, used to keep track of the combo items processed
735 unsigned int funcCount = 0;
737 // Combo Item Position within the guide
738 unsigned int comboItem = pos + 1;
740 // Iterate through the Result Combo
741 while ( funcCount < comboLength )
743 // Assign TriggerGuide element (key type, state and scancode)
744 ResultGuide *guide = (ResultGuide*)(¯o->guide[ comboItem ]);
746 // Do lookup on capability function
747 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
750 capability( macro->state, macro->stateType, &guide->args );
752 // Increment counters
754 comboItem += ResultGuideSize( (ResultGuide*)(¯o->guide[ comboItem ]) );
757 // Move to next item in the sequence
758 macro->pos = comboItem;
760 // If the ResultMacro is finished, remove
761 if ( macro->guide[ comboItem ] == 0 )
763 return ResultMacroEval_Remove;
766 // Otherwise leave the macro in the list
767 return ResultMacroEval_DoNothing;
771 // Update pending trigger list
772 inline void Macro_updateTriggerMacroPendingList()
774 // Iterate over the macroTriggerListBuffer to add any new Trigger Macros to the pending list
775 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
778 // TODO Analog Switches
779 // Only add TriggerMacro to pending list if key was pressed (not held, released or off)
780 if ( macroTriggerListBuffer[ key ].state == 0x00 && macroTriggerListBuffer[ key ].state != 0x01 )
783 // Lookup Trigger List
784 unsigned int *triggerList = Macro_layerLookup( macroTriggerListBuffer[ key ].scanCode );
786 // Number of Triggers in list
787 unsigned int triggerListSize = triggerList[0];
789 // Iterate over triggerList to see if any TriggerMacros need to be added
790 // First item is the number of items in the TriggerList
791 for ( unsigned int macro = 1; macro < triggerListSize + 1; macro++ )
793 // Lookup trigger macro index
794 unsigned int triggerMacroIndex = triggerList[ macro ];
796 // Iterate over macroTriggerMacroPendingList to see if any macro in the scancode's
797 // triggerList needs to be added
798 unsigned int pending = 0;
799 for ( ; pending < macroTriggerMacroPendingListSize; pending++ )
801 // Stop scanning if the trigger macro index is found in the pending list
802 if ( macroTriggerMacroPendingList[ pending ] == triggerMacroIndex )
806 // If the triggerMacroIndex (macro) was not found in the macroTriggerMacroPendingList
807 // Add it to the list
808 if ( pending == macroTriggerMacroPendingListSize )
810 macroTriggerMacroPendingList[ macroTriggerMacroPendingListSize++ ] = triggerMacroIndex;
812 // Reset macro position
813 TriggerMacroList[ triggerMacroIndex ].pos = 0;
814 TriggerMacroList[ triggerMacroIndex ].state = TriggerMacro_Waiting;
821 // Macro Procesing Loop
822 // Called once per USB buffer send
823 inline void Macro_process()
825 // Only do one round of macro processing between Output Module timer sends
826 if ( USBKeys_Sent != 0 )
829 // If the pause flag is set, only process if the step counter is non-zero
830 if ( macroPauseMode )
832 if ( macroStepCounter == 0 )
835 // Proceed, decrementing the step counter
837 dbug_print("Macro Step");
840 // Update pending trigger list, before processing TriggerMacros
841 Macro_updateTriggerMacroPendingList();
843 // Tail pointer for macroTriggerMacroPendingList
844 // Macros must be explicitly re-added
845 unsigned int macroTriggerMacroPendingListTail = 0;
847 // Iterate through the pending TriggerMacros, processing each of them
848 for ( unsigned int macro = 0; macro < macroTriggerMacroPendingListSize; macro++ )
850 switch ( Macro_evalTriggerMacro( macroTriggerMacroPendingList[ macro ] ) )
852 // Trigger Result Macro (purposely falling through)
853 case TriggerMacroEval_DoResult:
854 // Append ResultMacro to PendingList
855 Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
858 macroTriggerMacroPendingList[ macroTriggerMacroPendingListTail++ ] = macroTriggerMacroPendingList[ macro ];
861 // Trigger Result Macro and Remove (purposely falling through)
862 case TriggerMacroEval_DoResultAndRemove:
863 // Append ResultMacro to PendingList
864 Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
866 // Remove Macro from Pending List, nothing to do, removing by default
867 case TriggerMacroEval_Remove:
872 // Update the macroTriggerMacroPendingListSize with the tail pointer
873 macroTriggerMacroPendingListSize = macroTriggerMacroPendingListTail;
876 // Tail pointer for macroResultMacroPendingList
877 // Macros must be explicitly re-added
878 unsigned int macroResultMacroPendingListTail = 0;
880 // Iterate through the pending ResultMacros, processing each of them
881 for ( unsigned int macro = 0; macro < macroResultMacroPendingListSize; macro++ )
883 switch ( Macro_evalResultMacro( macroResultMacroPendingList[ macro ] ) )
885 // Re-add macros to pending list
886 case ResultMacroEval_DoNothing:
888 macroResultMacroPendingList[ macroResultMacroPendingListTail++ ] = macroResultMacroPendingList[ macro ];
891 // Remove Macro from Pending List, nothing to do, removing by default
892 case ResultMacroEval_Remove:
897 // Update the macroResultMacroPendingListSize with the tail pointer
898 macroResultMacroPendingListSize = macroResultMacroPendingListTail;
900 // Signal buffer that we've used it
901 Scan_finishedWithMacro( macroTriggerListBufferSize );
903 // Reset TriggerList buffer
904 macroTriggerListBufferSize = 0;
906 // If Macro debug mode is set, clear the USB Buffer
907 if ( macroDebugMode )
909 USBKeys_Modifiers = 0;
915 inline void Macro_setup()
917 // Register Macro CLI dictionary
918 CLI_registerDictionary( macroCLIDict, macroCLIDictName );
920 // Disable Macro debug mode
923 // Disable Macro pause flag
926 // Set Macro step counter to zero
927 macroStepCounter = 0;
929 // Make sure macro trigger buffer is empty
930 macroTriggerListBufferSize = 0;
932 // Initialize TriggerMacro states
933 for ( unsigned int macro = 0; macro < TriggerMacroNum; macro++ )
935 TriggerMacroList[ macro ].pos = 0;
936 TriggerMacroList[ macro ].state = TriggerMacro_Waiting;
939 // Initialize ResultMacro states
940 for ( unsigned int macro = 0; macro < ResultMacroNum; macro++ )
942 ResultMacroList[ macro ].pos = 0;
943 ResultMacroList[ macro ].state = 0;
944 ResultMacroList[ macro ].stateType = 0;
949 // ----- CLI Command Functions -----
951 void cliFunc_capList( char* args )
954 info_msg("Capabilities List");
955 printHex( CapabilitiesNum );
957 // Iterate through all of the capabilities and display them
958 for ( unsigned int cap = 0; cap < CapabilitiesNum; cap++ )
964 // Display/Lookup Capability Name (utilize debug mode of capability)
965 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
966 capability( 0xFF, 0xFF, 0 );
970 void cliFunc_capSelect( char* args )
972 // Parse code from argument
975 char* arg2Ptr = args;
977 // Total number of args to scan (must do a lookup if a keyboard capability is selected)
978 unsigned int totalArgs = 2; // Always at least two args
979 unsigned int cap = 0;
981 // Arguments used for keyboard capability function
982 unsigned int argSetCount = 0;
983 uint8_t *argSet = (uint8_t*)args;
986 for ( unsigned int c = 0; argSetCount < totalArgs; c++ )
989 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
991 // Stop processing args if no more are found
992 // Extra arguments are ignored
993 if ( *arg1Ptr == '\0' )
996 // For the first argument, choose the capability
997 if ( c == 0 ) switch ( arg1Ptr[0] )
999 // Keyboard Capability
1001 // Determine capability index
1002 cap = numToInt( &arg1Ptr[1] );
1004 // Lookup the number of args
1005 totalArgs += CapabilitiesList[ cap ].argCount;
1009 // Because allocating memory isn't doable, and the argument count is arbitrary
1010 // The argument pointer is repurposed as the argument list (much smaller anyways)
1011 argSet[ argSetCount++ ] = (uint8_t)numToInt( arg1Ptr );
1013 // Once all the arguments are prepared, call the keyboard capability function
1014 if ( argSetCount == totalArgs )
1016 // Indicate that the capability was called
1021 printHex( argSet[0] );
1023 printHex( argSet[1] );
1025 printHex( argSet[2] );
1028 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
1029 capability( argSet[0], argSet[1], &argSet[2] );
1034 void cliFunc_keyHold( char* args )
1036 // Parse codes from arguments
1039 char* arg2Ptr = args;
1045 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1047 // Stop processing args if no more are found
1048 if ( *arg1Ptr == '\0' )
1051 // Ignore non-Scancode numbers
1052 switch ( arg1Ptr[0] )
1056 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x02 ); // Hold scancode
1062 void cliFunc_keyPress( char* args )
1064 // Parse codes from arguments
1067 char* arg2Ptr = args;
1073 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1075 // Stop processing args if no more are found
1076 if ( *arg1Ptr == '\0' )
1079 // Ignore non-Scancode numbers
1080 switch ( arg1Ptr[0] )
1084 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x01 ); // Press scancode
1090 void cliFunc_keyRelease( char* args )
1092 // Parse codes from arguments
1095 char* arg2Ptr = args;
1101 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1103 // Stop processing args if no more are found
1104 if ( *arg1Ptr == '\0' )
1107 // Ignore non-Scancode numbers
1108 switch ( arg1Ptr[0] )
1112 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x03 ); // Release scancode
1118 void cliFunc_layerList( char* args )
1121 info_msg("Layer List");
1123 // Iterate through all of the layers and display them
1124 for ( unsigned int layer = 0; layer < LayerNum; layer++ )
1130 // Display layer name
1131 dPrint( (char*)LayerIndex[ layer ].name );
1135 print(" \033[1m(default)\033[0m");
1138 print( NL "\t\t Layer State: " );
1139 printHex( LayerIndex[ layer ].state );
1142 print(" Max Index: ");
1143 printHex( LayerIndex[ layer ].max );
1147 void cliFunc_layerState( char* args )
1149 // Parse codes from arguments
1152 char* arg2Ptr = args;
1157 // Process first two args
1158 for ( uint8_t c = 0; c < 2; c++ )
1161 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1163 // Stop processing args if no more are found
1164 if ( *arg1Ptr == '\0' )
1169 // First argument (e.g. L1)
1171 if ( arg1Ptr[0] != 'L' )
1174 arg1 = (uint8_t)numToInt( &arg1Ptr[1] );
1176 // Second argument (e.g. 4)
1178 arg2 = (uint8_t)numToInt( arg1Ptr );
1180 // Display operation (to indicate that it worked)
1182 info_msg("Setting Layer L");
1187 // Set the layer state
1188 LayerIndex[ arg1 ].state = arg2;
1194 void cliFunc_macroDebug( char* args )
1196 // Toggle macro debug mode
1197 macroDebugMode = macroDebugMode ? 0 : 1;
1200 info_msg("Macro Debug Mode: ");
1201 printInt8( macroDebugMode );
1204 void cliFunc_macroList( char* args )
1206 // Show pending key events
1208 info_msg("Pending Key Events: ");
1209 printInt16( (uint16_t)macroTriggerListBufferSize );
1211 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
1213 printHex( macroTriggerListBuffer[ key ].scanCode );
1217 // Show pending trigger macros
1219 info_msg("Pending Trigger Macros: ");
1220 printInt16( (uint16_t)macroTriggerMacroPendingListSize );
1222 for ( unsigned int macro = 0; macro < macroTriggerMacroPendingListSize; macro++ )
1224 printHex( macroTriggerMacroPendingList[ macro ] );
1228 // Show pending result macros
1230 info_msg("Pending Result Macros: ");
1231 printInt16( (uint16_t)macroResultMacroPendingListSize );
1233 for ( unsigned int macro = 0; macro < macroResultMacroPendingListSize; macro++ )
1235 printHex( macroResultMacroPendingList[ macro ] );
1239 // Show available trigger macro indices
1241 info_msg("Trigger Macros Range: T0 -> T");
1242 printInt16( (uint16_t)TriggerMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
1244 // Show available result macro indices
1246 info_msg("Result Macros Range: R0 -> R");
1247 printInt16( (uint16_t)ResultMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
1249 // Show Trigger to Result Macro Links
1251 info_msg("Trigger : Result Macro Pairs");
1252 for ( unsigned int macro = 0; macro < TriggerMacroNum; macro++ )
1256 printInt16( (uint16_t)macro ); // Hopefully large enough :P (can't assume 32-bit)
1258 printInt16( (uint16_t)TriggerMacroList[ macro ].result ); // Hopefully large enough :P (can't assume 32-bit)
1262 void cliFunc_macroProc( char* args )
1264 // Toggle macro pause mode
1265 macroPauseMode = macroPauseMode ? 0 : 1;
1268 info_msg("Macro Processing Mode: ");
1269 printInt8( macroPauseMode );
1272 void macroDebugShowTrigger( unsigned int index )
1274 // Only proceed if the macro exists
1275 if ( index >= TriggerMacroNum )
1278 // Trigger Macro Show
1279 TriggerMacro *macro = &TriggerMacroList[ index ];
1282 info_msg("Trigger Macro Index: ");
1283 printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
1286 // Read the comboLength for combo in the sequence (sequence of combos)
1287 unsigned int pos = 0;
1288 uint8_t comboLength = macro->guide[ pos ];
1290 // Iterate through and interpret the guide
1291 while ( comboLength != 0 )
1293 // Initial position of the combo
1294 unsigned int comboPos = ++pos;
1296 // Iterate through the combo
1297 while ( pos < comboLength * TriggerGuideSize + comboPos )
1299 // Assign TriggerGuide element (key type, state and scancode)
1300 TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ pos ]);
1302 // Display guide information about trigger key
1303 printHex( guide->scanCode );
1305 printHex( guide->type );
1307 printHex( guide->state );
1309 // Increment position
1310 pos += TriggerGuideSize;
1312 // Only show combo separator if there are combos left in the sequence element
1313 if ( pos < comboLength * TriggerGuideSize + comboPos )
1317 // Read the next comboLength
1318 comboLength = macro->guide[ pos ];
1320 // Only show sequence separator if there is another combo to process
1321 if ( comboLength != 0 )
1325 // Display current position
1326 print( NL "Position: " );
1327 printInt16( (uint16_t)macro->pos ); // Hopefully large enough :P (can't assume 32-bit)
1329 // Display result macro index
1330 print( NL "Result Macro Index: " );
1331 printInt16( (uint16_t)macro->result ); // Hopefully large enough :P (can't assume 32-bit)
1333 // Display trigger macro state
1334 print( NL "Trigger Macro State: " );
1335 switch ( macro->state )
1337 case TriggerMacro_Press: print("Press"); break;
1338 case TriggerMacro_Release: print("Release"); break;
1339 case TriggerMacro_Waiting: print("Waiting"); break;
1343 void macroDebugShowResult( unsigned int index )
1345 // Only proceed if the macro exists
1346 if ( index >= ResultMacroNum )
1349 // Trigger Macro Show
1350 ResultMacro *macro = &ResultMacroList[ index ];
1353 info_msg("Result Macro Index: ");
1354 printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
1357 // Read the comboLength for combo in the sequence (sequence of combos)
1358 unsigned int pos = 0;
1359 uint8_t comboLength = macro->guide[ pos++ ];
1361 // Iterate through and interpret the guide
1362 while ( comboLength != 0 )
1364 // Function Counter, used to keep track of the combos processed
1365 unsigned int funcCount = 0;
1367 // Iterate through the combo
1368 while ( funcCount < comboLength )
1370 // Assign TriggerGuide element (key type, state and scancode)
1371 ResultGuide *guide = (ResultGuide*)(¯o->guide[ pos ]);
1373 // Display Function Index
1374 printHex( guide->index );
1377 // Display Function Ptr Address
1378 printHex( (unsigned int)CapabilitiesList[ guide->index ].func );
1381 // Display/Lookup Capability Name (utilize debug mode of capability)
1382 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
1383 capability( 0xFF, 0xFF, 0 );
1385 // Display Argument(s)
1387 for ( unsigned int arg = 0; arg < CapabilitiesList[ guide->index ].argCount; arg++ )
1389 // Arguments are only 8 bit values
1390 printHex( (&guide->args)[ arg ] );
1392 // Only show arg separator if there are args left
1393 if ( arg + 1 < CapabilitiesList[ guide->index ].argCount )
1398 // Increment position
1399 pos += ResultGuideSize( guide );
1401 // Increment function count
1404 // Only show combo separator if there are combos left in the sequence element
1405 if ( funcCount < comboLength )
1409 // Read the next comboLength
1410 comboLength = macro->guide[ pos++ ];
1412 // Only show sequence separator if there is another combo to process
1413 if ( comboLength != 0 )
1417 // Display current position
1418 print( NL "Position: " );
1419 printInt16( (uint16_t)macro->pos ); // Hopefully large enough :P (can't assume 32-bit)
1421 // Display final trigger state/type
1422 print( NL "Final Trigger State (State/Type): " );
1423 printHex( macro->state );
1425 printHex( macro->stateType );
1428 void cliFunc_macroShow( char* args )
1430 // Parse codes from arguments
1433 char* arg2Ptr = args;
1439 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1441 // Stop processing args if no more are found
1442 if ( *arg1Ptr == '\0' )
1445 // Ignore invalid codes
1446 switch ( arg1Ptr[0] )
1448 // Indexed Trigger Macro
1450 macroDebugShowTrigger( numToInt( &arg1Ptr[1] ) );
1452 // Indexed Result Macro
1454 macroDebugShowResult( numToInt( &arg1Ptr[1] ) );
1460 void cliFunc_macroStep( char* args )
1462 // Parse number from argument
1463 // NOTE: Only first argument is used
1466 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
1468 // Default to 1, if no argument given
1469 unsigned int count = (unsigned int)numToInt( arg1Ptr );
1474 // Set the macro step counter, negative int's are cast to uint
1475 macroStepCounter = count;