Macro/PartialMap/macro.c

   1 /* Copyright (C) 2014 by Jacob Alexander
   2  *
   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.
   7  *
   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.
  12  *
  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/>.
  15  */
  16
  17 // ----- Includes -----
  18
  19 // Compiler Includes
  20 #include <Lib/MacroLib.h>
  21
  22 // Project Includes
  23 #include <cli.h>
  24 #include <led.h>
  25 #include <print.h>
  26 #include <scan_loop.h>
  27 #include <output_com.h>
  28
  29 // Keymaps
  30 #include "usb_hid.h"
  31 #include <defaultMap.h>
  32 #include "generatedKeymap.h" // TODO Use actual generated version
  33
  34 // Local Includes
  35 #include "macro.h"
  36
  37
  38
  39 // ----- Function Declarations -----
  40
  41 void cliFunc_capList   ( char* args );
  42 void cliFunc_capSelect ( char* args );
  43 void cliFunc_keyPress  ( char* args );
  44 void cliFunc_keyRelease( char* args );
  45 void cliFunc_layerList ( char* args );
  46 void cliFunc_layerState( char* args );
  47 void cliFunc_macroDebug( char* args );
  48 void cliFunc_macroList ( char* args );
  49 void cliFunc_macroProc ( char* args );
  50 void cliFunc_macroShow ( char* args );
  51 void cliFunc_macroStep ( char* args );
  52
  53
  54
  55 // ----- Variables -----
  56
  57 // Macro Module command dictionary
  58 char*       macroCLIDictName = "Macro Module Commands";
  59 CLIDictItem macroCLIDict[] = {
  60         { "capList",     "Prints an indexed list of all non USB keycode capabilities.", cliFunc_capList },
  61         { "capSelect",   "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B", cliFunc_capSelect },
  62         { "keyPress",    "Send key-presses to the macro module. Held until released. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyPress },
  63         { "keyRelease",  "Release a key-press from the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyRelease },
  64         { "layerList",   "List available layers.", cliFunc_layerList },
  65         { "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 },
  66         { "macroDebug",  "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes.", cliFunc_macroDebug },
  67         { "macroList",   "List the defined trigger and result macros.", cliFunc_macroList },
  68         { "macroProc",   "Pause/Resume macro processing.", cliFunc_macroProc },
  69         { "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 },
  70         { "macroStep",   "Do N macro processing steps. Defaults to 1.", cliFunc_macroStep },
  71         { 0, 0, 0 } // Null entry for dictionary end
  72 };
  73
  74
  75 // Macro debug flag - If set, clears the USB Buffers after signalling processing completion
  76 uint8_t macroDebugMode = 0;
  77
  78 // Macro pause flag - If set, the macro module pauses processing, unless unset, or the step counter is non-zero
  79 uint8_t macroPauseMode = 0;
  80
  81 // Macro step counter - If non-zero, the step counter counts down every time the macro module does one processing loop
  82 unsigned int macroStepCounter = 0;
  83
  84
  85 // Key Trigger List Buffer
  86 TriggerGuide macroTriggerListBuffer[ MaxScanCode ];
  87 uint8_t macroTriggerListBufferSize = 0;
  88
  89 // Pending Trigger Macro Index List
  90 //  * Any trigger macros that need processing from a previous macro processing loop
  91 // TODO, figure out a good way to scale this array size without wasting too much memory, but not rejecting macros
  92 //       Possibly could be calculated by the KLL compiler
  93 // XXX It may be possible to calculate the worst case using the KLL compiler
  94 unsigned int macroTriggerMacroPendingList[ TriggerMacroNum ] = { 0 };
  95 unsigned int macroTriggerMacroPendingListSize = 0;
  96
  97 // Layer Index Stack
  98 //  * When modifying layer state and the state is non-0x0, the stack must be adjusted
  99 unsigned int macroLayerIndexStack[ LayerNum ] = { 0 };
 100 unsigned int macroLayerIndexStackSize = 0;
 101
 102 // Pending Result Macro Index List
 103 //  * Any result macro that needs processing from a previous macro processing loop
 104 unsigned int macroResultMacroPendingList[ ResultMacroNum ] = { 0 };
 105 unsigned int macroResultMacroPendingListSize = 0;
 106
 107
 108
 109 // ----- Functions -----
 110
 111 // Looks up the trigger list for the given scan code (from the active layer)
 112 // NOTE: Calling function must handle the NULL pointer case
 113 unsigned int *Macro_layerLookup( uint8_t scanCode )
 114 {
 115         // If no trigger macro is defined at the given layer, fallthrough to the next layer
 116         for ( unsigned int layer = 0; layer < macroLayerIndexStackSize; layer++ )
 117         {
 118                 // Lookup layer
 119                 unsigned int **map = LayerIndex[ macroLayerIndexStack[ layer ] ].triggerMap;
 120
 121                 // Determine if layer has key defined
 122                 if ( map != 0 && *map[ scanCode ] != 0 )
 123                         return map[ scanCode ];
 124         }
 125
 126         // Do lookup on default layer
 127         unsigned int **map = LayerIndex[0].triggerMap;
 128
 129         // Determine if layer has key defined
 130         if ( map == 0 && *map[ scanCode ] == 0 )
 131         {
 132                 erro_msg("Scan Code has no defined Trigger Macro: ");
 133                 printHex( scanCode );
 134                 return 0;
 135         }
 136
 137         // Return lookup result
 138         return map[ scanCode ];
 139 }
 140
 141
 142 // Update the scancode key state
 143 // States:
 144 //   * 0x00 - Off
 145 //   * 0x01 - Pressed
 146 //   * 0x02 - Held
 147 //   * 0x03 - Released
 148 //   * 0x04 - Unpressed (this is currently ignored)
 149 inline void Macro_keyState( uint8_t scanCode, uint8_t state )
 150 {
 151         // Only add to macro trigger list if one of three states
 152         switch ( state )
 153         {
 154         case 0x01: // Pressed
 155         case 0x02: // Held
 156         case 0x03: // Released
 157                 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
 158                 macroTriggerListBuffer[ macroTriggerListBufferSize ].state    = state;
 159                 macroTriggerListBuffer[ macroTriggerListBufferSize ].type     = 0x00; // Normal key
 160                 macroTriggerListBufferSize++;
 161                 break;
 162         }
 163 }
 164
 165
 166 // Update the scancode analog state
 167 // States:
 168 //   * 0x00      - Off
 169 //   * 0x01      - Released
 170 //   * 0x02-0xFF - Analog value (low to high)
 171 inline void Macro_analogState( uint8_t scanCode, uint8_t state )
 172 {
 173         // Only add to macro trigger list if non-off
 174         if ( state != 0x00 )
 175         {
 176                 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
 177                 macroTriggerListBuffer[ macroTriggerListBufferSize ].state    = state;
 178                 macroTriggerListBuffer[ macroTriggerListBufferSize ].type     = 0x02; // Analog key
 179                 macroTriggerListBufferSize++;
 180         }
 181 }
 182
 183
 184 // Update led state
 185 // States:
 186 //   * 0x00 - Off
 187 //   * 0x01 - On
 188 inline void Macro_ledState( uint8_t ledCode, uint8_t state )
 189 {
 190         // Only add to macro trigger list if non-off
 191         if ( state != 0x00 )
 192         {
 193                 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = ledCode;
 194                 macroTriggerListBuffer[ macroTriggerListBufferSize ].state    = state;
 195                 macroTriggerListBuffer[ macroTriggerListBufferSize ].type     = 0x01; // LED key
 196                 macroTriggerListBufferSize++;
 197         }
 198 }
 199
 200
 201 // Evaluate/Update TriggerMacro
 202 void Macro_evalTriggerMacro( TriggerMacro *triggerMacro )
 203 {
 204         // Which combo in the sequence is being evaluated
 205         unsigned int comboPos = triggerMacro->pos;
 206
 207         // If combo length is more than 1, cancel trigger macro if an incorrect key is found
 208         uint8_t comboLength = triggerMacro->guide[ comboPos ];
 209
 210         // Iterate over list of keys currently pressed
 211         for ( uint8_t keyPressed = 0; keyPressed < macroTriggerListBufferSize; keyPressed++ )
 212         {
 213                 // Compare with keys in combo
 214                 for ( unsigned int comboKey = 0; comboKey < comboLength; comboKey++ )
 215                 {
 216                         // Lookup key in combo
 217                         uint8_t guideKey = triggerMacro->guide[ comboPos + comboKey + 2 ]; // TODO Only Press/Hold/Release atm
 218
 219                         // Sequence Case
 220                         if ( comboLength == 1 )
 221                         {
 222                                 // If key matches and only 1 key pressed, increment the TriggerMacro combo position
 223                                 if ( guideKey == macroTriggerListBuffer[ keyPressed ].scanCode && macroTriggerListBufferSize == 1 )
 224                                 {
 225                                         triggerMacro->pos += comboLength * 2 + 1;
 226                                         // TODO check if TriggerMacro is finished, register ResultMacro
 227                                         return;
 228                                 }
 229
 230                                 // If key does not match or more than 1 key pressed, reset the TriggerMacro combo position
 231                                 triggerMacro->pos = 0;
 232                                 return;
 233                         }
 234                         // Combo Case
 235                         else
 236                         {
 237                                 // TODO
 238                         }
 239                 }
 240         }
 241 }
 242
 243
 244 // Evaluate/Update ResultMacro
 245 void Macro_evalResultMacro( ResultMacro *resultMacro )
 246 {
 247         // TODO
 248 }
 249
 250
 251 // Called immediately after USB has finished sending a buffer
 252 inline void Macro_finishWithUSBBuffer( uint8_t sentKeys )
 253 {
 254         // XXX Currently not used to trigger anything (with this particular Macro module)
 255 }
 256
 257
 258 // Macro Procesing Loop
 259 // Called once per USB buffer send
 260 inline void Macro_process()
 261 {
 262         // Only do one round of macro processing between Output Module timer sends
 263         if ( USBKeys_Sent != 0 )
 264                 return;
 265
 266         // If the pause flag is set, only process if the step counter is non-zero
 267         if ( macroPauseMode && macroStepCounter == 0 )
 268         {
 269                 return;
 270         }
 271         // Proceed, decrementing the step counter
 272         else
 273         {
 274                 macroStepCounter--;
 275         }
 276
 277         // Loop through macro trigger buffer
 278         for ( uint8_t index = 0; index < macroTriggerListBufferSize; index++ )
 279         {
 280                 // Get scanCode, first item of macroTriggerListBuffer pairs
 281                 uint8_t scanCode = macroTriggerListBuffer[ index ].scanCode;
 282
 283                 // Lookup trigger list for this key
 284                 unsigned int *triggerList = Macro_layerLookup( scanCode );
 285
 286                 // Skip, if no trigger list
 287                 if ( triggerList == 0 )
 288                         continue;
 289
 290                 // The first element is the length of the trigger list
 291                 unsigned int triggerListSize = triggerList[0];
 292
 293                 // Loop through the trigger list
 294                 for ( unsigned int trigger = 0; trigger < triggerListSize; trigger++ )
 295                 {
 296                         // Lookup TriggerMacro
 297                         TriggerMacro *triggerMacro = (TriggerMacro*)triggerList[ trigger + 1 ];
 298
 299                         // Get triggered state of scan code, second item of macroTriggerListBuffer pairs
 300                         uint8_t state = macroTriggerListBuffer[ index ].state;
 301
 302                         // Evaluate Macro
 303                         Macro_evalTriggerMacro( triggerMacro );
 304                 }
 305         }
 306
 307
 308
 309
 310
 311         /* TODO
 312         // Loop through input buffer
 313         for ( uint8_t index = 0; index < KeyIndex_BufferUsed && !macroDebugMode; index++ )
 314         {
 315                 //print(" KEYS: ");
 316                 //printInt8( KeyIndex_BufferUsed );
 317                 // Get the keycode from the buffer
 318                 uint8_t key = KeyIndex_Buffer[index];
 319
 320                 // Set the modifier bit if this key is a modifier
 321                 if ( (key & KEY_LCTRL) == KEY_LCTRL ) // AND with 0xE0
 322                 {
 323                         USBKeys_Modifiers |= 1 << (key ^ KEY_LCTRL); // Left shift 1 by key XOR 0xE0
 324
 325                         // Modifier processed, move on to the next key
 326                         continue;
 327                 }
 328
 329                 // Too many keys
 330                 if ( USBKeys_Sent >= USBKeys_MaxSize )
 331                 {
 332                         warn_msg("USB Key limit reached");
 333                         errorLED( 1 );
 334                         break;
 335                 }
 336
 337                 // Allow ignoring keys with 0's
 338                 if ( key != 0 )
 339                 {
 340                         USBKeys_Array[USBKeys_Sent++] = key;
 341                 }
 342                 else
 343                 {
 344                         // Key was not mapped
 345                         erro_msg( "Key not mapped... - " );
 346                         printHex( key );
 347                         errorLED( 1 );
 348                 }
 349         }
 350         */
 351
 352         // Signal buffer that we've used it
 353         Scan_finishedWithBuffer( KeyIndex_BufferUsed );
 354
 355         // If Macro debug mode is set, clear the USB Buffer
 356         if ( macroDebugMode )
 357         {
 358                 USBKeys_Modifiers = 0;
 359                 USBKeys_Sent = 0;
 360         }
 361 }
 362
 363
 364 inline void Macro_setup()
 365 {
 366         // Register Macro CLI dictionary
 367         CLI_registerDictionary( macroCLIDict, macroCLIDictName );
 368
 369         // Disable Macro debug mode
 370         macroDebugMode = 0;
 371
 372         // Disable Macro pause flag
 373         macroPauseMode = 0;
 374
 375         // Set Macro step counter to zero
 376         macroStepCounter = 0;
 377
 378         // Make sure macro trigger buffer is empty
 379         macroTriggerListBufferSize = 0;
 380 }
 381
 382
 383 // ----- CLI Command Functions -----
 384
 385 void cliFunc_capList( char* args )
 386 {
 387         print( NL );
 388         info_msg("Capabilities List");
 389
 390         // Iterate through all of the capabilities and display them
 391         for ( unsigned int cap = 0; cap < CapabilitiesNum; cap++ )
 392         {
 393                 print( NL "\t" );
 394                 printHex( cap );
 395                 print(" - ");
 396
 397                 // Display/Lookup Capability Name (utilize debug mode of capability)
 398                 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
 399                 capability( 0xFF, 0xFF, 0 );
 400         }
 401 }
 402
 403 void cliFunc_capSelect( char* args )
 404 {
 405         // Parse code from argument
 406         char* curArgs;
 407         char* arg1Ptr;
 408         char* arg2Ptr = args;
 409
 410         // Total number of args to scan (must do a lookup if a keyboard capability is selected)
 411         unsigned int totalArgs = 2; // Always at least two args
 412         unsigned int cap = 0;
 413
 414         // Arguments used for keyboard capability function
 415         unsigned int argSetCount = 0;
 416         uint8_t *argSet = (uint8_t*)args;
 417
 418         // Process all args
 419         for ( unsigned int c = 0; argSetCount < totalArgs; c++ )
 420         {
 421                 curArgs = arg2Ptr;
 422                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 423
 424                 // Stop processing args if no more are found
 425                 // Extra arguments are ignored
 426                 if ( *arg1Ptr == '\0' )
 427                         break;
 428
 429                 // For the first argument, choose the capability
 430                 if ( c == 0 ) switch ( arg1Ptr[0] )
 431                 {
 432                 // Keyboard Capability
 433                 case 'K':
 434                         // Determine capability index
 435                         cap = decToInt( &arg1Ptr[1] );
 436
 437                         // Lookup the number of args
 438                         totalArgs += CapabilitiesList[ cap ].argCount;
 439                         continue;
 440                 }
 441
 442                 // Because allocating memory isn't doable, and the argument count is arbitrary
 443                 // The argument pointer is repurposed as the argument list (much smaller anyways)
 444                 argSet[ argSetCount++ ] = (uint8_t)decToInt( arg1Ptr );
 445
 446                 // Once all the arguments are prepared, call the keyboard capability function
 447                 if ( argSetCount == totalArgs )
 448                 {
 449                         // Indicate that the capability was called
 450                         print( NL );
 451                         info_msg("K");
 452                         printInt8( cap );
 453                         print(" - ");
 454                         printHex( argSet[0] );
 455                         print(" - ");
 456                         printHex( argSet[1] );
 457                         print(" - ");
 458                         printHex( argSet[2] );
 459                         print( "..." NL );
 460
 461                         void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
 462                         capability( argSet[0], argSet[1], &argSet[2] );
 463                 }
 464         }
 465 }
 466
 467 void cliFunc_keyPress( char* args )
 468 {
 469         // Parse codes from arguments
 470         char* curArgs;
 471         char* arg1Ptr;
 472         char* arg2Ptr = args;
 473
 474         // Process all args
 475         for ( ;; )
 476         {
 477                 curArgs = arg2Ptr;
 478                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 479
 480                 // Stop processing args if no more are found
 481                 if ( *arg1Ptr == '\0' )
 482                         break;
 483
 484                 // Ignore non-Scancode numbers
 485                 switch ( arg1Ptr[0] )
 486                 {
 487                 // Scancode
 488                 case 'S':
 489                         Macro_keyState( (uint8_t)decToInt( &arg1Ptr[1] ), 0x01 ); // Press scancode
 490                         break;
 491                 }
 492         }
 493 }
 494
 495 void cliFunc_keyRelease( char* args )
 496 {
 497         // Parse codes from arguments
 498         char* curArgs;
 499         char* arg1Ptr;
 500         char* arg2Ptr = args;
 501
 502         // Process all args
 503         for ( ;; )
 504         {
 505                 curArgs = arg2Ptr;
 506                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 507
 508                 // Stop processing args if no more are found
 509                 if ( *arg1Ptr == '\0' )
 510                         break;
 511
 512                 // Ignore non-Scancode numbers
 513                 switch ( arg1Ptr[0] )
 514                 {
 515                 // Scancode
 516                 case 'S':
 517                         Macro_keyState( (uint8_t)decToInt( &arg1Ptr[1] ), 0x03 ); // Release scancode
 518                         break;
 519                 }
 520         }
 521 }
 522
 523 void cliFunc_layerList( char* args )
 524 {
 525         print( NL );
 526         info_msg("Layer List");
 527
 528         // Iterate through all of the layers and display them
 529         for ( unsigned int layer = 0; layer < LayerNum; layer++ )
 530         {
 531                 print( NL "\t" );
 532                 printHex( layer );
 533                 print(" - ");
 534
 535                 // Display layer name
 536                 dPrint( LayerIndex[ layer ].name );
 537
 538                 // Default map
 539                 if ( layer == 0 )
 540                         print(" \033[1m(default)\033[0m");
 541
 542                 // Layer State
 543                 print( NL "\t\t Layer State: " );
 544                 printHex( LayerIndex[ layer ].state );
 545
 546                 // Max Index
 547                 print(" Max Index: ");
 548                 printHex( LayerIndex[ layer ].max );
 549         }
 550 }
 551
 552 void cliFunc_layerState( char* args )
 553 {
 554         // Parse codes from arguments
 555         char* curArgs;
 556         char* arg1Ptr;
 557         char* arg2Ptr = args;
 558
 559         uint8_t arg1 = 0;
 560         uint8_t arg2 = 0;
 561
 562         // Process first two args
 563         for ( uint8_t c = 0; c < 2; c++ )
 564         {
 565                 curArgs = arg2Ptr;
 566                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 567
 568                 // Stop processing args if no more are found
 569                 if ( *arg1Ptr == '\0' )
 570                         break;
 571
 572                 switch ( c )
 573                 {
 574                 // First argument (e.g. L1)
 575                 case 0:
 576                         if ( arg1Ptr[0] != 'L' )
 577                                 return;
 578
 579                         arg1 = (uint8_t)decToInt( &arg1Ptr[1] );
 580                         break;
 581                 // Second argument (e.g. 4)
 582                 case 1:
 583                         arg2 = (uint8_t)decToInt( arg1Ptr );
 584
 585                         // Display operation (to indicate that it worked)
 586                         print( NL );
 587                         info_msg("Setting Layer L");
 588                         printInt8( arg1 );
 589                         print(" to - ");
 590                         printHex( arg2 );
 591
 592                         // Set the layer state
 593                         LayerIndex[ arg1 ].state = arg2;
 594                         break;
 595                 }
 596         }
 597 }
 598
 599 void cliFunc_macroDebug( char* args )
 600 {
 601         // Toggle macro debug mode
 602         macroDebugMode = macroDebugMode ? 0 : 1;
 603
 604         print( NL );
 605         info_msg("Macro Debug Mode: ");
 606         printInt8( macroDebugMode );
 607 }
 608
 609 void cliFunc_macroList( char* args )
 610 {
 611         // Show available trigger macro indices
 612         print( NL );
 613         info_msg("Trigger Macros Range: T0 -> T");
 614         printInt16( (uint16_t)TriggerMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
 615
 616         // Show available result macro indices
 617         print( NL );
 618         info_msg("Result  Macros Range: R0 -> R");
 619         printInt16( (uint16_t)ResultMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
 620
 621         // Show Trigger to Result Macro Links
 622         print( NL );
 623         info_msg("Trigger : Result Macro Pairs");
 624         for ( unsigned int macro = 0; macro < TriggerMacroNum; macro++ )
 625         {
 626                 print( NL );
 627                 print("\tT");
 628                 printInt16( (uint16_t)macro ); // Hopefully large enough :P (can't assume 32-bit)
 629                 print(" : R");
 630                 printInt16( (uint16_t)TriggerMacroList[ macro ].result ); // Hopefully large enough :P (can't assume 32-bit)
 631         }
 632 }
 633
 634 void cliFunc_macroProc( char* args )
 635 {
 636         // Toggle macro pause mode
 637         macroPauseMode = macroPauseMode ? 0 : 1;
 638
 639         print( NL );
 640         info_msg("Macro Processing Mode: ");
 641         printInt8( macroPauseMode );
 642 }
 643
 644 void macroDebugShowTrigger( unsigned int index )
 645 {
 646         // Only proceed if the macro exists
 647         if ( index >= TriggerMacroNum )
 648                 return;
 649
 650         // Trigger Macro Show
 651         TriggerMacro *macro = &TriggerMacroList[ index ];
 652
 653         print( NL );
 654         info_msg("Trigger Macro Index: ");
 655         printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
 656         print( NL );
 657
 658         // Read the comboLength for combo in the sequence (sequence of combos)
 659         unsigned int pos = 0;
 660         uint8_t comboLength = macro->guide[ pos ];
 661
 662         // Iterate through and interpret the guide
 663         while ( comboLength != 0 )
 664         {
 665                 // Initial position of the combo
 666                 unsigned int comboPos = ++pos;
 667
 668                 // Iterate through the combo
 669                 while ( pos < comboLength * TriggerGuideSize + comboPos )
 670                 {
 671                         // Assign TriggerGuide element (key type, state and scancode)
 672                         TriggerGuide *guide = (TriggerGuide*)(&macro->guide[ pos ]);
 673
 674                         // Display guide information about trigger key
 675                         printHex( guide->scanCode );
 676                         print("|");
 677                         printHex( guide->type );
 678                         print("|");
 679                         printHex( guide->state );
 680
 681                         // Increment position
 682                         pos += TriggerGuideSize;
 683
 684                         // Only show combo separator if there are combos left in the sequence element
 685                         if ( pos < comboLength * TriggerGuideSize + comboPos )
 686                                 print("+");
 687                 }
 688
 689                 // Read the next comboLength
 690                 comboLength = macro->guide[ pos ];
 691
 692                 // Only show sequence separator if there is another combo to process
 693                 if ( comboLength != 0 )
 694                         print(";");
 695         }
 696
 697         // Display current position
 698         print( NL "Position: " );
 699         printInt16( (uint16_t)macro->pos ); // Hopefully large enough :P (can't assume 32-bit)
 700
 701         // Display result macro index
 702         print( NL "Result Macro Index: " );
 703         printInt16( (uint16_t)macro->result ); // Hopefully large enough :P (can't assume 32-bit)
 704 }
 705
 706 void macroDebugShowResult( unsigned int index )
 707 {
 708         // Only proceed if the macro exists
 709         if ( index >= ResultMacroNum )
 710                 return;
 711
 712         // Trigger Macro Show
 713         ResultMacro *macro = &ResultMacroList[ index ];
 714
 715         print( NL );
 716         info_msg("Result Macro Index: ");
 717         printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
 718         print( NL );
 719
 720         // Read the comboLength for combo in the sequence (sequence of combos)
 721         unsigned int pos = 0;
 722         uint8_t comboLength = macro->guide[ pos++ ];
 723
 724         // Iterate through and interpret the guide
 725         while ( comboLength != 0 )
 726         {
 727                 // Function Counter, used to keep track of the combos processed
 728                 unsigned int funcCount = 0;
 729
 730                 // Iterate through the combo
 731                 while ( funcCount < comboLength )
 732                 {
 733                         // Assign TriggerGuide element (key type, state and scancode)
 734                         ResultGuide *guide = (ResultGuide*)(&macro->guide[ pos ]);
 735
 736                         // Display Function Index
 737                         printHex( guide->index );
 738                         print("|");
 739
 740                         // Display Function Ptr Address
 741                         printHex( (unsigned int)CapabilitiesList[ guide->index ].func );
 742                         print("|");
 743
 744                         // Display/Lookup Capability Name (utilize debug mode of capability)
 745                         void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
 746                         capability( 0xFF, 0xFF, 0 );
 747
 748                         // Display Argument(s)
 749                         print("(");
 750                         for ( unsigned int arg = 0; arg < CapabilitiesList[ guide->index ].argCount; arg++ )
 751                         {
 752                                 // Arguments are only 8 bit values
 753                                 printHex( (&guide->args)[ arg ] );
 754
 755                                 // Only show arg separator if there are args left
 756                                 if ( arg + 1 < CapabilitiesList[ guide->index ].argCount )
 757                                         print(",");
 758                         }
 759                         print(")");
 760
 761                         // Increment position
 762                         pos += ResultGuideSize( guide );
 763
 764                         // Increment function count
 765                         funcCount++;
 766
 767                         // Only show combo separator if there are combos left in the sequence element
 768                         if ( funcCount < comboLength )
 769                                 print("+");
 770                 }
 771
 772                 // Read the next comboLength
 773                 comboLength = macro->guide[ pos++ ];
 774
 775                 // Only show sequence separator if there is another combo to process
 776                 if ( comboLength != 0 )
 777                         print(";");
 778         }
 779
 780         // Display current position
 781         print( NL "Position: " );
 782         printInt16( (uint16_t)macro->pos ); // Hopefully large enough :P (can't assume 32-bit)
 783
 784         // Display final trigger state/type
 785         print( NL "Final Trigger State (State/Type): " );
 786         printHex( macro->state );
 787         print("/");
 788         printHex( macro->stateType );
 789 }
 790
 791 void cliFunc_macroShow( char* args )
 792 {
 793         // Parse codes from arguments
 794         char* curArgs;
 795         char* arg1Ptr;
 796         char* arg2Ptr = args;
 797
 798         // Process all args
 799         for ( ;; )
 800         {
 801                 curArgs = arg2Ptr;
 802                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 803
 804                 // Stop processing args if no more are found
 805                 if ( *arg1Ptr == '\0' )
 806                         break;
 807
 808                 // Ignore invalid codes
 809                 switch ( arg1Ptr[0] )
 810                 {
 811                 // Indexed Trigger Macro
 812                 case 'T':
 813                         macroDebugShowTrigger( decToInt( &arg1Ptr[1] ) );
 814                         break;
 815                 // Indexed Result Macro
 816                 case 'R':
 817                         macroDebugShowResult( decToInt( &arg1Ptr[1] ) );
 818                         break;
 819                 }
 820         }
 821 }
 822
 823 void cliFunc_macroStep( char* args )
 824 {
 825         // Parse number from argument
 826         //  NOTE: Only first argument is used
 827         char* arg1Ptr;
 828         char* arg2Ptr;
 829         CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 830
 831         // Set the macro step counter, negative int's are cast to uint
 832         macroStepCounter = (unsigned int)decToInt( arg1Ptr );
 833 }
 834