Simplify the data structures used to represent multiple clipboard values

osu.Framework.Android/AndroidClipboard.cs

@@ -3,6 +3,7 @@
 
 using System.Collections.Generic;
 using Android.Content;
+using NuGet.Packaging;
 using osu.Framework.Platform;
 using SixLabors.ImageSharp;
 
@@ -22,36 +23,26 @@ public AndroidClipboard(AndroidGameView view)
 
         public override Image<TPixel>? GetImage<TPixel>() => null;
 
-        public override bool SetData(params ClipboardEntry[] entries)
+        public override bool SetData(ClipboardData data)
         {
             if (clipboardManager == null)
                 return false;
 
             customFormatValues.Clear();
             clipboardManager.PrimaryClip = null;
 
-            if (entries.Length == 0)
+            if (data.IsEmpty())
                 return false;
 
             bool success = true;
 
-            foreach (var entry in entries)
-            {
-                switch (entry)
-                {
-                    case ClipboardTextEntry textEntry:
-                        clipboardManager.PrimaryClip = ClipData.NewPlainText(null, textEntry.Value);
-                        break;
+            if (data.Text != null)
+                clipboardManager.PrimaryClip = ClipData.NewPlainText(null, data.Text);
 
-                    case ClipboardCustomEntry customEntry:
-                        customFormatValues[customEntry.Format] = customFormatValues[customEntry.Value];
-                        break;
+            if (data.Image != null)
+                success = false;
 
-                    default:
-                        success = false;
-                        break;
-                }
-            }
+            customFormatValues.AddRange(data.CustomFormatValues);
 
             return success;
         }

osu.Framework/Platform/Clipboard.cs

@@ -23,7 +23,10 @@ public abstract class Clipboard
         public void SetText(string text)
         {
             SetData(
-                new ClipboardTextEntry(text)
+                new ClipboardData
+                {
+                    Text = text
+                }
             );
         }
 
@@ -41,7 +44,10 @@ public void SetText(string text)
         public bool SetImage(Image image)
         {
             return SetData(
-                new ClipboardImageEntry(image)
+                new ClipboardData
+                {
+                    Image = image
+                }
             );
         }
 
@@ -58,15 +64,16 @@ public bool SetImage(Image image)
         /// <param name="text">Text to copy to the clipboard</param>
         public void SetCustom(string format, string text)
         {
-            SetData(
-                new ClipboardCustomEntry(format, text)
-            );
+            var data = new ClipboardData();
+            data.AddCustom(format, text);
+
+            SetData(data);
         }
 
         /// <summary>
         /// Copy multiple values to the clipboard
         /// </summary>
-        /// <param name="entries">Entries to copy the clipboard</param>
-        public abstract bool SetData(params ClipboardEntry[] entries);
+        /// <param name="data">Data to copy the clipboard</param>
+        public abstract bool SetData(ClipboardData data);
     }
 }

osu.Framework/Platform/ClipboardData.cs

@@ -0,0 +1,53 @@
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using System.Collections.Generic;
+using SixLabors.ImageSharp;
+
+namespace osu.Framework.Platform
+{
+    /// <summary>
+    /// Holds multiple values that can be copied to the clipboard
+    /// </summary>
+    public struct ClipboardData
+    {
+        /// <summary>
+        /// Text to be stored in the default plaintext format in the clipboard.
+        /// </summary>
+        public string? Text;
+
+        /// <summary>
+        /// Image to be stored in the default image format in the clipboard.
+        /// </summary>
+        public Image? Image;
+
+        /// <summary>
+        /// Values to be stored as custom formats on the clipboard.
+        /// </summary>
+        public readonly Dictionary<string, string> CustomFormatValues = new Dictionary<string, string>();
+
+        public ClipboardData()
+        {
+            Text = null;
+            Image = null;
+        }
+
+        /// <summary>
+        /// Adds a clipboard entry with a custom format
+        /// </summary>
+        /// <param name="format">format of the clipboard entry</param>
+        /// <param name="value">value of the clipboard entry</param>
+        public void AddCustom(string format, string value)
+        {
+            CustomFormatValues[format] = value;
+        }
+
+        /// <summary>
+        /// Returns true if no data is present
+        /// </summary>
+        public bool IsEmpty()
+        {
+            return Text == null && Image == null && CustomFormatValues.Count == 0;
+        }
+    }
+}

