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

jtschuster · 2024-04-25T22:30:52Z

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:

namespace SharedTypes.ComInterfaces
{
    [GeneratedComInterface]
    [Guid("023EA72A-ECAA-4B65-9D96-2122CFADE16C")]
    internal partial interface IHide
    {
        int SameMethod();
        int DifferentMethod();
    }

    [GeneratedComInterface]
    [Guid("5293B3B1-4994-425C-803E-A21A5011E077")]
    internal partial interface IHide2 : IHide
    {
        new int SameMethod();
        int DifferentMethod2();
    }

    internal interface UnrelatedInterfaceWithSameMethod
    {
        int SameMethod();
        int DifferentMethod3();
    }

    [GeneratedComInterface]
    [Guid("5DD35432-4987-488D-94F1-7682D7E4405C")]
    internal partial interface IHide3 : IHide2, UnrelatedInterfaceWithSameMethod
    {
        new int SameMethod();
        new int DifferentMethod3();
    }

    [GeneratedComClass]
    [Guid("2D36BD6D-C80E-4F00-86E9-8D1B4A0CB59A")]
    /// <summary>
    /// Implements IHides3 and returns the expected VTable index for each method.
    /// </summary>
    internal partial class HideBaseMethods : IHide3
    {
        int IHide.SameMethod() => 3;
        int IHide.DifferentMethod() => 4;
        int IHide2.SameMethod() => 5;
        int IHide2.DifferentMethod2() => 6;
        int IHide3.SameMethod() => 7;
        int IHide3.DifferentMethod3() => 8;
        int UnrelatedInterfaceWithSameMethod.SameMethod() => -1;
        int UnrelatedInterfaceWithSameMethod.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();
     }
 }

dotnet-policy-service · 2024-04-25T22:31:19Z

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

...raries/System.Runtime.InteropServices/tests/ComInterfaceGenerator.Tests/RcwAroundCcwTests.cs

…eGenerator.Tests/RcwAroundCcwTests.cs

src/libraries/System.Runtime.InteropServices/gen/ComInterfaceGenerator/ComMethodInfo.cs

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

src/libraries/System.Runtime.InteropServices/gen/ComInterfaceGenerator/ComMethodInfo.cs

…enerator/ComMethodInfo.cs

…ster/runtime into ComNonOverridingNewMethod

jtschuster · 2024-04-30T18:37:56Z

cc @dotnet/appmodel

…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>

Enable derived COM interfaces to hide base methods

2756017

jtschuster requested review from jkoritzinsky, AaronRobinsonMSFT and elinor-fung April 25, 2024 22:30

dotnet-issue-labeler bot added the area-System.Runtime.InteropServices label Apr 25, 2024

jtschuster changed the title ~~Enable derived COM interfaces to hide base methods~~ Enable derived COM interfaces to hide base methods with the new keyword Apr 25, 2024

dotnet-policy-service bot assigned jtschuster Apr 25, 2024

AaronRobinsonMSFT reviewed Apr 25, 2024

View reviewed changes

...raries/System.Runtime.InteropServices/tests/ComInterfaceGenerator.Tests/RcwAroundCcwTests.cs Outdated Show resolved Hide resolved

Update src/libraries/System.Runtime.InteropServices/tests/ComInterfac…

660e64c

…eGenerator.Tests/RcwAroundCcwTests.cs

AaronRobinsonMSFT reviewed Apr 25, 2024

View reviewed changes

src/libraries/System.Runtime.InteropServices/gen/ComInterfaceGenerator/ComMethodInfo.cs Outdated Show resolved Hide resolved

AaronRobinsonMSFT reviewed Apr 25, 2024

View reviewed changes

src/libraries/System.Runtime.InteropServices/gen/ComInterfaceGenerator/ComMethodInfo.cs Show resolved Hide resolved

This was referenced Apr 26, 2024

WasmTestOnChrome-System.Runtime.Tests.WorkItemExecution fails with exit code 3221226505 #101464

Closed

Dead lettering tests #101524

Closed

[WASI][AOT] LLVM ERROR: out of memory #101533

Closed

Update src/libraries/System.Runtime.InteropServices/gen/ComInterfaceG…

ad45e52

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

jtschuster mentioned this pull request Apr 26, 2024

ComInterfaceGenerator Method/Interface Info/Context types should limit construction and modification #101615

Closed

build-analysis bot mentioned this pull request Apr 26, 2024

Intermittent build failure in AfterSourceBuild: "Could not write state file" #76488

Open

jtschuster commented Apr 26, 2024

View reviewed changes

src/libraries/System.Runtime.InteropServices/gen/ComInterfaceGenerator/ComMethodInfo.cs Outdated Show resolved Hide resolved

Update src/libraries/System.Runtime.InteropServices/gen/ComInterfaceG…

7755f9c

…enerator/ComMethodInfo.cs

build-analysis bot mentioned this pull request Apr 26, 2024

[wasm][firefox] crit: OpenQA.Selenium.WebDriverException: Failed to decode response from marionette #101617

Open

3 tasks

jtschuster added 2 commits April 29, 2024 09:12

Remove extra usings and make snippet type partial

3694cd7

Merge branch 'ComNonOverridingNewMethod' of https://github.com/jtschu…

e1cb878

…ster/runtime into ComNonOverridingNewMethod

build-analysis bot mentioned this pull request Apr 29, 2024

AbbreviatedMonthGenitiveNames_Get_ReturnsExpected_HybridGlobalization failing with string mismatch #101634

Closed

jtschuster requested a review from AaronRobinsonMSFT May 6, 2024 17:11

Merge branch 'main' into ComNonOverridingNewMethod

36a4bd0

jkoritzinsky approved these changes May 6, 2024

View reviewed changes

build-analysis bot mentioned this pull request May 6, 2024

Crash in Microsoft.Extensions.Logging.Generators.Roslyn4.0.Tests.WorkItemExecution #90019

Open

jtschuster merged commit 5bc4a58 into dotnet:main May 6, 2024
91 of 93 checks passed

build-analysis bot mentioned this pull request May 6, 2024

tracing/eventpipe/providervalidation/providervalidation/providervalidation.cmd test failure #101759

Closed

github-actions bot locked and limited conversation to collaborators Jun 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

jtschuster commented Apr 25, 2024

dotnet-policy-service bot commented Apr 25, 2024

jtschuster commented Apr 30, 2024

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

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

Conversation

jtschuster commented Apr 25, 2024

dotnet-policy-service bot commented Apr 25, 2024

jtschuster commented Apr 30, 2024