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
|
/* -*- 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 .
*/
#pragma once
#include <mutex>
#include <osl/conditn.hxx>
#include <comphelper/interfacecontainer4.hxx>
#include "charttoolsdllapi.hxx"
namespace com::sun::star::document { class XStorageChangeListener; }
namespace com::sun::star::lang { class XComponent; }
namespace com::sun::star::lang { class XEventListener; }
namespace com::sun::star::util { class CloseVetoException; }
namespace com::sun::star::util { class XCloseListener; }
namespace com::sun::star::util { class XCloseable; }
namespace com::sun::star::util { class XModifyListener; }
namespace com::sun::star::view { class XSelectionChangeListener; }
namespace apphelper
{
class OOO_DLLPUBLIC_CHARTTOOLS LifeTimeManager
{
friend class LifeTimeGuard;
public:
LifeTimeManager( css::lang::XComponent* pComponent );
virtual ~LifeTimeManager();
bool impl_isDisposed( bool bAssert=true );
/// @throws css::uno::RuntimeException
bool dispose();
mutable std::mutex m_aAccessMutex;
::comphelper::OInterfaceContainerHelper4<css::util::XCloseListener> m_aCloseListeners;
::comphelper::OInterfaceContainerHelper4<css::util::XModifyListener> m_aModifyListeners;
::comphelper::OInterfaceContainerHelper4<css::document::XStorageChangeListener> m_aStorageChangeListeners;
::comphelper::OInterfaceContainerHelper4<css::lang::XEventListener> m_aEventListeners;
::comphelper::OInterfaceContainerHelper4<css::view::XSelectionChangeListener> m_aSelectionChangeListeners;
protected:
SAL_DLLPRIVATE virtual bool impl_canStartApiCall();
SAL_DLLPRIVATE virtual void impl_apiCallCountReachedNull(std::unique_lock<std::mutex>& /*rGuard*/){}
SAL_DLLPRIVATE void impl_registerApiCall(bool bLongLastingCall);
SAL_DLLPRIVATE void impl_unregisterApiCall(std::unique_lock<std::mutex>& rGuard, bool bLongLastingCall);
css::lang::XComponent* m_pComponent;
::osl::Condition m_aNoAccessCountCondition;
sal_Int32 m_nAccessCount;
bool volatile m_bDisposed;
bool volatile m_bInDispose;
::osl::Condition m_aNoLongLastingCallCountCondition;
sal_Int32 m_nLongLastingCallCount;
};
class CloseableLifeTimeManager final : public LifeTimeManager
{
css::util::XCloseable* m_pCloseable;
::osl::Condition m_aEndTryClosingCondition;
bool volatile m_bClosed;
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
bool volatile m_bOwnership;
public:
CloseableLifeTimeManager( css::util::XCloseable* pCloseable
, css::lang::XComponent* pComponent );
virtual ~CloseableLifeTimeManager() override;
bool impl_isDisposedOrClosed( bool bAssert=true );
/// @throws css::uno::Exception
bool g_close_startTryClose(bool bDeliverOwnership);
/// @throws css::util::CloseVetoException
void g_close_isNeedToCancelLongLastingCalls( bool bDeliverOwnership, css::util::CloseVetoException const & ex );
void g_close_endTryClose(bool bDeliverOwnership );
void g_close_endTryClose_doClose();
/// @throws css::uno::RuntimeException
void g_addCloseListener( const css::uno::Reference< css::util::XCloseListener > & xListener );
private:
virtual bool impl_canStartApiCall() override;
virtual void impl_apiCallCountReachedNull(std::unique_lock<std::mutex>& rGuard) override;
void impl_setOwnership( bool bDeliverOwnership, bool bMyVeto );
void impl_doClose(std::unique_lock<std::mutex>& rGuard);
};
/*
Use this Guard in your ApiCalls to protect access on resources
which will be released in dispose.
It's guaranteed 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 guaranteed 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(!aLifeTimeGuard.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 then 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:
LifeTimeGuard( LifeTimeManager& rManager )
: m_guard( rManager.m_aAccessMutex )
, m_rManager(rManager)
, m_bCallRegistered(false)
, m_bLongLastingCallRegistered(false)
{
}
bool startApiCall(bool bLongLastingCall=false);
~LifeTimeGuard();
void clear() { m_guard.unlock(); }
private:
std::unique_lock<std::mutex> m_guard;
LifeTimeManager& m_rManager;
bool m_bCallRegistered;
bool m_bLongLastingCallRegistered;
private:
LifeTimeGuard( const LifeTimeGuard& ) = delete;
LifeTimeGuard& operator= ( const LifeTimeGuard& ) = delete;
};
}//end namespace apphelper
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
