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
|
/* $Id: VBoxClipboard.h $ */
/** @file
* Shared Clipboard Service - Internal Header.
*/
/*
* Copyright (C) 2006-2019 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.
*/
#ifndef VBOX_INCLUDED_SRC_SharedClipboard_VBoxClipboard_h
#define VBOX_INCLUDED_SRC_SharedClipboard_VBoxClipboard_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/hgcmsvc.h>
#include <VBox/log.h>
struct _VBOXCLIPBOARDCONTEXT;
typedef struct _VBOXCLIPBOARDCONTEXT VBOXCLIPBOARDCONTEXT;
typedef struct _VBOXCLIPBOARDCLIENTDATA
{
struct _VBOXCLIPBOARDCLIENTDATA *pNext;
struct _VBOXCLIPBOARDCLIENTDATA *pPrev;
VBOXCLIPBOARDCONTEXT *pCtx;
uint32_t u32ClientID;
bool fAsync; /* Guest is waiting for a message. */
bool fReadPending; /* The guest is waiting for data from the host */
bool fMsgQuit;
bool fMsgReadData;
bool fMsgFormats;
struct {
VBOXHGCMCALLHANDLE callHandle;
VBOXHGCMSVCPARM *paParms;
} async;
struct {
VBOXHGCMCALLHANDLE callHandle;
VBOXHGCMSVCPARM *paParms;
} asyncRead;
struct {
void *pv;
uint32_t cb;
uint32_t u32Format;
} data;
uint32_t u32AvailableFormats;
uint32_t u32RequestedFormat;
} VBOXCLIPBOARDCLIENTDATA;
/*
* The service functions. Locking is between the service thread and the platform dependent windows thread.
*/
bool vboxSvcClipboardLock (void);
void vboxSvcClipboardUnlock (void);
void vboxSvcClipboardReportMsg (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Msg, uint32_t u32Formats);
void vboxSvcClipboardCompleteReadData(VBOXCLIPBOARDCLIENTDATA *pClient, int rc, uint32_t cbActual);
bool vboxSvcClipboardGetHeadless(void);
/*
* Platform dependent functions.
*/
int vboxClipboardInit (void);
void vboxClipboardDestroy (void);
int vboxClipboardConnect (VBOXCLIPBOARDCLIENTDATA *pClient, bool fHeadless);
void vboxClipboardDisconnect (VBOXCLIPBOARDCLIENTDATA *pClient);
void vboxClipboardFormatAnnounce (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Formats);
int vboxClipboardReadData (VBOXCLIPBOARDCLIENTDATA *pClient, uint32_t u32Format, void *pv, uint32_t cb, uint32_t *pcbActual);
void vboxClipboardWriteData (VBOXCLIPBOARDCLIENTDATA *pClient, void *pv, uint32_t cb, uint32_t u32Format);
int vboxClipboardSync (VBOXCLIPBOARDCLIENTDATA *pClient);
/* Host unit testing interface */
#ifdef UNIT_TEST
uint32_t TestClipSvcGetMode(void);
#endif
#endif /* !VBOX_INCLUDED_SRC_SharedClipboard_VBoxClipboard_h */
|