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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_SLIDESHOW_LISTENERCONTAINER_HXX
#define INCLUDED_SLIDESHOW_LISTENERCONTAINER_HXX
#include <osl/mutex.hxx>
#include <boost/utility.hpp>
#include <algorithm>
#include <vector>
#include "listenercontainerimpl.hxx"
namespace slideshow {
namespace internal {
/** Container for objects that can be notified.
This templatized container holds listener objects, than can get
notified (by calling certain methods on them).
@tpl Listener
Type for the listener objects to be held
@tpl ContainerT
Full type of the container to store the listener objects. Defaults
to std::vector<ListenerT>
@tpl MaxDeceasedListenerUllage
Threshold, from which upwards the listener container gets
pruned. Avoids frequent copying of nearly empty containers.
@attention internal class, not to be used. functionality is
incomplete, please use the Thread(Un)safeListenerContainer types
from below
*/
template< typename ListenerT,
typename MutexHolderBaseT,
typename ContainerT=std::vector<ListenerT>,
size_t MaxDeceasedListenerUllage=16 > class ListenerContainerBase : public MutexHolderBaseT
{
typedef typename MutexHolderBaseT::Guard Guard;
typedef typename MutexHolderBaseT::ClearableGuard ClearableGuard;
public:
typedef ListenerT listener_type;
typedef ContainerT container_type;
typedef MutexHolderBaseT mutex_type;
/** Check whether listener container is empty
@return true, if currently no listeners registered. Note that
in a multi-threaded scenario, without external synchronisation
to this object, the return value might become wrong at any time.
*/
bool isEmpty() const
{
Guard aGuard(*this);
return maListeners.empty();
}
/** Check whether given listener is already added
@return true, if given listener is already added.
*/
bool isAdded( listener_type const& rListener ) const
{
Guard aGuard(*this);
const typename container_type::const_iterator aEnd( maListeners.end() );
if( std::find( maListeners.begin(),
aEnd,
rListener ) != aEnd )
{
return true; // already added
}
return false;
}
/** Add new listener
@param rListener
Listener to add
@return false, if the listener is already added, true
otherwise
*/
bool add( listener_type const& rListener )
{
Guard aGuard(*this);
// ensure uniqueness
if( isAdded(rListener) )
return false; // already added
maListeners.push_back( rListener );
ListenerOperations<ListenerT>::pruneListeners(
maListeners,
MaxDeceasedListenerUllage);
return true;
}
/** Add new listener into sorted container
The stored listeners are kept sorted (using this method
requires listener_type to have operator< defined on it). Make
sure to call addSorted() for <em>each</em> listener to add to
this container - sorting is performed under the assumption
that existing entries are already sorted.
@param rListener
Listener to add
@return false, if the listener is already added, true
otherwise
*/
bool addSorted( listener_type const& rListener )
{
Guard aGuard(*this);
// ensure uniqueness
if( isAdded(rListener) )
return false; // already added
maListeners.push_back( rListener );
// a single entry does not need to be sorted
if( maListeners.size() > 1 )
{
std::inplace_merge(
maListeners.begin(),
boost::prior(maListeners.end()),
maListeners.end() );
}
ListenerOperations<ListenerT>::pruneListeners(
maListeners,
MaxDeceasedListenerUllage);
return true;
}
/** Remove listener from container
@param rListener
The listener to remove
@return false, if listener not found in container, true
otherwise
*/
bool remove( listener_type const& rListener )
{
Guard aGuard(*this);
const typename container_type::iterator aEnd( maListeners.end() );
typename container_type::iterator aIter;
if( (aIter=std::remove(maListeners.begin(),
aEnd,
rListener)) == aEnd )
{
return false; // listener not found
}
maListeners.erase( aIter, aEnd );
return true;
}
/// Removes all listeners in one go
void clear()
{
Guard aGuard(*this);
maListeners.clear();
}
/** Apply functor to one listener
This method applies functor to one of the listeners. Starting
with the first entry of the container, the functor is called
with the listener entries, until it returns true.
@param func
Given functor is called with listeners, until it returns true
@return true, if functor was successfully applied to a
listener
*/
template< typename FuncT > bool apply( FuncT func ) const
{
ClearableGuard aGuard(*this);
// generate a local copy of all handlers, to make method
// reentrant and thread-safe.
container_type const local( maListeners );
aGuard.clear();
const bool bRet(
ListenerOperations<ListenerT>::notifySingleListener(
local,
func ));
{
Guard aGuard2(*this);
ListenerOperations<ListenerT>::pruneListeners(
const_cast<container_type&>(maListeners),
MaxDeceasedListenerUllage);
}
return bRet;
}
/** Apply functor to all listeners
This method applies functor to all of the listeners. Starting
with the first entry of the container, the functor is called
with the listener entries.
@param func
Given functor is called with listeners.
@return true, if functor was successfully applied to at least
one listener
*/
template< typename FuncT > bool applyAll( FuncT func ) const
{
ClearableGuard aGuard(*this);
// generate a local copy of all handlers, to make method
// reentrant and thread-safe.
container_type const local( maListeners );
aGuard.clear();
const bool bRet(
ListenerOperations<ListenerT>::notifyAllListeners(
local,
func ));
{
Guard aGuard2(*this);
ListenerOperations<ListenerT>::pruneListeners(
const_cast<container_type&>(maListeners),
MaxDeceasedListenerUllage);
}
return bRet;
}
private:
ContainerT maListeners;
};
////////////////////////////////////////////////////////////////////////////
/** ListenerContainer variant that serialized access
This ListenerContainer is safe to use in a multi-threaded
context. It serializes access to the object, and avoids
dead-locking by releasing the object mutex before calling
listeners.
*/
template< typename ListenerT,
typename ContainerT=std::vector<ListenerT> >
class ThreadSafeListenerContainer : public ListenerContainerBase<ListenerT,
MutexBase,
ContainerT>
{
};
////////////////////////////////////////////////////////////////////////////
/** ListenerContainer variant that does not serialize access
This ListenerContainer version is not safe to use in a
multi-threaded scenario, but has less overhead.
*/
template< typename ListenerT,
typename ContainerT=std::vector<ListenerT> >
class ThreadUnsafeListenerContainer : public ListenerContainerBase<ListenerT,
EmptyBase,
ContainerT>
{
};
} // namespace internal
} // namespace slideshow
#endif /* INCLUDED_SLIDESHOW_LISTENERCONTAINER_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|