Changeset 18398 in vbox for trunk/src

Timestamp:

Mar 27, 2009 2:21:19 PM (16 years ago)

Author:

vboxsync

Message:

HostServices/SharedClipboard: move the first code to the GuestHost directory

Location:

trunk/src/VBox

Files:

• GuestHost/SharedClipboard (added)
• GuestHost/SharedClipboard/clipboard-helper.cpp (moved) (moved from trunk/src/VBox/HostServices/SharedClipboard/clipboard-helper.cpp ) (1 diff)
• GuestHost/SharedClipboard/x11-clipboard.cpp (copied) (copied from trunk/src/VBox/HostServices/SharedClipboard/x11-clipboard.cpp ) (74 diffs)
• HostServices/SharedClipboard/Makefile.kmk (modified) (1 diff)
• HostServices/SharedClipboard/darwin-pasteboard.cpp (modified) (1 diff)
• HostServices/SharedClipboard/x11-clipboard.cpp (modified) (2 diffs)

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

@@ -20 +20 @@
  */
 
-#include "clipboard-helper.h"
-#include "VBox/log.h"
 #include <iprt/assert.h>
+#include <VBox/log.h>
+#include <VBox/GuestHost/clipboard-helper.h>
 
 /** @todo use const where appropriate; delinuxifiy the code (*Lin* -> *Host*); use AssertLogRel*. */

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

@@ -2 +2 @@
  *
  * Shared Clipboard:
- * Linux host.
+ * X11 back-end.
  */
 
@@ -23 +23 @@
 #include <vector>
 
-#include <VBox/HostServices/VBoxClipboardSvc.h>
+#include <VBox/GuestHost/SharedClipboard.h>
 
 #include <iprt/alloc.h>
@@ -76 +76 @@
     Atom atom;
     g_eClipboardFormats format;
-    unsigned guestFormat;
+    unsigned vboxFormat;
 } VBOXCLIPBOARDFORMAT;
 
@@ -126 +126 @@
     std::vector<VBOXCLIPBOARDFORMAT> formatList;
 
-    /** Does the host or the guest currently own the clipboard? */
+    /** Does X11 or VBox currently own the clipboard? */
     volatile enum g_eOwner eOwner;
 
-    /** What is the best text format the host has to offer?  INVALID for none. */
-    g_eClipboardFormats hostTextFormat;
-    /** Atom corresponding to the host text format */
-    Atom atomHostTextFormat;
-    /** What is the best bitmap format the host has to offer?  INVALID for none. */
-    g_eClipboardFormats hostBitmapFormat;
-    /** Atom corresponding to the host Bitmap format */
-    Atom atomHostBitmapFormat;
-    /** What formats does the guest have on offer? */
-    int guestFormats;
+    /** What is the best text format that X11 has to offer?  INVALID for none. */
+    g_eClipboardFormats X11TextFormat;
+    /** Atom corresponding to the X11 text format */
+    Atom atomX11TextFormat;
+    /** What is the best bitmap format that X11 has to offer?  INVALID for none. */
+    g_eClipboardFormats X11BitmapFormat;
+    /** Atom corresponding to the X11 Bitmap format */
+    Atom atomX11BitmapFormat;
+    /** What formats does VBox have on offer? */
+    int vboxFormats;
     /** Windows caches the clipboard data it receives.  Since we have no way of knowing whether
         that data is still valid, we always send a "data changed" message after a successful
         transfer to invalidate the cache. */
-    bool notifyGuest;
+    bool notifyVBox;
 
     /** Since the clipboard data moves asynchronously, we use an event semaphore to wait for
@@ -155 +155 @@
     RTSEMMUTEX clipboardMutex;
 
-    /** Format which we are reading from the host clipboard (valid during a request for the
-        host clipboard) */
-    g_eClipboardFormats requestHostFormat;
-    /** The guest buffer to write host clipboard data to (valid during a request for the host
+    /** Format which we are reading from the X11 clipboard (valid during a request for the
+        X11 clipboard) */
+    g_eClipboardFormats requestX11Format;
+    /** VBox's buffer to write X11 clipboard data to (valid during a request for the X11
         clipboard) */
     void *requestBuffer;
-    /** The size of the guest buffer to write host clipboard data to (valid during a request for
-        the host clipboard) */
+    /** The size of VBox's buffer to write X11 clipboard data to (valid during a request for
+        the X11 clipboard) */
     unsigned requestBufferSize;
