Memory and input adjustments.

Non-repeating inputs (highlight: delayed inputs) will not allow re-execution until the existing thread is complete. The inputs keys will still be handled by the application and not passed through for further processing.

Author: nhmkdev

KeyCapLib/KeyCapLib.vcxproj

@@ -22,32 +22,32 @@
     <ProjectGuid>{5637CC7B-9FFF-486B-9D51-898DEDCB908A}</ProjectGuid>
     <Keyword>Win32Proj</Keyword>
     <RootNamespace>KeyCapLib</RootNamespace>
-    <WindowsTargetPlatformVersion>10.0.17134.0</WindowsTargetPlatformVersion>
+    <WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
     <ConfigurationType>DynamicLibrary</ConfigurationType>
     <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>v141</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <CharacterSet>Unicode</CharacterSet>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
     <ConfigurationType>DynamicLibrary</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>v141</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <WholeProgramOptimization>true</WholeProgramOptimization>
     <CharacterSet>Unicode</CharacterSet>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
     <ConfigurationType>DynamicLibrary</ConfigurationType>
     <UseDebugLibraries>true</UseDebugLibraries>
-    <PlatformToolset>v141</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <CharacterSet>Unicode</CharacterSet>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
     <ConfigurationType>DynamicLibrary</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
-    <PlatformToolset>v141</PlatformToolset>
+    <PlatformToolset>v142</PlatformToolset>
     <WholeProgramOptimization>true</WholeProgramOptimization>
     <CharacterSet>Unicode</CharacterSet>
   </PropertyGroup>

KeyCapLib/KeyCapture.cpp

@@ -28,7 +28,6 @@
 #include "keycapture.h"
 #include "keyboardproc.h"
 #include "mouseinput.h"
-#include "keyboardinput.h"
 #include "configfile.h"
 
 // === prototypes
@@ -39,9 +38,11 @@ extern "C"
 	__declspec(dllexport) void ShutdownCapture();
 }
 
-HHOOK g_hookMain = NULL;
+// non extern functions
+void InitiallizeEntryContainerListItem(RemapEntryContainerListItem* pKeyItem, RemapEntry* pEntry);
 
 // sweet globals
+HHOOK g_hookMain = NULL;
 RemapEntryContainerListItem* g_KeyTranslationTable[WIN_KEY_COUNT];
 RemapEntry* g_KeyTranslationHead = NULL;
 void* g_KeyTranslationEnd = NULL; // pointer indicating the end of the input file data
@@ -83,20 +84,19 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 			return INPUT_BAD;
 		}
 		// TODO: just get a pointer to g_KeyTranslationTable[pKey->inputConfig.virtualKey] ?
-
+#ifdef _DEBUG
 		char* pInputConfigDescription = GetInputConfigDescription(pEntry->inputConfig);
 		LogDebugMessage("Loading %s Outputs: %d", pInputConfigDescription, pEntry->outputCount);
 		free(pInputConfigDescription);
-
+#endif
 		// if the entry doesn't exist yet for the given input vkey create a new one with a null next pointer
 		if(NULL == g_KeyTranslationTable[pEntry->inputConfig.virtualKey])
 		{
 			g_KeyTranslationTable[pEntry->inputConfig.virtualKey] = (RemapEntryContainerListItem*)malloc(sizeof(RemapEntryContainerListItem));
-			g_KeyTranslationTable[pEntry->inputConfig.virtualKey]->pEntryContainer = (RemapEntryContainer*)malloc(sizeof(RemapEntryContainer));
-			g_KeyTranslationTable[pEntry->inputConfig.virtualKey]->pEntryContainer->pEntryState = (RemapEntryState*)malloc(sizeof(RemapEntryState));
-			g_KeyTranslationTable[pEntry->inputConfig.virtualKey]->pEntryContainer->pEntry = pEntry;
+			InitiallizeEntryContainerListItem(g_KeyTranslationTable[pEntry->inputConfig.virtualKey], pEntry);
 			g_KeyTranslationTable[pEntry->inputConfig.virtualKey]->pNext = NULL;
 		}
+		
 		// if the entry does exist create a new entry and append it to the existing linked list
 		else
 		{
@@ -107,9 +107,7 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 			}
 			pKeyItem->pNext = (RemapEntryContainerListItem*)malloc(sizeof(RemapEntryContainerListItem));
 			pKeyItem = pKeyItem->pNext;
