Changeset 82476 in vbox for trunk

Timestamp:

Dec 6, 2019 11:52:16 PM (5 years ago)

Author:

vboxsync

Message:

GuestHost/SharedClipboard.h: Fixed some broken macros: VBOX_SHCL_MAX_EVENTS, VBOX_SHCL_MAX_TRANSFERS, VBOX_SHCL_MAX_SESSIONS and VBOX_SHCL_CONTEXTID_MAKE_SESSION. Some cleanups. bugref:9437

File:

• trunk/include/VBox/GuestHost/SharedClipboard.h (modified) (6 diffs)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -122 +122 @@
     /** Payload ID; currently unused. */
     uint32_t uID;
+    /** Size (in bytes) of actual payload data. */
+    uint32_t cbData;
     /** Pointer to actual payload data. */
     void    *pvData;
-    /** Size (in bytes) of actual payload data. */
-    uint32_t cbData;
 } SHCLEVENTPAYLOAD, *PSHCLEVENTPAYLOAD;
 
@@ -155 +155 @@
 
 /** Maximum number of concurrent Shared Clipboard client sessions a VM can have. */
-#define VBOX_SHCL_MAX_SESSIONS                   UINT16_MAX - 1
+#define VBOX_SHCL_MAX_SESSIONS                   (UINT16_MAX - 1)
 /** Maximum number of concurrent Shared Clipboard transfers a single
  *  client can have. */
-#define VBOX_SHCL_MAX_TRANSFERS                  UINT16_MAX - 1
+#define VBOX_SHCL_MAX_TRANSFERS                  (UINT16_MAX - 1)
 /** Maximum number of events a single Shared Clipboard transfer can have. */
-#define VBOX_SHCL_MAX_EVENTS                     UINT32_MAX - 1
+#define VBOX_SHCL_MAX_EVENTS                     (UINT32_MAX - 1)
 
 /**
  * Creates a context ID out of a client ID, a transfer ID and a count (can be an event ID).
  */
-#define VBOX_SHCL_CONTEXTID_MAKE(uSessionID, uTransferID, uEventID) \
-    (  (uint64_t)((uSessionID)  & 0xffff) << 48 \
-     | (uint64_t)((uTransferID) & 0xffff) << 32 \
-     | (uint32_t)((uEventID)    & 0xffffffff) \
+#define VBOX_SHCL_CONTEXTID_MAKE(a_idSession, a_idTransfer, a_idEvent) \
+    (  ((uint64_t)((a_idSession)  & 0xffff) << 48) \
+     | ((uint64_t)((a_idTransfer) & 0xffff) << 32) \
+     | ((uint32_t) (a_idEvent)) \
     )
 /** Creates a context ID out of a session ID. */
-#define VBOX_SHCL_CONTEXTID_MAKE_SESSION(uSessionID) \
-    ((uint32_t)((uSessionID) & 0xffff) << 48)
+#define VBOX_SHCL_CONTEXTID_MAKE_SESSION(a_idSession)    VBOX_SHCL_CONTEXTID_MAKE(a_idSession, 0, 0)
 /** Gets the session ID out of a context ID. */
-#define VBOX_SHCL_CONTEXTID_GET_SESSION(uContextID) \
-    (((uContextID) >> 48) & 0xffff)
+#define VBOX_SHCL_CONTEXTID_GET_SESSION(a_idContext)     ( (uint16_t)(((a_idContext) >> 48) & UINT16_MAX) )
 /** Gets the transfer ID out of a context ID. */
-#define VBOX_SHCL_CONTEXTID_GET_TRANSFER(uContextID) \
-    (((uContextID) >> 32) & 0xffff)
+#define VBOX_SHCL_CONTEXTID_GET_TRANSFER(a_idContext)    ( (uint16_t)(((a_idContext) >> 32) & UINT16_MAX) )
 /** Gets the transfer event out of a context ID. */
-#define VBOX_SHCL_CONTEXTID_GET_EVENT(uContextID) \
-    ((uContextID) & 0xffffffff)
-
-/**
- * Structure for maintaining a Shared Clipboard event.
+#define VBOX_SHCL_CONTEXTID_GET_EVENT(a_idContext)       ( (uint32_t)( (a_idContext)        & UINT32_MAX) )
+
+/**
+ * Shared Clipboard event.
  */
 typedef struct _SHCLEVENT
@@ -199 +195 @@
 
 /**
- * Structure for maintaining a Shared Clipboard event source.
- *
- * Each event source maintains an own counter for events, so that
- * it can be used in different contexts.
- */
-typedef struct _SHCLEVENTSOURCE
-{
-    /** The event source' ID. */
+ * Shared Clipboard event source.
+ *
+ * Each event source maintains an own counter for events, so that it can be used
+ * in different contexts.
+ */
+typedef struct SHCLEVENTSOURCE
+{
+    /** The event source ID. */
     SHCLEVENTSOURCEID uID;
     /** Next upcoming event ID. */
@@ -224 +220 @@
  *  @{
  */
-int ShClEventSourceCreate(PSHCLEVENTSOURCE pSource, SHCLEVENTSOURCEID uID);
+int ShClEventSourceCreate(PSHCLEVENTSOURCE pSource, SHCLEVENTSOURCEID idEvtSrc);
 void ShClEventSourceDestroy(PSHCLEVENTSOURCE pSource);
 void ShClEventSourceReset(PSHCLEVENTSOURCE pSource);
@@ -234 +230 @@
 SHCLEVENTID ShClEventIDGenerate(PSHCLEVENTSOURCE pSource);
 SHCLEVENTID ShClEventGetLast(PSHCLEVENTSOURCE pSource);
-int ShClEventRegister(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
-int ShClEventUnregister(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
-int ShClEventWait(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD* ppPayload);
-int ShClEventSignal(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID, PSHCLEVENTPAYLOAD pPayload);
-void ShClEventPayloadDetach(PSHCLEVENTSOURCE pSource, SHCLEVENTID uID);
+int ShClEventRegister(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
+int ShClEventUnregister(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
+int ShClEventWait(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD *ppPayload);
+int ShClEventSignal(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent, PSHCLEVENTPAYLOAD pPayload);
+void ShClEventPayloadDetach(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
 /** @} */
 
 /**
- * Enumeration to specify the Shared Clipboard transfer source type.
+ * Shared Clipboard transfer source type.
  */
 typedef enum SHCLSOURCE
@@ -253 +249 @@
     SHCLSOURCE_REMOTE,
     /** The usual 32-bit hack. */
-    SHCLSOURCE_32Bit_Hack = 0x7fffffff
+    SHCLSOURCE_32BIT_HACK = 0x7fffffff
 } SHCLSOURCE;