Changeset 82493 in vbox for trunk/include/VBox/HostServices

Timestamp:

Dec 7, 2019 11:37:51 AM (5 years ago)

Author:

vboxsync

Message:

VBox/HostServices/VBoxClipboardSvc.h,++: Moved the formats and context ID stuff (back) to where these belong. The VBoxClipboardSvc.h header defines the service interface, while the VBox/GuestHost/ stuff is an library interface that's implementation specific and ultimately optional (for clients anyway). bugref:9437

File:

• trunk/include/VBox/HostServices/VBoxClipboardSvc.h (modified) (3 diffs)

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -57 +57 @@
 #include <VBox/VBoxGuestCoreTypes.h>
 #include <VBox/hgcmsvc.h>
-
-#include <VBox/GuestHost/SharedClipboard.h>
-#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
-#include <VBox/GuestHost/SharedClipboard-transfers.h>
-#endif
 
 
@@ -540 +535 @@
 
 /** The maximum default chunk size for a single data transfer.
- * @note r=bird: Nobody actually uses this.  Name is misleading.  */
+ * @note r=bird: Nobody actually uses this.  */
 #define VBOX_SHCL_DEFAULT_MAX_CHUNK_SIZE          _64K
+
 
 /** @name VBOX_SHCL_GF_XXX - Guest features.
@@ -563 +559 @@
 /** @} */
 
+
+/** @name VBOX_SHCL_FMT_XXX - Data formats (flags) for Shared Clipboard.
+ * @{
+ */
+/** No format set. */
+#define VBOX_SHCL_FMT_NONE          0
+/** Shared Clipboard format is an Unicode text. */
+#define VBOX_SHCL_FMT_UNICODETEXT   RT_BIT(0)
+/** Shared Clipboard format is bitmap (BMP / DIB). */
+#define VBOX_SHCL_FMT_BITMAP        RT_BIT(1)
+/** Shared Clipboard format is HTML. */
+#define VBOX_SHCL_FMT_HTML          RT_BIT(2)
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
+/** Shared Clipboard format is a transfer list. */
+# define VBOX_SHCL_FMT_URI_LIST     RT_BIT(3)
+#endif
+/** @}  */
+
+
+/** @name Context ID related macros and limits
+ * @{ */
+/**
+ * Creates a context ID out of a client ID, a transfer ID and an event ID (count).
+ */
+#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(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(a_idContext)     ( (uint16_t)(((a_idContext) >> 48) & UINT16_MAX) )
+/** Gets the transfer ID out of a context ID. */
+#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(a_idContext)       ( (uint32_t)( (a_idContext)        & UINT32_MAX) )
+
+/** Maximum number of concurrent Shared Clipboard client sessions a VM can have. */
+#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)
+/** Maximum number of events a single Shared Clipboard transfer can have. */
+#define VBOX_SHCL_MAX_EVENTS                            (UINT32_MAX - 1)
+/** @} */
+
+
 /*
  * HGCM parameter structures.
  */
-/** @todo r=bird: These structures are mostly pointless. */
+/** @todo r=bird: These structures are mostly pointless, as they're only
+ *        ever used by the VbglR3 part.  The host service does not use these
+ *        structures for decoding guest requests, instead it's all hardcoded. */
 #pragma pack(1)
 /**