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
218
219
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_COMPHELPER_PROXYAGGREGATION_HXX
#define INCLUDED_COMPHELPER_PROXYAGGREGATION_HXX
#include <com/sun/star/uno/XAggregation.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/interfacecontainer.hxx>
#include <cppuhelper/basemutex.hxx>
#include <comphelper/uno3.hxx>
#include <cppuhelper/compbase_ex.hxx>
#include <comphelper/comphelperdllapi.h>
namespace com { namespace sun { namespace star { namespace uno {
class XComponentContext;
} } } }
/* class hierarchy herein:
+-------------------+ helper class for aggregating the proxy to another object
| OProxyAggregation | - not ref counted
+-------------------+ - no UNO implementation, i.e. not derived from XInterface
^ (neither direct nor indirect)
|
|
+----------------------------------+ helper class for aggregating a proxy to an XComponent
| OComponentProxyAggregationHelper | - life time coupling: if the inner component (the "aggregate")
+----------------------------------+ is disposed, the outer (the delegator) is disposed, too, and
^ vice versa
| - UNO based, implementing XEventListener
|
+----------------------------+ component aggregating another XComponent
| OComponentProxyAggregation | - life time coupling as above
+----------------------------+ - ref-counted
- implements an XComponent itself
If you need to
- wrap a foreign object which is a XComponent
=> use OComponentProxyAggregation
- call componentAggregateProxyFor in your ctor
- call implEnsureDisposeInDtor in your dtor
- wrap a foreign object which is a XComponent, but already have ref-counting mechanisms
inherited from somewhere else
=> use OComponentProxyAggregationHelper
- override dispose - don't forget to call the base class' dispose!
- call componentAggregateProxyFor in your ctor
- wrap a foreign object which is no XComponent
=> use OProxyAggregation
- call baseAggregateProxyFor in your ctor
*/
namespace comphelper
{
//= OProxyAggregation
/** helper class for aggregating a proxy for a foreign object
*/
class OProxyAggregation
{
private:
css::uno::Reference< css::uno::XAggregation > m_xProxyAggregate;
css::uno::Reference< css::lang::XTypeProvider > m_xProxyTypeAccess;
css::uno::Reference< css::uno::XComponentContext > m_xContext;
protected:
const css::uno::Reference< css::uno::XComponentContext >& getComponentContext()
{
return m_xContext;
}
protected:
OProxyAggregation( const css::uno::Reference< css::uno::XComponentContext >& _rxContext );
~OProxyAggregation();
/// to be called from within your ctor
void baseAggregateProxyFor(
const css::uno::Reference< css::uno::XInterface >& _rxComponent,
oslInterlockedCount& _rRefCount,
::cppu::OWeakObject& _rDelegator
);
// XInterface and XTypeProvider
/// @throws css::uno::RuntimeException
css::uno::Any SAL_CALL queryAggregation( const css::uno::Type& _rType );
/// @throws css::uno::RuntimeException
css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( );
private:
OProxyAggregation( const OProxyAggregation& ) = delete;
OProxyAggregation& operator=( const OProxyAggregation& ) = delete;
};
//= OComponentProxyAggregationHelper
/** a helper class for aggregating a proxy to an XComponent
<p>The object couples the life time of itself and the component: if one of the both
dies (in a sense of being disposed), the other one dies, too.</p>
<p>The class itself does not implement XComponent so you need to forward any XComponent::dispose
calls which your derived class gets to the dispose method of this class.</p>
*/
class COMPHELPER_DLLPUBLIC OComponentProxyAggregationHelper :public ::cppu::ImplHelper1 < css::lang::XEventListener
>
,private OProxyAggregation
{
private:
typedef ::cppu::ImplHelper1 < css::lang::XEventListener
> BASE; // prevents some MSVC problems
protected:
css::uno::Reference< css::lang::XComponent >
m_xInner;
::cppu::OBroadcastHelper& m_rBHelper;
protected:
// OProxyAggregation
using OProxyAggregation::getComponentContext;
// XInterface
css::uno::Any SAL_CALL queryInterface( const css::uno::Type& _rType ) override;
// XTypeProvider
DECLARE_XTYPEPROVIDER( )
protected:
OComponentProxyAggregationHelper(
const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
::cppu::OBroadcastHelper& _rBHelper
);
virtual ~OComponentProxyAggregationHelper( );
/// to be called from within your ctor
void componentAggregateProxyFor(
const css::uno::Reference< css::lang::XComponent >& _rxComponent,
oslInterlockedCount& _rRefCount,
::cppu::OWeakObject& _rDelegator
);
// XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
// XComponent
/// @throws css::uno::RuntimeException
virtual void SAL_CALL dispose() = 0;
private:
OComponentProxyAggregationHelper( const OComponentProxyAggregationHelper& ) = delete;
OComponentProxyAggregationHelper& operator=( const OComponentProxyAggregationHelper& ) = delete;
};
//= OComponentProxyAggregation
class COMPHELPER_DLLPUBLIC OComponentProxyAggregation : public cppu::BaseMutex
,public cppu::WeakComponentImplHelperBase
,public OComponentProxyAggregationHelper
{
protected:
OComponentProxyAggregation(
const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
const css::uno::Reference< css::lang::XComponent >& _rxComponent
);
virtual ~OComponentProxyAggregation() override;
// XInterface
DECLARE_XINTERFACE()
// XTypeProvider
DECLARE_XTYPEPROVIDER()
// OComponentHelper
virtual void SAL_CALL disposing() override;
// XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& _rSource ) override;
// XComponent/OComponentProxyAggregationHelper
virtual void SAL_CALL dispose() override;
private:
OComponentProxyAggregation( const OComponentProxyAggregation& ) = delete;
OComponentProxyAggregation& operator=( const OComponentProxyAggregation& ) = delete;
};
} // namespace comphelper
#endif // INCLUDED_COMPHELPER_PROXYAGGREGATION_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
