Implement Marshal.GetIDispatchForObject on platforms with COM support (#33403)

elinor-fung · web-flow · commit 308ab659f409 · 2020-03-10T12:24:48.000-07:00
diff --git a/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.CoreCLR.cs b/src/coreclr/src/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.CoreCLR.cs
@@ -339,6 +339,17 @@ public static string GetTypeInfoName(ITypeInfo typeInfo)
         [MethodImpl(MethodImplOptions.InternalCall)]
         internal static extern IntPtr /* IUnknown* */ GetRawIUnknownForComObjectNoAddRef(object o);
 
+        /// <summary>
+        /// Return the IDispatch* for an Object.
+        /// </summary>
+        public static IntPtr /* IDispatch */ GetIDispatchForObject(object o)
+        {
+            return GetIDispatchForObjectNative(o, false);
+        }
+
+        [MethodImpl(MethodImplOptions.InternalCall)]
+        private static extern IntPtr /* IDispatch* */ GetIDispatchForObjectNative(object o, bool onlyInContext);
+
         /// <summary>
         /// Return the IUnknown* representing the interface for the Object.
         /// Object o should support Type T
diff --git a/src/coreclr/src/vm/ecalllist.h b/src/coreclr/src/vm/ecalllist.h
@@ -820,6 +820,7 @@ FCFuncStart(gInteropMarshalFuncs)
     FCFuncElement("GetStartComSlot", MarshalNative::GetStartComSlot)
     FCFuncElement("GetEndComSlot", MarshalNative::GetEndComSlot)
     FCFuncElement("GetIUnknownForObjectNative", MarshalNative::GetIUnknownForObjectNative)
+    FCFuncElement("GetIDispatchForObjectNative", MarshalNative::GetIDispatchForObjectNative)
     FCFuncElement("GetComInterfaceForObjectNative", MarshalNative::GetComInterfaceForObjectNative)
     FCFuncElement("InternalReleaseComObject", MarshalNative::ReleaseComObject)
     FCFuncElement("Release", MarshalNative::Release)
diff --git a/src/libraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/ComInvokeBinder.cs b/src/libraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/ComInvokeBinder.cs
@@ -506,7 +506,7 @@ private Expression MakeIDispatchInvokeTarget()
                 Expression.Assign(
                     DispatchPointerVariable,
                     Expression.Call(
-                        ComRuntimeHelpers.GetGetIDispatchForObjectMethod(),
+                        typeof(Marshal).GetMethod(nameof(Marshal.GetIDispatchForObject)),
                         DispatchObjectVariable
                     )
                 )
diff --git a/src/libraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/ComRuntimeHelpers.cs b/src/libraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/ComRuntimeHelpers.cs
@@ -211,12 +211,6 @@ public static DispCallable CreateDispCallable(IDispatchComObject dispatch, ComMe
         {
             return new DispCallable(dispatch, method.Name, method.DispId);
         }
-
-        internal static MethodInfo GetGetIDispatchForObjectMethod()
-        {
-            // GetIDispatchForObject always throws a PNSE in .NET Core, so we work around it by using GetComInterfaceForObject with our IDispatch type.
-            return typeof(Marshal).GetMethods().Single(m => m.Name == nameof(Marshal.GetComInterfaceForObject) && m.GetParameters().Length == 1 && m.ContainsGenericParameters).MakeGenericMethod(typeof(object), typeof(IDispatch));
-        }
     }
 
     /// <summary>
diff --git a/src/libraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/DispatchArgBuilder.cs b/src/libraries/Microsoft.CSharp/src/Microsoft/CSharp/RuntimeBinder/ComInterop/DispatchArgBuilder.cs
@@ -45,7 +45,7 @@ internal override Expression MarshalToRef(Expression parameter)
                 Expression.Equal(parameter, Expression.Constant(null)),
                 Expression.Constant(IntPtr.Zero),
                 Expression.Call(
-                    ComRuntimeHelpers.GetGetIDispatchForObjectMethod(),
+                    typeof(Marshal).GetMethod(nameof(System.Runtime.InteropServices.Marshal.GetIDispatchForObject)),
                     parameter
                 )
             );
