Changeset 104317 in vbox for trunk/src

Timestamp:

Apr 12, 2024 2:11:08 PM (10 months ago)

Author:

vboxsync

Message:

Shared Clipboard/Transfers: ShClTransferRootsInitFromXXX() -> ShClTransferRootsSetFromXXX(). bugref:9437

Location:

trunk/src/VBox

Files:

• Additions/x11/VBoxClient/clipboard-x11.cpp (modified) (1 diff)
• GuestHost/SharedClipboard/clipboard-transfers.cpp (modified) (10 diffs)
• GuestHost/SharedClipboard/clipboard-win.cpp (modified) (1 diff)
• GuestHost/SharedClipboard/testcase/tstClipboardHttpServer.cpp (modified) (1 diff)
• HostServices/SharedClipboard/VBoxSharedClipboardSvc-x11.cpp (modified) (1 diff)
• HostServices/SharedClipboard/testcase/tstClipboardTransfers.cpp (modified) (2 diffs)

trunk/src/VBox/Additions/x11/VBoxClient/clipboard-x11.cpp

@@ -85 +85 @@
             if (RT_SUCCESS(rc))
             {
-                rc = ShClTransferRootsInitFromStringListEx(pTransfer, (const char *)pvData, cbData,
-                                                           "\n" /* X11-based Desktop environments separate entries with "\n" */);
+                rc = ShClTransferRootsSetFromStringListEx(pTransfer, (const char *)pvData, cbData,
+                                                          "\n" /* X11-based Desktop environments separate entries with "\n" */);
                 RTMemFree(pvData);
             }

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp

@@ -1242 +1242 @@
          *         actually has some root entries set, as the other side can query for those at any time then. */
         if (pTransfer->State.enmDir == SHCLTRANSFERDIR_TO_REMOTE)
-            AssertMsgStmt(ShClTransferRootsCount(pTransfer), ("Transfer has no root entries set\n"), rc = VERR_WRONG_ORDER);
+            AssertMsgStmt(ShClTransferRootsCount(pTransfer), ("Transfer has no root entries set (yet)\n"), rc = VERR_WRONG_ORDER);
 
         if (RT_SUCCESS(rc))
@@ -1821 +1821 @@
 
 /**
- * Initializes the root list entries for a given clipboard transfer, extended version.
+ * Set the root list entries for a given clipboard transfer, extended version.
  *
  * @returns VBox status code.
@@ -1832 +1832 @@
  * @note    Accepts local paths or URI string lists (absolute only).
  */
-int ShClTransferRootsInitFromStringListEx(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots, const char *pszSep)
+int ShClTransferRootsSetFromStringListEx(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots, const char *pszSep)
 {
     AssertPtrReturn(pTransfer,      VERR_INVALID_POINTER);
@@ -1992 +1992 @@
 
 /**
- * Initializes the root list entries for a given clipboard transfer.
+ * Sets the root list entries for a given clipboard transfer.
  *
  * @returns VBox status code.
@@ -2002 +2002 @@
  * @note    Accepts local paths or URI string lists (absolute only).
  */
-int ShClTransferRootsInitFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots)
-{
-    return ShClTransferRootsInitFromStringListEx(pTransfer, pszRoots, cbRoots, SHCL_TRANSFER_URI_LIST_SEP_STR);
-}
-
-/**
- * Initializes the root list entries for a given clipboard transfer, UTF-16 (Unicode) version.
+int ShClTransferRootsSetFromStringList(PSHCLTRANSFER pTransfer, const char *pszRoots, size_t cbRoots)
+{
+    return ShClTransferRootsSetFromStringListEx(pTransfer, pszRoots, cbRoots, SHCL_TRANSFER_URI_LIST_SEP_STR);
+}
+
+/**
+ * Sets the root list entries for a given clipboard transfer, UTF-16 (Unicode) version.
  *
  * @returns VBox status code.
@@ -2018 +2018 @@
  * @note    Accepts local paths or URI string lists (absolute only).
  */
