Native AOT Compatibility!

.editorconfig

@@ -3,8 +3,5 @@
 # IDE0046: Convert to conditional expression
 dotnet_style_prefer_conditional_expression_over_return = false
 
-# CA1510: Use ArgumentNullException throw helper
-dotnet_diagnostic.CA1510.severity = none
-
-# CA1513: Use ObjectDisposedException throw helper
-dotnet_diagnostic.CA1513.severity = none
+# CA1708: Identifiers should differ by more than case
+dotnet_diagnostic.CA1708.severity = none

.github/workflows/dotnet.yml

@@ -24,7 +24,7 @@ jobs:
     - name: NuGet Restore
       run: nuget restore
     - name: Build
-      run: msbuild -t:restore,build /p:Configuration=${{matrix.configuration}} /p:Platform=x64 /bl
+      run: msbuild /t:restore`;build /p:Configuration=${{matrix.configuration}} /p:Platform=x64 /bl
     - name: Upload MSBuild binary log
       uses: actions/upload-artifact@v3
       with:
@@ -47,9 +47,9 @@ jobs:
     - name: NuGet Restore
       run: nuget restore
     - name: Build
-      run: msbuild .\src\Shmuelie.WinRTServer\Shmuelie.WinRTServer.csproj -t:restore,build -p:Configuration=Release
+      run: msbuild .\src\Shmuelie.WinRTServer\Shmuelie.WinRTServer.csproj /t:restore`;build /p:Configuration=Release
     - name: Pack
-      run: msbuild .\src\Shmuelie.WinRTServer\Shmuelie.WinRTServer.csproj -t:pack -p:Configuration=Release
+      run: msbuild .\src\Shmuelie.WinRTServer\Shmuelie.WinRTServer.csproj /t:pack /p:Configuration=Release
     - name: Upload package artifacts
       uses: actions/upload-artifact@v3
       with:

Directory.Build.props

@@ -19,7 +19,7 @@
     As such, this needs to be changed before a new release as well.
   -->
   <PropertyGroup>
-    <ShmuelieWinRTServerPackageVersion>1.2.0</ShmuelieWinRTServerPackageVersion>
+    <ShmuelieWinRTServerPackageVersion>2.0.0</ShmuelieWinRTServerPackageVersion>
     <IsCommitOnReleaseBranch>false</IsCommitOnReleaseBranch>
   </PropertyGroup>
 
@@ -70,7 +70,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.1.1" PrivateAssets="all" />
+    <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.2.4" PrivateAssets="all" />
   </ItemGroup>
 
   <!-- Needed for deterministic builds -->

src/Shmuelie.WinRTServer/ComServer.cs

@@ -1,9 +1,12 @@
 using System;
 using System.Collections.Generic;
+using System.Runtime.InteropServices;
+using System.Runtime.InteropServices.Marshalling;
 using System.Runtime.Versioning;
 using System.Threading.Tasks;
 using System.Timers;
-using Shmuelie.Interop.Windows;
+using Shmuelie.WinRTServer.Internal;
+using Shmuelie.WinRTServer.Internal.Windows;
 using Windows.Win32.Foundation;
 using Windows.Win32.System.Com;
 using static Windows.Win32.PInvoke;
@@ -13,6 +16,20 @@ namespace Shmuelie.WinRTServer;
 /// <summary>
 /// An Out of Process COM Server.
 /// </summary>
+/// <remarks>
+/// <para>Allows for types to be created using COM activation instead of WinRT activation like <see cref="WinRtServer"/>.</para>
+/// <para>Typical usage is to call from an <see langword="await"/> <see langword="using"/> block, using <see cref="WaitForFirstObjectAsync"/> to not close until it is safe to do so.</para>
+/// <code language="cs">
+/// <![CDATA[
+/// await using (ComServer server = new ComServer())
+/// {
+///     server.RegisterClass<RemoteThing, IRemoteThing>();
+///     server.Start();
+///     await server.WaitForFirstObjectAsync();
+/// }
+/// ]]>
+/// </code>
+/// </remarks>
 /// <see cref="IAsyncDisposable"/>
 /// <threadsafety static="true" instance="false"/>
 [SupportedOSPlatform("windows6.0.6000")]
