Add support for custom clipboard formats

osu.Framework.Android/AndroidClipboard.cs

@@ -1,7 +1,9 @@
 // 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 Android.Content;
+using NuGet.Packaging;
 using osu.Framework.Platform;
 using SixLabors.ImageSharp;
 
@@ -10,6 +12,7 @@ namespace osu.Framework.Android
     public class AndroidClipboard : Clipboard
     {
         private readonly ClipboardManager? clipboardManager;
+        private readonly Dictionary<string, string> customFormatValues = new Dictionary<string, string>();
 
         public AndroidClipboard(AndroidGameView view)
         {
@@ -18,14 +21,35 @@ public AndroidClipboard(AndroidGameView view)
 
         public override string? GetText() => clipboardManager?.PrimaryClip?.GetItemAt(0)?.Text;
 
-        public override void SetText(string text)
+        public override Image<TPixel>? GetImage<TPixel>() => null;
+
+        public override bool SetData(ClipboardData data)
         {
-            if (clipboardManager != null)
-                clipboardManager.PrimaryClip = ClipData.NewPlainText(null, text);
-        }
+            if (clipboardManager == null)
+                return false;
 
-        public override Image<TPixel>? GetImage<TPixel>() => null;
+            customFormatValues.Clear();
+            clipboardManager.PrimaryClip = null;
+
+            if (data.IsEmpty())
+                return false;
+
+            bool success = true;
+
+            if (data.Text != null)
+                clipboardManager.PrimaryClip = ClipData.NewPlainText(null, data.Text);
 
-        public override bool SetImage(Image image) => false;
+            if (data.Image != null)
+                success = false;
+
+            customFormatValues.AddRange(data.CustomFormatValues);
+
+            return success;
+        }
+
+        public override string? GetCustom(string format)
+        {
+            return customFormatValues[format];
+        }
     }
 }

osu.Framework/Platform/Clipboard.cs

@@ -20,7 +20,10 @@ public abstract class Clipboard
         /// Copy text to the clipboard.
         /// </summary>
         /// <param name="text">Text to copy to the clipboard</param>
-        public abstract void SetText(string text);
+        public void SetText(string text)
+        {
+            SetData(new ClipboardData { Text = text });
+        }
 
         /// <summary>
         /// Retrieve an image from the clipboard.
@@ -33,6 +36,37 @@ public abstract class Clipboard
         /// </summary>
         /// <param name="image">The image to copy to the clipboard</param>
         /// <returns>Whether the image was successfully copied or not</returns>
-        public abstract bool SetImage(Image image);
+        public bool SetImage(Image image)
+        {
+            return SetData(new ClipboardData { Image = image });
+        }
+
+        /// <summary>
+        /// Retrieve content with custom mime type from the clipboard.
+        /// </summary>
+        /// <returns>Mime type of the clipboard item to retrieve</returns>
+        public abstract string? GetCustom(string mimeType);
+
+        /// <summary>
+        /// Copy item with custom mime type to the clipboard
+        /// </summary>
+        /// <param name="mimeType">Mime type of the clipboard item</param>
+        /// <param name="text">Text to copy to the clipboard</param>
+        public void SetCustom(string mimeType, string text)
+        {
+            var data = new ClipboardData
+            {
+                CustomFormatValues = { [mimeType] = text }
+            };
+
+            SetData(data);
+        }
+
+        /// <summary>
+        /// Copy multiple values to the clipboard
+        /// </summary>
+        /// <param name="data">Data to copy the clipboard</param>
+        /// <returns>Whether the data was successfully copied or not</returns>
+        public abstract bool SetData(ClipboardData data);
     }
 }

osu.Framework/Platform/ClipboardData.cs

@@ -0,0 +1,44 @@
+// 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 concurrent representations of some data to 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>
+        /// Contains values to be stored with custom mime type in the clipboard.
+        /// Keyed by mime type.
+        /// </summary>
+        public readonly Dictionary<string, string> CustomFormatValues = new Dictionary<string, string>();
+
+        public ClipboardData()
+        {
+            Text = null;
+            Image = null;
+        }
+
+        /// <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

@@ -1,6 +1,8 @@
 // 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 NuGet.Packaging;
 using SixLabors.ImageSharp;
 
 namespace osu.Framework.Platform
