Index: /trunk/src/VBox/Additions/x11/VBoxClient/draganddrop.cpp =================================================================== --- /trunk/src/VBox/Additions/x11/VBoxClient/draganddrop.cpp (revision 85919) +++ /trunk/src/VBox/Additions/x11/VBoxClient/draganddrop.cpp (revision 85920) @@ -53,4 +53,8 @@ * For X11 guest Xdnd is used. See http://www.acc.umu.se/~vatten/XDND.html for * a walk trough. + * + * Also useful pages: + * - https://www.freedesktop.org/wiki/Draganddropwarts/ + * - https://www.freedesktop.org/wiki/Specifications/XDNDRevision/ * * Host -> Guest: @@ -86,5 +90,20 @@ */ -#define VBOX_XDND_VERSION (4) +/********************************************************************************************************************************* + * Definitions * + ********************************************************************************************************************************/ + +/** The Xdnd protocol version we support. */ +#define VBOX_XDND_VERSION (5) + +/** Whether the target window accepts the data being dragged over or not. */ +#define VBOX_XDND_STATUS_FLAG_ACCEPT 0x1 +/** Whether the target window wants XdndPosition messages while dragging stuff over it. */ +#define VBOX_XDND_STATUS_FLAG_WANTS_POS 0x2 + +/** Whether the target window accepted the drop data or not. */ +#define VBOX_XDND_FINISHED_FLAG_SUCCEEDED 0x1 + +/** How many X properties our proxy window can hold. */ #define VBOX_MAX_XPROPERTIES (LONG_MAX-1) @@ -218,10 +237,4 @@ #define VBoxDnDAtomList RTCList -/******************************************************************************* - * - * xHelpers Declaration - * - ******************************************************************************/ - class xHelpers { @@ -302,9 +315,7 @@ #define xAtomToString(xa) xHelpers::getInstance()->xAtomToString((xa)) -/******************************************************************************* - * - * xHelpers Implementation - * - ******************************************************************************/ +/********************************************************************************************************************************* + * xHelpers implementation. * + ********************************************************************************************************************************/ xHelpers *xHelpers::m_pInstance = NULL; @@ -418,10 +429,4 @@ } -/******************************************************************************* - * - * DragInstance Declaration - * - ******************************************************************************/ - #ifdef DEBUG # define VBOX_DND_FN_DECL_LOG(x) inline x /* For LogFlowXXX logging. */ @@ -430,5 +435,8 @@ #endif -/** @todo Move all proxy window-related stuff into this class! Clean up this mess. */ +/** + * Class which handles a single drag'n drop proxy window. + ** @todo Move all proxy window-related stuff into this class! Clean up this mess. + */ class VBoxDnDProxyWnd { @@ -570,6 +578,6 @@ /* Atom / HGCM formatting helpers. */ - int toAtomList(const RTCList &lstFormats, VBoxDnDAtomList &lstAtoms) const; - int toAtomList(const void *pvData, uint32_t cbData, VBoxDnDAtomList &lstAtoms) const; + int appendToAtomList(const RTCList &lstFormats, VBoxDnDAtomList &lstAtoms) const; + int appendToAtomList(const void *pvData, uint32_t cbData, VBoxDnDAtomList &lstAtoms) const; static Atom toAtomAction(VBOXDNDACTION dndAction); static int toAtomActions(VBOXDNDACTIONLIST dndActionList, VBoxDnDAtomList &lstAtoms); @@ -627,10 +635,7 @@ }; -/******************************************************************************* - * - * DragAndDropService Declaration - * - ******************************************************************************/ - +/** + * Service class which implements drag'n drop. + */ class DragAndDropService { @@ -677,9 +682,7 @@ }; -/******************************************************************************* - * - * DragInstanc Implementation - * - ******************************************************************************/ +/********************************************************************************************************************************* + * DragInstanc implementation. * + ********************************************************************************************************************************/ DragInstance::DragInstance(Display *pDisplay, DragAndDropService *pParent) @@ -885,7 +888,7 @@ /* Make the new window Xdnd aware. */ - Atom ver = VBOX_XDND_VERSION; + Atom atmVer = VBOX_XDND_VERSION; XChangeProperty(m_pDisplay, m_wndProxy.hWnd, xAtom(XA_XdndAware), XA_ATOM, 32, PropModeReplace, - reinterpret_cast(&ver), 1); + reinterpret_cast(&atmVer), 1); } while (0); @@ -1248,16 +1251,18 @@ * @param e X11 event to handle. */ -int DragInstance::onX11SelectionRequest(const XEvent &e) -{ - AssertReturn(e.type == SelectionRequest, VERR_INVALID_PARAMETER); +int DragInstance::onX11SelectionRequest(const XEvent &evReq) +{ + AssertReturn(evReq.type == SelectionRequest, VERR_INVALID_PARAMETER); + + const XSelectionRequestEvent *pEvReq = &evReq.xselectionrequest; LogFlowThisFunc(("mode=%RU32, state=%RU32\n", m_enmMode, m_enmState)); LogFlowThisFunc(("Event owner=%#x, requestor=%#x, selection=%s, target=%s, prop=%s, time=%u\n", - e.xselectionrequest.owner, - e.xselectionrequest.requestor, - xAtomToString(e.xselectionrequest.selection).c_str(), - xAtomToString(e.xselectionrequest.target).c_str(), - xAtomToString(e.xselectionrequest.property).c_str(), - e.xselectionrequest.time)); + pEvReq->owner, + pEvReq->requestor, + xAtomToString(pEvReq->selection).c_str(), + xAtomToString(pEvReq->target).c_str(), + xAtomToString(pEvReq->property).c_str(), + pEvReq->time)); int rc; @@ -1268,5 +1273,5 @@ rc = VINF_SUCCESS; - char *pszWndName = wndX11GetNameA(e.xselectionrequest.requestor); + char *pszWndName = wndX11GetNameA(pEvReq->requestor); AssertPtr(pszWndName); @@ -1276,15 +1281,16 @@ */ - XEvent s; - RT_ZERO(s); - s.xselection.type = SelectionNotify; - s.xselection.display = e.xselectionrequest.display; - s.xselection.requestor = e.xselectionrequest.requestor; - s.xselection.selection = e.xselectionrequest.selection; - s.xselection.target = e.xselectionrequest.target; - s.xselection.property = None; /* "None" means refusal. */ - s.xselection.time = e.xselectionrequest.time; - - const XSelectionRequestEvent *pReq = &e.xselectionrequest; + XEvent evResp; + RT_ZERO(evResp); + + XSelectionEvent *pEvResp = &evResp.xselection; + + pEvResp->type = SelectionNotify; + pEvResp->display = pEvReq->display; + pEvResp->requestor = pEvReq->requestor; + pEvResp->selection = pEvReq->selection; + pEvResp->target = pEvReq->target; + pEvResp->property = None; /* "None" means refusal. */ + pEvResp->time = pEvReq->time; #ifdef DEBUG @@ -1294,24 +1300,25 @@ #endif /* Is the requestor asking for the possible MIME types? */ - if (pReq->target == xAtom(XA_TARGETS)) + if (pEvReq->target == xAtom(XA_TARGETS)) { - VBClLogInfo("Target window %#x ('%s') asking for target list\n", e.xselectionrequest.requestor, pszWndName); + VBClLogInfo("Target window %#x ('%s') asking for target list\n", pEvReq->requestor, pszWndName); /* If so, set the window property with the formats on the requestor * window. */ - rc = wndXDnDSetFormatList(pReq->requestor, pReq->property, m_lstFormats); + rc = wndXDnDSetFormatList(pEvReq->requestor, pEvReq->property, m_lstFormats); if (RT_SUCCESS(rc)) - s.xselection.property = pReq->property; + pEvResp->property = pEvReq->property; } /* Is the requestor asking for a specific MIME type (we support)? */ - else if (m_lstFormats.contains(pReq->target)) + else if (m_lstFormats.contains(pEvReq->target)) { VBClLogInfo("Target window %#x ('%s') is asking for data as '%s'\n", - pReq->requestor, pszWndName, xAtomToString(pReq->target).c_str()); + pEvReq->requestor, pszWndName, xAtomToString(pEvReq->target).c_str()); /* Did we not drop our stuff to the guest yet? Bail out. */ if (m_enmState != Dropped) { - LogFlowThisFunc(("Wrong state (%RU32), refusing request\n", m_enmState)); + VBClLogError("Data not dropped by the host on the guest yet (client state %RU32, mode %RU32), refusing selection request by guest\n", + m_enmState, m_enmMode); } /* Did we not store the requestor's initial selection request yet? Then do so now. */ @@ -1319,8 +1326,8 @@ { /* Get the data format the requestor wants from us. */ - RTCString strFormat = xAtomToString(pReq->target); + RTCString strFormat = xAtomToString(pEvReq->target); Assert(strFormat.isNotEmpty()); VBClLogInfo("Target window=%#x requested data from host as '%s', rc=%Rrc\n", - pReq->requestor, strFormat.c_str(), rc); + pEvReq->requestor, strFormat.c_str(), rc); /* Make a copy of the MIME data to be passed back. The X server will be become @@ -1331,15 +1338,15 @@ /* Always return the requested property. */ - s.xselection.property = pReq->property; + evResp.xselection.property = pEvReq->property; /* Note: Always seems to return BadRequest. Seems fine. */ - int xRc = XChangeProperty(s.xselection.display, s.xselection.requestor, s.xselection.property, - s.xselection.target, 8, PropModeReplace, + int xRc = XChangeProperty(pEvResp->display, pEvResp->requestor, pEvResp->property, + pEvResp->target, 8, PropModeReplace, reinterpret_cast(pvData), cbData); LogFlowFunc(("Changing property '%s' (target '%s') of window=%RU32: %s\n", - xAtomToString(pReq->property).c_str(), - xAtomToString(pReq->target).c_str(), - pReq->requestor, + xAtomToString(pEvReq->property).c_str(), + xAtomToString(pEvReq->target).c_str(), + pEvReq->requestor, gX11->xErrorToString(xRc).c_str())); RT_NOREF(xRc); @@ -1350,17 +1357,17 @@ { VBClLogError("Refusing unknown command/format '%s' of wnd=%#x ('%s')\n", - xAtomToString(e.xselectionrequest.target).c_str(), pReq->requestor, pszWndName); + xAtomToString(pEvReq->target).c_str(), pEvReq->requestor, pszWndName); rc = VERR_NOT_SUPPORTED; } LogFlowThisFunc(("Offering type '%s', property '%s' to wnd=%#x ...\n", - xAtomToString(pReq->target).c_str(), - xAtomToString(pReq->property).c_str(), pReq->requestor)); - - int xRc = XSendEvent(pReq->display, pReq->requestor, True /* Propagate */, 0, &s); + xAtomToString(pEvReq->target).c_str(), + xAtomToString(pEvReq->property).c_str(), pEvReq->requestor)); + + int xRc = XSendEvent(pEvReq->display, pEvReq->requestor, True /* Propagate */, 0, &evResp); if (xRc == 0) - VBClLogError("Error sending SelectionNotify(1) event to wnd=%#x: %s\n", pReq->requestor, - gX11->xErrorToString(xRc).c_str()); - XFlush(pReq->display); + VBClLogError("Error sending SelectionNotify(1) event to wnd=%#x: %s\n", + pEvReq->requestor, gX11->xErrorToString(xRc).c_str()); + XFlush(pEvReq->display); if (pszWndName) @@ -1397,10 +1404,14 @@ */ case ButtonPress: + RT_FALL_THROUGH(); case ButtonRelease: - LogFlowThisFunc(("Mouse button press/release\n")); + { + VBClLogInfo("Mouse button %s\n", e.type == ButtonPress ? "pressed" : "released"); + + reset(); + rc = VINF_SUCCESS; - - reset(); - break; + break; + } case ClientMessage: @@ -1620,5 +1631,5 @@ break; - rc = toAtomList(lstFormats, m_lstFormats); + rc = appendToAtomList(lstFormats, m_lstFormats); if (RT_FAILURE(rc)) break; @@ -1698,5 +1709,5 @@ { /* Temp stuff for the XGetWindowProperty call. */ - Atom atmp; + Atom atmTmp; int fmt; unsigned long cItems, cbRemaining; @@ -1707,5 +1718,5 @@ xRc = XGetWindowProperty(m_pDisplay, wndCursor, xAtom(XA_XdndAware), 0, 2, False, AnyPropertyType, - &atmp, &fmt, &cItems, &cbRemaining, &pcData); + &atmTmp, &fmt, &cItems, &cbRemaining, &pcData); if (xRc != Success) { @@ -1824,6 +1835,6 @@ * Send a XdndPosition event with the proposed action to the guest. */ - Atom pa = toAtomAction(dndActionDefault); - LogFlowThisFunc(("strAction=%s\n", xAtomToString(pa).c_str())); + Atom atmAction = toAtomAction(dndActionDefault); + LogFlowThisFunc(("strAction=%s\n", xAtomToString(atmAction).c_str())); XClientMessageEvent m; @@ -1835,7 +1846,8 @@ m.format = 32; m.data.l[XdndPositionWindow] = m_wndProxy.hWnd; /* X window ID of source window. */ + m.data.l[XdndPositionFlags] = 0; /* Reserved, set to 0. */ m.data.l[XdndPositionXY] = RT_MAKE_U32(uPosY, uPosX); /* Cursor coordinates relative to the root window. */ m.data.l[XdndPositionTimeStamp] = CurrentTime; /* Timestamp for retrieving data. */ - m.data.l[XdndPositionAction] = pa; /* Actions requested by the user. */ + m.data.l[XdndPositionAction] = atmAction; /* Actions requested by the user. */ xRc = XSendEvent(m_pDisplay, wndCursor, False, NoEventMask, reinterpret_cast(&m)); @@ -2776,6 +2788,4 @@ * @param wndThis Window to set the format list for. * @param lstActions Reference to list of XDnD actions to set. - * - * @remark */ int DragInstance::wndXDnDSetActionList(Window wndThis, const VBoxDnDAtomList &lstActions) const @@ -2814,6 +2824,6 @@ XChangeProperty(m_pDisplay, wndThis, atmProp, XA_ATOM, 32, PropModeReplace, - reinterpret_cast(lstFormatsExt.raw()), - lstFormatsExt.size()); + reinterpret_cast(lstFormats.raw()), + lstFormats.size()); return VINF_SUCCESS; @@ -2821,5 +2831,5 @@ /** - * Converts a RTCString list to VBoxDnDAtomList list. + * Appends a RTCString list to VBoxDnDAtomList list. * * @returns IPRT status code. @@ -2827,5 +2837,5 @@ * @param lstAtoms Reference to VBoxDnDAtomList list to store results in. */ -int DragInstance::toAtomList(const RTCList &lstFormats, VBoxDnDAtomList &lstAtoms) const +int DragInstance::appendToAtomList(const RTCList &lstFormats, VBoxDnDAtomList &lstAtoms) const { for (size_t i = 0; i < lstFormats.size(); ++i) @@ -2836,5 +2846,5 @@ /** - * Converts a raw-data string list to VBoxDnDAtomList list. + * Appends a raw-data string list to VBoxDnDAtomList list. * * @returns IPRT status code. @@ -2843,5 +2853,5 @@ * @param lstAtoms Reference to VBoxDnDAtomList list to store results in. */ -int DragInstance::toAtomList(const void *pvData, uint32_t cbData, VBoxDnDAtomList &lstAtoms) const +int DragInstance::appendToAtomList(const void *pvData, uint32_t cbData, VBoxDnDAtomList &lstAtoms) const { RT_NOREF1(lstAtoms); @@ -2952,7 +2962,7 @@ } -/******************************************************************************* - * VBoxDnDProxyWnd implementation. - ******************************************************************************/ +/********************************************************************************************************************************* + * VBoxDnDProxyWnd implementation. * + ********************************************************************************************************************************/ VBoxDnDProxyWnd::VBoxDnDProxyWnd(void) @@ -3020,7 +3030,7 @@ } -/******************************************************************************* - * DragAndDropService implementation. - ******************************************************************************/ +/********************************************************************************************************************************* + * DragAndDropService implementation. * + ********************************************************************************************************************************/ /** @@ -3448,22 +3458,4 @@ XNextEvent(pThis->m_pDisplay, &e.x11); { -#ifdef DEBUG - switch (e.x11.type) - { - case ClientMessage: - { - XClientMessageEvent *pEvent = reinterpret_cast(&e); - AssertPtr(pEvent); - - RTCString strType = xAtomToString(pEvent->message_type); - LogFlowFunc(("ClientMessage: %s from wnd=%#x\n", strType.c_str(), pEvent->window)); - break; - } - - default: - LogFlowFunc(("Received X event type=%d\n", e.x11.type)); - break; - } -#endif /* At the moment we only have one drag instance. */ DragInstance *pInstance = pThis->m_pCurDnD;