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
|
/* -*- 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_EXTENSIONS_SOURCE_INC_COMPONENTMODULE_HXX
#define INCLUDED_EXTENSIONS_SOURCE_INC_COMPONENTMODULE_HXX
/** you may find this file helpful if you implement a component (in its 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.
*/
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <cppuhelper/factory.hxx>
#include <vector>
namespace compmodule
{
typedef css::uno::Reference< css::lang::XSingleServiceFactory > (*FactoryInstantiation)
(
const css::uno::Reference< css::lang::XMultiServiceFactory >& _rServiceManager,
const OUString & _rComponentName,
::cppu::ComponentInstantiation _pCreateFunction,
const css::uno::Sequence< OUString > & _rServiceNames,
rtl_ModuleCount*
);
class OModule
{
private:
OModule() = delete; //TODO: get rid of this class
protected:
// auto registration administration
static std::vector< OUString >*
s_pImplementationNames;
static std::vector< css::uno::Sequence< OUString > >*
s_pSupportedServices;
static std::vector< cppu::ComponentInstantiation >*
s_pCreationFunctionPointers;
static std::vector< FactoryInstantiation >*
s_pFactoryFunctionPointers;
public:
/** 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 OUString& _rImplementationName,
const css::uno::Sequence< 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 OUString& _rImplementationName);
/** 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 css::uno::Reference< css::uno::XInterface > getComponentFactory(
const OUString& _rImplementationName,
const css::uno::Reference< css::lang::XMultiServiceFactory >& _rxServiceManager
);
};
// specialized ResId, using the resource locale provided by the global module
OUString ModuleRes(const char* pId);
template <class TYPE>
class OMultiInstanceAutoRegistration
{
public:
/** automatically registers a multi instance component
<p>Assumed that the template argument has the three methods
<ul>
<li><code>static OUString getImplementationName_Static()</code><li/>
<li><code>static css::uno::Sequence< OUString > getSupportedServiceNames_Static()</code><li/>
<li><code>static css::uno::Reference< css::uno::XInterface >
Create(const css::uno::Reference< css::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>.
*/
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());
}
} // namespace compmodule
#endif // INCLUDED_EXTENSIONS_SOURCE_INC_COMPONENTMODULE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
