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
|
/* -*- 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_FRAMEWORK_INC_DISPATCH_INTERCEPTIONHELPER_HXX
#define INCLUDED_FRAMEWORK_INC_DISPATCH_INTERCEPTIONHELPER_HXX
#include <macros/xinterface.hxx>
#include <general.h>
#include <com/sun/star/frame/XDispatchProviderInterception.hpp>
#include <com/sun/star/frame/XDispatchProviderInterceptor.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/DispatchDescriptor.hpp>
#include <tools/wldcrd.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/weakref.hxx>
#include <deque>
namespace framework{
/** @short implements a helper to support interception with additional functionality.
@descr This helper implements the complete XDispatchProviderInterception interface with
master/slave functionality AND using of optional features like registration of URL pattern!
@attention Don't use this class as direct member - use it dynamicly. Do not derive from this class.
We hold a weakreference to our owner not to our superclass.
*/
class InterceptionHelper : public ::cppu::WeakImplHelper<
css::frame::XDispatchProvider,
css::frame::XDispatchProviderInterception,
css::lang::XEventListener >
{
// structs, helper
/** @short bind an interceptor component to its URL pattern registration. */
struct InterceptorInfo
{
/** @short reference to the interceptor component. */
css::uno::Reference< css::frame::XDispatchProvider > xInterceptor;
/** @short it's registration for URL patterns.
@descr If the interceptor component does not support the optional interface
XInterceptorInfo, it will be registered for one pattern "*" by default.
That would make it possible to handle it in the same manner then real
registered interceptor objects and we must not implement any special code. */
css::uno::Sequence< OUString > lURLPattern;
};
/** @short implements a list of items of type InterceptorInfo, and provides some special
functions on it.
@descr Because interceptor objects can be registered for URL patterns,
it supports a wildcard search on all list items.
*/
class InterceptorList : public ::std::deque< InterceptorInfo >
{
public:
/** @short search for an interceptor inside this list using it's reference.
@param xInterceptor
points to the interceptor object, which should be located inside this list.
@return An iterator object, which points directly to the located item inside this list.
In case no interceptor could be found, it points to the end of this list!
*/
iterator findByReference(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
{
css::uno::Reference< css::frame::XDispatchProviderInterceptor > xProviderInterface(xInterceptor, css::uno::UNO_QUERY);
iterator pIt;
for (pIt=begin(); pIt!=end(); ++pIt)
{
if (pIt->xInterceptor == xProviderInterface)
return pIt;
}
return end();
}
/** @short search for an interceptor inside this list using it's reference.
@param xInterceptor
points to the interceptor object, which should be located inside this list.
@return An iterator object, which points directly to the located item inside this list.
In case no interceptor could be found, it points to the end of this list!
*/
iterator findByPattern(const OUString& sURL)
{
iterator pIt;
for (pIt=begin(); pIt!=end(); ++pIt)
{
sal_Int32 c = pIt->lURLPattern.getLength();
const OUString* pPattern = pIt->lURLPattern.getConstArray();
for (sal_Int32 i=0; i<c; ++i)
{
WildCard aPattern(pPattern[i]);
if (aPattern.Matches(sURL))
return pIt;
}
}
return end();
}
};
// member
private:
/** @short reference to the frame, which uses this instance to implement it's own interception.
@descr We hold a weak reference only, to make disposing operations easy. */
css::uno::WeakReference< css::frame::XFrame > m_xOwnerWeak;
/** @short this interception helper implements the top level master of an interceptor list ...
but this member is the lowest possible slave! */
css::uno::Reference< css::frame::XDispatchProvider > m_xSlave;
/** @short contains all registered interceptor objects. */
InterceptorList m_lInterceptionRegs;
// native interface
public:
/** @short creates a new interception helper instance.
@param xOwner
points to the frame, which use this instances to support it's own interception interfaces.
@param xSlave
an outside creates dispatch provider, which has to be used here as lowest slave "interceptor".
*/
InterceptionHelper(const css::uno::Reference< css::frame::XFrame >& xOwner,
const css::uno::Reference< css::frame::XDispatchProvider >& xSlave);
protected:
/** @short standard destructor.
@descr This method destruct an instance of this class and clear some member.
This method is protected, because its not allowed to use this class as a direct member!
You MUST use a dynamical instance (pointer). That's the reason for a protected dtor.
*/
virtual ~InterceptionHelper() override;
// uno interface
public:
// XDispatchProvider
/** @short query for a dispatch, which implements the requested feature.
@descr We search inside our list of interception registrations, to locate
any interested interceptor. In case no interceptor exists or nobody is
interested on this URL our lowest slave will be used.
@param aURL
describes the requested dispatch functionality.
@param sTargetFrameName
the name of the target frame or a special name like "_blank", "_top" ...
Won't be used here ... but may by one of our registered interceptor objects
or our slave.
@param nSearchFlags
optional search parameter for targeting, if sTargetFrameName isn't a special one.
@return A valid dispatch object, if any interceptor or at least our slave is interested on the given URL;
or NULL otherwise.
*/
virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch(const css::util::URL& aURL ,
const OUString& sTargetFrameName,
sal_Int32 nSearchFlags )
throw(css::uno::RuntimeException, std::exception) override;
// XDispatchProvider
/** @short implements an optimized queryDispatch() for remote.
@descr It capsulate more than one queryDispatch() requests and return a lits of dispatch objects
as result. Because both lists (in and out) correspond together, it's not allowed to
pack it - means suppress NULL references!
@param lDescriptor
a list of queryDispatch() arguments.
@return A list of dispatch objects.
*/
virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches(const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor)
throw(css::uno::RuntimeException, std::exception) override;
// XDispatchProviderInterception
/** @short register an interceptor.
@descr Somebody can register himself to intercept all or some special dispatches.
It's depend from his supported interfaces. If he implement XInterceptorInfo
he his called for some special URLs only - otherwise we call it for every request!
@attention We don't check for double registrations here!
@param xInterceptor
reference to interceptor, which wish to be registered here.
@throw A RuntimeException if the given reference is NULL!
*/
virtual void SAL_CALL registerDispatchProviderInterceptor(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
throw(css::uno::RuntimeException, std::exception) override;
// XDispatchProviderInterception
/** @short release an interceptor.
@descr Remove the registered interceptor from our internal list
and delete all special information about it.
@param xInterceptor
reference to the interceptor, which wish to be deregistered.
@throw A RuntimeException if the given reference is NULL!
*/
virtual void SAL_CALL releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor ) throw( css::uno::RuntimeException, std::exception ) override;
// XEventListener
/** @short Is called from our owner frame, in case he will be disposed.
@descr We have to release all references to him then.
Normally we will die by ref count too...
*/
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
throw(css::uno::RuntimeException, std::exception) override;
}; // class InterceptionHelper
} // namespace framework
#endif // INCLUDED_FRAMEWORK_INC_DISPATCH_INTERCEPTIONHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
