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
|
/* -*- 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 .
*/
/*
* This file is part of LibreOffice published API.
*/
#ifndef INCLUDED_SALHELPER_SINGLETONREF_HXX
#define INCLUDED_SALHELPER_SINGLETONREF_HXX
#include "sal/config.h"
#include <cstddef>
#include "osl/mutex.hxx"
#include "rtl/instance.hxx"
#include "osl/diagnose.h"
#include "osl/getglobalmutex.hxx"
namespace salhelper{
/** @short template for implementing singleton classes.
Such classes can be instantiated every time they
are needed. But the internal wrapped object will
be created one times only. Of course it's used
resources are referenced one times only too.
This template hold it alive till the last
reference is gone. Further all operations
on this reference are threadsafe. Only
calls directly to the internal object (which modify
its state) must be made threadsafe by the object itself
or from outside.
@attention To prevent the code against race conditions, it's not
allowed to start operations inside the ctor
of the internal wrapped object - especially operations
which needs a reference to the same singleton too.
The only chance to suppress such strange constellations
is a lazy-init mechanism.
<ul>
<li>a) The singleton class can provide a special init()
method, which must be called as first after creation.</li>
<li>b) The singleton class can call a special impl_init()
method implicit for every called interface method.</li>
</ul>
Note further that this singleton pattern can work only, if
all user of such singleton are located inside the same library!
Because static values can't be exported - e.g. from windows libraries.
*/
template< class SingletonClass >
class SingletonRef
{
// member
private:
/** @short pointer to the internal wrapped singleton. */
static SingletonClass* m_pInstance;
/** @short ref count, which regulate creation and removing of m_pInstance. */
static sal_Int32 m_nRef;
// interface
public:
/** @short standard ctor.
The internal wrapped object is created only,
if its ref count was 0. Otherwise this method
does nothing ... except increasing of the internal
ref count!
*/
SingletonRef()
{
// GLOBAL SAFE ->
::osl::MutexGuard aLock(SingletonRef::ownStaticLock());
// must be increased before(!) the check is done.
// Otherwise this check can fail inside the same thread ...
++m_nRef;
if (m_nRef == 1)
m_pInstance = new SingletonClass();
OSL_ENSURE(m_nRef>0 && m_pInstance, "Race? Ref count of singleton >0, but instance is NULL!");
// <- GLOBAL SAFE
}
/** @short standard dtor.
The internal wrapped object is removed only,
if its ref count will be 0. Otherwise this method
does nothing ... except decreasing of the internal
ref count!
*/
~SingletonRef()
{
// GLOBAL SAFE ->
::osl::MutexGuard aLock(SingletonRef::ownStaticLock());
// must be decreased before(!) the check is done.
// Otherwise this check can fail inside the same thread ...
--m_nRef;
if (m_nRef == 0)
{
delete m_pInstance;
m_pInstance = NULL;
}
// <- GLOBAL SAFE
}
#if defined LIBO_INTERNAL_ONLY
SingletonRef & operator =(SingletonRef const &) = default;
#endif
/** @short Allows rSingle->someBodyOp().
*/
SingletonClass* operator->() const
{
// GLOBAL SAFE ->
::osl::MutexGuard aLock(SingletonRef::ownStaticLock());
return m_pInstance;
// <- GLOBAL SAFE
}
/** @short Allows (*rSingle).someBodyOp().
*/
SingletonClass& operator*() const
{
// GLOBAL SAFE ->
::osl::MutexGuard aLock(SingletonRef::ownStaticLock());
return *m_pInstance;
// <- GLOBAL SAFE
}
// helper
private:
SingletonRef(SingletonRef &) SAL_DELETED_FUNCTION;
/** @short creates an own mutex for guarding static contents.
The global mutex the osl library is used one times
only to create an own static mutex, which can be used
next time to guard own static member operations.
*/
struct SingletonLockInit
{
::osl::Mutex* operator()()
{
static ::osl::Mutex aInstance;
return &aInstance;
}
};
::osl::Mutex& ownStaticLock() const
{
return *rtl_Instance< ::osl::Mutex,
SingletonLockInit,
::osl::MutexGuard,
::osl::GetGlobalMutex >::create(SingletonLockInit(), ::osl::GetGlobalMutex());
}
};
template< class SingletonClass >
SingletonClass* SingletonRef< SingletonClass >::m_pInstance = NULL;
template< class SingletonClass >
sal_Int32 SingletonRef< SingletonClass >::m_nRef = 0;
} // namespace salhelper
#endif // INCLUDED_SALHELPER_SINGLETONREF_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
