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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
/** This header generates the following template classes with a variable number
of interfaces:
comphelper::ImplHelper<N> <typename Ifc1, ..., typename Ifc<N> >
comphelper::WeakImplHelper<N> <typename Ifc1, ..., typename Ifc<N> >
comphelper::WeakComponentImplHelper<N> <typename Ifc1, ...,
typename Ifc<N> >
comphelper::ImplInheritanceHelper<N> <typename BaseClass,
typename Ifc1, ..., typename Ifc<N> >
as already present in headers cppuhelper/implbase<1-12>.hxx and
cppuhelper/compbase<1-12>.hxx.
<N> denotes the number of interface types passed as template arguments.
Don't use this header for interface numbers up to 12;
always use the existing cppuhelper/(impl|comp)base<1-12>.hxx headers
for this purpose, which eases debugging.
Including this header requires a little discipline, because it has no
include guards. Please use the following external include guard rule
where <N> is the number of interface types:
#if ! defined(INCLUDED_COMPHELPER_IMPLBASE_VAR_HXX_<N>)
#define INCLUDED_COMPHELPER_IMPLBASE_VAR_HXX_<N>
#define COMPHELPER_IMPLBASE_INTERFACE_NUMBER <N>
#include "comphelper/implbase_var.hxx"
#endif
Additionally you can
#define COMPHELPER_IMPLBASE_MAX_CTOR_ARGS <N>
to control the maximum number of templated ctor arguments for the
ImplInheritanceHelper<N> classes.
The default is a maximum of 6 arguments.
*/
#if ! defined(COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
#error "you have to define COMPHELPER_IMPLBASE_INTERFACE_NUMBER prior to including comphelper/implbase_var.hxx!"
#endif // ! defined(COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
#if !defined(COMPHELPER_IMPLBASE_TEST_PHASE) && COMPHELPER_IMPLBASE_INTERFACE_NUMBER <= 12
#error "include proper header file: cppuhelper/implbase<N>.hxx or cppuhelper/compbase<N>.hxx!"
#endif
#if ! defined(COMPHELPER_IMPLBASE_MAX_CTOR_ARGS)
#define COMPHELPER_IMPLBASE_MAX_CTOR_ARGS 6 // default
#endif
#if ! defined(_CPPUHELPER_IMPLBASE_EX_HXX_)
#include "cppuhelper/implbase_ex.hxx"
#endif
#if ! defined(INCLUDED_RTL_INSTANCE_HXX)
#include "rtl/instance.hxx"
#endif
#if ! defined(_CPPUHELPER_COMPBASE_EX_HXX_)
#include "cppuhelper/compbase_ex.hxx"
#endif
#include "boost/preprocessor/cat.hpp"
#include "boost/preprocessor/repetition.hpp"
#include "boost/preprocessor/arithmetic/add.hpp"
namespace comphelper {
// Suppress warnings about hidden functions in case any of the IfcN has
// functions named dispose, addEventListener, or removeEventListener:
#if defined __SUNPRO_CC
#pragma disable_warn
#endif
namespace detail {
struct BOOST_PP_CAT(class_data, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
{
sal_Int16 m_nTypes;
sal_Bool m_storedTypeRefs;
sal_Bool m_storedId;
sal_Int8 m_id[16];
::cppu::type_entry m_typeEntries[COMPHELPER_IMPLBASE_INTERFACE_NUMBER + 1];
};
/// @internal
template < BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
typename Ifc), typename Impl >
struct BOOST_PP_CAT(ImplClassData, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
{
::cppu::class_data * operator()() {
static BOOST_PP_CAT(class_data, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
s_cd = {
COMPHELPER_IMPLBASE_INTERFACE_NUMBER + 1, sal_False, sal_False,
{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
{
#define COMPHELPER_IMPLBASE_classdataList(z_, n_, unused_) \
{ { BOOST_PP_CAT(Ifc, n_)::static_type }, \
reinterpret_cast<sal_IntPtr>( static_cast< BOOST_PP_CAT(Ifc, n_) * >( \
reinterpret_cast<Impl *>(16) ) ) - 16 },
BOOST_PP_REPEAT(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
COMPHELPER_IMPLBASE_classdataList, ~)
#undef COMPHELPER_IMPLBASE_classdataList
{ { ::com::sun::star::lang::XTypeProvider::static_type },
reinterpret_cast<sal_IntPtr>(
static_cast< ::com::sun::star::lang::XTypeProvider * >(
reinterpret_cast<Impl *>(16) ) ) - 16 }
}
};
return reinterpret_cast< ::cppu::class_data * >(&s_cd);
}
};
} // namespace detail
/** Implementation helper implementing interface
::com::sun::star::lang::XTypeProvider and method
XInterface::queryInterface(), but no reference counting.
@derive
Inherit from this class giving your interface(s) to be implemented as
template argument(s). Your sub class defines method implementations for
these interface(s) including acquire()/release() and delegates incoming
queryInterface() calls to this base class.
*/
template< BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
typename Ifc) >
class SAL_NO_VTABLE BOOST_PP_CAT(ImplHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
: public ::com::sun::star::lang::XTypeProvider,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, public Ifc)
{
/// @internal
struct cd : public ::rtl::StaticAggregate<
::cppu::class_data,
BOOST_PP_CAT(detail::ImplClassData,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc),
BOOST_PP_CAT(ImplHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc)>
> > {};
protected:
BOOST_PP_CAT(ImplHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)() {}
virtual ~BOOST_PP_CAT(ImplHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)() {}
public:
virtual ::com::sun::star::uno::Any
SAL_CALL queryInterface( ::com::sun::star::uno::Type const& rType )
throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_query( rType, cd::get(), this ); }
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >
SAL_CALL getTypes() throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_getTypes( cd::get() ); }
virtual ::com::sun::star::uno::Sequence<sal_Int8>
SAL_CALL getImplementationId()
throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_getImplementationId( cd::get() ); }
};
/** Implementation helper implementing interfaces
::com::sun::star::lang::XTypeProvider and
::com::sun::star::uno::XInterface
which supports weak mechanism to be held weakly
(supporting ::com::sun::star::uno::XWeak thru ::cppu::OWeakObject).
@derive
Inherit from this class giving your interface(s) to be implemented as
template argument(s). Your sub class defines method implementations for
these interface(s).
*/
template< BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
typename Ifc) >
class SAL_NO_VTABLE BOOST_PP_CAT(WeakImplHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
: public ::cppu::OWeakObject,
public ::com::sun::star::lang::XTypeProvider,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, public Ifc)
{
/// @internal
struct cd : public ::rtl::StaticAggregate<
::cppu::class_data,
BOOST_PP_CAT(detail::ImplClassData,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc),
BOOST_PP_CAT(WeakImplHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc)>
> > {};
public:
virtual ::com::sun::star::uno::Any
SAL_CALL queryInterface( ::com::sun::star::uno::Type const& rType )
throw (::com::sun::star::uno::RuntimeException)
{
return ::cppu::WeakImplHelper_query(
rType, cd::get(), this, static_cast<OWeakObject *>(this) );
}
virtual void SAL_CALL acquire() throw ()
{ OWeakObject::acquire(); }
virtual void SAL_CALL release() throw ()
{ OWeakObject::release(); }
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >
SAL_CALL getTypes() throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::WeakImplHelper_getTypes( cd::get() ); }
virtual ::com::sun::star::uno::Sequence<sal_Int8>
SAL_CALL getImplementationId()
throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_getImplementationId( cd::get() ); }
};
/** Implementation helper implementing interfaces
::com::sun::star::lang::XTypeProvider and
::com::sun::star::uno::XInterface inherting from a BaseClass.
All acquire() and release() calls are delegated to the BaseClass.
Upon queryInterface(), if a demanded interface is not supported by this
class directly, the request is delegated to the BaseClass.
@attention
The BaseClass has to be complete in a sense, that
::com::sun::star::uno::XInterface and
::com::sun::star::lang::XTypeProvider are implemented properly.
The BaseClass must have at least one ctor that can be called with
COMPHELPER_IMPLBASE_MAX_CTOR_ARGS or fewer arguments.
@derive
Inherit from this class giving your additional interface(s) to be
implemented as template argument(s). Your sub class defines method
implementations for these interface(s).
*/
template <typename BaseClass,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
typename Ifc) >
class SAL_NO_VTABLE BOOST_PP_CAT(ImplInheritanceHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
: public BaseClass,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, public Ifc)
{
/// @internal
struct cd : public ::rtl::StaticAggregate<
::cppu::class_data,
BOOST_PP_CAT(detail::ImplClassData,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc),
BOOST_PP_CAT(ImplInheritanceHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)<
BaseClass,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc)>
> > {};
protected:
#define COMPHELPER_IMPLBASE_templctor_args(z_, n_, unused_) \
BOOST_PP_CAT(T, n_) const& BOOST_PP_CAT(arg, n_)
#define COMPHELPER_IMPLBASE_templctor(z_, n_, classname_) \
template< BOOST_PP_ENUM_PARAMS( BOOST_PP_ADD(n_, 1), typename T) > \
explicit BOOST_PP_CAT(classname_, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)( \
BOOST_PP_ENUM(BOOST_PP_ADD(n_, 1), \
COMPHELPER_IMPLBASE_templctor_args, ~) ) \
: BaseClass( BOOST_PP_ENUM_PARAMS(BOOST_PP_ADD(n_, 1), arg) ) {}
BOOST_PP_CAT(ImplInheritanceHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)()
: BaseClass() {}
BOOST_PP_REPEAT(COMPHELPER_IMPLBASE_MAX_CTOR_ARGS,
COMPHELPER_IMPLBASE_templctor, ImplInheritanceHelper)
public:
virtual ::com::sun::star::uno::Any
SAL_CALL queryInterface( ::com::sun::star::uno::Type const& rType )
throw (::com::sun::star::uno::RuntimeException)
{
::com::sun::star::uno::Any const aRet(
::cppu::ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
if (aRet.hasValue())
return aRet;
return BaseClass::queryInterface( rType );
}
virtual void SAL_CALL acquire() throw ()
{ BaseClass::acquire(); }
virtual void SAL_CALL release() throw ()
{ BaseClass::release(); }
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >
SAL_CALL getTypes() throw (::com::sun::star::uno::RuntimeException)
{
return ::cppu::ImplInhHelper_getTypes(
cd::get(), BaseClass::getTypes() );
}
virtual ::com::sun::star::uno::Sequence<sal_Int8>
SAL_CALL getImplementationId()
throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_getImplementationId( cd::get() ); }
};
// not needed anymore:
#undef COMPHELPER_IMPLBASE_templctor_args
#undef COMPHELPER_IMPLBASE_templctor
/** Implementation helper supporting
::com::sun::star::lang::XTypeProvider and
::com::sun::star::lang::XComponent.
Upon disposing objects of this class, sub-classes receive a disposing()
call. Objects of this class can be held weakly, i.e. by a
::com::sun::star::uno::WeakReference.
@attention
The life-cycle of the passed mutex reference has to be longer than objects
of this class.
@derive
Inherit from this class giving your interface(s) to be implemented as
template argument(s). Your sub class defines method implementations for
these interface(s).
*/
template < BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
typename Ifc) >
class SAL_NO_VTABLE BOOST_PP_CAT(WeakComponentImplHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
: public ::cppu::WeakComponentImplHelperBase,
public ::com::sun::star::lang::XTypeProvider,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, public Ifc)
{
/// @internal
struct cd : public ::rtl::StaticAggregate<
::cppu::class_data,
BOOST_PP_CAT(detail::ImplClassData,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc),
BOOST_PP_CAT(WeakComponentImplHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc)>
> > {};
public:
BOOST_PP_CAT(WeakComponentImplHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)(
::osl::Mutex & rMutex ) : WeakComponentImplHelperBase(rMutex) {}
virtual ::com::sun::star::uno::Any
SAL_CALL queryInterface( ::com::sun::star::uno::Type const& rType )
throw (::com::sun::star::uno::RuntimeException)
{
return ::cppu::WeakComponentImplHelper_query(
rType, cd::get(), this,
static_cast< ::cppu::WeakComponentImplHelperBase * >(this) );
}
virtual void SAL_CALL acquire() throw ()
{ WeakComponentImplHelperBase::acquire(); }
virtual void SAL_CALL release() throw ()
{ WeakComponentImplHelperBase::release(); }
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >
SAL_CALL getTypes() throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::WeakComponentImplHelper_getTypes( cd::get() ); }
virtual ::com::sun::star::uno::Sequence<sal_Int8>
SAL_CALL getImplementationId()
throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_getImplementationId( cd::get() ); }
// implement XComponent directly avoiding ambiguities:
virtual void SAL_CALL dispose()
throw (::com::sun::star::uno::RuntimeException)
{ WeakComponentImplHelperBase::dispose(); }
virtual void SAL_CALL addEventListener(
::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>
const & xListener ) throw (::com::sun::star::uno::RuntimeException)
{ WeakComponentImplHelperBase::addEventListener( xListener ); }
virtual void SAL_CALL removeEventListener(
::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener>
const & xListener ) throw (::com::sun::star::uno::RuntimeException)
{ WeakComponentImplHelperBase::removeEventListener( xListener ); }
};
template < BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER,
typename Ifc) >
class SAL_NO_VTABLE BOOST_PP_CAT(PartialWeakComponentImplHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
: public ::cppu::WeakComponentImplHelperBase,
public ::com::sun::star::lang::XTypeProvider,
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, public Ifc)
{
/// @internal
struct cd : public ::rtl::StaticAggregate<
::cppu::class_data,
BOOST_PP_CAT(detail::ImplClassData,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)
<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc),
BOOST_PP_CAT(PartialWeakComponentImplHelper,
COMPHELPER_IMPLBASE_INTERFACE_NUMBER)<
BOOST_PP_ENUM_PARAMS(COMPHELPER_IMPLBASE_INTERFACE_NUMBER, Ifc)>
> > {};
public:
BOOST_PP_CAT(PartialWeakComponentImplHelper, COMPHELPER_IMPLBASE_INTERFACE_NUMBER)(
::osl::Mutex & rMutex ) : WeakComponentImplHelperBase(rMutex) {}
virtual ::com::sun::star::uno::Any
SAL_CALL queryInterface( ::com::sun::star::uno::Type const& rType )
throw (::com::sun::star::uno::RuntimeException)
{
return ::cppu::WeakComponentImplHelper_query(
rType, cd::get(), this,
static_cast< ::cppu::WeakComponentImplHelperBase * >(this) );
}
virtual void SAL_CALL acquire() throw ()
{ WeakComponentImplHelperBase::acquire(); }
virtual void SAL_CALL release() throw ()
{ WeakComponentImplHelperBase::release(); }
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >
SAL_CALL getTypes() throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::WeakComponentImplHelper_getTypes( cd::get() ); }
virtual ::com::sun::star::uno::Sequence<sal_Int8>
SAL_CALL getImplementationId()
throw (::com::sun::star::uno::RuntimeException)
{ return ::cppu::ImplHelper_getImplementationId( cd::get() ); }
};
} // namespace comphelper
// undef for multiple use/inclusion of this header:
#undef COMPHELPER_IMPLBASE_MAX_CTOR_ARGS
#undef COMPHELPER_IMPLBASE_INTERFACE_NUMBER
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
