Changeset 97735 in vbox for trunk/src/VBox/Additions

Timestamp:

Dec 2, 2022 8:39:26 PM (2 years ago)

Author:

vboxsync

Message:

DnD/VBoxClient: Use RT_BIT macros for the Xdnd flags, renamed DnDEvent -> DNDEVENT to emphasize that it's a POD type + some more renaming.

File:

• trunk/src/VBox/Additions/x11/VBoxClient/draganddrop.cpp (modified) (32 diffs)

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

@@ -117 +117 @@
 #define VBOX_XDND_VERSION                       (5)
 
+/** No flags specified. */
+#define VBOX_XDND_STATUS_FLAG_NONE              0
 /** Whether the target window accepts the data being dragged over or not. */
-#define VBOX_XDND_STATUS_FLAG_ACCEPT            0x1
+#define VBOX_XDND_STATUS_FLAG_ACCEPT            RT_BIT(0)
 /** Whether the target window wants XdndPosition messages while dragging stuff over it. */
-#define VBOX_XDND_STATUS_FLAG_WANTS_POS         0x2
+#define VBOX_XDND_STATUS_FLAG_WANTS_POS         RT_BIT(1)
 
 /** Whether the target window accepted the drop data or not. */
-#define VBOX_XDND_FINISHED_FLAG_SUCCEEDED       0x1
+#define VBOX_XDND_FINISHED_FLAG_SUCCEEDED       RT_BIT(0)
 
 /** How many X properties our proxy window can hold. */
@@ -135 +137 @@
  * into a single event queue.
  */
-struct DnDEvent
+typedef struct DNDEVENT
 {
     enum DnDEventType
@@ -158 +160 @@
     RTMEM_IMPLEMENT_NEW_AND_DELETE();
 #endif
-};
+} DNDEVENT;
+/** Pointer to a DnD event. */
+typedef DNDEVENT *PDNDEVENT;
 
 enum XA_Type
@@ -627 +631 @@
     /** Current source/target window handle. */
     Window                      m_wndCur;
-    /** The XDnD protocol version the current source/target window is using. */
-    long                        m_curVer;
+    /** The XDnD protocol version the current source/target window is using.
+     *  Set to 0 if not available / not set yet. */
+    uint8_t                     m_uXdndVer;
     /** List of (Atom) formats the current source/target window supports. */
     VBoxDnDAtomList             m_lstAtomFormats;
@@ -686 +691 @@
     Display             *m_pDisplay;
     /** Our (thread-safe) event queue with mixed events (DnD HGCM / X11). */
-    RTCMTList<DnDEvent>  m_eventQueue;
+    RTCMTList<DNDEVENT>  m_eventQueue;
     /** Critical section for providing serialized access to list
      *  event queue's contents. */
@@ -717 +722 @@
     , m_wndRoot(0)
     , m_wndCur(0)
-    , m_curVer(-1)
+    , m_uXdndVer(0)
     , m_pvSelReqData(NULL)
     , m_cbSelReqData(0)
@@ -801 +806 @@
         /** @todo Support INC (incremental transfers). */
 
-        m_wndCur    = 0;
-        m_curVer    = -1;
-        m_enmState  = Initialized;
-        m_enmMode   = Unknown;
+        m_wndCur   = 0;
+        m_uXdndVer = 0;
+        m_enmState = Initialized;
+        m_enmMode  = Unknown;
         m_eventQueueList.clear();
         m_cFailedPendingAttempts = 0;
@@ -1005 +1010 @@
 
                 /* Does the target accept the drop? */
-                const bool fAcceptDrop    = e.xclient.data.l[XdndStatusFlags] & VBOX_XDND_STATUS_FLAG_ACCEPT;
+                bool const fAcceptDrop    = RT_BOOL(e.xclient.data.l[XdndStatusFlags] & VBOX_XDND_STATUS_FLAG_ACCEPT);
                 /* Does the target want XdndPosition messages? */
