blob: f79d22edbe4f1c68e16a835fd2486ebe353e972b (
plain)
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: registration.hxx,v $
* $Revision: 1.5 $
*
* 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_REGISTRATION_HXX_
#define __FRAMEWORK_MACROS_REGISTRATION_HXX_
//_________________________________________________________________________________________________________________
// my own includes
//_________________________________________________________________________________________________________________
#include <macros/debug.hxx>
//_________________________________________________________________________________________________________________
// interface includes
//_________________________________________________________________________________________________________________
#include <com/sun/star/registry/XRegistryKey.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/registry/InvalidRegistryException.hpp>
//_________________________________________________________________________________________________________________
// other includes
//_________________________________________________________________________________________________________________
//_________________________________________________________________________________________________________________
// namespace
//_________________________________________________________________________________________________________________
//namespace framework{
/*_________________________________________________________________________________________________________________
macros for registration of services
Please use follow public macros only!
1) COMPONENTINFO( CLASS ) => use it as parameter for COMPONENT_WRITEINFO( INFOS )
2) IFFACTORY( CLASS ) => use it as parameter for COMPONENT_GETFACTORY( IFFACTORIES )
3) COMPONENTGETIMPLEMENTATIONENVIRONMENT => use it to define exported function component_getImplementationEnvironment()
4) COMPONENTWRITEINFO( INFOS ) => use it to define exported function component_writeInfo()
5) COMPONENTGETFACTORY( IFFACTORIES ) => use it to define exported function component_getFactory()
_________________________________________________________________________________________________________________*/
//*****************************************************************************************************************
// public
// use it as parameter for COMPONENT_WRITEINFO( INFOS )
//*****************************************************************************************************************
#define COMPONENTINFO( CLASS ) \
try \
{ \
/* Set default result of follow operations !!! */ \
bReturn = sal_False; \
/* Do the follow only, if given key is valid ! */ \
if ( xKey.is() == sal_True ) \
{ \
LOG_REGISTRATION_WRITEINFO( "\t\t\txKey is valid ...\n" ) \
/* Build new keyname */ \
sKeyName = DECLARE_ASCII( "/" ); \
sKeyName += CLASS::impl_getStaticImplementationName(); \
sKeyName += DECLARE_ASCII( "/UNO/SERVICES" ); \
LOG_REGISTRATION_WRITEINFO( "\t\t\tcreate key \"" ) \
LOG_REGISTRATION_WRITEINFO( U2B( sKeyName ) ) \
LOG_REGISTRATION_WRITEINFO( "\" ...\n" ) \
/* Create new key with new name. */ \
xNewKey = xKey->createKey( sKeyName ); \
/* If this new key valid ... */ \
if ( xNewKey.is() == sal_True ) \
{ \
LOG_REGISTRATION_WRITEINFO( "\t\t\t\ttsuccessful ...\n" ) \
/* Get information about supported services. */ \
seqServiceNames = CLASS::impl_getStaticSupportedServiceNames() ; \
pArray = seqServiceNames.getArray() ; \
nLength = seqServiceNames.getLength() ; \
nCounter = 0 ; \
/* Then set this information on this key. */ \
for ( nCounter = 0; nCounter < nLength; ++nCounter ) \
{ \
LOG_REGISTRATION_WRITEINFO( "\t\t\t\twrite key \"" ) \
LOG_REGISTRATION_WRITEINFO( U2B( pArray[nCounter] ) ) \
LOG_REGISTRATION_WRITEINFO( "\" to registry ...\n" ) \
xNewKey->createKey( pArray[nCounter] ); \
} \
/* Result of this operations = OK. */ \
bReturn = sal_True ; \
} \
} \
} \
catch( ::com::sun::star::registry::InvalidRegistryException& ) \
{ \
LOG_REGISTRATION_WRITEINFO( "\n\nERROR:\nInvalidRegistryException detected\n\n" ) \
bReturn = sal_False ; \
}
//*****************************************************************************************************************
// public
// use it as parameter for COMPONENT_GETFACTORY( IFFACTORIES )
//*****************************************************************************************************************
#define IFFACTORY( CLASS ) \
/* If searched name found ... */ \
/* You can't add some statements before follow line ... Here can be an ELSE-statement! */ \
if ( CLASS::impl_getStaticImplementationName().equals( ::rtl::OUString::createFromAscii( pImplementationName ) ) ) \
{ \
LOG_REGISTRATION_GETFACTORY( "\t\tImplementationname found - try to create factory! ...\n" ) \
/* ... then create right factory for this service. */ \
/* xFactory and xServiceManager are local variables of method which use this macro. */ \
xFactory = CLASS::impl_createFactory( xServiceManager ); \
}
//*****************************************************************************************************************
// public
// define helper to get information about service environment
//*****************************************************************************************************************
#define COMPONENTGETIMPLEMENTATIONENVIRONMENT \
extern "C" SAL_DLLPUBLIC_EXPORT void SAL_CALL component_getImplementationEnvironment( const sal_Char** ppEnvironmentTypeName , \
uno_Environment** ) \
{ \
*ppEnvironmentTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME ; \
}
//*****************************************************************************************************************
// public
// define registration of service
//*****************************************************************************************************************
#define COMPONENTWRITEINFO( INFOS ) \
extern "C" SAL_DLLPUBLIC_EXPORT sal_Bool SAL_CALL component_writeInfo( void* /*pServiceManager*/ , \
void* pRegistryKey ) \
{ \
LOG_REGISTRATION_WRITEINFO( "\t[start]\n" ) \
/* Set default return value for this operation - if it failed. */ \
sal_Bool bReturn = sal_False ; \
if ( pRegistryKey != NULL ) \
{ \
LOG_REGISTRATION_WRITEINFO( "\t\tpRegistryKey is valid ...\n" ) \
/* Define variables for following helper macros! */ \
/* bReturn will set automaticly. */ \
::com::sun::star::uno::Reference< ::com::sun::star::registry::XRegistryKey > xKey ; \
::com::sun::star::uno::Reference< ::com::sun::star::registry::XRegistryKey > xNewKey ; \
::com::sun::star::uno::Sequence< ::rtl::OUString > seqServiceNames ; \
const ::rtl::OUString* pArray ; \
sal_Int32 nLength ; \
sal_Int32 nCounter ; \
::rtl::OUString sKeyName ; \
xKey = reinterpret_cast< ::com::sun::star::registry::XRegistryKey* >( pRegistryKey ); \
/* This parameter will expand to */ \
/* "COMPONENT_INFO(a) */ \
/* ... */ \
/* COMPONENT_INFO(z)" */ \
INFOS \
} \
LOG_REGISTRATION_WRITEINFO( "\t[end]\n" ) \
/* Return with result of this operation. */ \
return bReturn ; \
}
//*****************************************************************************************************************
// public
// define method to instanciate new services
//*****************************************************************************************************************
#define COMPONENTGETFACTORY( IFFACTORIES ) \
extern "C" SAL_DLLPUBLIC_EXPORT void* SAL_CALL component_getFactory( const sal_Char* pImplementationName , \
void* pServiceManager , \
void* /*pRegistryKey*/ ) \
{ \
LOG_REGISTRATION_GETFACTORY( "\t[start]\n" ) \
/* Set default return value for this operation - if it failed. */ \
void* pReturn = NULL ; \
if ( \
( pImplementationName != NULL ) && \
( pServiceManager != NULL ) \
) \
{ \
LOG_REGISTRATION_GETFACTORY( "\t\tpImplementationName and pServiceManager are valid ...\n" ) \
/* Define variables which are used in following macros. */ \
::com::sun::star::uno::Reference< ::com::sun::star::lang::XSingleServiceFactory > xFactory ; \
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xServiceManager ; \
xServiceManager = reinterpret_cast< ::com::sun::star::lang::XMultiServiceFactory* >( pServiceManager ) ; \
/* These parameter will expand to */ \
/* "IF_NAME_CREATECOMPONENTFACTORY(a) */ \
/* else */ \
/* ... */ \
/* else */ \
/* IF_NAME_CREATECOMPONENTFACTORY(z)" */ \
IFFACTORIES \
/* Factory is valid, if service was found. */ \
if ( xFactory.is() == sal_True ) \
{ \
LOG_REGISTRATION_GETFACTORY( "\t\t\txFactory valid - service was found ...\n" ) \
xFactory->acquire(); \
pReturn = xFactory.get(); \
} \
} \
LOG_REGISTRATION_GETFACTORY( "\t[end]\n" ) \
/* Return with result of this operation. */ \
return pReturn ; \
}
//} // namespace framework
#endif // #ifndef __FRAMEWORK_MACROS_REGISTRATION_HXX_
|
