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
|
/* -*- 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_UNOTOOLS_COMPONENTRESMODULE_HXX
#define INCLUDED_UNOTOOLS_COMPONENTRESMODULE_HXX
#include <comphelper/componentmodule.hxx>
#include <unotools/unotoolsdllapi.h>
#include <tools/resid.hxx>
#include <memory>
class ResMgr;
namespace utl
{
class OComponentResModuleImpl;
//= OComponentResourceModule
/** extends the comphelper::OModule 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 OString& _rResFilePrefix );
virtual ~OComponentResourceModule();
/// get the vcl res manager of the module
ResMgr* getResManager();
protected:
// OModule overridables
virtual void onFirstClient() SAL_OVERRIDE;
virtual void onLastClient() SAL_OVERRIDE;
};
//= ModuleRes
/** specialized ResId, using the resource manager provided by a given OModule
*/
class UNOTOOLS_DLLPUBLIC ModuleRes : public ::ResId
{
public:
ModuleRes( sal_uInt16 _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( sal_uInt16 _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() ) \
{ \
} \
};
//= 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( OString( resprefix ) ) \
{ \
} \
\
ModuleClass& ModuleClass::getInstance() \
{ \
return *rtl_Instance< ModuleClass, CreateModuleClass, ::osl::MutexGuard, ::osl::GetGlobalMutex >:: \
create( CreateModuleClass(), ::osl::GetGlobalMutex() ); \
} \
} // namespace utl
#endif // INCLUDED_UNOTOOLS_COMPONENTRESMODULE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
