Changeset 78725 in vbox for trunk/include/VBox

Timestamp:

May 24, 2019 1:15:59 PM (6 years ago)

Author:

vboxsync

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

130804

Message:

Shared Clipboard/URI: Update.

Location:

trunk/include/VBox

Files:

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

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

@@ -62 +62 @@
 class SharedClipboardCache
 {
-
 public:
 
@@ -72 +71 @@
 public:
 
-    uint16_t AddRef(void);
-    uint16_t Release(void);
+    uint32_t AddRef(void);
+    uint32_t Release(void);
 
     int Lock(void);
@@ -117 +116 @@
     /** Associated clipboard area ID. */
     SHAREDCLIPBOARDAREAID        m_uID;
+};
+
+class SharedClipboardURIList;
+
+/**
+ * Class acting as a proxy to abstract reading / writing clipboard data.
+ *
+ * This is needed because various implementations can run on the host *or* on the guest side,
+ * requiring different methods for handling the actual data.
+ */
+class SharedClipboardProvider
+{
+public:
+
+    SharedClipboardProvider(void);
+    virtual ~SharedClipboardProvider(void);
+
+public:
+
+    enum SourceType
+    {
+        /** Invalid source type. */
+        SourceType_Invalid = 0,
+        /** Source is VbglR3. */
+        SourceType_VbglR3,
+        /** Source is the host service. */
+        SourceType_HostService
+    };
+
+public:
+
+    uint32_t AddRef(void);
+    uint32_t Release(void);
+
+public:
+
+    int SetSource(SourceType enmSource);
+    int ReadMetaData(SharedClipboardURIList &URIList, uint32_t fFlags = 0);
+
+protected:
+
+    /** Number of references to this instance. */
+    volatile uint32_t            m_cRefs;
+    /** Source type to handle. */
+    SourceType                   m_enmSource;
 };
 
@@ -368 +412 @@
 const void *SharedClipboardMetaDataRaw(PSHAREDCLIPBOARDMETADATA pMeta);
 
+bool SharedClipboardMIMEHasFileURLs(const char *pcszFormat, size_t cchFormatMax);
+bool SharedClipboardMIMENeedsCache(const char *pcszFormat, size_t cchFormatMax);
+
 #endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_uri_h */
 

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

@@ -39 +39 @@
 #  include <iprt/win/shlobj.h> /* For DROPFILES and friends. */
 #  include <oleidl.h>
+
+# include <VBox/GuestHost/SharedClipboard-uri.h>
 # endif
 
@@ -95 +97 @@
 typedef struct _VBOXCLIPBOARDWINURITRANSFER
 {
+    /** The Shared Clipboard provider in charge for this transfer. */
+    SharedClipboardProvider     Provider;
     /** Pointer to data object to use for this transfer. */
     VBoxClipboardWinDataObject *pDataObj;
@@ -181 +185 @@
 public:
 
-    VBoxClipboardWinDataObject(LPFORMATETC pFormatEtc = NULL, LPSTGMEDIUM pStgMed = NULL, ULONG cFormats = 0);
+    VBoxClipboardWinDataObject(SharedClipboardProvider *pProvider,
+                               LPFORMATETC pFormatEtc = NULL, LPSTGMEDIUM pStgMed = NULL, ULONG cFormats = 0);
     virtual ~VBoxClipboardWinDataObject(void);
 
@@ -214 +219 @@
 public:
 
-    int Init(uint32_t idClient);
+    int Init(void);
     static const char* ClipboardFormatToString(CLIPFORMAT fmt);
 
@@ -222 +227 @@
 
     int copyToHGlobal(const void *pvData, size_t cbData, UINT fFlags, HGLOBAL *phGlobal);
-    int createFileGroupDescriptor(const SharedClipboardURIList &URIList, HGLOBAL *phGlobal);
+    int createFileGroupDescriptor(const SharedClipboardURIList &URIList, bool fUnicode, HGLOBAL *phGlobal);
 
     bool lookupFormatEtc(LPFORMATETC pFormatEtc, ULONG *puIndex);
@@ -228 +233 @@
                         LONG lindex = -1, DWORD dwAspect = DVASPECT_CONTENT, DVTARGETDEVICE *pTargetDevice = NULL);
 
