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
|
/* -*- 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 __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
#define __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
#include <general.h>
#include <com/sun/star/uno/Exception.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/uno/Type.hxx>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <cppuhelper/factory.hxx>
#include <comphelper/sequence.hxx>
#include <rtl/ustring.hxx>
#include <rtl/logfile.hxx>
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
namespace framework{
/*_________________________________________________________________________________________________________________
macros for declaration and definition of XServiceInfo
Please use follow public macros only!
1) DECLARE_XSERVICEINFO => use it to declare XServiceInfo in your header
2) DEFINE_XSERVICEINFO_MULTISERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) => use it to define XServiceInfo for multi service mode
3) DEFINE_XSERVICEINFO_ONEINSTANCESERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) => use it to define XServiceInfo for one instance service mode
4) DEFINE_INIT_SERVICE( CLASS ) => use it to implement your own impl_initService() method, which is neccessary for initializeing object by using his own reference!
_________________________________________________________________________________________________________________*/
//*****************************************************************************************************************
// private
// implementation of XServiceInfo and helper functions
//*****************************************************************************************************************
#define PRIVATE_DEFINE_XSERVICEINFO_BASE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
/*===========================================================================================================*/ \
/* XServiceInfo */ \
/*===========================================================================================================*/ \
::rtl::OUString SAL_CALL CLASS::getImplementationName() throw( css::uno::RuntimeException ) \
{ \
return impl_getStaticImplementationName(); \
} \
\
/*===========================================================================================================*/ \
/* XServiceInfo */ \
/*===========================================================================================================*/ \
sal_Bool SAL_CALL CLASS::supportsService( const ::rtl::OUString& sServiceName ) throw( css::uno::RuntimeException ) \
{ \
return ::comphelper::findValue(getSupportedServiceNames(), sServiceName, sal_True).getLength() != 0; \
} \
\
/*===========================================================================================================*/ \
/* XServiceInfo */ \
/*===========================================================================================================*/ \
css::uno::Sequence< ::rtl::OUString > SAL_CALL CLASS::getSupportedServiceNames() throw( css::uno::RuntimeException ) \
{ \
return impl_getStaticSupportedServiceNames(); \
} \
\
/*===========================================================================================================*/ \
/* Helper for XServiceInfo */ \
/*===========================================================================================================*/ \
css::uno::Sequence< ::rtl::OUString > CLASS::impl_getStaticSupportedServiceNames() \
{ \
css::uno::Sequence< ::rtl::OUString > seqServiceNames( 1 ); \
seqServiceNames.getArray() [0] = SERVICENAME ; \
return seqServiceNames; \
} \
\
/*===========================================================================================================*/ \
/* Helper for XServiceInfo */ \
/*===========================================================================================================*/ \
::rtl::OUString CLASS::impl_getStaticImplementationName() \
{ \
return IMPLEMENTATIONNAME ; \
}
#define PRIVATE_DEFINE_XSERVICEINFO_OLDSTYLE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_XSERVICEINFO_BASE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
/*===========================================================================================================*/ \
/* Helper for registry */ \
/* Attention: To avoid against wrong ref counts during our own initialize procedure, we must */ \
/* use right EXTERNAL handling of them. That's why you should do nothing in your ctor, which could*/ \
/* work on your ref count! All other things are allowed. Do work with your own reference - please */ \
/* use "impl_initService()" method. */ \
/*===========================================================================================================*/ \
css::uno::Reference< css::uno::XInterface > SAL_CALL CLASS::impl_createInstance( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) throw( css::uno::Exception ) \
{ \
RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework","Ocke.Janssen@sun.com",U2B(IMPLEMENTATIONNAME).getStr()); \
/* create new instance of service */ \
CLASS* pClass = new CLASS( xServiceManager ); \
/* hold it alive by increasing his ref count!!! */ \
css::uno::Reference< css::uno::XInterface > xService( static_cast< XINTERFACECAST* >(pClass), css::uno::UNO_QUERY ); \
/* initialize new service instance ... he can use his own refcount ... we hold it! */ \
pClass->impl_initService(); \
/* return new created service as reference */ \
return xService; \
}
#define PRIVATE_DEFINE_XSERVICEINFO_NEWSTYLE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_XSERVICEINFO_BASE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
/*===========================================================================================================*/ \
/* Helper for registry */ \
/* Attention: To avoid against wrong ref counts during our own initialize procedure, we must */ \
/* use right EXTERNAL handling of them. That's why you should do nothing in your ctor, which could*/ \
/* work on your ref count! All other things are allowed. Do work with your own reference - please */ \
/* use "impl_initService()" method. */ \
/*===========================================================================================================*/ \
css::uno::Reference< css::uno::XInterface > SAL_CALL CLASS::impl_createInstance( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager )\
throw( css::uno::Exception ) \
{ \
/* retrieve component context from the given service manager */ \
static const ::rtl::OUString PROP_DEFAULTCONTEXT("DefaultContext"); \
css::uno::Reference< css::beans::XPropertySet > xSMGRProps(xServiceManager, css::uno::UNO_QUERY_THROW); \
css::uno::Reference< css::uno::XComponentContext > xComponentContext; \
xSMGRProps->getPropertyValue( PROP_DEFAULTCONTEXT ) >>= xComponentContext; \
/* create new instance of service */ \
CLASS* pClass = new CLASS( xComponentContext ); \
/* hold it alive by increasing his ref count!!! */ \
css::uno::Reference< css::uno::XInterface > xService( static_cast< XINTERFACECAST* >(pClass), css::uno::UNO_QUERY ); \
/* initialize new service instance ... he can use his own refcount ... we hold it! */ \
pClass->impl_initService(); \
/* return new created service as reference */ \
return xService; \
}
//*****************************************************************************************************************
// private
// definition of helper function createFactory() for multiple services
//*****************************************************************************************************************
#define PRIVATE_DEFINE_SINGLEFACTORY( CLASS ) \
css::uno::Reference< css::lang::XSingleServiceFactory > CLASS::impl_createFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) \
{ \
css::uno::Reference< css::lang::XSingleServiceFactory > xReturn ( cppu::createSingleFactory ( xServiceManager , \
CLASS::impl_getStaticImplementationName() , \
CLASS::impl_createInstance , \
CLASS::impl_getStaticSupportedServiceNames() \
) \
); \
return xReturn; \
}
//*****************************************************************************************************************
// private
// definition of helper function createFactory() for one instance services
//*****************************************************************************************************************
#define PRIVATE_DEFINE_ONEINSTANCEFACTORY( CLASS ) \
css::uno::Reference< css::lang::XSingleServiceFactory > CLASS::impl_createFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) \
{ \
css::uno::Reference< css::lang::XSingleServiceFactory > xReturn ( cppu::createOneInstanceFactory ( xServiceManager , \
CLASS::impl_getStaticImplementationName() , \
CLASS::impl_createInstance , \
CLASS::impl_getStaticSupportedServiceNames() \
) \
); \
return xReturn; \
}
//*****************************************************************************************************************
// public
// declaration of XServiceInfo and helper functions
//*****************************************************************************************************************
#define DECLARE_XSERVICEINFO_NOFACTORY \
/* interface XServiceInfo */ \
virtual ::rtl::OUString SAL_CALL getImplementationName ( ) throw( css::uno::RuntimeException ); \
virtual sal_Bool SAL_CALL supportsService ( const ::rtl::OUString& sServiceName ) throw( css::uno::RuntimeException ); \
virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames ( ) throw( css::uno::RuntimeException ); \
/* Helper for XServiceInfo */ \
static css::uno::Sequence< ::rtl::OUString > SAL_CALL impl_getStaticSupportedServiceNames( ); \
static ::rtl::OUString SAL_CALL impl_getStaticImplementationName ( ); \
/* Helper for initialization of service by using own reference! */ \
virtual void SAL_CALL impl_initService ( ); \
#define DECLARE_XSERVICEINFO \
DECLARE_XSERVICEINFO_NOFACTORY \
/* Helper for registry */ \
static css::uno::Reference< css::uno::XInterface > SAL_CALL impl_createInstance ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ) throw( css::uno::Exception ); \
static css::uno::Reference< css::lang::XSingleServiceFactory > SAL_CALL impl_createFactory ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xServiceManager ); \
//*****************************************************************************************************************
// public
// implementation of XServiceInfo
//*****************************************************************************************************************
#define DEFINE_XSERVICEINFO_MULTISERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_XSERVICEINFO_OLDSTYLE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_SINGLEFACTORY( CLASS )
#define DEFINE_XSERVICEINFO_ONEINSTANCESERVICE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_XSERVICEINFO_OLDSTYLE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_ONEINSTANCEFACTORY( CLASS )
#define DEFINE_XSERVICEINFO_MULTISERVICE_2( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_XSERVICEINFO_NEWSTYLE( CLASS, XINTERFACECAST, SERVICENAME, IMPLEMENTATIONNAME ) \
PRIVATE_DEFINE_SINGLEFACTORY( CLASS )
//*****************************************************************************************************************
// public
// implementation of service initialize!
// example of using: DEFINE_INIT_SERVICE( MyClassName,
// {
// ...
// Reference< XInterface > xThis( this, UNO_QUERY );
// myMember* pMember = new myMember( xThis );
// ...
// }
// )
//*****************************************************************************************************************
#define DEFINE_INIT_SERVICE( CLASS, FUNCTIONBODY ) \
void SAL_CALL CLASS::impl_initService() \
{ \
FUNCTIONBODY \
}
} // namespace framework
#endif // #ifndef __FRAMEWORK_MACROS_XSERVICEINFO_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|