Changeset 81768 in vbox for trunk/src/VBox/Additions/common

Timestamp:

Nov 11, 2019 4:36:41 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

134559

Message:

Shared Clipboard: Update.

File:

• trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp (modified) (8 diffs)

trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibClipboard.cpp

@@ -211 +211 @@
 
 /**
- * Receives a host request to read clipboard data request from the guest.
+ * Receives a host request to read clipboard data from the guest.
  *
  * @returns VBox status code.
@@ -225 +225 @@
 
     VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID,
-                       VBOX_SHCL_GUEST_FN_MSG_GET, VBOX_SHCL_CPARMS_READ_DATA);
+                       VBOX_SHCL_GUEST_FN_MSG_GET, VBOX_SHCL_CPARMS_READ_DATA_REQ);
 
     Msg.uContext.SetUInt64(VBOX_SHCL_HOST_MSG_READ_DATA);
+    Msg.fFlags.SetUInt32(0);
     Msg.uFormat.SetUInt32(0);
     Msg.cbSize.SetUInt32(0);
@@ -290 +291 @@
  * Reads data from the host clipboard.
  *
+ * Legacy function, do not use anymore.
+ *
  * @returns VBox status code.
  * @retval  VINF_BUFFER_OVERFLOW    If there is more data available than the caller provided buffer space for.
@@ -295 +298 @@
  * @param   idClient        The client id returned by VbglR3ClipboardConnect().
  * @param   fFormat         The format we're requesting the data in.
- * @param   pv              Where to store the data.
- * @param   cb              The size of the buffer pointed to by pv.
- * @param   pcb             The actual size of the host clipboard data. May be larger than cb.
- */
-VBGLR3DECL(int) VbglR3ClipboardReadData(HGCMCLIENTID idClient, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb)
+ * @param   pvData          Where to store the data.
+ * @param   cbData          The size of the buffer pointed to by \a pvData.
+ * @param   pcbRead         The actual size of the host clipboard data. May be larger than \a cbData.
+ */
+VBGLR3DECL(int) VbglR3ClipboardReadData(HGCMCLIENTID idClient, uint32_t fFormat, void *pvData, uint32_t cbData,
+                                        uint32_t *pcbRead)
 {
     VBoxShClReadDataMsg Msg;
 
-    VBGL_HGCM_HDR_INIT(&Msg.hdr, idClient, VBOX_SHCL_GUEST_FN_DATA_READ, VBOX_SHCL_CPARMS_READ_DATA);
-    VbglHGCMParmUInt32Set(&Msg.format, fFormat);
-    VbglHGCMParmPtrSet(&Msg.ptr, pv, cb);
-    VbglHGCMParmUInt32Set(&Msg.size, 0);
-
-    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
-    if (RT_SUCCESS(rc))
-    {
-        uint32_t cbActual;
-        int rc2 = VbglHGCMParmUInt32Get(&Msg.size, &cbActual);
-        if (RT_SUCCESS(rc2))
-        {
-            *pcb = cbActual;
-            if (cbActual > cb)
-                return VINF_BUFFER_OVERFLOW;
-            return rc;
-        }
-        rc = rc2;
-    }
+    LogFlowFuncEnter();
+
+    VBGL_HGCM_HDR_INIT(&Msg.hdr, idClient, VBOX_SHCL_GUEST_FN_DATA_READ, 3);
+
+    VbglHGCMParmUInt32Set(&Msg.u.v0.format, fFormat);
+    VbglHGCMParmPtrSet(&Msg.u.v0.ptr, pvData, cbData);
+    VbglHGCMParmUInt32Set(&Msg.u.v0.size, 0);
+
+    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg.hdr) + sizeof(Msg.u.v0));
+    if (RT_SUCCESS(rc))
+    {
+        uint32_t cbRead;
+        rc = VbglHGCMParmUInt32Get(&Msg.u.v0.size, &cbRead);
+        if (RT_SUCCESS(rc))
+        {
+            LogFlowFunc(("cbRead=%RU32\n", cbRead));
+
+            if (cbRead > cbData)
+                rc = VINF_BUFFER_OVERFLOW;
+
+            *pcbRead = cbRead;
+        }
+    }
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
+ * Reads clipboard data from the host clipboard.
+ *
+ * @returns VBox status code.
+ * @retval  VINF_BUFFER_OVERFLOW    If there is more data available than the caller provided buffer space for.
+ *
+ * @param   pCtx                The command context returned by VbglR3ClipboardConnectEx().
+ * @param   pData               Where to store the clipboard data read.
+ * @param   pcbRead             The actual size of the host clipboard data.
+ */
+VBGLR3DECL(int) VbglR3ClipboardReadDataEx(PVBGLR3SHCLCMDCTX pCtx, PSHCLDATABLOCK pData, uint32_t *pcbRead)
+{
+    AssertPtrReturn(pCtx,  VERR_INVALID_POINTER);
+    AssertPtrReturn(pData, VERR_INVALID_POINTER);
+
+    int rc;
+
+    LogFlowFuncEnter();
+
+    if (pCtx->fUseLegacyProtocol)
+    {
+        rc = VbglR3ClipboardReadData(pCtx->uClientID, pData->uFormat, pData->pvData, pData->cbData, pcbRead);
+    }
+    else
+    {
+        VBoxShClReadDataMsg Msg;
+
+        VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, VBOX_SHCL_GUEST_FN_DATA_READ, VBOX_SHCL_CPARMS_READ_DATA);
+
+        VbglHGCMParmUInt64Set(&Msg.u.v1.uContext, pCtx->uContextID);
+        VbglHGCMParmUInt32Set(&Msg.u.v1.fFlags, 0);
+        VbglHGCMParmUInt32Set(&Msg.u.v1.uFormat, pData->uFormat);
+        VbglHGCMParmUInt32Set(&Msg.u.v1.cbData, pData->cbData);
+        VbglHGCMParmPtrSet(&Msg.u.v1.pvData, pData->pvData, pData->cbData);
+
+        rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg.hdr) + sizeof(Msg.u.v1));
+        if (RT_SUCCESS(rc))
+        {
+            uint32_t cbRead;
+            rc = VbglHGCMParmUInt32Get(&Msg.u.v1.cbData, &cbRead);
+            if (RT_SUCCESS(rc))
+            {
+                LogFlowFunc(("cbRead=%RU32\n", cbRead));
+
+                if (cbRead > pData->cbData)
+                    rc = VINF_BUFFER_OVERFLOW;
+
+                *pcbRead = cbRead;
+            }
+        }
+    }
+
+    LogFlowFuncLeaveRC(rc);
     return rc;
 }