-			pKeyItem->pEntryContainer = (RemapEntryContainer*)malloc(sizeof(RemapEntryContainer));
-			pKeyItem->pEntryContainer->pEntryState = (RemapEntryState*)malloc(sizeof(RemapEntryState));
-			pKeyItem->pEntryContainer->pEntry = pEntry;
+			InitiallizeEntryContainerListItem(pKeyItem, pEntry);
 			pKeyItem->pNext = NULL;
 		}
 		// jump to the next entry
@@ -130,7 +128,7 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 	if(bValidTranslationSet)
 	{
 		// Note: This fails in VisualStudio if managed debugging is NOT enabled in the project(!)
-		HHOOK g_hookMain = SetWindowsHookEx( WH_KEYBOARD_LL, LowLevelKeyboardProc, hInstance, NULL);
+		g_hookMain = SetWindowsHookEx( WH_KEYBOARD_LL, LowLevelKeyboardProc, hInstance, NULL);
 		if(NULL == g_hookMain)
 		{
 			ShutdownCapture();
@@ -148,11 +146,67 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 	}
 }
 
+void InitiallizeEntryContainerListItem(RemapEntryContainerListItem* pKeyItem, RemapEntry* pEntry)
+{
+	pKeyItem->pEntryContainer = (RemapEntryContainer*)malloc(sizeof(RemapEntryContainer));
+	pKeyItem->pEntryContainer->pEntryState = (RemapEntryState*)calloc(1, sizeof(RemapEntryState));
+	pKeyItem->pEntryContainer->pEntry = pEntry;
+}
+
 /*
 Shuts down the key capture hook and frees any allocated memory
 */
 __declspec(dllexport) void ShutdownCapture()
 {
+	// signal shutdown for all entries with a thread handle
+	for(int nIdx = 0; nIdx < WIN_KEY_COUNT; nIdx++)
+	{
+		if(NULL != g_KeyTranslationTable[nIdx])
+		{
+			RemapEntryContainerListItem* pListItem = g_KeyTranslationTable[nIdx];
+			RemapEntryContainerListItem* pNextItem = NULL;
+			while(NULL != pListItem)
+			{
+				pNextItem = pListItem->pNext;
+				if (NULL != pListItem->pEntryContainer->pEntryState->threadHandle)
+				{
+					pListItem->pEntryContainer->pEntryState->bShutdown = true;
+				}
+				pListItem = pNextItem;
+			}
+		}
+	}	
+
+	// monitor and terminate threads for all entries with a thread handle
+	for (int nIdx = 0; nIdx < WIN_KEY_COUNT; nIdx++)
+	{
+		if (NULL != g_KeyTranslationTable[nIdx])
+		{
+			RemapEntryContainerListItem* pListItem = g_KeyTranslationTable[nIdx];
+			RemapEntryContainerListItem* pNextItem = NULL;
+			while (NULL != pListItem)
+			{
+				pNextItem = pListItem->pNext;
+				if(NULL != pListItem->pEntryContainer->pEntryState->threadHandle)
+				{
+					DWORD dwExitCode = WAIT_TIMEOUT;
+					for(int shutdownIteration = 0; shutdownIteration < THREAD_SHUTDOWN_MAX_ATTEMPTS && dwExitCode != WAIT_OBJECT_0; shutdownIteration++)
+					{
+						// check on the state of the thread (for 100ms) (MS says not to use GetExitCodeThread unless the thread is known to be exited)
+						dwExitCode = WaitForSingleObject(pListItem->pEntryContainer->pEntryState->threadHandle, THREAD_SHUTDOWN_ATTEMPT_DELAY_MS);
+					}
+					if (dwExitCode != WAIT_OBJECT_0)
+					{
+						LogDebugMessage("Force terminating thread!");
+						TerminateThread(pListItem->pEntryContainer->pEntryState->threadHandle, 1);
+					}
+				}
+				pListItem = pNextItem;
+			}
+		}
+	}
+
+	
 	// disable the hook
 	if(NULL != g_hookMain)
 	{

KeyCapLib/KeyCapture.h

@@ -28,4 +28,8 @@
 #include "keycapturestructs.h"
 #include "keycaptureutil.h"
 
+// === consts and defines
+const int THREAD_SHUTDOWN_MAX_ATTEMPTS = 5;
+const int THREAD_SHUTDOWN_ATTEMPT_DELAY_MS = 100;
+
 #endif // KEY_CAPTURE_H_

KeyCapLib/KeyboardInput.cpp

@@ -30,7 +30,7 @@ Sends the necessary inputs to complete the trigger (modifier keys)
 
 pTriggerDefinition: pointer to a key definition for the trigger
 */
-void SendTriggerEndInputKeys(RemapEntry* pRemapEntry/*InputConfig* pInputConfig*/)
+void SendTriggerEndInputKeys(RemapEntry* pRemapEntry)
 {
 	InputConfig* pInputConfig = &pRemapEntry->inputConfig;
 

KeyCapLib/keyboardproc.cpp

@@ -59,11 +59,17 @@ LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam)
 						(bControl == pKeyDef->inputFlag.bControl) &&
 						(bShift == pKeyDef->inputFlag.bShift))
 					{
+#ifdef _DEBUG
 						char* pInputConfigDescription = GetInputConfigDescription(*pKeyDef);
 						LogDebugMessage("Detected Key Press: %s Outputs: %d", pInputConfigDescription, pKeyListItem->pEntryContainer->pEntry->outputCount);
 						free(pInputConfigDescription);
-						// TODO: get thread handle, also check for null
-						CreateThread(NULL, 0, SendInputThread, pKeyListItem->pEntryContainer, 0, NULL);
+#endif
+						// If there is NOT an existing thread OR the existing thread is running a repeat another key press is allowed
+						if (NULL == pKeyListItem->pEntryContainer->pEntryState->threadHandle || pKeyListItem->pEntryContainer->pEntryState->bRepeating)
+						{
+							pKeyListItem->pEntryContainer->pEntryState->threadHandle = CreateThread(NULL, 0, SendInputThread, pKeyListItem->pEntryContainer, 0, NULL);
+						}
+						// no matter if a new SendInputThread was started or not block further processing with the inputs
 						bSentInput = true;
 						break;
 					}

KeyCapLib/keycapturestructs.h

@@ -95,7 +95,8 @@ struct RemapEntryState
 {
 	BYTE bToggled : 1;
 	BYTE bRepeating : 1;
-	BYTE padOne : 6;
+	BYTE bShutdown : 1;
+	BYTE padOne : 5;
 	BYTE padTwo : 8;
 	BYTE padThree : 8;
 	BYTE padFour : 8;

KeyCapLib/sendinputthread.cpp

@@ -61,6 +61,7 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 	if (pRemapEntryState->bRepeating)
 	{
 		pRemapEntryState->bRepeating = false;
+		pRemapEntryState->bShutdown = true;
 		LogDebugMessage("SendInputThread Completed (ended Repeat)");
 		return 0;
 	}
@@ -92,14 +93,14 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 				// skip this output
 				pOutputConfig++; // move the pointer forward one KeyDefinition
 			}
-
+#ifdef _DEBUG
 			char* pOutputConfigDescription = GetOutputConfigDescription(*pOutputConfig);
 			LogDebugMessage("Performing %s Output Action: %s",
 				pOutputConfig->outputFlag.bMouseOut ? "Mouse" : "Keyboard",
 				pOutputConfigDescription
 			);
 			free(pOutputConfigDescription);
-
+#endif
 			// mouse input
 			if (pOutputConfig->outputFlag.bMouseOut)
 			{
@@ -108,7 +109,16 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 			// just a delay
 			else if (pOutputConfig->outputFlag.bDelay)
 			{
-				Sleep(1000 * pOutputConfig->parameter);
+				//Want to delay break...
+				int iterations = pOutputConfig->parameter * 10;
+				for (int nDelayCount = 0; nDelayCount < iterations; nDelayCount++)
+				{
+					Sleep(100);
+					if (pRemapEntryState->bShutdown)
+					{
+						break;
+					}
+				}
 			}
 			// keyboard input
 			else
@@ -118,6 +128,12 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 			pOutputConfig++; // move the pointer forward one KeyDefinition
 		}
 
+		// break out now
+		if (pRemapEntryState->bShutdown)
+		{
+			break;
+		}
+		
 		// reset output pointer
 		pOutputConfig = (OutputConfig*)(pRemapEntry + 1);
 		firstPassComplete = true;
@@ -132,5 +148,7 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 	pRemapEntryState->bToggled = !pRemapEntryState->bToggled;
 
 	LogDebugMessage("SendInputThread Completed");
+	// Disconnect this thread from the state
+	pRemapEntryState->threadHandle = NULL;
 	return 0;
 }