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
|
/* -*- 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.
*
************************************************************************/
#include <dispatch/interceptionhelper.hxx>
#include <com/sun/star/frame/XInterceptorInfo.hpp>
#include <vcl/svapp.hxx>
//_______________________________________________
// namespace
namespace framework{
//_______________________________________________
// non exported const
sal_Bool InterceptionHelper::m_bPreferrFirstInterceptor = sal_True;
//_______________________________________________
// non exported definitions
//_______________________________________________
// declarations
DEFINE_XINTERFACE_3(InterceptionHelper ,
OWeakObject ,
DIRECT_INTERFACE(css::frame::XDispatchProvider ),
DIRECT_INTERFACE(css::frame::XDispatchProviderInterception),
DIRECT_INTERFACE(css::lang::XEventListener ))
InterceptionHelper::InterceptionHelper(const css::uno::Reference< css::frame::XFrame >& xOwner,
const css::uno::Reference< css::frame::XDispatchProvider >& xSlave)
// Init baseclasses first
: ThreadHelpBase(&Application::GetSolarMutex())
, OWeakObject ( )
// Init member
, m_xOwnerWeak (xOwner )
, m_xSlave (xSlave )
{
}
InterceptionHelper::~InterceptionHelper()
{
}
css::uno::Reference< css::frame::XDispatch > SAL_CALL InterceptionHelper::queryDispatch(const css::util::URL& aURL ,
const ::rtl::OUString& sTargetFrameName,
sal_Int32 nSearchFlags )
throw(css::uno::RuntimeException)
{
// SAFE {
ReadGuard aReadLock(m_aLock);
// a) first search an interceptor, which match to this URL by it's URL pattern registration
// Note: if it return NULL - it does not mean an empty interceptor list automaticly!
css::uno::Reference< css::frame::XDispatchProvider > xInterceptor;
InterceptorList::const_iterator pIt = m_lInterceptionRegs.findByPattern(aURL.Complete);
if (pIt != m_lInterceptionRegs.end())
xInterceptor = pIt->xInterceptor;
// b) No match by registration - but a valid interceptor list.
// Use first interceptor everytimes.
// Note: it doesn't matter, which direction this helper implementation use to ask interceptor objects.
// Using of member m_aInterceptorList will starts at the beginning everytimes.
// It depends from the filling operation, in which direction it works realy!
if (!xInterceptor.is() && m_lInterceptionRegs.size()>0)
{
pIt = m_lInterceptionRegs.begin();
xInterceptor = pIt->xInterceptor;
}
// c) No registered interceptor => use our direct slave.
// This helper exist by design and must be valid everytimes ...
// But to be more feature proof - we should check that .-)
if (!xInterceptor.is() && m_xSlave.is())
xInterceptor = m_xSlave;
aReadLock.unlock();
// } SAFE
css::uno::Reference< css::frame::XDispatch > xReturn;
if (xInterceptor.is())
xReturn = xInterceptor->queryDispatch(aURL, sTargetFrameName, nSearchFlags);
return xReturn;
}
css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL InterceptionHelper::queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor )
throw(css::uno::RuntimeException)
{
sal_Int32 c = lDescriptor.getLength();
css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > lDispatches (c);
css::uno::Reference< css::frame::XDispatch >* pDispatches = lDispatches.getArray();
const css::frame::DispatchDescriptor* pDescriptor = lDescriptor.getConstArray();
for (sal_Int32 i=0; i<c; ++i)
pDispatches[i] = queryDispatch(pDescriptor[i].FeatureURL, pDescriptor[i].FrameName, pDescriptor[i].SearchFlags);
return lDispatches;
}
void SAL_CALL InterceptionHelper::registerDispatchProviderInterceptor(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
throw(css::uno::RuntimeException)
{
// reject wrong calling of this interface method
css::uno::Reference< css::frame::XDispatchProvider > xThis(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY);
if (!xInterceptor.is())
throw css::uno::RuntimeException(DECLARE_ASCII("NULL references not allowed as in parameter"), xThis);
// Fill a new info structure for new interceptor.
// Save his reference and try to get an additional URL/pattern list from him.
// If no list exist register these interceptor for all dispatch events with "*"!
InterceptorInfo aInfo;
aInfo.xInterceptor = css::uno::Reference< css::frame::XDispatchProvider >(xInterceptor, css::uno::UNO_QUERY);
css::uno::Reference< css::frame::XInterceptorInfo > xInfo(xInterceptor, css::uno::UNO_QUERY);
if (xInfo.is())
aInfo.lURLPattern = xInfo->getInterceptedURLs();
else
{
aInfo.lURLPattern.realloc(1);
aInfo.lURLPattern[0] = ::rtl::OUString("*");
}
// SAFE {
WriteGuard aWriteLock(m_aLock);
// a) no interceptor at all - set this instance as master for given interceptor
// and set our slave as it's slave - and put this interceptor to the list.
// It's place there doesn matter. Because this list is currently empty.
if (m_lInterceptionRegs.empty())
{
xInterceptor->setMasterDispatchProvider(xThis );
xInterceptor->setSlaveDispatchProvider (m_xSlave);
m_lInterceptionRegs.push_back(aInfo);
}
// b) OK - there is at least one interceptor already registered.
// It's slave and it's master must be valid references ...
// because we created it. But we have to look for the static bool which
// regulate direction of using of interceptor objects!
// b1) If "m_bPreferrFirstInterceptor" is set to true, we have to
// insert it behind any other existing interceptor - means at the end of our list.
else if (m_bPreferrFirstInterceptor)
{
css::uno::Reference< css::frame::XDispatchProvider > xMasterD = m_lInterceptionRegs.rbegin()->xInterceptor;
css::uno::Reference< css::frame::XDispatchProviderInterceptor > xMasterI (xMasterD, css::uno::UNO_QUERY);
xInterceptor->setMasterDispatchProvider(xMasterD );
xInterceptor->setSlaveDispatchProvider (m_xSlave );
xMasterI->setSlaveDispatchProvider (aInfo.xInterceptor);
m_lInterceptionRegs.push_back(aInfo);
}
// b2) If "m_bPreferrFirstInterceptor" is set to false, we have to
// insert it before any other existing interceptor - means at the beginning of our list.
else
{
css::uno::Reference< css::frame::XDispatchProvider > xSlaveD = m_lInterceptionRegs.begin()->xInterceptor;
css::uno::Reference< css::frame::XDispatchProviderInterceptor > xSlaveI (xSlaveD , css::uno::UNO_QUERY);
xInterceptor->setMasterDispatchProvider(xThis );
xInterceptor->setSlaveDispatchProvider (xSlaveD );
xSlaveI->setMasterDispatchProvider (aInfo.xInterceptor);
m_lInterceptionRegs.push_front(aInfo);
}
css::uno::Reference< css::frame::XFrame > xOwner(m_xOwnerWeak.get(), css::uno::UNO_QUERY);
aWriteLock.unlock();
// } SAFE
// Don't forget to send a frame action event "context changed".
// Any cached dispatch objects must be validated now!
if (xOwner.is())
xOwner->contextChanged();
}
void SAL_CALL InterceptionHelper::releaseDispatchProviderInterceptor(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
throw(css::uno::RuntimeException)
{
// reject wrong calling of this interface method
css::uno::Reference< css::frame::XDispatchProvider > xThis(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY);
if (!xInterceptor.is())
throw css::uno::RuntimeException(DECLARE_ASCII("NULL references not allowed as in parameter"), xThis);
// SAFE {
WriteGuard aWriteLock(m_aLock);
// search this interceptor ...
// If it could be located inside cache -
// use it's slave/master relations to update the interception list;
// set empty references for it as new master and slave;
// and relase it from out cache.
InterceptorList::iterator pIt = m_lInterceptionRegs.findByReference(xInterceptor);
if (pIt != m_lInterceptionRegs.end())
{
css::uno::Reference< css::frame::XDispatchProvider > xSlaveD (xInterceptor->getSlaveDispatchProvider() , css::uno::UNO_QUERY);
css::uno::Reference< css::frame::XDispatchProvider > xMasterD (xInterceptor->getMasterDispatchProvider(), css::uno::UNO_QUERY);
css::uno::Reference< css::frame::XDispatchProviderInterceptor > xSlaveI (xSlaveD , css::uno::UNO_QUERY);
css::uno::Reference< css::frame::XDispatchProviderInterceptor > xMasterI (xMasterD , css::uno::UNO_QUERY);
if (xMasterI.is())
xMasterI->setSlaveDispatchProvider(xSlaveD);
if (xSlaveI.is())
xSlaveI->setMasterDispatchProvider(xMasterD);
xInterceptor->setSlaveDispatchProvider (css::uno::Reference< css::frame::XDispatchProvider >());
xInterceptor->setMasterDispatchProvider(css::uno::Reference< css::frame::XDispatchProvider >());
m_lInterceptionRegs.erase(pIt);
}
css::uno::Reference< css::frame::XFrame > xOwner(m_xOwnerWeak.get(), css::uno::UNO_QUERY);
aWriteLock.unlock();
// } SAFE
// Don't forget to send a frame action event "context changed".
// Any cached dispatch objects must be validated now!
if (xOwner.is())
xOwner->contextChanged();
}
#define FORCE_DESTRUCTION_OF_INTERCEPTION_CHAIN
void SAL_CALL InterceptionHelper::disposing(const css::lang::EventObject& aEvent)
throw(css::uno::RuntimeException)
{
#ifdef FORCE_DESTRUCTION_OF_INTERCEPTION_CHAIN
// SAFE ->
ReadGuard aReadLock(m_aLock);
// check calli ... we accept such disposing call's only from our onwer frame.
css::uno::Reference< css::frame::XFrame > xOwner(m_xOwnerWeak.get(), css::uno::UNO_QUERY);
if (aEvent.Source != xOwner)
return;
// Because every interceptor hold at least one reference to us ... and we destruct this list
// of interception objects ... we should hold ourself alive .-)
css::uno::Reference< css::frame::XDispatchProvider > xThis(static_cast< ::cppu::OWeakObject* >(this), css::uno::UNO_QUERY_THROW);
// We need a full copy of all currently registered interceptor objects.
// Otherwhise we cant iterate over this vector without the risk, that our iterator will be invalid.
// Because this vetor will be influenced by every deregistered interceptor.
InterceptionHelper::InterceptorList aCopy = m_lInterceptionRegs;
aReadLock.unlock();
// <- SAFE
InterceptionHelper::InterceptorList::iterator pIt;
for ( pIt = aCopy.begin();
pIt != aCopy.end() ;
++pIt )
{
InterceptionHelper::InterceptorInfo& rInfo = *pIt;
if (rInfo.xInterceptor.is())
{
css::uno::Reference< css::frame::XDispatchProviderInterceptor > xInterceptor(rInfo.xInterceptor, css::uno::UNO_QUERY_THROW);
releaseDispatchProviderInterceptor(xInterceptor);
rInfo.xInterceptor.clear();
}
}
aCopy.clear();
#if OSL_DEBUG_LEVEL > 0
// SAFE ->
aReadLock.lock();
if (!m_lInterceptionRegs.empty() )
OSL_FAIL("There are some pending interceptor objects, which seams to be registered during (!) the destruction of a frame.");
aReadLock.unlock();
// <- SAFE
#endif // ODL_DEBUG_LEVEL>0
#endif // FORCE_DESTRUCTION_OF_INTERCEPTION_CHAIN
}
} // namespace framework
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|