LibreOffice
LibreOffice 24.2 SDK C/C++ API Reference
implbase2.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 #ifndef INCLUDED_CPPUHELPER_IMPLBASE2_HXX
24 #define INCLUDED_CPPUHELPER_IMPLBASE2_HXX
25 
27 #include "rtl/instance.hxx"
28 #include "cppuhelper/weak.hxx"
29 #include "cppuhelper/weakagg.hxx"
30 #include "com/sun/star/lang/XTypeProvider.hpp"
31 
32 namespace cppu
33 {
35 
36  struct class_data2
37  {
38  sal_Int16 m_nTypes;
39  sal_Bool m_storedTypeRefs;
40  sal_Bool m_storedId;
41  sal_Int8 m_id[ 16 ];
42  type_entry m_typeEntries[ 2 + 1 ];
43  };
44 
45  template< typename Ifc1, typename Ifc2, typename Impl > struct SAL_WARN_UNUSED ImplClassData2
46  {
47  class_data* operator ()()
48  {
49  static class_data2 s_cd =
50  {
51  2 +1, false, false,
52  { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
53  {
54  CPPUHELPER_DETAIL_TYPEENTRY(Ifc1),
55  CPPUHELPER_DETAIL_TYPEENTRY(Ifc2),
56  CPPUHELPER_DETAIL_TYPEENTRY(css::lang::XTypeProvider)
57  }
58  };
59  return reinterpret_cast< class_data * >(&s_cd);
60  }
61  };
62 
64 
73  template< class Ifc1, class Ifc2 >
74  class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE ImplHelper2
75  : public css::lang::XTypeProvider
76  , public Ifc1, public Ifc2
77  {
78  struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, ImplHelper2<Ifc1, Ifc2> > > {};
79  public:
80 #if defined LIBO_INTERNAL_ONLY
81  ImplHelper2() = default;
82  ImplHelper2(ImplHelper2 const &) = default;
83  ImplHelper2(ImplHelper2 &&) = default;
84  ImplHelper2 & operator =(ImplHelper2 const &) = default;
85  ImplHelper2 & operator =(ImplHelper2 &&) = default;
86 #endif
87 
88  virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
89  { return ImplHelper_query( rType, cd::get(), this ); }
90  virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
91  { return ImplHelper_getTypes( cd::get() ); }
92  virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
93  { return ImplHelper_getImplementationId( cd::get() ); }
94 
95 #if !defined _MSC_VER // public -> protected changes mangled names there
96  protected:
97 #endif
99  };
108  template< class Ifc1, class Ifc2 >
109  class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE SAL_DLLPUBLIC_EXPORT WeakImplHelper2
110  : public OWeakObject
111  , public css::lang::XTypeProvider
112  , public Ifc1, public Ifc2
113  {
114  struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, WeakImplHelper2<Ifc1, Ifc2> > > {};
115  public:
116  virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
117  { return WeakImplHelper_query( rType, cd::get(), this, static_cast<OWeakObject *>(this) ); }
118  virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
119  { OWeakObject::acquire(); }
120  virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
121  { OWeakObject::release(); }
122  virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
123  { return WeakImplHelper_getTypes( cd::get() ); }
124  virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
125  { return ImplHelper_getImplementationId( cd::get() ); }
126  };
140  template< class Ifc1, class Ifc2 >
141  class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakAggImplHelper2
142  : public OWeakAggObject
143  , public css::lang::XTypeProvider
144  , public Ifc1, public Ifc2
145  {
146  struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, WeakAggImplHelper2<Ifc1, Ifc2> > > {};
147  public:
148  virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
149  { return OWeakAggObject::queryInterface( rType ); }
150  virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
151  { return WeakAggImplHelper_queryAgg( rType, cd::get(), this, static_cast<OWeakAggObject *>(this) ); }
152  virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
154  virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
156  virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
157  { return WeakAggImplHelper_getTypes( cd::get() ); }
158  virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
159  { return ImplHelper_getImplementationId( cd::get() ); }
160  };
177  template< class BaseClass, class Ifc1, class Ifc2 >
178  class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE ImplInheritanceHelper2
179  : public BaseClass
180  , public Ifc1, public Ifc2
181  {
182  struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, ImplInheritanceHelper2<BaseClass, Ifc1, Ifc2> > > {};
183  protected:
184  template< typename T1 >
185  explicit ImplInheritanceHelper2(T1 const & arg1): BaseClass(arg1) {}
186  template< typename T1, typename T2 >
187  ImplInheritanceHelper2(T1 const & arg1, T2 const & arg2):
188  BaseClass(arg1, arg2) {}
189  template< typename T1, typename T2, typename T3 >
191  T1 const & arg1, T2 const & arg2, T3 const & arg3):
192  BaseClass(arg1, arg2, arg3) {}
193  template< typename T1, typename T2, typename T3, typename T4 >
195  T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4):
196  BaseClass(arg1, arg2, arg3, arg4) {}
197  template<
198  typename T1, typename T2, typename T3, typename T4, typename T5 >
200  T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
201  T5 const & arg5):
202  BaseClass(arg1, arg2, arg3, arg4, arg5) {}
203  template<
204  typename T1, typename T2, typename T3, typename T4, typename T5,
205  typename T6 >
207  T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
208  T5 const & arg5, T6 const & arg6):
209  BaseClass(arg1, arg2, arg3, arg4, arg5, arg6) {}
210  public:
212  virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
213  {
214  css::uno::Any aRet( ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
215  if (aRet.hasValue())
216  return aRet;
217  return BaseClass::queryInterface( rType );
218  }
219  virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
220  { BaseClass::acquire(); }
221  virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
222  { BaseClass::release(); }
223  virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
224  { return ImplInhHelper_getTypes( cd::get(), BaseClass::getTypes() ); }
225  virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
226  { return ImplHelper_getImplementationId( cd::get() ); }
227  };
245  template< class BaseClass, class Ifc1, class Ifc2 >
246  class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE AggImplInheritanceHelper2
247  : public BaseClass
248  , public Ifc1, public Ifc2
249  {
250  struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, AggImplInheritanceHelper2<BaseClass, Ifc1, Ifc2> > > {};
251  protected:
252  template< typename T1 >
253  explicit AggImplInheritanceHelper2(T1 const & arg1): BaseClass(arg1) {}
254  template< typename T1, typename T2 >
255  AggImplInheritanceHelper2(T1 const & arg1, T2 const & arg2):
256  BaseClass(arg1, arg2) {}
257  template< typename T1, typename T2, typename T3 >
259  T1 const & arg1, T2 const & arg2, T3 const & arg3):
260  BaseClass(arg1, arg2, arg3) {}
261  template< typename T1, typename T2, typename T3, typename T4 >
263  T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4):
264  BaseClass(arg1, arg2, arg3, arg4) {}
265  template<
266  typename T1, typename T2, typename T3, typename T4, typename T5 >
268  T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
269  T5 const & arg5):
270  BaseClass(arg1, arg2, arg3, arg4, arg5) {}
271  template<
272  typename T1, typename T2, typename T3, typename T4, typename T5,
273  typename T6 >
275  T1 const & arg1, T2 const & arg2, T3 const & arg3, T4 const & arg4,
276  T5 const & arg5, T6 const & arg6):
277  BaseClass(arg1, arg2, arg3, arg4, arg5, arg6) {}
278  public:
280  virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE
281  { return BaseClass::queryInterface( rType ); }
282  virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE
283  {
284  css::uno::Any aRet( ImplHelper_queryNoXInterface( rType, cd::get(), this ) );
285  if (aRet.hasValue())
286  return aRet;
287  return BaseClass::queryAggregation( rType );
288  }
289  virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE
290  { BaseClass::acquire(); }
291  virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE
292  { BaseClass::release(); }
293  virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE
294  { return ImplInhHelper_getTypes( cd::get(), BaseClass::getTypes() ); }
295  virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE
296  { return ImplHelper_getImplementationId( cd::get() ); }
297  };
298 }
299 
300 #endif
301 
302 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual css::uno::Sequence< css::uno::Type > getTypes() SAL_OVERRIDE
Definition: implbase2.hxx:293
virtual void acquire() SAL_NOEXCEPT SAL_OVERRIDE
increasing m_refCount
css::uno::Any queryInterface(const css::uno::Type &rType, Interface1 *p1)
Compares demanded type to given template argument types.
Definition: queryinterface.hxx:43
#define SAL_OVERRIDE
C++11 "override" feature.
Definition: types.h:391
AggImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3)
Definition: implbase2.hxx:258
virtual css::uno::Sequence< sal_Int8 > getImplementationId() SAL_OVERRIDE
Definition: implbase2.hxx:158
#define SAL_NO_VTABLE
Use this for pure virtual classes, e.g.
Definition: types.h:294
virtual css::uno::Sequence< css::uno::Type > getTypes() SAL_OVERRIDE
Definition: implbase2.hxx:122
~ImplHelper2() SAL_NOEXCEPT
Definition: implbase2.hxx:98
AggImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4, T5 const &arg5, T6 const &arg6)
Definition: implbase2.hxx:274
signed char sal_Int8
Definition: types.h:43
ImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4, T5 const &arg5, T6 const &arg6)
Definition: implbase2.hxx:206
virtual css::uno::Any queryInterface(css::uno::Type const &rType) SAL_OVERRIDE
Definition: implbase2.hxx:212
virtual css::uno::Any queryInterface(css::uno::Type const &rType) SAL_OVERRIDE
Definition: implbase2.hxx:88
virtual css::uno::Any queryInterface(const css::uno::Type &rType) SAL_OVERRIDE
If a delegator is set, then the delegator is queried for the demanded interface.
virtual void release() SAL_NOEXCEPT SAL_OVERRIDE
If a delegator is set, then the delegators gets released.
AggImplInheritanceHelper2(T1 const &arg1, T2 const &arg2)
Definition: implbase2.hxx:255
virtual void release() SAL_NOEXCEPT SAL_OVERRIDE
Definition: implbase2.hxx:291
ImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4, T5 const &arg5)
Definition: implbase2.hxx:199
Implementation helper implementing interface css::lang::XTypeProvider and queryInterface(), but no reference counting.
Definition: implbase2.hxx:74
ImplInheritanceHelper2(T1 const &arg1)
Definition: implbase2.hxx:185
ImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4)
Definition: implbase2.hxx:194
#define SAL_WARN_UNUSED
Annotate classes where a compiler should warn if an instance is unused.
Definition: types.h:587
virtual void release() SAL_NOEXCEPT SAL_OVERRIDE
decreasing m_refCount
Implementation helper implementing interfaces css::lang::XTypeProvider and css::uno::XInterface inher...
Definition: implbase2.hxx:246
Base class to implement a UNO object supporting weak references, i.e.
Definition: weakagg.hxx:45
Helper class for a late-initialized static aggregate, e.g.
Definition: instance.hxx:548
virtual css::uno::Any queryAggregation(css::uno::Type const &rType) SAL_OVERRIDE
Called by the delegator or queryInterface.
Definition: implbase2.hxx:150
unsigned char sal_Bool
Definition: types.h:38
virtual css::uno::Sequence< sal_Int8 > getImplementationId() SAL_OVERRIDE
Definition: implbase2.hxx:92
Implementation helper implementing interfaces css::lang::XTypeProvider and css::uno::XInterface which...
Definition: implbase2.hxx:109
virtual css::uno::Any queryInterface(css::uno::Type const &rType) SAL_OVERRIDE
Basic queryInterface() implementation supporting com::sun::star::uno::XWeak and com::sun::star::uno::...
Definition: implbase2.hxx:116
virtual void acquire() SAL_NOEXCEPT SAL_OVERRIDE
Definition: implbase2.hxx:289
#define SAL_NOEXCEPT
Macro for C++11 "noexcept" vs.
Definition: types.h:416
ImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3)
Definition: implbase2.hxx:190
Definition: Enterable.hxx:30
virtual css::uno::Any queryAggregation(css::uno::Type const &rType) SAL_OVERRIDE
Definition: implbase2.hxx:282
virtual css::uno::Sequence< sal_Int8 > getImplementationId() SAL_OVERRIDE
Definition: implbase2.hxx:124
Implementation helper implementing interfaces css::lang::XTypeProvider and css::uno::XInterface which...
Definition: implbase2.hxx:141
virtual void acquire() SAL_NOEXCEPT SAL_OVERRIDE
If a delegator is set, then the delegators gets acquired.
virtual void acquire() SAL_NOEXCEPT SAL_OVERRIDE
Definition: implbase2.hxx:219
Base class to implement a UNO object supporting weak references, i.e.
Definition: weak.hxx:47
ImplInheritanceHelper2()
Definition: implbase2.hxx:211
AggImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4, T5 const &arg5)
Definition: implbase2.hxx:267
virtual css::uno::Any queryInterface(css::uno::Type const &rType) SAL_OVERRIDE
If a delegator is set, then the delegator is queried for the demanded interface.
Definition: implbase2.hxx:148
virtual css::uno::Sequence< css::uno::Type > getTypes() SAL_OVERRIDE
Definition: implbase2.hxx:90
ImplInheritanceHelper2(T1 const &arg1, T2 const &arg2)
Definition: implbase2.hxx:187
virtual void release() SAL_NOEXCEPT SAL_OVERRIDE
Definition: implbase2.hxx:221
AggImplInheritanceHelper2()
Definition: implbase2.hxx:279
virtual void acquire() SAL_NOEXCEPT SAL_OVERRIDE
increasing m_refCount
Definition: implbase2.hxx:118
Implementation helper implementing interfaces css::lang::XTypeProvider and css::uno::XInterface inher...
Definition: implbase2.hxx:178
virtual void release() SAL_NOEXCEPT SAL_OVERRIDE
decreasing m_refCount
Definition: implbase2.hxx:120
virtual css::uno::Sequence< css::uno::Type > getTypes() SAL_OVERRIDE
Definition: implbase2.hxx:223
virtual css::uno::Sequence< css::uno::Type > getTypes() SAL_OVERRIDE
Definition: implbase2.hxx:156
virtual css::uno::Sequence< sal_Int8 > getImplementationId() SAL_OVERRIDE
Definition: implbase2.hxx:295
virtual css::uno::Any queryInterface(css::uno::Type const &rType) SAL_OVERRIDE
Definition: implbase2.hxx:280
virtual void acquire() SAL_NOEXCEPT SAL_OVERRIDE
If a delegator is set, then the delegators gets acquired.
Definition: implbase2.hxx:152
AggImplInheritanceHelper2(T1 const &arg1)
Definition: implbase2.hxx:253
virtual css::uno::Sequence< sal_Int8 > getImplementationId() SAL_OVERRIDE
Definition: implbase2.hxx:225
virtual void release() SAL_NOEXCEPT SAL_OVERRIDE
If a delegator is set, then the delegators gets released.
Definition: implbase2.hxx:154
AggImplInheritanceHelper2(T1 const &arg1, T2 const &arg2, T3 const &arg3, T4 const &arg4)
Definition: implbase2.hxx:262