/src/libreoffice/include/cppuhelper/compbase2.hxx
Line | Count | Source |
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_COMPBASE2_HXX |
24 | | #define INCLUDED_CPPUHELPER_COMPBASE2_HXX |
25 | | |
26 | | #include "cppuhelper/implbase2.hxx" |
27 | | #include "cppuhelper/compbase_ex.hxx" |
28 | | |
29 | | namespace cppu |
30 | | { |
31 | | |
32 | | /** Implementation helper supporting css::lang::XTypeProvider and |
33 | | css::lang::XComponent. |
34 | | |
35 | | Upon disposing objects of this class, sub-classes receive a disposing() |
36 | | call. Objects of this class can be held weakly, i.e. by a |
37 | | css::uno::WeakReference. |
38 | | |
39 | | @attention |
40 | | The life-cycle of the passed mutex reference has to be longer than objects of this class. |
41 | | |
42 | | @derive |
43 | | Inherit from this class giving your interface(s) to be implemented as template argument(s). |
44 | | Your sub class defines method implementations for these interface(s). |
45 | | */ |
46 | | template< class Ifc1, class Ifc2 > |
47 | | class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakComponentImplHelper2 |
48 | | : public WeakComponentImplHelperBase |
49 | | , public css::lang::XTypeProvider |
50 | | , public Ifc1, public Ifc2 |
51 | | { |
52 | | struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, WeakComponentImplHelper2<Ifc1, Ifc2> > > {}; |
53 | | public: |
54 | | WeakComponentImplHelper2( ::osl::Mutex & rMutex ) SAL_NOEXCEPT |
55 | | : WeakComponentImplHelperBase( rMutex ) |
56 | | {} |
57 | | virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE |
58 | | { return WeakComponentImplHelper_query( rType, cd::get(), this, static_cast<WeakComponentImplHelperBase *>(this) ); } |
59 | | virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE |
60 | | { WeakComponentImplHelperBase::acquire(); } |
61 | | virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE |
62 | | { WeakComponentImplHelperBase::release(); } |
63 | | virtual void SAL_CALL dispose() SAL_OVERRIDE |
64 | | { WeakComponentImplHelperBase::dispose(); } |
65 | | virtual void SAL_CALL addEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) SAL_OVERRIDE |
66 | | { WeakComponentImplHelperBase::addEventListener(xListener); } |
67 | | virtual void SAL_CALL removeEventListener(const css::uno::Reference< css::lang::XEventListener > & xListener) SAL_OVERRIDE |
68 | | { WeakComponentImplHelperBase::removeEventListener(xListener); } |
69 | | virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE |
70 | | { return WeakComponentImplHelper_getTypes( cd::get() ); } |
71 | | virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE |
72 | | { return ImplHelper_getImplementationId( cd::get() ); } |
73 | | }; |
74 | | |
75 | | /** Same as WeakComponentImplHelper2, except doesn't implement |
76 | | addEventListener, removeEventListener and dispose. |
77 | | |
78 | | This requires derived classes to implement those three methods. |
79 | | This makes it possible to implement classes which are required to |
80 | | implement methods from multiple bases which have different |
81 | | addEventListener/removeEventListener signatures without triggering |
82 | | the g++ overloaded-virtual warning |
83 | | */ |
84 | | template< class Ifc1, class Ifc2 > |
85 | | class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE PartialWeakComponentImplHelper2 |
86 | | : public WeakComponentImplHelperBase |
87 | | , public css::lang::XTypeProvider |
88 | | , public Ifc1, public Ifc2 |
89 | | { |
90 | | struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, PartialWeakComponentImplHelper2<Ifc1, Ifc2> > > {}; |
91 | | public: |
92 | | PartialWeakComponentImplHelper2( ::osl::Mutex & rMutex ) SAL_NOEXCEPT |
93 | | : WeakComponentImplHelperBase( rMutex ) |
94 | | {} |
95 | | virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE |
96 | | { return WeakComponentImplHelper_query( rType, cd::get(), this, static_cast<WeakComponentImplHelperBase *>(this) ); } |
97 | | virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE |
98 | | { WeakComponentImplHelperBase::acquire(); } |
99 | | virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE |
100 | | { WeakComponentImplHelperBase::release(); } |
101 | | virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE |
102 | | { return WeakComponentImplHelper_getTypes( cd::get() ); } |
103 | | virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE |
104 | | { return ImplHelper_getImplementationId( cd::get() ); } |
105 | | }; |
106 | | |
107 | | |
108 | | /** Implementation helper supporting css::lang::XTypeProvider and |
109 | | css::lang::XComponent. |
110 | | |
111 | | Upon disposing objects of this class, sub-classes receive a disposing() |
112 | | call. Objects of this class can be held weakly, i.e. by a |
113 | | css::uno::WeakReference. Object of this class can be |
114 | | aggregated, i.e. incoming queryInterface() calls are delegated. |
115 | | |
116 | | @attention |
117 | | The life-cycle of the passed mutex reference has to be longer than objects of this class. |
118 | | |
119 | | @derive |
120 | | Inherit from this class giving your interface(s) to be implemented as template argument(s). |
121 | | Your sub class defines method implementations for these interface(s). |
122 | | |
123 | | @deprecated |
124 | | */ |
125 | | template< class Ifc1, class Ifc2 > |
126 | | class SAL_NO_VTABLE SAL_DLLPUBLIC_TEMPLATE WeakAggComponentImplHelper2 |
127 | | : public WeakAggComponentImplHelperBase |
128 | | , public css::lang::XTypeProvider |
129 | | , public Ifc1, public Ifc2 |
130 | | { |
131 | | struct cd : public rtl::StaticAggregate< class_data, ImplClassData2 < Ifc1, Ifc2, WeakAggComponentImplHelper2<Ifc1, Ifc2> > > {}; |
132 | | public: |
133 | | WeakAggComponentImplHelper2( ::osl::Mutex & rMutex ) SAL_NOEXCEPT |
134 | 0 | : WeakAggComponentImplHelperBase( rMutex ) |
135 | 0 | {} |
136 | | virtual css::uno::Any SAL_CALL queryInterface( css::uno::Type const & rType ) SAL_OVERRIDE |
137 | 0 | { return WeakAggComponentImplHelperBase::queryInterface( rType ); } |
138 | | virtual css::uno::Any SAL_CALL queryAggregation( css::uno::Type const & rType ) SAL_OVERRIDE |
139 | 0 | { return WeakAggComponentImplHelper_queryAgg( rType, cd::get(), this, static_cast<WeakAggComponentImplHelperBase *>(this) ); } |
140 | | virtual void SAL_CALL acquire() SAL_NOEXCEPT SAL_OVERRIDE |
141 | 0 | { WeakAggComponentImplHelperBase::acquire(); } |
142 | | virtual void SAL_CALL release() SAL_NOEXCEPT SAL_OVERRIDE |
143 | 0 | { WeakAggComponentImplHelperBase::release(); } |
144 | | virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() SAL_OVERRIDE |
145 | 0 | { return WeakAggComponentImplHelper_getTypes( cd::get() ); } |
146 | | virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() SAL_OVERRIDE |
147 | 0 | { return ImplHelper_getImplementationId( cd::get() ); } |
148 | | }; |
149 | | } |
150 | | |
151 | | #endif |
152 | | |
153 | | /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |