Changeset 78151 in vbox

Timestamp:

Apr 17, 2019 12:03:42 PM (5 years ago)

Author:

vboxsync

Message:

Shared Clipboard: Got rid of a lot of duplicated code between Windows hosts / guests, plus a lot of renaming / cleanup, some more documentation.

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard-win.h (added)
• include/VBox/GuestHost/SharedClipboard.h (modified) (2 diffs)
• include/VBox/HostServices/VBoxClipboardSvc.h (modified) (2 diffs)
• src/VBox/Additions/WINNT/VBoxTray/Makefile.kmk (modified) (2 diffs)
• src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp (modified) (27 diffs)
• src/VBox/GuestHost/SharedClipboard/clipboard-win.cpp (added)
• src/VBox/HostServices/SharedClipboard/Makefile.kmk (modified) (1 diff)
• src/VBox/HostServices/SharedClipboard/VBoxClipboard-win.cpp (modified) (39 diffs)
• src/VBox/HostServices/SharedClipboard/VBoxClipboard.h (modified) (3 diffs)
• src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp (modified) (3 diffs)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -33 +33 @@
 #include <iprt/types.h>
 
+/**
+ * Supported data formats for Shared Clipboard. Bit mask.
+ */
+/** Shared Clipboard format is an Unicode text. */
+#define VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT   UINT32_C(0x01)
+/** Shared Clipboard format is bitmap (BMP / DIB). */
+#define VBOX_SHARED_CLIPBOARD_FMT_BITMAP        UINT32_C(0x02)
+/** Shared Clipboard format is HTML. */
+#define VBOX_SHARED_CLIPBOARD_FMT_HTML          UINT32_C(0x04)
+
+/**
+ * The host messages for the guest.
+ */
+#define VBOX_SHARED_CLIPBOARD_HOST_MSG_QUIT        1
+#define VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA   2
+#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS     3
+
 enum
 {
@@ -46 +63 @@
 struct _VBOXCLIPBOARDCONTEXT;
 typedef struct _VBOXCLIPBOARDCONTEXT VBOXCLIPBOARDCONTEXT;
+typedef struct _VBOXCLIPBOARDCONTEXT *PVBOXCLIPBOARDCONTEXT;
 
 /** Opaque data structure for the X11/VBox backend code. */

trunk/include/VBox/HostServices/VBoxClipboardSvc.h

@@ -43 +43 @@
 
 /*
- * Supported data formats. Bit mask.
- */
-#define VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT   UINT32_C(0x01)
-#define VBOX_SHARED_CLIPBOARD_FMT_BITMAP        UINT32_C(0x02)
-#define VBOX_SHARED_CLIPBOARD_FMT_HTML          UINT32_C(0x04)
-
-/*
  * The service functions which are callable by host.
  */
@@ -67 +60 @@
 /* Send data in requested format to host. */
 #define VBOX_SHARED_CLIPBOARD_FN_WRITE_DATA        4
-
-/*
- * The host messages for the guest.
- */
-#define VBOX_SHARED_CLIPBOARD_HOST_MSG_QUIT        1
-#define VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA   2
-#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS     3
 
 /*

trunk/src/VBox/Additions/WINNT/VBoxTray/Makefile.kmk

@@ -37 +37 @@
         VBoxDispIf.cpp \
         VBoxSeamless.cpp \
-        VBoxClipboard.cpp \
         VBoxDisplay.cpp \
         VBoxVRDP.cpp \
@@ -46 +45 @@
 VBoxTray_VBOX_IMPORT_CHECKER.win.x86 = nt4 #nt350
 VBoxTray_VBOX_IMPORT_CHECKER.win.amd64 = xp64
+ifdef VBOX_WITH_SHARED_CLIPBOARD
+ VBoxTray_DEFS     += \
+        VBOX_WITH_SHARED_CLIPBOARD
+ VBoxTray_SOURCES  += \
+        VBoxClipboard.cpp \
+        $(PATH_ROOT)/src/VBox/GuestHost/SharedClipboard/clipboard-win.cpp
+endif
 ifdef VBOX_WITH_DRAG_AND_DROP
  VBoxTray_DEFS     += \

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp

@@ -27 +27 @@
 #include <iprt/ldr.h>
 
-#include <VBox/HostServices/VBoxClipboardSvc.h>
+#include <VBox/GuestHost/SharedClipboard.h>
+#include <VBox/GuestHost/SharedClipboard-win.h>
 #include <strsafe.h>
 
@@ -36 +37 @@
 *   Structures and Typedefs                                                                                                      *
 *********************************************************************************************************************************/
-/* Dynamically load clipboard functions from User32.dll. */
-typedef BOOL WINAPI FNADDCLIPBOARDFORMATLISTENER(HWND);
-typedef FNADDCLIPBOARDFORMATLISTENER *PFNADDCLIPBOARDFORMATLISTENER;
-
-typedef BOOL WINAPI FNREMOVECLIPBOARDFORMATLISTENER(HWND);
-typedef FNREMOVECLIPBOARDFORMATLISTENER *PFNREMOVECLIPBOARDFORMATLISTENER;
-
-#ifndef WM_CLIPBOARDUPDATE
-#define WM_CLIPBOARDUPDATE 0x031D
-#endif
-
-/** Sets announced clipboard formats from the host. */
-#define VBOX_WM_SHCLPB_SET_FORMATS      WM_USER
-/** Reads data from the clipboard and sends it to the host. */
-#define VBOX_WM_SHCLPB_READ_DATA        WM_USER + 1
-
-typedef struct _VBOXCLIPBOARDCONTEXT
-{
-    const VBOXSERVICEENV *pEnv;
-    uint32_t              u32ClientID;
-    ATOM                  wndClass;
-    HWND                  hwnd;
-    HWND                  hwndNextInChain;
-    UINT                  timerRefresh;
-    bool                  fCBChainPingInProcess;
-    PFNADDCLIPBOARDFORMATLISTENER pfnAddClipboardFormatListener;
-    PFNREMOVECLIPBOARDFORMATLISTENER pfnRemoveClipboardFormatListener;
-} VBOXCLIPBOARDCONTEXT, *PVBOXCLIPBOARDCONTEXT;
-
-enum { CBCHAIN_TIMEOUT = 5000 /* ms */ };
-
+
+struct _VBOXCLIPBOARDCONTEXT
+{
+    /** Pointer to the VBoxClient service environment. */
+    const VBOXSERVICEENV    *pEnv;
+    /** Client ID the service is connected to the HGCM service with. */
+    uint32_t                 u32ClientID;
+    /** Windows-specific context data. */
+    VBOXCLIPBOARDWINCTX      Win;
+};
 
 /*********************************************************************************************************************************
-*   Header Files                                                                                                                 *
+*   Static variables                                                                                                             *
 *********************************************************************************************************************************/
-/** Static since it is the single instance. Directly used in the windows proc. */
+/** Static clipboard context (since it is the single instance). Directly used in the windows proc. */
 static VBOXCLIPBOARDCONTEXT g_Ctx = { NULL };
-
-static char s_szClipWndClassName[] = "VBoxSharedClipboardClass";
-
-
-static void vboxClipboardInitNewAPI(VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    RTLDRMOD hUser32 = NIL_RTLDRMOD;
-    int rc = RTLdrLoadSystem("User32.dll", /* fNoUnload = */ true, &hUser32);
-    if (RT_SUCCESS(rc))
-    {
-        rc = RTLdrGetSymbol(hUser32, "AddClipboardFormatListener", (void**)&pCtx->pfnAddClipboardFormatListener);
-        if (RT_SUCCESS(rc))
-        {
-            rc = RTLdrGetSymbol(hUser32, "RemoveClipboardFormatListener", (void**)&pCtx->pfnRemoveClipboardFormatListener);
-        }
-
-        RTLdrClose(hUser32);
-    }
-
-    if (RT_SUCCESS(rc))
-    {
-        Log(("New Clipboard API is enabled\n"));
-    }
-    else
-    {
-        pCtx->pfnAddClipboardFormatListener = NULL;
-        pCtx->pfnRemoveClipboardFormatListener = NULL;
-        Log(("New Clipboard API is not available. rc = %Rrc\n", rc));
-    }
-}
-
-static bool vboxClipboardIsNewAPI(VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    return pCtx->pfnAddClipboardFormatListener != NULL;
-}
-
-
-static int vboxOpenClipboard(HWND hWnd)
-{
-    /* "OpenClipboard fails if another window has the clipboard open."
-     * So try a few times and wait up to 1 second.
-     */
-    BOOL fOpened = FALSE;
-
-    LogFlowFunc(("hWnd=%p\n", hWnd));
-
-    int i = 0;
-    for (;;)
-    {
-        if (OpenClipboard(hWnd))
-        {
-            fOpened = TRUE;
-            break;
-        }
-
-        if (i >= 10) /* sleep interval = [1..512] ms */
-            break;
-
-        RTThreadSleep(1 << i);
-        ++i;
-    }
-
-#ifdef LOG_ENABLED
-    if (i > 0)
-        LogFlowFunc(("%d times tried to open clipboard\n", i + 1));
-#endif
-
-    int rc;
-    if (fOpened)
-        rc = VINF_SUCCESS;
-    else
-    {
-        const DWORD dwLastErr = GetLastError();
-        rc = RTErrConvertFromWin32(dwLastErr);
-        LogRel(("Clipboard: Failed to open clipboard! Error=%ld (%Rrc)\n", dwLastErr, rc));
-    }
-
-    return rc;
-}
-
-
-static int vboxClipboardChanged(PVBOXCLIPBOARDCONTEXT pCtx)
+/** Static window class name. */
+static char s_szClipWndClassName[] = VBOX_CLIPBOARD_WNDCLASS_NAME;
+
+
+static LRESULT vboxClipboardProcessMsg(PVBOXCLIPBOARDCONTEXT pCtx, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
 {
     AssertPtr(pCtx);
 
-    /* Query list of available formats and report to host. */
-    int rc = vboxOpenClipboard(pCtx->hwnd);
-    if (RT_SUCCESS(rc))
-    {
-        uint32_t u32Formats = 0;
-        UINT format = 0;
-
-        while ((format = EnumClipboardFormats(format)) != 0)
-        {
-            LogFlowFunc(("vboxClipboardChanged: format = 0x%08X\n", format));
-            switch (format)
-            {
-                case CF_UNICODETEXT:
-                case CF_TEXT:
-                    u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
-                    break;
-
-                case CF_DIB:
-                case CF_BITMAP:
-                    u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_BITMAP;
-                    break;
-
-                default:
-                {
-                    if (format >= 0xC000)
-                    {
-                        TCHAR szFormatName[256];
-
-                        int cActual = GetClipboardFormatName(format, szFormatName, sizeof(szFormatName)/sizeof (TCHAR));
-                        if (cActual)
-                        {
-                            if (strcmp (szFormatName, "HTML Format") == 0)
-                            {
-                                u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_HTML;
-                            }
-                        }
-                    }
-                    break;
-                }
-            }
-        }
-
-        CloseClipboard();
-        rc = VbglR3ClipboardReportFormats(pCtx->u32ClientID, u32Formats);
-    }
-    return rc;
-}
-
-/* Add ourselves into the chain of cliboard listeners */
-static void vboxClipboardAddToCBChain(PVBOXCLIPBOARDCONTEXT pCtx)
-{
-    AssertPtrReturnVoid(pCtx);
-    if (vboxClipboardIsNewAPI(pCtx))
-        pCtx->pfnAddClipboardFormatListener(pCtx->hwnd);
-    else
-        pCtx->hwndNextInChain = SetClipboardViewer(pCtx->hwnd);
-    /** @todo r=andy Return code?? */
-}
-
-/* Remove ourselves from the chain of cliboard listeners */
-static void vboxClipboardRemoveFromCBChain(PVBOXCLIPBOARDCONTEXT pCtx)
-{
-    AssertPtrReturnVoid(pCtx);
-
-    if (vboxClipboardIsNewAPI(pCtx))
-    {
-        pCtx->pfnRemoveClipboardFormatListener(pCtx->hwnd);
-    }
-    else
-    {
-        ChangeClipboardChain(pCtx->hwnd, pCtx->hwndNextInChain);
-        pCtx->hwndNextInChain = NULL;
-    }
-    /** @todo r=andy Return code?? */
-}
-
-/* Callback which is invoked when we have successfully pinged ourselves down the
- * clipboard chain.  We simply unset a boolean flag to say that we are responding.
- * There is a race if a ping returns after the next one is initiated, but nothing
- * very bad is likely to happen. */
-VOID CALLBACK vboxClipboardChainPingProc(HWND hWnd, UINT uMsg, ULONG_PTR dwData, LRESULT lResult)
-{
-    NOREF(hWnd);
-    NOREF(uMsg);
-    NOREF(lResult);
-
-    /** @todo r=andy Why not using SetWindowLongPtr for keeping the context? */
-    PVBOXCLIPBOARDCONTEXT pCtx = (PVBOXCLIPBOARDCONTEXT)dwData;
-    AssertPtr(pCtx);
-
-    pCtx->fCBChainPingInProcess = FALSE;
-}
-
-static LRESULT vboxClipboardProcessMsg(PVBOXCLIPBOARDCONTEXT pCtx, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
-{
-    AssertPtr(pCtx);
+    const PVBOXCLIPBOARDWINCTX pWinCtx = &pCtx->Win;
 
     LRESULT rc = 0;
@@ -266 +74 @@
             {
                 /* Clipboard was updated by another application. */
-                vboxClipboardChanged(pCtx);
+                uint32_t uFormats;
+                int vboxrc = VBoxClipboardWinGetFormats(&pCtx->Win, &uFormats);
+                if (RT_SUCCESS(vboxrc))
+                    vboxrc = VbglR3ClipboardReportFormats(pCtx->u32ClientID, uFormats);
             }
         } break;
@@ -272 +83 @@
         case WM_CHANGECBCHAIN:
         {
-            if (vboxClipboardIsNewAPI(pCtx))
+            if (VBoxClipboardWinIsNewAPI(&pWinCtx->newAPI))
             {
                 rc = DefWindowProc(hwnd, msg, wParam, lParam);
@@ -278 +89 @@
             }
 
-            HWND hwndRemoved = (HWND)wParam;
-            HWND hwndNext    = (HWND)lParam;
-
-            LogFlowFunc(("WM_CHANGECBCHAIN: hwndRemoved %p, hwndNext %p, hwnd %p\n", hwndRemoved, hwndNext, pCtx->hwnd));
-
-            if (hwndRemoved == pCtx->hwndNextInChain)
+            HWND hWndRemoved = (HWND)wParam;
+            HWND hWndNext    = (HWND)lParam;
+
+            LogFlowFunc(("WM_CHANGECBCHAIN: hWndRemoved=%p, hWndNext=%p, hWnd=%p\n", hWndRemoved, hWndNext, pWinCtx->hWnd));
+
+            if (hWndRemoved == pWinCtx->hWndNextInChain)
             {
                 /* The window that was next to our in the chain is being removed.
                  * Relink to the new next window. */
-                pCtx->hwndNextInChain = hwndNext;
+                pWinCtx->hWndNextInChain = hWndNext;
             }
             else
             {
-                if (pCtx->hwndNextInChain)
+                if (pWinCtx->hWndNextInChain)
                 {
                     /* Pass the message further. */
                     DWORD_PTR dwResult;
-                    rc = SendMessageTimeout(pCtx->hwndNextInChain, WM_CHANGECBCHAIN, wParam, lParam, 0, CBCHAIN_TIMEOUT, &dwResult);
+                    rc = SendMessageTimeout(pWinCtx->hWndNextInChain, WM_CHANGECBCHAIN, wParam, lParam, 0,
+                                            VBOX_CLIPBOARD_CBCHAIN_TIMEOUT_MS, &dwResult);
                     if (!rc)
                         rc = (LRESULT) dwResult;
@@ -304 +116 @@
         case WM_DRAWCLIPBOARD:
         {
-            LogFlowFunc(("WM_DRAWCLIPBOARD, hwnd %p\n", pCtx->hwnd));
+            LogFlowFunc(("WM_DRAWCLIPBOARD, hwnd %p\n", pWinCtx->hWnd));
 
             if (GetClipboardOwner() != hwnd)
@@ -310 +122 @@
                 /* Clipboard was updated by another application. */
                 /* WM_DRAWCLIPBOARD always expects a return code of 0, so don't change "rc" here. */
-                int vboxrc = vboxClipboardChanged(pCtx);
-                if (RT_FAILURE(vboxrc))
-                    LogFlowFunc(("vboxClipboardChanged failed, rc = %Rrc\n", vboxrc));
-            }
-
-            if (pCtx->hwndNextInChain)
+                uint32_t uFormats;
+                int vboxrc = VBoxClipboardWinGetFormats(pWinCtx, &uFormats);
+                if (RT_SUCCESS(vboxrc))
+                    vboxrc = VbglR3ClipboardReportFormats(pCtx->u32ClientID, uFormats);
+            }
+
+            if (pWinCtx->hWndNextInChain)
             {
                 /* Pass the message to next windows in the clipboard chain. */
-                SendMessageTimeout(pCtx->hwndNextInChain, msg, wParam, lParam, 0, CBCHAIN_TIMEOUT, NULL);
+                SendMessageTimeout(pWinCtx->hWndNextInChain, msg, wParam, lParam, 0, VBOX_CLIPBOARD_CBCHAIN_TIMEOUT_MS, NULL);
             }
         } break;
@@ -324 +137 @@
         case WM_TIMER:
         {
-            if (vboxClipboardIsNewAPI(pCtx))
+            if (VBoxClipboardWinIsNewAPI(&pWinCtx->newAPI))
                 break;
 
@@ -331 +144 @@
             /* Re-register ourselves in the clipboard chain if our last ping
              * timed out or there seems to be no valid chain. */
-            if (!hViewer || pCtx->fCBChainPingInProcess)
-            {
-                vboxClipboardRemoveFromCBChain(pCtx);
-                vboxClipboardAddToCBChain(pCtx);
-            }
+            if (!hViewer || pWinCtx->oldAPI.fCBChainPingInProcess)
+            {
+                VBoxClipboardWinRemoveFromCBChain(pWinCtx);
+                VBoxClipboardWinAddToCBChain(pWinCtx);
+            }
+
             /* Start a new ping by passing a dummy WM_CHANGECBCHAIN to be
              * processed by ourselves to the chain. */
-            pCtx->fCBChainPingInProcess = TRUE;
+            pWinCtx->oldAPI.fCBChainPingInProcess = TRUE;
+
             hViewer = GetClipboardViewer();
             if (hViewer)
-                SendMessageCallback(hViewer, WM_CHANGECBCHAIN, (WPARAM)pCtx->hwndNextInChain, (LPARAM)pCtx->hwndNextInChain, vboxClipboardChainPingProc, (ULONG_PTR)pCtx);
+                SendMessageCallback(hViewer, WM_CHANGECBCHAIN, (WPARAM)pWinCtx->hWndNextInChain, (LPARAM)pWinCtx->hWndNextInChain,
+                                    VBoxClipboardWinChainPingProc, (ULONG_PTR)pWinCtx);
         } break;
 
@@ -387 +203 @@
                 /* Unsupported clipboard format is requested. */
                 LogFlowFunc(("Unsupported clipboard format requested: %ld\n", u32Format));
-                EmptyClipboard();
+                VBoxClipboardWinClear();
             }
             else
@@ -518 +334 @@
 
                 /* Something went wrong. */
-                EmptyClipboard();
+                VBoxClipboardWinClear();
             }
         } break;
@@ -527 +343 @@
              * windows is to be destroyed and therefore the guest side becomes inactive.
              */
-            int vboxrc = vboxOpenClipboard(hwnd);
+            int vboxrc = VBoxClipboardWinOpen(hwnd);
             if (RT_SUCCESS(vboxrc))
             {
-                EmptyClipboard();
-                CloseClipboard();
-            }
-        } break;
-
-        case VBOX_WM_SHCLPB_SET_FORMATS:
+                VBoxClipboardWinClear();
+                VBoxClipboardWinClose();
+            }
+        } break;
+
+        case VBOX_CLIPBOARD_WM_SET_FORMATS:
         {
             /* Announce available formats. Do not insert data, they will be inserted in WM_RENDER*. */
@@ -542 +358 @@
             LogFlowFunc(("VBOX_WM_SHCLPB_SET_FORMATS: u32Formats=0x%x\n", u32Formats));
 
-            int vboxrc = vboxOpenClipboard(hwnd);
+            int vboxrc = VBoxClipboardWinOpen(hwnd);
             if (RT_SUCCESS(vboxrc))
             {
-                EmptyClipboard();
+                VBoxClipboardWinClear();
 
                 HANDLE hClip = NULL;
@@ -562 +378 @@
                 }
 
-                CloseClipboard();
+                VBoxClipboardWinClose();
 
                 LogFlowFunc(("VBOX_WM_SHCLPB_SET_FORMATS: hClip=%p, lastErr=%ld\n", hClip, GetLastError()));
@@ -568 +384 @@
         } break;
 