diff --git a/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.NoCom.cs b/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.NoCom.cs
@@ -91,6 +91,11 @@ public static IntPtr GetHINSTANCE(Module m)
             return (IntPtr)(-1);
         }
 
+        public static IntPtr GetIDispatchForObject(object o)
+        {
+            throw new PlatformNotSupportedException(SR.PlatformNotSupported_ComInterop);
+        }
+
         public static IntPtr GetIUnknownForObject(object o)
         {
             throw new PlatformNotSupportedException(SR.PlatformNotSupported_ComInterop);
diff --git a/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs b/src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/Marshal.cs
@@ -913,8 +913,6 @@ public static int GetHRForLastWin32Error()
             return (dwLastError & 0x0000FFFF) | unchecked((int)0x80070000);
         }
 
-        public static IntPtr /* IDispatch */ GetIDispatchForObject(object o) => throw new PlatformNotSupportedException();
-
         public static unsafe void ZeroFreeBSTR(IntPtr s)
         {
             if (s == IntPtr.Zero)
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System.Runtime.InteropServices.Tests.csproj b/src/libraries/System.Runtime.InteropServices/tests/System.Runtime.InteropServices.Tests.csproj
@@ -82,6 +82,7 @@
     <Compile Include="System\Runtime\InteropServices\Marshal\GetObjectForIUnknownTests.Windows.cs" Condition="'$(TargetsWindows)' == 'true'" />
     <Compile Include="System\Runtime\InteropServices\Marshal\GetObjectForIUnknownTests.cs" />
     <Compile Include="System\Runtime\InteropServices\Marshal\GetObjectForNativeVariantTests.cs" />
+    <Compile Include="System\Runtime\InteropServices\Marshal\GetObjectForNativeVariantTests.Windows.cs" Condition="'$(TargetsWindows)' == 'true'" />
     <Compile Include="System\Runtime\InteropServices\Marshal\GetObjectsForNativeVariantsTests.cs" />
     <Compile Include="System\Runtime\InteropServices\Marshal\GetStartComSlotTests.cs" />
     <Compile Include="System\Runtime\InteropServices\Marshal\GetStartComSlotTests.Windows.cs" Condition="'$(TargetsWindows)' == 'true'" />
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/DispatchWrapperTests.cs b/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/DispatchWrapperTests.cs
@@ -19,10 +19,20 @@ public void Ctor_Null_Success()
         [Theory]
         [InlineData("")]
         [InlineData(0)]
+        [PlatformSpecific(TestPlatforms.AnyUnix)]
         public void Ctor_NonNull_ThrowsPlatformNotSupportedException(object value)
         {
             Assert.Throws<PlatformNotSupportedException>(() => new DispatchWrapper(value));
         }
+
+        [Theory]
+        [InlineData("")]
+        [InlineData(0)]
+        [PlatformSpecific(TestPlatforms.Windows)]
+        public void Ctor_NonDispatchObject_ThrowsInvalidCastException(object value)
+        {
+            Assert.Throws<InvalidCastException>(() => new DispatchWrapper(value));
+        }
     }
 #pragma warning restore 0618
 }
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetIDispatchForObjectTests.Windows.cs b/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetIDispatchForObjectTests.Windows.cs
@@ -10,7 +10,7 @@ namespace System.Runtime.InteropServices.Tests
 {
     public partial class GetIDispatchForObjectTests
     {
-        public static IEnumerable<object[]> GetIUnknownForObject_ComObject_TestData()
+        public static IEnumerable<object[]> GetIDispatchForObject_ComObject_TestData()
         {
             yield return new object[] { new ComImportObject() };
 
@@ -27,5 +27,20 @@ public static IEnumerable<object[]> GetIUnknownForObject_ComObject_TestData()
             yield return new object[] { new AutoDispatchComObjectEmpty() };
             yield return new object[] { new AutoDualComObjectEmpty() };
         }
+
+        [ConditionalTheory(typeof(PlatformDetection), nameof(PlatformDetection.IsNotWindowsNanoServer))]
+        [MemberData(nameof(GetIDispatchForObject_ComObject_TestData))]
+        public void GetIDispatchForObject_DispatchObject_Success(object obj)
+        {
+            IntPtr ptr = Marshal.GetIDispatchForObject(obj);
+            try
+            {
+                Assert.NotEqual(IntPtr.Zero, ptr);
+            }
+            finally
+            {
+                Marshal.Release(ptr);
+            }
+        }
     }
 }
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetIDispatchForObjectTests.cs b/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetIDispatchForObjectTests.cs
@@ -13,9 +13,24 @@ namespace System.Runtime.InteropServices.Tests
     public partial class GetIDispatchForObjectTests
     {
         [Fact]
+        [PlatformSpecific(TestPlatforms.AnyUnix)]
         public void GetIDispatchForObject_NetCore_ThrowsPlatformNotSupportedException()
         {
             Assert.Throws<PlatformNotSupportedException>(() => Marshal.GetIDispatchForObject(null));
         }
+
+        [Fact]
+        [PlatformSpecific(TestPlatforms.Windows)]
+        public void GetIDispatchForObject_NullObject_ThrowsArgumentNullException()
+        {
+            AssertExtensions.Throws<ArgumentNullException>("o", () => Marshal.GetIDispatchForObject(null));
+        }
+
+        [Fact]
+        [PlatformSpecific(TestPlatforms.Windows)]
+        public void GetIDispatchForObject_NonDispatchObject_ThrowsInvalidCastException()
+        {
+            Assert.Throws<InvalidCastException>(() => Marshal.GetIDispatchForObject(string.Empty));
+        }
     }
 }
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetNativeVariantForObjectTests.Windows.cs b/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetNativeVariantForObjectTests.Windows.cs
@@ -80,21 +80,14 @@ public static IEnumerable<object[]> GetNativeVariantForObject_WrappedComObject_T
             yield return new object[] { new UnknownWrapper(autoDispatch), autoDispatch, VarEnum.VT_UNKNOWN };
             yield return new object[] { new UnknownWrapper(autoDual), autoDual, VarEnum.VT_UNKNOWN };
 
