Fixes related to threading and release prep.

Author: nhmkdev

Forms/KeyCaptureConfig.cs

@@ -46,7 +46,6 @@ public partial class KeyCaptureConfig
         private readonly IniManager m_zIniManager = new IniManager(Application.ProductName, false, true, false);
 
         private FormWindowState m_ePrevWindowState = FormWindowState.Normal;
-        private bool m_bRun = true;
         private bool m_bShutdownApplication = false;
 
         /// <summary>
@@ -129,7 +128,6 @@ private void newToolStripMenuItem_Click(object sender, EventArgs e)
         private void exitMainToolStripMenuItem_Click(object sender, EventArgs e)
         {
             m_bShutdownApplication = true;
-            m_bRun = false;
             if (WindowState == FormWindowState.Minimized)
             {
                 WindowState = m_ePrevWindowState;

KeyCapLib/KeyCapture.cpp

@@ -153,7 +153,7 @@ void InitiallizeEntryContainerListItem(RemapEntryContainerListItem* pKeyItem, Re
 	pKeyItem->pEntryContainer->pEntry = pEntry;
 }
 
-void ShutdownInputThreads()
+void ShutdownInputThreads(bool forceShutdown)
 {
 	// signal shutdown for all entries with a thread handle
 	for (int nIdx = 0; nIdx < WIN_KEY_COUNT; nIdx++)
@@ -174,6 +174,9 @@ void ShutdownInputThreads()
 		}
 	}
 
+	// a forced shutdown will kill threads (mostly for application exit)
+	if(!forceShutdown) return;
+
 	// monitor and terminate threads for all entries with a thread handle
 	for (int nIdx = 0; nIdx < WIN_KEY_COUNT; nIdx++)
 	{
@@ -210,7 +213,7 @@ Shuts down the key capture hook and frees any allocated memory
 __declspec(dllexport) void ShutdownCapture()
 {
 	// stop any active threads
-	ShutdownInputThreads();
+	ShutdownInputThreads(true);
 
 	// disable the hook
 	if(NULL != g_hookMain)

KeyCapLib/KeyCapture.h

@@ -29,7 +29,7 @@
 #include "keycaptureutil.h"
 
 // shared functions
-void ShutdownInputThreads();
+void ShutdownInputThreads(bool forceShutdown);
 
 // === consts and defines
 const int THREAD_SHUTDOWN_MAX_ATTEMPTS = 5;

KeyCapLib/KeyCaptureUtil.cpp

@@ -25,6 +25,14 @@
 #include "keycapturestructs.h"
 #include "keycaptureutil.h"
 
+void ResetRemapEntryState(RemapEntryState* pRemapEntryState, BYTE bToggled)
+{
+	pRemapEntryState->bToggled = bToggled;
+	pRemapEntryState->bRepeating = false;
+	pRemapEntryState->bShutdown = false;
+	pRemapEntryState->threadHandle = NULL;
+}
+
 bool IsButtonDownRequired(RemapEntryState* pRemapEntryState, OutputConfig* pKeyDef)
 {
 	if (pKeyDef->outputFlag.bToggle)

KeyCapLib/KeyCaptureUtil.h

@@ -30,6 +30,7 @@
 
 const int DESCRIPTION_BUFFER_SIZE = 256;
 
+void ResetRemapEntryState(RemapEntryState* pRemapEntryState, BYTE bToggled);
 bool IsButtonDownRequired(RemapEntryState* pRemapEntryState, OutputConfig* pKeyDef);
 bool IsButtonUpRequired(RemapEntryState* pRemapEntryState, OutputConfig* pKeyDef);
 

KeyCapLib/sendinputthread.cpp

@@ -109,10 +109,8 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 			}
 			if(pOutputConfig->outputFlag.bCancelActiveOutputs)
 			{
-				// HACK alert - would destroy this thread, so disassociate and exit immediately after
-				pRemapEntryState->bShutdown = true;
-				pRemapEntryState->threadHandle = NULL;
-				ShutdownInputThreads();
+				// NOTE: even this thread might be affected
+				ShutdownInputThreads(false);
 				break;
 			}
 			else if (pOutputConfig->outputFlag.bMouseOut)
@@ -152,17 +150,34 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 		firstPassComplete = true;
 		if (pRemapEntryState->bRepeating)
 		{
-			Sleep(repeatDelayMillis);
-			LogDebugMessage("SendInputThread Repeating...");
+			int iterations = repeatDelayMillis / MIN_REPEAT_DELAY_MS;
+			for (int repeatDelayCount = 0; repeatDelayCount < iterations; repeatDelayCount++)
+			{
+				Sleep(100);
+				if (pRemapEntryState->bShutdown)
+				{
+					LogDebugMessage("Exiting repeat loop due to shutdown.");
+					break;
+				}
+			}
+			if (!pRemapEntryState->bShutdown)
+			{
+				LogDebugMessage("SendInputThread Repeating...");
+			}
 		}
 	} while (pRemapEntryState->bRepeating);
 
-	// flip the overall toggle state
+	// flip the overall toggle state (even when a thread is canceled this should flip back, arguably to false...)
 	pRemapEntryState->bToggled = !pRemapEntryState->bToggled;
-	pRemapEntryState->bShutdown = false;
 
-	LogDebugMessage("SendInputThread Completed");
-	// Disconnect this thread from the state
+	// reset things on the remap entry
+	pRemapEntryState->bShutdown = false;
+	pRemapEntryState->bRepeating = false;
 	pRemapEntryState->threadHandle = NULL;
+#ifdef _DEBUG
+	char* pInputConfigDescription = GetInputConfigDescription(pRemapEntry->inputConfig);
+	LogDebugMessage("SendInputThread Completed: %s", pInputConfigDescription);
+	free(pInputConfigDescription);
+#endif
 	return 0;
 }

Properties/AssemblyInfo.cs

@@ -33,7 +33,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("NHMK")]
 [assembly: AssemblyProduct("KeyCap")]
-[assembly: AssemblyCopyright("Copyright © NHMK 2019")]
+[assembly: AssemblyCopyright("Copyright © NHMK 2020")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -55,5 +55,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.0.0.0")]
-[assembly: AssemblyFileVersion("2.0.0.0")]
+[assembly: AssemblyVersion("2.0.0.1")]
+[assembly: AssemblyFileVersion("2.0.0.1")]

bin/Release/History.txt

@@ -1,5 +1,9 @@
 KeyCap Version History
 --------------------------
+2.0.0.1
+- Added ability to cancel all active threads (repeats, delays, etc.)
+- Fixed a critical bug with shutdown (basically it wouldn't)
+
 2.0.0.0
 - New file format for configurations to support future expansion
 - Direct control over up/down messages (if needed)