-
Notifications
You must be signed in to change notification settings - Fork 114
Integrate Shmueli's ComServer into CsWinRT #1995
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 8 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
790ad43
add comservehelpers
beervoley bcd145b
add copyright notices
beervoley 59c5a86
fix tests
beervoley 121a51a
copy comservers binaries to output location
beervoley 5646caf
update nuget pack to include com server helpers
beervoley b9f748e
address PR feedback
beervoley 8f4db4f
version assembly separately
beervoley eca2d2b
add oop com tests
beervoley b7f28e4
update tests
beervoley 2ac6e85
clean up
beervoley e084530
clean up
beervoley 6fc66f2
remove trustlevel marshaller - unsused
beervoley 2d043ca
invalid arg to invalid ptr
beervoley bd37f88
remove roinitialize; replace malloc
beervoley 168290d
global option is not iinspectable; do direct cast
beervoley 08c16c4
address PR feedback
beervoley 0202908
reorder fields to match guidelines
beervoley 5ab887a
add missing file
beervoley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.Runtime.Versioning; | ||
|
|
||
| namespace ComServerHelpers; | ||
|
|
||
| /// <summary> | ||
| /// Base for a WinRT Activation Factory for a .NET type. | ||
| /// </summary> | ||
| [SupportedOSPlatform("windows8.0")] | ||
| public abstract class BaseActivationFactory | ||
beervoley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| /// <inheritdoc/> | ||
| public abstract object ActivateInstance(); | ||
|
|
||
| /// <summary> | ||
| /// Gets the Activatable Class ID. | ||
| /// </summary> | ||
| public abstract string ActivatableClassId | ||
beervoley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| get; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Occurs when a new instance is created. | ||
| /// </summary> | ||
| public event EventHandler<InstanceCreatedEventArgs>? InstanceCreated; | ||
beervoley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /// <summary> | ||
| /// Raises the <see cref="InstanceCreated"/> event. | ||
| /// </summary> | ||
| /// <param name="instance">The created instance.</param> | ||
| /// <event cref="InstanceCreated"/> | ||
| internal void OnInstanceCreated(object instance) | ||
| { | ||
| InstanceCreated?.Invoke(this, new InstanceCreatedEventArgs(instance)); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.Runtime.Versioning; | ||
|
|
||
| namespace ComServerHelpers; | ||
|
|
||
| /// <summary> | ||
| /// Base for a COM class factory for a .NET type. | ||
| /// </summary> | ||
| /// <remarks>Does not support aggregation. Will always return <c>CLASS_E_NOAGGREGATION</c> if requested.</remarks> | ||
| [SupportedOSPlatform("windows6.0.6000")] | ||
| public abstract class BaseClassFactory | ||
| { | ||
| /// <summary> | ||
| /// Creates an instance of the object. | ||
| /// </summary> | ||
| /// <returns>An instance of the object.</returns> | ||
| protected internal abstract object CreateInstance(); | ||
|
|
||
| /// <summary> | ||
| /// Occurs when a new instance is created. | ||
| /// </summary> | ||
| public event EventHandler<InstanceCreatedEventArgs>? InstanceCreated; | ||
|
|
||
| /// <summary> | ||
| /// Gets the <c>CLSID</c>. | ||
| /// </summary> | ||
| protected internal abstract Guid Clsid | ||
| { | ||
| get; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets the <c>IID</c>. | ||
| /// </summary> | ||
| protected internal abstract Guid Iid | ||
| { | ||
| get; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Raises the <see cref="InstanceCreated"/> event. | ||
| /// </summary> | ||
| /// <param name="instance">The created instance.</param> | ||
| /// <event cref="InstanceCreated"/> | ||
| internal void OnInstanceCreated(object instance) | ||
| { | ||
| InstanceCreated?.Invoke(this, new InstanceCreatedEventArgs(instance)); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,239 @@ | ||
| // Copyright (c) Microsoft Corporation. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Runtime.InteropServices; | ||
| using System.Runtime.InteropServices.Marshalling; | ||
| using System.Runtime.Versioning; | ||
| using System.Threading.Tasks; | ||
| using ComServerHelpers.Internal; | ||
| using ComServerHelpers.Internal.Windows; | ||
| using Windows.Win32.Foundation; | ||
| using Windows.Win32.System.Com; | ||
| using static Windows.Win32.PInvoke; | ||
|
|
||
| namespace ComServerHelpers; | ||
|
|
||
| /// <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 a <see langword="using"/> block, using <see cref="WaitForFirstObjectAsync"/> to not close until it is safe to do so.</para> | ||
| /// <code language="cs"> | ||
| /// <![CDATA[ | ||
| /// using (ComServer server = new ComServer()) | ||
| /// { | ||
| /// server.RegisterClass<RemoteThing, IRemoteThing>(); | ||
| /// server.Start(); | ||
| /// await server.WaitForFirstObjectAsync(); | ||
| /// } | ||
| /// ]]> | ||
| /// </code> | ||
| /// </remarks> | ||
| /// <see cref="IDisposable"/> | ||
| /// <threadsafety static="true" instance="false"/> | ||
| [SupportedOSPlatform("windows6.0.6000")] | ||
| public sealed class ComServer : IDisposable | ||
| { | ||
| /// <summary> | ||
| /// Map of class factories and the registration cookie from the CLSID that the factory creates. | ||
| /// </summary> | ||
| private readonly Dictionary<Guid, (BaseClassFactory factory, uint cookie)> factories = []; | ||
|
|
||
| private readonly StrategyBasedComWrappers comWrappers = new(); | ||
|
|
||
| /// <summary> | ||
| /// Tracks the creation of the first instance after server is started. | ||
| /// </summary> | ||
| private TaskCompletionSource<object>? firstInstanceCreated; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="ComServer"/> class. | ||
| /// </summary> | ||
| public unsafe ComServer() | ||
| { | ||
| using ComPtr<IGlobalOptions> options = default; | ||
| Guid clsid = CLSID_GlobalOptions; | ||
| Guid iid = IGlobalOptions.IID_Guid; | ||
| if (CoCreateInstance(&clsid, null, CLSCTX.CLSCTX_INPROC_SERVER, &iid, (void**)options.GetAddressOf()) == HRESULT.S_OK) | ||
| { | ||
| options.Get()->Set(GLOBALOPT_PROPERTIES.COMGLB_RO_SETTINGS, (nuint)GLOBALOPT_RO_FLAGS.COMGLB_FAST_RUNDOWN); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// 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"/> 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, ComWrappers comWrappers) | ||
| { | ||
| ObjectDisposedException.ThrowIf(IsDisposed, this); | ||
| ArgumentNullException.ThrowIfNull(factory); | ||
| ArgumentNullException.ThrowIfNull(comWrappers); | ||
| if (IsRunning) | ||
| { | ||
| throw new InvalidOperationException("Can only add class factories when server is not running."); | ||
| } | ||
|
|
||
| Guid clsid = factory.Clsid; | ||
|
|
||
| if (factories.ContainsKey(clsid)) | ||
| { | ||
| return false; | ||
| } | ||
|
|
||
| factory.InstanceCreated += Factory_InstanceCreated; | ||
|
|
||
| nint wrapper = this.comWrappers.GetOrCreateComInterfaceForObject(new BaseClassFactoryWrapper(factory, comWrappers), CreateComInterfaceFlags.None); | ||
|
|
||
| uint cookie; | ||
| CoRegisterClassObject(&clsid, (IUnknown*)wrapper, CLSCTX.CLSCTX_LOCAL_SERVER, (REGCLS.REGCLS_MULTIPLEUSE | REGCLS.REGCLS_SUSPENDED), &cookie).ThrowOnFailure(); | ||
|
|
||
| factories.Add(clsid, (factory, cookie)); | ||
beervoley marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return true; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Unregister a class factory. | ||
| /// </summary> | ||
| /// <param name="clsid">The CLSID of the server to remove.</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> | ||
| /// <seealso cref="RegisterClassFactory(BaseClassFactory, ComWrappers)"/> | ||
| public unsafe bool UnregisterClassFactory(Guid clsid) | ||
| { | ||
| ObjectDisposedException.ThrowIf(IsDisposed, this); | ||
| if (IsRunning) | ||
| { | ||
| throw new InvalidOperationException("Can only remove class factories when server is not running."); | ||
| } | ||
|
|
||
| if (!factories.TryGetValue(clsid, out (BaseClassFactory factory, uint cookie) data)) | ||
| { | ||
| return false; | ||
| } | ||
| factories.Remove(clsid); | ||
|
|
||
| data.factory.InstanceCreated -= Factory_InstanceCreated; | ||
|
|
||
| CoRevokeClassObject(data.cookie).ThrowOnFailure(); | ||
| return true; | ||
| } | ||
|
|
||
| private void Factory_InstanceCreated(object? sender, InstanceCreatedEventArgs e) | ||
| { | ||
| if (IsDisposed) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| InstanceCreated?.Invoke(this, e); | ||
| firstInstanceCreated?.TrySetResult(e.Instance); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the server is running. | ||
| /// </summary> | ||
| public bool IsRunning { get; private set; } | ||
|
|
||
| /// <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() | ||
| { | ||
| ObjectDisposedException.ThrowIf(IsDisposed, this); | ||
| if (IsRunning) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| firstInstanceCreated = new(); | ||
| CoResumeClassObjects().ThrowOnFailure(); | ||
| IsRunning = true; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Stops the server. | ||
| /// </summary> | ||
| /// <exception cref="ObjectDisposedException">The instance is disposed.</exception> | ||
| public void Stop() | ||
| { | ||
| ObjectDisposedException.ThrowIf(IsDisposed, this); | ||
| if (!IsRunning) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| firstInstanceCreated = null; | ||
| IsRunning = false; | ||
| CoSuspendClassObjects().ThrowOnFailure(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Wait for the server to have created an object since it was started. | ||
| /// </summary> | ||
| /// <returns>The first object created if the server is running; otherwise <see langword="null"/>.</returns> | ||
| /// <exception cref="ObjectDisposedException">The instance is disposed.</exception> | ||
| public async Task<object?> WaitForFirstObjectAsync() | ||
| { | ||
| ObjectDisposedException.ThrowIf(IsDisposed, this); | ||
|
|
||
| TaskCompletionSource<object>? local = firstInstanceCreated; | ||
| if (local is null) | ||
| { | ||
| return null; | ||
| } | ||
| return await local.Task.ConfigureAwait(false); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the instance is disposed. | ||
| /// </summary> | ||
| public bool IsDisposed | ||
| { | ||
| get; | ||
| private set; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Force the server to stop and release all resources. | ||
| /// </summary> | ||
| public void Dispose() | ||
| { | ||
| if (!IsDisposed) | ||
| { | ||
| try | ||
| { | ||
| _ = CoSuspendClassObjects(); | ||
|
|
||
| IsRunning = false; | ||
|
|
||
| foreach (var clsid in factories.Keys) | ||
| { | ||
| _ = UnregisterClassFactory(clsid); | ||
| } | ||
| } | ||
| finally | ||
| { | ||
| IsDisposed = true; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Occurs when the server creates an object. | ||
| /// </summary> | ||
| public event EventHandler<InstanceCreatedEventArgs>? InstanceCreated; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should really think about what actual namespace names to use. And type names.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's your suggestion?