-            if (!PlatformDetection.IsNetCore)
-            {
-                yield return new object[] { new DispatchWrapper(empty), empty, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(dual), dual, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(iUnknown), iUnknown, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(iDispatch), iDispatch, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(iInspectable), iInspectable, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(nonDual), nonDual, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(autoDispatch), autoDispatch, VarEnum.VT_DISPATCH };
-                yield return new object[] { new DispatchWrapper(autoDual), autoDual, VarEnum.VT_DISPATCH };
-            }
-            else
-            {
-                Assert.Throws<PlatformNotSupportedException>(() => new DispatchWrapper(10));
-            }
+            yield return new object[] { new DispatchWrapper(empty), empty, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(dual), dual, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(iUnknown), iUnknown, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(iDispatch), iDispatch, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(iInspectable), iInspectable, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(nonDual), nonDual, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(autoDispatch), autoDispatch, VarEnum.VT_DISPATCH };
+            yield return new object[] { new DispatchWrapper(autoDual), autoDual, VarEnum.VT_DISPATCH };
         }
 
         [ConditionalTheory(typeof(PlatformDetection), nameof(PlatformDetection.IsNotWindowsNanoServer))]
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetObjectForNativeVariantTests.Windows.cs b/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetObjectForNativeVariantTests.Windows.cs
diff --git a/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetObjectForNativeVariantTests.cs b/src/libraries/System.Runtime.InteropServices/tests/System/Runtime/InteropServices/Marshal/GetObjectForNativeVariantTests.cs

