Refactor proc files into their own types

More log wrapping for debug. Overall needs more testing with mouse. Mouse is challenging if you have other apps that perform injections (mouse software for example). Will reorganize files and potentially rename things to cut down on confusion (inputs/outputs/blah).

Author: nhmkdev

Format/MouseMapping.cs

@@ -0,0 +1,52 @@
+////////////////////////////////////////////////////////////////////////////////
+// The MIT License (MIT)
+//
+// Copyright (c) 2023 Tim Stair
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+////////////////////////////////////////////////////////////////////////////////
+using System.Collections.Generic;
+using System.Windows.Forms;
+
+namespace KeyCap.Format
+{
+    public class MouseMapping
+    {
+        const byte VK_MBUTTON = 0x04;
+        const byte VK_XBUTTON1 = 0x05;
+        const byte VK_XBUTTON2 = 0x06;
+
+        private static Dictionary<MouseButtons, byte> s_mouseButtonsToKeyCode = new Dictionary<MouseButtons, byte>()
+        {
+            {MouseButtons.Middle, VK_MBUTTON },
+            {MouseButtons.XButton1, VK_XBUTTON1 },
+            {MouseButtons.XButton2, VK_XBUTTON2 },
+        };
+
+        public static byte MapMouseButtonToKeyCode(MouseButtons eMouseButton)
+        {
+            if(s_mouseButtonsToKeyCode.TryGetValue(eMouseButton, out byte nKeyCode))
+            {
+                return nKeyCode;
+            }
+
+            return 0;
+        }
+    }
+}

Forms/KeyCaptureConfig.cs

