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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: LifeTime.hxx,v $
*
* $Revision: 1.3 $
*
* last change: $Author: rt $ $Date: 2005-09-08 00:42:04 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef _LIFETIME_HXX
#define _LIFETIME_HXX
#ifndef _OSL_MUTEX_HXX_
#include <osl/mutex.hxx>
#endif
#ifndef _OSL_CONDITN_HXX_
#include <osl/conditn.hxx>
#endif
#ifndef _COM_SUN_STAR_UNO_EXCEPTION_HDL_
#include <com/sun/star/uno/Exception.hdl>
#endif
#ifndef _CPPUHELPER_INTERFACECONTAINER_HXX_
#include <cppuhelper/interfacecontainer.hxx>
#endif
#ifndef _COM_SUN_STAR_UTIL_XCLOSELISTENER_HPP_
#include <com/sun/star/util/XCloseListener.hpp>
#endif
#ifndef _COM_SUN_STAR_UTIL_XCLOSEABLE_HPP_
#include <com/sun/star/util/XCloseable.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XCOMPONENT_HPP_
#include <com/sun/star/lang/XComponent.hpp>
#endif
#ifndef _CPPUHELPER_WEAKREF_HXX_
#include <cppuhelper/weakref.hxx>
#endif
namespace apphelper
{
class LifeTimeGuard;
class LifeTimeManager
{
friend class LifeTimeGuard;
public:
LifeTimeManager( ::com::sun::star::lang::XComponent* pComponent, sal_Bool bLongLastingCallsCancelable = sal_False );
virtual ~LifeTimeManager();
sal_Bool impl_isDisposed();
sal_Bool dispose() throw(::com::sun::star::uno::RuntimeException);
public:
::cppu::OMultiTypeInterfaceContainerHelper m_aListenerContainer;
protected:
virtual sal_Bool impl_canStartApiCall();
virtual void impl_apiCallCountReachedNull(){}
void impl_registerApiCall(sal_Bool bLongLastingCall);
void impl_unregisterApiCall(sal_Bool bLongLastingCall);
void impl_init();
protected:
mutable ::osl::Mutex m_aAccessMutex;
::com::sun::star::lang::XComponent* m_pComponent;
::osl::Condition m_aNoAccessCountCondition;
sal_Int32 volatile m_nAccessCount;
sal_Bool volatile m_bDisposed;
sal_Bool volatile m_bInDispose;
//
sal_Bool m_bLongLastingCallsCancelable;
::osl::Condition m_aNoLongLastingCallCountCondition;
sal_Int32 volatile m_nLongLastingCallCount;
};
class CloseableLifeTimeManager : public LifeTimeManager
{
protected:
::com::sun::star::util::XCloseable* m_pCloseable;
::osl::Condition m_aEndTryClosingCondition;
sal_Bool volatile m_bClosed;
sal_Bool volatile m_bInTryClose;
//the ownership between model and controller is not clear at first
//each controller might consider him as owner of the model first
//at start the model is not considered as owner of itself
sal_Bool volatile m_bOwnership;
//with a XCloseable::close call and during XCloseListener::queryClosing
//the ownership can be regulated more explicit,
//if so the ownership is considered to be well known
sal_Bool volatile m_bOwnershipIsWellKnown;
public:
CloseableLifeTimeManager( ::com::sun::star::util::XCloseable* pCloseable
, ::com::sun::star::lang::XComponent* pComponent
, sal_Bool bLongLastingCallsCancelable = sal_False );
virtual ~CloseableLifeTimeManager();
sal_Bool impl_isDisposedOrClosed();
sal_Bool g_close_startTryClose(sal_Bool bDeliverOwnership)
throw ( ::com::sun::star::uno::Exception );
sal_Bool g_close_isNeedToCancelLongLastingCalls( sal_Bool bDeliverOwnership, ::com::sun::star::uno::Exception& ex )
throw ( ::com::sun::star::uno::Exception );
void g_close_endTryClose(sal_Bool bDeliverOwnership, sal_Bool bMyVeto, ::com::sun::star::uno::Exception& ex)
throw ( ::com::sun::star::uno::Exception );
void g_close_endTryClose_doClose();
sal_Bool g_addCloseListener( const ::com::sun::star::uno::Reference<
::com::sun::star::util::XCloseListener > & xListener )
throw(::com::sun::star::uno::RuntimeException);
protected:
virtual sal_Bool impl_canStartApiCall();
virtual void impl_apiCallCountReachedNull();
void impl_setOwnership( sal_Bool bDeliverOwnership, sal_Bool bMyVeto );
sal_Bool impl_shouldCloseAtNextChance();
void impl_doClose();
void impl_init()
{
m_bClosed = sal_False;
m_bInTryClose = sal_False;
m_bOwnership = sal_False;
m_bOwnershipIsWellKnown = sal_False;
m_aEndTryClosingCondition.set();
}
};
//-----------------------------------------------------------------
/*
Use this Guard in your apicalls to protect access on resources
which will be released in dispose.
It's guarantied, that the release of resources only starts if your
guarded call has finished.
! It's only partly guaranteed that this resources will not change during the call.
See the example for details.
This class is to be used as described in the example.
If this guard is used in all api calls of an XCloseable object
it's guarantied, that the closeable will close itself after finishing the last call
if it should do so.
::ApiCall
{
//hold no mutex!!!
LifeTimeGuard aLifeTimeGuard(m_aLifeTimeManager);
//mutex is acquired; call is not registered
if(!aGuard.startApiCall())
return ; //behave as passive as possible, if disposed or closed
//mutex is acquired, call is registered
{
//you might access some private members here
//but than you need to protect access to these members always like this
//never call to the outside here
}
aLifeTimeGuard.clear(); //!!!
//Mutex is released, the running call is still registered
//this call will finish before the 'release-section' in dispose is allowed to start
{
//you might access some private members here guarded with your own mutex
//but release your mutex at the end of this block
}
//you can call to the outside (without holding the mutex) without becoming disposed
//End of method -> ~LifeTimeGuard
//-> call is unregistered
//-> this object might be disposed now
}
your XComponent::dispose method has to be implemented in the following way:
::dispose()
{
//hold no mutex!!!
if( !m_aLifeTimeManager.dispose() )
return;
//--release all resources and references
//...
}
*/
//-----------------------------------------------------------------
class LifeTimeGuard : public ::osl::ResettableMutexGuard
{
public:
LifeTimeGuard( LifeTimeManager& rManager )
: ::osl::ResettableGuard< ::osl::Mutex >( rManager.m_aAccessMutex )
, m_rManager(rManager)
, m_bCallRegistered(sal_False)
, m_bLongLastingCallRegistered(sal_False)
{
}
sal_Bool startApiCall(sal_Bool bLongLastingCall=sal_False);
virtual ~LifeTimeGuard();
private:
LifeTimeManager& m_rManager;
sal_Bool m_bCallRegistered;
sal_Bool m_bLongLastingCallRegistered;
private:
// these make no sense
LifeTimeGuard( ::osl::Mutex& rMutex );
LifeTimeGuard( const LifeTimeGuard& );
LifeTimeGuard& operator= ( const LifeTimeGuard& );
};
template<class T>
class NegativeGuard
{
protected:
T * m_pT;
public:
NegativeGuard(T * pT) : m_pT(pT)
{
m_pT->release();
}
NegativeGuard(T & t) : m_pT(&t)
{
m_pT->release();
}
~NegativeGuard()
{
m_pT->acquire();
}
};
}//end namespace apphelper
#endif
|
