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
|
/* -*- 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 .
*/
#ifndef INCLUDED_FILTER_SOURCE_CONFIG_CACHE_BASECONTAINER_HXX
#define INCLUDED_FILTER_SOURCE_CONFIG_CACHE_BASECONTAINER_HXX
#include "filtercache.hxx"
#include <com/sun/star/uno/Exception.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/util/XRefreshable.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/container/XContainerQuery.hpp>
#include <com/sun/star/util/XFlushable.hpp>
#include <cppuhelper/interfacecontainer.h>
#include <salhelper/singletonref.hxx>
#include <cppuhelper/implbase4.hxx>
#include <cppuhelper/weakref.hxx>
#include <rtl/ustring.hxx>
namespace filter{
namespace config{
/** @short implements the interface css::container::XNameContainer
on top of a FilterCache reference.
@descr This class can be used as base for own service implementations,
which must provide read/write access to the filter configuration.
Parameters regulate read/write access, which sub set of information
should be available etc.
@attention The base class BaseLock must be the first of declared ones.
Otherwise we can't be sure, that our own mutex member (which is
present by this base class!) was full initialized inside our own
ctor as first!
*/
class BaseContainer : public BaseLock
, public ::cppu::WeakImplHelper4< css::lang::XServiceInfo ,
css::container::XNameContainer , // => XNameReplace => XNameAccess => XElementAccess
css::container::XContainerQuery ,
css::util::XFlushable >
{
// member
protected:
// TODO
css::uno::WeakReference< css::util::XRefreshable > m_xRefreshBroadcaster;
/** @short the implementation name of our derived class, which we provide
at the interface XServiceInfo of our class ... */
OUString m_sImplementationName;
/** @short the list of supported uno service names of our derived class, which we provide
at the interface XServiceInfo of our class ... */
css::uno::Sequence< OUString > m_lServiceNames;
/** @short reference(!) to a singleton filter cache implementation,
which is used to work with the underlying configuration. */
::salhelper::SingletonRef< FilterCache > m_rCache;
/** @short local filter cache, which is used to collect changes on the
filter configuration first and flush it later.
@descr Normally this member isn't used nor initialized. Thats true,
if this container is used for reading only. The first write access
(e.g. by calling insertByName()) creates a copy of the current
global cache m_rCache to initialize the m_pFlushCache member.
Afterwards only the flush cache copy is used. Inside flush() this
copy will be removed and m_rCache can be used again.
m_pFlushCache and m_rCache must not be synchronized manually here.
m_rCache listen on the global configuration, where m_pFlushCache
write its data. m_rCache update itself automatically.
*/
FilterCache* m_pFlushCache;
/** @short specify, which sub container of the used filter cache
must be wrapped by this container interface. */
FilterCache::EItemType m_eType;
/** @short holds all listener, which are registered at this instance. */
::cppu::OMultiTypeInterfaceContainerHelper m_lListener;
// native interface
public:
// ctor/dtor
/** @short standard ctor.
@descr Because mostly this class is used as base class for own service
implementations in combination with a ImplInheritanceHelper2 template ...
there is no way to provide some initializing data through the ctor :-(
This base class will be created inside its default ctor and must be
initialized with its needed parameters explicitly by calling: "init()".
@see init()
*/
BaseContainer();
/** @short standard dtor.
*/
virtual ~BaseContainer();
/** @short initialize this generic intsnace with some specialized values
from our derived object.
@descr Because an outside class must use ImplInheritanceHelper2 template to
use us a base class ... and there is no way to pass such initializing
parameters trough a required default ctor ... we must be initialized
by this special method. Of course this method must be called first before
any other interface method is used.
@param rxContext
reference to the uno service manager, which created this service instance.
@param sImplementationName
the implementation name of our derived class, which we provide
at the interface XServiceInfo of our class ...
@param lServiceNames
the list of supported uno service names of our derived class, which we provide
at the interface XServiceInfo of our class ...
@param eType
specify, which sub container of the used filter cache
must be wrapped by this container interface.
*/
virtual void init(const css::uno::Reference< css::uno::XComponentContext >& rxContext ,
const OUString& sImplementationName,
const css::uno::Sequence< OUString >& lServiceNames ,
FilterCache::EItemType eType );
// helper
protected:
/** @short check if the underlying configuration data was already loaded
and do it if necessary automatically.
*/
void impl_loadOnDemand();
/** @short it creates the global instance m_pFilterCache, which is a copy
of the global instance m_rCache, and will be used to change the
configuration.
@descr If no exception occurs, its guaranteed, that the member m_rFlushCache
was initialized right and can be used further.
*/
void impl_initFlushMode()
throw (css::uno::RuntimeException);
/** @short returns a pointer to the current used cache member.
@descr Its a point to the FilterCache instance behind m_pFlushCache
or m_rCache.
@note The lifetime of this pointer is restricted to the time, where
the mutex of this BaseContainer instance is locked.
Otherwise may be the interface method flush() will destroy
m_pFlushCache and the here returned pointer will be invalid!
Use:
Guard aLock(m_aLock);
FilterCache* p = impl_getWorkingCache();
p->doSomething();
aLock.clear();
// after this point p can't b e guaranteed any longer!
*/
FilterCache* impl_getWorkingCache() const;
// uno interface
public:
// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL supportsService(const OUString& sServiceName)
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames()
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XNameContainer
virtual void SAL_CALL insertByName(const OUString& sItem ,
const css::uno::Any& aValue)
throw (css::lang::IllegalArgumentException ,
css::container::ElementExistException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL removeByName(const OUString& sItem)
throw (css::container::NoSuchElementException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XNameReplace
virtual void SAL_CALL replaceByName(const OUString& sItem ,
const css::uno::Any& aValue)
throw (css::lang::IllegalArgumentException ,
css::container::NoSuchElementException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XElementAccess
virtual css::uno::Any SAL_CALL getByName(const OUString& sItem)
throw (css::container::NoSuchElementException,
css::lang::WrappedTargetException ,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual css::uno::Sequence< OUString > SAL_CALL getElementNames()
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL hasByName(const OUString& sItem)
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Type SAL_CALL getElementType()
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL hasElements()
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XContainerQuery
// must be implemented really by derived class ...
// We implement return of an empty result here only!
// But we show an assertion :-)
virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createSubSetEnumerationByQuery(const OUString& sQuery)
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createSubSetEnumerationByProperties(const css::uno::Sequence< css::beans::NamedValue >& lProperties)
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XFlushable
virtual void SAL_CALL flush()
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addFlushListener(const css::uno::Reference< css::util::XFlushListener >& xListener)
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeFlushListener(const css::uno::Reference< css::util::XFlushListener >& xListener)
throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
};
} // namespace config
} // namespace filter
#endif // INCLUDED_FILTER_SOURCE_CONFIG_CACHE_BASECONTAINER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|