Add logging and tests for the R3 integration

Author: TolikPylypchuk

SharpHook.R3/Logging/IR3LogSource.cs

@@ -0,0 +1,21 @@
+namespace SharpHook.R3.Logging;
+
+/// <summary>
+/// Represents a reactive R3 source of libuiohook logs.
+/// </summary>
+/// <seealso cref="ILogSource" />
+/// <seealso cref="LogSource" />
+public interface IR3LogSource : IDisposable
+{
+    /// <summary>
+    /// An observable which is emitted when libuiohook logs a message.
+    /// </summary>
+    Observable<LogEntry> MessageLogged { get; }
+
+    /// <summary>
+    /// Gets the value which indicates whether the log source is disposed.
+    /// </summary>
+    /// <value><see langword="true" /> if the log source is disposed. Otherwise, <see langword="false" />.</value>
+    /// <remarks>The <see cref="MessageLogged" /> observable doesn't emit any values in a disposed log source.</remarks>
+    bool IsDisposed { get; }
+}

SharpHook.R3/Logging/R3LogSourceAdapter.cs

@@ -0,0 +1,93 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace SharpHook.R3.Logging;
+
+/// <summary>
+/// Adapts an <see cref="ILogSource" /> to the <see cref="IR3LogSource" /> interface.
+/// </summary>
+/// <seealso cref="ILogSource" />
+/// <seealso cref="IR3LogSource" />
+[ExcludeFromCodeCoverage]
+public sealed class R3LogSourceAdapter : IR3LogSource
+{
+    private readonly ILogSource logSource;
+    private readonly Subject<LogEntry> messageLoggedSubject = new();
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="R3LogSourceAdapter" /> class.
+    /// </summary>
+    /// <param name="logSource">The log source to adapt.</param>
+    /// <exception cref="ArgumentNullException"><paramref name="logSource" /> is <see langword="null" />.</exception>
+    public R3LogSourceAdapter(ILogSource logSource)
+        : this(logSource, ObservableSystem.DefaultTimeProvider)
+    { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="R3LogSourceAdapter" /> class.
+    /// </summary>
+    /// <param name="logSource">The log source to adapt.</param>
+    /// <param name="defaultTimeProvider">The default time provider for the observable.</param>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="logSource" /> or <paramref name="defaultTimeProvider" /> is <see langword="null" />.
+    /// </exception>
+    public R3LogSourceAdapter(ILogSource logSource, TimeProvider defaultTimeProvider)
+    {
+        this.logSource = logSource ?? throw new ArgumentNullException(nameof(logSource));
+
+        if (defaultTimeProvider is null)
+        {
+            throw new ArgumentNullException(nameof(defaultTimeProvider));
+        }
+
+        Observable.FromEventHandler<LogEventArgs>(
+            h => this.logSource.MessageLogged += h, h => this.logSource.MessageLogged -= h)
+            .Select(this.SelectEventArgs)
+            .Select(e => e.LogEntry)
+            .Subscribe(this.messageLoggedSubject.AsObserver());
+
+        this.MessageLogged = this.messageLoggedSubject.ObserveOn(defaultTimeProvider);
+    }
+
+    /// <summary>
+    /// Completes the <see cref="MessageLogged" /> observable if the log source hasn't been disposed.
+    /// </summary>
+    ~R3LogSourceAdapter() =>
+        this.Dispose(false);
+
+    /// <summary>
+    /// An observable which is emitted when libuiohook logs a message.
+    /// </summary>
+    public Observable<LogEntry> MessageLogged { get; }
+
+    /// <summary>
+    /// Gets the value which indicates whether the log source is disposed.
+    /// </summary>
+    /// <value><see langword="true" /> if the log source is disposed. Otherwise, <see langword="false" />.</value>
+    /// <remarks>The <see cref="MessageLogged" /> observable doesn't emit any values in a disposed log source.</remarks>
+    public bool IsDisposed => this.logSource.IsDisposed;
+
+    /// <summary>
+    /// Disposes the adapted log source and emits the completion signal for <see cref="MessageLogged" />.
+    /// </summary>
+    public void Dispose()
+    {
+        if (!this.IsDisposed)
+        {
+            this.Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+    }
+
+    private void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            this.logSource.Dispose();
+        }
+
+        this.messageLoggedSubject.Dispose();
+    }
+
+    private TArgs SelectEventArgs<TArgs>((object? Sender, TArgs Args) e) =>
+        e.Args;
+}

SharpHook.R3/SharpHook.R3.xml

@@ -206,7 +206,7 @@ public void Run()
         {
             this.IsRunning = false;
             runningGlobalHooks.TryRemove(this.hookIndex, out _);
-            this.globalHookProvider.SetDispatchProc(null, IntPtr.Zero);
+            this.globalHookProvider.SetDispatchProc(null, this.hookIndex);
         }
 
         if (result != UioHookResult.Success)
@@ -258,7 +258,7 @@ public Task RunAsync()
             } finally
             {
                 runningGlobalHooks.TryRemove(this.hookIndex, out _);
-                this.globalHookProvider.SetDispatchProc(null, IntPtr.Zero);
+                this.globalHookProvider.SetDispatchProc(null, this.hookIndex);
             }
         })
         {

SharpHook.R3/SimpleR3GlobalHook.cs

@@ -82,6 +82,7 @@ private void Dispose(bool disposing)
             this.logSource.Dispose();
         }
 
-        messageLoggedSubject.OnCompleted();
+        this.messageLoggedSubject.OnCompleted();
+        this.messageLoggedSubject.Dispose();
     }
 }

SharpHook.Reactive/Logging/ReactiveLogSourceAdapter.cs

@@ -202,7 +202,7 @@ public void Run()
         {
             this.IsRunning = false;
             runningGlobalHooks.TryRemove(this.hookIndex, out _);
-            this.globalHookProvider.SetDispatchProc(null, IntPtr.Zero);
+            this.globalHookProvider.SetDispatchProc(null, this.hookIndex);
         }
 
         if (result != UioHookResult.Success)
@@ -256,7 +256,7 @@ public IObservable<Unit> RunAsync()
             } finally
             {
                 runningGlobalHooks.TryRemove(this.hookIndex, out _);
-                this.globalHookProvider.SetDispatchProc(null, IntPtr.Zero);
+                this.globalHookProvider.SetDispatchProc(null, this.hookIndex);
 
             }
         })

SharpHook.Reactive/SimpleReactiveGlobalHook.cs

@@ -1,9 +1,13 @@
 global using System.Reactive.Concurrency;
 global using System.Reactive.Linq;
 
+global using R3;
+
 global using SharpHook;
 global using SharpHook.Data;
 global using SharpHook.Logging;
 global using SharpHook.Providers;
+global using SharpHook.R3;
+global using SharpHook.R3.Logging;
 global using SharpHook.Reactive;
 global using SharpHook.Reactive.Logging;