Changeset 99951 in vbox for trunk/include/VBox/GuestHost

Timestamp:

May 24, 2023 10:37:12 AM (2 years ago)

Author:

vboxsync

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

157609

Message:

Shared Clipboard: Moved code for handling local filesystems with transfers into an own provider interface implementation. This cleans up the generic code a lot. bugref:9437

File:

• trunk/include/VBox/GuestHost/SharedClipboard-transfers.h (modified) (6 diffs)

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

@@ -709 +709 @@
 /** Pointer to a Shared Clipboard transfer provider interface table. */
 typedef SHCLTXPROVIDERIFACE *PSHCLTXPROVIDERIFACE;
+
+/** Queries (assigns) a Shared Clipboard provider interface. */
+#define SHCLTXPROVIDERIFACE_QUERY(a_Iface, a_Name) \
+    a_Iface->pfnRootsGet       = a_Name ## RootsGet; \
+    a_Iface->pfnListOpen       = a_Name ## ListOpen; \
+    a_Iface->pfnListClose      = a_Name ## ListClose; \
+    a_Iface->pfnListHdrRead    = a_Name ## ListHdrRead; \
+    a_Iface->pfnListHdrWrite   = a_Name ## ListHdrWrite; \
+    a_Iface->pfnListEntryRead  = a_Name ## ListEntryRead; \
+    a_Iface->pfnListEntryWrite = a_Name ## ListEntryWrite; \
+    a_Iface->pfnObjOpen        = a_Name ## ObjOpen; \
+    a_Iface->pfnObjClose       = a_Name ## ObjClose; \
+    a_Iface->pfnObjRead        = a_Name ## ObjRead; \
+    a_Iface->pfnObjWrite       = a_Name ## ObjWrite;
+
+/** Queries (assigns) a Shared Clipboard provider interface + returns the interface pointer. */
+#define SHCLTXPROVIDERIFACE_QUERY_RET(a_Iface, a_Name) \
+    SHCLTXPROVIDERIFACE_QUERY(a_Iface, a_Name); return a_Iface;
 
 /**
@@ -954 +972 @@
 };
 
+/** @name Shared Clipboard transfer interface providers.
+ *  @{
+ */
+PSHCLTXPROVIDERIFACE VBClTransferQueryIfaceLocal(PSHCLTXPROVIDERIFACE pIface);
+/** @} */
+
 /** @name Shared Clipboard transfer object API.
  *  @{
@@ -973 +997 @@
 int ShClTransferObjRead(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t fFlags, uint32_t *pcbRead);
 int ShClTransferObjWrite(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj, void *pvBuf, uint32_t cbBuf, uint32_t fFlags, uint32_t *pcbWritten);
+PSHCLOBJHANDLEINFO ShClTransferObjGet(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj);
 
 PSHCLOBJDATACHUNK ShClTransferObjDataChunkDup(PSHCLOBJDATACHUNK pDataChunk);
@@ -1002 +1027 @@
 int ShClTransferListClose(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);
 int ShClTransferListGetHeader(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTHDR pHdr);
+PSHCLLISTHANDLEINFO ShClTransferListGetByHandle(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList);
 PSHCLTRANSFEROBJ ShClTransferListGetObj(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, uint64_t uIdx);
 int ShClTransferListRead(PSHCLTRANSFER pTransfer, SHCLLISTHANDLE hList, PSHCLLISTENTRY pEntry);
@@ -1104 +1130 @@
 #endif /* VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS_HTTP */
 
+/** @name Shared Clipboard transfers utility functions.
+ *  @{
+ */
+const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus);
+int ShClTransferValidatePath(const char *pcszPath, bool fMustExist);
 void ShClFsObjFromIPRT(PSHCLFSOBJINFO pDst, PCRTFSOBJINFO pSrc);
+/** @} */
 
 /** @name Shared Clipboard MIME functions.
@@ -1113 +1145 @@
 /** @} */
 
-const char *ShClTransferStatusToStr(SHCLTRANSFERSTATUS enmStatus);
-
 #endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_transfers_h */