-                const bool fWantsPosition = e.xclient.data.l[XdndStatusFlags] & VBOX_XDND_STATUS_FLAG_WANTS_POS;
-                RT_NOREF(fWantsPosition);
+                bool const fWantsPosition = RT_BOOL(e.xclient.data.l[XdndStatusFlags] & VBOX_XDND_STATUS_FLAG_WANTS_POS);
 
                 /*
@@ -1055 +1059 @@
                 AssertPtrBreakStmt(pszWndTgtName, VERR_NO_MEMORY);
 
-                if (m_curVer >= 5)
+                if (m_uXdndVer >= 5)
                 {
                     const bool  fSucceeded = e.xclient.data.l[XdndFinishedFlags] & VBOX_XDND_FINISHED_FLAG_SUCCEEDED;
@@ -1106 +1110 @@
                 if (RT_SUCCESS(rc))
                 {
-                    long const xdndVer = e.xclient.data.l[XdndEnterFlags] >> XdndEnterVersionRShift;
-
-                    VBClLogInfo("Entered new source window %#x ('%s'), supports Xdnd version %ld\n", wndSel, pszWndSelName, xdndVer);
+                    uint8_t const uXdndVer = (uint8_t)e.xclient.data.l[XdndEnterFlags] >> XdndEnterVersionRShift;
+
+                    VBClLogInfo("Entered new source window %#x ('%s'), supports Xdnd version %u\n", wndSel, pszWndSelName, uXdndVer);
 #ifdef DEBUG
                     XWindowAttributes xwa;
@@ -1146 +1150 @@
                      * Retrieve supported actions.
                      */
