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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/** @file
* Shared Clipboard - Common guest and host Code.
*/
/*
* Copyright (C) 2006-2020 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_INCLUDED_GuestHost_SharedClipboard_h
#define VBOX_INCLUDED_GuestHost_SharedClipboard_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/types.h>
#include <iprt/list.h>
/**
* Shared Clipboard transfer direction.
*/
typedef enum SHCLTRANSFERDIR
{
/** Unknown transfer directory. */
SHCLTRANSFERDIR_UNKNOWN = 0,
/** Read transfer (from source). */
SHCLTRANSFERDIR_FROM_REMOTE,
/** Write transfer (to target). */
SHCLTRANSFERDIR_TO_REMOTE,
/** The usual 32-bit hack. */
SHCLTRANSFERDIR_32BIT_HACK = 0x7fffffff
} SHCLTRANSFERDIR;
/** Pointer to a shared clipboard transfer direction. */
typedef SHCLTRANSFERDIR *PSHCLTRANSFERDIR;
/** A single Shared Clipboard format (VBOX_SHCL_FMT_XXX). */
typedef uint32_t SHCLFORMAT;
/** Pointer to a single Shared Clipboard format (VBOX_SHCL_FMT_XXX). */
typedef SHCLFORMAT *PSHCLFORMAT;
/** Bit map (flags) of Shared Clipboard formats (VBOX_SHCL_FMT_XXX). */
typedef uint32_t SHCLFORMATS;
/** Pointer to a bit map of Shared Clipboard formats (VBOX_SHCL_FMT_XXX). */
typedef SHCLFORMATS *PSHCLFORMATS;
/**
* Shared Clipboard data read request.
*/
typedef struct SHCLDATAREQ
{
/** In which format the data needs to be sent. */
SHCLFORMAT uFmt;
/** Read flags; currently unused. */
uint32_t fFlags;
/** Maximum data (in byte) can be sent. */
uint32_t cbSize;
} SHCLDATAREQ;
/** Pointer to a shared clipboard data request. */
typedef SHCLDATAREQ *PSHCLDATAREQ;
/**
* Shared Clipboard event payload (optional).
*/
typedef struct SHCLEVENTPAYLOAD
{
/** Payload ID; currently unused. */
uint32_t uID;
/** Size (in bytes) of actual payload data. */
uint32_t cbData;
/** Pointer to actual payload data. */
void *pvData;
} SHCLEVENTPAYLOAD;
/** Pointer to a shared clipboard event payload. */
typedef SHCLEVENTPAYLOAD *PSHCLEVENTPAYLOAD;
/** A shared clipboard event source ID. */
typedef uint16_t SHCLEVENTSOURCEID;
/** Pointer to a shared clipboard event source ID. */
typedef SHCLEVENTSOURCEID *PSHCLEVENTSOURCEID;
/** A shared clipboard session ID. */
typedef uint16_t SHCLSESSIONID;
/** Pointer to a shared clipboard session ID. */
typedef SHCLSESSIONID *PSHCLSESSIONID;
/** NIL shared clipboard session ID. */
#define NIL_SHCLSESSIONID UINT16_MAX
/** A shared clipboard transfer ID. */
typedef uint16_t SHCLTRANSFERID;
/** Pointer to a shared clipboard transfer ID. */
typedef SHCLTRANSFERID *PSHCLTRANSFERID;
/** NIL shared clipboardtransfer ID. */
#define NIL_SHCLTRANSFERID UINT16_MAX
/** A shared clipboard event ID. */
typedef uint32_t SHCLEVENTID;
/** Pointer to a shared clipboard event source ID. */
typedef SHCLEVENTID *PSHCLEVENTID;
/** NIL shared clipboard event ID. */
#define NIL_SHCLEVENTID UINT32_MAX
/**
* Shared Clipboard event.
*/
typedef struct SHCLEVENT
{
/** List node. */
RTLISTNODE Node;
/** The event's ID, for self-reference. */
SHCLEVENTID idEvent;
/** Reference count to this event. */
uint32_t cRefs;
/** Event semaphore for signalling the event. */
RTSEMEVENTMULTI hEvtMulSem;
/** Payload to this event, optional (NULL). */
PSHCLEVENTPAYLOAD pPayload;
} SHCLEVENT;
/** Pointer to a shared clipboard event. */
typedef SHCLEVENT *PSHCLEVENT;
/**
* Shared Clipboard event source.
*
* Each event source maintains an own counter for events, so that it can be used
* in different contexts.
*/
typedef struct SHCLEVENTSOURCE
{
/** The event source ID. */
SHCLEVENTSOURCEID uID;
/** Next upcoming event ID. */
SHCLEVENTID idNextEvent;
/** List of events (PSHCLEVENT). */
RTLISTANCHOR lstEvents;
} SHCLEVENTSOURCE;
/** Pointer to a shared clipboard event source. */
typedef SHCLEVENTSOURCE *PSHCLEVENTSOURCE;
/** @name Shared Clipboard data payload functions.
* @{
*/
int ShClPayloadAlloc(uint32_t uID, const void *pvData, uint32_t cbData, PSHCLEVENTPAYLOAD *ppPayload);
void ShClPayloadFree(PSHCLEVENTPAYLOAD pPayload);
/** @} */
/** @name Shared Clipboard event source functions.
* @{
*/
int ShClEventSourceCreate(PSHCLEVENTSOURCE pSource, SHCLEVENTSOURCEID idEvtSrc);
void ShClEventSourceDestroy(PSHCLEVENTSOURCE pSource);
void ShClEventSourceReset(PSHCLEVENTSOURCE pSource);
/** @} */
/** @name Shared Clipboard event functions.
* @{
*/
SHCLEVENTID ShClEventIdGenerateAndRegister(PSHCLEVENTSOURCE pSource);
SHCLEVENTID ShClEventGetLast(PSHCLEVENTSOURCE pSource);
uint32_t ShClEventRetain(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
uint32_t ShClEventRelease(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
int ShClEventSignal(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent, PSHCLEVENTPAYLOAD pPayload);
int ShClEventUnregister(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
int ShClEventWait(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD *ppPayload);
void ShClEventPayloadDetach(PSHCLEVENTSOURCE pSource, SHCLEVENTID idEvent);
/** @} */
/**
* Shared Clipboard transfer source type.
* @note Part of saved state!
*/
typedef enum SHCLSOURCE
{
/** Invalid source type. */
SHCLSOURCE_INVALID = 0,
/** Source is local. */
SHCLSOURCE_LOCAL,
/** Source is remote. */
SHCLSOURCE_REMOTE,
/** The usual 32-bit hack. */
SHCLSOURCE_32BIT_HACK = 0x7fffffff
} SHCLSOURCE;
/** Opaque data structure for the X11/VBox frontend/glue code.
* @{ */
struct SHCLCONTEXT;
typedef struct SHCLCONTEXT SHCLCONTEXT;
/** @} */
/** Pointer to opaque data structure the X11/VBox frontend/glue code. */
typedef SHCLCONTEXT *PSHCLCONTEXT;
/** Opaque request structure for X11 clipboard data.
* @{ */
struct CLIPREADCBREQ;
typedef struct CLIPREADCBREQ CLIPREADCBREQ;
/** @} */
#endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_h */
|
