Changeset 97764 in vbox for trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibDragAndDrop.cpp

Timestamp:

Dec 8, 2022 3:47:13 PM (2 years ago)

Author:

vboxsync

Message:

DnD: Renamed the VbglR3 event name VBGLR3DNDEVENTTYPE_HG_CANCEL -> VBGLR3DNDEVENTTYPE_CANCEL, to emphasize that this is an event for both directions (host -> guest / guest -> host). Fixed a memory leak in vbglR3DnDHGRecvDataMain().

File:

• trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibDragAndDrop.cpp (modified) (9 diffs)

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

@@ -401 +401 @@
  *
  * @returns IPRT status code.
+ * @retval  VERR_CANCELLED if the transfer was cancelled by the host.
  * @param   pCtx                DnD context to use.
  * @param   pDataHdr            DnD data header to use. Needed for accounting.
@@ -657 +658 @@
     if (RT_FAILURE(rc))
     {
-        LogRel(("DnD: Receiving URI data failed with %Rrc\n", rc));
+        if (rc == VERR_CANCELLED)
+            LogRel2(("DnD: Receiving URI data was cancelled by the host\n"));
+        else
+            LogRel(("DnD: Receiving URI data failed with %Rrc\n", rc));
 
         DnDTransferObjectDestroy(&objCur);
@@ -864 +868 @@
  * Main function for receiving the actual DnD data from the host.
  *
- * @returns IPRT status code.
+ * @returns VBox status code.
+ * @retval  VERR_CANCELLED if cancelled by the host.
  * @param   pCtx                DnD context to use.
  * @param   pMeta               Where to store the actual meta data received from the host.
@@ -885 +890 @@
     void    *pvData = NULL;
     uint64_t cbData = 0;
-
     int rc = vbglR3DnDHGRecvDataLoop(pCtx, &dataHdr, &pvData, &cbData);
     if (RT_SUCCESS(rc))
@@ -944 +948 @@
             pMeta->enmType = VBGLR3GUESTDNDMETADATATYPE_RAW;
         }
+
+        if (pvData)
+            RTMemFree(pvData);
     }
 
@@ -951 +958 @@
     if (RT_FAILURE(rc))
     {
-        if (pvData)
-            RTMemFree(pvData);
-
         if (rc != VERR_CANCELLED)
         {
@@ -1198 +1202 @@
  * protocol actually is working.
  *
- * @returns IPRT status code.
+ * @returns VBox status code.
  * @param   pCtx                DnD context to work with.
  * @param   ppEvent             Next DnD event received on success; needs to be free'd by the client calling
@@ -1324 +1328 @@
                 rc = vbglR3DnDHGRecvCancel(pCtx);
                 if (RT_SUCCESS(rc))
-                    pEvent->enmType = VBGLR3DNDEVENTTYPE_HG_CANCEL;
+                    rc = VERR_CANCELLED; /* Will emit a cancel event below. */
                 break;
             }
@@ -1356 +1360 @@
     if (RT_FAILURE(rc))
     {
-        VbglR3DnDEventFree(pEvent);
-        LogRel(("DnD: Handling message %s (%#x) failed with %Rrc\n", DnDHostMsgToStr(uMsg), uMsg, rc));
-    }
-    else
+        /* Current operation cancelled? Set / overwrite event type and tell the caller. */
+        if (rc == VERR_CANCELLED)
+        {
+            pEvent->enmType = VBGLR3DNDEVENTTYPE_CANCEL;
+            rc              = VINF_SUCCESS; /* Deliver the event to the caller. */
+        }
+        else
+        {
+            VbglR3DnDEventFree(pEvent);
+            LogRel(("DnD: Handling message %s (%#x) failed with %Rrc\n", DnDHostMsgToStr(uMsg), uMsg, rc));
+        }
+    }
+
+    if (RT_SUCCESS(rc))
         *ppEvent = pEvent;
 
+    LogFlowFuncLeaveRC(rc);
     return rc;
 }