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
|
/* -*- 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 UNOTOOLS_INC_UNOTOOLS_COMPONENTRESMODULE_HXX
#define UNOTOOLS_INC_UNOTOOLS_COMPONENTRESMODULE_HXX
#include <comphelper/componentmodule.hxx>
#include <unotools/unotoolsdllapi.h>
/** === begin UNO includes === **/
/** === end UNO includes === **/
#include <tools/resid.hxx>
#include <memory>
class ResMgr;
//........................................................................
namespace utl
{
//........................................................................
class OComponentResModuleImpl;
//====================================================================
//= OComponentResourceModule
//====================================================================
/** extends the <type scope="comphelper">OModule</type> implementation with
simply resource access
*/
class UNOTOOLS_DLLPUBLIC OComponentResourceModule : public ::comphelper::OModule
{
private:
typedef ::comphelper::OModule BaseClass;
private:
::std::auto_ptr< OComponentResModuleImpl > m_pImpl;
public:
OComponentResourceModule( const ::rtl::OString& _rResFilePrefix );
~OComponentResourceModule();
/// get the vcl res manager of the module
ResMgr* getResManager();
protected:
// OModule overridables
virtual void onFirstClient();
virtual void onLastClient();
};
//=========================================================================
//= ModuleRes
//=========================================================================
/** specialized ResId, using the ressource manager provided by a given <type>OModule</type>
*/
class UNOTOOLS_DLLPUBLIC ModuleRes : public ::ResId
{
public:
ModuleRes( USHORT _nId, OComponentResourceModule& _rModule ) : ResId( _nId, *_rModule.getResManager() ) { }
};
//====================================================================
//= defining a concrete module
//====================================================================
#define DEFINE_MODULE( ModuleClass, ClientClass, ResClass ) \
/* -------------------------------------------------------------------- */ \
class ModuleClass : public ::utl::OComponentResourceModule \
{ \
friend struct CreateModuleClass; \
typedef ::utl::OComponentResourceModule BaseClass; \
\
public: \
static ModuleClass& getInstance(); \
\
private: \
ModuleClass(); \
}; \
\
/* -------------------------------------------------------------------- */ \
class ClientClass : public ::comphelper::OModuleClient \
{ \
private: \
typedef ::comphelper::OModuleClient BaseClass; \
\
public: \
ClientClass() : BaseClass( ModuleClass::getInstance() ) \
{ \
} \
}; \
\
/* -------------------------------------------------------------------- */ \
class ResClass : public ::utl::ModuleRes \
{ \
private: \
typedef ::utl::ModuleRes BaseClass; \
\
public: \
ResClass( USHORT _nId ) : BaseClass( _nId, ModuleClass::getInstance() ) \
{ \
} \
}; \
\
/* -------------------------------------------------------------------- */ \
template < class TYPE > \
class OAutoRegistration : public ::comphelper::OAutoRegistration< TYPE > \
{ \
private: \
typedef ::comphelper::OAutoRegistration< TYPE > BaseClass; \
\
public: \
OAutoRegistration() : BaseClass( ModuleClass::getInstance() ) \
{ \
} \
}; \
\
/* -------------------------------------------------------------------- */ \
template < class TYPE > \
class OSingletonRegistration : public ::comphelper::OSingletonRegistration< TYPE > \
{ \
private: \
typedef ::comphelper::OSingletonRegistration< TYPE > BaseClass; \
\
public: \
OSingletonRegistration() : BaseClass( ModuleClass::getInstance() ) \
{ \
} \
}; \
\
/* -------------------------------------------------------------------- */ \
template < class TYPE > \
class OLegacySingletonRegistration : public ::comphelper::OLegacySingletonRegistration< TYPE > \
{ \
private: \
typedef ::comphelper::OLegacySingletonRegistration< TYPE > BaseClass; \
\
public: \
OLegacySingletonRegistration() : BaseClass( ModuleClass::getInstance() ) \
{ \
} \
};
//====================================================================
//= implementing a concrete module
//====================================================================
#define IMPLEMENT_MODULE( ModuleClass, resprefix ) \
struct CreateModuleClass \
{ \
ModuleClass* operator()() \
{ \
static ModuleClass* pModule = new ModuleClass; \
return pModule; \
/* yes, in theory, this is a resource leak, since the ModuleClass \
will never be cleaned up. However, using a non-heap instance of ModuleClass \
would not work: It would be cleaned up when the module is unloaded. \
This might happen (and is likely to happen) *after* the tools-library \
has been unloaded. However, the module's dtor is where we would delete \
our resource manager (in case not all our clients de-registered) - which \
would call into the already-unloaded tools-library. */ \
} \
}; \
\
ModuleClass::ModuleClass() \
:BaseClass( ::rtl::OString( resprefix ) ) \
{ \
} \
\
ModuleClass& ModuleClass::getInstance() \
{ \
return *rtl_Instance< ModuleClass, CreateModuleClass, ::osl::MutexGuard, ::osl::GetGlobalMutex >:: \
create( CreateModuleClass(), ::osl::GetGlobalMutex() ); \
} \
//........................................................................
} // namespace utl
//........................................................................
#endif // UNOTOOLS_INC_UNOTOOLS_COMPONENTRESMODULE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