@@ -15,21 +17,25 @@ public class HeadlessClipboard : Clipboard
     {
         private string? clipboardText;
         private Image? clipboardImage;
+        private readonly Dictionary<string, string> customValues = new Dictionary<string, string>();
 
         public override string? GetText() => clipboardText;
 
-        public override void SetText(string text)
+        public override Image<TPixel>? GetImage<TPixel>() => clipboardImage?.CloneAs<TPixel>();
+
+        public override string? GetCustom(string mimeType)
         {
-            clipboardImage = null;
-            clipboardText = text;
+            return customValues[mimeType];
         }
 
-        public override Image<TPixel>? GetImage<TPixel>() => clipboardImage?.CloneAs<TPixel>();
-
-        public override bool SetImage(Image image)
+        public override bool SetData(ClipboardData data)
         {
-            clipboardText = null;
-            clipboardImage = image;
+            clipboardText = data.Text;
+            clipboardImage = data.Image;
+            customValues.Clear();
+
+            customValues.AddRange(data.CustomFormatValues);
+
             return true;
         }
     }

osu.Framework/Platform/MacOS/MacOSClipboard.cs

@@ -2,6 +2,8 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using System;
+using System.Collections.Generic;
+using NuGet.Packaging;
 using osu.Framework.Platform.MacOS.Native;
 using SixLabors.ImageSharp;
 
@@ -11,13 +13,16 @@ public class MacOSClipboard : Clipboard
     {
         private readonly NSPasteboard generalPasteboard = NSPasteboard.GeneralPasteboard();
 
+        private readonly Dictionary<string, string> customFormatValues = new Dictionary<string, string>();
+
         public override string? GetText() => Cocoa.FromNSString(getFromPasteboard(Class.Get("NSString")));
 
         public override Image<TPixel>? GetImage<TPixel>() => Cocoa.FromNSImage<TPixel>(getFromPasteboard(Class.Get("NSImage")));
 
-        public override void SetText(string text) => setToPasteboard(Cocoa.ToNSString(text));
-
-        public override bool SetImage(Image image) => setToPasteboard(Cocoa.ToNSImage(image));
+        public override string? GetCustom(string mimeType)
+        {
+            return customFormatValues[mimeType];
+        }
 
         private IntPtr getFromPasteboard(IntPtr @class)
         {
@@ -32,12 +37,29 @@ private IntPtr getFromPasteboard(IntPtr @class)
             return objects?.Length > 0 ? objects[0] : IntPtr.Zero;
         }
 
+        public override bool SetData(ClipboardData data)
+        {
+            generalPasteboard.ClearContents();
+            customFormatValues.Clear();
+
+            bool success = true;
+
+            if (data.Text != null)
+                success &= setToPasteboard(Cocoa.ToNSString(data.Text));
+
+            if (data.Image != null)
+                success &= setToPasteboard(Cocoa.ToNSImage(data.Image));
+
+            customFormatValues.AddRange(data.CustomFormatValues);
+
+            return success;
+        }
+
         private bool setToPasteboard(IntPtr handle)
         {
             if (handle == IntPtr.Zero)
                 return false;
 
-            generalPasteboard.ClearContents();
             generalPasteboard.WriteObjects(NSArray.ArrayWithObject(handle));
             return true;
         }

osu.Framework/Platform/SDL2/SDL2Clipboard.cs

@@ -1,28 +1,48 @@
 // 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 NuGet.Packaging;
 using SDL2;
 using SixLabors.ImageSharp;
 
 namespace osu.Framework.Platform.SDL2
 {
     public class SDL2Clipboard : Clipboard
     {
+        private readonly Dictionary<string, string> customFormatValues = new Dictionary<string, string>();
+
         // SDL cannot differentiate between string.Empty and no text (eg. empty clipboard or an image)
         // doesn't matter as text editors don't really allow copying empty strings.
         // assume that empty text means no text.
         public override string? GetText() => SDL.SDL_HasClipboardText() == SDL.SDL_bool.SDL_TRUE ? SDL.SDL_GetClipboardText() : null;
 
-        public override void SetText(string text) => SDL.SDL_SetClipboardText(text);
-
         public override Image<TPixel>? GetImage<TPixel>()
         {
             return null;
         }
 
-        public override bool SetImage(Image image)
+        public override string? GetCustom(string mimeType)
+        {
+            return customFormatValues[mimeType];
+        }
+
+        public override bool SetData(ClipboardData data)
         {
-            return false;
+            customFormatValues.Clear();
+
+            if (data.IsEmpty())
+                return false;
+
+            if (data.Image != null)
+                return false;
+
+            if (data.Text != null)
+                SDL.SDL_SetClipboardText(data.Text);
+
+            customFormatValues.AddRange(data.CustomFormatValues);
+
+            return true;
         }
     }
 }