osu.Framework/Platform/HeadlessClipboard.cs

@@ -2,6 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System.Collections.Generic;
+using NuGet.Packaging;
 using SixLabors.ImageSharp;
 
 namespace osu.Framework.Platform
@@ -27,29 +28,13 @@ public class HeadlessClipboard : Clipboard
             return customValues[format];
         }
 
-        public override bool SetData(params ClipboardEntry[] entries)
+        public override bool SetData(ClipboardData data)
         {
-            clipboardText = null;
-            clipboardImage = null;
+            clipboardText = data.Text;
+            clipboardImage = data.Image;
             customValues.Clear();
 
-            foreach (var entry in entries)
-            {
-                switch (entry)
-                {
-                    case ClipboardTextEntry textEntry:
-                        clipboardText = textEntry.Value;
-                        break;
-
-                    case ClipboardImageEntry imageEntry:
-                        clipboardImage = imageEntry.Value;
-                        break;
-
-                    case ClipboardCustomEntry customEntry:
-                        customValues[customEntry.Format] = customEntry.Value;
-                        break;
-                }
-            }
+            customValues.AddRange(data.CustomFormatValues);
 
             return true;
         }

osu.Framework/Platform/MacOS/MacOSClipboard.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using NuGet.Packaging;
 using osu.Framework.Platform.MacOS.Native;
 using SixLabors.ImageSharp;
 
@@ -36,30 +37,22 @@ private IntPtr getFromPasteboard(IntPtr @class)
             return objects?.Length > 0 ? objects[0] : IntPtr.Zero;
         }
 
-        public override bool SetData(params ClipboardEntry[] entries)
+        public override bool SetData(ClipboardData data)
         {
             generalPasteboard.ClearContents();
             customFormatValues.Clear();
 
-            foreach (var entry in entries)
-            {
-                switch (entry)
-                {
-                    case ClipboardTextEntry textEntry:
-                        setToPasteboard(Cocoa.ToNSString(textEntry.Value));
-                        break;
+            bool success = true;
 
-                    case ClipboardImageEntry imageEntry:
-                        setToPasteboard(Cocoa.ToNSImage(imageEntry.Value));
-                        break;
+            if (data.Text != null)
+                success &= setToPasteboard(Cocoa.ToNSString(data.Text));
 
-                    case ClipboardCustomEntry customEntry:
-                        customFormatValues[customEntry.Format] = customEntry.Value;
-                        break;
-                }
-            }
+            if (data.Image != null)
+                success &= setToPasteboard(Cocoa.ToNSImage(data.Image));
 
-            return true;
+            customFormatValues.AddRange(data.CustomFormatValues);
+
+            return success;
         }
 
         private bool setToPasteboard(IntPtr handle)

osu.Framework/Platform/SDL2/SDL2Clipboard.cs

@@ -2,7 +2,7 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System.Collections.Generic;
-using System.Linq;
+using NuGet.Packaging;
 using SDL2;
 using SixLabors.ImageSharp;
 
@@ -27,28 +27,20 @@ public class SDL2Clipboard : Clipboard
             return customFormatValues[format];
         }
 
-        public override bool SetData(params ClipboardEntry[] entries)
+        public override bool SetData(ClipboardData data)
         {
             customFormatValues.Clear();
 
-            if (entries.Any(e => e is ClipboardImageEntry))
-            {
+            if (data.IsEmpty())
                 return false;
-            }
-
-            foreach (var entry in entries)
-            {
-                switch (entry)
-                {
-                    case ClipboardTextEntry textEntry:
-                        SDL.SDL_SetClipboardText(textEntry.Value);
-                        break;
-
-                    case ClipboardCustomEntry customEntry:
-                        customFormatValues[customEntry.Format] = customEntry.Value;
-                        break;
-                }
-            }
+
+            if (data.Image != null)
+                return false;
+
+            if (data.Text != null)
+                SDL.SDL_SetClipboardText(data.Text);
+
+            customFormatValues.AddRange(data.CustomFormatValues);
 
             return true;
         }