1 /* Copyright (C) 2014 by Jacob Alexander
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 // ----- Includes -----
25 #include <Lib/MacroLib.h>
31 #include <scan_loop.h>
32 #include <output_com.h>
36 #include <defaultMap.h>
43 // ----- Function Declarations -----
45 void cliFunc_capList ( char* args );
46 void cliFunc_capSelect ( char* args );
47 void cliFunc_lookComb ( char* args );
48 void cliFunc_lookDefault( char* args );
49 void cliFunc_lookPartial( char* args );
50 void cliFunc_macroDebug ( char* args );
54 // ----- Variables -----
56 // Macro Module command dictionary
57 char* macroCLIDictName = "Macro Module Commands (Not all commands fully work yet...)";
58 CLIDictItem macroCLIDict[] = {
59 { "capList", "Prints an indexed list of all non USB keycode capabilities.", cliFunc_capList },
60 { "capSelect", "Triggers the specified capability. U10 - USB Code 0x0A. K11 - Keyboard Capability 0x0B. S10 - Scancode 0x0A", cliFunc_capSelect },
61 { "lookComb", "Do a lookup on the Combined map. S10 - Scancode 0x0A. U10 - USB Code 0x0A.", cliFunc_lookComb },
62 { "lookDefault", "Do a lookup on the Default map. S10 - Scancode 0x0A.", cliFunc_lookDefault },
63 { "lookPartial", "Do a lookup on the layered Partial maps. S10 - Scancode 0x0A. U10 - USB Code 0x0A.", cliFunc_lookPartial },
64 { "macroDebug", "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes.", cliFunc_macroDebug },
65 { 0, 0, 0 } // Null entry for dictionary end
69 // Macro debug flag - If set, clears the USB Buffers after signalling processing completion
70 uint8_t macroDebugMode = 0;
74 // ----- Functions -----
76 inline void Macro_bufferAdd( uint8_t byte )
78 // Make sure we haven't overflowed the key buffer
79 // Default function for adding keys to the KeyIndex_Buffer, does a DefaultMap_Lookup
80 if ( KeyIndex_BufferUsed < KEYBOARD_BUFFER )
82 KeyIndex_Buffer[KeyIndex_BufferUsed++] = DefaultMap_Lookup[byte];
86 inline void Macro_finishWithUSBBuffer( uint8_t sentKeys )
90 inline void Macro_process()
92 // Only do one round of macro processing between Output Module timer sends
93 if ( USBKeys_Sent != 0 )
96 // Loop through input buffer
97 for ( uint8_t index = 0; index < KeyIndex_BufferUsed; index++ )
99 // Get the keycode from the buffer
100 uint8_t key = KeyIndex_Buffer[index];
102 // Set the modifier bit if this key is a modifier
103 if ( key & KEY_LCTRL ) // AND with 0xE0
105 USBKeys_Modifiers |= 1 << (key ^ KEY_LCTRL); // Left shift 1 by key XOR 0xE0
107 // Modifier processed, move on to the next key
112 if ( USBKeys_Sent >= USBKeys_MaxSize )
114 warn_msg("USB Key limit reached");
119 // Allow ignoring keys with 0's
122 USBKeys_Array[USBKeys_Sent++] = key;
126 // Key was not mapped
127 erro_msg( "Key not mapped... - " );
133 // Signal buffer that we've used it
134 Scan_finishedWithBuffer( KeyIndex_BufferUsed );
136 // If Macro debug mode is set, clear the USB Buffer
137 if ( macroDebugMode )
139 USBKeys_Modifiers = 0;
144 inline void Macro_setup()
146 // Register Macro CLI dictionary
147 CLI_registerDictionary( macroCLIDict, macroCLIDictName );
149 // Disable Macro debug mode
154 // ----- CLI Command Functions -----
156 void cliFunc_capList( char* args )
161 void cliFunc_capSelect( char* args )
163 // Parse code from argument
164 // NOTE: Only first argument is used
167 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
169 // Depending on the first character, the lookup changes
170 switch ( arg1Ptr[0] )
172 // Keyboard Capability
179 // Add to the USB Buffer using the DefaultMap lookup
180 Macro_bufferAdd( decToInt( &arg1Ptr[1] ) );
185 // Just add the key to the USB Buffer
186 if ( KeyIndex_BufferUsed < KEYBOARD_BUFFER )
188 KeyIndex_Buffer[KeyIndex_BufferUsed++] = decToInt( &arg1Ptr[1] );
194 void cliFunc_lookComb( char* args )
196 // Parse code from argument
197 // NOTE: Only first argument is used
200 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
202 // Depending on the first character, the lookup changes
203 switch ( arg1Ptr[0] )
217 void cliFunc_lookDefault( char* args )
219 // Parse code from argument
220 // NOTE: Only first argument is used
223 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
225 // Depending on the first character, the lookup changes
226 switch ( arg1Ptr[0] )
231 printInt8( DefaultMap_Lookup[decToInt( &arg1Ptr[1] )] );
233 printHex( DefaultMap_Lookup[decToInt( &arg1Ptr[1] )] );
238 void cliFunc_lookPartial( char* args )
240 // Parse code from argument
241 // NOTE: Only first argument is used
244 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
246 // Depending on the first character, the lookup changes
247 switch ( arg1Ptr[0] )
261 void cliFunc_macroDebug( char* args )
263 // Toggle macro debug mode
264 macroDebugMode = macroDebugMode ? 0 : 1;
267 info_msg("Macro Debug Mode: ");
268 printInt8( macroDebugMode );