Changeset 18708 in vbox

Timestamp:

Apr 3, 2009 5:55:59 PM (16 years ago)

Author:

vboxsync

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

45652

Message:

GuestHost/SharedClipboard: reorganise constructor and destructor funcions

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard.h (modified) (2 diffs)
• src/VBox/GuestHost/SharedClipboard/x11-clipboard.cpp (modified) (5 diffs)
• src/VBox/HostServices/SharedClipboard/x11-clipboard.cpp (modified) (4 diffs)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -40 +40 @@
 
 /** Does X11 or VBox currently own the clipboard? */
+/** @todo This is ugly, get rid of it. */
 enum g_eOwner { NONE = 0, X11, VB };
 
@@ -62 +63 @@
 
 /* APIs exported by the X11 backend */
-extern int VBoxX11ClipboardInitX11(VBOXCLIPBOARDCONTEXT *pFrontend,
-                                   VBOXCLIPBOARDCONTEXTX11 **ppBackend);
-extern int VBoxX11ClipboardTermX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
+extern VBOXCLIPBOARDCONTEXTX11 *VBoxX11ClipboardConstructX11
+                                        (VBOXCLIPBOARDCONTEXT *pFrontend);
+extern void VBoxX11ClipboardDestructX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
 extern int VBoxX11ClipboardStartX11(VBOXCLIPBOARDCONTEXTX11 *pBackend,
-                                    enum g_eOwner owner);
+                                    bool fOwnsClipboard);
+extern int VBoxX11ClipboardStopX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
 extern void VBoxX11ClipboardRequestSyncX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
-extern void VBoxX11ClipboardStopX11(VBOXCLIPBOARDCONTEXTX11 *pBackend);
 extern void VBoxX11ClipboardAnnounceVBoxFormat(VBOXCLIPBOARDCONTEXTX11
                                                *pBackend, uint32_t u32Formats);

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

@@ -694 +694 @@
 
 /**
- * Initialise the X11 backend of the shared clipboard.
+ * Construct the X11 backend of the shared clipboard.
  * @note  X11 backend code
  */
-int VBoxX11ClipboardInitX11(VBOXCLIPBOARDCONTEXT *pFrontend,
-                            VBOXCLIPBOARDCONTEXTX11 **ppBackend)
+VBOXCLIPBOARDCONTEXTX11 *VBoxX11ClipboardConstructX11
+                                 (VBOXCLIPBOARDCONTEXT *pFrontend)
 {
     int rc;
@@ -704 +704 @@
     VBOXCLIPBOARDCONTEXTX11 *pCtx = &g_ctxX11;
     /** @todo we still only support one backend at a time, because the X
-     * toolkit intrinsics don't support user data in XtOwnSelection.  Not
-     * a big problem, but not clean either. */
-    AssertReturn(g_pCtx == NULL, VERR_NOT_SUPPORTED);
+     * toolkit intrinsics don't support user data in XtOwnSelection.
+     * This function should not fail like this. */
+    AssertReturn(g_pCtx == NULL, NULL);
     g_pCtx = &g_ctxX11;
     if (!RTEnvGet("DISPLAY"))
     {
         /*
-         * If we don't find the DISPLAY environment variable we assume that we are not
-         * connected to an X11 server. Don't actually try to do this then, just fail
-         * silently and report success on every call. This is important for VBoxHeadless.
+         * If we don't find the DISPLAY environment variable we assume that
+         * we are not connected to an X11 server. Don't actually try to do
+         * this then, just fail silently and report success on every call.
+         * This is important for VBoxHeadless.
          */
         LogRelFunc(("X11 DISPLAY variable not set -- disabling shared clipboard\n"));
         g_fHaveX11 = false;
-        return VINF_SUCCESS;
+        return pCtx;
     }
 
@@ -746 +747 @@
     pCtx->pFrontend = pFrontend;
     RTSemEventCreate(&pCtx->waitForData);
-    rc = vboxClipboardInitX11(pCtx);
-    if (RT_SUCCESS(rc))
-    {
-        rc = RTThreadCreate(&pCtx->thread, vboxClipboardThread, pCtx, 0,
-                            RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "SHCLIP");
-        if (RT_FAILURE(rc))
-            LogRel(("Failed to initialise the shared clipboard X11 backend.\n"));
-    }
-    if (RT_FAILURE(rc))
-        RTSemEventDestroy(pCtx->waitForData);
-    *ppBackend = pCtx;
-    return rc;
-}
-
-/**
- * Terminate the shared clipboard X11 backend.
+    return pCtx;
+}
+
+/**
+ * Destruct the shared clipboard X11 backend.
  * @note  X11 backend code
  */
