VBoxClipboard.cpp revision 48d832e07616531bbb720d9c98103c83b561ebb6
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * VBoxClipboard - Shared clipboard
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * available from http://www.virtualbox.org. This file is free software;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * General Public License (GPL) as published by the Free Software
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * additional information or have any questions.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// bool fOperational;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// uint32_t u32LastSentFormat;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// uint64_t u64LastSentCRC64;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic char gachWindowClassName[] = "VBoxSharedClipboardClass";
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync (__a)->hdr.cParms = (sizeof (*(__a)) - sizeof ((__a)->hdr)) / sizeof (HGCMFunctionParameter); \
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync//static bool vboxClipboardIsSameAsLastSent (VBOXCLIPBOARDCONTEXT *pCtx, uint32_t u32Format,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// void *pv, uint32_t cb)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// uint64_t u64CRC = RTCrc64 (pv, cb);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// if ( pCtx->u32LastSentFormat == u32Format
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// && pCtx->u64LastSentCRC64 == u64CRC)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// return true;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// pCtx->u64LastSentCRC64 = u64CRC;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// pCtx->u32LastSentFormat = u32Format;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// return false;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxClipboardConnect (VBOXCLIPBOARDCONTEXT *pCtx)
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync memcpy (info.Loc.u.host.achName, "VBoxSharedClipboard", sizeof ("VBoxSharedClipboard"));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic void vboxClipboardDisconnect (VBOXCLIPBOARDCONTEXT *pCtx)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic void VBoxHGCMParmUInt32Set (HGCMFunctionParameter *pParm, uint32_t u32)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int VBoxHGCMParmUInt32Get (HGCMFunctionParameter *pParm, uint32_t *pu32)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic void VBoxHGCMParmPtrSet (HGCMFunctionParameter *pParm, void *pv, uint32_t cb)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxCall (HANDLE hDriver, void *pvData, unsigned cbData)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxClipboardReportFormats (VBOXCLIPBOARDCONTEXT *pCtx, uint32_t u32Formats)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOX_INIT_CALL(&parms, VBOX_SHARED_CLIPBOARD_FN_FORMATS, pCtx);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBoxHGCMParmUInt32Set (&parms.formats, u32Formats);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int rc = vboxCall (pCtx->pEnv->hDriver, &parms, sizeof (parms));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxClipboardReadData (VBOXCLIPBOARDCONTEXT *pCtx, uint32_t u32Format, void *pv, uint32_t cb, uint32_t *pcbActual)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOX_INIT_CALL(&parms, VBOX_SHARED_CLIPBOARD_FN_READ_DATA, pCtx);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int rc = vboxCall (pCtx->pEnv->hDriver, &parms, sizeof (parms));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync rc = VBoxHGCMParmUInt32Get (&parms.size, &u32Size);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log (("vboxClipboardReadData: actual size = %d, rc = %d\n", u32Size, rc));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxClipboardWriteData (VBOXCLIPBOARDCONTEXT *pCtx, uint32_t u32Format,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// if (vboxClipboardIsSameAsLastSent (pCtx, u32Format, pv, cb))
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync// Log (("vboxClipboardWriteData: The data to be sent are the same as the last sent.\n"));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync// return VINF_SUCCESS;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOX_INIT_CALL(&parms, VBOX_SHARED_CLIPBOARD_FN_WRITE_DATA, pCtx);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int rc = vboxCall (pCtx->pEnv->hDriver, &parms, sizeof (parms));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic void vboxClipboardChanged (VBOXCLIPBOARDCONTEXT *pCtx)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Query list of available formats and report to host. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync while ((format = EnumClipboardFormats (format)) != 0)
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log (("vboxClipboardChanged: format 0x%08X\n", format));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync u32Formats |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int cActual = GetClipboardFormatName(format, szFormatName, sizeof(szFormatName)/sizeof (TCHAR));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic LRESULT vboxClipboardProcessMsg(VBOXCLIPBOARDCONTEXT *pCtx, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log (("vboxClipboardProcessMsg: WM_CHANGECBCHAIN: hwndRemoved %p, hwndNext %p, hwnd %p\n", hwndRemoved, hwndNext, pCtx->hwnd));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The window that was next to our in the chain is being removed.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Relink to the new next window.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Pass the message further. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync rc = SendMessage (pCtx->hwndNextInChain, WM_CHANGECBCHAIN, wParam, lParam);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log (("vboxClipboardProcessMsg: WM_DRAWCLIPBOARD, hwnd %p\n", pCtx->hwnd));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Clipboard was updated by another application. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Pass the message to next windows in the clipboard chain. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync rc = SendMessage (pCtx->hwndNextInChain, msg, wParam, lParam);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Do nothing. Ignore the message. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Insert the requested clipboard format data into the clipboard. */
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log (("vboxClipboardProcessMsg: WM_RENDERFORMAT, format %x\n", format));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync u32Format |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int cActual = GetClipboardFormatName(format, szFormatName, sizeof(szFormatName)/sizeof (TCHAR));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Unsupported clipboard format is requested. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Preallocate a buffer, most of small text transfers will fit into it. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync HANDLE hMem = GlobalAlloc (GMEM_DDESHARE | GMEM_MOVEABLE, cbPrealloc);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("pMem %p, GlobalSize %d\n", pMem, GlobalSize (hMem)));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Read the host data to the preallocated buffer. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync int vboxrc = vboxClipboardReadData (pCtx, u32Format, pMem, cbPrealloc, &cb);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("vboxClipboardReadData vboxrc %d\n", vboxrc));
d6c1ac4cabb20caef17d53c6fd371433a79343d8vboxsync /* 0 bytes returned means the clipboard is empty.
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync * Deallocate the memory and set hMem to NULL to get to
d6c1ac4cabb20caef17d53c6fd371433a79343d8vboxsync * the clipboard empty code path.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The preallocated buffer is too small, adjust the size. */
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("pMem %p, GlobalSize %d\n", pMem, GlobalSize (hMem)));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Read the host data to the preallocated buffer. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync vboxrc = vboxClipboardReadData (pCtx, u32Format, pMem, cb, &cbNew);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("vboxClipboardReadData vboxrc %d, cb = %d, cbNew = %d\n", vboxrc, cb, cbNew));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* pMem is the address of the data. cb is the size of returned data. */
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync /* Verify the size of returned text, the memory block for clipboard
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync * must have the exact string size.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (u32Format == VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync HRESULT hrc = StringCbLengthW ((LPWSTR)pMem, cb, &cbActual);
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync /* Discard invalid data. */
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync /* cbActual is the number of bytes, excluding those used
4ca78a9695174cccd2dc4c0f26da066622ed9d42vboxsync * for the terminating null character.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* 'hMem' contains the host clipboard data.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * size is 'cb' and format is 'format'.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The hMem ownership has gone to the system. Finish the processing. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Cleanup follows. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Something went wrong. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Do nothing. The clipboard formats will be unavailable now, because the
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * windows is to be destroyed and therefore the guest side becomes inactive.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Announce available formats. Do not insert data, they will be inserted in WM_RENDER*. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("window proc WM_USER: VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT\n"));
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("window proc WM_USER: VBOX_SHARED_CLIPBOARD_FMT_BITMAP\n"));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync UINT format = RegisterClipboardFormat ("HTML Format");
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("window proc WM_USER: VBOX_SHARED_CLIPBOARD_FMT_HTML 0x%04X\n", format));
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("window proc WM_USER: hClip %p, err %d\n", hClip, GetLastError ()));
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("window proc WM_USER: failed to open clipboard\n"));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Send data in the specified format to the host. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync vboxClipboardWriteData (pCtx, VBOX_SHARED_CLIPBOARD_FMT_BITMAP,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync else if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync vboxClipboardWriteData (pCtx, VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync else if (u32Formats & VBOX_SHARED_CLIPBOARD_FMT_HTML)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync UINT format = RegisterClipboardFormat ("HTML Format");
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync vboxClipboardWriteData (pCtx, VBOX_SHARED_CLIPBOARD_FMT_HTML,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Requested clipboard format is not available, send empty data. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic LRESULT CALLBACK vboxClipboardWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic int vboxClipboardInit (VBOXCLIPBOARDCONTEXT *pCtx)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Register the Window Class. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Create the window. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync pCtx->hwnd = CreateWindowEx (WS_EX_TOOLWINDOW | WS_EX_TRANSPARENT | WS_EX_TOPMOST,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync -200, -200, 100, 100, NULL, NULL, pCtx->pEnv->hInstance, NULL);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync SetWindowPos(pCtx->hwnd, HWND_TOPMOST, -200, -200, 0, 0,
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync SWP_NOACTIVATE | SWP_HIDEWINDOW | SWP_NOCOPYBITS | SWP_NOREDRAW | SWP_NOSIZE);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync pCtx->hwndNextInChain = SetClipboardViewer (pCtx->hwnd);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic void vboxClipboardDestroy (VBOXCLIPBOARDCONTEXT *pCtx)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync ChangeClipboardChain (pCtx->hwnd, pCtx->hwndNextInChain);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync UnregisterClass(gachWindowClassName, pCtx->pEnv->hInstance);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync/* Static since it is the single instance. Directly used in the windows proc. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncstatic LRESULT CALLBACK vboxClipboardWndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Forward with proper context. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync return vboxClipboardProcessMsg (&gCtx, hwnd, msg, wParam, lParam);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncint VBoxClipboardInit (const VBOXSERVICEENV *pEnv, void **ppInstance, bool *pfStartThread)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Clipboard was already initialized. 2 or more instances are not supported. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Always start the thread for host messages. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncunsigned __stdcall VBoxClipboardThread (void *pInstance)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *)pInstance;
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Open the new driver instance to not interfere with other callers. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The thread waits for incoming messages from the host. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOX_INIT_CALL(&parms, VBOX_SHARED_CLIPBOARD_FN_GET_HOST_MSG, pCtx);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("Failed to call the driver for host message.\n"));
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Wait a bit before retrying. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (WaitForSingleObject(pCtx->pEnv->hStopEvent, 1000) == WAIT_OBJECT_0)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync rc = VBoxHGCMParmUInt32Get (&parms.formats, &u32Formats);
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("vboxClipboardHostEvent u32Msg %d, u32Formats %d\n", u32Msg, u32Formats));
240f7d7012a5f64bcde850bcf048531a710d81cfvboxsync /* The host has announced available clipboard formats.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * Forward the information to the window, so it can later
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync * respond to WM_RENDERFORMAT message.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync ::PostMessage (pCtx->hwnd, WM_USER, 0, u32Formats);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The host needs data in the specified format.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync ::PostMessage (pCtx->hwnd, WM_USER + 1, 0, u32Formats);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* The host is terminating.
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Wait for termination event. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync WaitForSingleObject(pCtx->pEnv->hStopEvent, INFINITE);
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync /* Wait a bit before retrying. */
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync if (WaitForSingleObject(pCtx->pEnv->hStopEvent, 1000) == WAIT_OBJECT_0)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsyncvoid VBoxClipboardDestroy (const VBOXSERVICEENV *pEnv, void *pInstance)
e62cb87bae732e9968199a3ad153cc94004b7182vboxsync VBOXCLIPBOARDCONTEXT *pCtx = (VBOXCLIPBOARDCONTEXT *)pInstance;
315ad5b8dea4f6f933a01420cfb1e0fe19183c45vboxsync Log(("VBoxClipboardDestroy: invalid instance %p (our %p)!!!\n", pCtx, &gCtx));