1 | /** @file
|
---|
2 | * Drag and Drop manager.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2011-2016 Oracle Corporation
|
---|
7 | *
|
---|
8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
9 | * available from http://www.virtualbox.org. This file is free software;
|
---|
10 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
11 | * General Public License (GPL) as published by the Free Software
|
---|
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
15 | */
|
---|
16 |
|
---|
17 | #ifndef ___VBox_HostService_DnD_dndmanager_h
|
---|
18 | #define ___VBox_HostService_DnD_dndmanager_h
|
---|
19 |
|
---|
20 | #include <VBox/GuestHost/DragAndDrop.h>
|
---|
21 | #include <VBox/HostServices/Service.h>
|
---|
22 | #include <VBox/HostServices/DragAndDropSvc.h>
|
---|
23 |
|
---|
24 | #include <iprt/cpp/ministring.h>
|
---|
25 | #include <iprt/cpp/list.h>
|
---|
26 |
|
---|
27 | typedef DECLCALLBACK(int) FNDNDPROGRESS(uint32_t uState, uint32_t uPercentage, int rc, void *pvUser);
|
---|
28 | typedef FNDNDPROGRESS *PFNDNDPROGRESS;
|
---|
29 |
|
---|
30 | /**
|
---|
31 | * DnD message class. This class forms the base of all other more specialized
|
---|
32 | * message classes.
|
---|
33 | */
|
---|
34 | class DnDMessage
|
---|
35 | {
|
---|
36 | public:
|
---|
37 |
|
---|
38 | DnDMessage(void)
|
---|
39 | : m_pNextMsg(NULL)
|
---|
40 | {
|
---|
41 | }
|
---|
42 |
|
---|
43 | virtual ~DnDMessage(void)
|
---|
44 | {
|
---|
45 | clearNextMsg();
|
---|
46 | }
|
---|
47 |
|
---|
48 | virtual HGCM::Message* nextHGCMMessage(void)
|
---|
49 | {
|
---|
50 | return m_pNextMsg;
|
---|
51 | }
|
---|
52 |
|
---|
53 | virtual int currentMessageInfo(uint32_t *puMsg, uint32_t *pcParms)
|
---|
54 | {
|
---|
55 | AssertPtrReturn(puMsg, VERR_INVALID_POINTER);
|
---|
56 | AssertPtrReturn(pcParms, VERR_INVALID_POINTER);
|
---|
57 |
|
---|
58 | if (!m_pNextMsg)
|
---|
59 | return VERR_NO_DATA;
|
---|
60 |
|
---|
61 | *puMsg = m_pNextMsg->message();
|
---|
62 | *pcParms = m_pNextMsg->paramsCount();
|
---|
63 |
|
---|
64 | return VINF_SUCCESS;
|
---|
65 | }
|
---|
66 |
|
---|
67 | virtual int currentMessage(uint32_t uMsg, uint32_t cParms,
|
---|
68 | VBOXHGCMSVCPARM paParms[])
|
---|
69 | {
|
---|
70 | if (!m_pNextMsg)
|
---|
71 | return VERR_NO_DATA;
|
---|
72 |
|
---|
73 | int rc = m_pNextMsg->getData(uMsg, cParms, paParms);
|
---|
74 |
|
---|
75 | clearNextMsg();
|
---|
76 |
|
---|
77 | return rc;
|
---|
78 | }
|
---|
79 |
|
---|
80 | virtual void clearNextMsg(void)
|
---|
81 | {
|
---|
82 | if (m_pNextMsg)
|
---|
83 | {
|
---|
84 | delete m_pNextMsg;
|
---|
85 | m_pNextMsg = NULL;
|
---|
86 | }
|
---|
87 | }
|
---|
88 |
|
---|
89 | virtual bool isMessageWaiting(void) const { return m_pNextMsg != NULL; }
|
---|
90 |
|
---|
91 | protected:
|
---|
92 |
|
---|
93 | HGCM::Message *m_pNextMsg;
|
---|
94 | };
|
---|
95 |
|
---|
96 | /**
|
---|
97 | * DnD message class for generic messages which didn't need any special
|
---|
98 | * handling.
|
---|
99 | */
|
---|
100 | class DnDGenericMessage: public DnDMessage
|
---|
101 | {
|
---|
102 | public:
|
---|
103 | DnDGenericMessage(uint32_t uMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[])
|
---|
104 | {
|
---|
105 | m_pNextMsg = new HGCM::Message(uMsg, cParms, paParms);
|
---|
106 | }
|
---|
107 | };
|
---|
108 |
|
---|
109 | /**
|
---|
110 | * DnD message class for informing the guest to cancel any current (and pending) activities.
|
---|
111 | */
|
---|
112 | class DnDHGCancelMessage: public DnDMessage
|
---|
113 | {
|
---|
114 | public:
|
---|
115 |
|
---|
116 | DnDHGCancelMessage(void)
|
---|
117 | {
|
---|
118 | m_pNextMsg
|
---|
119 | = new HGCM::Message(DragAndDropSvc::HOST_DND_HG_EVT_CANCEL,
|
---|
120 | 0 /* cParms */, 0 /* aParms */);
|
---|
121 | }
|
---|
122 | };
|
---|
123 |
|
---|
124 | /**
|
---|
125 | * DnD manager. Manage creation and queuing of messages for the various DnD
|
---|
126 | * messages types.
|
---|
127 | */
|
---|
128 | class DnDManager
|
---|
129 | {
|
---|
130 | public:
|
---|
131 |
|
---|
132 | DnDManager(PFNDNDPROGRESS pfnProgressCallback, void *pvProgressUser)
|
---|
133 | : m_pCurMsg(NULL)
|
---|
134 | , m_pfnProgressCallback(pfnProgressCallback)
|
---|
135 | , m_pvProgressUser(pvProgressUser)
|
---|
136 | {}
|
---|
137 |
|
---|
138 | virtual ~DnDManager(void)
|
---|
139 | {
|
---|
140 | clear();
|
---|
141 | }
|
---|
142 |
|
---|
143 | int addMessage(uint32_t uMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[], bool fAppend = true);
|
---|
144 |
|
---|
145 | HGCM::Message *nextHGCMMessage(void);
|
---|
146 | int nextMessageInfo(uint32_t *puMsg, uint32_t *pcParms);
|
---|
147 | int nextMessage(uint32_t uMsg, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
|
---|
148 |
|
---|
149 | void clear(void);
|
---|
150 | int doReschedule(void);
|
---|
151 |
|
---|
152 | private:
|
---|
153 | DnDMessage *m_pCurMsg;
|
---|
154 | RTCList<DnDMessage*> m_dndMessageQueue;
|
---|
155 |
|
---|
156 | /* Progress stuff */
|
---|
157 | PFNDNDPROGRESS m_pfnProgressCallback;
|
---|
158 | void *m_pvProgressUser;
|
---|
159 | };
|
---|
160 | #endif /* ___VBox_HostService_DnD_dndmanager_h */
|
---|
161 |
|
---|