Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Enable derived COM interfaces to hide base methods with the new keyword - #101577

Merged
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod
May 6, 2024
Merged

Enable derived COM interfaces to hide base methods with the new keyword#101577
jtschuster merged 7 commits into
dotnet:mainfrom
jtschuster:ComNonOverridingNewMethod

Conversation

@jtschuster

Copy link
Copy Markdown
Member

Fixes#101240

When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.

Test type definitions:
namespaceSharedTypes.ComInterfaces{[GeneratedComInterface][Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]internalpartialinterfaceIHide{intSameMethod();intDifferentMethod();}[GeneratedComInterface][Guid("5293B3B1-4994-425C-803E-A21A5011E077")]internalpartialinterfaceIHide2:IHide{newintSameMethod();intDifferentMethod2();}internalinterfaceUnrelatedInterfaceWithSameMethod{intSameMethod();intDifferentMethod3();}[GeneratedComInterface][Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]internalpartialinterfaceIHide3:IHide2,UnrelatedInterfaceWithSameMethod{newintSameMethod();newintDifferentMethod3();}[GeneratedComClass][Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]/// <summary>/// Implements IHides3 and returns the expected VTable index for each method./// </summary>internalpartialclassHideBaseMethods:IHide3{intIHide.SameMethod()=>3;intIHide.DifferentMethod()=>4;intIHide2.SameMethod()=>5;intIHide2.DifferentMethod2()=>6;intIHide3.SameMethod()=>7;intIHide3.DifferentMethod3()=>8;intUnrelatedInterfaceWithSameMethod.SameMethod()=>-1;intUnrelatedInterfaceWithSameMethod.DifferentMethod3()=>-1;}}
Diff from .NET 8 to this PR
diff --git "before/SharedTypes.ComInterfaces.IHide.cs" "after/SharedTypes.ComInterfaces.IHide.cs"
index bcc1630fa59..62d87df9798 100644
--- "before/SharedTypes.ComInterfaces.IHide.cs"+++ "after/SharedTypes.ComInterfaces.IHide.cs"@@ -1,131 +1,131 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([42, 167, 62, 2, 170, 236, 101, 75, 157, 150, 33, 34, 207, 173, 225, 108]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide>(__this_native);
__invokeRetVal = @this.DifferentMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide), sizeof(void*) * 5);
{
nint v0, v1, v2;
global::System.Runtime.InteropServices.ComWrappers.GetIUnknownImpl(out v0, out v1, out v2);
vtable[0] = (void*)v0;
vtable[1] = (void*)v1;
vtable[2] = (void*)v2;
}
{
vtable[3] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[4] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide
{
}
}
diff --git "before/SharedTypes.ComInterfaces.IHide2.cs" "after/SharedTypes.ComInterfaces.IHide2.cs"
index ba644decff3..cdd1a7ada47 100644
--- "before/SharedTypes.ComInterfaces.IHide2.cs"+++ "after/SharedTypes.ComInterfaces.IHide2.cs"@@ -1,176 +1,156 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([177, 179, 147, 82, 148, 73, 92, 66, 128, 62, 162, 26, 80, 17, 224, 119]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide2
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide2.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide2.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide2.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide2));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod2(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide2 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide2>(__this_native);
__invokeRetVal = @this.DifferentMethod2();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide2), sizeof(void*) * 7);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 5));
}
{
vtable[5] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[6] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod2;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide2
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide2
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
}
}
\ No newline at end of file
diff --git "before/SharedTypes.ComInterfaces.IHide3.cs" "after/SharedTypes.ComInterfaces.IHide3.cs"
index f77cc741db1..d0342b9caa6 100644
--- "before/SharedTypes.ComInterfaces.IHide3.cs"+++ "after/SharedTypes.ComInterfaces.IHide3.cs"@@ -1,218 +1,178 @@
// <auto-generated />
#pragma warning disable CS0612, CS0618
file unsafe class InterfaceInformation : global::System.Runtime.InteropServices.Marshalling.IIUnknownInterfaceType
{
public static global::System.Guid Iid { get; } = new([50, 84, 211, 93, 135, 73, 141, 72, 148, 241, 118, 130, 215, 228, 64, 92]);
private static void** _vtable;
public static void** ManagedVirtualMethodTable => _vtable != null ? _vtable : (_vtable = InterfaceImplementation.CreateManagedVirtualFunctionTable());
}
[global::System.Runtime.InteropServices.DynamicInterfaceCastableImplementationAttribute]
file unsafe partial interface InterfaceImplementation : global::SharedTypes.ComInterfaces.IHide3
{
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()+ int global::SharedTypes.ComInterfaces.IHide3.SameMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[7])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
- new int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()+ int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod3()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[8])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[3])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[4])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int global::SharedTypes.ComInterfaces.IHide3.SameMethod()- {- var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));- int __retVal;- int __invokeRetVal;- {- __invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[5])(__this, &__retVal);- }-- // NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.- global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);- global::System.GC.KeepAlive(this);- return __retVal;- }-
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
int global::SharedTypes.ComInterfaces.IHide3.DifferentMethod2()
{
var(__this, __vtable_native) = ((global::System.Runtime.InteropServices.Marshalling.IUnmanagedVirtualMethodTableProvider)this).GetVirtualMethodTableInfoForKey(typeof(global::SharedTypes.ComInterfaces.IHide3));
int __retVal;
int __invokeRetVal;
{
__invokeRetVal = ((delegate* unmanaged[MemberFunction]<void*, int*, int> )__vtable_native[6])(__this, &__retVal);
}
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
global::System.Runtime.InteropServices.Marshal.ThrowExceptionForHR(__invokeRetVal);
global::System.GC.KeepAlive(this);
return __retVal;
}
int global::SharedTypes.ComInterfaces.IHide.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide.DifferentMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.SameMethod() => throw new global::System.Diagnostics.UnreachableException();
int global::SharedTypes.ComInterfaces.IHide2.DifferentMethod2() => throw new global::System.Diagnostics.UnreachableException();
}
file unsafe partial interface InterfaceImplementation
{
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_SameMethod(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.SameMethod();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
[global::System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute(CallConvs = new[] { typeof(global::System.Runtime.CompilerServices.CallConvMemberFunction) })]
internal static int ABI_DifferentMethod3(global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch* __this_native, int* __invokeRetValUnmanaged__param)
{
global::SharedTypes.ComInterfaces.IHide3 @this = default;
ref int __invokeRetValUnmanaged = ref *__invokeRetValUnmanaged__param;
int __invokeRetVal = default;
int __retVal = default;
try
{
// Unmarshal - Convert native data to managed data.
@this = global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch.GetInstance<global::SharedTypes.ComInterfaces.IHide3>(__this_native);
__invokeRetVal = @this.DifferentMethod3();
// NotifyForSuccessfulInvoke - Keep alive any managed objects that need to stay alive across the call.
__retVal = 0; // S_OK
// Marshal - Convert managed data to native data.
__invokeRetValUnmanaged = __invokeRetVal;
}
catch (global::System.Exception __exception)
{
__retVal = global::System.Runtime.InteropServices.Marshalling.ExceptionAsHResultMarshaller<int>.ConvertToUnmanaged(__exception);
}
return __retVal;
}
}
file unsafe partial interface InterfaceImplementation
{
internal static void** CreateManagedVirtualFunctionTable()
{
void** vtable = (void**)global::System.Runtime.CompilerServices.RuntimeHelpers.AllocateTypeAssociatedMemory(typeof(global::SharedTypes.ComInterfaces.IHide3), sizeof(void*) * 9);
{
global::System.Runtime.InteropServices.NativeMemory.Copy(global::System.Runtime.InteropServices.Marshalling.StrategyBasedComWrappers.DefaultIUnknownInterfaceDetailsStrategy.GetIUnknownDerivedDetails(typeof(global::SharedTypes.ComInterfaces.IHide2).TypeHandle).ManagedVirtualMethodTable, vtable, (nuint)(sizeof(void*) * 7));
}
{
vtable[7] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_SameMethod;
vtable[8] = (void*)(delegate* unmanaged[MemberFunction]<global::System.Runtime.InteropServices.ComWrappers.ComInterfaceDispatch*, int*, int> )&ABI_DifferentMethod3;
}
return vtable;
}
}
namespace SharedTypes.ComInterfaces
{
[global::System.Runtime.InteropServices.Marshalling.IUnknownDerivedAttribute<InterfaceInformation, InterfaceImplementation>]
internal partial interface IHide3
{
}
}
namespace SharedTypes.ComInterfaces
{
internal partial interface IHide3
{
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod() => ((global::SharedTypes.ComInterfaces.IHide)this).DifferentMethod();
- [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]- [global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]- new int SameMethod() => ((global::SharedTypes.ComInterfaces.IHide2)this).SameMethod();
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.Interop.ComInterfaceGenerator", "42.42.42.42")]
[global::System.Runtime.CompilerServices.SkipLocalsInitAttribute]
new int DifferentMethod2() => ((global::SharedTypes.ComInterfaces.IHide2)this).DifferentMethod2();
}
}

@jtschusterjtschuster changed the title Enable derived COM interfaces to hide base methodsEnable derived COM interfaces to hide base methods with the new keywordApr 25, 2024
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

…enerator/ComMethodInfo.cs
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@jtschuster

Copy link
Copy Markdown
MemberAuthor

cc @dotnet/appmodel

michaelgsharp pushed a commit to michaelgsharp/runtime that referenced this pull request May 9, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
Ruihan-Yin pushed a commit to Ruihan-Yin/runtime that referenced this pull request May 30, 2024
…rd (dotnet#101577)
When a COM interface method is defined with the new keyword, we should avoid creating a new shadowing method on the derived interface, and remove the new keyword when creating implementations of methods. This change tracks whether a method was declared with the new keyword. If it was, we search all the inherited methods for one with the same name and signature. If found, we mark that method as "HiddenOnDerivedInterface". The hidden method may not be found if the method hides a non-COM method. When generating methods, we only generate new shadowing method declarations for inherited methods that aren't already hidden, and we don't generate any stubs for inherited hidden methods. The diff for the generated code for the new test interfaces is shown below.
---------
Co-authored-by: Aaron Robinson <arobins@microsoft.com>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jun 6, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GeneratedComInterfaceAttribute can cause CS0108 error with two derived COM interfaces declaring methods with same name and signature

3 participants

@jtschuster@jkoritzinsky@AaronRobinsonMSFT