-    /** The size of the host clipboard data written to the guest buffer (valid during a request
-        for the host clipboard) */
+    /** The size of the X11 clipboard data written to VBox's buffer (valid during a request
+        for the X11 clipboard) */
     uint32_t *requestActualSize;
 
@@ -175 +175 @@
 static VBOXCLIPBOARDCONTEXT g_ctx;
 
-/* Are we actually connected to the X11 servicer? */
+/* Are we actually connected to the X server? */
 static bool g_fHaveX11;
 
 /**
- * Reset the contents of the buffer used to pass clipboard data from VBox to X11.
- * This must be done after every clipboard transfer.
- */
-static void vboxClipboardEmptyGuestBuffer(void)
-{
-    if (g_ctx.pClient->data.pv != 0)
-        RTMemFree(g_ctx.pClient->data.pv);
-    g_ctx.pClient->data.pv = 0;
-    g_ctx.pClient->data.cb = 0;
-    g_ctx.pClient->data.u32Format = 0;
-}
-
-/**
  * Send a request to VBox to transfer the contents of its clipboard to X11.
  *
- * @param  pCtx      Pointer to the host clipboard structure
+ * @param  pCtx      Pointer to the X11 clipboard structure
  * @param  u32Format The format in which the data should be transfered
  * @thread clipboard X11 event thread
@@ -208 +195 @@
         /* This can legitimately happen if we disconnect during a request for
          * data from X11. */
-        LogFunc(("host requested guest clipboard data after guest had disconnected.\n"));
-        pCtx->guestFormats = 0;
+        LogFunc(("X11 requested VBox clipboard data after VBox had disconnected.\n"));
+        pCtx->vboxFormats = 0;
         pCtx->waiter = NONE;
         return VERR_TIMEOUT;
@@ -229 +216 @@
                               u32Format);
     /* Which will signal us when it is ready.  We use a timeout here because
-     * we can't be sure that the guest will behave correctly. */
+     * we can't be sure that the other side will behave correctly. */
     int rc = RTSemEventWait(pCtx->waitForData, CLIPBOARDTIMEOUT);
     if (rc == VERR_TIMEOUT)
@@ -247 +234 @@
         /* I believe this should not happen.  Wait until the assertions arrive
          * to prove the contrary. */
-        vboxClipboardEmptyGuestBuffer();
-        pCtx->guestFormats = 0;
+        vboxClipboardEmptyVBoxBuffer();
+        pCtx->vboxFormats = 0;
         return rc;
     }
@@ -259 +246 @@
 /**
  * Convert the UTF-16 text returned from the X11 clipboard to UTF-16LE with Windows EOLs
- * and place it in the global g_pcClipboardText variable.  We are reading the host clipboard to
- * make it available to the guest.
+ * and place it in the global g_pcClipboardText variable.  We are reading the X11 clipboard to
+ * make it available to VBox.
  *
  * @param pValue      Source UTF-16 text
@@ -284 +271 @@
     {
         /* Not enough buffer space provided - report the amount needed. */
