Changeset 7162 in vbox

Timestamp:

Feb 27, 2008 2:28:43 AM (17 years ago)

Author:

vboxsync

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

28452

Message:

r=bird: some missing docs, fixed incorrect cleanup order and made cleanup a little bit faster (user sem, not sleep).

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• Makefile.kmk (modified) (1 diff)
• darwin-pasteboard.cpp (modified) (1 diff)
• darwin.cpp (modified) (4 diffs)

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

@@ -37 +37 @@
         clipboard-helper.cpp \
         darwin-pasteboard.cpp
-if1of ($(BUILD_TARGET),linux solaris)
+if1of ($(BUILD_TARGET),linux solaris) ## @todo X11
  ifndef VBOX_HEADLESS
   VBoxSharedClipboard_SOURCES += \

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

@@ -34 +34 @@
 //#define SHOW_CLIPBOARD_CONTENT
 
+/** @todo r=bird: document these functions */
+
 int initPasteboard (PasteboardRef *pPasteboardRef)
 {

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

@@ -43 +43 @@
 static VBOXCLIPBOARDCONTEXT g_ctx;
 
-int vboxClipboardChanged (VBOXCLIPBOARDCONTEXT *pCtx)
+
+/**
+ * Checks if something is present on the clipboard and calls vboxSvcClipboardReportMsg.
+ * 
+ * @returns IPRT status code (ignored).
+ * @param   pCtx    The context.
+ * 
+ * @todo r=bird: This function does not check if something has _changed_ like indicated by 
+ *               the name. It will instead notify the client every 200ms as long as something
+ *               is on the clipboard. When the clipboard is cleared it will do nothing.
+ *               I somehow cannot think that this intentional behavior...
+ */
+static int vboxClipboardChanged (VBOXCLIPBOARDCONTEXT *pCtx)
 {
     if (pCtx->pClient == NULL)
@@ -61 +73 @@
 }
 
-static int vboxClipboardThread (RTTHREAD self, void *pvUser)
+
+/** 
+ * The poller thread.
+ * 
+ * This thread will check for the arrival of new data on the clipboard.
+ * 
+ * @returns VINF_SUCCESS (not used).
+ * @param   Thread      Our thread handle.
+ * @param   pvUser      Pointer to the VBOXCLIPBOARDCONTEXT structure.
+ * 
+ */
+static int vboxClipboardThread (RTTHREAD ThreadSelf, void *pvUser)
 {
     Log (("vboxClipboardThread: starting clipboard thread\n"));
 
-    AssertReturn (VALID_PTR (pvUser), VERR_INVALID_PARAMETER);
-
-    VBOXCLIPBOARDCONTEXT *pCtx = static_cast <VBOXCLIPBOARDCONTEXT*> (pvUser);
+    AssertPtrReturn (pvUser, VERR_INVALID_PARAMETER);
+    VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *) pvUser;
 
     while (!pCtx->fTerminate)
     {
-       vboxClipboardChanged (pCtx);
-       /* Sleep for 200 msecs before next poll */
-       RTThreadSleep (200);
-    }
-
-    Log (("vboxClipboardThread: clipboard thread terminated successfully with return code %Vrc\n", VINF_SUCCESS));
+        vboxClipboardChanged (pCtx);
+        /* Sleep for 200 msecs before next poll */
+        RTThreadUserWait (self, 200);
+    }
+
+    Log (("vboxClipboardThread: clipboard thread terminated successfully with return code %Rrc\n", VINF_SUCCESS));
     return VINF_SUCCESS;
 }
@@ -89 +111 @@
     Log (("vboxClipboardInit\n"));
 
-    int rc = VINF_SUCCESS;
-
     g_ctx.fTerminate = false;
 
-    rc = initPasteboard (&g_ctx.pasteboard);
+    int rc = initPasteboard (&g_ctx.pasteboard);
+    AssertRCReturn (rc, rc);
 
     rc = RTThreadCreate (&g_ctx.thread, vboxClipboardThread, &g_ctx, 0,
                          RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "SHCLIP");
+    if (RT_FAILURE (rc))
+    {
+        g_ctx.thread = NIL_RTTHREAD;
+        destroyPasteboard (&g_ctx.pasteboard);
+    }
 
     return rc;
@@ -106 +132 @@
     Log (("vboxClipboardDestroy\n"));
 
-    g_ctx.fTerminate = true;
-
+    /* 
+     * Signal the termination of the polling thread and wait for it to respond.
+     */
+    ASMAtomicWriteBool (&g_ctx.fTerminate, true);
+    int rc = RTThreadUserSignal (g_ctx.thread);
+    AssertRC (rc);
+    rc = RTThreadWait (g_ctx.thread, RT_INDEFINITE_WAIT, NULL);
+    AssertRC (rc);
+
+    /*
+     * Destroy the pasteboard and uninitialize the global context record.
+     */
     destroyPasteboard (&g_ctx.pasteboard);
-
-    /* Wait for the clipboard thread to terminate. */
-    RTThreadWait (g_ctx.thread, RT_INDEFINITE_WAIT, NULL);
-
     g_ctx.thread = NIL_RTTHREAD;
-}
-
-/**
-  * Enable the shared clipboard - called by the hgcm clipboard subsystem.
-  *
-  * @param   pClient Structure containing context information about the guest system
-  * @returns RT status code
-  */
+    g_ctx.pClient = NULL;
+}
+
+/**
+ * Enable the shared clipboard - called by the hgcm clipboard subsystem.
+ *
+ * @param   pClient Structure containing context information about the guest system
+ * @returns RT status code
+ */
 int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient)
 {