Merge branch 'development' into feature/update-avalonia

src/Artemis.Core/Exceptions/ArtemisPluginException.cs

@@ -10,7 +10,7 @@ public class ArtemisPluginException : Exception
     /// <summary>
     ///     Creates a new instance of the <see cref="ArtemisPluginException" /> class
     /// </summary>
-    public ArtemisPluginException(Plugin plugin)
+    internal ArtemisPluginException(Plugin plugin)
     {
         Plugin = plugin;
     }
@@ -18,7 +18,7 @@ public class ArtemisPluginException : Exception
     /// <summary>
     ///     Creates a new instance of the <see cref="ArtemisPluginException" /> class
     /// </summary>
-    public ArtemisPluginException(Plugin plugin, string message) : base(message)
+    internal ArtemisPluginException(Plugin plugin, string message) : base(message)
     {
         Plugin = plugin;
     }
@@ -26,7 +26,7 @@ public class ArtemisPluginException : Exception
     /// <summary>
     ///     Creates a new instance of the <see cref="ArtemisPluginException" /> class
     /// </summary>
-    public ArtemisPluginException(Plugin plugin, string message, Exception inner) : base(message, inner)
+    internal ArtemisPluginException(Plugin plugin, string message, Exception inner) : base(message, inner)
     {
         Plugin = plugin;
     }
@@ -44,9 +44,31 @@ public class ArtemisPluginException : Exception
     public ArtemisPluginException(string message, Exception inner) : base(message, inner)
     {
     }
+    
+    /// <summary>
+    ///     Creates a new instance of the <see cref="ArtemisPluginException" /> class
+    /// </summary>
+    public ArtemisPluginException(string message, string helpDocument) : base(message)
+    {
+        HelpDocument = helpDocument;
+    }
+
+    /// <summary>
+    ///     Creates a new instance of the <see cref="ArtemisPluginException" /> class
+    /// </summary>
+    public ArtemisPluginException(string message, Exception inner, string helpDocument) : base(message, inner)
+    {
+        HelpDocument = helpDocument;
+    }
 
     /// <summary>
     ///     Gets the plugin the error is related to
     /// </summary>
     public Plugin? Plugin { get; }
+    
+    /// <summary>
+    ///     Gets or sets the help document related to this exception.
+    /// </summary>
+    public string? HelpDocument { get; }
+
 }

src/Artemis.Core/Services/Interfaces/IPluginManagementService.cs

@@ -127,6 +127,13 @@ public interface IPluginManagementService : IArtemisService, IDisposable
     /// <returns>If the current call stack contains a plugin, the plugin. Otherwise null</returns>
     Plugin? GetCallingPlugin();
 
+    /// <summary>
+    ///     Returns the plugin that threw the provided exception.
+    /// </summary>
+    /// <param name="exception"></param>
+    /// <returns>If the exception was thrown by a plugin, the plugin. Otherwise null</returns>
+    Plugin? GetPluginFromException(Exception exception);
+
     /// <summary>
     ///     Gets the plugin that defined the specified device
     /// </summary>

src/Artemis.Core/Services/PluginManagementService.cs

