Changeset 102824 in vbox

Timestamp:

Jan 10, 2024 5:31:25 PM (11 months ago)

Author:

vboxsync

Message:

Shared Clipboard/X11: Implemented ShClX11WriteDataToX11[Async](). bugref:9437

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard-x11.h (modified) (4 diffs)
• src/VBox/GuestHost/SharedClipboard/clipboard-x11.cpp (modified) (1 diff)

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

@@ -177 +177 @@
     SHCLX11EVENTTYPE_REPORT_FORMATS,
     /** Reads clipboard from X11. */
-    SHCLX11EVENTTYPE_READ
+    SHCLX11EVENTTYPE_READ,
+    /** Writes clipboard to X11. */
+    SHCLX11EVENTTYPE_WRITE
 } SHCLX11EVENTTYPE;
 /** Pointer to an enumeration for an X11 event type. */
@@ -211 +213 @@
             uint32_t         cbMax;
         } Read;
+        /** Write request. */
+        struct
+        {
+            /** The format of the data to write. */
+            SHCLFORMAT       uFmtVBox;
+            /** The format to write to X11. */
+            SHCLX11FMTIDX    idxFmtX11;
+            /** Data to write. */
+            void            *pvData;
+            /** How much bytes to write. */
+            uint32_t         cbData;
+        } Write;
     };
 } SHCLX11REQUEST;
@@ -232 +246 @@
             uint32_t cbData;
         } Read;
+        struct
+        {
+            const void *pvData;
+            uint32_t    cbData;
+        } Write;
     };
 } SHCLX11RESPONSE;
@@ -248 +267 @@
 int ShClX11ReadDataFromX11Async(PSHCLX11CTX pCtx, SHCLFORMAT uFmt, uint32_t cbMax, PSHCLEVENT pEvent);
 int ShClX11ReadDataFromX11(PSHCLX11CTX pCtx, PSHCLEVENTSOURCE pEventSource, RTMSINTERVAL msTimeout, SHCLFORMAT uFmt, void *pvBuf, uint32_t cbBuf, uint32_t *pcbBuf);
+int ShClX11WriteDataToX11Async(PSHCLX11CTX pCtx, SHCLFORMAT uFmt, const void *pvBuf, uint32_t cbBuf, PSHCLEVENT pEvent);
+int ShClX11WriteDataToX11(PSHCLX11CTX pCtx, PSHCLEVENTSOURCE pEventSource, RTMSINTERVAL msTimeout, SHCLFORMAT uFmt, const void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten);
 void ShClX11SetCallbacks(PSHCLX11CTX pCtx, PSHCLCALLBACKS pCallbacks);
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS

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

@@ -2727 +2727 @@
     return rc;
 }
+
+/**
+ * Writes to the X11 clipboard (asynchronously).
+ *
+ * @returns VBox status code.
+ * @retval  VERR_NOT_AVAILABLE the the X11 clipboard is not available.
+ * @retval  VERR_NOT_IMPLEMENTED if the format is not implemented.
+ * @param   pCtx                Context data for the clipboard backend.
+ * @param   uFmts               The format(s) to write.
+ *                              Conversions might be performed, if available.
+ * @param   pvBuf               Pointer to data to write.
+ * @param   cbBuf               Size (in bytes) of data to write.
+ * @param   pEvent              Event to use for waiting for data to get written.
+ *                              The event's payload will contain the amount of data written.
+ *                              Needs to be free'd with ShClEventRelease().
+ */
+int ShClX11WriteDataToX11Async(PSHCLX11CTX pCtx, SHCLFORMATS uFmts, const void *pvBuf, uint32_t cbBuf, PSHCLEVENT pEvent)
+{
+    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
+    AssertPtrReturn(pvBuf,  VERR_INVALID_POINTER);
+    AssertReturn(cbBuf,  VERR_INVALID_PARAMETER);
+    /* pEvent not used yet. */ RT_NOREF(pEvent);
+
+    /*
+     * Immediately return if we are not connected to the X server.
+     */
+    if (!pCtx->fHaveX11)
+        return VERR_NOT_AVAILABLE;
+
+    int rc = ShClCacheSetMultiple(&pCtx->Cache, uFmts, pvBuf, cbBuf);
+    if (RT_SUCCESS(rc))
+    {
+        clipResetX11Formats(pCtx);
+        clipGrabX11Clipboard(pCtx, uFmts);
+    }
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * Writes to the X11 clipboard.
+ *
+ * This function currently only is implemented as asynchronous version.
+ *
+ * @returns VBox status code.
+ * @retval  VERR_NOT_AVAILABLE the the X11 clipboard is not available.
+ * @retval  VERR_TRY_AGAIN if format is supported but data could not be written.
+ * @retval  VERR_NOT_IMPLEMENTED if the format is not implemented.
+ * @param   pCtx                Context data for the clipboard backend.
+ * @param   uFmt                The format to write.
+ * @param   pvBuf               Pointer to data to write. Must match format to write.
+ * @param   cbBuf               Size (in bytes) of data to write.
+ * @param   pcbWritten          Where to return the written bytes on success. Optional.
+ *                              Currently always returns the value of \a cbBuf on success.
+ *
+ * @note    Text data must be in UTF-8, always.
+ */
+int ShClX11WriteDataToX11(PSHCLX11CTX pCtx, PSHCLEVENTSOURCE pEventSource, RTMSINTERVAL msTimeout,
+                          SHCLFORMAT uFmt, const void *pvBuf, uint32_t cbBuf, uint32_t *pcbWritten)
+{
+    AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
+    AssertPtrReturn(pEventSource, VERR_INVALID_POINTER);
+    AssertPtrReturn(pvBuf, VERR_INVALID_POINTER);
+    AssertReturn(cbBuf, VERR_INVALID_PARAMETER);
+    /* pcbWritetn is optional. */
+
+    RT_NOREF(msTimeout); /* Not used yet. */
+
+    int rc = ShClX11WriteDataToX11Async(pCtx, uFmt, pvBuf, cbBuf, NULL /* pEvent */);
+    if (RT_SUCCESS(rc))
+    {
+        if (pcbWritten)
+            *pcbWritten = cbBuf;
+    }
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+