-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide support for exposing .NET classes to COM through source gener…
…ation (#83755)
- Loading branch information
1 parent
3a28f6e
commit ce48579
Showing
25 changed files
with
655 additions
and
257 deletions.
There are no files selected for viewing
231 changes: 231 additions & 0 deletions
231
src/libraries/System.Runtime.InteropServices/gen/ComInterfaceGenerator/ComClassGenerator.cs
This file contains 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,231 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.Collections.Immutable; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
|
|
||
| namespace Microsoft.Interop | ||
| { | ||
| [Generator] | ||
| public class ComClassGenerator : IIncrementalGenerator | ||
| { | ||
| private sealed record ComClassInfo(string ClassName, ContainingSyntaxContext ContainingSyntaxContext, ContainingSyntax ClassSyntax, SequenceEqualImmutableArray<string> ImplementedInterfacesNames); | ||
| public void Initialize(IncrementalGeneratorInitializationContext context) | ||
| { | ||
| // Get all types with the [GeneratedComClassAttribute] attribute. | ||
| var attributedClasses = context.SyntaxProvider | ||
| .ForAttributeWithMetadataName( | ||
| TypeNames.GeneratedComClassAttribute, | ||
| static (node, ct) => node is ClassDeclarationSyntax, | ||
| static (context, ct) => | ||
| { | ||
| var type = (INamedTypeSymbol)context.TargetSymbol; | ||
| var syntax = (ClassDeclarationSyntax)context.TargetNode; | ||
| ImmutableArray<string>.Builder names = ImmutableArray.CreateBuilder<string>(); | ||
| foreach (INamedTypeSymbol iface in type.AllInterfaces) | ||
| { | ||
| if (iface.GetAttributes().Any(attr => attr.AttributeClass?.ToDisplayString() == TypeNames.GeneratedComInterfaceAttribute)) | ||
| { | ||
| names.Add(iface.ToDisplayString()); | ||
| } | ||
| } | ||
| return new ComClassInfo( | ||
| type.ToDisplayString(), | ||
| new ContainingSyntaxContext(syntax), | ||
| new ContainingSyntax(syntax.Modifiers, syntax.Kind(), syntax.Identifier, syntax.TypeParameterList), | ||
| new(names.ToImmutable())); | ||
| }); | ||
|
|
||
| var className = attributedClasses.Select(static (info, ct) => info.ClassName); | ||
|
|
||
| var classInfoType = attributedClasses | ||
| .Select(static (info, ct) => new { info.ClassName, info.ImplementedInterfacesNames }) | ||
| .Select(static (info, ct) => GenerateClassInfoType(info.ImplementedInterfacesNames.Array).NormalizeWhitespace()); | ||
|
|
||
| var attribute = attributedClasses | ||
| .Select(static (info, ct) => new { info.ContainingSyntaxContext, info.ClassSyntax }) | ||
| .Select(static (info, ct) => GenerateClassInfoAttributeOnUserType(info.ContainingSyntaxContext, info.ClassSyntax).NormalizeWhitespace()); | ||
|
|
||
| context.RegisterSourceOutput(className.Zip(classInfoType).Zip(attribute), static (context, classInfo) => | ||
| { | ||
| var ((className, classInfoType), attribute) = classInfo; | ||
| StringWriter writer = new(); | ||
| writer.WriteLine(classInfoType.ToFullString()); | ||
| writer.WriteLine(); | ||
| writer.WriteLine(attribute); | ||
| context.AddSource(className, writer.ToString()); | ||
| }); | ||
| } | ||
|
|
||
| private const string ClassInfoTypeName = "ComClassInformation"; | ||
|
|
||
| private static readonly AttributeSyntax s_comExposedClassAttributeTemplate = | ||
| Attribute( | ||
| GenericName(TypeNames.ComExposedClassAttribute) | ||
| .AddTypeArgumentListArguments( | ||
| IdentifierName(ClassInfoTypeName))); | ||
| private static MemberDeclarationSyntax GenerateClassInfoAttributeOnUserType(ContainingSyntaxContext containingSyntaxContext, ContainingSyntax classSyntax) => | ||
| containingSyntaxContext.WrapMemberInContainingSyntaxWithUnsafeModifier( | ||
| TypeDeclaration(classSyntax.TypeKind, classSyntax.Identifier) | ||
| .WithModifiers(classSyntax.Modifiers) | ||
| .WithTypeParameterList(classSyntax.TypeParameters) | ||
| .AddAttributeLists(AttributeList(SingletonSeparatedList(s_comExposedClassAttributeTemplate)))); | ||
| private static ClassDeclarationSyntax GenerateClassInfoType(ImmutableArray<string> implementedInterfaces) | ||
| { | ||
| const string vtablesField = "s_vtables"; | ||
| const string vtablesLocal = "vtables"; | ||
| const string detailsTempLocal = "details"; | ||
| const string countIdentifier = "count"; | ||
| var typeDeclaration = ClassDeclaration(ClassInfoTypeName) | ||
| .AddModifiers( | ||
| Token(SyntaxKind.FileKeyword), | ||
| Token(SyntaxKind.SealedKeyword), | ||
| Token(SyntaxKind.UnsafeKeyword)) | ||
| .AddBaseListTypes(SimpleBaseType(ParseTypeName(TypeNames.IComExposedClass))) | ||
| .AddMembers( | ||
| FieldDeclaration( | ||
| VariableDeclaration( | ||
| PointerType( | ||
| ParseTypeName(TypeNames.System_Runtime_InteropServices_ComWrappers_ComInterfaceEntry)), | ||
| SingletonSeparatedList(VariableDeclarator(vtablesField)))) | ||
| .AddModifiers( | ||
| Token(SyntaxKind.PrivateKeyword), | ||
| Token(SyntaxKind.StaticKeyword), | ||
| Token(SyntaxKind.VolatileKeyword))); | ||
| List<StatementSyntax> vtableInitializationBlock = new() | ||
| { | ||
| // ComInterfaceEntry* vtables = (ComInterfaceEntry*)RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(<ClassInfoTypeName>), sizeof(ComInterfaceEntry) * <numInterfaces>); | ||
| LocalDeclarationStatement( | ||
| VariableDeclaration( | ||
| PointerType( | ||
| ParseTypeName(TypeNames.System_Runtime_InteropServices_ComWrappers_ComInterfaceEntry)), | ||
| SingletonSeparatedList( | ||
| VariableDeclarator(vtablesLocal) | ||
| .WithInitializer(EqualsValueClause( | ||
| CastExpression( | ||
| PointerType( | ||
| ParseTypeName(TypeNames.System_Runtime_InteropServices_ComWrappers_ComInterfaceEntry)), | ||
| InvocationExpression( | ||
| MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, | ||
| ParseTypeName(TypeNames.System_Runtime_CompilerServices_RuntimeHelpers), | ||
| IdentifierName("AllocateTypeAssociatedMemory"))) | ||
| .AddArgumentListArguments( | ||
| Argument(TypeOfExpression(IdentifierName(ClassInfoTypeName))), | ||
| Argument( | ||
| BinaryExpression( | ||
| SyntaxKind.MultiplyExpression, | ||
| SizeOfExpression(ParseTypeName(TypeNames.System_Runtime_InteropServices_ComWrappers_ComInterfaceEntry)), | ||
| LiteralExpression( | ||
| SyntaxKind.NumericLiteralExpression, | ||
| Literal(implementedInterfaces.Length))))))))))), | ||
| // IIUnknownDerivedDetails details; | ||
| LocalDeclarationStatement( | ||
| VariableDeclaration( | ||
| ParseTypeName(TypeNames.IIUnknownDerivedDetails), | ||
| SingletonSeparatedList( | ||
| VariableDeclarator(detailsTempLocal)))) | ||
| }; | ||
| for (int i = 0; i < implementedInterfaces.Length; i++) | ||
| { | ||
| string ifaceName = implementedInterfaces[i]; | ||
|
|
||
| // details = StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(<ifaceName>).TypeHandle); | ||
| vtableInitializationBlock.Add( | ||
| ExpressionStatement( | ||
| AssignmentExpression(SyntaxKind.SimpleAssignmentExpression, | ||
| IdentifierName(detailsTempLocal), | ||
| InvocationExpression( | ||
| MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, | ||
| MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, | ||
| ParseTypeName(TypeNames.StrategyBasedComWrappers), | ||
| IdentifierName("DefaultIUnknownInterfaceDetailsStrategy")), | ||
| IdentifierName("GetIUnknownDerivedDetails")), | ||
| ArgumentList( | ||
| SingletonSeparatedList( | ||
| Argument( | ||
| MemberAccessExpression(SyntaxKind.SimpleMemberAccessExpression, | ||
| TypeOfExpression(ParseName(ifaceName)), | ||
| IdentifierName("TypeHandle"))))))))); | ||
| // vtable[i] = new() { IID = details.Iid, Vtable = details.ManagedVirtualMethodTable }; | ||
| vtableInitializationBlock.Add( | ||
| ExpressionStatement( | ||
| AssignmentExpression(SyntaxKind.SimpleAssignmentExpression, | ||
| ElementAccessExpression( | ||
| IdentifierName(vtablesLocal), | ||
| BracketedArgumentList( | ||
| SingletonSeparatedList( | ||
| Argument( | ||
| LiteralExpression(SyntaxKind.NumericLiteralExpression, Literal(i)))))), | ||
| ImplicitObjectCreationExpression( | ||
| ArgumentList(), | ||
| InitializerExpression(SyntaxKind.ObjectInitializerExpression, | ||
| SeparatedList( | ||
| new ExpressionSyntax[] | ||
| { | ||
| AssignmentExpression( | ||
| SyntaxKind.SimpleAssignmentExpression, | ||
| IdentifierName("IID"), | ||
| MemberAccessExpression( | ||
| SyntaxKind.SimpleMemberAccessExpression, | ||
| IdentifierName(detailsTempLocal), | ||
| IdentifierName("Iid"))), | ||
| AssignmentExpression( | ||
| SyntaxKind.SimpleAssignmentExpression, | ||
| IdentifierName("Vtable"), | ||
| CastExpression( | ||
| IdentifierName("nint"), | ||
| MemberAccessExpression( | ||
| SyntaxKind.SimpleMemberAccessExpression, | ||
| IdentifierName(detailsTempLocal), | ||
| IdentifierName("ManagedVirtualMethodTable")))) | ||
| })))))); | ||
| } | ||
|
|
||
| // s_vtable = vtable; | ||
| vtableInitializationBlock.Add( | ||
| ExpressionStatement( | ||
| AssignmentExpression(SyntaxKind.SimpleAssignmentExpression, | ||
| IdentifierName(vtablesField), | ||
| IdentifierName(vtablesLocal)))); | ||
|
|
||
| BlockSyntax getComInterfaceEntriesMethodBody = Block( | ||
| // count = <count>; | ||
| ExpressionStatement( | ||
| AssignmentExpression(SyntaxKind.SimpleAssignmentExpression, | ||
| IdentifierName(countIdentifier), | ||
| LiteralExpression(SyntaxKind.NumericLiteralExpression, | ||
| Literal(implementedInterfaces.Length)))), | ||
| // if (s_vtable == null) | ||
| // { initializer block } | ||
| IfStatement( | ||
| BinaryExpression(SyntaxKind.EqualsExpression, | ||
| IdentifierName(vtablesField), | ||
| LiteralExpression(SyntaxKind.NullLiteralExpression)), | ||
| Block(vtableInitializationBlock)), | ||
| // return s_vtable; | ||
| ReturnStatement(IdentifierName(vtablesField))); | ||
|
|
||
| typeDeclaration = typeDeclaration.AddMembers( | ||
| // public static unsafe ComWrappers.ComInterfaceDispatch* GetComInterfaceEntries(out int count) | ||
| // { body } | ||
| MethodDeclaration( | ||
| PointerType( | ||
| ParseTypeName(TypeNames.System_Runtime_InteropServices_ComWrappers_ComInterfaceEntry)), | ||
| "GetComInterfaceEntries") | ||
| .AddParameterListParameters( | ||
| Parameter(Identifier(countIdentifier)) | ||
| .WithType(PredefinedType(Token(SyntaxKind.IntKeyword))) | ||
| .AddModifiers(Token(SyntaxKind.OutKeyword))) | ||
| .WithBody(getComInterfaceEntriesMethodBody) | ||
| .AddModifiers(Token(SyntaxKind.PublicKeyword), Token(SyntaxKind.StaticKeyword))); | ||
|
|
||
| return typeDeclaration; | ||
| } | ||
| } | ||
| } |
This file contains 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 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 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
23 changes: 23 additions & 0 deletions
23
...raries/System.Runtime.InteropServices/tests/Ancillary.Interop/ComExposedClassAttribute.cs
This file contains 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,23 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace System.Runtime.InteropServices.Marshalling | ||
| { | ||
| /// <summary> | ||
| /// An attribute to mark this class as a type whose instances should be exposed to COM. | ||
| /// </summary> | ||
| /// <typeparam name="T">The type that provides information about how to expose the attributed type to COM.</typeparam> | ||
| [AttributeUsage(AttributeTargets.Class, Inherited = false)] | ||
| public sealed class ComExposedClassAttribute<T> : Attribute, IComExposedDetails | ||
| where T : IComExposedClass | ||
| { | ||
| /// <inheritdoc /> | ||
| public unsafe ComWrappers.ComInterfaceEntry* GetComInterfaceEntries(out int count) => T.GetComInterfaceEntries(out count); | ||
| } | ||
| } |
Oops, something went wrong.