-        case VBOX_WM_SHCLPB_READ_DATA:
+        case VBOX_CLIPBOARD_WM_READ_DATA:
         {
             /* Send data in the specified format to the host. */
@@ -576 +392 @@
             LogFlowFunc(("VBOX_WM_SHCLPB_READ_DATA: u32Formats=0x%x\n", u32Formats));
 
-            int vboxrc = vboxOpenClipboard(hwnd);
+            int vboxrc = VBoxClipboardWinOpen(hwnd);
             if (RT_SUCCESS(vboxrc))
             {
@@ -642 +458 @@
                 }
 
-                CloseClipboard();
+                VBoxClipboardWinClose();
             }
 
@@ -654 +470 @@
         case WM_DESTROY:
         {
-            vboxClipboardRemoveFromCBChain(pCtx);
-            if (pCtx->timerRefresh)
-                KillTimer(pCtx->hwnd, 0);
+            VBoxClipboardWinRemoveFromCBChain(pWinCtx);
+            if (pWinCtx->oldAPI.timerRefresh)
+                KillTimer(pWinCtx->hWnd, 0);
             /*
              * don't need to call PostQuitMessage cause
@@ -699 +515 @@
         wc.lpszClassName = s_szClipWndClassName;
 
-        pCtx->wndClass = RegisterClassEx(&wc);
-        if (pCtx->wndClass == 0)
+        ATOM wndClass = RegisterClassEx(&wc);
+        if (wndClass == 0)
             rc = RTErrConvertFromWin32(GetLastError());
     }
@@ -706 +522 @@
     if (RT_SUCCESS(rc))
     {
+        const PVBOXCLIPBOARDWINCTX pWinCtx = &pCtx->Win;
+
         /* Create the window. */
-        pCtx->hwnd = CreateWindowEx(WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
-                                    s_szClipWndClassName, s_szClipWndClassName,
-                                    WS_POPUPWINDOW,
-                                    -200, -200, 100, 100, NULL, NULL, hInstance, NULL);
-        if (pCtx->hwnd == NULL)
+        pWinCtx->hWnd = CreateWindowEx(WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
+                                       s_szClipWndClassName, s_szClipWndClassName,
+                                       WS_POPUPWINDOW,
+                                       -200, -200, 100, 100, NULL, NULL, hInstance, NULL);
+        if (pWinCtx->hWnd == NULL)
         {
             rc = VERR_NOT_SUPPORTED;
@@ -717 +535 @@
         else
         {
-            SetWindowPos(pCtx->hwnd, HWND_TOPMOST, -200, -200, 0, 0,
+            SetWindowPos(pWinCtx->hWnd, HWND_TOPMOST, -200, -200, 0, 0,
                          SWP_NOACTIVATE | SWP_HIDEWINDOW | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
 
-            vboxClipboardAddToCBChain(pCtx);
-            if (!vboxClipboardIsNewAPI(pCtx))
-                pCtx->timerRefresh = SetTimer(pCtx->hwnd, 0, 10 * 1000, NULL);
+            VBoxClipboardWinAddToCBChain(pWinCtx);
+            if (!VBoxClipboardWinIsNewAPI(&pWinCtx->newAPI))
+                pWinCtx->oldAPI.timerRefresh = SetTimer(pWinCtx->hWnd, 0, 10 * 1000 /* 10s */, NULL);
         }
     }
@@ -734 +552 @@
     AssertPtrReturnVoid(pCtx);
 
-    if (pCtx->hwnd)
+    const PVBOXCLIPBOARDWINCTX pWinCtx = &pCtx->Win;
+
+    if (pWinCtx->hWnd)
     {
-        DestroyWindow(pCtx->hwnd);
-        pCtx->hwnd = NULL;
+        DestroyWindow(pWinCtx->hWnd);
+        pWinCtx->hWnd = NULL;
     }
 
-    if (pCtx->wndClass != 0)
-    {
-        UnregisterClass(s_szClipWndClassName, pCtx->pEnv->hInstance);
-        pCtx->wndClass = 0;
-    }
+    UnregisterClass(s_szClipWndClassName, pCtx->pEnv->hInstance);
 }
 
@@ -777 +593 @@
 
     RT_BZERO(pCtx, sizeof(VBOXCLIPBOARDCONTEXT));
+
     pCtx->pEnv = pEnv;
 
     /* Check that new Clipboard API is available */
-    vboxClipboardInitNewAPI(pCtx);
+    VBoxClipboardWinCheckAndInitNewAPI(&pCtx->Win.newAPI);
 
     int rc = VbglR3ClipboardConnect(&pCtx->u32ClientID);
@@ -811 +628 @@
     RTThreadUserSignal(RTThreadSelf());
 
-    PVBOXCLIPBOARDCONTEXT pCtx = (PVBOXCLIPBOARDCONTEXT)pInstance;
+    const PVBOXCLIPBOARDCONTEXT pCtx = (PVBOXCLIPBOARDCONTEXT)pInstance;
     AssertPtr(pCtx);
+
+    const PVBOXCLIPBOARDWINCTX pWinCtx = &pCtx->Win;
 
     int rc;
@@ -846 +665 @@
                      * Forward the information to the window, so it can later
                      * respond to WM_RENDERFORMAT message. */
-                    ::PostMessage(pCtx->hwnd, VBOX_WM_SHCLPB_SET_FORMATS, 0, u32Formats);
+                    ::PostMessage(pWinCtx->hWnd, VBOX_CLIPBOARD_WM_SET_FORMATS, 0, u32Formats);
                 } break;
 
@@ -852 +671 @@
                 {
                     /* The host needs data in the specified format. */
-                    ::PostMessage(pCtx->hwnd, VBOX_WM_SHCLPB_READ_DATA, 0, u32Formats);
+                    ::PostMessage(pWinCtx->hWnd, VBOX_CLIPBOARD_WM_READ_DATA, 0, u32Formats);
                 } break;
 
@@ -927 +746 @@
     VBoxClipboardDestroy
 };