Original file line number	Diff line number	Diff line change
`@@ -506,7 +506,7 @@ private Expression MakeIDispatchInvokeTarget()`
`506`	`506`	`Expression.Assign(`
`507`	`507`	`DispatchPointerVariable,`
`508`	`508`	`Expression.Call(`
`509`		`- ComRuntimeHelpers.GetGetIDispatchForObjectMethod(),`
	`509`	`+ typeof(Marshal).GetMethod(nameof(Marshal.GetIDispatchForObject)),`
`510`	`510`	`DispatchObjectVariable`
`511`	`511`	`)`
`512`	`512`	`)`
Original file line number	Diff line number	Diff line change
`@@ -211,12 +211,6 @@ public static DispCallable CreateDispCallable(IDispatchComObject dispatch, ComMe`
`211`	`211`	`{`
`212`	`212`	`return new DispCallable(dispatch, method.Name, method.DispId);`
`213`	`213`	`}`
`214`		`-`
`215`		`- internal static MethodInfo GetGetIDispatchForObjectMethod()`
`216`		`- {`
`217`		`- // GetIDispatchForObject always throws a PNSE in .NET Core, so we work around it by using GetComInterfaceForObject with our IDispatch type.`
`218`		`- return typeof(Marshal).GetMethods().Single(m => m.Name == nameof(Marshal.GetComInterfaceForObject) && m.GetParameters().Length == 1 && m.ContainsGenericParameters).MakeGenericMethod(typeof(object), typeof(IDispatch));`
`219`		`- }`
`220`	`214`	`}`
`221`	`215`
`222`	`216`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ internal override Expression MarshalToRef(Expression parameter)`
`45`	`45`	`Expression.Equal(parameter, Expression.Constant(null)),`
`46`	`46`	`Expression.Constant(IntPtr.Zero),`
`47`	`47`	`Expression.Call(`
`48`		`- ComRuntimeHelpers.GetGetIDispatchForObjectMethod(),`
	`48`	`+ typeof(Marshal).GetMethod(nameof(System.Runtime.InteropServices.Marshal.GetIDispatchForObject)),`
`49`	`49`	`parameter`
`50`	`50`	`)`
`51`	`51`	`);`
Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,11 @@ public static IntPtr GetHINSTANCE(Module m)`
`91`	`91`	`return (IntPtr)(-1);`
`92`	`92`	`}`
`93`	`93`
	`94`	`+ public static IntPtr GetIDispatchForObject(object o)`
	`95`	`+ {`
	`96`	`+ throw new PlatformNotSupportedException(SR.PlatformNotSupported_ComInterop);`
	`97`	`+ }`
	`98`	`+`
