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
|
/* -*- 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_COMPONENTMODULE_HXX
#define INCLUDED_COMPHELPER_COMPONENTMODULE_HXX
#include <comphelper/comphelperdllapi.h>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <cppuhelper/factory.hxx>
#include <osl/mutex.hxx>
#include <rtl/string.hxx>
#include <rtl/instance.hxx>
namespace comphelper
{
/** factory factory declaration
*/
typedef ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleComponentFactory > (SAL_CALL *FactoryInstantiation)
(
::cppu::ComponentFactoryFunc _pFactoryFunc,
OUString const& _rComponentName,
::com::sun::star::uno::Sequence< OUString > const & _rServiceNames,
rtl_ModuleCount*
);
//= ComponentDescription
struct COMPHELPER_DLLPUBLIC ComponentDescription
{
/// the implementation name of the component
OUString sImplementationName;
/// the services supported by the component implementation
::com::sun::star::uno::Sequence< OUString > aSupportedServices;
/** the name under which the component implementation should be registered as singleton,
or empty if the component does not implement a singleton.
*/
OUString sSingletonName;
/// the function to create an instance of the component
::cppu::ComponentFactoryFunc pComponentCreationFunc;
/// the function to create a factory for the component (usually <code>::cppu::createSingleComponentFactory</code>)
FactoryInstantiation pFactoryCreationFunc;
ComponentDescription()
:sImplementationName()
,aSupportedServices()
,sSingletonName()
,pComponentCreationFunc( NULL )
,pFactoryCreationFunc( NULL )
{
}
ComponentDescription(
const OUString& _rImplementationName,
const ::com::sun::star::uno::Sequence< OUString >& _rSupportedServices,
const OUString& _rSingletonName,
::cppu::ComponentFactoryFunc _pComponentCreationFunc,
FactoryInstantiation _pFactoryCreationFunc
)
:sImplementationName( _rImplementationName )
,aSupportedServices( _rSupportedServices )
,sSingletonName( _rSingletonName )
,pComponentCreationFunc( _pComponentCreationFunc )
,pFactoryCreationFunc( _pFactoryCreationFunc )
{
}
};
//= OModule
class OModuleImpl;
class COMPHELPER_DLLPUBLIC OModule
{
private:
oslInterlockedCount m_nClients; /// number of registered clients
OModuleImpl* m_pImpl; /// impl class. lives as long as at least one client for the module is registered
protected:
mutable ::osl::Mutex m_aMutex; /// access safety
public:
OModule();
virtual ~OModule();
/** register a component implementing a service with the given data.
@param _rImplementationName
the implementation name of the component
@param _rServiceNames
the services the component supports
@param _pCreateFunction
a function for creating an instance of the component
@param _pFactoryFunction
a function for creating a factory for that component
*/
void registerImplementation(
const OUString& _rImplementationName,
const ::com::sun::star::uno::Sequence< OUString >& _rServiceNames,
::cppu::ComponentFactoryFunc _pCreateFunction,
FactoryInstantiation _pFactoryFunction = ::cppu::createSingleComponentFactory );
/** registers a component given by ComponentDescription
*/
void registerImplementation( const ComponentDescription& _rComp );
/** creates a Factory for the component with the given implementation name.
<p>Usually used from within component_getFactory.<p/>
@param _pImplementationName
the implementation name of the component
@return
the XInterface access to a factory for the component
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getComponentFactory(
const OUString& _rImplementationName );
/** version of getComponentFactory which directly takes the char argument you got in your component_getFactory call
*/
void* getComponentFactory( const sal_Char* _pImplementationName );
public:
class ClientAccess { friend class OModuleClient; private: ClientAccess() { } };
/// register a client for the module
void registerClient( ClientAccess );
/// revoke a client for the module
void revokeClient( ClientAccess );
protected:
/** called when the first client has been registered
@precond
<member>m_aMutex</member> is locked
*/
virtual void onFirstClient();
/** called when the last client has been revoked
@precond
<member>m_aMutex</member> is locked
*/
virtual void onLastClient();
private:
OModule( const OModule& ); // never implemented
OModule& operator=( const OModule& ); // never implemented
};
//= OModuleClient
/** base class for objects which uses any global module-specific resources
*/
class COMPHELPER_DLLPUBLIC OModuleClient
{
protected:
OModule& m_rModule;
public:
OModuleClient( OModule& _rModule ) :m_rModule( _rModule ) { m_rModule.registerClient( OModule::ClientAccess() ); }
~OModuleClient() { m_rModule.revokeClient( OModule::ClientAccess() ); }
};
//= OAutoRegistration
template <class TYPE>
class OAutoRegistration
{
public:
/** automatically provides all component information to an OModule instance
<p>Assumed that the template argument has the three methods
<ul>
<li><code>static OUString getImplementationName_static()</code><li/>
<li><code>static ::com::sun::star::uno::Sequence< OUString > getSupportedServiceNames_static()</code><li/>
<li><code>static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&)</code>
</li>
<ul/>
the instantiation of this object will automatically register the class via <member>OModule::registerImplementation</member>.
<p/>
The factory creation function used is <code>::cppu::createSingleComponentFactory</code>.
*/
OAutoRegistration( OModule& _rModule );
};
template <class TYPE>
OAutoRegistration<TYPE>::OAutoRegistration( OModule& _rModule )
{
_rModule.registerImplementation(
TYPE::getImplementationName_static(),
TYPE::getSupportedServiceNames_static(),
TYPE::Create
);
}
//= OSingletonRegistration
template <class TYPE>
class OSingletonRegistration
{
public:
/** automatically provides all component information to an OModule instance,
for a singleton component
<p>Assumed that the template argument has the three methods
<ul>
<li><code>static OUString getImplementationName_static()</code><li/>
<li><code>static ::com::sun::star::uno::Sequence< OUString > getSupportedServiceNames_static()</code><li/>
<li><code>static OUString getSingletonName_static()</code></li>
<li><code>static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >&)</code>
</li>
<ul/>
the instantiation of this object will automatically register the class via <member>OModule::registerImplementation</member>.
</p>
*/
OSingletonRegistration( OModule& _rModule );
};
template <class TYPE>
OSingletonRegistration<TYPE>::OSingletonRegistration( OModule& _rModule )
{
_rModule.registerImplementation( ComponentDescription(
TYPE::getImplementationName_static(),
TYPE::getSupportedServiceNames_static(),
TYPE::getSingletonName_static(),
&TYPE::Create,
&::cppu::createSingleComponentFactory
) );
}
} // namespace comphelper
#endif // INCLUDED_COMPHELPER_COMPONENTMODULE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