+

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

@@ -35 +35 @@
 VBoxSharedClipboard_SOURCES.win = \
         VBoxClipboard-win.cpp \
+        $(PATH_ROOT)/src/VBox/GuestHost/SharedClipboard/clipboard-win.cpp \
         VBoxSharedClipboardSvc.rc
 VBoxSharedClipboard_SOURCES.darwin = \

trunk/src/VBox/HostServices/SharedClipboard/VBoxClipboard-win.cpp

@@ -24 +24 @@
 
 #include <VBox/HostServices/VBoxClipboardSvc.h>
+#include <VBox/GuestHost/SharedClipboard-win.h>
 
 #include <iprt/alloc.h>
@@ -35 +36 @@
 #include "VBoxClipboard.h"
 
-#define dprintf Log
-
-static char gachWindowClassName[] = "VBoxSharedClipboardClass";
-
-enum { CBCHAIN_TIMEOUT = 5000 /* ms */ };
-
-/* Dynamically load clipboard functions from User32.dll. */
-typedef BOOL WINAPI FNADDCLIPBOARDFORMATLISTENER(HWND);
-typedef FNADDCLIPBOARDFORMATLISTENER *PFNADDCLIPBOARDFORMATLISTENER;
-
-typedef BOOL WINAPI FNREMOVECLIPBOARDFORMATLISTENER(HWND);
-typedef FNREMOVECLIPBOARDFORMATLISTENER *PFNREMOVECLIPBOARDFORMATLISTENER;
-
+/** Static window class name. */
+static char s_szClipWndClassName[] = VBOX_CLIPBOARD_WNDCLASS_NAME;
 
 /*********************************************************************************************************************************
@@ -55 +45 @@
 static int ConvertMimeToCFHTML(const char *pszSource, size_t cb, char **ppszOutput, uint32_t *pcbOutput);
 static bool IsWindowsHTML(const char *source);
-
-
-#ifndef WM_CLIPBOARDUPDATE
-#define WM_CLIPBOARDUPDATE 0x031D
-#endif
+static int vboxClipboardSyncInternal(PVBOXCLIPBOARDCONTEXT pCtx);
 
 struct _VBOXCLIPBOARDCONTEXT
 {
-    HWND    hwnd;
-    HWND    hwndNextInChain;
-
-    UINT     timerRefresh;
-
-    bool     fCBChainPingInProcess;
-
-    RTTHREAD thread;
-
-    HANDLE hRenderEvent;
-
-    VBOXCLIPBOARDCLIENTDATA *pClient;
-
-    PFNADDCLIPBOARDFORMATLISTENER    pfnAddClipboardFormatListener;
-    PFNREMOVECLIPBOARDFORMATLISTENER pfnRemoveClipboardFormatListener;
-
+    /** Handle for window message handling thread. */
+    RTTHREAD                 hThread;
+    /** Event which gets triggered if the host clipboard needs to render its data. */
+    HANDLE                   hRenderEvent;
+    /** Structure for keeping and communicating with client data (from the guest). */
+    PVBOXCLIPBOARDCLIENTDATA pClient;
+    /** Windows-specific context data. */
+    VBOXCLIPBOARDWINCTX      Win;
 };
 
