More OLE related refactoring (#12840)

This makes a number of changes to continue the move of OLE code to Core.

- Move clipboard related switch to Core
- Move CsWin32 definitions to Core
- Rename older PInvokeCore files
- Unnest a few more classes
- Move FeatureSwitchDefinition to FeatureSwitches
- Move JsonData to Core
- Move TypeExtensions to Core

Note that setting `typeof()` to a static actually results in lower perf. `typeof()` gets replaced with a pointer by the JIT.

Author: JeremyKuhne

src/Common/tests/TestUtilities/AppContextSwitchScope.cs

@@ -1,6 +1,8 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.Reflection;
+
 namespace System;
 
 /// <summary>
@@ -18,7 +20,7 @@ public readonly ref struct AppContextSwitchScope
     private readonly bool _originalState;
 
     public AppContextSwitchScope(string switchName, bool enable)
-        : this (switchName, getDefaultValue: null, enable)
+        : this(switchName, getDefaultValue: null, enable)
     {
     }
 
@@ -31,6 +33,7 @@ public AppContextSwitchScope(string switchName, Func<bool>? getDefaultValue, boo
             throw new InvalidOperationException("LocalAppContext switch caching is not disabled.");
         }
 
+        // AppContext won't have any switch value until it is explicitly set.
         if (!AppContext.TryGetSwitch(switchName, out _originalState))
         {
             _originalState = getDefaultValue is not null && getDefaultValue();
@@ -53,4 +56,23 @@ public void Dispose()
             throw new InvalidOperationException($"Could not reset {_switchName} to {_originalState}.");
         }
     }
+
+    /// <summary>
+    ///  Gets the default value for a switch via reflection.
+    /// </summary>
+    public static bool GetDefaultValueForSwitchInAssembly(string switchName, string assemblyName, string typeName)
+    {
+        foreach (Assembly assembly in AppDomain.CurrentDomain.GetAssemblies())
+        {
+            if (assembly.GetName().Name == assemblyName)
+            {
+                Type type = assembly.GetType(typeName)
+                    ?? throw new InvalidOperationException($"Could not find {typeName} type in {assemblyName} assembly.");
+
+                return type.TestAccessor().Dynamic.GetSwitchDefaultValue(switchName);
+            }
+        }
+
+        throw new InvalidOperationException($"Could not find {assemblyName} assembly in the test process.");
+    }
 }

src/Common/tests/TestUtilities/BinaryFormatterInClipboardDragDropScope.cs

@@ -10,7 +10,13 @@ public readonly ref struct BinaryFormatterInClipboardDragDropScope
     public BinaryFormatterInClipboardDragDropScope(bool enable)
     {
         Monitor.Enter(typeof(BinaryFormatterInClipboardDragDropScope));
-        _switchScope = new(AppContextSwitchNames.ClipboardDragDropEnableUnsafeBinaryFormatterSerializationSwitchName, GetDefaultValue, enable);
+        _switchScope = new(
+            AppContextSwitchNames.ClipboardDragDropEnableUnsafeBinaryFormatterSerializationSwitchName,
+            () => AppContextSwitchScope.GetDefaultValueForSwitchInAssembly(
+                AppContextSwitchNames.ClipboardDragDropEnableUnsafeBinaryFormatterSerializationSwitchName,
+                "System.Private.Windows.Core",
+                "System.Private.Windows.CoreAppContextSwitches"),
+            enable);
     }
 
     public void Dispose()
@@ -24,23 +30,4 @@ public void Dispose()
             Monitor.Exit(typeof(BinaryFormatterInClipboardDragDropScope));
         }
     }
-
-    internal static bool GetDefaultValue()
-    {
-        var assemblies = AppDomain.CurrentDomain.GetAssemblies();
-        foreach (var assembly in assemblies)
-        {
-            if (assembly.FullName?.StartsWith("System.Windows.Forms.Primitives,", StringComparison.InvariantCultureIgnoreCase) == true)
-            {
-                var type = assembly.GetType("System.Windows.Forms.Primitives.LocalAppContextSwitches")
-                    ?? throw new InvalidOperationException("Could not find LocalAppContextSwitches type in System.Windows.Forms.Primitives assembly.");
-
-                bool value = type.TestAccessor().CreateDelegate<Func<string, bool>>("GetSwitchDefaultValue")
-                    (AppContextSwitchNames.ClipboardDragDropEnableUnsafeBinaryFormatterSerializationSwitchName);
-                return value;
-            }
-        }
-
-        throw new InvalidOperationException("Could not find System.Windows.Forms.Primitives assembly in the test process.");
-    }
 }

