Changeset 78095 in vbox for trunk/src/VBox

Timestamp:

Apr 10, 2019 3:23:03 PM (6 years ago)

Author:

vboxsync

Message:

DnD/Main: Added validation mask for the DND_OBJCTX_STATE_ flags, docs.

File:

• trunk/src/VBox/Main/include/GuestDnDPrivate.h (modified) (4 diffs)

trunk/src/VBox/Main/include/GuestDnDPrivate.h

@@ -369 +369 @@
 };
 
-/** Initial state. */
+/** Initial object context state / no state set. */
 #define DND_OBJCTX_STATE_NONE           0
-/** The header was received/sent. */
+/** The header was received / sent. */
 #define DND_OBJCTX_STATE_HAS_HDR        RT_BIT(0)
+/** Validation mask for object context state. */
+#define DND_OBJCTX_STATE_VALID_MASK     UINT32_C(0x00000001)
 
 /**
@@ -435 +437 @@
     bool isValid(void) const { return (pObjURI != NULL); }
 
+    /** Returns the current state. */
     uint32_t getState(void) const { return fState; }
 
@@ -444 +447 @@
 
         fIntermediate = false;
-        fState        = 0;
+        fState        = DND_OBJCTX_STATE_NONE;
     }
 
@@ -456 +459 @@
     }
 
+    /**
+     * Sets the new state.
+     *
+     * @returns The new state, if set.
+     * @param   fStateNew       New state to set.
+     */
     uint32_t setState(uint32_t fStateNew)
     {
-        /** @todo Add validation. */
+        AssertReturn(!(fStateNew & ~DND_OBJCTX_STATE_VALID_MASK), fState /* Return old state */);
         fState = fStateNew;
         return fState;