`94`	`99`	`public static IntPtr GetIUnknownForObject(object o)`
`95`	`100`	`{`
`96`	`101`	`throw new PlatformNotSupportedException(SR.PlatformNotSupported_ComInterop);`
Original file line number	Diff line number	Diff line change
`@@ -913,8 +913,6 @@ public static int GetHRForLastWin32Error()`
`913`	`913`	`return (dwLastError & 0x0000FFFF) \| unchecked((int)0x80070000);`
`914`	`914`	`}`
`915`	`915`
`916`		`- public static IntPtr /* IDispatch */ GetIDispatchForObject(object o) => throw new PlatformNotSupportedException();`
`917`		`-`
`918`	`916`	`public static unsafe void ZeroFreeBSTR(IntPtr s)`
`919`	`917`	`{`
`920`	`918`	`if (s == IntPtr.Zero)`
Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,20 @@ public void Ctor_Null_Success()`
`19`	`19`	`[Theory]`
`20`	`20`	`[InlineData("")]`
`21`	`21`	`[InlineData(0)]`
	`22`	`+ [PlatformSpecific(TestPlatforms.AnyUnix)]`
`22`	`23`	`public void Ctor_NonNull_ThrowsPlatformNotSupportedException(object value)`
`23`	`24`	`{`
`24`	`25`	`Assert.Throws<PlatformNotSupportedException>(() => new DispatchWrapper(value));`
`25`	`26`	`}`
	`27`	`+`
	`28`	`+ [Theory]`
	`29`	`+ [InlineData("")]`
	`30`	`+ [InlineData(0)]`
	`31`	`+ [PlatformSpecific(TestPlatforms.Windows)]`
	`32`	`+ public void Ctor_NonDispatchObject_ThrowsInvalidCastException(object value)`
	`33`	`+ {`
	`34`	`+ Assert.Throws<InvalidCastException>(() => new DispatchWrapper(value));`
	`35`	`+ }`
`26`	`36`	`}`
`27`	`37`	`#pragma warning restore 0618`
`28`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ namespace System.Runtime.InteropServices.Tests`
`10`	`10`	`{`
`11`	`11`	`public partial class GetIDispatchForObjectTests`
`12`	`12`	`{`
`13`		`- public static IEnumerable<object[]> GetIUnknownForObject_ComObject_TestData()`
	`13`	`+ public static IEnumerable<object[]> GetIDispatchForObject_ComObject_TestData()`
`14`	`14`	`{`
`15`	`15`	`yield return new object[] { new ComImportObject() };`
`16`	`16`
`@@ -27,5 +27,20 @@ public static IEnumerable<object[]> GetIUnknownForObject_ComObject_TestData()`
`27`	`27`	`yield return new object[] { new AutoDispatchComObjectEmpty() };`
`28`	`28`	`yield return new object[] { new AutoDualComObjectEmpty() };`
`29`	`29`	`}`
	`30`	`+`
	`31`	`+ [ConditionalTheory(typeof(PlatformDetection), nameof(PlatformDetection.IsNotWindowsNanoServer))]`
	`32`	`+ [MemberData(nameof(GetIDispatchForObject_ComObject_TestData))]`
	`33`	`+ public void GetIDispatchForObject_DispatchObject_Success(object obj)`
	`34`	`+ {`
	`35`	`+ IntPtr ptr = Marshal.GetIDispatchForObject(obj);`
	`36`	`+ try`
	`37`	`+ {`
	`38`	`+ Assert.NotEqual(IntPtr.Zero, ptr);`
	`39`	`+ }`
	`40`	`+ finally`
	`41`	`+ {`
	`42`	`+ Marshal.Release(ptr);`
	`43`	`+ }`
	`44`	`+ }`
`30`	`45`	`}`
`31`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,24 @@ namespace System.Runtime.InteropServices.Tests`
`13`	`13`	`public partial class GetIDispatchForObjectTests`
`14`	`14`	`{`
`15`	`15`	`[Fact]`
	`16`	`+ [PlatformSpecific(TestPlatforms.AnyUnix)]`
`16`	`17`	`public void GetIDispatchForObject_NetCore_ThrowsPlatformNotSupportedException()`
`17`	`18`	`{`
`18`	`19`	`Assert.Throws<PlatformNotSupportedException>(() => Marshal.GetIDispatchForObject(null));`
`19`	`20`	`}`
	`21`	`+`
	`22`	`+ [Fact]`
	`23`	`+ [PlatformSpecific(TestPlatforms.Windows)]`
	`24`	`+ public void GetIDispatchForObject_NullObject_ThrowsArgumentNullException()`
	`25`	`+ {`
	`26`	`+ AssertExtensions.Throws<ArgumentNullException>("o", () => Marshal.GetIDispatchForObject(null));`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ [Fact]`
	`30`	`+ [PlatformSpecific(TestPlatforms.Windows)]`
	`31`	`+ public void GetIDispatchForObject_NonDispatchObject_ThrowsInvalidCastException()`
	`32`	`+ {`
	`33`	`+ Assert.Throws<InvalidCastException>(() => Marshal.GetIDispatchForObject(string.Empty));`
	`34`	`+ }`
`20`	`35`	`}`
`21`	`36`	`}`