src/Common/tests/TestUtilities/NrbfSerializerInClipboardDragDropScope.cs

@@ -10,7 +10,13 @@ public readonly ref struct NrbfSerializerInClipboardDragDropScope
     public NrbfSerializerInClipboardDragDropScope(bool enable)
     {
         Monitor.Enter(typeof(NrbfSerializerInClipboardDragDropScope));
-        _switchScope = new(AppContextSwitchNames.ClipboardDragDropEnableNrbfSerializationSwitchName, GetDefaultValue, enable);
+        _switchScope = new(
+            AppContextSwitchNames.ClipboardDragDropEnableNrbfSerializationSwitchName,
+            () => AppContextSwitchScope.GetDefaultValueForSwitchInAssembly(
+                AppContextSwitchNames.ClipboardDragDropEnableNrbfSerializationSwitchName,
+                "System.Private.Windows.Core",
+                "System.Private.Windows.CoreAppContextSwitches"),
+            enable);
     }
 
     public void Dispose()
@@ -24,23 +30,4 @@ public void Dispose()
             Monitor.Exit(typeof(NrbfSerializerInClipboardDragDropScope));
         }
     }
-
-    internal static bool GetDefaultValue()
-    {
-        var assemblies = AppDomain.CurrentDomain.GetAssemblies();
-        foreach (var assembly in assemblies)
-        {
-            if (assembly.FullName?.StartsWith("System.Windows.Forms.Primitives,", StringComparison.InvariantCultureIgnoreCase) == true)
-            {
-                var type = assembly.GetType("System.Windows.Forms.Primitives.LocalAppContextSwitches")
-                    ?? throw new InvalidOperationException("Could not find LocalAppContextSwitches type in System.Windows.Forms.Primitives assembly.");
-
-                bool value = type.TestAccessor().CreateDelegate<Func<string, bool>>("GetSwitchDefaultValue")
-                    (AppContextSwitchNames.ClipboardDragDropEnableNrbfSerializationSwitchName);
-                return value;
-            }
-        }
-
-        throw new InvalidOperationException("Could not find System.Windows.Forms.Primitives assembly in the test process.");
-    }
 }

src/System.Private.Windows.Core/src/NativeMethods.txt

@@ -2,13 +2,16 @@ BeginPaint
 BI_COMPRESSION
 BitBlt
 BOOL
-CLIPBRD_E_BAD_DATA
-CLR_*
 CallWindowProc
+CFSTR_DROPDESCRIPTION
+CFSTR_INDRAGLOOP
 CLIPBOARD_FORMAT
+CLIPBRD_E_BAD_DATA
+CLR_*
 CoCreateInstance
 CombineRgn
 CopyImage
+CP_ACP
 CreateBitmap
 CreateCompatibleBitmap
 CreateCompatibleDC
@@ -45,12 +48,18 @@ DISP_E_UNKNOWNLCID
 DISP_E_UNKNOWNNAME
 DISPID_*
 DMORIENT_*
+DoDragDrop
+DragAcceptFiles
 DRAGDROP_E_ALREADYREGISTERED
 DRAGDROP_E_NOTREGISTERED
 DRAGDROP_S_CANCEL
 DRAGDROP_S_DROP
 DRAGDROP_S_USEDEFAULTCURSORS
+DragQueryFile
 DrawIconEx
+DROPDESCRIPTION
+DROPFILES
+DROPIMAGETYPE
 DV_E_*
 E_ABORT
 E_ACCESSDENIED
@@ -73,14 +82,11 @@ FACILITY_CODE
 fdex*
 FDEX_PROP_FLAGS
 FILETIME
-GetCurrentThreadId
-GetSysColorBrush
-GetWindowText
-GetWindowTextLength
 GET_CLASS_LONG_INDEX
 GetClientRect
 GetClipboardFormatName
 GetClipRgn
+GetCurrentThreadId
 GetDC
 GetDCEx
 GetDesktopWindow
@@ -94,12 +100,17 @@ GetObjectType
 GetPaletteEntries
 GetRegionData
 GetStockObject
+GetSysColor
+GetSysColorBrush
 GetSystemDefaultLCID
 GetSystemMetrics
 GetThreadLocale
 GetViewportExtEx
 GetViewportOrgEx
 GetWindowRect
+GetWindowText
+GetWindowTextLength
+GetWindowThreadProcessId
 GlobalAlloc
 GlobalFree
 GlobalLock
@@ -121,7 +132,9 @@ HPROPSHEETPAGE
 HRGN
 HWND
 HWND_*
+IDataObject
 IDI_*
+IDragSourceHelper2
 IEnumUnknown
 IGlobalInterfaceTable
 ImageLockMode
@@ -145,37 +158,47 @@ MonitorFromRect
 MonitorFromWindow
 MONITORINFOEXW
 MONITORINFOF_*
+MultiByteToWideChar
 NONCLIENTMETRICSW
-NS_E_WMP_URLDOWNLOADFAILED
-NS_E_WMP_LOGON_FAILURE
 NS_E_WMP_CANNOT_FIND_FILE
-NS_E_WMP_UNSUPPORTED_FORMAT
 NS_E_WMP_DSHOW_UNSUPPORTED_FORMAT
 NS_E_WMP_INVALID_ASX
+NS_E_WMP_LOGON_FAILURE
+NS_E_WMP_UNSUPPORTED_FORMAT
+NS_E_WMP_URLDOWNLOADFAILED
 NTSTATUS
 OBJ_TYPE
 OBJECT_IDENTIFIER
 OffsetViewportOrgEx
-OLECMDERR_E_DISABLED
-OLECMDERR_E_NOTSUPPORTED
-OLECMDERR_E_UNKNOWNGROUP
 OLE_E_ADVISENOTSUPPORTED
 OLE_E_INVALIDRECT
 OLE_E_NOCONNECTION
 OLE_E_PROMPTSAVECANCELLED
+OLECMDERR_E_DISABLED
+OLECMDERR_E_NOTSUPPORTED
+OLECMDERR_E_UNKNOWNGROUP
 OleCreatePictureIndirect
+OleDuplicateData
+OleFlushClipboard
+OleGetClipboard
+OleInitialize
+OleSetClipboard
+OleUninitialize
 PeekMessage
-PostMessage
 POINTS
+PostMessage
 PRINTDLGEX_FLAGS
 PropVariantClear
 PWSTR
 RealizePalette
 RECT
 REGDB_E_CLASSNOTREG
 RegisterClipboardFormat
+RegisterDragDrop
 ReleaseDC
+ReleaseStgMedium
 RestoreDC
+RevokeDragDrop
 RPC_E_CHANGED_MODE
 RPC_E_DISCONNECTED
 RPC_E_SERVERFAULT
@@ -218,6 +241,7 @@ SystemParametersInfoForDpi
 TYPE_E_BADMODULEKIND
 UNICODE_STRING_MAX_CHARS
 VIEW_E_DRAW
+WideCharToMultiByte
 WIN32_ERROR
 WINCODEC_ERR_*
 WINDOW_LONG_PTR_INDEX

src/System.Windows.Forms/src/misc/CompatibleIComparer.cs renamed to src/System.Private.Windows.Core/src/System/Collections/Specialized/CompatibleIComparer.cs

