Changeset 85833 in vbox for trunk/src/VBox/GuestHost

Timestamp:

Aug 19, 2020 2:04:04 PM (5 years ago)

Author:

vboxsync

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

139993

Message:

Shared Clipboard/X11: Docs.

File:

• trunk/src/VBox/GuestHost/SharedClipboard/clipboard-x11.cpp (modified) (7 diffs)

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

@@ -206 +206 @@
 static Atom clipAtomForX11Format(PSHCLX11CTX pCtx, SHCLX11FMTIDX uFmtIdx)
 {
-    LogFlowFunc(("format=%u -> pcszAtom=%s\n", uFmtIdx, g_aFormats[uFmtIdx].pcszAtom));
     AssertReturn(uFmtIdx < RT_ELEMENTS(g_aFormats), 0);
     return clipGetAtom(pCtx, g_aFormats[uFmtIdx].pcszAtom);
@@ -246 +245 @@
     for (unsigned i = 0; i < RT_ELEMENTS(g_aFormats); ++i)
         if (clipAtomForX11Format(pCtx, i) == atomFormat)
+        {
+            LogFlowFunc(("Returning index %u for atom '%s'\n", i, g_aFormats[i].pcszAtom));
             return i;
+        }
     return NIL_CLIPX11FORMAT;
 }
@@ -1226 +1228 @@
 
 /**
- * Satisfies a request from X11 for clipboard targets supported by VBox.
+ * Returns the targets supported by VBox.
+ *
+ * This will return a list of atoms which tells the caller
+ * what kind of clipboard formats we support.
  *
  * @returns VBox status code.
@@ -1244 +1249 @@
                                 int *piFormatReturn)
 {
-    LogFlowFuncEnter();
-
     const unsigned cFixedTargets = 3;
 
@@ -1271 +1274 @@
     *piFormatReturn = 32;
 
+    LogFlowFunc(("cTargets=%u\n", cTargets + cFixedTargets));
+
     return VINF_SUCCESS;
 }
@@ -1277 +1282 @@
  * This is a wrapper around ShClX11RequestDataForX11Callback that will cache the
  * data returned.
+ *
+ * @returns VBox status code. VERR_NO_DATA if no data available.
+ * @param   pCtx                The X11 clipboard context to use.
+ * @param   Format              Clipboard format to read data in.
+ * @param   ppv                 Where to store the allocated read data on success.
+ *                              Needs to be free'd by the caller.
+ * @param   pcb                 Where to return the size (in bytes) of the allocated read data on success.
  */
 static int clipReadVBoxShCl(PSHCLX11CTX pCtx, SHCLFORMAT Format,
@@ -1588 +1600 @@
 
     PSHCLX11CTX pCtx = clipLookupContext(widget);
-    int rc = VINF_SUCCESS;
-
     if (!pCtx)
         return False;
 
+    /* Is this the rigt selection (clipboard) we were asked for? */
     if (!clipIsSupportedSelectionType(pCtx, *atomSelection))
         return False;
 
+    int rc;
     if (*atomTarget == clipGetAtom(pCtx, "TARGETS"))
         rc = clipCreateX11Targets(pCtx, atomTypeReturn, pValReturn,