Changeset 80623 in vbox for trunk/include

Timestamp:

Sep 6, 2019 10:05:11 AM (6 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

133152

Message:

Shared Clipboard: Removed old protocol handling cruft on the host side and added message translation support for serving older Guest Additions. Updated docs / protocol changelog.

Location:

trunk/include/VBox

Files:

• GuestHost/SharedClipboard.h (modified) (6 diffs)
• HostServices/VBoxClipboardSvc.h (modified) (3 diffs)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -1 +1 @@
 /** @file
- * Shared Clipboard - Common Guest and Host Code.
+ * Shared Clipboard - Common guest and host Code.
  */
 
@@ -50 +50 @@
 #define VBOX_SHARED_CLIPBOARD_FMT_NONE          0
 /** Shared Clipboard format is an Unicode text. */
-#define VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT   UINT32_C(0x01)
+#define VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT   RT_BIT(0)
 /** Shared Clipboard format is bitmap (BMP / DIB). */
-#define VBOX_SHARED_CLIPBOARD_FMT_BITMAP        UINT32_C(0x02)
+#define VBOX_SHARED_CLIPBOARD_FMT_BITMAP        RT_BIT(1)
 /** Shared Clipboard format is HTML. */
-#define VBOX_SHARED_CLIPBOARD_FMT_HTML          UINT32_C(0x04)
+#define VBOX_SHARED_CLIPBOARD_FMT_HTML          RT_BIT(2)
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
 /** Shared Clipboard format is an URI list. */
-#define VBOX_SHARED_CLIPBOARD_FMT_URI_LIST      UINT32_C(0x08)
+#define VBOX_SHARED_CLIPBOARD_FMT_URI_LIST      RT_BIT(3)
 #endif
 
@@ -167 +167 @@
 
 VBOXCLIPBOARDEVENTID SharedClipboardEventIDGenerate(PSHAREDCLIPBOARDEVENTSOURCE pSource);
+VBOXCLIPBOARDEVENTID SharedClipboardEventGetLast(PSHAREDCLIPBOARDEVENTSOURCE pSource);
 int SharedClipboardEventRegister(PSHAREDCLIPBOARDEVENTSOURCE pSource, VBOXCLIPBOARDEVENTID uID);
 int SharedClipboardEventUnregister(PSHAREDCLIPBOARDEVENTSOURCE pSource, VBOXCLIPBOARDEVENTID uID);
@@ -189 +190 @@
 } SHAREDCLIPBOARDSOURCE;
 
-enum
-{
-    /** The number of milliseconds before the clipboard times out. */
-#ifndef TESTCASE
-    CLIPBOARD_TIMEOUT = 5000
-#else
-    CLIPBOARD_TIMEOUT = 1
-#endif
-};
-
 /** Opaque data structure for the X11/VBox frontend/glue code. */
 struct _VBOXCLIPBOARDCONTEXT;
@@ -208 +199 @@
 typedef struct _CLIPBACKEND CLIPBACKEND;
 
-/** Opaque request structure for clipboard data.
+/** Opaque request structure for X11 clipboard data.
  * @todo All use of single and double underscore prefixes is banned! */
 struct _CLIPREADCBREQ;
@@ -216 +207 @@
 extern CLIPBACKEND *ClipConstructX11(VBOXCLIPBOARDCONTEXT *pFrontend, bool fHeadless);
 extern void ClipDestructX11(CLIPBACKEND *pBackend);
-#ifdef __cplusplus
-extern int ClipStartX11(CLIPBACKEND *pBackend, bool grab = false);
-#else
 extern int ClipStartX11(CLIPBACKEND *pBackend, bool grab);
-#endif
 extern int ClipStopX11(CLIPBACKEND *pBackend);
-extern int ClipAnnounceFormatToX11(CLIPBACKEND *pBackend,
-                                   VBOXCLIPBOARDFORMATS vboxFormats);
-extern int ClipRequestDataFromX11(CLIPBACKEND *pBackend, VBOXCLIPBOARDFORMATS vboxFormat,
-                                  CLIPREADCBREQ *pReq);
+extern int ClipAnnounceFormatToX11(CLIPBACKEND *pBackend, VBOXCLIPBOARDFORMATS vboxFormats);
+extern int ClipRequestDataFromX11(CLIPBACKEND *pBackend, VBOXCLIPBOARDFORMATS vboxFormat, CLIPREADCBREQ *pReq);
 
 /* APIs exported by the X11/VBox frontend */
-extern int ClipRequestDataForX11(VBOXCLIPBOARDCONTEXT *pCtx,
-                                 uint32_t u32Format, void **ppv,
-                                 uint32_t *pcb);
-extern void ClipReportX11Formats(VBOXCLIPBOARDCONTEXT *pCtx,
-                                 uint32_t u32Formats);
-extern void ClipCompleteDataRequestFromX11(VBOXCLIPBOARDCONTEXT *pCtx, int rc,
-                                           CLIPREADCBREQ *pReq, void *pv,
-                                           uint32_t cb);
+extern int ClipRequestDataForX11(VBOXCLIPBOARDCONTEXT *pCtx, uint32_t u32Format, void **ppv, uint32_t *pcb);
+extern void ClipReportX11Formats(VBOXCLIPBOARDCONTEXT *pCtx, uint32_t u32Formats);
+extern void ClipRequestFromX11CompleteCallback(VBOXCLIPBOARDCONTEXT *pCtx, int rc, CLIPREADCBREQ *pReq, void *pv, uint32_t cb);
 #endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_h */
+

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -40 +40 @@
  *
  *     Protocol v1 (VBox >= 6.1):
- *         + Introduces protocol versioning and context IDs for parallel,
+ *         + Adds protocol versioning and context IDs for parallel,
  *           asynchronous transfers.
- *         | Keeps backwards-compatbility with protocol v0 clients.
+ *         | Keeps backwards-compatbility with protocol v0 clients by translating
+ *           messages to protocol v0, to not break compatibility with older
+ *           Guest Additions (VBox < 6.1).
  */
 
@@ -96 +98 @@
 /** Reports available clipboard format from host to the guest.
  *  Formerly known as VBOX_SHARED_CLIPBOARD_HOST_MSG_REPORT_FORMATS. */
-#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS_WRITE                3
-/** Reports available clipboard format from host to the guest. */
-#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS_READ                 4
+#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS_REPORT               3
 
 /** Initiates a new transfer (read / write) on the guest side. */
@@ -144 +144 @@
 /** Sends a list of available formats to the host.
  *  Formely known as VBOX_SHARED_CLIPBOARD_GUEST_FN_REPORT_FORMATS. */
-#define VBOX_SHARED_CLIPBOARD_GUEST_FN_FORMATS_WRITE          2
+#define VBOX_SHARED_CLIPBOARD_GUEST_FN_FORMATS_REPORT         2
 /** Reads data in specified format from the host. */
 #define VBOX_SHARED_CLIPBOARD_GUEST_FN_DATA_READ              3