@@ -0,0 +1,98 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Runtime.CompilerServices;
+using System.Runtime.Serialization.Formatters.Binary;
+
+namespace System.Private.Windows;
+
+// Borrowed from https://github.com/dotnet/runtime/blob/main/src/libraries/Common/src/System/LocalAppContextSwitches.Common.cs
+internal static class CoreAppContextSwitches
+{
+    // Enabling switches in Core is different from Framework. See https://learn.microsoft.com/dotnet/core/runtime-config/
+    // for details on how to set switches.
+    internal const string ClipboardDragDropEnableUnsafeBinaryFormatterSerializationSwitchName = "Windows.ClipboardDragDrop.EnableUnsafeBinaryFormatterSerialization";
+    internal const string ClipboardDragDropEnableNrbfSerializationSwitchName = "Windows.ClipboardDragDrop.EnableNrbfSerialization";
+
+    private static int s_clipboardDragDropEnableUnsafeBinaryFormatterSerialization;
+    private static int s_clipboardDragDropEnableNrbfSerialization;
+
+    private static bool GetCachedSwitchValue(string switchName, ref int cachedSwitchValue)
+    {
+        // The cached switch value has 3 states: 0 - unknown, 1 - true, -1 - false
+        if (cachedSwitchValue < 0)
+        {
+            return false;
+        }
+
+        if (cachedSwitchValue > 0)
+        {
+            return true;
+        }
+
+        return GetSwitchValue(switchName, ref cachedSwitchValue);
+    }
+
+    private static bool GetSwitchValue(string switchName, ref int cachedSwitchValue)
+    {
+        bool hasSwitch = AppContext.TryGetSwitch(switchName, out bool isSwitchEnabled);
+        if (!hasSwitch)
+        {
+            isSwitchEnabled = GetSwitchDefaultValue(switchName);
+        }
+
+        AppContext.TryGetSwitch("TestSwitch.LocalAppContext.DisableCaching", out bool disableCaching);
+        if (!disableCaching)
+        {
+            cachedSwitchValue = isSwitchEnabled ? 1 /*true*/ : -1 /*false*/;
+        }
+        else if (!hasSwitch)
+        {
+            AppContext.SetSwitch(switchName, isSwitchEnabled);
+        }
+
+        return isSwitchEnabled;
+    }
+
+    private static bool GetSwitchDefaultValue(string switchName)
+    {
+        if (switchName == ClipboardDragDropEnableNrbfSerializationSwitchName)
+        {
+            return true;
+        }
+
+        return false;
+    }
+
+    /// <summary>
+    ///  If <see langword="true"/>, then Clipboard and DataObject Get and Set methods will attempts to serialize or deserialize
+    ///  binary formatted content using either <see cref="BinaryFormatter"/> or System.Windows.Forms.BinaryFormat.Deserializer.
+    ///  To use <see cref="BinaryFormatter"/>, application should also opt in into the
+    ///  "System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization" option and reference the out-of-band
+    ///  "System.Runtime.Serialization.Formatters" NuGet package and opt out from using the System.Windows.Forms.BinaryFormat.Deserializer
+    ///  by setting "Windows.ClipboardDragDrop.EnableNrbfSerialization" to <see langword="true"/>
+    /// </summary>
+    public static bool ClipboardDragDropEnableUnsafeBinaryFormatterSerialization
+    {
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        get => GetCachedSwitchValue(ClipboardDragDropEnableUnsafeBinaryFormatterSerializationSwitchName,
+            ref s_clipboardDragDropEnableUnsafeBinaryFormatterSerialization);
+    }
+
+    /// <summary>
+    ///  If <see langword="true"/>, then Clipboard Get methods will prefer System.Windows.Forms.BinaryFormat.Deserializer
+    ///  to deserialize the payload, if needed. If <see langword="false"/>, then <see cref="BinaryFormatter"/> is used
+    ///  to get full compatibility with the downlevel versions of .NET.
+    /// </summary>
+    /// <remarks>
+    ///  <para>
+    ///   This switch has no effect if "Windows.ClipboardDragDrop.EnableUnsafeBinaryFormatterSerialization"
+    ///   is set to <see langword="false"/>.
+    ///  </para>
+    /// </remarks>
+    public static bool ClipboardDragDropEnableNrbfSerialization
+    {
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        get => GetCachedSwitchValue(ClipboardDragDropEnableNrbfSerializationSwitchName, ref s_clipboardDragDropEnableNrbfSerialization);
+    }
+}

src/System.Private.Windows.Core/src/System/Private/Windows/CoreAppContextSwitches.cs

@@ -0,0 +1,18 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace System.Private.Windows;
+
+internal static class FeatureSwitches
+{
+    // Feature switch, when set to false, BinaryFormatter is not supported in trimmed applications.
+    // This field, using the default BinaryFormatter switch, is used to control trim warnings related
+    // to using BinaryFormatter in WinForms trimming. The trimmer will generate a warning when set
+    // to true and will not generate a warning when set to false.
+#if NET9_0_OR_GREATER
+    [FeatureSwitchDefinition("System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization")]
+#endif
+    internal static bool EnableUnsafeBinaryFormatterInNativeObjectSerialization =>
+        !AppContext.TryGetSwitch("System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization", out bool isEnabled)
+        || isEnabled;
+}