HostServices/SharedClipboard/darwin-pasteboard.cpp

	darwin-pasteboard.cpp revision 7d9e0d289e799c0ee5b9307fe7358ddc53bd34dd
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/* $Id$ */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/** @file
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Shared Clipboard: Mac OS X host implementation.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/*
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Copyright (C) 2008 Sun Microsystems, Inc.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * available from http://www.virtualbox.org. This file is free software;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * you can redistribute it and/or modify it under the terms of the GNU
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * General Public License (GPL) as published by the Free Software
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * additional information or have any questions.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#define LOG_GROUP LOG_GROUP_HGCM
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#include <Carbon/Carbon.h>
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#include <iprt/mem.h>
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync#include <iprt/assert.h>
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#include "iprt/err.h"
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#include "VBox/log.h"
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#include "VBox/HostServices/VBoxClipboardSvc.h"
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync#include "VBox/GuestHost/clipboard-helper.h"
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/* For debugging */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync//#define SHOW_CLIPBOARD_CONTENT
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/**
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Initialize the global pasteboard and return a reference to it.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @param pPasteboardRef Reference to the global pasteboard.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @returns IPRT status code.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsyncint initPasteboard (PasteboardRef *pPasteboardRef)
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync{
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    int rc = VINF_SUCCESS;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    if (PasteboardCreate (kPasteboardClipboard, pPasteboardRef))
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        rc = VERR_NOT_SUPPORTED;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    return rc;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync}
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/**
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Release the reference to the global pasteboard.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @param pPasteboardRef Reference to the global pasteboard.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsyncvoid destroyPasteboard (PasteboardRef *pPasteboardRef)
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync{
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    CFRelease (*pPasteboardRef);
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    *pPasteboardRef = NULL;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync}
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync/**
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * Inspect the global pasteboard for new content. Check if there is some type
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * that is supported by vbox and return it.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @param   pPasteboardRef Reference to the global pasteboard.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @param   pfFormats      Pointer for the bit combination of the
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *                         supported types.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @param   pbChanged      True if something has changed after the
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *                         last call.
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync *
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync * @returns IPRT status code. (Always VINF_SUCCESS atm.)
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsyncint queryNewPasteboardFormats (PasteboardRef pPasteboard, uint32_t *pfFormats, bool *pfChanged)
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync{
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    Log (("queryNewPasteboardFormats\n"));
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    OSStatus err = noErr;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    *pfChanged = true;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    PasteboardSyncFlags syncFlags;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    /* Make sure all is in sync */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    syncFlags = PasteboardSynchronize (pPasteboard);
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    /* If nothing changed return */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    if (!(syncFlags & kPasteboardModified))
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync    {
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        *pfChanged = false;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        return VINF_SUCCESS;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    }
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    /* Are some items in the pasteboard? */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    ItemCount itemCount;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    err = PasteboardGetItemCount (pPasteboard, &itemCount);
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync    if (itemCount < 1)
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        return VINF_SUCCESS;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    /* The id of the first element in the pasteboard */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    int rc = VINF_SUCCESS;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    PasteboardItemID itemID;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    if (!(err = PasteboardGetItemIdentifier (pPasteboard, 1, &itemID)))
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    {
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        /* Retrieve all flavors in the pasteboard, maybe there
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync         * is something we can use. */
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        CFArrayRef flavorTypeArray;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        if (!(err = PasteboardCopyItemFlavors (pPasteboard, itemID, &flavorTypeArray)))
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        {
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync            CFIndex flavorCount;
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync            flavorCount = CFArrayGetCount (flavorTypeArray);
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync            for (CFIndex flavorIndex = 0; flavorIndex < flavorCount; flavorIndex++)
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync            {
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync                CFStringRef flavorType;
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync                flavorType = static_cast <CFStringRef> (CFArrayGetValueAtIndex (flavorTypeArray,
c8befbec2916e0bba4d254c81d87e5b0e78013bavboxsync                                                                                flavorIndex));
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync                /* Currently only unicode supported */
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync                if (UTTypeConformsTo (flavorType, CFSTR ("public.utf8-plain-text")) ||
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync                    UTTypeConformsTo (flavorType, CFSTR ("public.utf16-plain-text")))
6754e49069315bd28137abb0f9241e3aeb99a97evboxsync                {
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync                    Log (("Unicode flavor detected.\n"));
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync                    *pfFormats |= VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync                }
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync            }
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync            CFRelease (flavorTypeArray);
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync        }
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    }
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync    Log (("queryNewPasteboardFormats: rc = %02X\n", rc));
    return rc;
}

