Changeset 100522 in vbox for trunk/include

Timestamp:

Jul 11, 2023 4:52:03 PM (17 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Resolved a @todo: Removed SHCLOBJHANDLEINFO and only use SHCLTRANSFEROBJ instead, as both structures almost were the same. bugref:9437

File:

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

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

@@ -519 +519 @@
 
 /**
- * Structure for a Shared Clipboard transfer object.
- */
-typedef struct _SHCLTRANSFEROBJ
-{
-    /** Handle of the object. */
-    SHCLOBJHANDLE        uHandle;
-    /** Absolute (local) path of the object. Source-style path. */
-    char                *pszPathAbs;
-    /** Object information. */
-    SHCLFSOBJINFO        objInfo;
-    /** Object type. */
-    SHCLSOURCE           enmSource;
-    /** Current state. */
-    SHCLTRANSFEROBJSTATE State;
-} SHCLTRANSFEROBJ;
-/** Pointer to a Shared Clipboard transfer object. */
-typedef SHCLTRANSFEROBJ *PSHCLTRANSFEROBJ;
-
-/**
  * Enumeration for specifying a Shared Clipboard object type.
  */
@@ -553 +534 @@
     SHCLOBJTYPE_32BIT_SIZE_HACK = 0x7fffffff
 } SHCLOBJTYPE;
+
+/**
+ * Structure for a single Shared Clipboard transfer object.
+ */
+typedef struct _SHCLTRANSFEROBJ
+{
+    /** The list node. */
+    RTLISTNODE           Node;
+    /** Handle of the object. */
+    SHCLOBJHANDLE        hObj;
+    /** Absolute (local) path of the object. Source-style path. */
+    char                *pszPathLocalAbs;
+    /** Object file system information. */
+    SHCLFSOBJINFO        objInfo;
+    /** Source the object originates from. */
+    SHCLSOURCE           enmSource;
+    /** Current state. */
+    SHCLTRANSFEROBJSTATE State;
+    /** Type of object handle. */
+    SHCLOBJTYPE          enmType;
+    /** Data union, based on \a enmType. */
+    union
+    {
+        /** Local data. */
+        struct
+        {
+            union
+            {
+                RTDIR  hDir;
+                RTFILE hFile;
+            };
+        } Local;
+    } u;
+} SHCLTRANSFEROBJ;
+/** Pointer to a Shared Clipboard transfer object. */
+typedef SHCLTRANSFEROBJ *PSHCLTRANSFEROBJ;
 
 /**
@@ -586 +603 @@
 
 /**
- * Structure for keeping transfer object handle information.
- * This is using to map own (local) handles to the underlying file system.
- */
-typedef struct _SHCLOBJHANDLEINFO
-{
-    /** The list node. */
-    RTLISTNODE     Node;
-    /** The object's handle. */
-    SHCLOBJHANDLE  hObj;
-    /** Type of object handle. */
-    SHCLOBJTYPE    enmType;
-    /** Absolute local path of the object. */
-    char          *pszPathLocalAbs;
-    /** Data union, based on \a enmType. */
-    union
-    {
-        /** Local data. */
-        struct
-        {
-            union
-            {
-                RTDIR  hDir;
-                RTFILE hFile;
-            };
-        } Local;
-    } u;
-} SHCLOBJHANDLEINFO;
-/** Pointer to a Shared Clipboard transfer object handle. */
-typedef SHCLOBJHANDLEINFO *PSHCLOBJHANDLEINFO;
-
-/**
  * Structure for maintaining an Shared Clipboard transfer state.
  * Everything in here will be part of a saved state (later).
@@ -853 +839 @@
     DECLCALLBACKMEMBER(void,  pfnOnStarted,(PSHCLTRANSFERCALLBACKCTX pCbCtx));
     /**
-     * Called when the transfer has been complete.
+     * Called when the transfer has been completed.
      *
      * @param   pCbCtx              Pointer to callback context to use.
@@ -1106 +1092 @@
 bool ShClTransferObjCtxIsValid(PSHCLCLIENTTRANSFEROBJCTX pObjCtx);
 
-int ShClTransferObjHandleInfoInit(PSHCLOBJHANDLEINFO pInfo);
-void ShClTransferObjHandleInfoDestroy(PSHCLOBJHANDLEINFO pInfo);
+int ShClTransferObjInit(PSHCLTRANSFEROBJ pObj);
+void ShClTransferObjDestroy(PSHCLTRANSFEROBJ pObj);
 
 int ShClTransferObjOpenParmsInit(PSHCLOBJOPENCREATEPARMS pParms);
@@ -1118 +1104 @@
 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);
+PSHCLTRANSFEROBJ ShClTransferObjGet(PSHCLTRANSFER pTransfer, SHCLOBJHANDLE hObj);
 
 PSHCLOBJDATACHUNK ShClTransferObjDataChunkDup(PSHCLOBJDATACHUNK pDataChunk);