Changeset 102815 in vbox for trunk

Timestamp:

Jan 10, 2024 1:44:29 PM (13 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Added ShClCacheSetMultiple(). bugref:9437

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard.h (modified) (2 diffs)
• src/VBox/GuestHost/SharedClipboard/clipboard-common.cpp (modified) (3 diffs)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -264 +264 @@
  */
 /**
- * A single Shared CLipboard cache entry.
+ * A single Shared Clipboard cache entry.
+ *
+ * One entry marks exactly one clipboard format at a time.
  */
 typedef struct _SHCLCACHEENTRY
@@ -297 +299 @@
 PSHCLCACHEENTRY ShClCacheGet(PSHCLCACHE pCache, SHCLFORMAT uFmt);
 int ShClCacheSet(PSHCLCACHE pCache, SHCLFORMAT uFmt, const void *pvData, size_t cbData);
+int ShClCacheSetMultiple(PSHCLCACHE pCache, SHCLFORMATS uFmts, const void *pvData, size_t cbData);
 /** @}  */
 

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-common.cpp

@@ -1454 +1454 @@
 
 /**
- * Sets data to cache for a specific clipboard format.
+ * Sets data to cache for a specific clipboard format, internal version.
  *
  * @returns VBox status code.
@@ -1462 +1462 @@
  * @param   cbData              Size (in bytes) of data to set.
  */
+DECLINLINE(int) shClCacheSet(PSHCLCACHE pCache, SHCLFORMAT uFmt, const void *pvData, size_t cbData)
+{
+    AssertReturn(uFmt < VBOX_SHCL_FMT_MAX, VERR_INVALID_PARAMETER);
+    AssertReturn(shClCacheEntryIsValid(&pCache->aEntries[uFmt]) == false, VERR_ALREADY_EXISTS);
+
+    return shClCacheEntryInit(&pCache->aEntries[uFmt], pvData, cbData);
+}
+
+/**
+ * Sets data to cache for a specific clipboard format.
+ *
+ * @returns VBox status code.
+ * @param   pCache              Cache to set data for.
+ * @param   uFmt                Clipboard format to set data for.
+ * @param   pvData              Data to set.
+ * @param   cbData              Size (in bytes) of data to set.
+ */
 int ShClCacheSet(PSHCLCACHE pCache, SHCLFORMAT uFmt, const void *pvData, size_t cbData)
 {
@@ -1470 +1487 @@
 
     AssertReturn(cbData, VERR_INVALID_PARAMETER);
-    AssertReturn(uFmt < VBOX_SHCL_FMT_MAX, VERR_INVALID_PARAMETER);
-    AssertReturn(shClCacheEntryIsValid(&pCache->aEntries[uFmt]) == false, VERR_ALREADY_EXISTS);
-
-    return shClCacheEntryInit(&pCache->aEntries[uFmt], pvData, cbData);
-}
-
+
+    return shClCacheSet(pCache, uFmt, pvData, cbData);
+}
+
+/**
+ * Sets data to cache for multiple clipboard formats.
+ *
+ * Will bail out if a given format cannot be handled with the data given.
+ *
+ * @returns VBox status code.
+ * @param   pCache              Cache to set data for.
+ * @param   uFmt                Clipboard format to set data for.
+ * @param   pvData              Data to set.
+ * @param   cbData              Size (in bytes) of data to set.
+ */
+int ShClCacheSetMultiple(PSHCLCACHE pCache, SHCLFORMATS uFmts, const void *pvData, size_t cbData)
+{
+    AssertPtrReturn(pCache, VERR_INVALID_POINTER);
+
+    if (!pvData) /* Nothing to cache? */
+        return VINF_SUCCESS;
+
+    AssertReturn(cbData, VERR_INVALID_PARAMETER);
+
+    int rc = VINF_SUCCESS;
+
+    SHCLFORMATS uFmtsLeft = uFmts;
+    while (uFmtsLeft)
+    {
+        SHCLFORMAT  uFmt        = VBOX_SHCL_FMT_NONE;
+         void *pvConv = NULL;
+        size_t cbConv = 0;
+        if (uFmtsLeft & VBOX_SHCL_FMT_UNICODETEXT)
+        {
+            uFmt = VBOX_SHCL_FMT_UNICODETEXT;
+
+            rc = RTStrValidateEncoding((const char *)pvData);
+            if (RT_SUCCESS(rc))
+            {
+                rc = RTStrToUtf16((const char *)pvData, (PRTUTF16 *)&pvConv);
+                if (RT_SUCCESS(rc))
+                    cbConv = (RTUtf16Len((const PRTUTF16)pvConv) + 1) * sizeof(RTUTF16);
+            }
+            else if (!RTUtf16ValidateEncoding((const PRTUTF16)pvData))
+            {
+                AssertFailedBreakStmt(rc = VERR_INVALID_PARAMETER);
+            }
+        }
+        else if (uFmtsLeft & VBOX_SHCL_FMT_BITMAP)
+            uFmt = VBOX_SHCL_FMT_BITMAP;
+        else if (uFmtsLeft & VBOX_SHCL_FMT_HTML)
+            uFmt = VBOX_SHCL_FMT_HTML;
+        else if (uFmtsLeft & VBOX_SHCL_FMT_URI_LIST)
+            uFmt = VBOX_SHCL_FMT_URI_LIST;
+        else
+            AssertFailedBreakStmt(rc = VERR_NOT_SUPPORTED);
+
+        uFmtsLeft &= ~uFmt; /* Remove from list. */
+        Assert(RT_VALID_PTR(pvConv) || cbConv == 0); /* Sanity. */
+
+        if (RT_SUCCESS(rc))
+            rc = shClCacheSet(pCache, uFmt,
+                              pvConv ? pvConv : pvData,
+                              cbConv ? cbConv : cbData);
+        RTMemFree(pvConv);
+        AssertRCBreak(rc);
+    }
+
+    return rc;
+}
+