-    Status      mStatus;
-    LONG        mRefCount;
-    ULONG       mcFormats;
-    LPFORMATETC mpFormatEtc;
-    LPSTGMEDIUM mpStgMedium;
-    /** The HGCM client ID for the URI data transfers. */
-    uint32_t    muClientID;
-    IStream    *mpStream;
+protected:
+
+    Status                   m_enmStatus;
+    LONG                     m_lRefCount;
+    ULONG                    m_cFormats;
+    LPFORMATETC              m_pFormatEtc;
+    LPSTGMEDIUM              m_pStgMedium;
+    SharedClipboardProvider *m_pProvider;
+    IStream                 *m_pStream;
 };
 
@@ -279 +285 @@
 public:
 
-    VBoxClipboardWinStreamImpl(void);
+    VBoxClipboardWinStreamImpl(SharedClipboardProvider *pProvider);
     virtual ~VBoxClipboardWinStreamImpl(void);
 
@@ -304 +310 @@
 public: /* Own methods. */
 
-    static HRESULT Create(IStream **ppStream);
+    static HRESULT Create(SharedClipboardProvider *pProvider, IStream **ppStream);
 
 private:
 
-    LONG        m_lRefCount;
+    /** The stream object's current reference count. */
+    LONG                     m_lRefCount;
+    /** Pointer to the associated Shared Clipboard provider. */
+    SharedClipboardProvider *m_pProvider;
 };
 

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -176 +176 @@
  * VBOX_SHARED_CLIPBOARD_FN_WRITE_DATA_HDR
  */
-typedef struct _VBoxClipboardReadDataHdrMsg
+typedef struct _VBoxClipboardDataHdrMsg
 {
     VBGLIOCHGCMCALL hdr;
@@ -287 +287 @@
     /** Total size (in bytes). */
     HGCMFunctionParameter cbTotal;      /* OUT uint64_t */
-} VBoxClipboardWriteReadHdrMsg, VBoxClipboardWriteFileHdrMsg;
+} VBoxClipboardReadFileHdrMsg, VBoxClipboardWriteFileHdrMsg;
 
 #define VBOX_SHARED_CLIPBOARD_CPARMS_READ_FILE_HDR  6
@@ -314 +314 @@
     /** Size (in bytes) of curren data chunk checksum. */
     HGCMFunctionParameter cbChecksum;   /* OUT uint32_t */
-} VBoxClipboardWriteFileDataMsg;
+} VBoxClipboardReadFileDataMsg, VBoxClipboardWriteFileDataMsg;
 
 #define VBOX_SHARED_CLIPBOARD_CPARMS_READ_FILE_DATA  5
@@ -449 +449 @@
 
 # ifdef VBOX_WITH_SHARED_CLIPBOARD_URI_LIST
-bool VBoxSvcClipboardDataHdrIsValid(PVBOXCLIPBOARDDATAHDR pData);
-bool VBoxSvcClipboardDataChunkIsValid(PVBOXCLIPBOARDDATACHUNK pData);
-bool VBoxSvcClipboardDirDataIsValid(PVBOXCLIPBOARDDIRDATA pData);
+bool VBoxSvcClipboardDataHdrIsValid(PVBOXCLIPBOARDDATAHDR pDataHdr);
+bool VBoxSvcClipboardDataChunkIsValid(PVBOXCLIPBOARDDATACHUNK pDataChunk);
+bool VBoxSvcClipboardDirDataIsValid(PVBOXCLIPBOARDDIRDATA pDirData);
 bool VBoxSvcClipboardFileHdrIsValid(PVBOXCLIPBOARDFILEHDR pFileHdr, PVBOXCLIPBOARDDATAHDR pDataHdr);
-bool VBoxSvcClipboardFileDataIsValid(PVBOXCLIPBOARDFILEDATA pData, PVBOXCLIPBOARDDATAHDR pDataHdr);
+bool VBoxSvcClipboardFileDataIsValid(PVBOXCLIPBOARDFILEDATA pFileData, PVBOXCLIPBOARDDATAHDR pDataHdr);
 # endif /* VBOX_WITH_SHARED_CLIPBOARD_URI_LIST */