Added preliminary support for long press on inputs

nhmkdev · nhmkdev · commit b554c9b51620 · 2023-01-27T20:04:03.000-08:00
diff --git a/Format/InputConfig.cs b/Format/InputConfig.cs
@@ -46,26 +46,19 @@ public enum InputFlag
             Shift = 1 << 0,
             Control = 1 << 1,
             Alt = 1 << 2,
-            // supports up to 32 entries
-        }
+            LongPress = 1 << 3,
+        // supports up to 32 entries
+    }
 
         /// <summary>
         /// Constructor for an InputConfig
         /// </summary>
         /// <param name="byFlags">The flags defining the input</param>
         /// <param name="byVirtualKey">The value of the input</param>
         /// <param name="eKeyArgs">The input key arguments from user input</param>
-        public InputConfig(byte byVirtualKey, KeyEventArgs eKeyArgs)
+        public InputConfig(byte byVirtualKey)
         {
             VirtualKey = byVirtualKey;
-
-            if (null != eKeyArgs)
-            {
-                Flags |= (int)(
-                    (eKeyArgs.Shift ? (int)InputFlag.Shift : (byte)0) |
-                    (eKeyArgs.Alt ? (int)InputFlag.Alt : (byte)0) |
-                    (eKeyArgs.Control ? (int)InputFlag.Control : (byte)0));
-            }
         }
 
         public InputConfig(Stream zStream) : base(zStream) { }
@@ -77,6 +70,7 @@ public override string GetDescription()
                    (IsFlaggedAs(InputFlag.Shift) ? "+Shift" : string.Empty) +
                    (IsFlaggedAs(InputFlag.Alt) ? "+Alt" : string.Empty) +
                    (IsFlaggedAs(InputFlag.Control) ? "+Control" : string.Empty) +
+                   (IsFlaggedAs(InputFlag.LongPress) ? "+LongPress" : string.Empty) +
                    "]";
         }
     }
diff --git a/Forms/KeyCaptureConfig.cs b/Forms/KeyCaptureConfig.cs
@@ -47,6 +47,7 @@ public partial class KeyCaptureConfig
         private readonly List<string> m_listRecentFiles = new List<string>();
         private readonly KeyCapInstanceState m_zInstanceState;
         private readonly IniManager m_zIniManager = new IniManager(Application.ProductName, false, true, false);
+        private HashSet<Control> m_setInputControls = new HashSet<Control>();
         private HashSet<Control> m_setOutputControls = new HashSet<Control>();
 
         private FormWindowState m_ePrevWindowState = FormWindowState.Normal;
@@ -103,7 +104,7 @@ private void KeyCaptureConfig_Load(object sender, EventArgs e)
                 }
             }
 
-            InitOutputControlsSet();
+            InitControlSets();
             ConfigureToolTips();
 
             // load the command line specified file
@@ -120,8 +121,15 @@ private void KeyCaptureConfig_Load(object sender, EventArgs e)
             }
         }
 