-        LogFlowFunc (("guest buffer too small: size %d bytes, needed %d.  Returning.\n",
+        LogFlowFunc (("VBox's buffer too small: size %d bytes, needed %d.  Returning.\n",
                        cb, cwDestLen * 2));
         *pcbActual = cwDestLen * 2;
@@ -336 +323 @@
     {
         /* Not enough buffer space provided - report the amount needed. */
-        LogFlowFunc (("guest buffer too small: size %d bytes, needed %d.  Returning.\n",
+        LogFlowFunc (("VBox's buffer too small: size %d bytes, needed %d.  Returning.\n",
                        cb, cwDestLen * 2));
         *pcbActual = cwDestLen * 2;
@@ -416 +403 @@
     {
         /* Not enough buffer space provided - report the amount needed. */
-        LogFlowFunc (("guest buffer too small: size %d bytes, needed %d.  Returning.\n",
+        LogFlowFunc (("VBox's buffer too small: size %d bytes, needed %d.  Returning.\n",
                        cb, cwDestLen * 2));
         *pcbActual = cwDestLen * 2;
@@ -467 +454 @@
     {
         /* Not enough buffer space provided - report the amount needed. */
-        LogFlowFunc (("guest buffer too small: size %d bytes\n", cb));
+        LogFlowFunc (("VBox's buffer too small: size %d bytes\n", cb));
         *pcbActual = cwDestLen * 2;
         rc = VERR_BUFFER_OVERFLOW;
@@ -504 +491 @@
 {
     LogFlowFunc(("pClientData=%p, *pcLen=%lu, *piFormat=%d\n", pClientData, *pcLen, *piFormat));
-    LogFlowFunc(("g_ctx.requestHostFormat=%d, g_ctx.requestBufferSize=%d\n",
-                 g_ctx.requestHostFormat, g_ctx.requestBufferSize));
+    LogFlowFunc(("g_ctx.requestX11Format=%d, g_ctx.requestBufferSize=%d\n",
+                 g_ctx.requestX11Format, g_ctx.requestBufferSize));
     unsigned cTextLen = (*pcLen) * (*piFormat) / 8;
     /* The X Toolkit may have failed to get the clipboard selection for us. */
@@ -526 +513 @@
 
     /* In which format did we request the clipboard data? */
-    switch (g_ctx.requestHostFormat)
+    switch (g_ctx.requestX11Format)
     {
     case UTF16:
@@ -542 +529 @@
         char *pu8SourceText = reinterpret_cast<char *>(pValue);
 
-        if ((g_ctx.requestHostFormat == UTF8)
+        if ((g_ctx.requestX11Format == UTF8)
             && (RTStrUniLenEx(pu8SourceText, *pcLen, &cStringLen) == VINF_SUCCESS))
         {
@@ -562 +549 @@
         return;
     }
-    g_ctx.notifyGuest = true;
+    g_ctx.notifyVBox = true;
     RTSemMutexRelease(g_ctx.clipboardMutex);
 }
@@ -587 +574 @@
     if (*atomType == XT_CONVERT_FAIL)
     {
-        LogFunc (("reading clipboard from host, X toolkit failed to convert the selection\n"));
+        LogFunc (("reading clipboard from X11, X toolkit failed to convert the selection\n"));
         return;
     }
@@ -618 +605 @@
             if (szAtomName != 0)
             {
-                Log2 (("%s: the host offers target %s\n", __PRETTY_FUNCTION__,
+                Log2 (("%s: X11 offers target %s\n", __PRETTY_FUNCTION__,
                        szAtomName));
                 XFree(szAtomName);
@@ -624 +611 @@
         }
     }
-    g_ctx.atomHostTextFormat = atomBestTarget;
-    if ((eBestTarget != g_ctx.hostTextFormat) || (g_ctx.notifyGuest == true))
+    g_ctx.atomX11TextFormat = atomBestTarget;
+    if ((eBestTarget != g_ctx.X11TextFormat) || (g_ctx.notifyVBox == true))
     {
         uint32_t u32Formats = 0;
@@ -633 +620 @@
             {
                 char *szAtomName = XGetAtomName(XtDisplay(g_ctx.widget), atomBestTarget);
-                Log2 (("%s: switching to host text target %s.  Available targets are:\n",
+                Log2 (("%s: switching to X11 text target %s.  Available targets are:\n",
                        __PRETTY_FUNCTION__, szAtomName));
                 XFree(szAtomName);
             }
             else
-                Log2(("%s: no supported host text target found.  Available targets are:\n",
+                Log2(("%s: no supported X11 text target found.  Available targets are:\n",
                       __PRETTY_FUNCTION__));
             for (unsigned i = 0; i < cAtoms; ++i)
@@ -650 +637 @@
             }
         }
-        g_ctx.hostTextFormat = eBestTarget;
+        g_ctx.X11TextFormat = eBestTarget;
         if (eBestTarget != INVALID)
             u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
         vboxSvcClipboardReportMsg (g_ctx.pClient, VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS,
                                    u32Formats);
-        g_ctx.notifyGuest = false;
+        g_ctx.notifyVBox = false;
     }
     XtFree(reinterpret_cast<char *>(pValue));
@@ -673 +660 @@
     if (g_ctx.eOwner == X11 && g_ctx.pClient != 0)
     {
-        Log3 (("%s: requesting the targets that the host clipboard offers\n",
+        Log3 (("%s: requesting the targets that the X11 clipboard offers\n",
                __PRETTY_FUNCTION__));
         XtGetSelectionValue(g_ctx.widget, g_ctx.atomClipboard, g_ctx.atomTargets,
@@ -686 +673 @@
     use. */
 static void vboxClipboardAddFormat(const char *pszName, g_eClipboardFormats eFormat,
-                                   unsigned guestFormat)
+                                   unsigned vboxFormat)
 {
     VBOXCLIPBOARDFORMAT sFormat;
@@ -693 +680 @@
     sFormat.atom   = atomFormat;
     sFormat.format = eFormat;
-    sFormat.guestFormat = guestFormat;
+    sFormat.vboxFormat = vboxFormat;
     g_ctx.formatList.push_back(sFormat);
     LogFlow (("vboxClipboardAddFormat: added format %s (%d)\n", pszName, eFormat));
@@ -704 +691 @@
 static int vboxClipboardThread(RTTHREAD self, void * /* pvUser */)
 {
-    LogRel(("Shared clipboard: starting host clipboard thread\n"));
-
-    /* Set up a timer to poll the host clipboard */
+    LogRel(("Shared clipboard: starting X11 clipboard thread\n"));
+
+    /* Set up a timer to poll the X11 clipboard */
     XtAppAddTimeOut(g_ctx.appContext, 200 /* ms */, vboxClipboardPollX11ForTargets, 0);
 
     XtAppMainLoop(g_ctx.appContext);
     g_ctx.formatList.clear();
-    LogRel(("Shared clipboard: host clipboard thread terminated successfully\n"));
+    LogRel(("Shared clipboard: X11 clipboard thread terminated successfully\n"));
     return VINF_SUCCESS;
 }
@@ -736 +723 @@
     if (NULL == pDisplay)
     {
-        LogRel(("Shared clipboard: failed to connect to the host clipboard - the window system may not be running.\n"));
+        LogRel(("Shared clipboard: failed to connect to the X11 clipboard - the window system may not be running.\n"));
         rc = VERR_NOT_SUPPORTED;
     }
@@ -745 +732 @@
         if (NULL == g_ctx.widget)
         {
-            LogRel(("Shared clipboard: failed to construct the X11 window for the host clipboard manager.\n"));
+            LogRel(("Shared clipboard: failed to construct the X11 window for the X11 clipboard manager.\n"));
             rc = VERR_NO_MEMORY;
         }
@@ -792 +779 @@
 
 /**
- * Initialise the host side of the shared clipboard.
+ * Initialise the X11 side of the shared clipboard.
  * @note    Called by the HGCM clipboard service
  * @thread  HGCM clipboard service thread
@@ -807 +794 @@
          * silently and report success on every call. This is important for VBoxHeadless.
          */
-        LogRelFunc(("no X11 detected -- host clipboard disabled\n"));
+        LogRelFunc(("no X11 detected -- X11 clipboard disabled\n"));
         g_fHaveX11 = false;
         return VINF_SUCCESS;
@@ -815 +802 @@
     {
         g_testUtf16 = true;
-        LogRel(("Host clipboard: testing Utf16\n"));
+        LogRel(("X11 clipboard: testing Utf16\n"));
     }
     else if (RTEnvGet("VBOX_CBTEST_UTF8"))
     {
         g_testUtf8 = true;
-        LogRel(("Host clipboard: testing Utf8\n"));
+        LogRel(("X11 clipboard: testing Utf8\n"));
     }
     else if (RTEnvGet("VBOX_CBTEST_CTEXT"))
     {
         g_testCText = true;
-        LogRel(("Host clipboard: testing compound text\n"));
+        LogRel(("X11 clipboard: testing compound text\n"));
     }
     else if (RTEnvGet("VBOX_CBDEBUG"))
     {
         g_debugClipboard = true;
-        LogRel(("Host clipboard: enabling additional debugging output\n"));
+        LogRel(("X11 clipboard: enabling additional debugging output\n"));
     }
 
     g_fHaveX11 = true;
 
-    LogRel(("Initializing host clipboard service\n"));
+    LogRel(("Initializing X11 clipboard service\n"));
     RTSemEventCreate(&g_ctx.waitForData);
     RTSemMutexCreate(&g_ctx.clipboardMutex);
@@ -844 +831 @@
                             RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "SHCLIP");
         if (RT_FAILURE(rc))
-            LogRel(("Failed to start the host shared clipboard thread.\n"));
+            LogRel(("Failed to start the X11 shared clipboard thread.\n"));
     }
     if (RT_FAILURE(rc))
@@ -855 +842 @@
 
 /**
- * Terminate the host side of the shared clipboard.
+ * Terminate the X11 side of the shared clipboard.
  * @note    Called by the HGCM clipboard service
  * @thread  HGCM clipboard service thread
@@ -866 +853 @@
 
     /*
-     * Immediately return if we are not connected to the host X server.
+     * Immediately return if we are not connected to the X server.
      */
     if (!g_fHaveX11)
         return;
 
-    LogRel(("vboxClipboardDestroy: shutting down host clipboard\n"));
+    LogRel(("vboxClipboardDestroy: shutting down X11 clipboard\n"));
 
     /* Drop the reference to the client, in case it is still there.  This will
@@ -922 +909 @@
 
 /**
- * Connect a guest the shared clipboard.
- *
- * @param   pClient Structure containing context information about the guest system
+ * Connect VBox to the shared clipboard.
+ *
+ * @param   pClient Structure containing context information from VBox
  * @returns RT status code
  * @note    Called by the HGCM clipboard service
@@ -932 +919 @@
 {
     /*
-     * Immediately return if we are not connected to the host X server.
+     * Immediately return if we are not connected to the X server.
      */
     if (!g_fHaveX11)
@@ -945 +932 @@
     pClient->pCtx->pClient = pClient;
     g_ctx.eOwner = X11;
-    g_ctx.notifyGuest = true;
+    g_ctx.notifyVBox = true;
     return VINF_SUCCESS;
 }
 
 /**
- * Synchronise the contents of the host clipboard with the guest, called
- * after a save and restore of the guest.
+ * Synchronise the contents of the X11 clipboard with VBox, called
+ * after a save and restore of VBox.
  * @note    Called by the HGCM clipboard service
  * @thread  HGCM clipboard service thread
@@ -958 +945 @@
 {
     /*
-     * Immediately return if we are not connected to the host X server.
+     * Immediately return if we are not connected to the X server.
      */
     if (!g_fHaveX11)
         return VINF_SUCCESS;
 
-    /* On a Linux host, the guest should never synchronise/cache its clipboard contents, as
-       we have no way of reliably telling when the host clipboard data changes.  So instead
-       of synchronising, we tell the guest to empty its clipboard, and we set the cached
-       flag so that we report formats to the guest next time we poll for them. */
+    /* On X11, VBox should never synchronise/cache its clipboard contents, as
+       we have no way of reliably telling when the X11 clipboard data changes.  So instead
+       of synchronising, we tell VBox to empty its clipboard, and we set the cached
+       flag so that we report formats to VBox next time we poll for them. */
     vboxSvcClipboardReportMsg (g_ctx.pClient, VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS, 0);
-    g_ctx.notifyGuest = true;
+    g_ctx.notifyVBox = true;
 
     return VINF_SUCCESS;
@@ -974 +961 @@
 
 /**
- * Shut down the shared clipboard service and "disconnect" the guest.
+ * Shut down the shared clipboard service and "disconnect" VBox.
  * @note    Called by the HGCM clipboard service
  * @thread  HGCM clipboard service thread
@@ -981 +968 @@
 {
     /*
-     * Immediately return if we are not connected to the host X server.
+     * Immediately return if we are not connected to the X server.
      */
     if (!g_fHaveX11)
@@ -991 +978 @@
     g_ctx.pClient = NULL;
     g_ctx.eOwner = NONE;
-    g_ctx.hostTextFormat = INVALID;
-    g_ctx.hostBitmapFormat = INVALID;
+    g_ctx.X11TextFormat = INVALID;
+    g_ctx.X11BitmapFormat = INVALID;
     RTSemMutexRelease(g_ctx.clipboardMutex);
 }
@@ -1019 +1006 @@
     for (unsigned i = 0; i < uListSize; ++i)
     {
-        if (   ((g_ctx.guestFormats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT) != 0)
-            && (g_ctx.formatList[i].guestFormat == VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT))
+        if (   ((g_ctx.vboxFormats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT) != 0)
+            && (g_ctx.formatList[i].vboxFormat == VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT))
         {
             atomTargets[cTargets] = g_ctx.formatList[i].atom;
@@ -1055 +1042 @@
 
 /**
- * Satisfy a request from the host to convert the clipboard text to Utf16.  We return non-zero
+ * Satisfy a request from the X11 to convert the clipboard text to Utf16.  We return non-zero
  * terminated text.
  *
@@ -1080 +1067 @@
         LogRelFunc (("vboxClipboardReadDataFromVBox returned %Rrc%s\n", rc,
                     RT_SUCCESS(rc) ? ", g_ctx.pClient->data.cb == 0" :  ""));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1090 +1077 @@
     {
         LogRel(("vboxClipboardConvertUtf16: clipboard conversion failed.  vboxClipboardUtf16GetLinSize returned %Rrc.  Abandoning.\n", rc));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         AssertRCReturn(rc, false);
     }
     if (cwDestLen == 0)
     {
-        LogFlowFunc(("received empty clipboard data from the guest, returning false.\n"));
-        vboxClipboardEmptyGuestBuffer();
+        LogFlowFunc(("received empty clipboard data from VBox, returning false.\n"));
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1103 +1090 @@
     {
         LogRel(("vboxClipboardConvertUtf16: failed to allocate %d bytes\n", cwDestLen * 2));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1112 +1099 @@
         LogRel(("vboxClipboardConvertUtf16: clipboard conversion failed.  vboxClipboardUtf16WinToLin returned %Rrc.  Abandoning.\n", rc));
         XtFree(reinterpret_cast<char *>(pu16DestText));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
     LogFlowFunc (("converted string is %.*ls. Returning.\n", cwDestLen, pu16DestText));
-    vboxClipboardEmptyGuestBuffer();
+    vboxClipboardEmptyVBoxBuffer();
     *atomTypeReturn = g_ctx.atomUtf16;
     *pValReturn = reinterpret_cast<XtPointer>(pu16DestText);
@@ -1125 +1112 @@
 
 /**
- * Satisfy a request from the host to convert the clipboard text to Utf8.
+ * Satisfy a request from the X11 to convert the clipboard text to Utf8.
  *
  * @returns true if we successfully convert the data to the format requested, false otherwise.
@@ -1148 +1135 @@
 
     LogFlowFunc (("called\n"));
-    /* Read the clipboard data from the guest. */
+    /* Read the clipboard data from VBox. */
     rc = vboxClipboardReadDataFromVBox(&g_ctx, VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT);
     if ((rc != VINF_SUCCESS) || (g_ctx.pClient->data.cb == 0))
@@ -1155 +1142 @@
         LogRelFunc (("vboxClipboardReadDataFromVBox returned %Rrc%s\n", rc,
                      RT_SUCCESS(rc) ? ", g_ctx.pClient->data.cb == 0" :  ""));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1165 +1152 @@
     {
         LogRelFunc (("clipboard conversion failed.  vboxClipboardUtf16GetLinSize returned %Rrc.  Abandoning.\n", rc));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         AssertRCReturn(rc, false);
     }
     if (cwDestLen == 0)
     {
-        LogFlowFunc(("received empty clipboard data from the guest, returning false.\n"));
-        vboxClipboardEmptyGuestBuffer();
+        LogFlowFunc(("received empty clipboard data from VBox, returning false.\n"));
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1178 +1165 @@
     {
         LogRelFunc (("failed to allocate %d bytes\n", cwDestLen * 2));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1187 +1174 @@
         LogRelFunc (("clipboard conversion failed.  vboxClipboardUtf16WinToLin() returned %Rrc.  Abandoning.\n", rc));
         RTMemFree(reinterpret_cast<void *>(pu16DestText));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1197 +1184 @@
         LogRelFunc (("failed to allocate %d bytes\n", cwDestLen * 4));
         RTMemFree(reinterpret_cast<void *>(pu16DestText));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1208 +1195 @@
         LogRelFunc (("clipboard conversion failed.  RTUtf16ToUtf8Ex() returned %Rrc.  Abandoning.\n", rc));
         XtFree(pu8DestText);
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
     LogFlowFunc (("converted string is %.*s. Returning.\n", cbDestLen, pu8DestText));
-    vboxClipboardEmptyGuestBuffer();
+    vboxClipboardEmptyVBoxBuffer();
     *atomTypeReturn = g_ctx.atomUtf8;
     *pValReturn = reinterpret_cast<XtPointer>(pu8DestText);
@@ -1221 +1208 @@
 
 /**
- * Satisfy a request from the host to convert the clipboard text to COMPOUND_TEXT.
+ * Satisfy a request from the X11 to convert the clipboard text to COMPOUND_TEXT.
  *
  * @returns true if we successfully convert the data to the format requested, false otherwise.
@@ -1245 +1232 @@
 
     LogFlowFunc (("called\n"));
-    /* Read the clipboard data from the guest. */
+    /* Read the clipboard data from VBox. */
     rc = vboxClipboardReadDataFromVBox(&g_ctx, VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT);
     if ((rc != VINF_SUCCESS) || (g_ctx.pClient->data.cb == 0))
@@ -1252 +1239 @@
         LogRelFunc (("vboxClipboardReadDataFromVBox returned %Rrc%s\n", rc,
                       RT_SUCCESS(rc) ? ", g_ctx.pClient->data.cb == 0" :  ""));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1262 +1249 @@
     {
         LogRelFunc (("clipboard conversion failed.  vboxClipboardUtf16GetLinSize returned %Rrc.  Abandoning.\n", rc));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         AssertRCReturn(rc, false);
     }
     if (cwDestLen == 0)
     {
-        LogFlowFunc(("received empty clipboard data from the guest, returning false.\n"));
-        vboxClipboardEmptyGuestBuffer();
+        LogFlowFunc(("received empty clipboard data from VBox, returning false.\n"));
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1275 +1262 @@
     {
         LogRelFunc (("failed to allocate %d bytes\n", cwDestLen * 2));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1284 +1271 @@
         LogRelFunc (("clipboard conversion failed.  vboxClipboardUtf16WinToLin() returned %Rrc.  Abandoning.\n", rc));
         RTMemFree(reinterpret_cast<void *>(pu16DestText));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1293 +1280 @@
     {
         LogRelFunc (("clipboard conversion failed.  RTUtf16ToUtf8Ex() returned %Rrc.  Abandoning.\n", rc));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
@@ -1324 +1311 @@
         LogRelFunc (("Xutf8TextListToTextProperty failed.  Reason: %s\n",
                 pcReason));
-        vboxClipboardEmptyGuestBuffer();
+        vboxClipboardEmptyVBoxBuffer();
         return false;
     }
     LogFlowFunc (("converted string is %s. Returning.\n", property.value));
-    vboxClipboardEmptyGuestBuffer();
+    vboxClipboardEmptyVBoxBuffer();
     *atomTypeReturn = property.encoding;
     *pValReturn = reinterpret_cast<XtPointer>(property.value);
@@ -1420 +1407 @@
     LogFlowFunc (("called, giving VBox clipboard ownership\n"));
     g_ctx.eOwner = X11;
-    g_ctx.notifyGuest = true;
+    g_ctx.notifyVBox = true;
 }
 
@@ -1426 +1413 @@
  * VBox is taking possession of the shared clipboard.
  *
- * @param pClient    Context data for the guest system
- * @param u32Formats Clipboard formats the guest is offering
+ * @param pClient    Context data from VBox
+ * @param u32Formats Clipboard formats that VBox is offering
  * @note    Called by the HGCM clipboard service
  * @thread  HGCM clipboard service thread
@@ -1434 +1421 @@
 {
     /*
-     * Immediately return if we are not connected to the host X server.
+     * Immediately return if we are not connected to the X server.
      */
     if (!g_fHaveX11)
         return;
 
-    pClient->pCtx->guestFormats = u32Formats;
+    pClient->pCtx->vboxFormats = u32Formats;
     LogFlowFunc (("u32Formats=%d\n", u32Formats));
     if (u32Formats == 0)
@@ -1451 +1438 @@
         /* We already own the clipboard, so no need to grab it, especially as that can lead
            to races due to the asynchronous nature of the X11 clipboard.  This event may also
-           have been sent out by the guest to invalidate the Windows clipboard cache. */
+           have been sent out by VBox to invalidate the Windows clipboard cache. */
         LogFlowFunc(("returning\n"));
         return;
     }
-    Log2 (("%s: giving the guest clipboard ownership\n", __PRETTY_FUNCTION__));
+    Log2 (("%s: giving VBox clipboard ownership\n", __PRETTY_FUNCTION__));
     g_ctx.eOwner = VB;
-    g_ctx.hostTextFormat = INVALID;
-    g_ctx.hostBitmapFormat = INVALID;
+    g_ctx.X11TextFormat = INVALID;
+    g_ctx.X11BitmapFormat = INVALID;
     if (XtOwnSelection(g_ctx.widget, g_ctx.atomClipboard, CurrentTime, vboxClipboardConvertForX11,
                        vboxClipboardReturnToX11, 0) != True)
     {
-        Log2 (("%s: returning clipboard ownership to the host\n", __PRETTY_FUNCTION__));
-        /* We set this so that the guest gets notified when we take the clipboard, even if no
-          guest formats are found which we understand. */
-        g_ctx.notifyGuest = true;
+        Log2 (("%s: returning clipboard ownership to X11\n", __PRETTY_FUNCTION__));
+        /* We set this so that VBox gets notified when we take the clipboard, even if no
+          VBox formats are found which we understand. */
+        g_ctx.notifyVBox = true;
         g_ctx.eOwner = X11;
     }
@@ -1477 +1464 @@
  * Called when VBox wants to read the X11 clipboard.
  *
- * @param pClient   Context information about the guest VM
- * @param u32Format The format that the guest would like to receive the data in
+ * @param pClient   Context information from VBox
+ * @param u32Format The format that VBox would like to receive the data in
  * @param pv        Where to write the data to
  * @param cb        The size of the buffer to write the data to
@@ -1489 +1476 @@
 {
     /*
-     * Immediately return if we are not connected to the host X server.
+     * Immediately return if we are not connected to the X server.
      */
     if (!g_fHaveX11)
@@ -1501 +1488 @@
 
     /*
-     * The guest wants to read data in the given format.
+     * VBox wants to read data in the given format.
      */
     if (u32Format & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
     {
-        if (g_ctx.hostTextFormat == INVALID)
+        if (g_ctx.X11TextFormat == INVALID)
         {
             /* No data available. */
             *pcbActual = 0;
-            return VERR_NO_DATA;  /* The guest thinks we have data and we don't */
+            return VERR_NO_DATA;  /* VBox thinks we have data and we don't */
         }
         /* No one else (VBox or X11) should currently be waiting.  The first because
@@ -1515 +1502 @@
          * grabbed the clipboard, so it should not be waiting for data from us. */
         AssertLogRelReturn (ASMAtomicCmpXchgU32(&g_ctx.waiter, VB, NONE), VERR_DEADLOCK);
-        g_ctx.requestHostFormat = g_ctx.hostTextFormat;
+        g_ctx.requestX11Format = g_ctx.X11TextFormat;
         g_ctx.requestBuffer = pv;
         g_ctx.requestBufferSize = cb;
@@ -1523 +1510 @@
         *pcbActual = 0;
         /* Send out a request for the data to the current clipboard owner */
-        XtGetSelectionValue(g_ctx.widget, g_ctx.atomClipboard, g_ctx.atomHostTextFormat,
+        XtGetSelectionValue(g_ctx.widget, g_ctx.atomClipboard, g_ctx.atomX11TextFormat,
                             vboxClipboardGetDataFromX11, reinterpret_cast<XtPointer>(g_ctx.pClient),
                             CurrentTime);
@@ -1547 +1534 @@
  * Called when we have requested data from VBox and that data has arrived.
  *
- * @param pClient   Context information about the guest VM
+ * @param pClient   Context information from VBox
  * @param pv        Buffer to which the data was written
  * @param cb        The size of the data written

trunk/src/VBox/HostServices/SharedClipboard/Makefile.kmk

@@ -38 +38 @@
 VBoxSharedClipboard_SOURCES.darwin = \
         darwin.cpp \
-        clipboard-helper.cpp \
+        $(PATH_ROOT)/src/VBox/GuestHost/SharedClipboard/clipboard-helper.cpp \
         darwin-pasteboard.cpp
 if1of ($(KBUILD_TARGET), linux solaris) ## @todo X11
  ifndef VBOX_HEADLESS
   VBoxSharedClipboard_SOURCES += \
-        clipboard-helper.cpp \
+        $(PATH_ROOT)/src/VBox/GuestHost/SharedClipboard/clipboard-helper.cpp \
         x11-clipboard.cpp
  else

trunk/src/VBox/HostServices/SharedClipboard/darwin-pasteboard.cpp

@@ -29 +29 @@
 #include "VBox/log.h"
 #include "VBox/HostServices/VBoxClipboardSvc.h"
-#include "clipboard-helper.h"
+#include "VBox/GuestHost/clipboard-helper.h"
 
 /* For debugging */

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

@@ -21 +21 @@
  */
 
+#include <string.h>
+#include <stdio.h>
+#include <stdint.h>
+
+#ifdef RT_OS_SOLARIS
+#include <tsol/label.h>
+#endif
+
 #include <vector>
 
-#include <VBox/HostServices/VBoxClipboardSvc.h>
+#include <X11/Xlib.h>
+#include <X11/Xatom.h>
+#include <X11/Intrinsic.h>
+#include <X11/Shell.h>
+#include <X11/Xproto.h>
+#include <X11/StringDefs.h>
 
 #include <iprt/alloc.h>
@@ -34 +47 @@
 #include <iprt/process.h>
 #include <iprt/semaphore.h>
-#include <string.h>
-#include <stdio.h>
-#include <stdint.h>
+
+#include <VBox/GuestHost/clipboard-helper.h>
+#include <VBox/HostServices/VBoxClipboardSvc.h>
 
 #include "VBoxClipboard.h"
-#include "clipboard-helper.h"
-
-#include <X11/Xlib.h>
-#include <X11/Xatom.h>
-#include <X11/Intrinsic.h>
-#include <X11/Shell.h>
-#include <X11/Xproto.h>
-#include <X11/StringDefs.h>
-
-#ifdef RT_OS_SOLARIS
-#include <tsol/label.h>
-#endif
 
 /** Do we want to test Utf16 by disabling other text formats? */