-int VBoxX11ClipboardTermX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
-{
-    int rc, rcThread;
-    unsigned count = 0;
-    XEvent ev;
-
+void VBoxX11ClipboardDestructX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
+{
+    /*
+     * Immediately return if we are not connected to the host X server.
+     */
+    if (!g_fHaveX11)
+        return;
+
+    RTSemEventDestroy(pCtx->waitForData);
+}
+
+/**
+ * Announce to the X11 backend that we are ready to start.
+ * @param  owner who is the initial clipboard owner
+ */
+int VBoxX11ClipboardStartX11(VBOXCLIPBOARDCONTEXTX11 *pCtx,
+                             bool fOwnsClipboard)
+{
+    int rc = VINF_SUCCESS;
+    LogFlowFunc(("\n"));
     /*
      * Immediately return if we are not connected to the host X server.
@@ -776 +780 @@
         return VINF_SUCCESS;
 
-    LogRelFunc(("shutting down the shared clipboard X11 backend\n"));
+    rc = vboxClipboardInitX11(pCtx);
+    if (RT_SUCCESS(rc))
+    {
+        rc = RTThreadCreate(&pCtx->thread, vboxClipboardThread, pCtx, 0,
+                            RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "SHCLIP");
+        if (RT_FAILURE(rc))
+            LogRel(("Failed to initialise the shared clipboard X11 backend.\n"));
+    }
+    if (RT_SUCCESS(rc))
+    {
+        if (fOwnsClipboard)
+        {
+            pCtx->eOwner = X11;
+            pCtx->notifyVBox = true;
+        }
+        else
+        {
+            /** @todo Check whether the guest gets a format announcement at
+              *       startup. */
+            pCtx->eOwner = VB;
+            VBoxX11ClipboardAnnounceVBoxFormat(pCtx, 0);
+        }
+    }
+    return rc;
+}
+
+/**
+ * Called when the VBox may have fallen out of sync with the backend.
+ * @note  X11 backend code
+ */
+void VBoxX11ClipboardRequestSyncX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
+{
+    /*
+     * Immediately return if we are not connected to the host X server.
+     */
+    if (!g_fHaveX11)
+        return;
+    pCtx->notifyVBox = true;
+}
+
+/**
+ * Shut down the shared clipboard X11 backend.
+ * @note  X11 backend code
+ */
+int VBoxX11ClipboardStopX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
+{
+    int rc, rcThread;
+    unsigned count = 0;
+    XEvent ev;
+    /*
+     * Immediately return if we are not connected to the host X server.
+     */
+    if (!g_fHaveX11)
+        return VINF_SUCCESS;
+
+    pCtx->eOwner = NONE;
+    pCtx->X11TextFormat = INVALID;
+    pCtx->X11BitmapFormat = INVALID;
+    LogRelFunc(("stopping the shared clipboard X11 backend\n"));
 
     /* Set the termination flag.  This has been observed to block if it was set
@@ -795 +857 @@
     } while ((VERR_TIMEOUT == rc) && (count < 300));
     if (RT_SUCCESS(rc))
-    {
-        /* We can safely destroy this now, as only this thread ever waits
-         * for it. */
-        RTSemEventDestroy(pCtx->waitForData);
         AssertRC(rcThread);
-    }
     else
-        LogRel(("vboxClipboardDestroy: rc=%Rrc\n", rc));
+        LogRelFunc(("rc=%Rrc\n", rc));
     XtCloseDisplay(XtDisplay(pCtx->widget));
     LogFlowFunc(("returning %Rrc.\n", rc));
     return rc;
