Convert Rest of Ole to Cswin32 (#10651)

* Add test to capture wrapping behavior * Convert rest of ole to cswin32 * update ComNativeDescriptorTest * Add test and comment capturing clipboard behavior * fix build
dotnet · Jan 18, 2024 · 64528f3 · 64528f3
1 parent 9c5723b
commit 64528f3
Show file tree

Hide file tree

Showing 26 changed files with 516 additions and 814 deletions.
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.CoCreateInstance.cs b/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.CoCreateInstance.cs
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.DoDragDrop.cs b/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.DoDragDrop.cs
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.OleGetClipboard.cs b/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.OleGetClipboard.cs
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.OleSetClipboard.cs b/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.OleSetClipboard.cs
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.ReleaseStgMedium.cs b/src/System.Windows.Forms.Primitives/src/Interop/Ole32/Interop.ReleaseStgMedium.cs
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Shell32/Interop.IDragSourceHelper2.cs b/src/System.Windows.Forms.Primitives/src/Interop/Shell32/Interop.IDragSourceHelper2.cs
diff --git a/src/System.Windows.Forms.Primitives/src/Interop/Shell32/Interop.IDropTargetHelper.cs b/src/System.Windows.Forms.Primitives/src/Interop/Shell32/Interop.IDropTargetHelper.cs
diff --git a/src/System.Windows.Forms.Primitives/src/NativeMethods.json b/src/System.Windows.Forms.Primitives/src/NativeMethods.json
@@ -52,6 +52,12 @@
       "IDispatchEx.GetTypeInfoCount",
       "IDispatchEx.Invoke",
       "IDispatchEx.InvokeEx",
+      "IDragSourceHelper2.SetFlags",
+      "IDragSourceHelper2.InitializeFromBitmap",
+      "IDropTargetHelper.DragEnter",
+      "IDropTargetHelper.DragLeave",
+      "IDropTargetHelper.DragOver",
+      "IDropTargetHelper.Drop",
       "IEnumConnectionPoints.Next",
       "IEnumOLEVERB.Clone",
       "IEnumOLEVERB.Next",
@@ -364,6 +370,11 @@
       "ITypeInfo.ReleaseTypeAttr",
       "ITypeLib.GetLibAttr",
       "ITypeLib.GetTypeInfoOfGuid",
+      "IUIAutomation.GetFocusedElement",
+      "IUIAutomationElement.get_CurrentBoundingRectangle",
+      "IUIAutomationElement.get_CurrentName",
+      "IUIAutomationElement.GetClickablePoint",
+      "IUIAutomationElement.SetFocus",
       "IUnknown.QueryInterface",
       "IValueProvider.get_IsReadOnly",
       "IValueProvider.get_Value",

diff --git a/src/System.Windows.Forms.Primitives/src/NativeMethods.txt b/src/System.Windows.Forms.Primitives/src/NativeMethods.txt
@@ -293,8 +293,10 @@ IDataObject
 IDC_*
 IDispatchEx
 IDropSource
+IDragSourceHelper2
 IDropSourceNotify
 IDropTarget
+IDropTargetHelper
 IEnumFORMATETC
 IEnumOLEVERB
 IEnumString
@@ -414,6 +416,8 @@ ITextProvider
 ITextProvider2
 ITextRangeProvider
 IToggleProvider
+IUIAutomation
+IUIAutomationElement
 IValueProvider
 IVBFormat
 IVBGetControl
@@ -548,7 +552,9 @@ OleCreatePropertyFrame
 OleCreatePropertyFrameIndirect
 OleDuplicateData
 OleFlushClipboard
+OleGetClipboard
 OleInitialize
+OleSetClipboard
 OleUninitialize
 OPEN_FILENAME_FLAGS
 OPEN_FILENAME_FLAGS_EX

diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Control.cs
@@ -14,7 +14,7 @@
 using Windows.Win32.System.Ole;
 using Windows.Win32.UI.Accessibility;
 using Windows.Win32.UI.Input.KeyboardAndMouse;
-using static Interop;
+using Com = Windows.Win32.System.Com;
 using ComTypes = System.Runtime.InteropServices.ComTypes;
 using Encoding = System.Text.Encoding;
 
@@ -5198,12 +5198,44 @@ public DragDropEffects DoDragDrop(object data, DragDropEffects allowedEffects)
     ///   value.
     ///  </para>
     /// </remarks>
-    public DragDropEffects DoDragDrop(
+    public unsafe DragDropEffects DoDragDrop(
         object data,
         DragDropEffects allowedEffects,
         Bitmap? dragImage,
         Point cursorOffset,
         bool useDefaultDragImage)
+    {
+        ComTypes.IDataObject dataObject = PrepareIncomingDragData(data);
+
+        DROPEFFECT finalEffect;
+
+        try
+        {
+            using var dropSource = ComHelpers.GetComScope<IDropSource>(
+                new DropSource(this, dataObject, dragImage, cursorOffset, useDefaultDragImage));
+            using var dataScope = ComHelpers.GetComScope<Com.IDataObject>(dataObject);
+            if (PInvoke.DoDragDrop(dataScope, dropSource, (DROPEFFECT)(uint)allowedEffects, out finalEffect).Failed)
+            {
+                return DragDropEffects.None;
+            }
+        }
+        finally
+        {
+            if (DragDropHelper.IsInDragLoop(dataObject))
+            {
+                DragDropHelper.SetInDragLoop(dataObject, inDragLoop: false);
+            }
+        }
+
+        return (DragDropEffects)finalEffect;
+    }
+
+    /// <summary>
+    ///  Prepares the incoming drag data for consumption.
+    ///  The incoming <paramref name="data"/> should implement <see cref="ComTypes.IDataObject"/> to be taken as is.
+    ///  Otherwise, the data will be wrapped in a <see cref="DataObject"/>.
+    /// </summary>
+    private static ComTypes.IDataObject PrepareIncomingDragData(object data)
     {
         ComTypes.IDataObject dataObject;
 
@@ -5227,25 +5259,7 @@ public DragDropEffects DoDragDrop(
             dataObject = iwdata;
         }
 
-        DROPEFFECT finalEffect;
-
-        try
-        {
-            IDropSource.Interface dropSource = new DropSource(this, dataObject, dragImage, cursorOffset, useDefaultDragImage);
-            if (Ole32.DoDragDrop(dataObject, dropSource, (DROPEFFECT)(uint)allowedEffects, out finalEffect).Failed)
-            {
-                return DragDropEffects.None;
-            }
-        }
-        finally
-        {
-            if (DragDropHelper.IsInDragLoop(dataObject))
-            {
-                DragDropHelper.SetInDragLoop(dataObject, inDragLoop: false);
-            }
-        }
-
-        return (DragDropEffects)finalEffect;
+        return dataObject;
     }
 
     public void DrawToBitmap(Bitmap bitmap, Rectangle targetBounds)

diff --git a/...em.Windows.Forms/src/System/Windows/Forms/Controls/RichTextBox/RichTextBox.OleCallback.cs b/...em.Windows.Forms/src/System/Windows/Forms/Controls/RichTextBox/RichTextBox.OleCallback.cs
@@ -183,7 +183,7 @@ public HRESULT QueryAcceptData(Com.IDataObject* lpdataobj, ushort* lpcfFormat, R
                 if (CanShowImage(e))
                 {
                     UpdateDropDescription(e);
-                    DragDropHelper.DragEnter(_owner.Handle, e);
+                    DragDropHelper.DragEnter(_owner.HWND, e);
                 }
             }
             else

diff --git a/....Windows.Forms/src/System/Windows/Forms/Controls/ToolStrips/ToolStripDropTargetManager.cs b/....Windows.Forms/src/System/Windows/Forms/Controls/ToolStrips/ToolStripDropTargetManager.cs
@@ -290,7 +290,7 @@ private void UpdateDropTarget(IDropTarget? newTarget, DragEventArgs e)
                 if (dragEnterArgs.DropImageType > DropImageType.Invalid && _owner is ToolStrip toolStrip && toolStrip.IsHandleCreated)
                 {
                     DragDropHelper.SetDropDescription(dragEnterArgs);
-                    DragDropHelper.DragEnter(toolStrip.Handle, dragEnterArgs);
+                    DragDropHelper.DragEnter(toolStrip.HWND, dragEnterArgs);
                 }
             }
         }