@@ -192,7 +192,19 @@ internal class PluginManagementService : IPluginManagementService
 
     public Plugin? GetCallingPlugin()
     {
-        StackTrace stackTrace = new(); // get call stack
+        return GetPluginFromStackTrace(new StackTrace());
+    }
+
+    public Plugin? GetPluginFromException(Exception exception)
+    {
+        if (exception is ArtemisPluginException pluginException && pluginException.Plugin != null)
+            return pluginException.Plugin;
+
+        return GetPluginFromStackTrace(new StackTrace(exception));
+    }
+
+    private Plugin? GetPluginFromStackTrace(StackTrace stackTrace)
+    {
         StackFrame[] stackFrames = stackTrace.GetFrames(); // get method calls (frames)
 
         foreach (StackFrame stackFrame in stackFrames)

src/Artemis.UI.Shared/Controls/HotkeyBox.axaml

@@ -10,8 +10,16 @@
         <Style Selector="TextBox#DisplayTextBox:focus:not(TextBox:empty)">
             <Setter Property="InnerRightContent">
                 <Template>
-                    <Button Classes="textBoxClearButton"
+                    <Button Theme="{StaticResource TextBoxDeleteButtonStyle}"
-                            Click="Button_OnClick" />
+                            Click="Button_OnClick"
+                            BorderThickness="{TemplateBinding BorderThickness}"
+                            CornerRadius="{DynamicResource ControlCornerRadius}"
+                            Padding="{StaticResource HelperButtonThemePadding}"
+                            IsTabStop="False"
+                            Focusable="False"
+                            FontSize="{TemplateBinding FontSize}"
+                            Width="30"
+                            VerticalAlignment="Stretch" />
                 </Template>
             </Setter>
         </Style>

src/Artemis.UI.Shared/Controls/HotkeyBox.axaml.cs

@@ -8,6 +8,8 @@ using Avalonia.Data;
 using Avalonia.Input;
 using Avalonia.Interactivity;
 using Avalonia.Markup.Xaml;
+using Avalonia.Threading;
+using DryIoc;
 using FluentAvalonia.Core;
 using Humanizer;
 using Material.Icons;
@@ -19,44 +21,62 @@ namespace Artemis.UI.Shared;
 /// </summary>
 public partial class HotkeyBox : UserControl
 {
+    private readonly IInputService _inputService;
+
     /// <summary>
     ///     Creates a new instance of the <see cref="HotkeyBox" /> class
     /// </summary>
     public HotkeyBox()
     {
+        _inputService = UI.Locator.Resolve<IInputService>();
+
         InitializeComponent();
         PropertyChanged += OnPropertyChanged;
-        DisplayTextBox.KeyDown += DisplayTextBoxOnKeyDown;
-        DisplayTextBox.KeyUp += DisplayTextBoxOnKeyUp;
         UpdateDisplayTextBox();
     }
 
+    protected override void OnGotFocus(GotFocusEventArgs e)
+    {
+        _inputService.KeyboardKeyDown += InputServiceOnKeyboardKeyDown;
+        _inputService.KeyboardKeyUp += InputServiceOnKeyboardKeyUp;
+        
+        base.OnGotFocus(e);
+    }
+
+    protected override void OnLostFocus(RoutedEventArgs e)
+    {
+        _inputService.KeyboardKeyDown -= InputServiceOnKeyboardKeyDown;
+        _inputService.KeyboardKeyUp -= InputServiceOnKeyboardKeyUp;
+        
+        base.OnLostFocus(e);
+    }
+    
     private void OnPropertyChanged(object? sender, AvaloniaPropertyChangedEventArgs e)
     {
         if (e.Property == HotkeyProperty)
             UpdateDisplayTextBox();
     }
 
-    private void DisplayTextBoxOnKeyDown(object? sender, KeyEventArgs e)
+    private void InputServiceOnKeyboardKeyDown(object? sender, ArtemisKeyboardKeyEventArgs e)
     {
-        if (e.Key >= Key.LeftShift && e.Key <= Key.RightAlt)
+        if (e.Key >= KeyboardKey.LeftShift && e.Key <= KeyboardKey.RightAlt)
             return;
 
         Hotkey ??= new Hotkey();
-        Hotkey.Key = (KeyboardKey?) e.Key;
+        Hotkey.Key = e.Key;
-        Hotkey.Modifiers = (KeyboardModifierKey?) e.KeyModifiers;
+        Hotkey.Modifiers = e.Modifiers;
-        UpdateDisplayTextBox();
+        
-        HotkeyChanged?.Invoke(this, EventArgs.Empty);
+        Dispatcher.UIThread.Post(() =>
-
+        {
-        e.Handled = true;
+            UpdateDisplayTextBox();
+            HotkeyChanged?.Invoke(this, EventArgs.Empty);
+        });
     }
 
-    private void DisplayTextBoxOnKeyUp(object? sender, KeyEventArgs e)
+    private void InputServiceOnKeyboardKeyUp(object? sender, ArtemisKeyboardKeyEventArgs e)
     {
-        if (e.KeyModifiers == KeyModifiers.None)
+        if (e.Modifiers == KeyboardModifierKey.None)
-            FocusManager.Instance?.Focus(null);
+            Dispatcher.UIThread.Post(() => FocusManager.Instance?.Focus(null));
-
-        e.Handled = true;
     }
 
     private void UpdateDisplayTextBox()

src/Artemis.UI.Shared/DryIoc/ContainerExtensions.cs

@@ -17,5 +17,7 @@ public static class ContainerExtensions
     {
         Assembly artemisShared = typeof(IArtemisSharedUIService).GetAssembly();
         container.RegisterMany(new[] { artemisShared }, type => type.IsAssignableTo<IArtemisSharedUIService>(), Reuse.Singleton);
+
+        UI.Locator = container;
     }
 }

src/Artemis.UI.Shared/Utilities.cs

@@ -0,0 +1,8 @@
+using DryIoc;
+
+namespace Artemis.UI.Shared;
+
+internal static class UI
+{
+    public static IContainer Locator { get; set; } = null!;
+}