@@ -86 +64 @@
 
 #ifdef LOG_ENABLED
-void vboxClipboardDump(const void *pv, size_t cb, uint32_t u32Format)
+static void vboxClipboardDump(const void *pv, size_t cb, uint32_t u32Format)
 {
     if (u32Format & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
     {
-        Log(("DUMP: VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT:\n"));
+        LogFunc(("VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT:\n"));
         if (pv && cb)
-            Log(("%ls\n", pv));
+            LogFunc(("%ls\n", pv));
         else
-            Log(("%p %d\n", pv, cb));
+            LogFunc(("%p %zu\n", pv, cb));
     }
     else if (u32Format & VBOX_SHARED_CLIPBOARD_FMT_BITMAP)
-        dprintf(("DUMP: VBOX_SHARED_CLIPBOARD_FMT_BITMAP\n"));
+        LogFunc(("VBOX_SHARED_CLIPBOARD_FMT_BITMAP\n"));
     else if (u32Format & VBOX_SHARED_CLIPBOARD_FMT_HTML)
     {
-        Log(("DUMP: VBOX_SHARED_CLIPBOARD_FMT_HTML:\n"));
+        LogFunc(("VBOX_SHARED_CLIPBOARD_FMT_HTML:\n"));
         if (pv && cb)
         {
-            Log(("%s\n", pv));
+            LogFunc(("%s\n", pv));
 
             //size_t cb = RTStrNLen(pv, );
@@ -114 +92 @@
             }
 
-            Log(("%s\n", pszBuf));
+            LogFunc(("%s\n", pszBuf));
             RTMemFree(pszBuf);
         }
         else
-            Log(("%p %d\n", pv, cb));
+            LogFunc(("%p %zu\n", pv, cb));
     }
     else
-        dprintf(("DUMP: invalid format %02X\n", u32Format));
+        LogFunc(("Invalid format %02X\n", u32Format));
 }
 #else  /* !LOG_ENABLED */
