Changeset 97748 in vbox

Timestamp:

Dec 6, 2022 9:26:48 AM (2 years ago)

Author:

vboxsync

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

154809

Message:

DnD: Renamed GUEST_DND_FN_GH_EVT_ERROR -> GUEST_DND_FN_EVT_ERROR to make this message more generic and not only bound to guest -> host (G->H) transfers. We also need a way to pass back errors for host -> guest (H->G) transfers.

Location:

trunk

Files:

• include/VBox/HostServices/DragAndDropSvc.h (modified) (4 diffs)
• include/VBox/VBoxGuestLib.h (modified) (2 diffs)
• src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.cpp (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibDragAndDrop.cpp (modified) (3 diffs)
• src/VBox/Additions/x11/VBoxClient/draganddrop.cpp (modified) (1 diff)
• src/VBox/GuestHost/DragAndDrop/DnDUtils.cpp (modified) (2 diffs)
• src/VBox/HostServices/DragAndDrop/VBoxDragAndDropSvc.cpp (modified) (4 diffs)

trunk/include/VBox/HostServices/DragAndDropSvc.h ¶

@@ -217 +217 @@
     GUEST_DND_FN_GET_NEXT_HOST_MSG        = 300,
 
+    /** Reports back an error to the host.
+     *
+     *  Note: Don't change the ID to also support older hosts
+     *        (was GUEST_DND_FN_GH_EVT_ERROR before < 7.0, only for G->H transfers).
+     *
+     *        This was changed to GUEST_DND_FN_EVT_ERROR to be a generic event
+     *        that also can be used for H->G transfers.
+     *
+     * @retval  VINF_SUCCESS on success.
+     * @retval  VERR_INVALID_CLIENT_ID
+     * @retval  VERR_WRONG_PARAMETER_COUNT
+     * @retval  VERR_WRONG_PARAMETER_TYPE
+     * @since   7.0.x
+     */
+    GUEST_DND_FN_EVT_ERROR                = 502,
+
     /*
      * Host -> Guest operation messages.
@@ -248 +264 @@
      */
     GUEST_DND_FN_GH_SND_DATA              = 501,
-    /** The guest reports an error back to the host. */
-    GUEST_DND_FN_GH_EVT_ERROR             = 502,
     /** The guest sends a directory entry to the host. */
     GUEST_DND_FN_GH_SND_DIR               = 700,
@@ -936 +950 @@
     CB_MAGIC_DND_CONNECT                   = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_CONNECT, 0),
     CB_MAGIC_DND_REPORT_FEATURES           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_REPORT_FEATURES, 0),
+    CB_MAGIC_DND_EVT_ERROR                 = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_EVT_ERROR, 0),
     CB_MAGIC_DND_HG_GET_NEXT_HOST_MSG      = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GET_NEXT_HOST_MSG, 0),
     CB_MAGIC_DND_HG_ACK_OP                 = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_HG_ACK_OP, 0),
@@ -945 +960 @@
     CB_MAGIC_DND_GH_SND_DIR                = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_DIR, 0),
     CB_MAGIC_DND_GH_SND_FILE_HDR           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_FILE_HDR, 0),
-    CB_MAGIC_DND_GH_SND_FILE_DATA          = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_FILE_DATA, 0),
-    CB_MAGIC_DND_GH_EVT_ERROR              = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_EVT_ERROR, 0)
+    CB_MAGIC_DND_GH_SND_FILE_DATA          = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_FILE_DATA, 0)
 };
 

trunk/include/VBox/VBoxGuestLib.h ¶

@@ -1336 +1336 @@
 
 VBGLR3DECL(int)     VbglR3DnDReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures);
+VBGLR3DECL(int)     VbglR3DnDSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
 
 VBGLR3DECL(int)     VbglR3DnDEventGetNext(PVBGLR3GUESTDNDCMDCTX pCtx, PVBGLR3DNDEVENT *ppEvent);
@@ -1346 +1347 @@
 VBGLR3DECL(int)     VbglR3DnDGHSendAckPending(PVBGLR3GUESTDNDCMDCTX pCtx, VBOXDNDACTION dndActionDefault, VBOXDNDACTIONLIST dndLstActionsAllowed, const char* pcszFormats, uint32_t cbFormats);
 VBGLR3DECL(int)     VbglR3DnDGHSendData(PVBGLR3GUESTDNDCMDCTX pCtx, const char *pszFormat, void *pvData, uint32_t cbData);
-VBGLR3DECL(int)     VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcOp);
 #  endif /* VBOX_WITH_DRAG_AND_DROP_GH */
 /** @} */

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.cpp ¶

@@ -1419 +1419 @@
          * not wait for the data it expects from the guest.
          */
-        int rc2 = VbglR3DnDGHSendError(&m_cmdCtx, rc);
+        int rc2 = VbglR3DnDSendError(&m_cmdCtx, rc);
         AssertRC(rc2);
     }

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

@@ -103 +103 @@
 
     } while (rc == VERR_INTERRUPTED);
+
+    return rc;
+}
+
+
+/**
+ * Sends a DnD error back to the host.
+ *
+ * @returns IPRT status code.
+ * @param   pCtx                DnD context to use.
+ * @param   rcErr               Error (IPRT-style) to send.
+ */
+VBGLR3DECL(int) VbglR3DnDSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcErr)
+{
+    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
+
+    HGCMMsgGHError Msg;
+    VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_DND_FN_EVT_ERROR, 2);
+    /** @todo Context ID not used yet. */
+    Msg.u.v3.uContext.SetUInt32(0);
+    Msg.u.v3.rc.SetUInt32((uint32_t)rcErr); /* uint32_t vs. int. */
+
+    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
+
+    /*
+     * Never return an error if the host did not accept the error at the current
+     * time.  This can be due to the host not having any appropriate callbacks
+     * set which would handle that error.
+     *
+     * bird: Looks like VERR_NOT_SUPPORTED is what the host will return if it
+     *       doesn't an appropriate callback.  The code used to ignore ALL errors
+     *       the host would return, also relevant ones.
+     */
+    if (RT_FAILURE(rc))
+        LogFlowFunc(("Sending error %Rrc failed with rc=%Rrc\n", rcErr, rc));
+    if (rc == VERR_NOT_SUPPORTED)
+        rc = VINF_SUCCESS;
 
     return rc;
