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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447 | /* -*- 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 .
*/
#include <formnavigation.hxx>
#include <urltransformer.hxx>
#include <controlfeatureinterception.hxx>
#include <frm_strings.hxx>
#include <com/sun/star/form/runtime/FormFeature.hpp>
#include <tools/debug.hxx>
#include <osl/diagnose.h>
namespace frm
{
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::util;
using namespace ::com::sun::star::frame;
namespace FormFeature = ::com::sun::star::form::runtime::FormFeature;
OFormNavigationHelper::OFormNavigationHelper( const Reference< XComponentContext >& _rxORB )
:m_xORB( _rxORB )
,m_nConnectedFeatures( 0 )
{
m_pFeatureInterception.reset( new ControlFeatureInterception( m_xORB ) );
}
OFormNavigationHelper::~OFormNavigationHelper()
{
}
void OFormNavigationHelper::dispose( )
{
m_pFeatureInterception->dispose();
disconnectDispatchers();
}
void OFormNavigationHelper::interceptorsChanged( )
{
updateDispatches();
}
void OFormNavigationHelper::featureStateChanged( sal_Int16 /*_nFeatureId*/, bool /*_bEnabled*/ )
{
// not interested in
}
void OFormNavigationHelper::allFeatureStatesChanged( )
{
// not interested in
}
void SAL_CALL OFormNavigationHelper::registerDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor )
{
m_pFeatureInterception->registerDispatchProviderInterceptor( _rxInterceptor );
interceptorsChanged();
}
void SAL_CALL OFormNavigationHelper::releaseDispatchProviderInterceptor( const Reference< XDispatchProviderInterceptor >& _rxInterceptor )
{
m_pFeatureInterception->releaseDispatchProviderInterceptor( _rxInterceptor );
interceptorsChanged();
}
void SAL_CALL OFormNavigationHelper::statusChanged( const FeatureStateEvent& _rState )
{
for (auto & feature : m_aSupportedFeatures)
{
if ( feature.second.aURL.Main == _rState.FeatureURL.Main )
{<--- Consider using std::find_if algorithm instead of a raw loop.
if ( ( feature.second.bCachedState != bool(_rState.IsEnabled) )
|| ( feature.second.aCachedAdditionalState != _rState.State )
)
{
// change the cached state
feature.second.bCachedState = _rState.IsEnabled;
feature.second.aCachedAdditionalState = _rState.State;
// tell derivees what happened
featureStateChanged( feature.first, _rState.IsEnabled );
}
return;
}
}
// unreachable
OSL_FAIL( "OFormNavigationHelper::statusChanged: huh? An invalid/unknown URL?" );
}
void SAL_CALL OFormNavigationHelper::disposing( const EventObject& _rSource )
{
// was it one of our external dispatchers?
if ( !m_nConnectedFeatures )
return;
for (auto & feature : m_aSupportedFeatures)
{
if ( feature.second.xDispatcher == _rSource.Source )
{<--- Consider using std::find_if algorithm instead of a raw loop.
feature.second.xDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
feature.second.xDispatcher = nullptr;
feature.second.bCachedState = false;
feature.second.aCachedAdditionalState.clear();
--m_nConnectedFeatures;
featureStateChanged( feature.first, false );
break;
}
}
}
void OFormNavigationHelper::updateDispatches()
{
if ( !m_nConnectedFeatures )
{ // we don't have any dispatchers yet -> do the initial connect
connectDispatchers();
return;
}
initializeSupportedFeatures();
m_nConnectedFeatures = 0;
Reference< XDispatch > xNewDispatcher;
Reference< XDispatch > xCurrentDispatcher;
for (auto & feature : m_aSupportedFeatures)
{
xNewDispatcher = queryDispatch( feature.second.aURL );
xCurrentDispatcher = feature.second.xDispatcher;
if ( xNewDispatcher != xCurrentDispatcher )
{
// the dispatcher for this particular URL changed
if ( xCurrentDispatcher.is() )
xCurrentDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
xCurrentDispatcher = feature.second.xDispatcher = xNewDispatcher;
if ( xCurrentDispatcher.is() )
xCurrentDispatcher->addStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
}
if ( xCurrentDispatcher.is() )
++m_nConnectedFeatures;
else
feature.second.bCachedState = false;
}
// notify derivee that (potentially) all features changed their state
allFeatureStatesChanged( );
}
void OFormNavigationHelper::connectDispatchers()
{
if ( m_nConnectedFeatures )
{ // already connected -> just do an update
updateDispatches();
return;
}
initializeSupportedFeatures();
m_nConnectedFeatures = 0;
for (auto & feature : m_aSupportedFeatures)
{
feature.second.bCachedState = false;
feature.second.aCachedAdditionalState.clear();
feature.second.xDispatcher = queryDispatch( feature.second.aURL );
if ( feature.second.xDispatcher.is() )
{
++m_nConnectedFeatures;
feature.second.xDispatcher->addStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
}
}
// notify derivee that (potentially) all features changed their state
allFeatureStatesChanged( );
}
void OFormNavigationHelper::disconnectDispatchers()
{
if ( m_nConnectedFeatures )
{
for (auto & feature : m_aSupportedFeatures)
{
if ( feature.second.xDispatcher.is() )
feature.second.xDispatcher->removeStatusListener( static_cast< XStatusListener* >( this ), feature.second.aURL );
feature.second.xDispatcher = nullptr;
feature.second.bCachedState = false;
feature.second.aCachedAdditionalState.clear();
}
m_nConnectedFeatures = 0;
}
// notify derivee that (potentially) all features changed their state
allFeatureStatesChanged( );
}
void OFormNavigationHelper::initializeSupportedFeatures( )
{
if ( !m_aSupportedFeatures.empty() )
return;
// ask the derivee which feature ids it wants us to support
::std::vector< sal_Int16 > aFeatureIds;
getSupportedFeatures( aFeatureIds );
OFormNavigationMapper aUrlMapper( m_xORB );
for (auto const& feature : aFeatureIds)
{
FeatureInfo aFeatureInfo;
bool bKnownId =
aUrlMapper.getFeatureURL( feature, aFeatureInfo.aURL );
DBG_ASSERT( bKnownId, "OFormNavigationHelper::initializeSupportedFeatures: unknown feature id!" );
if ( bKnownId )
// add to our map
m_aSupportedFeatures.emplace( feature, aFeatureInfo );
}
}
Reference< XDispatch > OFormNavigationHelper::queryDispatch( const URL& _rURL )
{
return m_pFeatureInterception->queryDispatch( _rURL );
}
void OFormNavigationHelper::dispatchWithArgument( sal_Int16 _nFeatureId, const char* _pParamAsciiName,
const Any& _rParamValue ) const
{
FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
if ( m_aSupportedFeatures.end() != aInfo )
{
if ( aInfo->second.xDispatcher.is() )
{
Sequence< PropertyValue > aArgs( 1 );
aArgs[0].Name = OUString::createFromAscii( _pParamAsciiName );
aArgs[0].Value = _rParamValue;
aInfo->second.xDispatcher->dispatch( aInfo->second.aURL, aArgs );
}
}
}
void OFormNavigationHelper::dispatch( sal_Int16 _nFeatureId ) const
{
FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
if ( m_aSupportedFeatures.end() != aInfo )
{
if ( aInfo->second.xDispatcher.is() )
{
Sequence< PropertyValue > aEmptyArgs;
aInfo->second.xDispatcher->dispatch( aInfo->second.aURL, aEmptyArgs );
}
}
}
bool OFormNavigationHelper::isEnabled( sal_Int16 _nFeatureId ) const
{
FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
if ( m_aSupportedFeatures.end() != aInfo )
return aInfo->second.bCachedState;
return false;
}
bool OFormNavigationHelper::getBooleanState( sal_Int16 _nFeatureId ) const
{
bool bState = false;
FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
if ( m_aSupportedFeatures.end() != aInfo )
aInfo->second.aCachedAdditionalState >>= bState;
return bState;
}
OUString OFormNavigationHelper::getStringState( sal_Int16 _nFeatureId ) const
{
OUString sState;
FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
if ( m_aSupportedFeatures.end() != aInfo )
aInfo->second.aCachedAdditionalState >>= sState;
return sState;
}
sal_Int32 OFormNavigationHelper::getIntegerState( sal_Int16 _nFeatureId ) const
{
sal_Int32 nState = 0;
FeatureMap::const_iterator aInfo = m_aSupportedFeatures.find( _nFeatureId );
if ( m_aSupportedFeatures.end() != aInfo )
aInfo->second.aCachedAdditionalState >>= nState;
return nState;
}
void OFormNavigationHelper::invalidateSupportedFeaturesSet()
{
disconnectDispatchers( );
// no supported features anymore:
FeatureMap aEmpty;
m_aSupportedFeatures.swap( aEmpty );
}
OFormNavigationMapper::OFormNavigationMapper( const Reference< XComponentContext >& _rxORB )
{
m_pUrlTransformer.reset( new UrlTransformer( _rxORB ) );
}
OFormNavigationMapper::~OFormNavigationMapper( )
{
}
bool OFormNavigationMapper::getFeatureURL( sal_Int16 _nFeatureId, URL& /* [out] */ _rURL )
{
// get the ascii version of the URL
const char* pAsciiURL = getFeatureURLAscii( _nFeatureId );
if ( pAsciiURL )
_rURL = m_pUrlTransformer->getStrictURLFromAscii( pAsciiURL );
return ( pAsciiURL != nullptr );
}
namespace
{
struct FeatureURL
{
const sal_Int16 nFormFeature;
const char* pAsciiURL;
FeatureURL( const sal_Int16 _nFormFeature, const char* _pAsciiURL )
:nFormFeature( _nFormFeature )
,pAsciiURL( _pAsciiURL )
{
}
};
const FeatureURL* lcl_getFeatureTable()
{
static const FeatureURL s_aFeatureURLs[] =
{
FeatureURL( FormFeature::MoveAbsolute, URL_FORM_POSITION ),
FeatureURL( FormFeature::TotalRecords, URL_FORM_RECORDCOUNT ),
FeatureURL( FormFeature::MoveToFirst, URL_RECORD_FIRST ),
FeatureURL( FormFeature::MoveToPrevious, URL_RECORD_PREV ),
FeatureURL( FormFeature::MoveToNext, URL_RECORD_NEXT ),
FeatureURL( FormFeature::MoveToLast, URL_RECORD_LAST ),
FeatureURL( FormFeature::SaveRecordChanges, URL_RECORD_SAVE ),
FeatureURL( FormFeature::UndoRecordChanges, URL_RECORD_UNDO ),
FeatureURL( FormFeature::MoveToInsertRow, URL_RECORD_NEW ),
FeatureURL( FormFeature::DeleteRecord, URL_RECORD_DELETE ),
FeatureURL( FormFeature::ReloadForm, URL_FORM_REFRESH ),
FeatureURL( FormFeature::RefreshCurrentControl, URL_FORM_REFRESH_CURRENT_CONTROL ),
FeatureURL( FormFeature::SortAscending, URL_FORM_SORT_UP ),
FeatureURL( FormFeature::SortDescending, URL_FORM_SORT_DOWN ),
FeatureURL( FormFeature::InteractiveSort, URL_FORM_SORT ),
FeatureURL( FormFeature::AutoFilter, URL_FORM_AUTO_FILTER ),
FeatureURL( FormFeature::InteractiveFilter, URL_FORM_FILTER ),
FeatureURL( FormFeature::ToggleApplyFilter, URL_FORM_APPLY_FILTER ),
FeatureURL( FormFeature::RemoveFilterAndSort, URL_FORM_REMOVE_FILTER ),
FeatureURL( 0, nullptr )
};
return s_aFeatureURLs;
}
}
const char* OFormNavigationMapper::getFeatureURLAscii( sal_Int16 _nFeatureId )
{
const FeatureURL* pFeatures = lcl_getFeatureTable();
while ( pFeatures->pAsciiURL )
{
if ( pFeatures->nFormFeature == _nFeatureId )
return pFeatures->pAsciiURL;
++pFeatures;
}
return nullptr;
}
sal_Int16 OFormNavigationMapper::getFeatureId( const OUString& _rCompleteURL )
{
const FeatureURL* pFeatures = lcl_getFeatureTable();
while ( pFeatures->pAsciiURL )
{
if ( _rCompleteURL.equalsAscii( pFeatures->pAsciiURL ) )
return pFeatures->nFormFeature;
++pFeatures;
}
return -1;
}
} // namespace frm
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|