Changeset 100541 in vbox for trunk/src/VBox/Additions/WINNT

Timestamp:

Jul 12, 2023 10:55:48 AM (20 months ago)

Author:

vboxsync

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

158355

Message:

Shared Clipboard: Renamed SharedClipboardWinDataObject::CALLBACKS::pfnTransferStart -> pfnTransferBegin + added pfnTransferEnd, added data object callbacks to propagate transfer end status. bugref:9437

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp (modified) (6 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp

@@ -170 +170 @@
 
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
-
 /**
- * @copydoc SharedClipboardWinDataObject::CALLBACKS::pfnTransferStart
+ * @copydoc SharedClipboardWinDataObject::CALLBACKS::pfnTransferBegin
+ *
+ * Called by SharedClipboardWinDataObject::GetData() when the user wants to paste data.
+ * This then requests a new transfer on the host.
  *
  * @thread  Clipboard main thread.
  */
-static DECLCALLBACK(int) vbtrShClDataObjectTransferStartCallback(SharedClipboardWinDataObject::PCALLBACKCTX pCbCtx)
+static DECLCALLBACK(int) vbtrShClDataObjectTransferBeginCallback(SharedClipboardWinDataObject::PCALLBACKCTX pCbCtx)
 {
     LogFlowFuncEnter();
@@ -185 +187 @@
     int rc = VbglR3ClipboardTransferRequest(&pCtx->CmdCtx);
 
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
+ * @copydoc SharedClipboardWinDataObject::CALLBACKS::pfnTransferEnd
+ *
+ * Called by SharedClipboardWinDataObject when the assigned transfer has been ended.
+ *
+ * @thread  Clipboard main thread.
+ */
+static DECLCALLBACK(int) vbtrShClDataObjectTransferEndCallback(SharedClipboardWinDataObject::PCALLBACKCTX pCbCtx,
+                                                               PSHCLTRANSFER pTransfer, int rcTransfer)
+{
+    LogFlowFuncEnter();
+
+    PSHCLCONTEXT pCtx = (PSHCLCONTEXT)pCbCtx->pvUser;
+    AssertPtr(pCtx);
+
+    SHCLTRANSFERSTATUS enmSts;
+
+    switch (rcTransfer)
+    {
+        case VERR_CANCELLED:
+            enmSts = SHCLTRANSFERSTATUS_CANCELED;
+            break;
+
+        default:
+            enmSts =   RT_SUCCESS(rcTransfer)
+                     ? SHCLTRANSFERSTATUS_UNINITIALIZED : SHCLTRANSFERSTATUS_ERROR;
+            break;
+    }
+
+    int rc = VbglR3ClipboardTransferStatusReply(&pCtx->CmdCtx, pTransfer, enmSts,
+                                                enmSts == SHCLTRANSFERSTATUS_ERROR ? rcTransfer : VINF_SUCCESS);
     LogFlowFuncLeaveRC(rc);
     return rc;
@@ -278 +315 @@
 
 /**
- * Cleanup helper function for transfer callbacks.
- *
- * @param   pTransferCtx        Pointer to transfer context that the transfer contains.
- * @param   pTransfer           Pointer to transfer to cleanup.
- */
-static void vbtrShClTransferCallbackCleanup(PSHCLTRANSFERCTX pTransferCtx, PSHCLTRANSFER pTransfer)
-{
-    LogFlowFuncEnter();
-
-    if (!pTransferCtx || !pTransfer)
-        return;
-
-    if (pTransfer->pvUser) /* SharedClipboardWinTransferCtx */
-    {
-        delete pTransfer->pvUser;
-        pTransfer->pvUser = NULL;
-    }
-
-    int rc2 = ShClTransferCtxUnregisterById(pTransferCtx, pTransfer->State.uID);
-    AssertRC(rc2);
-
-    ShClTransferDestroy(pTransfer);
-
-    RTMemFree(pTransfer);
-    pTransfer = NULL;
-}
-
-/**
  * Worker for a reading clipboard from the host.
  *
@@ -384 +393 @@
     AssertPtr(pCtx);
 
-    LogRel2(("Shared Clipboard: Transfer to destination %s\n",
-             rcCompletion == VERR_CANCELLED ? "canceled" : "complete"));
-
-    vbtrShClTransferCallbackCleanup(&pCtx->TransferCtx, pCbCtx->pTransfer);
+    LogRel2(("Shared Clipboard: Transfer %RU16 %s\n",
+             ShClTransferGetID(pCbCtx->pTransfer), rcCompletion == VERR_CANCELLED ? "canceled" : "complete"));
 }
 
@@ -396 +403 @@
     AssertPtr(pCtx);
 
-    LogRel(("Shared Clipboard: Transfer to destination failed with %Rrc\n", rcError));
-
-    vbtrShClTransferCallbackCleanup(&pCtx->TransferCtx, pCbCtx->pTransfer);
+    LogRel(("Shared Clipboard: Transfer %RU16 failed with %Rrc\n", ShClTransferGetID(pCbCtx->pTransfer), rcError));
 }
 
@@ -745 +750 @@
                     SharedClipboardWinDataObject::CALLBACKS Callbacks;
                     RT_ZERO(Callbacks);
-                    Callbacks.pfnTransferStart = vbtrShClDataObjectTransferStartCallback;
+                    Callbacks.pfnTransferBegin = vbtrShClDataObjectTransferBeginCallback;
+                    Callbacks.pfnTransferEnd   = vbtrShClDataObjectTransferEndCallback;
 
                     rc = SharedClipboardWinTransferCreateAndSetDataObject(pWinCtx, pCtx, &Callbacks);