measure_from config setting, for #34

Author: mcmonkey4eva

KeyboardChatterBlocker/KeyBlocker.cs

@@ -42,6 +42,19 @@ public class KeyBlocker
         /// </summary>
         public Dictionary<string, string> Hotkeys = new Dictionary<string, string>();
 
+        /// <summary>
+        /// Enum to represent when to measure the time delay from.
+        /// </summary>
+        public enum MeasureFrom
+        {
+            Press, Release
+        }
+
+        /// <summary>
+        /// When to measure the time delay from.
+        /// </summary>
+        public MeasureFrom MeasureMode = MeasureFrom.Press;
+
         /// <summary>
         /// Load the <see cref="KeyBlocker"/> from config file settings.
         /// </summary>
@@ -149,6 +162,9 @@ public void ApplyConfigSetting(string setting)
                     Hotkeys["disable"] = settingValue;
                     HotKeys.Register(settingValue, () => Program.MainForm.SetEnabled(false));
                     break;
+                case "measure_from":
+                    MeasureMode = (MeasureFrom)Enum.Parse(typeof(MeasureFrom), settingValue, true);
+                    break;
             }
         }
 
@@ -175,6 +191,7 @@ public string GetConfigurationString()
             result.Append("is_enabled: ").Append(IsEnabled ? "true" : "false").Append("\n");
             result.Append("global_chatter: ").Append(GlobalChatterTimeLimit).Append("\n");
             result.Append("hide_in_system_tray: ").Append(Program.HideInSystemTray ? "true" : "false").Append("\n");
+            result.Append($"measure_from: {MeasureMode}\n");
             result.Append("\n");
             foreach (KeyValuePair<Keys, uint?> chatterTimes in KeysToChatterTime.MainDictionary)
             {
@@ -222,6 +239,11 @@ public string GetConfigurationString()
         /// </summary>
         public AcceleratedKeyMap<ulong> KeysToLastPressTime = new AcceleratedKeyMap<ulong>();
 
+        /// <summary>
+        /// A mapping of keys to the last release time.
+        /// </summary>
+        public AcceleratedKeyMap<ulong> KeysToLastReleaseTime = new AcceleratedKeyMap<ulong>();
+
         /// <summary>
         /// The global chatter time limit, in milliseconds.
         /// </summary>
@@ -287,7 +309,7 @@ public bool AllowKeyDown(Keys key, bool defaultZero)
             KeyIsDown[key] = true;
             StatsKeyCount[key]++;
             ulong timeNow = GetTickCount64();
-            ulong timeLast = KeysToLastPressTime[key];
+            ulong timeLast = MeasureMode == MeasureFrom.Release ? KeysToLastReleaseTime[key] : KeysToLastPressTime[key];
             if (timeLast > timeNow) // In the future = number handling mixup, just allow it.
             {
                 KeysToLastPressTime[key] = timeNow;
@@ -319,13 +341,16 @@ public bool AllowKeyDown(Keys key, bool defaultZero)
         /// <returns>True to allow the key-up, false to deny it.</returns>
         public bool AllowKeyUp(Keys key)
         {
+            ulong timeNow = GetTickCount64();
             if (!IsEnabled || IsAutoDisabled) // Not enabled = allow everything through.
             {
+                KeysToLastReleaseTime[key] = timeNow;
                 return true;
             }
             KeyIsDown[key] = false;
             if (!KeysWereDownBlocked[key]) // Down wasn't blocked = allow it.
             {
+                KeysToLastReleaseTime[key] = timeNow;
                 return true;
             }
             KeysWereDownBlocked[key] = false;

README.md

@@ -72,7 +72,8 @@ I've taken a similar approach to the software solutions mentioned above, but wit
 - `keys.<KEY>`: (for example, `keys.H`) set to the time (in ms) for that specific key's keyboard chatter threshold.
 - `auto_disable_programs`: Set to a list of executable names (case insensitive, without the `.exe`) separated by slashes (like `some_video_game/other_game`) that will cause the chatter block to automatically disable whenever that program is open.
 - `auto_disable_on_fullscreen`: set to `true` to auto-disable the chatter block when any application is open in fullscreen - see also [#26](https://github.com/mcmonkeyprojects/KeyboardChatterBlocker/issues/26).
-- `hotkey_<type>`: (where type is `toggle`, `enable`, `disable`) set to a key combo. Must be a combination of any of `control`, `alt`, `win`, `shift`, and any valid key separated by `+`. For example `control + a`, `win + alt + b`, `shift + d1`. Note that using `control` often won't work as it gets reserved by other applications (or Windows itself) often. This line will register a global hotkey that performs the applicable action (eg `hotkey_disable: win + shift + pause` will allow you to hold those three keys together at any time to immediately disable the chatter blocker).
+- `hotkey_<type>`: (where type is `toggle`, `enable`, `disable`) set to a key combo. Must be a combination of any of `control`, `alt`, `win`, `shift`, and any valid key separated by `+`. For example `control + a`, `win + alt + b`, `shift + d1`. Note that hotkeys including `control` often won't work as they often get reserved by other applications (or Windows itself). This line will register a global hotkey that performs the applicable action (eg `hotkey_disable: win + shift + pause` will allow you to hold those three keys together at any time to immediately disable the chatter blocker).
+- `measure_from` set to `Press` or `Release` (defaults to `Press`) to choose when to measure chatter delay from - the last key press, or last key release.
 
 ### Other Features