@@ -127 +105 @@
 #endif /* !LOG_ENABLED */
 
-
-static void vboxClipboardInitNewAPI(VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    RTLDRMOD hUser32 = NIL_RTLDRMOD;
-    int rc = RTLdrLoadSystem("User32.dll", /* fNoUnload = */ true, &hUser32);
-    if (RT_SUCCESS(rc))
-    {
-        rc = RTLdrGetSymbol(hUser32, "AddClipboardFormatListener", (void**)&pCtx->pfnAddClipboardFormatListener);
-        if (RT_SUCCESS(rc))
-        {
-            rc = RTLdrGetSymbol(hUser32, "RemoveClipboardFormatListener", (void**)&pCtx->pfnRemoveClipboardFormatListener);
-        }
-
-        RTLdrClose(hUser32);
-    }
-
-    if (RT_SUCCESS(rc))
-    {
-        Log(("New Clipboard API is enabled\n"));
-    }
-    else
-    {
-        pCtx->pfnAddClipboardFormatListener = NULL;
-        pCtx->pfnRemoveClipboardFormatListener = NULL;
-        Log(("New Clipboard API is not available. rc = %Rrc\n", rc));
-    }
-}
-
-static bool vboxClipboardIsNewAPI(VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    return pCtx->pfnAddClipboardFormatListener != NULL;
-}
-
-
-static int vboxOpenClipboard(HWND hwnd)
-{
-    /* "OpenClipboard fails if another window has the clipboard open."
-     * So try a few times and wait up to 1 second.
-     */
-    BOOL fOpened = FALSE;
-
-    int i = 0;
-    for (;;)
-    {
-        if (OpenClipboard(hwnd))
-        {
-            fOpened = TRUE;
-            break;
-        }
-
-        if (i >= 10) /* sleep interval = [1..512] ms */
-            break;
-
-        RTThreadSleep(1 << i);
-        ++i;
-    }
-
-#ifdef LOG_ENABLED
-    if (i > 0)
-        LogFlowFunc(("%d times tried to open clipboard.\n", i + 1));
-#endif
-
-    int rc;
-    if (fOpened)
-        rc = VINF_SUCCESS;
-    else
-    {
-        const DWORD err = GetLastError();
-        LogFlowFunc(("error %d\n", err));
-        rc = RTErrConvertFromWin32(err);
-    }
-
-    return rc;
-}
-
-
 /** @todo Someone please explain the protocol wrt overflows...  */
 static void vboxClipboardGetData (uint32_t u32Format, const void *pvSrc, uint32_t cbSrc,
                                   void *pvDst, uint32_t cbDst, uint32_t *pcbActualDst)
 {
-    dprintf (("vboxClipboardGetData.\n"));
-
     LogFlow(("vboxClipboardGetData cbSrc = %d, cbDst = %d\n", cbSrc, cbDst));
 
@@ -270 +170 @@
 }
 
