VBoxGuestR3LibClipboard.cpp revision e55369e083c89b9c4570d1ea9461a8cbea88eeb0
/* $Id$ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Clipboard.
*/
/*
* Copyright (C) 2007 innotek GmbH
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include <VBox/HostServices/VBoxClipboardSvc.h>
#include <VBox/VBoxGuest.h>
#include <iprt/string.h>
#include <iprt/assert.h>
#include "VBGLR3Internal.h"
/**
* Connects to the clipboard service.
*
* @returns VBox status code
* @param pu32ClientId Where to put the client id on success. The client id
* must be passed to all the other clipboard calls.
*/
VBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId)
{
VBoxGuestHGCMConnectInfo Info = { 0 };
Info.result = (uint32_t)VERR_WRONG_ORDER; /** @todo drop the cast when the result type has been fixed! */
Info.Loc.type = VMMDevHGCMLoc_LocalHost_Existing;
// memset(&Info.Loc.u, 0, sizeof(Info.Loc.u));
strcpy(Info.Loc.u.host.achName, "VBoxSharedClipboard");
int rc = vbglR3DoIOCtl(IOCTL_VBOXGUEST_HGCM_CONNECT, &Info, sizeof(Info));
if (RT_SUCCESS(rc))
{
rc = Info.result;
if (RT_SUCCESS(rc))
*pu32ClientId = Info.u32ClientID;
}
return rc;
}
/**
* Disconnect from the clipboard service.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
*/
VBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId)
{
VBoxGuestHGCMDisconnectInfo Info;
Info.result = (uint32_t)VERR_WRONG_ORDER; /** @todo drop the cast when the result type has been fixed! */
Info.u32ClientID = u32ClientId;
int rc = vbglR3DoIOCtl(IOCTL_VBOXGUEST_HGCM_DISCONNECT, &Info, sizeof(Info));
if (RT_SUCCESS(rc))
rc = Info.result;
return rc;
}
/**
* Get a host message.
*
* This will block until a message becomes available.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param pMsg Where to store the message id.
* @param pfFormats Where to store the format(s) the message applies to.
*/
VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats)
{
VBoxClipboardGetHostMsg Msg = { 0 };
Msg.hdr.result = (uint32_t)VERR_WRONG_ORDER; /** @todo drop the cast when the result type has been fixed! */
Msg.hdr.u32ClientID = u32ClientId;
Msg.hdr.u32Function = VBOX_SHARED_CLIPBOARD_FN_GET_HOST_MSG;
Msg.hdr.cParms = 2;
VbglHGCMParmUInt32Set(&Msg.msg, 0);
VbglHGCMParmUInt32Set(&Msg.formats, 0);
int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
if (RT_SUCCESS(rc))
{
rc = Msg.hdr.result;
if (RT_SUCCESS(rc))
{
uint32_t u32Msg;
rc = VbglHGCMParmUInt32Get(&Msg.msg, &u32Msg);
if (RT_SUCCESS(rc))
{
uint32_t fFormats;
rc = VbglHGCMParmUInt32Get(&Msg.formats, &fFormats);
if (RT_SUCCESS(rc))
{
*pMsg = u32Msg;
*pfFormats = fFormats;
return Msg.hdr.result;
}
}
}
}
return rc;
}
/**
* Reads data from the host clipboard.
*
* @returns VBox status code.
* @retval VINF_BUFFER_OVERFLOW If there is more data available than the caller provided buffer space for.
*
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param fFormat The format we're requesting the data in.
* @param pv Where to store the data.
* @param cb The size of the buffer pointed to by pv.
* @param pcb The actual size of the host clipboard data. May be larger than cb.
*/
VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb)
{
VBoxClipboardReadData Msg;
Msg.hdr.result = (uint32_t)VERR_WRONG_ORDER; /** @todo drop the cast when the result type has been fixed! */
Msg.hdr.u32ClientID = u32ClientId;
Msg.hdr.u32Function = VBOX_SHARED_CLIPBOARD_FN_READ_DATA;
Msg.hdr.cParms = 3;
VbglHGCMParmUInt32Set(&Msg.format, fFormat);
VbglHGCMParmPtrSet(&Msg.ptr, pv, cb);
VbglHGCMParmUInt32Set(&Msg.size, 0);
int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
if (RT_SUCCESS(rc))
{
rc = Msg.hdr.result;
if (RT_SUCCESS(rc))
{
uint32_t cbActual;
rc = VbglHGCMParmUInt32Get(&Msg.size, &cbActual);
if (RT_SUCCESS(rc))
{
*pcb = cbActual;
if (cbActual > cb)
return VINF_BUFFER_OVERFLOW;
return Msg.hdr.result;
}
}
}
return rc;
}
/**
* Advertises guest clipboard formats to the host.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param fFormats The formats to advertise.
*/
VBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats)
{
VBoxClipboardFormats Msg;
Msg.hdr.result = (uint32_t)VERR_WRONG_ORDER; /** @todo drop the cast when the result type has been fixed! */
Msg.hdr.u32ClientID = u32ClientId;
Msg.hdr.u32Function = VBOX_SHARED_CLIPBOARD_FN_FORMATS;
Msg.hdr.cParms = 1;
VbglHGCMParmUInt32Set(&Msg.formats, fFormats);
int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
if (RT_SUCCESS(rc))
rc = Msg.hdr.result;
return rc;
}
/**
* Send guest clipboard data to the host.
*
* This is usually called in reply to a VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA message
* from the host.
*
* @returns VBox status code.
* @param u32ClientId The client id returned by VbglR3ClipboardConnect().
* @param fFormat The format of the data.
* @param pv The data.
* @param cb The size of the data.
*/
VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb)
{
VBoxClipboardWriteData Msg;
Msg.hdr.result = (uint32_t)VERR_WRONG_ORDER; /** @todo drop the cast when the result type has been fixed! */
Msg.hdr.u32ClientID = u32ClientId;
Msg.hdr.u32Function = VBOX_SHARED_CLIPBOARD_FN_WRITE_DATA;
Msg.hdr.cParms = 2;
VbglHGCMParmUInt32Set(&Msg.format, fFormat);
VbglHGCMParmPtrSet(&Msg.ptr, pv, cb);
int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_HGCM_CALL(sizeof(Msg)), &Msg, sizeof(Msg));
if (RT_SUCCESS(rc))
rc = Msg.hdr.result;
return rc;
}