@@ -2340 +2406 @@
     VbglHGCMParmUInt32Set(&Msg.u.v0.uFormats, fFormats);
 
-    return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg.hdr) + sizeof(Msg.u.v0));
-}
-
-/**
- * Sends guest clipboard data to the host. Legacy function kept for compatibility, do not use anymore.
+    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg.hdr) + sizeof(Msg.u.v0));
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
+ * Sends guest clipboard data to the host.
+ *
+ * Legacy function kept for compatibility, do not use anymore.
  *
  * This is usually called in reply to a VBOX_SHCL_HOST_MSG_READ_DATA message
@@ -2357 +2428 @@
 VBGLR3DECL(int) VbglR3ClipboardWriteData(HGCMCLIENTID idClient, uint32_t fFormat, void *pv, uint32_t cb)
 {
-    AssertReturn   (idClient, VERR_INVALID_PARAMETER);
-    AssertPtrReturn(pv,       VERR_INVALID_POINTER);
-    AssertReturn   (cb,       VERR_INVALID_PARAMETER);
+    LogFlowFuncEnter();
 
     VBoxShClWriteDataMsg Msg;
@@ -2393 +2462 @@
     int rc;
 
+    LogFlowFuncEnter();
+
     if (pCtx->fUseLegacyProtocol)
     {
@@ -2409 +2480 @@
         Msg.u.v1.uContext.SetUInt64(pCtx->uContextID);
         Msg.u.v1.uFormat.SetUInt32(pData->uFormat);
+        Msg.u.v1.fFlags.SetUInt32(0);
         Msg.u.v1.cbData.SetUInt32(pData->cbData);
         Msg.u.v1.pvData.SetPtr(pData->pvData, pData->cbData);