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
|
/* $Id: listeners.h $ */
/** @file
* MS COM / XPCOM Abstraction Layer - Listener helpers.
*/
/*
* Copyright (C) 2010-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox 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.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_com_listeners_h
#define VBOX_INCLUDED_com_listeners_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/com/com.h>
#include <VBox/com/VirtualBox.h>
/** @defgroup grp_com_listeners Listener Helpers
* @ingroup grp_com
* @{
*/
#ifdef VBOX_WITH_XPCOM
# define NS_IMPL_QUERY_HEAD_INLINE() \
NS_IMETHODIMP QueryInterface(REFNSIID aIID, void **aInstancePtr) \
{ \
NS_ASSERTION(aInstancePtr, "QueryInterface requires a non-NULL destination!"); \
nsISupports *foundInterface;
# define NS_INTERFACE_MAP_BEGIN_INLINE() NS_IMPL_QUERY_HEAD_INLINE()
# define NS_IMPL_QUERY_INTERFACE1_INLINE(a_i1) \
NS_INTERFACE_MAP_BEGIN_INLINE() \
NS_INTERFACE_MAP_ENTRY(a_i1) \
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, a_i1) \
NS_INTERFACE_MAP_END
#endif
template <class T, class TParam = void *>
class ListenerImpl :
public ATL::CComObjectRootEx<ATL::CComMultiThreadModel>,
VBOX_SCRIPTABLE_IMPL(IEventListener)
{
T* mListener;
#ifdef RT_OS_WINDOWS
/* FTM stuff */
ComPtr<IUnknown> m_pUnkMarshaler;
#else
nsAutoRefCnt mRefCnt;
NS_DECL_OWNINGTHREAD
#endif
public:
ListenerImpl()
{
}
virtual ~ListenerImpl()
{
}
HRESULT init(T* aListener, TParam param)
{
mListener = aListener;
return mListener->init(param);
}
HRESULT init(T* aListener)
{
mListener = aListener;
return mListener->init();
}
void uninit()
{
if (mListener)
{
mListener->uninit();
delete mListener;
mListener = 0;
}
}
HRESULT FinalConstruct()
{
#ifdef RT_OS_WINDOWS
return CoCreateFreeThreadedMarshaler(this, &m_pUnkMarshaler.m_p);
#else
return S_OK;
#endif
}
void FinalRelease()
{
uninit();
#ifdef RT_OS_WINDOWS
m_pUnkMarshaler.setNull();
#endif
}
T* getWrapped()
{
return mListener;
}
DECLARE_NOT_AGGREGATABLE(ListenerImpl)
DECLARE_PROTECT_FINAL_CONSTRUCT()
#ifdef RT_OS_WINDOWS
BEGIN_COM_MAP(ListenerImpl)
COM_INTERFACE_ENTRY(IEventListener)
COM_INTERFACE_ENTRY2(IDispatch, IEventListener)
COM_INTERFACE_ENTRY_AGGREGATE(IID_IMarshal, m_pUnkMarshaler.m_p)
END_COM_MAP()
#else
NS_IMETHOD_(nsrefcnt) AddRef(void)
{
NS_PRECONDITION(PRInt32(mRefCnt) >= 0, "illegal refcnt");
nsrefcnt count;
count = PR_AtomicIncrement((PRInt32*)&mRefCnt);
NS_LOG_ADDREF(this, count, "ListenerImpl", sizeof(*this));
return count;
}
NS_IMETHOD_(nsrefcnt) Release(void)
{
nsrefcnt count;
NS_PRECONDITION(0 != mRefCnt, "dup release");
count = PR_AtomicDecrement((PRInt32 *)&mRefCnt);
NS_LOG_RELEASE(this, count, "ListenerImpl");
if (0 == count) {
mRefCnt = 1; /* stabilize */
/* enable this to find non-threadsafe destructors: */
/* NS_ASSERT_OWNINGTHREAD(_class); */
NS_DELETEXPCOM(this);
return 0;
}
return count;
}
NS_IMPL_QUERY_INTERFACE1_INLINE(IEventListener)
#endif
STDMETHOD(HandleEvent)(IEvent * aEvent)
{
VBoxEventType_T aType = VBoxEventType_Invalid;
HRESULT hrc = aEvent->COMGETTER(Type)(&aType);
AssertMsg(SUCCEEDED(hrc), ("hrc=%Rhrc\n", hrc)); RT_NOREF(hrc);
return mListener->HandleEvent(aType, aEvent);
}
};
#ifdef VBOX_WITH_XPCOM
# define VBOX_LISTENER_DECLARE(klazz) NS_DECL_CLASSINFO(klazz)
#else
# define VBOX_LISTENER_DECLARE(klazz)
#endif
/** @} */
#endif /* !VBOX_INCLUDED_com_listeners_h */
|