-static void vboxClipboardChanged (VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    LogFlow(("vboxClipboardChanged\n"));
-
-    if (pCtx->pClient == NULL)
-    {
-        return;
-    }
-
-    /* Query list of available formats and report to host. */
-    int rc = vboxOpenClipboard(pCtx->hwnd);
-    if (RT_SUCCESS(rc))
-    {
-        uint32_t u32Formats = 0;
-
-        UINT format = 0;
-
-        while ((format = EnumClipboardFormats (format)) != 0)
-        {
-            LogFlow(("vboxClipboardChanged format %#x\n", format));
-            switch (format)
-            {
-                case CF_UNICODETEXT:
-                case CF_TEXT:
-                    u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
-                    break;
-
-                case CF_DIB:
-                case CF_BITMAP:
-                    u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_BITMAP;
-                    break;
-
-                default:
-                    if (format >= 0xC000)
-                    {
-                        TCHAR szFormatName[256];
-
-                        int cActual = GetClipboardFormatName(format, szFormatName, sizeof(szFormatName)/sizeof (TCHAR));
-
-                        if (cActual)
-                        {
-                            if (strcmp (szFormatName, "HTML Format") == 0)
-                            {
-                                u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_HTML;
-                            }
-                        }
-                    }
-                    break;
-            }
-        }
-
-        CloseClipboard ();
-
-        LogFlow(("vboxClipboardChanged u32Formats %02X\n", u32Formats));
-
-        vboxSvcClipboardReportMsg (pCtx->pClient, VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS, u32Formats);
-    }
-    else
-    {
-        LogFlow(("vboxClipboardChanged: error in open clipboard. hwnd: %x. err: %Rrc\n", pCtx->hwnd, rc));
-    }
-}
-
-/* Add ourselves into the chain of cliboard listeners */
-static void addToCBChain (VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    if (vboxClipboardIsNewAPI(pCtx))
-        pCtx->pfnAddClipboardFormatListener(pCtx->hwnd);
-    else
-        pCtx->hwndNextInChain = SetClipboardViewer(pCtx->hwnd);
-}
-
-/* Remove ourselves from the chain of cliboard listeners */
-static void removeFromCBChain (VBOXCLIPBOARDCONTEXT *pCtx)
-{
-    if (vboxClipboardIsNewAPI(pCtx))
-    {
-        pCtx->pfnRemoveClipboardFormatListener(pCtx->hwnd);
-    }
-    else
-    {
-        ChangeClipboardChain(pCtx->hwnd, pCtx->hwndNextInChain);
-        pCtx->hwndNextInChain = NULL;
-    }
-}
-
-/* Callback which is invoked when we have successfully pinged ourselves down the
- * clipboard chain.  We simply unset a boolean flag to say that we are responding.
- * There is a race if a ping returns after the next one is initiated, but nothing
- * very bad is likely to happen. */
-VOID CALLBACK CBChainPingProc(HWND hwnd, UINT uMsg, ULONG_PTR dwData, LRESULT lResult)
-{
-    (void) hwnd;
-    (void) uMsg;
-    (void) lResult;
-    VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *)dwData;
-    pCtx->fCBChainPingInProcess = FALSE;
-}
-
 static LRESULT CALLBACK vboxClipboardWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
 {
     LRESULT rc = 0;
 
-    VBOXCLIPBOARDCONTEXT *pCtx = &g_ctx;
+    PVBOXCLIPBOARDCONTEXT pCtx = &g_ctx;
 
     switch (msg)
@@ -383 +184 @@
             if (GetClipboardOwner() != hwnd)
             {
-                /* Clipboard was updated by another application. */
-                vboxClipboardChanged(pCtx);
+                /* Clipboard was updated by another application, retrieve formats and report back. */
+                int vboxrc = vboxClipboardSyncInternal(pCtx);
+                AssertRC(vboxrc);
             }
         } break;
@@ -392 +194 @@
             Log(("WM_CHANGECBCHAIN\n"));
 
