VBoxClipboardSvc.h revision 4e70517ea7c253ad227af80a841e38adb5420203
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/** @file
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * Shared Clipboard:
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * Common header for host service and guest clients.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync *
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync * available from http://www.virtualbox.org. This file is free software;
c98fb3e16fcd571a790eab772c0c66173d225205vboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync *
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * The contents of this file may alternatively be used under the terms
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * of the Common Development and Distribution License Version 1.0
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution, in which case the provisions of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * CDDL are applicable instead of those of the GPL.
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync *
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * You may elect to license modified versions of this file under the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * terms and conditions of either the GPL or the CDDL or both.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync *
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * additional information or have any questions.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#ifndef ___VBox_HostService_VBoxClipboardSvc_h
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define ___VBox_HostService_VBoxClipboardSvc_h
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#include <VBox/types.h>
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#include <VBox/VBoxGuest.h>
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#include <VBox/hgcmsvc.h>
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * The mode of operations.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_MODE_OFF 0
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_MODE_HOST_TO_GUEST 1
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_MODE_GUEST_TO_HOST 2
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_MODE_BIDIRECTIONAL 3
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * Supported data formats. Bit mask.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FMT_UNICODETEXT 0x01
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FMT_BITMAP 0x02
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FMT_HTML 0x04
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * The service functions which are callable by host.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_HOST_FN_SET_MODE 1
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * The service functions which are called by guest.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/* Call host and wait blocking for an host event VBOX_SHARED_CLIPBOARD_HOST_MSG_* */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FN_GET_HOST_MSG 1
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/* Send list of available formats to host. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FN_FORMATS 2
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/* Obtain data in specified format from host. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FN_READ_DATA 3
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/* Send data in requested format to host. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_FN_WRITE_DATA 4
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * The host messages for the guest.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_HOST_MSG_QUIT 1
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA 2
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#define VBOX_SHARED_CLIPBOARD_HOST_MSG_FORMATS 3
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync/*
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * HGCM parameter structures.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#pragma pack (1)
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsynctypedef struct _VBoxClipboardGetHostMsg
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync{
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync VBoxGuestHGCMCallInfo hdr;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* VBOX_SHARED_CLIPBOARD_HOST_MSG_* */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter msg; /* OUT uint32_t */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* VBOX_SHARED_CLIPBOARD_FMT_*, depends on the 'msg'. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter formats; /* OUT uint32_t */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync} VBoxClipboardGetHostMsg;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
4e70517ea7c253ad227af80a841e38adb5420203vboxsync#define VBOX_SHARED_CLIPBOARD_CPARMS_GET_HOST_MSG 2
4e70517ea7c253ad227af80a841e38adb5420203vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsynctypedef struct _VBoxClipboardFormats
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync{
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync VBoxGuestHGCMCallInfo hdr;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* VBOX_SHARED_CLIPBOARD_FMT_* */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter formats; /* OUT uint32_t */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync} VBoxClipboardFormats;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
4e70517ea7c253ad227af80a841e38adb5420203vboxsync#define VBOX_SHARED_CLIPBOARD_CPARMS_FORMATS 1
4e70517ea7c253ad227af80a841e38adb5420203vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsynctypedef struct _VBoxClipboardReadData
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync{
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync VBoxGuestHGCMCallInfo hdr;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* Requested format. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter format; /* IN uint32_t */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* The data buffer. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter ptr; /* IN linear pointer. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* Size of returned data, if > ptr->cb, then no data was
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync * actually transferred and the guest must repeat the call.
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter size; /* OUT uint32_t */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync} VBoxClipboardReadData;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
4e70517ea7c253ad227af80a841e38adb5420203vboxsync#define VBOX_SHARED_CLIPBOARD_CPARMS_READ_DATA 3
4e70517ea7c253ad227af80a841e38adb5420203vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsynctypedef struct _VBoxClipboardWriteData
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync{
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync VBoxGuestHGCMCallInfo hdr;
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* Returned format as requested in the VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA message. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter format; /* IN uint32_t */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync /* Data. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync HGCMFunctionParameter ptr; /* IN linear pointer. */
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync} VBoxClipboardWriteData;
4e70517ea7c253ad227af80a841e38adb5420203vboxsync
4e70517ea7c253ad227af80a841e38adb5420203vboxsync#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_DATA 2
4e70517ea7c253ad227af80a841e38adb5420203vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#pragma pack ()
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync
9c9df2b728333cb734a7cc7856568e9ea9dc4600vboxsync#endif