Changeset 79299 in vbox for trunk/include

Timestamp:

Jun 24, 2019 10:18:19 AM (6 years ago)

Author:

vboxsync

Message:

Shared Clipboard/URI: Update.

Location:

trunk/include/VBox

Files:

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

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

@@ -503 +503 @@
 
 /**
- * Enumeration to specify the Shared Clipboard provider source type.
- */
-typedef enum SHAREDCLIPBOARDPROVIDERSOURCE
+ * Enumeration to specify the Shared Clipboard URI provider source type.
+ */
+typedef enum SHAREDCLIPBOARDURIPROVIDERSOURCE
 {
     /** Invalid source type. */
-    SHAREDCLIPBOARDPROVIDERSOURCE_INVALID = 0,
+    SHAREDCLIPBOARDURIPROVIDERSOURCE_INVALID = 0,
     /** Source is VbglR3. */
-    SHAREDCLIPBOARDPROVIDERSOURCE_VBGLR3,
+    SHAREDCLIPBOARDURIPROVIDERSOURCE_VBGLR3,
     /** Source is the host service. */
-    SHAREDCLIPBOARDPROVIDERSOURCE_HOSTSERVICE
-} SHAREDCLIPBOARDPROVIDERSOURCE;
+    SHAREDCLIPBOARDURIPROVIDERSOURCE_HOSTSERVICE
+} SHAREDCLIPBOARDURIPROVIDERSOURCE;
 
 class SharedClipboardProvider;