-            if (vboxClipboardIsNewAPI(pCtx))
+            if (VBoxClipboardWinIsNewAPI(&pCtx->Win.newAPI))
             {
                 rc = DefWindowProc(hwnd, msg, wParam, lParam);
@@ -401 +203 @@
             HWND hwndNext    = (HWND)lParam;
 
-            if (hwndRemoved == pCtx->hwndNextInChain)
+            if (hwndRemoved == pCtx->Win.hWndNextInChain)
             {
                 /* The window that was next to our in the chain is being removed.
                  * Relink to the new next window.
                  */
-                pCtx->hwndNextInChain = hwndNext;
+                pCtx->Win.hWndNextInChain = hwndNext;
             }
             else
             {
-                if (pCtx->hwndNextInChain)
+                if (pCtx->Win.hWndNextInChain)
                 {
                     /* Pass the message further. */
                     DWORD_PTR dwResult;
-                    rc = SendMessageTimeout(pCtx->hwndNextInChain, WM_CHANGECBCHAIN, wParam, lParam, 0, CBCHAIN_TIMEOUT, &dwResult);
+                    rc = SendMessageTimeout(pCtx->Win.hWndNextInChain, WM_CHANGECBCHAIN, wParam, lParam, 0,
+                                            VBOX_CLIPBOARD_CBCHAIN_TIMEOUT_MS,
+                                            &dwResult);
                     if (!rc)
                         rc = (LRESULT)dwResult;
@@ -425 +229 @@
             Log(("WM_DRAWCLIPBOARD\n"));
 
-            if (GetClipboardOwner () != hwnd)
-            {
-                /* Clipboard was updated by another application. */
-                vboxClipboardChanged (pCtx);
-            }
-
-            if (pCtx->hwndNextInChain)
-            {
-                Log(("WM_DRAWCLIPBOARD next %p\n", pCtx->hwndNextInChain));
+            if (GetClipboardOwner() != hwnd)
+            {
+                /* Clipboard was updated by another application, retrieve formats and report back. */
+                int vboxrc = vboxClipboardSyncInternal(pCtx);
+                AssertRC(vboxrc);
+            }
+
+            if (pCtx->Win.hWndNextInChain)
+            {
+                Log(("WM_DRAWCLIPBOARD next %p\n", pCtx->Win.hWndNextInChain));
                 /* Pass the message to next windows in the clipboard chain. */
                 DWORD_PTR dwResult;
-                rc = SendMessageTimeout(pCtx->hwndNextInChain, msg, wParam, lParam, 0, CBCHAIN_TIMEOUT, &dwResult);
+                rc = SendMessageTimeout(pCtx->Win.hWndNextInChain, msg, wParam, lParam, 0, VBOX_CLIPBOARD_CBCHAIN_TIMEOUT_MS,
+                                        &dwResult);
                 if (!rc)
                     rc = dwResult;
@@ -444 +250 @@
         case WM_TIMER:
         {
-            if (vboxClipboardIsNewAPI(pCtx))
+            if (VBoxClipboardWinIsNewAPI(&pCtx->Win.newAPI))
                 break;
 
@@ -451 +257 @@
             /* Re-register ourselves in the clipboard chain if our last ping
              * timed out or there seems to be no valid chain. */
-            if (!hViewer || pCtx->fCBChainPingInProcess)
-            {
-                removeFromCBChain(pCtx);
-                addToCBChain(pCtx);
-            }
+            if (!hViewer || pCtx->Win.oldAPI.fCBChainPingInProcess)
+            {
+                VBoxClipboardWinRemoveFromCBChain(&pCtx->Win);
+                VBoxClipboardWinAddToCBChain(&pCtx->Win);
+            }
+
             /* Start a new ping by passing a dummy WM_CHANGECBCHAIN to be
              * processed by ourselves to the chain. */
-            pCtx->fCBChainPingInProcess = TRUE;
+            pCtx->Win.oldAPI.fCBChainPingInProcess = TRUE;
+
             hViewer = GetClipboardViewer();
             if (hViewer)
-                SendMessageCallback(hViewer, WM_CHANGECBCHAIN, (WPARAM)pCtx->hwndNextInChain, (LPARAM)pCtx->hwndNextInChain, CBChainPingProc, (ULONG_PTR) pCtx);
+                SendMessageCallback(hViewer, WM_CHANGECBCHAIN,
+                                    (WPARAM)pCtx->Win.hWndNextInChain, (LPARAM)pCtx->Win.hWndNextInChain,
+                                    VBoxClipboardWinChainPingProc, (ULONG_PTR)pCtx);
         } break;
 
@@ -511 +321 @@
                 int vboxrc = vboxClipboardReadDataFromClient (pCtx, u32Format);
 
-                dprintf(("vboxClipboardReadDataFromClient vboxrc = %d, pv %p, cb %d, u32Format %d\n",
+                LogFunc(("vboxClipboardReadDataFromClient vboxrc = %d, pv %p, cb %d, u32Format %d\n",
                           vboxrc, pCtx->pClient->data.pv, pCtx->pClient->data.cb, pCtx->pClient->data.u32Format));
 
@@ -521 +331 @@
                     HANDLE hMem = GlobalAlloc (GMEM_DDESHARE | GMEM_MOVEABLE, pCtx->pClient->data.cb);
 
-                    dprintf(("hMem %p\n", hMem));
+                    LogFunc(("hMem %p\n", hMem));
 
                     if (hMem)
@@ -527 +337 @@
                         void *pMem = GlobalLock (hMem);
 
-                        dprintf(("pMem %p, GlobalSize %d\n", pMem, GlobalSize (hMem)));
+                        LogFunc(("pMem %p, GlobalSize %d\n", pMem, GlobalSize (hMem)));
 
                         if (pMem)
@@ -552 +362 @@
                             HANDLE hClip = SetClipboardData (format, hMem);
 
-                            dprintf(("vboxClipboardHostEvent hClip %p\n", hClip));
+                            LogFunc(("vboxClipboardHostEvent hClip %p\n", hClip));
 
                             if (hClip)
@@ -571 +381 @@
 
                 /* Something went wrong. */
-                EmptyClipboard ();
+                VBoxClipboardWinClear();
             }
         } break;
@@ -582 +392 @@
              * windows is to be destroyed and therefore the guest side becomes inactive.
              */
-            int vboxrc = vboxOpenClipboard(hwnd);
+            int vboxrc = VBoxClipboardWinOpen(hwnd);
             if (RT_SUCCESS(vboxrc))
             {
-                EmptyClipboard();
-
-                CloseClipboard();
+                VBoxClipboardWinClear();
+                VBoxClipboardWinClose();
             }
             else
@@ -595 +404 @@
         } break;
 
-        case WM_USER:
+        case VBOX_CLIPBOARD_WM_SET_FORMATS:
         {
             if (pCtx->pClient == NULL || pCtx->pClient->fMsgFormats)
@@ -602 +411 @@
                  * because host clipboard has more priority.
                  */
-                Log(("WM_USER ignored\n"));
+                Log(("VBOX_CLIPBOARD_WM_SET_FORMATS ignored\n"));
                 break;
             }
@@ -609 +418 @@
             uint32_t u32Formats = (uint32_t)lParam;
 
-            Log(("WM_USER u32Formats = %02X\n", u32Formats));
-
-            int vboxrc = vboxOpenClipboard(hwnd);
+            Log(("VBOX_CLIPBOARD_WM_SET_FORMATS: u32Formats=%02X\n", u32Formats));
+
+            int vboxrc = VBoxClipboardWinOpen(hwnd);
             if (RT_SUCCESS(vboxrc))
             {
-                EmptyClipboard();
-
-                Log(("WM_USER emptied clipboard\n"));
+                VBoxClipboardWinClear();
+
+                Log(("VBOX_CLIPBOARD_WM_SET_FORMATS emptied clipboard\n"));
 
                 HANDLE hClip = NULL;
 
                 if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
-                {
-                    dprintf(("window proc WM_USER: VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT\n"));
-
-                    hClip = SetClipboardData (CF_UNICODETEXT, NULL);
-                }
+                    hClip = SetClipboardData(CF_UNICODETEXT, NULL);
 
                 if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_BITMAP)
-                {
-                    dprintf(("window proc WM_USER: VBOX_SHARED_CLIPBOARD_FMT_BITMAP\n"));
-
-                    hClip = SetClipboardData (CF_DIB, NULL);
-                }
+                    hClip = SetClipboardData(CF_DIB, NULL);
 
                 if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_HTML)
                 {
                     UINT format = RegisterClipboardFormat ("HTML Format");
-                    dprintf(("window proc WM_USER: VBOX_SHARED_CLIPBOARD_FMT_HTML 0x%04X\n", format));
                     if (format != 0)
                     {
@@ -644 +444 @@
                 }
 
-                CloseClipboard();
-
-                dprintf(("window proc WM_USER: hClip %p, err %d\n", hClip, GetLastError ()));
-            }
-            else
-            {
-                dprintf(("window proc WM_USER: failed to open clipboard. rc: %Rrc\n", vboxrc));
+                VBoxClipboardWinClose();
+
+                LogFunc(("VBOX_CLIPBOARD_WM_SET_FORMATS: hClip=%p, lastErr=%ld\n", hClip, GetLastError ()));
             }
         } break;
@@ -656 +452 @@
         case WM_DESTROY:
         {
-            /* MS recommends to remove from Clipboard chain in this callback */
-            Assert(pCtx->hwnd);
-            removeFromCBChain(pCtx);
-            if (pCtx->timerRefresh)
-                KillTimer(pCtx->hwnd, 0);
+            /* MS recommends to remove from Clipboard chain in this callback. */
+            VBoxClipboardWinRemoveFromCBChain(&pCtx->Win);
+            if (pCtx->Win.oldAPI.timerRefresh)
+            {
+                Assert(pCtx->Win.hWnd);
+                KillTimer(pCtx->Win.hWnd, 0);
+            }
             PostQuitMessage(0);
         } break;
@@ -683 +481 @@
     LogFlow(("VBoxClipboardThread\n"));
 
-    VBOXCLIPBOARDCONTEXT *pCtx = &g_ctx;
+    const PVBOXCLIPBOARDCONTEXT pCtx = &g_ctx;
 
     HINSTANCE hInstance = (HINSTANCE)GetModuleHandle(NULL);
@@ -695 +493 @@
     wc.hInstance     = hInstance;
     wc.hbrBackground = (HBRUSH)(COLOR_BACKGROUND + 1);
-    wc.lpszClassName = gachWindowClassName;
+    wc.lpszClassName = s_szClipWndClassName;
 
     ATOM atomWindowClass = RegisterClass(&wc);
@@ -707 +505 @@
     {
         /* Create the window. */
-        pCtx->hwnd = CreateWindowEx (WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
-                                     gachWindowClassName, gachWindowClassName,
-                                     WS_POPUPWINDOW,
-                                     -200, -200, 100, 100, NULL, NULL, hInstance, NULL);
-
-        if (pCtx->hwnd == NULL)
+        pCtx->Win.hWnd = CreateWindowEx (WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
+                                         s_szClipWndClassName, s_szClipWndClassName,
+                                         WS_POPUPWINDOW,
+                                         -200, -200, 100, 100, NULL, NULL, hInstance, NULL);
+        if (pCtx->Win.hWnd == NULL)
         {
             Log(("Failed to create window\n"));
@@ -719 +516 @@
         else
         {
-            SetWindowPos(pCtx->hwnd, HWND_TOPMOST, -200, -200, 0, 0,
+            SetWindowPos(pCtx->Win.hWnd, HWND_TOPMOST, -200, -200, 0, 0,
                          SWP_NOACTIVATE | SWP_HIDEWINDOW | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
 
-            addToCBChain(pCtx);
-            if (!vboxClipboardIsNewAPI(pCtx))
-                pCtx->timerRefresh = SetTimer(pCtx->hwnd, 0, 10 * 1000, NULL);
+            VBoxClipboardWinAddToCBChain(&pCtx->Win);
+            if (!VBoxClipboardWinIsNewAPI(&pCtx->Win.newAPI))
+                pCtx->Win.oldAPI.timerRefresh = SetTimer(pCtx->Win.hWnd, 0, 10 * 1000, NULL);
 
             MSG msg;
@@ -743 +540 @@
     }
 
-    pCtx->hwnd = NULL;
+    pCtx->Win.hWnd = NULL;
 
     if (atomWindowClass != 0)
     {
-        UnregisterClass (gachWindowClassName, hInstance);
+        UnregisterClass (s_szClipWndClassName, hInstance);
         atomWindowClass = 0;
     }
 
     return 0;
+}
+
+/**
+ * Synchronizes the host and the guest clipboard formats by sending all supported host clipboard
+ * formats to the guest.
+ *
+ * @returns VBox status code.
+ * @param   pCtx                Clipboard context to synchronize.
+ */
+static int vboxClipboardSyncInternal(PVBOXCLIPBOARDCONTEXT pCtx)
+{
+    uint32_t uFormats;
+    int rc = VBoxClipboardWinGetFormats(&pCtx->Win, &uFormats);
+    if (RT_SUCCESS(rc))
+        vboxSvcClipboardReportMsg(pCtx->pClient, VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS, uFormats);
+
+    return rc;
 }
 
@@ -763 +577 @@
     RT_ZERO(g_ctx);
 
-    /* Check that new Clipboard API is available */
-    vboxClipboardInitNewAPI(&g_ctx);
+    /* Check that new Clipboard API is available. */
+    VBoxClipboardWinCheckAndInitNewAPI(&g_ctx.Win.newAPI);
 
     g_ctx.hRenderEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
 
-    rc = RTThreadCreate (&g_ctx.thread, VBoxClipboardThread, NULL, 65536,
+    rc = RTThreadCreate (&g_ctx.hThread, VBoxClipboardThread, NULL, 65536,
                          RTTHREADTYPE_IO, RTTHREADFLAGS_WAITABLE, "SHCLIP");
 
@@ -783 +597 @@
     Log(("vboxClipboardDestroy\n"));
 
-    if (g_ctx.hwnd)
-    {
-        PostMessage (g_ctx.hwnd, WM_CLOSE, 0, 0);
+    if (g_ctx.Win.hWnd)
+    {
+        PostMessage (g_ctx.Win.hWnd, WM_CLOSE, 0, 0);
     }
 
@@ -791 +605 @@
 
     /* Wait for the window thread to terminate. */
-    RTThreadWait (g_ctx.thread, RT_INDEFINITE_WAIT, NULL);
-
-    g_ctx.thread = NIL_RTTHREAD;
+    RTThreadWait (g_ctx.hThread, RT_INDEFINITE_WAIT, NULL);
+
+    g_ctx.hThread = NIL_RTTHREAD;
 }
 
@@ -820 +634 @@
 {
     /* Sync the host clipboard content with the client. */
-    vboxClipboardChanged (pClient->pCtx);
-
-    return VINF_SUCCESS;
+    return vboxClipboardSyncInternal(pClient->pCtx);
 }
 
@@ -838 +650 @@
      * The guest announces formats. Forward to the window thread.
      */
-    PostMessage (pClient->pCtx->hwnd, WM_USER, 0, u32Formats);
+    PostMessage (pClient->pCtx->Win.hWnd, WM_USER, 0, u32Formats);
 }
 
@@ -880 +692 @@
      * The guest wants to read data in the given format.
      */
-    int rc = vboxOpenClipboard(pClient->pCtx->hwnd);
+    int rc = VBoxClipboardWinOpen(pClient->pCtx->Win.hWnd);
     if (RT_SUCCESS(rc))
     {
-        dprintf(("Clipboard opened.\n"));
+        LogFunc(("Clipboard opened.\n"));
 
         if (u32Format & VBOX_SHARED_CLIPBOARD_FMT_BITMAP)
@@ -895 +707 @@
                 if (lp != NULL)
                 {
-                    dprintf(("CF_DIB\n"));
+                    LogFunc(("CF_DIB\n"));
 
                     vboxClipboardGetData (VBOX_SHARED_CLIPBOARD_FMT_BITMAP, lp, GlobalSize (hClip),
@@ -918 +730 @@
                 if (uniString != NULL)
                 {
-                    dprintf(("CF_UNICODETEXT\n"));
+                    LogFunc(("CF_UNICODETEXT\n"));
 
                     vboxClipboardGetData (VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT, uniString, (lstrlenW (uniString) + 1) * 2,
@@ -945 +757 @@
                     if (lp != NULL)
                     {
-                        dprintf(("CF_HTML\n"));
+                        LogFunc(("CF_HTML\n"));
 
                         vboxClipboardGetData (VBOX_SHARED_CLIPBOARD_FMT_HTML, lp, GlobalSize (hClip),
@@ -961 +773 @@
         }
 
-        CloseClipboard ();
+        VBoxClipboardWinClose();
     }
     else
     {
-        dprintf(("vboxClipboardReadData: failed to open clipboard, rc: %Rrc\n", rc));
+        LogFunc(("vboxClipboardReadData: failed to open clipboard, rc: %Rrc\n", rc));
     }
 

trunk/src/VBox/HostServices/SharedClipboard/VBoxClipboard.h

@@ -25 +25 @@
 #include <VBox/log.h>
 
-struct _VBOXCLIPBOARDCONTEXT;
-typedef struct _VBOXCLIPBOARDCONTEXT VBOXCLIPBOARDCONTEXT;
-
+#include <VBox/GuestHost/SharedClipboard.h>
 
 typedef struct _VBOXCLIPBOARDCLIENTDATA
@@ -64 +62 @@
     uint32_t u32RequestedFormat;
 
-} VBOXCLIPBOARDCLIENTDATA;
+} VBOXCLIPBOARDCLIENTDATA, *PVBOXCLIPBOARDCLIENTDATA;
 
 /*
  * The service functions. Locking is between the service thread and the platform dependent windows thread.
  */
-bool vboxSvcClipboardLock (void);
-void vboxSvcClipboardUnlock (void);
-
 void vboxSvcClipboardReportMsg (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Msg, uint32_t u32Formats);
-
 void vboxSvcClipboardCompleteReadData(VBOXCLIPBOARDCLIENTDATA *pClient, int rc, uint32_t cbActual);
-
-bool vboxSvcClipboardGetHeadless(void);
 
 /*
@@ -86 +78 @@
 int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient, bool fHeadless);
 void vboxClipboardDisconnect (VBOXCLIPBOARDCLIENTDATA *pClient);
-
 void vboxClipboardFormatAnnounce (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Formats);
-
 int vboxClipboardReadData (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Format, void *pv, uint32_t cb, uint32_t *pcbActual);
-
 void vboxClipboardWriteData (VBOXCLIPBOARDCLIENTDATA *pClient, void *pv, uint32_t cb, uint32_t u32Format);
 

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

@@ -109 +109 @@
 static bool g_fHeadless = false;
 
+static bool vboxSvcClipboardGetHeadless(void);
+static bool vboxSvcClipboardLock(void);
+static void vboxSvcClipboardUnlock(void);
+
 
 static void VBoxHGCMParmUInt32Set (VBOXHGCMSVCPARM *pParm, uint32_t u32)
@@ -163 +167 @@
 
 /** Getter for headless setting */
-bool vboxSvcClipboardGetHeadless(void)
+static bool vboxSvcClipboardGetHeadless(void)
 {
     return g_fHeadless;
@@ -184 +188 @@
 }
 
-bool vboxSvcClipboardLock (void)
+static bool vboxSvcClipboardLock (void)
 {
     return RT_SUCCESS(RTCritSectEnter (&critsect));
 }
 
-void vboxSvcClipboardUnlock (void)
+static void vboxSvcClipboardUnlock(void)
 {
     RTCritSectLeave (&critsect);