/**
 * Read content from the host clipboard and write it to the internal clipboard
 * structure for further processing.
 *
 * @param   pPasteboardRef Reference to the global pasteboard.
 * @param   fFormats       The format type which should be read.
 * @param   pv             The destination buffer.
 * @param   cb             The size of the destination buffer.
 * @param   pcbActual      The size which is needed to transfer the content.
 *
 * @returns IPRT status code.
 */
int readFromPasteboard (PasteboardRef pPasteboard, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcbActual)
{
    Log (("readFromPasteboard: fFormat = %02X\n", fFormat));

    OSStatus err = noErr;

    /* Make sure all is in sync */
    PasteboardSynchronize (pPasteboard);

    /* Are some items in the pasteboard? */
    ItemCount itemCount;
    err = PasteboardGetItemCount (pPasteboard, &itemCount);
    if (itemCount < 1)
        return VINF_SUCCESS;

    /* The id of the first element in the pasteboard */
    int rc = VERR_NOT_SUPPORTED;
    PasteboardItemID itemID;
    if (!(err = PasteboardGetItemIdentifier (pPasteboard, 1, &itemID)))
    {
        /* The guest request unicode */
        if (fFormat & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
        {
            CFDataRef outData;
            PRTUTF16 pwszTmp = NULL;
            /* Try utf-16 first */
            if (!(err = PasteboardCopyItemFlavorData (pPasteboard, itemID, CFSTR ("public.utf16-plain-text"), &outData)))
            {
                Log (("Clipboard content is utf-16\n"));
                rc = RTUtf16DupEx (&pwszTmp, (PRTUTF16)CFDataGetBytePtr (outData), 0);
            }
            /* Second try is utf-8 */
            else
                if (!(err = PasteboardCopyItemFlavorData (pPasteboard, itemID, CFSTR ("public.utf8-plain-text"), &outData)))
                {
                    Log (("readFromPasteboard: clipboard content is utf-8\n"));
                    rc = RTStrToUtf16 ((const char*)CFDataGetBytePtr (outData), &pwszTmp);
                }
            if (pwszTmp)
            {
                /* Check how much longer will the converted text will be. */
                size_t cwSrc = RTUtf16Len (pwszTmp);
                size_t cwDest;
                rc = vboxClipboardUtf16GetWinSize (pwszTmp, cwSrc, &cwDest);
                if (RT_FAILURE (rc))
                {
                    RTUtf16Free (pwszTmp);
                    Log (("readFromPasteboard: clipboard conversion failed.  vboxClipboardUtf16GetWinSize returned %Rrc.  Abandoning.\n", rc));
                    AssertRCReturn (rc, rc);
                }
                /* Set the actually needed data size */
                *pcbActual = cwDest * 2;
                /* Return success state */
                rc = VINF_SUCCESS;
                /* Do not copy data if the dst buffer is not big enough. */
                if (*pcbActual <= cb)
                {
                    rc = vboxClipboardUtf16LinToWin (pwszTmp, RTUtf16Len (pwszTmp), static_cast <PRTUTF16> (pv), cb / 2);
                    if (RT_FAILURE (rc))
                    {
                        RTUtf16Free (pwszTmp);
                        Log (("readFromPasteboard: clipboard conversion failed.  vboxClipboardUtf16LinToWin() returned %Rrc.  Abandoning.\n", rc));
                        AssertRCReturn (rc, rc);
                    }
#ifdef SHOW_CLIPBOARD_CONTENT
                    Log (("readFromPasteboard: clipboard content: %ls\n", static_cast <PRTUTF16> (pv)));
#endif
                }
                /* Free the temp string */
                RTUtf16Free (pwszTmp);
            }
        }
    }

    Log (("readFromPasteboard: rc = %02X\n", rc));
    return rc;
}

/**
 * Write clipboard content to the host clipboard from the internal clipboard
 * structure.
 *
 * @param   pPasteboardRef Reference to the global pasteboard.
 * @param   pv             The source buffer.
 * @param   cb             The size of the source buffer.
 * @param   fFormats       The format type which should be written.
 *
 * @returns IPRT status code.
 */
int writeToPasteboard (PasteboardRef pPasteboard, void *pv, uint32_t cb, uint32_t fFormat)
{
    Log (("writeToPasteboard: fFormat = %02X\n", fFormat));

    /* Clear the pasteboard */
    if (PasteboardClear (pPasteboard))
        return VERR_NOT_SUPPORTED;

    /* Make sure all is in sync */
    PasteboardSynchronize (pPasteboard);

    int rc = VERR_NOT_SUPPORTED;
    /* Handle the unicode text */
    if (fFormat & VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT)
    {
        PRTUTF16 pwszSrcText = static_cast <PRTUTF16> (pv);
        size_t cwSrc = cb / 2;
        size_t cwDest = 0;
        /* How long will the converted text be? */
        rc = vboxClipboardUtf16GetLinSize (pwszSrcText, cwSrc, &cwDest);
        if (RT_FAILURE (rc))
        {
            Log (("writeToPasteboard: clipboard conversion failed.  vboxClipboardUtf16GetLinSize returned %Rrc.  Abandoning.\n", rc));
            AssertRCReturn (rc, rc);
        }
        /* Empty clipboard? Not critical */
        if (cwDest == 0)
        {
            Log (("writeToPasteboard: received empty clipboard data from the guest, returning false.\n"));
            return VINF_SUCCESS;
        }
        /* Allocate the necessary memory */
        PRTUTF16 pwszDestText = static_cast <PRTUTF16> (RTMemAlloc (cwDest * 2));
        if (pwszDestText == NULL)
        {
            Log (("writeToPasteboard: failed to allocate %d bytes\n", cwDest * 2));
            return VERR_NO_MEMORY;
        }
        /* Convert the EOL */
        rc = vboxClipboardUtf16WinToLin (pwszSrcText, cwSrc, pwszDestText, cwDest);
        if (RT_FAILURE (rc))
        {
            Log (("writeToPasteboard: clipboard conversion failed.  vboxClipboardUtf16WinToLin() returned %Rrc.  Abandoning.\n", rc));
            RTMemFree (pwszDestText);
            AssertRCReturn (rc, rc);
        }

        CFDataRef textData = NULL;
        /* Item id is 1. Nothing special here. */
        PasteboardItemID itemId = (PasteboardItemID)1;
        /* Create a CData object which we could pass to the pasteboard */
        if ((textData = CFDataCreate (kCFAllocatorDefault,
                                      reinterpret_cast<UInt8*> (pwszDestText), cwDest * 2)))
        {
            /* Put the Utf-16 version to the pasteboard */
            PasteboardPutItemFlavor (pPasteboard, itemId,
                                     CFSTR ("public.utf16-plain-text"),
                                     textData, 0);
        }
        /* Create a Utf-8 version */
        char *pszDestText;
        rc = RTUtf16ToUtf8 (pwszDestText, &pszDestText);
        if (RT_SUCCESS (rc))
        {
            /* Create a CData object which we could pass to the pasteboard */
            if ((textData = CFDataCreate (kCFAllocatorDefault,
                                          reinterpret_cast<UInt8*> (pszDestText), strlen(pszDestText))))
            {
                /* Put the Utf-8 version to the pasteboard */
                PasteboardPutItemFlavor (pPasteboard, itemId,
                                         CFSTR ("public.utf8-plain-text"),
                                         textData, 0);
            }
            RTStrFree (pszDestText);
        }

        RTMemFree (pwszDestText);
        rc = VINF_SUCCESS;
    }
    else
        rc = VERR_NOT_IMPLEMENTED;

    Log (("writeToPasteboard: rc = %02X\n", rc));
    return rc;
}