@@ -553 +553 @@
 {
     /** Specifies what the source of the provider is. */
-    SHAREDCLIPBOARDPROVIDERSOURCE     enmSource;
+    SHAREDCLIPBOARDURIPROVIDERSOURCE  enmSource;
+    /** Specifies whether the provider will read or write data. */
+    SHAREDCLIPBOARDURITRANSFERDIR     enmDir;
     /** Optional callback table; can be NULL if not needed. */
     PSHAREDCLIPBOARDPROVIDERCALLBACKS pCallbacks;
@@ -625 +627 @@
 public: /* Interface to be implemented. */
 
+    virtual int Prepare(void);
+
     virtual int ReadDataHdr(PVBOXCLIPBOARDDATAHDR *ppDataHdr);
     virtual int WriteDataHdr(const PVBOXCLIPBOARDDATAHDR pDataHdr);
@@ -697 +701 @@
     /** Number of references to this instance. */
     volatile uint32_t                m_cRefs;
+    /** The provider's transfer direction. */
+    SHAREDCLIPBOARDURITRANSFERDIR    m_enmDir;
     /** The provider's callback table. */
     SHAREDCLIPBOARDPROVIDERCALLBACKS m_Callbacks;
@@ -759 +765 @@
 public:
 
+    int Prepare(void);
+
     int ReadDataHdr(PVBOXCLIPBOARDDATAHDR *ppDataHdr);
     int WriteDataHdr(const PVBOXCLIPBOARDDATAHDR pDataHdr);
@@ -811 +819 @@
 typedef FNSHAREDCLIPBOARDURITRANSFERSTARTED *PFNSHAREDCLIPBOARDURITRANSFERSTARTED;
 
+typedef DECLCALLBACK(void) FNSHAREDCLIPBOARDURITRANSFERPREPARE(PSHAREDCLIPBOARDURITRANSFERCALLBACKDATA pData);
+/** Pointer to a FNSHAREDCLIPBOARDURITRANSFERPREPARE function. */
+typedef FNSHAREDCLIPBOARDURITRANSFERPREPARE *PFNSHAREDCLIPBOARDURITRANSFERPREPARE;
+
+typedef DECLCALLBACK(void) FNSHAREDCLIPBOARDURIMETADATACOMPLETE(PSHAREDCLIPBOARDURITRANSFERCALLBACKDATA pData);
+/** Pointer to a FNSHAREDCLIPBOARDURIMETADATACOMPLETE function. */
+typedef FNSHAREDCLIPBOARDURIMETADATACOMPLETE *PFNSHAREDCLIPBOARDURIMETADATACOMPLETE;
+
 typedef DECLCALLBACK(void) FNSHAREDCLIPBOARDURITRANSFERCANCELED(PSHAREDCLIPBOARDURITRANSFERCALLBACKDATA pData);
 /** Pointer to a FNSHAREDCLIPBOARDURITRANSFERCANCELED function. */
@@ -831 +847 @@
     /** Saved user pointer. */
     void                                 *pvUser;
+    /** Function pointer, called when the transfer is going to be prepared. */
+    PFNSHAREDCLIPBOARDURITRANSFERPREPARE  pfnTransferPrepare;
     /** Function pointer, called when the transfer has been started. */
     PFNSHAREDCLIPBOARDURITRANSFERSTARTED  pfnTransferStarted;
+    /** Function pointer, called when reading / writing meta data is complete. */
+    PFNSHAREDCLIPBOARDURIMETADATACOMPLETE pfnMetaDataComplete;
     /** Function pointer, called when the transfer is complete. */
     PFNSHAREDCLIPBOARDURITRANSFERCOMPLETE pfnTransferComplete;
@@ -933 +953 @@
 SharedClipboardURIObject *SharedClipboardURITransferGetObject(PSHAREDCLIPBOARDURITRANSFER pTransfer, uint64_t uIdx);
 int SharedClipboardURITransferRun(PSHAREDCLIPBOARDURITRANSFER pTransfer, bool fAsync);
-void SharedClipboardURITransferSetCallbacks(PSHAREDCLIPBOARDURITRANSFER pTransfer, PSHAREDCLIPBOARDURITRANSFERCALLBACKS pCallbacks);
+void SharedClipboardURITransferSetCallbacks(PSHAREDCLIPBOARDURITRANSFER pTransfer,
+                                            PSHAREDCLIPBOARDURITRANSFERCALLBACKS pCallbacks);
 
 int SharedClipboardURITransferMetaDataAdd(PSHAREDCLIPBOARDURITRANSFER pTransfer, const void *pvMeta, uint32_t cbMeta);
 bool SharedClipboardURITransferMetaDataIsComplete(PSHAREDCLIPBOARDURITRANSFER pTransfer);
-int SharedClipboardURITransferMetaGet(PSHAREDCLIPBOARDURITRANSFER pTransfer, const void *pvMeta, uint32_t cbMeta);
 int SharedClipboardURITransferMetaDataRead(PSHAREDCLIPBOARDURITRANSFER pTransfer, uint32_t *pcbRead);
 int SharedClipboardURITransferMetaDataWrite(PSHAREDCLIPBOARDURITRANSFER pTransfer, uint32_t *pcbWritten);

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

@@ -216 +216 @@
 
     int copyToHGlobal(const void *pvData, size_t cbData, UINT fFlags, HGLOBAL *phGlobal);
-    int createFileGroupDescriptorFromURIList(const SharedClipboardURIList &URIList, bool fUnicode, HGLOBAL *phGlobal);
+    int createFileGroupDescriptorFromTransfer(PSHAREDCLIPBOARDURITRANSFER pTransfer,
+                                              bool fUnicode, HGLOBAL *phGlobal);
 
     bool lookupFormatEtc(LPFORMATETC pFormatEtc, ULONG *puIndex);
     void registerFormat(LPFORMATETC pFormatEtc, CLIPFORMAT clipFormat, TYMED tyMed = TYMED_HGLOBAL,
                         LONG lindex = -1, DWORD dwAspect = DVASPECT_CONTENT, DVTARGETDEVICE *pTargetDevice = NULL);
+
+protected: /* URI transfer callbacks */
+
+    static DECLCALLBACK(void) onMetaDataCompleteCallback(PSHAREDCLIPBOARDURITRANSFERCALLBACKDATA pData);
 
 protected:
@@ -232 +237 @@
     IStream                    *m_pStream;
     ULONG                       m_uObjIdx;
+    /** Event being triggered when reading the meta data has been completed.*/
+    RTSEMEVENT                  m_EventMetaDataComplete;
 };
 

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -449 +449 @@
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
 int VBoxSvcClipboardURIReadDataHdr(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDDATAHDR pDataHdr);
+int VBoxSvcClipboardURIWriteDataHdr(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDDATAHDR pDataHdr);
 int VBoxSvcClipboardURIReadDataChunk(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDDATACHUNK pDataChunk);
+int VBoxSvcClipboardURIWriteDataChunk(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDDATACHUNK pDataChunk);
 int VBoxSvcClipboardURIReadDir(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDDIRDATA pDirData);
+int VBoxSvcClipboardURIWriteDir(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDDIRDATA pDirData);
 int VBoxSvcClipboardURIReadFileHdr(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDFILEHDR pFileHdr);
+int VBoxSvcClipboardURIWriteFileHdr(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDFILEHDR pFileHdr);
 int VBoxSvcClipboardURIReadFileData(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDFILEDATA pFileData);
+int VBoxSvcClipboardURIWriteFileData(uint32_t cParms, VBOXHGCMSVCPARM paParms[], PVBOXCLIPBOARDFILEDATA pFileData);
 #endif