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
|
/* -*- 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.
*
************************************************************************/
#ifndef _EXTENSIONS_COMPONENT_MODULE_HXX_
#define _EXTENSIONS_COMPONENT_MODULE_HXX_
/** you may find this file helpfull if you implement a component (in it's own library) which can't use
the usual infrastructure.<br/>
More precise, you find helper classes to ease the use of resources and the registration of services.
<p>
You need to define a preprocessor variable COMPMOD_NAMESPACE in order to use this file. Set it to a string
which should be used as namespace for the classes defined herein.</p>
*/
#include <osl/mutex.hxx>
#include <tools/resid.hxx>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/registry/XRegistryKey.hpp>
#include <cppuhelper/factory.hxx>
#include <rtl/string.hxx>
class ResMgr;
//.........................................................................
namespace COMPMOD_NAMESPACE
{
//.........................................................................
typedef ::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > (SAL_CALL *FactoryInstantiation)
(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rServiceManager,
const ::rtl::OUString & _rComponentName,
::cppu::ComponentInstantiation _pCreateFunction,
const ::com::sun::star::uno::Sequence< ::rtl::OUString > & _rServiceNames,
rtl_ModuleCount* _pModuleCounter
);
//=========================================================================
//= OModule
//=========================================================================
class OModuleImpl;
class OModule
{
friend class OModuleResourceClient;
private:
OModule();
// not implemented. OModule is a static class
protected:
// resource administration
static ::osl::Mutex s_aMutex; /// access safety
static sal_Int32 s_nClients; /// number of registered clients
static OModuleImpl* s_pImpl; /// impl class. lives as long as at least one client for the module is registered
static ::rtl::OString s_sResPrefix;
// auto registration administration
static ::com::sun::star::uno::Sequence< ::rtl::OUString >*
s_pImplementationNames;
static ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::rtl::OUString > >*
s_pSupportedServices;
static ::com::sun::star::uno::Sequence< sal_Int64 >*
s_pCreationFunctionPointers;
static ::com::sun::star::uno::Sequence< sal_Int64 >*
s_pFactoryFunctionPointers;
public:
// cna be set as long as no resource has been accessed ...
static void setResourceFilePrefix(const ::rtl::OString& _rPrefix);
/// get the vcl res manager of the module
static ResMgr* getResManager();
/** 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
@see revokeComponent
*/
static void registerComponent(
const ::rtl::OUString& _rImplementationName,
const ::com::sun::star::uno::Sequence< ::rtl::OUString >& _rServiceNames,
::cppu::ComponentInstantiation _pCreateFunction,
FactoryInstantiation _pFactoryFunction);
/** revoke the registration for the specified component
@param _rImplementationName
the implementation name of the component
*/
static void revokeComponent(
const ::rtl::OUString& _rImplementationName);
/** write the registration information of all known components
<p>writes the registration information of all components which are currently registered into the
specified registry.<p/>
<p>Usually used from within component_writeInfo.<p/>
@param _rxServiceManager
the service manager
@param _rRootKey
the registry key under which the information will be stored
@return
sal_True if the registration of all implementations was successfull, sal_False otherwise
*/
static sal_Bool writeComponentInfos(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxServiceManager,
const ::com::sun::star::uno::Reference< ::com::sun::star::registry::XRegistryKey >& _rRootKey);
/** creates a Factory for the component with the given implementation name.
<p>Usually used from within component_getFactory.<p/>
@param _rxServiceManager
a pointer to an XMultiServiceFactory interface as got in component_getFactory
@param _pImplementationName
the implementation name of the component
@return
the XInterface access to a factory for the component
*/
static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getComponentFactory(
const ::rtl::OUString& _rImplementationName,
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxServiceManager
);
protected:
/// register a client for the module
static void registerClient();
/// revoke a client for the module
static void revokeClient();
private:
/** ensure that the impl class exists
@precond m_aMutex is guarded when this method gets called
*/
static void ensureImpl();
};
//=========================================================================
//= OModuleResourceClient
//=========================================================================
/** base class for objects which uses any global module-specific ressources
*/
class OModuleResourceClient
{
public:
OModuleResourceClient() { OModule::registerClient(); }
~OModuleResourceClient() { OModule::revokeClient(); }
};
//=========================================================================
//= ModuleRes
//=========================================================================
/** specialized ResId, using the ressource manager provided by the global module
*/
class ModuleRes : public ::ResId
{
public:
ModuleRes(USHORT _nId) : ResId(_nId, *OModule::getResManager()) { }
};
//==========================================================================
//= OMultiInstanceAutoRegistration
//==========================================================================
template <class TYPE>
class OMultiInstanceAutoRegistration
{
public:
/** automatically registeres a multi instance component
<p>Assumed that the template argument has the three methods
<ul>
<li><code>static ::rtl::OUString getImplementationName_Static()</code><li/>
<li><code>static ::com::sun::star::uno::Sequence< ::rtl::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 <method>OModule::registerComponent</method>.
<p/>
The factory creation function used is <code>::cppu::createSingleFactory</code>.
@see OOneInstanceAutoRegistration
*/
OMultiInstanceAutoRegistration();
~OMultiInstanceAutoRegistration();
};
template <class TYPE>
OMultiInstanceAutoRegistration<TYPE>::OMultiInstanceAutoRegistration()
{
OModule::registerComponent(
TYPE::getImplementationName_Static(),
TYPE::getSupportedServiceNames_Static(),
TYPE::Create,
::cppu::createSingleFactory
);
}
template <class TYPE>
OMultiInstanceAutoRegistration<TYPE>::~OMultiInstanceAutoRegistration()
{
OModule::revokeComponent(TYPE::getImplementationName_Static());
}
//==========================================================================
//= OOneInstanceAutoRegistration
//==========================================================================
template <class TYPE>
class OOneInstanceAutoRegistration
{
public:
/** automatically registeres a single instance component
<p>Assumed that the template argument has the three methods
<ul>
<li><code>static ::rtl::OUString getImplementationName_Static()</code><li/>
<li><code>static ::com::sun::star::uno::Sequence< ::rtl::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 <method>OModule::registerComponent</method>.
<p/>
The factory creation function used is <code>::cppu::createOneInstanceFactory</code>.
@see OOneInstanceAutoRegistration
*/
OOneInstanceAutoRegistration();
~OOneInstanceAutoRegistration();
};
template <class TYPE>
OOneInstanceAutoRegistration<TYPE>::OOneInstanceAutoRegistration()
{
OModule::registerComponent(
TYPE::getImplementationName_Static(),
TYPE::getSupportedServiceNames_Static(),
TYPE::Create,
::cppu::createOneInstanceFactory
);
}
template <class TYPE>
OOneInstanceAutoRegistration<TYPE>::~OOneInstanceAutoRegistration()
{
OModule::revokeComponent(TYPE::getImplementationName_Static());
}
//.........................................................................
} // namespace COMPMOD_NAMESPACE
//.........................................................................
#endif // _EXTENSIONS_COMPONENT_MODULE_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