@@ -401,19 +401,7 @@ private void btnMouseGeneric_Click(object sender, EventArgs e)
 
         private void txtKeyIn_MouseDown(object sender, MouseEventArgs e)
         {
-            byte keyCode = 0;
-            switch (e.Button)
-            {
-                case MouseButtons.Middle:
-                    keyCode = 0x04; // VK_MBUTTON
-                    break;
-                case MouseButtons.XButton1:
-                    keyCode = 0x05; // VK_XBUTTON1
-                    break;
-                case MouseButtons.XButton2:
-                    keyCode = 0x06; // VK_XBUTTON2
-                    break;
-            }
+            byte keyCode = MouseMapping.MapMouseButtonToKeyCode(e.Button);
 
             if (keyCode == 0)
                 return; // unsupported

KeyCap.csproj

@@ -70,6 +70,7 @@
   <ItemGroup>
     <Compile Include="Format\BaseIOConfig.cs" />
     <Compile Include="Format\ConfigFileManager.cs" />
+    <Compile Include="Format\MouseMapping.cs" />
     <Compile Include="Format\OutputConfig.cs" />
     <Compile Include="Format\InputConfig.cs" />
     <Compile Include="Format\RemapEntry.cs" />

KeyCapLib/KeyCapLib.vcxproj

@@ -149,23 +149,27 @@
   </ItemDefinitionGroup>
   <ItemGroup>
     <ClInclude Include="configfile.h" />
+    <ClInclude Include="inputproc.h" />
     <ClInclude Include="keyboardinput.h" />
     <ClInclude Include="keyboardproc.h" />
     <ClInclude Include="keycapture.h" />
     <ClInclude Include="keycapturestructs.h" />
     <ClInclude Include="keycaptureutil.h" />
     <ClInclude Include="mouseinput.h" />
+    <ClInclude Include="mouseproc.h" />
     <ClInclude Include="sendinputthread.h" />
     <ClInclude Include="stdafx.h" />
     <ClInclude Include="targetver.h" />
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="configfile.cpp" />
+    <ClCompile Include="inputproc.cpp" />
     <ClCompile Include="keyboardinput.cpp" />
     <ClCompile Include="keyboardproc.cpp" />
     <ClCompile Include="keycapture.cpp" />
     <ClCompile Include="keycaptureutil.cpp" />
     <ClCompile Include="mouseinput.cpp" />
+    <ClCompile Include="mouseproc.cpp" />
     <ClCompile Include="sendinputthread.cpp" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />

KeyCapLib/KeyCapLib.vcxproj.filters

@@ -8,6 +8,8 @@
     <ClCompile Include="keycaptureutil.cpp" />
     <ClCompile Include="mouseinput.cpp" />
     <ClCompile Include="sendinputthread.cpp" />
+    <ClCompile Include="inputproc.cpp" />
+    <ClCompile Include="mouseproc.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="stdafx.h" />
@@ -20,5 +22,7 @@
     <ClInclude Include="keycaptureutil.h" />
     <ClInclude Include="mouseinput.h" />
     <ClInclude Include="sendinputthread.h" />
+    <ClInclude Include="inputproc.h" />
+    <ClInclude Include="mouseproc.h" />
   </ItemGroup>
 </Project>

KeyCapLib/KeyCapture.cpp

@@ -27,6 +27,7 @@
 
 #include "keycapture.h"
 #include "keyboardproc.h"
+#include "mouseproc.h"
 #include "mouseinput.h"
 #include "configfile.h"
 
@@ -42,10 +43,10 @@ extern "C"
 void InitiallizeEntryContainerListItem(RemapEntryContainerListItem* pKeyItem, RemapEntry* pEntry);
 
 // sweet globals
-HHOOK g_hookKeyboard = NULL, g_hookMouse = NULL;
+HHOOK g_hookKeyboard = nullptr, g_hookMouse = nullptr;
 RemapEntryContainerListItem* g_KeyTranslationTable[WIN_KEY_COUNT];
-RemapEntry* g_KeyTranslationHead = NULL;
-void* g_KeyTranslationEnd = NULL; // pointer indicating the end of the input file data
+RemapEntry* g_KeyTranslationHead = nullptr;
+void* g_KeyTranslationEnd = nullptr; // pointer indicating the end of the input file data
 
 /*
 Performs the load file operation and initiates the keyboard capture process
@@ -77,7 +78,7 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 
 	// The translation table contains linked lists of all the output sets for a given key due to the flag keys (shift/alt/ctrl)
 	// Example: input 'a' will be in the same list as 'shift+a' 'alt+a' 'ctrl+a' (or any combos like 'alt+shift+a')
-	while(NULL != pEntry)
+	while(nullptr != pEntry)
 	{
 		if(0 == pEntry->outputCount)
 		{
@@ -91,25 +92,25 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 		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])
+		if(nullptr == g_KeyTranslationTable[pEntry->inputConfig.virtualKey])
 		{
 			g_KeyTranslationTable[pEntry->inputConfig.virtualKey] = (RemapEntryContainerListItem*)malloc(sizeof(RemapEntryContainerListItem));
 			InitiallizeEntryContainerListItem(g_KeyTranslationTable[pEntry->inputConfig.virtualKey], pEntry);
-			g_KeyTranslationTable[pEntry->inputConfig.virtualKey]->pNext = NULL;
+			g_KeyTranslationTable[pEntry->inputConfig.virtualKey]->pNext = nullptr;
 		}
 
 		// if the entry does exist create a new entry and append it to the existing linked list
 		else
 		{
 			RemapEntryContainerListItem* pKeyItem = g_KeyTranslationTable[pEntry->inputConfig.virtualKey];
-			while(NULL != pKeyItem->pNext)
+			while(nullptr != pKeyItem->pNext)
 			{
 				pKeyItem = pKeyItem->pNext;
 			}
 			pKeyItem->pNext = (RemapEntryContainerListItem*)malloc(sizeof(RemapEntryContainerListItem));
 			pKeyItem = pKeyItem->pNext;
 			InitiallizeEntryContainerListItem(pKeyItem, pEntry);
-			pKeyItem->pNext = NULL;
+			pKeyItem->pNext = nullptr;
 		}
 		// jump to the next entry
 		pEntry = (RemapEntry*)(&pEntry->outputCount + (sizeof(unsigned int) + (pEntry->outputCount * sizeof(OutputConfig))));
@@ -130,7 +131,7 @@ __declspec(dllexport) int LoadAndCaptureFromFile(HINSTANCE hInstance, char* sFil
 	{
 		// Note: This fails in VisualStudio if managed debugging is NOT enabled in the project(!)
 		g_hookKeyboard = SetWindowsHookEx( WH_KEYBOARD_LL, LowLevelKeyboardProc, hInstance, NULL);
-		g_hookMouse = SetWindowsHookEx(WH_MOUSE_LL, LowLevelKeyboardProc, hInstance, NULL);
+		g_hookMouse = SetWindowsHookEx(WH_MOUSE_LL, LowLevelMouseProc, hInstance, NULL);
 		if(g_hookKeyboard && g_hookMouse)
 		{
 			return HOOK_CREATION_SUCCESS;
@@ -155,14 +156,14 @@ void ShutdownInputThreads(bool forceShutdown)
 	// signal shutdown for all entries with a thread handle
 	for (int nIdx = 0; nIdx < WIN_KEY_COUNT; nIdx++)
 	{
-		if (NULL != g_KeyTranslationTable[nIdx])
+		if (nullptr != g_KeyTranslationTable[nIdx])
 		{
 			RemapEntryContainerListItem* pListItem = g_KeyTranslationTable[nIdx];
-			RemapEntryContainerListItem* pNextItem = NULL;
-			while (NULL != pListItem)
+			RemapEntryContainerListItem* pNextItem = nullptr;
+			while (nullptr != pListItem)
 			{
 				pNextItem = pListItem->pNext;
-				if (NULL != pListItem->pEntryContainer->pEntryState->threadHandle)
+				if (nullptr != pListItem->pEntryContainer->pEntryState->threadHandle)
 				{
 					pListItem->pEntryContainer->pEntryState->bShutdown = true;
 				}
@@ -177,14 +178,14 @@ void ShutdownInputThreads(bool forceShutdown)
 	// 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])
+		if (nullptr != g_KeyTranslationTable[nIdx])
 		{
 			RemapEntryContainerListItem* pListItem = g_KeyTranslationTable[nIdx];
-			RemapEntryContainerListItem* pNextItem = NULL;
-			while (NULL != pListItem)
+			RemapEntryContainerListItem* pNextItem = nullptr;
+			while (nullptr != pListItem)
 			{
 				pNextItem = pListItem->pNext;
-				if (NULL != pListItem->pEntryContainer->pEntryState->threadHandle)
+				if (nullptr != pListItem->pEntryContainer->pEntryState->threadHandle)
 				{
 					DWORD dwExitCode = WAIT_TIMEOUT;
 					for (int shutdownIteration = 0; shutdownIteration < THREAD_SHUTDOWN_MAX_ATTEMPTS && dwExitCode != WAIT_OBJECT_0; shutdownIteration++)
@@ -217,31 +218,31 @@ __declspec(dllexport) void ShutdownCapture()
 	{
 		LogDebugMessage("Unhooked keyboard");
 		UnhookWindowsHookEx(g_hookKeyboard);
-		g_hookKeyboard = NULL;
+		g_hookKeyboard = nullptr;
 	}
 	if (g_hookMouse)
 	{
 		LogDebugMessage("Unhooked mouse");
 		UnhookWindowsHookEx(g_hookMouse);
-		g_hookMouse = NULL;
+		g_hookMouse = nullptr;
 	}
 
 	// memory clean up
-	if(NULL != g_KeyTranslationHead)
+	if(nullptr != g_KeyTranslationHead)
 	{
 		LogDebugMessage("Cleared Memory!");
 		free(g_KeyTranslationHead);
-		g_KeyTranslationHead = NULL;
+		g_KeyTranslationHead = nullptr;
 	}
 
 	// clean up "hash" table
 	for(int nIdx = 0; nIdx < WIN_KEY_COUNT; nIdx++)
 	{
-		if(NULL != g_KeyTranslationTable[nIdx])
+		if(nullptr != g_KeyTranslationTable[nIdx])
 		{
 			RemapEntryContainerListItem* pListItem = g_KeyTranslationTable[nIdx];
-			RemapEntryContainerListItem* pNextItem = NULL;
-			while(NULL != pListItem)
+			RemapEntryContainerListItem* pNextItem = nullptr;
+			while(nullptr != pListItem)
 			{
 				pNextItem = pListItem->pNext;
 				free(pListItem->pEntryContainer->pEntryState);
@@ -250,11 +251,11 @@ __declspec(dllexport) void ShutdownCapture()
 				free(pListItem);
 				pListItem = pNextItem;
 			}
-			g_KeyTranslationTable[nIdx] = NULL;
+			g_KeyTranslationTable[nIdx] = nullptr;
 		}
 	}
 
-	g_KeyTranslationEnd = NULL; 
+	g_KeyTranslationEnd = nullptr; 
 
 	LogDebugMessage("Capture Shutdown");
 }

KeyCapLib/KeyCaptureUtil.cpp

@@ -42,7 +42,7 @@ void ResetRemapEntryState(RemapEntryState* pRemapEntryState, BYTE bToggled)
 	pRemapEntryState->bToggled = bToggled;
 	pRemapEntryState->bRepeating = false;
 	pRemapEntryState->bShutdown = false;
-	pRemapEntryState->threadHandle = NULL;
+	pRemapEntryState->threadHandle = nullptr;
 }
 
 bool IsButtonDownRequired(RemapEntryState* pRemapEntryState, OutputConfig* pKeyDef)

KeyCapLib/KeyboardInput.cpp

@@ -98,7 +98,9 @@ void SendInputKeys(RemapEntryState* pRemapEntryState, OutputConfig* pKeyDef)
 
 	if (pKeyDef->outputFlag.bToggle && pKeyDef->virtualKey >= MAX_VKEY)
 	{
+#if _DEBUG
 		LogDebugMessage("---- ERROR Cannot have a vkey value over 255: %d", pKeyDef->virtualKey);
+#endif
 		return;
 	}
 
@@ -121,19 +123,25 @@ void SendInputKeys(RemapEntryState* pRemapEntryState, OutputConfig* pKeyDef)
 	}
 	if (!bSendKeyDown && !bSendKeyUp)
 	{
+#if _DEBUG
 		LogDebugMessage("Nothing to send for this keyout. Misconfigured output.");
+#endif
 		return;
 	}
 
+#if _DEBUG
 	LogDebugMessage("[Sending Inputs]");
 	for (int nTemp = 0; nTemp < nIndex; nTemp++)
 	{
 		// TODO: support Shift+W toggle (the toggle ends up requiring detection of the shift key)
 		LogDebugMessage("%s: %d", GetKeyFlagsString(inputBuffer[nTemp].ki.dwFlags), inputBuffer[nTemp].ki.wVk);
 	}
+#endif
 
 	UINT inputsSent = SendInput(nIndex, inputBuffer, sizeof(INPUT));
+#if _DEBUG
 	LogDebugMessage("[Sent Inputs] (%d/%d)", inputsSent, nIndex);
+#endif
 }
 
 /*

KeyCapLib/configfile.cpp

@@ -56,7 +56,7 @@ int LoadFile(char* sFile, RemapEntry** ppKeyTranslationHead, void** ppKeyTransla
 		DWORD dwBytesRead = 0;
 		unsigned int headerBuffer[2];
 		// READ THE HEADER
-		if (ReadFile(hFile, headerBuffer, sizeof(headerBuffer), &dwBytesRead, NULL))
+		if (ReadFile(hFile, headerBuffer, sizeof(headerBuffer), &dwBytesRead, nullptr))
 		{
 			if (dwBytesRead == sizeof(headerBuffer))
 			{
@@ -80,7 +80,7 @@ int LoadFile(char* sFile, RemapEntry** ppKeyTranslationHead, void** ppKeyTransla
 
 		// read the entire file into memory
 		// NOTE: This assumes the file is less than DWORD max in size(!)
-		if (ReadFile(hFile, *ppKeyTranslationHead, dwBytesRemaining, &dwBytesRead, NULL))
+		if (ReadFile(hFile, *ppKeyTranslationHead, dwBytesRemaining, &dwBytesRead, nullptr))
 		{
 			if (dwBytesRead == dwBytesRemaining) // verify everything was read in...
 			{