diff --git a/src/System.Windows.Forms/src/System/Windows/Forms/Controls/ToolStrips/ToolStripItem.cs b/src/System.Windows.Forms/src/System/Windows/Forms/Controls/ToolStrips/ToolStripItem.cs
@@ -7,8 +7,8 @@
 using System.Drawing.Design;
 using System.Drawing.Imaging;
 using System.Windows.Forms.Layout;
+using Com = Windows.Win32.System.Com;
 using Windows.Win32.System.Ole;
-using static Interop;
 using IComDataObject = System.Runtime.InteropServices.ComTypes.IDataObject;
 
 namespace System.Windows.Forms;
@@ -2211,11 +2211,9 @@ public DragDropEffects DoDragDrop(object data, DragDropEffects allowedEffects)
     ///  </para>
     /// </remarks>
     [EditorBrowsable(EditorBrowsableState.Advanced)]
-    public DragDropEffects DoDragDrop(object data, DragDropEffects allowedEffects, Bitmap? dragImage, Point cursorOffset, bool useDefaultDragImage)
+    public unsafe DragDropEffects DoDragDrop(object data, DragDropEffects allowedEffects, Bitmap? dragImage, Point cursorOffset, bool useDefaultDragImage)
     {
-        IComDataObject? dataObject = data as IComDataObject;
-
-        if (dataObject is null)
+        if (data is not IComDataObject dataObject)
         {
             DataObject? iwdata = null;
             if (data is IDataObject idataObject)
@@ -2246,8 +2244,9 @@ public DragDropEffects DoDragDrop(object data, DragDropEffects allowedEffects, B
 
         try
         {
-            IDropSource.Interface dropSource = CreateDropSource(dataObject, dragImage, cursorOffset, useDefaultDragImage);
-            if (Ole32.DoDragDrop(dataObject, dropSource, (DROPEFFECT)(uint)allowedEffects, out finalEffect).Failed)
+            using var dropSource = ComHelpers.GetComScope<IDropSource>(CreateDropSource(dataObject, dragImage, cursorOffset, useDefaultDragImage));
+            using var dataObjectScope = ComHelpers.GetComScope<Com.IDataObject>(dataObject);
+            if (PInvoke.DoDragDrop(dataObjectScope, dropSource, (DROPEFFECT)(uint)allowedEffects, out finalEffect).Failed)
             {
                 return DragDropEffects.None;
             }