Merge pull request #119 from nullinside-development-group/feat/skip

Feat/skip

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/Models/KeyboardLowLevelHookStruct.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Runtime.InteropServices;
+
+namespace TwitchStreamingTools.Models;
+
+/// <summary>
+///   The structure representing the key pressed.
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal struct KeyboardLowLevelHookStruct {
+  /// <summary>
+  ///   The keystroke.
+  /// </summary>
+  public int vkCode;
+
+  /// <summary>
+  ///   The scan code.
+  /// </summary>
+  public int scanCode;
+
+  /// <summary>
+  ///   The flags.
+  /// </summary>
+  public int flags;
+
+  /// <summary>
+  ///   The time the key was pressed.
+  /// </summary>
+  public int time;
+
+  /// <summary>
+  ///   The extra info.
+  /// </summary>
+  public IntPtr dwExtraInfo;
+}

src/TwitchStreamingTools/Models/KeyboardMessage.cs

@@ -0,0 +1,26 @@
+namespace TwitchStreamingTools.Models;
+
+/// <summary>
+///   Information on what kind of event it is.
+/// </summary>
+public enum KeyboardMessage {
+  /// <summary>
+  ///   The key was pressed down.
+  /// </summary>
+  KEY_DOWN = 0x100,
+
+  /// <summary>
+  ///   The key was released after being pressed down.
+  /// </summary>
+  KEY_UP = 0x101,
+
+  /// <summary>
+  ///   No idea.
+  /// </summary>
+  SYS_KEY_DOWN = 0x104,
+
+  /// <summary>
+  ///   Don't ask me.
+  /// </summary>
+  SYS_KEY_UP = 0x105
+}