@@ -33,6 +50,8 @@ public sealed class ComServer : IAsyncDisposable
     /// </summary>
     private readonly Timer lifetimeCheckTimer;
 
+    private readonly StrategyBasedComWrappers comWrappers = new();
+
     /// <summary>
     /// Tracks the creation of the first instance after server is started.
     /// </summary>
@@ -97,22 +116,18 @@ private void LifetimeCheckTimer_Elapsed(object? sender, ElapsedEventArgs e)
     /// Register a class factory with the server.
     /// </summary>
     /// <param name="factory">The class factory to register.</param>
+    /// <param name="comWrappers">The implementation of <see cref="ComWrappers"/> to use for wrapping.</param>
     /// <returns><see langword="true"/> if <paramref name="factory"/> was registered; otherwise, <see langword="false"/>.</returns>
     /// <remarks>Only one factory can be registered for a CLSID.</remarks>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
-    /// <exception cref="ArgumentNullException"><paramref name="factory"/> is <see langword="null"/>.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="factory"/> or <paramref name="comWrappers"/> is <see langword="null"/>.</exception>
     /// <exception cref="InvalidOperationException">The server is running.</exception>
     /// <seealso cref="UnregisterClassFactory(Guid)"/>
-    public unsafe bool RegisterClassFactory(BaseClassFactory factory)
+    public unsafe bool RegisterClassFactory(BaseClassFactory factory, ComWrappers comWrappers)
     {
-        if (IsDisposed)
-        {
-            throw new ObjectDisposedException(nameof(ComServer));
-        }
-        if (factory is null)
-        {
-            throw new ArgumentNullException(nameof(factory));
-        }
+        ObjectDisposedException.ThrowIf(IsDisposed, this);
+        ArgumentNullException.ThrowIfNull(factory);
+        ArgumentNullException.ThrowIfNull(comWrappers);
         if (lifetimeCheckTimer.Enabled)
         {
             throw new InvalidOperationException("Can only add class factories when server is not running.");
@@ -127,11 +142,10 @@ public unsafe bool RegisterClassFactory(BaseClassFactory factory)
 
         factory.InstanceCreated += Factory_InstanceCreated;
 
-        using ComPtr<BaseClassFactoryProxy> proxy = default;
-        proxy.Attach(BaseClassFactoryProxy.Create(factory));
+        nint wrapper = this.comWrappers.GetOrCreateComInterfaceForObject(new BaseClassFactoryWrapper(factory, comWrappers), CreateComInterfaceFlags.None);
 
         uint cookie;
-        CoRegisterClassObject(&clsid, (IUnknown*)proxy.Get(), CLSCTX.CLSCTX_LOCAL_SERVER, (REGCLS.REGCLS_MULTIPLEUSE | REGCLS.REGCLS_SUSPENDED), &cookie).ThrowOnFailure();
+        CoRegisterClassObject(&clsid, (IUnknown*)wrapper, CLSCTX.CLSCTX_LOCAL_SERVER, (REGCLS.REGCLS_MULTIPLEUSE | REGCLS.REGCLS_SUSPENDED), &cookie).ThrowOnFailure();
 
         factories.Add(clsid, (factory, cookie));
         return true;
@@ -144,13 +158,10 @@ public unsafe bool RegisterClassFactory(BaseClassFactory factory)
     /// <returns><see langword="true"/> if the server was removed; otherwise, <see langword="false"/>.</returns>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
     /// <exception cref="InvalidOperationException">The server is running.</exception>
-    /// <seealso cref="RegisterClassFactory(BaseClassFactory)"/>
+    /// <seealso cref="RegisterClassFactory(BaseClassFactory, ComWrappers)"/>
     public unsafe bool UnregisterClassFactory(Guid clsid)
     {
-        if (IsDisposed)
-        {
-            throw new ObjectDisposedException(nameof(ComServer));
-        }
+        ObjectDisposedException.ThrowIf(IsDisposed, this);
         if (lifetimeCheckTimer.Enabled)
         {
             throw new InvalidOperationException("Can only remove class factories when server is not running.");
@@ -188,13 +199,11 @@ private void Factory_InstanceCreated(object? sender, InstanceCreatedEventArgs e)
     /// <summary>
     /// Starts the server.
     /// </summary>
+    /// <remarks>Calling <see cref="Start"/> is non-blocking.</remarks>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
     public void Start()
     {
-        if (IsDisposed)
-        {
-            throw new ObjectDisposedException(nameof(ComServer));
-        }
+        ObjectDisposedException.ThrowIf(IsDisposed, this);
         if (lifetimeCheckTimer.Enabled)
         {
             return;
@@ -211,10 +220,7 @@ public void Start()
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
     public void Stop()
     {
-        if (IsDisposed)
-        {
-            throw new ObjectDisposedException(nameof(ComServer));
-        }
+        ObjectDisposedException.ThrowIf(IsDisposed, this);
         if (!lifetimeCheckTimer.Enabled)
         {
             return;
@@ -232,17 +238,14 @@ public void Stop()
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
     public async Task<object?> WaitForFirstObjectAsync()
     {
-        if (IsDisposed)
-        {
-            throw new ObjectDisposedException(nameof(ComServer));
-        }
+        ObjectDisposedException.ThrowIf(IsDisposed, this);
 
         TaskCompletionSource<object>? local = firstInstanceCreated;
         if (local is null)
         {
             return null;
         }
-        return await local.Task;
+        return await local.Task.ConfigureAwait(false);
     }
 
     /// <summary>
@@ -272,7 +275,7 @@ void Ended(object? sender, EventArgs e)
                     }
 
                     Empty += Ended;
-                    await tcs.Task;
+                    await tcs.Task.ConfigureAwait(false);
                     Empty -= Ended;
                 }
 

src/Shmuelie.WinRTServer/ComServerExtensions.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Runtime.InteropServices;
 using System.Runtime.Versioning;
 
 namespace Shmuelie.WinRTServer;
@@ -15,19 +16,19 @@ public static class ComServerExtensions
     /// <typeparam name="T">The type to register.</typeparam>
     /// <typeparam name="TInterface">The interface that <typeparamref name="T"/> implements.</typeparam>
     /// <param name="server">The instance.</param>
+    /// <param name="comWrappers">The implementation of <see cref="ComWrappers"/> to use for wrapping.</param>
     /// <returns><see langword="true"/> if type was registered; otherwise, <see langword="false"/>.</returns>
     /// <remarks>Type can only be registered once.</remarks>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
-    /// <exception cref="ArgumentNullException"><paramref name="server"/> is <see langword="null"/>.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> or <paramref name="comWrappers"/> is <see langword="null"/>.</exception>
     /// <exception cref="InvalidOperationException">The server is running.</exception>
-    public static bool RegisterClass<T, TInterface>(this ComServer server) where T : class, TInterface, new()
+    public static bool RegisterClass<T, TInterface>(this ComServer server, ComWrappers comWrappers) where T : class, TInterface, new()
     {
-        if (server is null)
-        {
-            throw new ArgumentNullException(nameof(server));
-        }
+        ArgumentNullException.ThrowIfNull(server);
+        ArgumentNullException.ThrowIfNull(comWrappers);
 
-        return server.RegisterClassFactory(new GeneralClassFactory<T, TInterface>());
+
+        return server.RegisterClassFactory(new GeneralClassFactory<T, TInterface>(), comWrappers);
     }
 
     /// <summary>
@@ -37,39 +38,38 @@ public static class ComServerExtensions
     /// <typeparam name="TInterface">The interface that <typeparamref name="T"/> implements.</typeparam>
     /// <param name="server">The instance.</param>
     /// <param name="factory">Method to create instance of <typeparamref name="T"/>.</param>
+    /// <param name="comWrappers">The implementation of <see cref="ComWrappers"/> to use for wrapping.</param>
     /// <returns><see langword="true"/> if type was registered; otherwise, <see langword="false"/>.</returns>
     /// <remarks>Type can only be registered once.</remarks>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
-    /// <exception cref="ArgumentNullException"><paramref name="server"/> is <see langword="null"/>.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/>, <paramref name="factory"/>, or <paramref name="comWrappers"/> is <see langword="null"/>.</exception>
     /// <exception cref="InvalidOperationException">The server is running.</exception>
-    public static bool RegisterClass<T, TInterface>(this ComServer server, Func<T> factory) where T : class, TInterface
+    public static bool RegisterClass<T, TInterface>(this ComServer server, Func<T> factory, ComWrappers comWrappers) where T : class, TInterface
     {
-        if (server is null)
-        {
-            throw new ArgumentNullException(nameof(server));
-        }
+        ArgumentNullException.ThrowIfNull(server);
+        ArgumentNullException.ThrowIfNull(factory);
+        ArgumentNullException.ThrowIfNull(comWrappers);
 
-        return server.RegisterClassFactory(new DelegateClassFactory<T, TInterface>(factory));
+        return server.RegisterClassFactory(new DelegateClassFactory<T, TInterface>(factory), comWrappers);
     }
 
     /// <summary>
     /// Register a class factory with the server.
     /// </summary>
     /// <typeparam name="T">The type of the factory to register.</typeparam>
-    /// /// <param name="server">The instance.</param>
+    /// <param name="server">The instance.</param>
+    /// <param name="comWrappers">The implementation of <see cref="ComWrappers"/> to use for wrapping.</param>
     /// <returns><see langword="true"/> if an instance of <typeparamref name="T"/> was registered; otherwise, <see langword="false"/>.</returns>
     /// <remarks>Only one factory can be registered for a CLSID.</remarks>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
-    /// <exception cref="ArgumentNullException"><paramref name="server"/> is <see langword="null"/>.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> or <paramref name="comWrappers"/> is <see langword="null"/>.</exception>
     /// <exception cref="InvalidOperationException">The server is running.</exception>
-    public static bool RegisterClassFactory<T>(this ComServer server) where T : BaseClassFactory, new()
+    public static bool RegisterClassFactory<T>(this ComServer server, ComWrappers comWrappers) where T : BaseClassFactory, new()
     {
-        if (server is null)
-        {
-            throw new ArgumentNullException(nameof(server));
-        }
+        ArgumentNullException.ThrowIfNull(server);
+        ArgumentNullException.ThrowIfNull(comWrappers);
 
-        return server.RegisterClassFactory(new T());
+        return server.RegisterClassFactory(new T(), comWrappers);
     }
 
     /// <summary>
@@ -80,8 +80,12 @@ public static bool RegisterClass<T, TInterface>(this ComServer server, Func<T> f
     /// <returns><see langword="true"/> if the server was removed; otherwise, <see langword="false"/>.</returns>
     /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
     /// <exception cref="InvalidOperationException">The server is running.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> or <paramref name="factory"/> is <see langword="null"/>.</exception>
     public static bool UnregisterClassFactory(this ComServer server, BaseClassFactory factory)
     {
+        ArgumentNullException.ThrowIfNull(server);
+        ArgumentNullException.ThrowIfNull(factory);
+
         return server.UnregisterClassFactory(factory.Clsid);
     }
 }

src/Shmuelie.WinRTServer/CsWinRT/ComServerExtensions.cs

@@ -0,0 +1,86 @@
+using System;
+using System.Runtime.Versioning;
+using WinRT;
+
+namespace Shmuelie.WinRTServer.CsWinRT;
+
+/// <summary>
+/// Extensions for <see cref="ComServer"/> when using <see cref="DefaultComWrappers"/>.
+/// </summary>
+[SupportedOSPlatform("windows6.0.6000")]
+public static class ComServerExtensions
+{
+    private static readonly DefaultComWrappers comWrappers = new();
+
+    /// <summary>
+    /// Register a type with the server.
+    /// </summary>
+    /// <typeparam name="T">The type to register.</typeparam>
+    /// <typeparam name="TInterface">The interface that <typeparamref name="T"/> implements.</typeparam>
+    /// <param name="server">The instance.</param>
+    /// <returns><see langword="true"/> if type was registered; otherwise, <see langword="false"/>.</returns>
+    /// <remarks>Type can only be registered once.</remarks>
+    /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> is <see langword="null"/>.</exception>
+    /// <exception cref="InvalidOperationException">The server is running.</exception>
+    public static bool RegisterClass<T, TInterface>(this ComServer server) where T : class, TInterface, new()
+    {
+        ArgumentNullException.ThrowIfNull(server);
+
+        return server.RegisterClassFactory(new GeneralClassFactory<T, TInterface>(), comWrappers);
+    }
+
+    /// <summary>
+    /// Register a type with the server.
+    /// </summary>
+    /// <typeparam name="T">The type to register.</typeparam>
+    /// <typeparam name="TInterface">The interface that <typeparamref name="T"/> implements.</typeparam>
+    /// <param name="server">The instance.</param>
+    /// <param name="factory">Method to create instance of <typeparamref name="T"/>.</param>
+    /// <returns><see langword="true"/> if type was registered; otherwise, <see langword="false"/>.</returns>
+    /// <remarks>Type can only be registered once.</remarks>
+    /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> or <paramref name="factory"/> is <see langword="null"/>.</exception>
+    /// <exception cref="InvalidOperationException">The server is running.</exception>
+    public static bool RegisterClass<T, TInterface>(this ComServer server, Func<T> factory) where T : class, TInterface
+    {
+        ArgumentNullException.ThrowIfNull(server);
+        ArgumentNullException.ThrowIfNull(factory);
+
+        return server.RegisterClassFactory(new DelegateClassFactory<T, TInterface>(factory), comWrappers);
+    }
+
+    /// <summary>
+    /// Register a class factory with the server.
+    /// </summary>
+    /// <typeparam name="T">The type of the factory to register.</typeparam>
+    /// <param name="server">The instance.</param>
+    /// <returns><see langword="true"/> if an instance of <typeparamref name="T"/> was registered; otherwise, <see langword="false"/>.</returns>
+    /// <remarks>Only one factory can be registered for a CLSID.</remarks>
+    /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> is <see langword="null"/>.</exception>
+    /// <exception cref="InvalidOperationException">The server is running.</exception>
+    public static bool RegisterClassFactory<T>(this ComServer server) where T : BaseClassFactory, new()
+    {
+        ArgumentNullException.ThrowIfNull(server);
+
+        return server.RegisterClassFactory(new T(), comWrappers);
+    }
+
+    /// <summary>
+    /// Unregister a class factory.
+    /// </summary>
+    /// <param name="server">The instance.</param>
+    /// <param name="factory">The class factory to unregister.</param>
+    /// <returns><see langword="true"/> if the server was removed; otherwise, <see langword="false"/>.</returns>
+    /// <exception cref="ObjectDisposedException">The instance is disposed.</exception>
+    /// <exception cref="InvalidOperationException">The server is running.</exception>
+    /// <exception cref="ArgumentNullException"><paramref name="server"/> or <paramref name="factory"/> is <see langword="null"/>.</exception>
+    public static bool UnregisterClassFactory(this ComServer server, BaseClassFactory factory)
+    {
+        ArgumentNullException.ThrowIfNull(server);
+        ArgumentNullException.ThrowIfNull(factory);
+
+        return server.UnregisterClassFactory(factory.Clsid);
+    }
+}