@@ -1882 +1919 @@
         if (rc != VERR_CANCELLED)
         {
-            int rc2 = VbglR3DnDGHSendError(pCtx, rc);
+            int rc2 = VbglR3DnDSendError(pCtx, rc);
             if (RT_FAILURE(rc2))
                 LogFlowFunc(("Unable to send error (%Rrc) to host, rc=%Rrc\n", rc, rc2));
@@ -1890 +1927 @@
     return rc;
 }
-
-/**
- * Guest -> Host
- * Send an error back to the host.
- *
- * @returns IPRT status code.
- * @param   pCtx                DnD context to use.
- * @param   rcErr               Error (IPRT-style) to send.
- */
-VBGLR3DECL(int) VbglR3DnDGHSendError(PVBGLR3GUESTDNDCMDCTX pCtx, int rcErr)
-{
-    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
-
-    HGCMMsgGHError Msg;
-    VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_DND_FN_GH_EVT_ERROR, 2);
-    /** @todo Context ID not used yet. */
-    Msg.u.v3.uContext.SetUInt32(0);
-    Msg.u.v3.rc.SetUInt32((uint32_t)rcErr); /* uint32_t vs. int. */
-
-    int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
-
-    /*
-     * Never return an error if the host did not accept the error at the current
-     * time.  This can be due to the host not having any appropriate callbacks
-     * set which would handle that error.
-     *
-     * bird: Looks like VERR_NOT_SUPPORTED is what the host will return if it
-     *       doesn't an appropriate callback.  The code used to ignore ALL errors
-     *       the host would return, also relevant ones.
-     */
-    if (RT_FAILURE(rc))
-        LogFlowFunc(("Sending error %Rrc failed with rc=%Rrc\n", rcErr, rc));
-    if (rc == VERR_NOT_SUPPORTED)
-        rc = VINF_SUCCESS;
-
-    return rc;
-}
 #endif /* VBOX_WITH_DRAG_AND_DROP_GH */
 

trunk/src/VBox/Additions/x11/VBoxClient/draganddrop.cpp ¶

@@ -2566 +2566 @@
     if (RT_FAILURE(rc))
     {
-        int rc2 = VbglR3DnDGHSendError(&m_dndCtx, rc);
+        int rc2 = VbglR3DnDSendError(&m_dndCtx, rc);
         LogFlowThisFunc(("Sending error %Rrc to host resulted in %Rrc\n", rc, rc2)); RT_NOREF(rc2);
         /* This is not fatal for us, just ignore. */

trunk/src/VBox/GuestHost/DragAndDrop/DnDUtils.cpp ¶

@@ -81 +81 @@
         RT_CASE_RET_STR(GUEST_DND_FN_QUERY_FEATURES);
         RT_CASE_RET_STR(GUEST_DND_FN_GET_NEXT_HOST_MSG);
+        RT_CASE_RET_STR(GUEST_DND_FN_EVT_ERROR);
         RT_CASE_RET_STR(GUEST_DND_FN_HG_ACK_OP);
         RT_CASE_RET_STR(GUEST_DND_FN_HG_REQ_DATA);
@@ -87 +88 @@
         RT_CASE_RET_STR(GUEST_DND_FN_GH_SND_DATA_HDR);
         RT_CASE_RET_STR(GUEST_DND_FN_GH_SND_DATA);
-        RT_CASE_RET_STR(GUEST_DND_FN_GH_EVT_ERROR);
         RT_CASE_RET_STR(GUEST_DND_FN_GH_SND_DIR);
         RT_CASE_RET_STR(GUEST_DND_FN_GH_SND_FILE_DATA);

trunk/src/VBox/HostServices/DragAndDrop/VBoxDragAndDropSvc.cpp ¶

@@ -464 +464 @@
         }
 
+        /* New since VBOx 7.0.x. See define for details. */
+        case GUEST_DND_FN_EVT_ERROR:
+        {
+            rc = VINF_SUCCESS;
+            break;
+        }
+
         case GUEST_DND_FN_HG_ACK_OP:
         case GUEST_DND_FN_HG_REQ_DATA:
@@ -482 +489 @@
         case GUEST_DND_FN_GH_SND_FILE_HDR:
         case GUEST_DND_FN_GH_SND_FILE_DATA:
-        case GUEST_DND_FN_GH_EVT_ERROR:
         {
 #ifdef VBOX_WITH_DRAG_AND_DROP_GH
@@ -959 +965 @@
                 break;
             }
-            case GUEST_DND_FN_GH_EVT_ERROR:
+            case GUEST_DND_FN_EVT_ERROR:
             {
                 ASSERT_GUEST_BREAK(cParms >= 1);
@@ -965 +971 @@
                 VBOXDNDCBEVTERRORDATA data;
                 RT_ZERO(data);
-                data.hdr.uMagic = CB_MAGIC_DND_GH_EVT_ERROR;
+                data.hdr.uMagic = CB_MAGIC_DND_EVT_ERROR;
 
                 GET_CONTEXT_ID_PARM0();