Changeset 78648 in vbox for trunk/include/VBox

Timestamp:

May 22, 2019 9:30:34 AM (6 years ago)

Author:

vboxsync

Message:

Shared Clipboard/URI: Update.

Location:

trunk/include/VBox

Files:

• GuestHost/SharedClipboard-uri.h (modified) (1 diff)
• HostServices/VBoxClipboardSvc.h (modified) (12 diffs)

trunk/include/VBox/GuestHost/SharedClipboard-uri.h

@@ -329 +329 @@
 };
 
+/**
+ * Structure for keeping Shared Clipboard meta data.
+ *
+ * For URI transfers this represents a string list with the file object root entries in it.
+ */
+typedef struct _SHAREDCLIPBOARDMETADATA
+{
+    /** Actual meta data block. */
+    void  *pvMeta;
+    /** Total size (in bytes) of the allocated meta data block .*/
+    size_t cbMeta;
+    /** How many bytes are being used in the meta data block. */
+    size_t cbUsed;
+} SHAREDCLIPBOARDMETADATA, *PSHAREDCLIPBOARDMETADATA;
+
+int SharedClipboardMetaDataInit(PSHAREDCLIPBOARDMETADATA pMeta);
+void SharedClipboardMetaDataDestroy(PSHAREDCLIPBOARDMETADATA pMeta);
+int SharedClipboardMetaDataAdd(PSHAREDCLIPBOARDMETADATA pMeta, const void *pvDataAdd, uint32_t cbDataAdd);
+int SharedClipboardMetaDataResize(PSHAREDCLIPBOARDMETADATA pMeta, size_t cbNewSize);
+size_t SharedClipboardMetaDataGetUsed(PSHAREDCLIPBOARDMETADATA pMeta);
+size_t SharedClipboardMetaDataGetSize(PSHAREDCLIPBOARDMETADATA pMeta);
+const void *SharedClipboardMetaDataRaw(PSHAREDCLIPBOARDMETADATA pMeta);
+
 #endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_uri_h */
 

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -202 +202 @@
 } VBoxClipboardWriteDataHdrMsg;
 
-typedef struct _VBOXCLIPBOARDWRITEDATACHUNK
-{
-    /** Data block buffer. */
-    void                       *pvData;
-    /** Size (in bytes) of data block. */
-    uint32_t                    cbData;
-    /** (Rolling) Checksum. Not yet implemented. */
-    void                       *pvChecksum;
-    /** Size (in bytes) of checksum. Not yet implemented. */
-    uint32_t                    cbChecksum;
-} VBOXCLIPBOARDWRITEDATACHUNK, *PVBOXCLIPBOARDWRITEDATACHUNK;
+#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_DATA_HDR 12
 
 /**
@@ -236 +226 @@
 } VBoxClipboardWriteDataChunkMsg;
 
+#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_DATA_CHUNK 5
+
 /**
  * Sends a directory entry.
@@ -255 +247 @@
     HGCMFunctionParameter fMode;        /* OUT uint32_t */
 } VBoxClipboardWriteDirMsg;
+
+#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_DIR 4
 
 /**
@@ -280 +274 @@
 } VBoxClipboardWriteFileHdrMsg;
 
+#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_FILE_HDR 6
+
 /**
  * Sends data of a file entry.
@@ -303 +299 @@
 } VBoxClipboardWriteFileDataMsg;
 
+#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_FILE_DATA 5
+
 /**
  * Sends an error event.
@@ -340 +338 @@
     CB_MAGIC_CLIPBOARD_WRITE_ERROR      = VBOX_CLIPBOARD_CB_MAGIC_MAKE(VBOX_SHARED_CLIPBOARD_FN_WRITE_ERROR, 0)
 };
-
-typedef struct _VBOXCLIPBOARDCBHEADERDATA
-{
-    /** Magic number to identify the structure. */
-    uint32_t                    uMagic;
-    /** Context ID to identify callback data. */
-    uint32_t                    uContextID;
-} VBOXCLIPBOARDCBHEADERDATA, *PVBOXCLIPBOARDCBHEADERDATA;
 
 /**
@@ -382 +372 @@
 } VBOXCLIPBOARDDATAHDR, *PVBOXCLIPBOARDDATAHDR;
 
-typedef struct _VBOXCLIPBOARDCBWRITEDATAHDRDATA
-{
-    /** Callback data header. */
-    VBOXCLIPBOARDCBHEADERDATA         hdr;
-    /** Actual header data. */
-    VBOXCLIPBOARDDATAHDR              data;
-} VBOXCLIPBOARDCBWRITEDATAHDRDATA, *PVBOXCLIPBOARDCBWRITEDATAHDRDATA;
-
-typedef struct VBOXCLIPBOARDSNDDATA
+typedef struct _VBOXCLIPBOARDDATACHUNK
 {
     /** Data block buffer. */
@@ -400 +382 @@
     /** Size (in bytes) of checksum. Not yet implemented. */
     uint32_t                    cbChecksum;
-} VBOXCLIPBOARDSNDDATA, *PVBOXCLIPBOARDSNDDATA;
-
-typedef struct VBOXCLIPBOARDCBSNDDATADATA
-{
-    /** Callback data header. */
-    VBOXCLIPBOARDCBHEADERDATA         hdr;
-    /** Actual data. */
-    VBOXCLIPBOARDSNDDATA              data;
-} VBOXCLIPBOARDCBDATADATA, *PVBOXCLIPBOARDCBSNDDATADATA;
-
-typedef struct _VBOXCLIPBOARDCBWRITEDIRDATA
-{
-    /** Callback data header. */
-    VBOXCLIPBOARDCBHEADERDATA   hdr;
+} VBOXCLIPBOARDDATACHUNK, *PVBOXCLIPBOARDDATACHUNK;
+
+typedef struct _VBOXCLIPBOARDDIRDATA
+{
     /** Directory path. */
     char                       *pszPath;
@@ -420 +392 @@
     /** Directory creation mode. */
     uint32_t                    fMode;
-} VBOXCLIPBOARDCBWRITEDIRDATA, *PVBOXCLIPBOARDCBWRITEDIRDATA;
-
-typedef struct _VBOXCLIPBOARDCBWRITEFILEHDRDATA
-{
-    /** Callback data header. */
-    VBOXCLIPBOARDCBHEADERDATA   hdr;
+} VBOXCLIPBOARDDIRDATA, *PVBOXCLIPBOARDDIRDATA;
+
+typedef struct _VBOXCLIPBOARDFILEHDR
+{
     /** File path (name). */
     char                       *pszFilePath;
@@ -436 +406 @@
     /** Additional flags. Not used at the moment. */
     uint32_t                    fFlags;
-} VBOXCLIPBOARDCBWRITEFILEHDRDATA, *PVBOXCLIPBOARDCBWRITEFILEHDRDATA;
-
-typedef struct _VBOXCLIPBOARDCBWRITEFILEDATADATA
-{
-    /** Callback data header. */
-    VBOXCLIPBOARDCBHEADERDATA   hdr;
+} VBOXCLIPBOARDFILEHDR, *PVBOXCLIPBOARDFILEHDR;
+
+typedef struct _VBOXCLIPBOARDFILEDATA
+{
     /** Current file data chunk. */
     void                       *pvData;
@@ -450 +418 @@
     /** Size (in bytes) of current data chunk. */
     uint32_t                    cbChecksum;
-} VBOXCLIPBOARDCBWRITEFILEDATADATA, *PVBOXCLIPBOARDCBWRITEFILEDATADATA;
-
-typedef struct _VBOXCLIPBOARDCBEVTERRORDATA
-{
-    /** Callback data header. */
-    VBOXCLIPBOARDCBHEADERDATA   hdr;
+} VBOXCLIPBOARDFILEDATA, *PVBOXCLIPBOARDFILEDATA;
+
+typedef struct _VBOXCLIPBOARDERRORDATA
+{
     int32_t                     rc;
-} VBOXCLIPBOARDCBEVTERRORDATA, *PVBOXCLIPBOARDCBEVTERRORDATA;
+} VBOXCLIPBOARDERRORDATA, *PVBOXCLIPBOARDERRORDATA;
 # endif /* VBOX_WITH_SHARED_CLIPBOARD_URI_LIST */
 
@@ -464 +430 @@
 void VBoxSvcClipboardUnlock(void);
 
+bool VBoxSvcClipboardDataHdrIsValid(PVBOXCLIPBOARDDATAHDR pData);
+bool VBoxSvcClipboardDataChunkIsValid(PVBOXCLIPBOARDDATACHUNK pData);
+bool VBoxSvcClipboardDirDataIsValid(PVBOXCLIPBOARDDIRDATA pData);
+bool VBoxSvcClipboardFileHdrIsValid(PVBOXCLIPBOARDFILEHDR pFileHdr, PVBOXCLIPBOARDDATAHDR pDataHdr);
+bool VBoxSvcClipboardFileDataIsValid(PVBOXCLIPBOARDFILEDATA pData, PVBOXCLIPBOARDDATAHDR pDataHdr);
+
 #endif /* !VBOX_INCLUDED_HostServices_VBoxClipboardSvc_h */