-        private void InitOutputControlsSet()
+        private void InitControlSets()
         {
+            m_setInputControls = new HashSet<Control>(new Control[]
+            {
+                checkInputAlt,
+                checkInputControl,
+                checkInputShift,
+                checkInputLongPress
+            });
             m_setOutputControls = new HashSet<Control>(new Control[]
             {
                 checkOutputAlt,
@@ -254,7 +262,7 @@ private void txtKeyIn_KeyDown(object sender, KeyEventArgs e)
 #if LOG_KEYS
             Console.Out.WriteLine("Key Input: {0} 0x{1}".FormatString(e.KeyCode, e.KeyCode.ToString("x")));
 #endif
-            UpdateTextBox((TextBox)sender, e, new InputConfig((byte)e.KeyCode, e));
+            UpdateTextBox((TextBox)sender, e, new InputConfig((byte)e.KeyCode));
         }
 
         private void txtKeyOut_KeyDown(object sender, KeyEventArgs e)
@@ -482,6 +490,15 @@ private void btnStart_Click(object sender, EventArgs e)
 
         #region Input / Output Settings Control Events
 
+        private void checkInputLongPress_CheckedChanged(object sender, EventArgs e)
+        {
+            ToggleControlsEnabled(m_setInputControls, !checkInputLongPress.Checked, (Control)sender);
+            if (checkInputLongPress.Checked)
+            {
+                ToggleCheckboxesChecked(false, checkInputAlt, checkInputControl, checkInputShift);
+            }
+        }
+
         private void comboBoxMouseOut_SelectedIndexChanged(object sender, EventArgs e)
         {
             SetOutKeyConfig(comboBoxOutMouse.SelectedIndex == 0 ? null : new OutputConfig(
@@ -628,11 +645,13 @@ private InputConfig UpdateInputFlags(InputConfig zInputConfig)
             var bAlt = checkInputAlt.Checked;
             var bControl = checkInputControl.Checked;
             var bShift = checkInputShift.Checked;
+            var bLongPress = checkInputLongPress.Checked;
 
             var nFlags = 0;
             nFlags = BitUtil.UpdateFlag(nFlags, bAlt, InputConfig.InputFlag.Alt);
             nFlags = BitUtil.UpdateFlag(nFlags, bControl, InputConfig.InputFlag.Control);
             nFlags = BitUtil.UpdateFlag(nFlags, bShift, InputConfig.InputFlag.Shift);
+            nFlags = BitUtil.UpdateFlag(nFlags, bLongPress, InputConfig.InputFlag.LongPress);
             zInputConfig.Flags = nFlags;
             return zInputConfig;
         }
diff --git a/Forms/KeyCaptureConfig.designer.cs b/Forms/KeyCaptureConfig.designer.cs
diff --git a/KeyCapLib/KeyCaptureUtil.cpp b/KeyCapLib/KeyCaptureUtil.cpp
@@ -66,12 +66,22 @@ char* GetBoolString(BYTE nValue)
 char* GetInputConfigDescription(InputConfig inputConfig)
 {
 	char* pDescription = (char*)malloc(DESCRIPTION_BUFFER_SIZE);
-	sprintf_s(pDescription, DESCRIPTION_BUFFER_SIZE, "InputConfig [Key: %d 0x%02x][Alt: %s][Ctrl: %s][Shift: %s]",
-		inputConfig.virtualKey,
-		inputConfig.virtualKey,
-		GetBoolString(inputConfig.inputFlag.bAlt),
-		GetBoolString(inputConfig.inputFlag.bControl),
-		GetBoolString(inputConfig.inputFlag.bShift));
+	if(inputConfig.inputFlag.bLongPress)
+	{
+		sprintf_s(pDescription, DESCRIPTION_BUFFER_SIZE, "InputConfig [Key: %d 0x%02x][LongPress: %s]",
+			inputConfig.virtualKey,
+			inputConfig.virtualKey,
+			GetBoolString(inputConfig.inputFlag.bLongPress));
+	}
+	else
+	{
+		sprintf_s(pDescription, DESCRIPTION_BUFFER_SIZE, "InputConfig [Key: %d 0x%02x][Alt: %s][Ctrl: %s][Shift: %s]",
+			inputConfig.virtualKey,
+			inputConfig.virtualKey,
+			GetBoolString(inputConfig.inputFlag.bAlt),
+			GetBoolString(inputConfig.inputFlag.bControl),
+			GetBoolString(inputConfig.inputFlag.bShift));
+	}
 	return pDescription;
 }
 
diff --git a/KeyCapLib/keyboardproc.cpp b/KeyCapLib/keyboardproc.cpp
@@ -24,6 +24,8 @@
 
 extern RemapEntryContainerListItem* g_KeyTranslationTable[WIN_KEY_COUNT];
 
+ULONGLONG g_KeyDownTime[WIN_KEY_COUNT];
+
 /*
 Implementation of the win32 LowLevelKeyboardProc (see docs for information)
 
@@ -33,7 +35,7 @@ created to send out the key(s) to send to the os.
 */
 LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam)
 {
-	KBDLLHOOKSTRUCT  *pHook = reinterpret_cast<KBDLLHOOKSTRUCT*>(lParam);
+	KBDLLHOOKSTRUCT *pHook = reinterpret_cast<KBDLLHOOKSTRUCT*>(lParam);
 	bool bSentInput = false;
 
 	bool bAlt = 0 != (GetAsyncKeyState(VK_MENU) & 0x8000);
@@ -51,13 +53,16 @@ LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam)
 		case WM_SYSKEYDOWN:
 			// detect a keydown that matches a remaped key (and start the input thread to respond accordingly then indicate to the OS that the key has been handled)
 			{
-				RemapEntryContainerListItem* pKeyListItem = g_KeyTranslationTable[pHook->vkCode];
+				// NOTE: key down events will come in while a key is being held
+
+				const RemapEntryContainerListItem* pKeyListItem = g_KeyTranslationTable[pHook->vkCode];
 				while (NULL != pKeyListItem)
 				{
-					InputConfig* pKeyDef = &pKeyListItem->pEntryContainer->pEntry->inputConfig;
+					const InputConfig* pKeyDef = &pKeyListItem->pEntryContainer->pEntry->inputConfig;
 					if ((bAlt == pKeyDef->inputFlag.bAlt) &&
 						(bControl == pKeyDef->inputFlag.bControl) &&
-						(bShift == pKeyDef->inputFlag.bShift))
+						(bShift == pKeyDef->inputFlag.bShift)
+						&& !pKeyDef->inputFlag.bLongPress)
 					{
 #ifdef _DEBUG
 						char* pInputConfigDescription = GetInputConfigDescription(*pKeyDef);
@@ -69,7 +74,24 @@ LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam)
 						{
 							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
+						// block further processing with the inputs
+						bSentInput = true;
+						break;
+					}
+					if(!bAlt
+						&& !bControl
+						&& !bShift
+						&& pKeyDef->inputFlag.bLongPress)
+					{
+						if (g_KeyDownTime[pKeyDef->virtualKey] == 0) // ignore all keydown events on this key after recording the initial key down time
+						{
+							const ULONGLONG tickCount = GetTickCount64();
+							g_KeyDownTime[pKeyDef->virtualKey] = tickCount;
+#ifdef _DEBUG
+							LogDebugMessage("Detected LONGPRESS Key Down: %d Tick: %d", pKeyDef->virtualKey, tickCount);
+#endif
+						}
+						// block further processing with the inputs
 						bSentInput = true;
 						break;
 					}
@@ -85,10 +107,42 @@ LRESULT CALLBACK LowLevelKeyboardProc(int nCode, WPARAM wParam, LPARAM lParam)
 				while (NULL != pKeyListItem)
 				{
 					InputConfig* pKeyDef = &pKeyListItem->pEntryContainer->pEntry->inputConfig;
-					if ((bAlt == pKeyDef->inputFlag.bAlt) &&
-						(bControl == pKeyDef->inputFlag.bControl) &&
-						(bShift == pKeyDef->inputFlag.bShift))
+					if (bAlt == pKeyDef->inputFlag.bAlt
+						&& bControl == pKeyDef->inputFlag.bControl 
+						&& bShift == pKeyDef->inputFlag.bShift
+						&& !pKeyDef->inputFlag.bLongPress)
+					{
+						// block further processing with the inputs
+						bSentInput = true;
+						break;
+					}
+					if (!bAlt 
+						&& !bControl 
+						&& !bShift
+						&& pKeyDef->inputFlag.bLongPress)
 					{
+						ULONGLONG tickCount = GetTickCount64();
+						if (tickCount - g_KeyDownTime[pKeyDef->virtualKey] > 1000)
+						{
+#ifdef _DEBUG
+							char* pInputConfigDescription = GetInputConfigDescription(*pKeyDef);
+							LogDebugMessage("Detected LONGPRESS Key Up: %s Outputs: %d", pInputConfigDescription, pKeyListItem->pEntryContainer->pEntry->outputCount);
+							free(pInputConfigDescription);
+#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);
+							}
+						}
+						else
+						{
+							LogDebugMessage("Detected LONGPRESS Key UP (too short): %d Tick: %d (Old Tick: %d)", pKeyDef->virtualKey, tickCount, g_KeyDownTime[pKeyDef->virtualKey]);
+							// when a longpress "fails" just send the normal keypress
+							CreateThread(NULL, 0, SendInputKeypress, pKeyDef, 0, NULL);
+						}
+						g_KeyDownTime[pKeyDef->virtualKey] = 0;
+						// block further processing with the inputs
 						bSentInput = true;
 						break;
 					}
diff --git a/KeyCapLib/keycapturestructs.h b/KeyCapLib/keycapturestructs.h
@@ -34,11 +34,13 @@ struct InputFlag
 	const int KEYCAP_SHIFT = 1 << 0;
 	const int KEYCAP_CONTROL = 1 << 1;
 	const int KEYCAP_ALT = 1 << 2;
+	const int KEYCAP_LONGPRESS = 1 << 3;
 #endif
 	BYTE bShift : 1;
 	BYTE bControl : 1;
 	BYTE bAlt : 1;
-	BYTE padOne : 5;
+	BYTE bLongPress : 1;
+	BYTE padOne : 4;
 	BYTE padTwo : 8;
 	BYTE padThree : 8;
 	BYTE padFour : 8;
diff --git a/KeyCapLib/sendinputthread.cpp b/KeyCapLib/sendinputthread.cpp
@@ -180,4 +180,20 @@ DWORD InitiateSendInput(RemapEntry* pRemapEntry, RemapEntryState* pRemapEntrySta
 	free(pInputConfigDescription);
 #endif
 	return 0;
+}
+
+/*
+ * Thread entry point for simple keypress (used for longpress configured keys to send the normal input key on key up)
+ */
+DWORD WINAPI SendInputKeypress(LPVOID lpParam)
+{
+	InputConfig* inputConfig = static_cast<InputConfig*>(lpParam);
+	int nIndex = 0;
+	INPUT inputBuffer[MAX_KEY_INPUT_PER_STROKE];
+	memset(&inputBuffer, 0, sizeof(INPUT) * MAX_KEY_INPUT_PER_STROKE);
+	AppendSingleKey(inputConfig->virtualKey, &inputBuffer[nIndex++], 0);
+	AppendSingleKey(inputConfig->virtualKey, &inputBuffer[nIndex++], KEYEVENTF_KEYUP);
+	LogDebugMessage("[Sending Input Keypress][virtualKey: %d]", inputConfig->virtualKey);
+	SendInput(nIndex, inputBuffer, sizeof(INPUT));
+	return 0;
 }
diff --git a/KeyCapLib/sendinputthread.h b/KeyCapLib/sendinputthread.h
@@ -28,5 +28,6 @@
 #include "stdafx.h"
 
 DWORD WINAPI SendInputThread(LPVOID lpParam);
+DWORD WINAPI SendInputKeypress(LPVOID lpParam);
 
 #endif
diff --git a/Properties/AssemblyInfo.cs b/Properties/AssemblyInfo.cs
@@ -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.4")]
-[assembly: AssemblyFileVersion("2.0.0.4")]
+[assembly: AssemblyVersion("2.0.0.5")]
+[assembly: AssemblyFileVersion("2.0.0.5")]
diff --git a/bin/Release/History.txt b/bin/Release/History.txt
@@ -1,5 +1,8 @@
 KeyCap Version History
 --------------------------
+2.0.0.5
+- Added long press as an input option (at this time it requires being held for about 1 second)
+
 2.0.0.4
 - Refactors and improvements with the output controls (blocking unsupported configurations)
 - Updated all delays/repeats to operate on increments of 100ms
diff --git a/bin/Release/KeyCap.odt b/bin/Release/KeyCap.odt
