blob: 1486f46c1547bd94b300ec5ac59886cc0b16520b (
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
|
/* -*- 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 .
*/
#include <threadhelp/lockhelper.hxx>
#include <general.h>
#include <macros/generic.hxx>
#include "vcl/solarmutex.hxx"
#include <osl/process.h>
namespace framework{
/*-************************************************************************************************************
@short use ctor to initialize instance
@seealso class Guard
@param "rSolarMutex", for some components we must be "vcl-free"! So we can't work with our solar mutex
directly. User must set his reference at this instance - so we can work with it!
@return -
@onerror -
*//*-*************************************************************************************************************/
LockHelper::LockHelper( comphelper::SolarMutex* pSolarMutex )
: m_pSolarMutex ( NULL )
, m_pShareableOslMutex( NULL )
, m_bDummySolarMutex ( sal_False )
{
if( pSolarMutex == NULL )
{
m_pSolarMutex = new ::vcl::SolarMutexObject;
m_bDummySolarMutex = sal_True;
}
else
{
m_pSolarMutex = pSolarMutex;
}
}
/*-************************************************************************************************************
@short default dtor to release safed pointer
@descr We have created dynamical mutex- or lock-member ... or we hold a pointer to external objects.
We must release it!
@seealso ctor()
@param -
@return -
@onerror -
*//*-*************************************************************************************************************/
LockHelper::~LockHelper()
{
if( m_pShareableOslMutex != NULL )
{
delete m_pShareableOslMutex;
m_pShareableOslMutex = NULL;
}
if( m_pSolarMutex != NULL )
{
if (m_bDummySolarMutex)
{
delete static_cast<vcl::SolarMutexObject*>(m_pSolarMutex);
m_bDummySolarMutex = sal_False;
}
m_pSolarMutex = NULL;
}
}
/*-************************************************************************************************************
@interface IMutex
@short set an exclusiv lock
@descr We must match this lock call with current set lock type and used lock member.
If a mutex should be used - it will be easy ... but if a rw-lock should be used
we must simulate it as a write access!
@attention If a shareable osl mutex exist, he must be used as twice!
It's necessary for some cppu-helper classes ...
@param -
@return -
@onerror -
*//*-*************************************************************************************************************/
void LockHelper::acquire()
{
m_pSolarMutex->acquire();
}
/*-************************************************************************************************************
@interface IMutex
@short release exclusiv lock
@descr We must match this unlock call with current set lock type and used lock member.
If a mutex should be used - it will be easy ... but if a rw-lock should be used
we must simulate it as a write access!
@attention If a shareable osl mutex exist, he must be used as twice!
It's necessary for some cppu-helper classes ...
@param -
@return -
@onerror -
*//*-*************************************************************************************************************/
void LockHelper::release()
{
m_pSolarMutex->release();
}
/*-************************************************************************************************************
@short return a reference to a static lock helper
@descr Sometimes we need the global mutex or rw-lock! (e.g. in our own static methods)
But it's not a good idea to use these global one very often ...
Thats why we use this little helper method.
We create our own "class global static" lock.
It will be created at first call only!
All other requests use these created one then directly.
@seealso -
@param -
@return A reference to a static mutex/lock member.
@onerror No error should occur.
*//*-*************************************************************************************************************/
LockHelper& LockHelper::getGlobalLock()
{
// Initialize static "member" only for one time!
// Algorithm:
// a) Start with an invalid lock (NULL pointer)
// b) If these method first called (lock not already exist!) ...
// c) ... we must create a new one. Protect follow code with the global mutex -
// (It must be - we create a static variable!)
// d) Check pointer again - because ... another instance of our class could be faster then these one!
// e) Create the new lock and set it for return on static variable.
// f) Return new created or already existing lock object.
static LockHelper* pLock = NULL;
if( pLock == NULL )
{
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
if( pLock == NULL )
{
static LockHelper aLock;
pLock = &aLock;
}
}
return *pLock;
}
/*-************************************************************************************************************
@short return a reference to shared mutex member
@descr Sometimes we need a osl-mutex for sharing with our uno helper ...
What can we do?
We must use a different mutex member :-(
I HOPE IT WORKS!
@seealso -
@param -
@return A reference to a shared mutex.
@onerror No error should occur.
*//*-*************************************************************************************************************/
::osl::Mutex& LockHelper::getShareableOslMutex()
{
if( m_pShareableOslMutex == NULL )
{
::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
if( m_pShareableOslMutex == NULL )
{
m_pShareableOslMutex = new ::osl::Mutex;
}
}
return *m_pShareableOslMutex;
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