-int ShClTransferRootsInitFromStringListUnicode(PSHCLTRANSFER pTransfer, PRTUTF16 pwszRoots, size_t cbRoots)
+int ShClTransferRootsSetFromStringListUnicode(PSHCLTRANSFER pTransfer, PRTUTF16 pwszRoots, size_t cbRoots)
 {
     AssertPtrReturn(pwszRoots, VERR_INVALID_POINTER);
@@ -2039 +2039 @@
             rc = ShClConvUtf16CRLFToUtf8LF(pwszRoots, cwcRoots, pszDst, chDst, &cbActual);
             if (RT_SUCCESS(rc))
-                rc = ShClTransferRootsInitFromStringList(pTransfer, pszDst, cbActual + 1 /* Include terminator */);
+                rc = ShClTransferRootsSetFromStringList(pTransfer, pszDst, cbActual + 1 /* Include terminator */);
 
             RTStrFree(pszDst);
@@ -2051 +2051 @@
 
 /**
- * Initializes a single path as a transfer root.
+ * Sets a single path as a transfer root.
  *
  * @returns VBox status code.
@@ -2059 +2059 @@
  * @note    Convenience function, uses ShClTransferRootsInitFromStringList() internally.
  */
-int ShClTransferRootsInitFromPath(PSHCLTRANSFER pTransfer, const char *pszPath)
+int ShClTransferRootsSetFromPath(PSHCLTRANSFER pTransfer, const char *pszPath)
 {
     AssertPtrReturn(pTransfer, VERR_INVALID_POINTER);
@@ -2069 +2069 @@
     rc = RTStrAAppend(&pszRoots, SHCL_TRANSFER_URI_LIST_SEP_STR);
     AssertRCReturn(rc, rc);
-    rc =  ShClTransferRootsInitFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1 /* Include terminator */);
+    rc =  ShClTransferRootsSetFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1 /* Include terminator */);
     RTStrFree(pszRoots);
     return rc;

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-win.cpp

@@ -1317 +1317 @@
                 if (RT_SUCCESS(rc))
                 {
-                    rc = ShClTransferRootsInitFromStringList(pTransfer, pszList, cbList);
+                    rc = ShClTransferRootsSetFromStringList(pTransfer, pszList, cbList);
                     RTStrFree(pszList);
                 }

trunk/src/VBox/GuestHost/SharedClipboard/testcase/tstClipboardHttpServer.cpp

@@ -106 +106 @@
     RTTEST_CHECK_RC_OK(hTest, ShClTransferCreate(SHCLTRANSFERDIR_TO_REMOTE, SHCLSOURCE_LOCAL, NULL /* Callbacks */, &pTx));
     RTTEST_CHECK_RC_OK(hTest, ShClTransferSetProvider(pTx, pProvider));
-    RTTEST_CHECK_RC_OK(hTest, ShClTransferRootsInitFromPath(pTx, pszPath));
+    RTTEST_CHECK_RC_OK(hTest, ShClTransferRootsSetFromPath(pTx, pszPath));
     RTTEST_CHECK_RC_OK(hTest, ShClTransferInit(pTx));
     RTTEST_CHECK_RC_OK(hTest, ShClTransferCtxRegister(pTransferCtx, pTx, NULL));

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-x11.cpp

@@ -674 +674 @@
     if (RT_SUCCESS(rc))
     {
-        rc = ShClTransferRootsInitFromStringList(pCtx->pTransfer, (const char *)pvData, cbData);
+        rc = ShClTransferRootsSetFromStringList(pCtx->pTransfer, (const char *)pvData, cbData);
         if (RT_SUCCESS(rc))
             LogRel2(("Shared Clipboard: Host reported %RU64 X11 root entries for transfer to guest\n",

trunk/src/VBox/HostServices/SharedClipboard/testcase/tstClipboardTransfers.cpp

@@ -231 +231 @@
     RTTESTI_CHECK_RC_OK_RETV(rc);
 
-    rc = ShClTransferRootsInitFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1);
+    rc = ShClTransferRootsSetFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1);
     RTTESTI_CHECK_RC(rc, rcExpected);
 
@@ -267 +267 @@
     RTTESTI_CHECK_RC_OK_RETV(rc);
 
-    rc = ShClTransferRootsInitFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1);
+    rc = ShClTransferRootsSetFromStringList(pTransfer, pszRoots, strlen(pszRoots) + 1);
     RTTESTI_CHECK_RC_OK(rc);