-}
-
-/**
- * Announce to the X11 backend that we are ready to start.
- * @param  owner who is the initial clipboard owner
- */
-int VBoxX11ClipboardStartX11(VBOXCLIPBOARDCONTEXTX11 *pCtx,
-                             enum g_eOwner owner)
-{
-    LogFlowFunc(("\n"));
-    /*
-     * Immediately return if we are not connected to the host X server.
-     */
-    if (!g_fHaveX11)
-        return VINF_SUCCESS;
-
-    pCtx->eOwner = owner;
-    if (owner == X11)
-        pCtx->notifyVBox = true;
-    else
-    {
-        /** @todo Check whether the guest gets a format announcement at
-          *       startup. */
-        VBoxX11ClipboardAnnounceVBoxFormat(pCtx, 0);
-    }
-    return VINF_SUCCESS;
-}
-
-/**
- * Called when the VBox may have fallen out of sync with the backend.
- * @note  X11 backend code
- */
-void VBoxX11ClipboardRequestSyncX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
-{
-    /*
-     * Immediately return if we are not connected to the host X server.
-     */
-    if (!g_fHaveX11)
-        return;
-    pCtx->notifyVBox = true;
-}
-
-/**
- * Shut down the shared clipboard X11 backend.
- * @note  X11 backend code
- */
-void VBoxX11ClipboardStopX11(VBOXCLIPBOARDCONTEXTX11 *pCtx)
-{
-    /*
-     * Immediately return if we are not connected to the host X server.
-     */
-    if (!g_fHaveX11)
-        return;
-
-    pCtx->eOwner = NONE;
-    pCtx->X11TextFormat = INVALID;
-    pCtx->X11BitmapFormat = INVALID;
 }
 

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

@@ -164 +164 @@
     RTSemEventCreate(&g_ctxHost.waitForData);
     RTSemMutexCreate(&g_ctxHost.clipboardMutex);
-    rc = VBoxX11ClipboardInitX11(&g_ctxHost, &pBackend);
-    if (RT_FAILURE(rc))
+    pBackend = VBoxX11ClipboardConstructX11(&g_ctxHost);
+    if (pBackend == NULL)
     {
         RTSemEventDestroy(g_ctxHost.waitForData);
         RTSemMutexDestroy(g_ctxHost.clipboardMutex);
-        LogRel(("Failed to start the host shared clipboard service.\n"));
+        LogRel(("Failed to start the host shared clipboard service, out of memory.\n"));
+        rc = VERR_NO_MEMORY;
     }
     else
@@ -198 +199 @@
      *         even if we are not waiting. */
     RTSemEventSignal(g_ctxHost.waitForData);
-    rc = VBoxX11ClipboardTermX11(g_ctxHost.pBackend);
-    if (RT_SUCCESS(rc))
-    {
-        /* We can safely destroy these as the backend has exited
-         * successfully and no other calls from the host code should be
-         * forthcoming. */
-        /** @todo  can the backend fail to exit successfully?  What then? */
-        RTSemEventDestroy(g_ctxHost.waitForData);
-        RTSemMutexDestroy(g_ctxHost.clipboardMutex);
-    }
+    VBoxX11ClipboardDestructX11(g_ctxHost.pBackend);
+    /* We can safely destroy these as the backend has exited
+     * successfully and no other calls from the host code should be
+     * forthcoming. */
+    RTSemEventDestroy(g_ctxHost.waitForData);
+    RTSemMutexDestroy(g_ctxHost.clipboardMutex);
 }
 
@@ -227 +224 @@
      * client at a time. */
     rc = VBoxX11ClipboardStartX11(g_ctxHost.pBackend,
-                                  X11 /* initial owner */);
+                                  true /* fOwnClipboard */);
     return rc;
 }
@@ -263 +260 @@
     RTSemMutexRequest(g_ctxHost.clipboardMutex, RT_INDEFINITE_WAIT);
     g_ctxHost.pClient = NULL;
-    VBoxX11ClipboardStopX11(g_ctxHost.pBackend);
+    /** @todo handle this slightly more reasonably, or be really sure
+     *        it won't go wrong. */
+    AssertRC(VBoxX11ClipboardStopX11(g_ctxHost.pBackend));
     RTSemMutexRelease(g_ctxHost.clipboardMutex);
 }