-                    if (xdndVer >= 2) /* More than one action allowed since protocol version 2. */
+                    if (uXdndVer >= 2) /* More than one action allowed since protocol version 2. */
                     {
                         rc = wndXDnDGetActionList(wndSel, m_lstAtomActions);
@@ -1181 +1185 @@
 
                     m_wndCur   = wndSel;
-                    m_curVer   = xdndVer;
+                    m_uXdndVer = uXdndVer;
                     m_enmMode  = GH;
                     m_enmState = Dragging;
@@ -1200 +1204 @@
 #ifdef LOG_ENABLED
                 int32_t iPos      = e.xclient.data.l[XdndPositionXY];
-                Atom    atmAction = m_curVer >= 2 /* Actions other than "copy" or only supported since protocol version 2. */
+                Atom    atmAction = m_uXdndVer >= 2 /* Actions other than "copy" or only supported since protocol version 2. */
                                   ? e.xclient.data.l[XdndPositionAction] : xAtom(XA_XdndActionCopy);
                 LogFlowThisFunc(("XA_XdndPosition: wndProxy=%#x, wndCur=%#x, x=%RI32, y=%RI32, strAction=%s\n",
@@ -1218 +1222 @@
                 m.format       = 32;
                 m.data.l[XdndStatusWindow]  = m_wndProxy.hWnd;
-                m.data.l[XdndStatusFlags]   = fAcceptDrop ? RT_BIT(0) : 0; /* Whether to accept the drop or not. */
+                m.data.l[XdndStatusFlags]   = fAcceptDrop ? VBOX_XDND_STATUS_FLAG_ACCEPT : VBOX_XDND_STATUS_FLAG_NONE; /* Whether to accept the drop or not. */
 
                 /* We don't want any new XA_XdndPosition messages while being
@@ -1617 +1621 @@
 
     bool fFound = false;
-    const uint64_t uiStart = RTTimeMilliTS();
+    uint64_t const tsStartMs = RTTimeMilliTS();
 
     do
@@ -1655 +1659 @@
         }
     }
-    while (RTTimeMilliTS() - uiStart < uTimeoutMS);
-
-    LogFlowThisFunc(("Returning fFound=%RTbool, msRuntime=%RU64\n", fFound, RTTimeMilliTS() - uiStart));
+    while (RTTimeMilliTS() - tsStartMs < uTimeoutMS);
+
+    LogFlowThisFunc(("Returning fFound=%RTbool, msRuntime=%RU64\n", fFound, RTTimeMilliTS() - tsStartMs));
     return fFound;
 }
@@ -1856 +1860 @@
     AssertPtrReturn(pszWndBelowCursorName, VERR_NO_MEMORY);
 
-    long newVer = -1; /* This means the current window is _not_ XdndAware. */
+    uint8_t uBelowCursorXdndVer = 0; /* 0 means the current window is _not_ XdndAware. */
 
     if (wndBelowCursor != None)
@@ -1886 +1890 @@
             {
                 /* Get the current window's Xdnd version. */
-                newVer = reinterpret_cast<long *>(pcData)[0];
+                uBelowCursorXdndVer = (uint8_t)reinterpret_cast<long *>(pcData)[0];
             }
 
@@ -1896 +1900 @@
     AssertPtrReturn(pszWndCurName, VERR_NO_MEMORY);
 
-    LogFlowThisFunc(("wndCursor=%x ('%s', Xdnd version %ld), wndCur=%x ('%s', Xdnd version %ld)\n",
-                     wndBelowCursor, pszWndBelowCursorName, newVer, m_wndCur, pszWndCurName, m_curVer));
+    LogFlowThisFunc(("wndCursor=%x ('%s', Xdnd version %u), wndCur=%x ('%s', Xdnd version %u)\n",
+                     wndBelowCursor, pszWndBelowCursorName, uBelowCursorXdndVer, m_wndCur, pszWndCurName, m_uXdndVer));
 
     if (   wndBelowCursor != m_wndCur
-        && m_curVer       != -1)
-    {
-        VBClLogInfo("Left old window %#x ('%s'), supported Xdnd version %ld\n", m_wndCur, pszWndCurName, m_curVer);
+        && m_uXdndVer)
+    {
+        VBClLogInfo("Left old window %#x ('%s'), supported Xdnd version %u\n", m_wndCur, pszWndCurName, m_uXdndVer);
 
         /* We left the current XdndAware window. Announce this to the current indow. */
@@ -1919 +1923 @@
 
         /* Reset our current window. */
-        m_wndCur = 0;
-        m_curVer = -1;
+        m_wndCur   = 0;
+        m_uXdndVer = 0;
     }
 
@@ -1927 +1931 @@
      */
     if (   wndBelowCursor != m_wndCur
-        && newVer         != -1)
-    {
-        VBClLogInfo("Entered new window %#x ('%s'), supports Xdnd version=%ld\n", wndBelowCursor, pszWndBelowCursorName, newVer);
+        && uBelowCursorXdndVer)
+    {
+        VBClLogInfo("Entered new window %#x ('%s'), supports Xdnd version=%u\n",
+                    wndBelowCursor, pszWndBelowCursorName, uBelowCursorXdndVer);
 
         /*
@@ -1951 +1956 @@
                                     0, 0,
                                     /* Protocol version to use. */
-                                    RT_MIN(VBOX_XDND_VERSION, newVer));
+                                    RT_MIN(VBOX_XDND_VERSION, uBelowCursorXdndVer));
         m.data.l[XdndEnterType1]  = m_lstAtomFormats.value(0, None); /* First data type to use. */
         m.data.l[XdndEnterType2]  = m_lstAtomFormats.value(1, None); /* Second data type to use. */
@@ -1961 +1966 @@
     }
 
-    if (newVer != -1)
+    if (uBelowCursorXdndVer)
     {
         Assert(wndBelowCursor != None);
@@ -1992 +1997 @@
     }
 
-    if (newVer == -1)
+    if (uBelowCursorXdndVer == 0)
     {
         /* No window to process, so send a ignore ack event to the host. */
@@ -2001 +2006 @@
         Assert(wndBelowCursor != None);
 
-        m_wndCur = wndBelowCursor;
-        m_curVer = newVer;
+        m_wndCur   = wndBelowCursor;
+        m_uXdndVer = uBelowCursorXdndVer;
     }
 
@@ -2417 +2422 @@
 
         Time tsDrop;
-        if (m_curVer >= 1)
+        if (m_uXdndVer >= 1)
             tsDrop = evDnDDrop.data.l[XdndDropTimeStamp];
         else
@@ -3284 +3289 @@
         do
         {
-            DnDEvent e;
+            DNDEVENT e;
             RT_ZERO(e);
 
@@ -3297 +3302 @@
             m_eventQueue.removeFirst();
 
-            if (e.enmType == DnDEvent::DnDEventType_HGCM)
+            if (e.enmType == DNDEVENT::DnDEventType_HGCM)
             {
                 PVBGLR3DNDEVENT pVbglR3Event = e.hgcm;
@@ -3420 +3425 @@
                     break;
             }
-            else if (e.enmType == DnDEvent::DnDEventType_X11)
+            else if (e.enmType == DNDEVENT::DnDEventType_X11)
             {
                 m_pCurDnD->onX11Event(e.x11);
@@ -3551 +3556 @@
     /* Number of invalid messages skipped in a row. */
     int cMsgSkippedInvalid = 0;
-    DnDEvent e;
+    DNDEVENT e;
 
     do
     {
         RT_ZERO(e);
-        e.enmType = DnDEvent::DnDEventType_HGCM;
+        e.enmType = DNDEVENT::DnDEventType_HGCM;
 
         /* Wait for new events. */
@@ -3617 +3622 @@
     VBClLogVerbose(2, "X11 thread started\n");
 
-    DnDEvent e;
+    DNDEVENT e;
     do
     {
@@ -3630 +3635 @@
         {
             RT_ZERO(e);
-            e.enmType = DnDEvent::DnDEventType_X11;
+            e.enmType = DNDEVENT::DnDEventType_X11;
 
             /* XNextEvent will block until a new X event becomes available. */