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
318
319
320
|
/* -*- 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_FORMS_SOURCE_INC_INTERFACECONTAINER_HXX
#define INCLUDED_FORMS_SOURCE_INC_INTERFACECONTAINER_HXX
#include <comphelper/types.hxx>
#include <comphelper/uno3.hxx>
#include <com/sun/star/container/XNameReplace.hpp>
#include <com/sun/star/container/XIndexReplace.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/lang/EventObject.hpp>
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/io/XPersistObject.hpp>
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/beans/PropertyChangeEvent.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/script/XEventAttacherManager.hpp>
#include <com/sun/star/script/ScriptEvent.hpp>
#include <com/sun/star/script/ScriptEventDescriptor.hpp>
#include <com/sun/star/container/XContainer.hpp>
#include <com/sun/star/container/XIndexContainer.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/form/XFormComponent.hpp>
#include <com/sun/star/util/XCloneable.hpp>
#include <osl/mutex.hxx>
#include <cppuhelper/interfacecontainer.hxx>
#include <cppuhelper/component.hxx>
#include <cppuhelper/implbase8.hxx>
#include <unordered_map>
namespace com { namespace sun { namespace star { namespace uno {
class XComponentContext;
} } } }
using namespace comphelper;
namespace frm
{
struct ElementDescription
{
public:
css::uno::Reference< css::uno::XInterface > xInterface;
css::uno::Reference< css::beans::XPropertySet > xPropertySet;
css::uno::Reference< css::container::XChild > xChild;
css::uno::Any aElementTypeInterface;
public:
ElementDescription( );
virtual ~ElementDescription();
private:
ElementDescription( const ElementDescription& ) = delete;
ElementDescription& operator=( const ElementDescription& ) = delete;
};
typedef std::vector<css::uno::Reference<css::uno::XInterface>> OInterfaceArray;
typedef std::unordered_multimap< OUString, css::uno::Reference<css::uno::XInterface>, OUStringHash > OInterfaceMap;
// OInterfaceContainer
// implements a container for form components
typedef ::cppu::ImplHelper8 < css::container::XNameContainer
, css::container::XIndexContainer
, css::container::XContainer
, css::container::XEnumerationAccess
, css::script::XEventAttacherManager
, css::beans::XPropertyChangeListener
, css::io::XPersistObject
, css::util::XCloneable
> OInterfaceContainer_BASE;
class OInterfaceContainer : public OInterfaceContainer_BASE
{
protected:
::osl::Mutex& m_rMutex;
OInterfaceArray m_aItems;
OInterfaceMap m_aMap;
::cppu::OInterfaceContainerHelper m_aContainerListeners;
const css::uno::Type m_aElementType;
css::uno::Reference< css::uno::XComponentContext> m_xContext;
// EventManager
css::uno::Reference< css::script::XEventAttacherManager> m_xEventAttacher;
public:
OInterfaceContainer(
const css::uno::Reference< css::uno::XComponentContext>& _rxFactory,
::osl::Mutex& _rMutex,
const css::uno::Type& _rElementType);
OInterfaceContainer( ::osl::Mutex& _rMutex, const OInterfaceContainer& _cloneSource );
// late constructor for cloning
void clonedFrom(const OInterfaceContainer& _cloneSource) throw(css::uno::RuntimeException, std::exception);
protected:
virtual ~OInterfaceContainer();
public:
// css::io::XPersistObject
virtual OUString SAL_CALL getServiceName( ) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE = 0;
virtual void SAL_CALL write( const css::uno::Reference< css::io::XObjectOutputStream >& OutStream ) throw(css::io::IOException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL read( const css::uno::Reference< css::io::XObjectInputStream >& InStream ) throw(css::io::IOException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::lang::XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& _rSource) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::beans::XPropertyChangeListener
virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent& evt) throw (css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XElementAccess
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;
// css::container::XEnumerationAccess
virtual css::uno::Reference< css::container::XEnumeration> SAL_CALL createEnumeration() throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XNameAccess
virtual css::uno::Any SAL_CALL getByName( const OUString& aName ) 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& aName ) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XNameReplace
virtual void SAL_CALL replaceByName(const OUString& Name, const css::uno::Any& _rElement) throw(css::lang::IllegalArgumentException, css::container::NoSuchElementException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XNameContainer
virtual void SAL_CALL insertByName(const OUString& Name, const css::uno::Any& _rElement) throw(css::lang::IllegalArgumentException, css::container::ElementExistException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeByName(const OUString& Name) throw(css::container::NoSuchElementException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XIndexAccess
virtual sal_Int32 SAL_CALL getCount() throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Any SAL_CALL getByIndex(sal_Int32 _nIndex) throw(css::lang::IndexOutOfBoundsException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XIndexReplace
virtual void SAL_CALL replaceByIndex(sal_Int32 _nIndex, const css::uno::Any& _rElement) throw(css::lang::IllegalArgumentException, css::lang::IndexOutOfBoundsException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XIndexContainer
virtual void SAL_CALL insertByIndex(sal_Int32 _nIndex, const css::uno::Any& Element) throw(css::lang::IllegalArgumentException, css::lang::IndexOutOfBoundsException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeByIndex(sal_Int32 _nIndex) throw(css::lang::IndexOutOfBoundsException, css::lang::WrappedTargetException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::container::XContainer
virtual void SAL_CALL addContainerListener(const css::uno::Reference< css::container::XContainerListener>& _rxListener) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeContainerListener(const css::uno::Reference< css::container::XContainerListener>& _rxListener) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// css::script::XEventAttacherManager
virtual void SAL_CALL registerScriptEvent( sal_Int32 nIndex, const css::script::ScriptEventDescriptor& aScriptEvent ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL registerScriptEvents( sal_Int32 nIndex, const css::uno::Sequence< css::script::ScriptEventDescriptor >& aScriptEvents ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL revokeScriptEvent( sal_Int32 nIndex, const OUString& aListenerType, const OUString& aEventMethod, const OUString& aRemoveListenerParam ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL revokeScriptEvents( sal_Int32 nIndex ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL insertEntry( sal_Int32 nIndex ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeEntry( sal_Int32 nIndex ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Sequence< css::script::ScriptEventDescriptor > SAL_CALL getScriptEvents( sal_Int32 Index ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL attach( sal_Int32 nIndex, const css::uno::Reference< css::uno::XInterface >& xObject, const css::uno::Any& aHelper ) throw(css::lang::IllegalArgumentException, css::lang::ServiceNotRegisteredException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL detach( sal_Int32 nIndex, const css::uno::Reference< css::uno::XInterface >& xObject ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addScriptListener( const css::uno::Reference< css::script::XScriptListener >& xListener ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeScriptListener( const css::uno::Reference< css::script::XScriptListener >& Listener ) throw(css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
protected:
// helper
virtual void SAL_CALL disposing();
void removeElementsNoEvents(sal_Int32 nIndex);
/** to be overridden if elements which are to be inserted into the container shall be checked
<p>the ElementDescription given can be used to cache information about the object - it will be passed
later on to implInserted/implReplaced.</p>
*/
virtual void approveNewElement(
const css::uno::Reference< css::beans::XPropertySet >& _rxObject,
ElementDescription* _pElement
);
virtual ElementDescription* createElementMetaData( );
/** inserts an object into our internal structures
@param _nIndex
the index at which position it should be inserted
@param _bEvents
if <TRUE/>, event knittings will be done
@param _pApprovalResult
must contain the result of an approveNewElement call. Can be <NULL/>, in this case, the approval
is done within implInsert.
@param _bFire
if <TRUE/>, a notification about the insertion will be fired
*/
void implInsert(
sal_Int32 _nIndex,
const css::uno::Reference< css::beans::XPropertySet >& _rxObject,
bool _bEvents /* = sal_True */,
ElementDescription* _pApprovalResult /* = NULL */ ,
bool _bFire /* = sal_True */
) throw(css::lang::IllegalArgumentException);
// called after the object is inserted, but before the "real listeners" are notified
virtual void implInserted( const ElementDescription* _pElement );
// called after the object is removed, but before the "real listeners" are notified
virtual void implRemoved(const css::uno::Reference<css::uno::XInterface>& _rxObject);
/** called after an object was replaced. The default implementation notifies our listeners, after releasing
the instance lock.
*/
virtual void impl_replacedElement(
const css::container::ContainerEvent& _rEvent,
::osl::ClearableMutexGuard& _rInstanceLock
);
void SAL_CALL writeEvents(const css::uno::Reference< css::io::XObjectOutputStream>& _rxOutStream);
void SAL_CALL readEvents(const css::uno::Reference< css::io::XObjectInputStream>& _rxInStream);
/** replace an element, specified by position
@precond <arg>_nIndex</arg> is a valid index
@precond our mutex is locked exactly once, by the guard specified with <arg>_rClearBeforeNotify</arg>
*/
void implReplaceByIndex(
const sal_Int32 _nIndex,
const css::uno::Any& _rNewElement,
::osl::ClearableMutexGuard& _rClearBeforeNotify
);
/** removes an element, specified by position
@precond <arg>_nIndex</arg> is a valid index
@precond our mutex is locked exactly once, by the guard specified with <arg>_rClearBeforeNotify</arg>
*/
void implRemoveByIndex(
const sal_Int32 _nIndex,
::osl::ClearableMutexGuard& _rClearBeforeNotify
);
/** validates the given index
@throws css::lang::IndexOutOfBoundsException
if the given index does not denote a valid position in our children array
*/
void implCheckIndex( const sal_Int32 _nIndex );
private:
// hack for Vba Events
void impl_addVbEvents_nolck_nothrow( const sal_Int32 i_nIndex );
// the runtime event format has changed from version SO5.2 to OOo
enum EventFormat
{
efVersionSO5x,
efVersionSO6x
};
void transformEvents( const EventFormat _eTargetFormat );
void impl_createEventAttacher_nothrow();
};
typedef ::cppu::ImplHelper1< css::form::XFormComponent> OFormComponents_BASE;
typedef ::cppu::OComponentHelper FormComponentsBase;
// else MSVC kills itself on some statements
class OFormComponents :public FormComponentsBase
,public OInterfaceContainer
,public OFormComponents_BASE
{
protected:
::osl::Mutex m_aMutex;
css::uno::Reference<css::uno::XInterface> m_xParent;
public:
OFormComponents(const css::uno::Reference< css::uno::XComponentContext>& _rxFactory);
OFormComponents( const OFormComponents& _cloneSource );
virtual ~OFormComponents();
DECLARE_UNO3_AGG_DEFAULTS(OFormComponents, FormComponentsBase)
virtual css::uno::Any SAL_CALL queryAggregation(const css::uno::Type& _rType) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// OComponentHelper
virtual void SAL_CALL disposing() SAL_OVERRIDE;
// css::form::XFormComponent
virtual css::uno::Reference<css::uno::XInterface> SAL_CALL getParent() throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setParent(const css::uno::Reference<css::uno::XInterface>& Parent) throw(css::lang::NoSupportException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XEventListener
using OInterfaceContainer::disposing;
};
} // namespace frm
#endif // INCLUDED_FORMS_SOURCE_INC_INTERFACECONTAINER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
