blob: d8240e60a5fb91b71e0e90628a9565193006ec66 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/** @file
* Shared Clipboard - Common header for host service and guest clients.
*/
/*
* Copyright (C) 2006-2013 Oracle Corporation
*
* 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_HostService_VBoxClipboardSvc_h
#define ___VBox_HostService_VBoxClipboardSvc_h
#include <VBox/types.h>
#include <VBox/VMMDev.h>
#include <VBox/VBoxGuest2.h>
#include <VBox/hgcmsvc.h>
/*
* The mode of operations.
*/
#define VBOX_SHARED_CLIPBOARD_MODE_OFF 0
#define VBOX_SHARED_CLIPBOARD_MODE_HOST_TO_GUEST 1
#define VBOX_SHARED_CLIPBOARD_MODE_GUEST_TO_HOST 2
#define VBOX_SHARED_CLIPBOARD_MODE_BIDIRECTIONAL 3
/*
* 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.
*/
#define VBOX_SHARED_CLIPBOARD_HOST_FN_SET_MODE 1
/** Run headless on the host, i.e. do not touch the host clipboard. */
#define VBOX_SHARED_CLIPBOARD_HOST_FN_SET_HEADLESS 2
/*
* The service functions which are called by guest.
*/
/* Call host and wait blocking for an host event VBOX_SHARED_CLIPBOARD_HOST_MSG_* */
#define VBOX_SHARED_CLIPBOARD_FN_GET_HOST_MSG 1
/* Send list of available formats to host. */
#define VBOX_SHARED_CLIPBOARD_FN_FORMATS 2
/* Obtain data in specified format from host. */
#define VBOX_SHARED_CLIPBOARD_FN_READ_DATA 3
/* 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
/*
* HGCM parameter structures.
*/
#pragma pack (1)
typedef struct _VBoxClipboardGetHostMsg
{
VBoxGuestHGCMCallInfo hdr;
/* VBOX_SHARED_CLIPBOARD_HOST_MSG_* */
HGCMFunctionParameter msg; /* OUT uint32_t */
/* VBOX_SHARED_CLIPBOARD_FMT_*, depends on the 'msg'. */
HGCMFunctionParameter formats; /* OUT uint32_t */
} VBoxClipboardGetHostMsg;
#define VBOX_SHARED_CLIPBOARD_CPARMS_GET_HOST_MSG 2
typedef struct _VBoxClipboardFormats
{
VBoxGuestHGCMCallInfo hdr;
/* VBOX_SHARED_CLIPBOARD_FMT_* */
HGCMFunctionParameter formats; /* OUT uint32_t */
} VBoxClipboardFormats;
#define VBOX_SHARED_CLIPBOARD_CPARMS_FORMATS 1
typedef struct _VBoxClipboardReadData
{
VBoxGuestHGCMCallInfo hdr;
/* Requested format. */
HGCMFunctionParameter format; /* IN uint32_t */
/* The data buffer. */
HGCMFunctionParameter ptr; /* IN linear pointer. */
/* Size of returned data, if > ptr->cb, then no data was
* actually transferred and the guest must repeat the call.
*/
HGCMFunctionParameter size; /* OUT uint32_t */
} VBoxClipboardReadData;
#define VBOX_SHARED_CLIPBOARD_CPARMS_READ_DATA 3
typedef struct _VBoxClipboardWriteData
{
VBoxGuestHGCMCallInfo hdr;
/* Returned format as requested in the VBOX_SHARED_CLIPBOARD_HOST_MSG_READ_DATA message. */
HGCMFunctionParameter format; /* IN uint32_t */
/* Data. */
HGCMFunctionParameter ptr; /* IN linear pointer. */
} VBoxClipboardWriteData;
#define VBOX_SHARED_CLIPBOARD_CPARMS_WRITE_DATA 2
#pragma pack ()
#endif
|
