feat: adding setting to menu to skip tts messages

Author: ProgrammingByPermutation

src/TwitchStreamingTools/Configuration.cs

@@ -9,6 +9,7 @@
 
 using Nullinside.Api.Common.Twitch;
 
+using TwitchStreamingTools.Controls.ViewModels;
 using TwitchStreamingTools.Models;
 using TwitchStreamingTools.Utilities;
 
@@ -85,6 +86,9 @@ public static Configuration Instance {
   /// <inheritdoc />
   public bool SayUsernameWithMessage { get; set; }
 
+  /// <inheritdoc />
+  public Keybind? SkipTtsKey { get; set; } = new() { Key = Keys.End };
+
   /// <summary>
   ///   Writes the configuration file to disk.
   /// </summary>

src/TwitchStreamingTools/Controls/Keybind.axaml

@@ -0,0 +1,12 @@
+<UserControl xmlns="https://github.com/avaloniaui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+             xmlns:viewModels="clr-namespace:TwitchStreamingTools.Controls.ViewModels"
+             mc:Ignorable="d" d:DesignWidth="800" d:DesignHeight="450"
+             x:Class="TwitchStreamingTools.Controls.Keybind"
+             x:DataType="viewModels:KeybindViewModel">
+    <StackPanel>
+        <Button Content="{Binding Keybind}" Command="{Binding ListenForKeystroke}" />
+    </StackPanel>
+</UserControl>

src/TwitchStreamingTools/Controls/Keybind.axaml.cs

@@ -0,0 +1,15 @@
+using Avalonia.Controls;
+
+namespace TwitchStreamingTools.Controls;
+
+/// <summary>
+///   Represents a keybind.
+/// </summary>
+public partial class Keybind : UserControl {
+  /// <summary>
+  ///   Initializes a new instance of the <see cref="Keybind" /> class.
+  /// </summary>
+  public Keybind() {
+    InitializeComponent();
+  }
+}

src/TwitchStreamingTools/Controls/ViewModels/Keybind.cs

@@ -0,0 +1,55 @@
+using System.Text;
+
+using TwitchStreamingTools.Models;
+
+namespace TwitchStreamingTools.Controls.ViewModels;
+
+/// <summary>
+///   A keybind.
+/// </summary>
+public class Keybind {
+  /// <summary>
+  ///   The key pressed.
+  /// </summary>
+  public Keys Key { get; set; }
+
+  /// <summary>
+  ///   Indicates whether the Control (Ctrl) key is pressed as part of the keybind.
+  /// </summary>
+  public bool IsCtrl { get; set; }
+
+  /// <summary>
+  ///   Indicates whether the Shift key is pressed as part of the keybind.
+  /// </summary>
+  public bool IsShift { get; set; }
+
+  /// <summary>
+  ///   Indicates whether the Alt key is pressed as part of the keybind.
+  /// </summary>
+  public bool IsAlt { get; set; }
+
+  /// <summary>
+  ///   Returns a string representation of the keybind, including any modifier keys (Ctrl, Shift, Alt) and the key itself.
+  /// </summary>
+  /// <returns>
+  ///   A string representing the current keybind in the format of "Ctrl + Shift + Alt + Key",
+  ///   including only the applicable modifiers.
+  /// </returns>
+  public override string ToString() {
+    var sb = new StringBuilder();
+    if (IsCtrl) {
+      sb.Append("Ctrl + ");
+    }
+
+    if (IsShift) {
+      sb.Append("Shift + ");
+    }
+
+    if (IsAlt) {
+      sb.Append("Alt + ");
+    }
+
+    sb.Append(Key);
+    return sb.ToString();
+  }
+}

src/TwitchStreamingTools/Controls/ViewModels/KeybindViewModel.cs

@@ -0,0 +1,66 @@
+using System.Reactive;
+
+using ReactiveUI;
+
+using TwitchStreamingTools.Services;
+using TwitchStreamingTools.ViewModels;
+
+namespace TwitchStreamingTools.Controls.ViewModels;
+
+/// <summary>
+///   Handles storing information required to visualize a keybind.
+/// </summary>
+public class KeybindViewModel : ViewModelBase {
+  /// <summary>
+  ///   The listener for keystrokes on the keyboard.
+  /// </summary>
+  private readonly IGlobalKeyPressService _service;
+
+  /// <summary>
+  ///   The keybind, if set.
+  /// </summary>
+  private Keybind? _keybind;
+
+  /// <summary>
+  ///   Initializes a new instance of the <see cref="KeybindViewModel" /> class.
+  /// </summary>
+  /// <param name="service">The listener for keystrokes on the keyboard.</param>
+  public KeybindViewModel(IGlobalKeyPressService service) {
+    _service = service;
+    ListenForKeystroke = ReactiveCommand.Create(StartListenKeystroke);
+  }
+
+  /// <summary>
+  ///   The keybind.
+  /// </summary>
+  public Keybind? Keybind {
+    get => _keybind;
+    set => this.RaiseAndSetIfChanged(ref _keybind, value);
+  }
+
+  /// <summary>
+  ///   Listens for keystrokes.
+  /// </summary>
+  public ReactiveCommand<Unit, Unit> ListenForKeystroke { get; }
+
+  /// <summary>
+  ///   Starts listening for keystrokes.
+  /// </summary>
+  private void StartListenKeystroke() {
+    _service.OnKeystroke -= OnKeystroke;
+    _service.OnKeystroke += OnKeystroke;
+  }
+
+  /// <summary>
+  ///   Called whenever a keystroke is pressed.
+  /// </summary>
+  /// <param name="keybind">The key that was press.</param>
+  private void OnKeystroke(Keybind keybind) {
+    if (_service.IsModifier(keybind.Key)) {
+      return;
+    }
+
+    Keybind = keybind;
+    _service.OnKeystroke -= OnKeystroke;
+  }
+}

src/TwitchStreamingTools/IConfiguration.cs

@@ -2,6 +2,7 @@
 
 using Nullinside.Api.Common.Twitch;
 
+using TwitchStreamingTools.Controls.ViewModels;
 using TwitchStreamingTools.Models;
 
 namespace TwitchStreamingTools;
@@ -50,6 +51,11 @@ public interface IConfiguration {
   /// </summary>
   bool SayUsernameWithMessage { get; set; }
 
+  /// <summary>
+  ///   The key press to skip the TTS.
+  /// </summary>
+  Keybind? SkipTtsKey { get; set; }
+
   /// <summary>
   ///   Writes the configuration file to disk.
   /// </summary>

src/TwitchStreamingTools/ServiceCollectionExtensions.cs

@@ -4,6 +4,7 @@
 
 using Nullinside.Api.Common.Twitch;
 
+using TwitchStreamingTools.Controls.ViewModels;
 using TwitchStreamingTools.Services;
 using TwitchStreamingTools.Utilities;
 using TwitchStreamingTools.ViewModels;
@@ -25,7 +26,7 @@ public static void AddCommonServices(this IServiceCollection collection) {
     collection.AddSingleton<IConfiguration, Configuration>(_ => Configuration.Instance);
     collection.AddSingleton<ITwitchClientProxy, TwitchClientProxy>(_ => TwitchClientProxy.Instance);
     collection.AddSingleton<ITwitchChatLog, TwitchChatLog>();
-    collection.AddSingleton<GlobalKeyPressService>();
+    collection.AddSingleton<IGlobalKeyPressService, GlobalKeyPressService>();
 
     // Services
     collection.AddSingleton<ITwitchAccountService, TwitchAccountService>();
@@ -39,6 +40,7 @@ public static void AddCommonServices(this IServiceCollection collection) {
     collection.AddTransient<SettingsViewModel>();
     collection.AddTransient<TtsPhoneticWordsViewModel>();
     collection.AddTransient<TtsSkipUsernamesViewModel>();
+    collection.AddTransient<KeybindViewModel>();
   }
 
   /// <summary>
@@ -48,6 +50,6 @@ public static void AddCommonServices(this IServiceCollection collection) {
   public static void StartupServices(this IServiceProvider provider) {
     provider.GetRequiredService<ITwitchAccountService>();
     provider.GetRequiredService<ITwitchTtsService>();
-    provider.GetRequiredService<GlobalKeyPressService>();
+    provider.GetRequiredService<IGlobalKeyPressService>();
   }
 }

src/TwitchStreamingTools/Services/GlobalKeyPressService.cs

@@ -1,21 +1,21 @@
 using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
-using System.Text;
 using System.Threading;
 
 using log4net;
 
 using PInvoke;
 
+using TwitchStreamingTools.Controls.ViewModels;
 using TwitchStreamingTools.Models;
 
 namespace TwitchStreamingTools.Services;
 
 /// <summary>
 ///   Detects when keys are pressed anywhere on the OS.
 /// </summary>
-public class GlobalKeyPressService {
+public class GlobalKeyPressService : IGlobalKeyPressService {
   /// <summary>
   ///   The logger.
   /// </summary>
@@ -53,6 +53,11 @@ public class GlobalKeyPressService {
   /// </summary>
   private readonly Thread _thread;
 
+  /// <summary>
+  ///   The keystroke callback.
+  /// </summary>
+  private Action<Keybind>? s_onKeystroke;
+
   /// <summary>
   ///   Initializes a new instance of the <see cref="GlobalKeyPressService" /> class.
   /// </summary>
@@ -67,7 +72,15 @@ public GlobalKeyPressService() {
   /// <summary>
   ///   Gets or sets the callbacks to invoke when a keystroke is pressed.
   /// </summary>
-  public static Action<Keys, bool, bool, bool>? OnKeystroke { get; set; }
+  public Action<Keybind>? OnKeystroke {
+    get => s_onKeystroke;
+    set => s_onKeystroke = value;
+  }
+
+  /// <inheritdoc />
+  public bool IsModifier(Keys key) {
+    return modifiers.Contains(key);
+  }
 
   /// <summary>
   ///   The main loop which registers for keystrokes on the system and flushes the message buffer.
@@ -90,7 +103,7 @@ private void Main() {
   /// <param name="wParam">The <seealso cref="KeyboardMessage" />.</param>
   /// <param name="lParam">The <seealso cref="KeyboardLowLevelHookStruct" />.</param>
   /// <returns>The next hook that should be called.</returns>
-  private static int KeystrokeCallback(int nCode, IntPtr wParam, IntPtr lParam) {
+  private int KeystrokeCallback(int nCode, IntPtr wParam, IntPtr lParam) {
     var keyboardEvent = Marshal.PtrToStructure<KeyboardLowLevelHookStruct>(lParam);
     var whatHappened = (KeyboardMessage)wParam;
     var key = (Keys)keyboardEvent.vkCode;
@@ -104,8 +117,14 @@ private static int KeystrokeCallback(int nCode, IntPtr wParam, IntPtr lParam) {
       bool holdingAlt = (keyboardEvent.flags & 0b_0001_0000) != 0;
       bool holdingCtrl = holding[Keys.Control] || holding[Keys.ControlKey] || holding[Keys.LControlKey] || holding[Keys.RControlKey];
       bool holdingShift = holding[Keys.Shift] || holding[Keys.ShiftKey] || holding[Keys.LShiftKey] || holding[Keys.RShiftKey];
-      LogKey(key, holdingCtrl, holdingAlt, holdingShift);
-      OnKeystroke?.Invoke(key, holdingCtrl, holdingAlt, holdingShift);
+      var keybind = new Keybind {
+        IsCtrl = holdingCtrl,
+        IsShift = holdingShift,
+        IsAlt = holdingAlt,
+        Key = key
+      };
+      LogKey(keybind);
+      s_onKeystroke?.Invoke(keybind);
     }
     else if (whatHappened == KeyboardMessage.KEY_UP) {
       if (modifiers.Contains(key)) {
@@ -119,26 +138,8 @@ private static int KeystrokeCallback(int nCode, IntPtr wParam, IntPtr lParam) {
   /// <summary>
   ///   Logs the keystroke for debugging.
   /// </summary>
-  /// <param name="key">The key pressed.</param>
-  /// <param name="holdingCtrl">True if control is held down.</param>
-  /// <param name="holdingAlt">True if alt is held down.</param>
-  /// <param name="holdingShift">True if shift is held down.</param>
-  private static void LogKey(Keys key, bool holdingCtrl, bool holdingAlt, bool holdingShift) {
-    var sb = new StringBuilder("Key Pressed: ");
-    if (holdingCtrl) {
-      sb.Append("Ctrl + ");
-    }
-
-    if (holdingShift) {
-      sb.Append("Shift + ");
-    }
-
-    if (holdingAlt) {
-      sb.Append("Alt + ");
-    }
-
-    sb.Append(key);
-
-    LOGGER.Debug(sb.ToString());
+  /// <param name="keybind">The key pressed.</param>
+  private void LogKey(Keybind keybind) {
+    LOGGER.Debug($"Key pressed: {keybind}");
   }
 }

src/TwitchStreamingTools/Services/IGlobalKeyPressService.cs

@@ -0,0 +1,23 @@
+using System;
+
+using TwitchStreamingTools.Controls.ViewModels;
+using TwitchStreamingTools.Models;
+
+namespace TwitchStreamingTools.Services;
+
+/// <summary>
+///   The contract for a service that detects when keys are pressed anywhere on the OS.
+/// </summary>
+public interface IGlobalKeyPressService {
+  /// <summary>
+  ///   Gets or sets the callbacks to invoke when a keystroke is pressed.
+  /// </summary>
+  Action<Keybind>? OnKeystroke { get; set; }
+
+  /// <summary>
+  ///   True if the key press is a modifier key and not a real keystroke.
+  /// </summary>
+  /// <param name="key">The key.</param>
+  /// <returns>True if modifier, false otherwise.</returns>
+  bool IsModifier(Keys key);
+}