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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
|
/* -*- 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 <editeng/AccessibleContextBase.hxx>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <com/sun/star/beans/PropertyChangeEvent.hpp>
#include <com/sun/star/accessibility/XAccessibleEventListener.hpp>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/accessibility/AccessibleRelationType.hpp>
#include <unotools/accessiblestatesethelper.hxx>
#include <unotools/accessiblerelationsethelper.hxx>
#include <comphelper/accessibleeventnotifier.hxx>
#include <comphelper/servicehelper.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <osl/mutex.hxx>
#include <utility>
using namespace ::com::sun::star;
using namespace ::com::sun::star::accessibility;
using ::com::sun::star::uno::Reference;
namespace accessibility {
// internal
AccessibleContextBase::AccessibleContextBase (
const uno::Reference<XAccessible>& rxParent,
const sal_Int16 aRole)
: WeakComponentImplHelper(MutexOwner::maMutex),
mxStateSet (nullptr),
mxRelationSet (nullptr),
mxParent(rxParent),
msDescription(),
meDescriptionOrigin(NotSet),
msName(),
meNameOrigin(NotSet),
mnClientId(0),
maRole(aRole)
{
// Create the state set.
::utl::AccessibleStateSetHelper* pStateSet = new ::utl::AccessibleStateSetHelper ();
mxStateSet = pStateSet;
// Set some states. Don't use the SetState method because no events
// shall be broadcastet (that is not yet initialized anyway).
pStateSet->AddState (AccessibleStateType::ENABLED);
pStateSet->AddState (AccessibleStateType::SENSITIVE);
pStateSet->AddState (AccessibleStateType::SHOWING);
pStateSet->AddState (AccessibleStateType::VISIBLE);
pStateSet->AddState (AccessibleStateType::FOCUSABLE);
pStateSet->AddState (AccessibleStateType::SELECTABLE);
// Create the relation set.
::utl::AccessibleRelationSetHelper* pRelationSet = new ::utl::AccessibleRelationSetHelper ();
mxRelationSet = pRelationSet;
}
AccessibleContextBase::~AccessibleContextBase()
{
}
bool AccessibleContextBase::SetState (sal_Int16 aState)
{
::osl::ClearableMutexGuard aGuard (maMutex);
::utl::AccessibleStateSetHelper* pStateSet =
static_cast< ::utl::AccessibleStateSetHelper*>(mxStateSet.get());
if ((pStateSet != nullptr) && !pStateSet->contains(aState))
{
pStateSet->AddState (aState);
// Clear the mutex guard so that it is not locked during calls to
// listeners.
aGuard.clear();
// Send event for all states except the DEFUNC state.
if (aState != AccessibleStateType::DEFUNC)
{
uno::Any aNewValue;
aNewValue <<= aState;
CommitChange(
AccessibleEventId::STATE_CHANGED,
aNewValue,
uno::Any());
}
return true;
}
else
return false;
}
bool AccessibleContextBase::ResetState (sal_Int16 aState)
{
::osl::ClearableMutexGuard aGuard (maMutex);
::utl::AccessibleStateSetHelper* pStateSet =
static_cast< ::utl::AccessibleStateSetHelper*>(mxStateSet.get());
if ((pStateSet != nullptr) && pStateSet->contains(aState))
{
pStateSet->RemoveState (aState);
// Clear the mutex guard so that it is not locked during calls to listeners.
aGuard.clear();
uno::Any aOldValue;
aOldValue <<= aState;
CommitChange(
AccessibleEventId::STATE_CHANGED,
uno::Any(),
aOldValue);
return true;
}
else
return false;
}
bool AccessibleContextBase::GetState (sal_Int16 aState)
{
::osl::MutexGuard aGuard (maMutex);
::utl::AccessibleStateSetHelper* pStateSet =
static_cast< ::utl::AccessibleStateSetHelper*>(mxStateSet.get());
if (pStateSet != nullptr)
return pStateSet->contains(aState);
else
// If there is no state set then return false as a default value.
return false;
}
void AccessibleContextBase::SetRelationSet (
const uno::Reference<XAccessibleRelationSet>& rxNewRelationSet)
throw (css::uno::RuntimeException)
{
OSL_TRACE ("setting relation set");
// Try to emit some meaningfull events indicating differing relations in
// both sets.
typedef std::pair<short int,short int> RD;
const RD aRelationDescriptors[] = {
RD(AccessibleRelationType::CONTROLLED_BY, AccessibleEventId::CONTROLLED_BY_RELATION_CHANGED),
RD(AccessibleRelationType::CONTROLLER_FOR, AccessibleEventId::CONTROLLER_FOR_RELATION_CHANGED),
RD(AccessibleRelationType::LABELED_BY, AccessibleEventId::LABELED_BY_RELATION_CHANGED),
RD(AccessibleRelationType::LABEL_FOR, AccessibleEventId::LABEL_FOR_RELATION_CHANGED),
RD(AccessibleRelationType::MEMBER_OF, AccessibleEventId::MEMBER_OF_RELATION_CHANGED),
RD(AccessibleRelationType::INVALID, -1),
};
for (int i=0; aRelationDescriptors[i].first!=AccessibleRelationType::INVALID; i++)
if (mxRelationSet->containsRelation(aRelationDescriptors[i].first)
!= rxNewRelationSet->containsRelation(aRelationDescriptors[i].first))
CommitChange (aRelationDescriptors[i].second, uno::Any(), uno::Any());
mxRelationSet = rxNewRelationSet;
}
// XAccessible
uno::Reference< XAccessibleContext> SAL_CALL
AccessibleContextBase::getAccessibleContext()
throw (uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
return this;
}
// XAccessibleContext
/** No children.
*/
sal_Int32 SAL_CALL
AccessibleContextBase::getAccessibleChildCount()
throw (uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
return 0;
}
/** Forward the request to the shape. Return the requested shape or throw
an exception for a wrong index.
*/
uno::Reference<XAccessible> SAL_CALL
AccessibleContextBase::getAccessibleChild (sal_Int32 nIndex)
throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
throw lang::IndexOutOfBoundsException (
"no child with index " + OUString::number(nIndex),
nullptr);
}
uno::Reference<XAccessible> SAL_CALL
AccessibleContextBase::getAccessibleParent()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
return mxParent;
}
sal_Int32 SAL_CALL
AccessibleContextBase::getAccessibleIndexInParent()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
// Use a simple but slow solution for now. Optimize later.
// Iterate over all the parent's children and search for this object.
if (mxParent.is())
{
uno::Reference<XAccessibleContext> xParentContext (
mxParent->getAccessibleContext());
if (xParentContext.is())
{
sal_Int32 nChildCount = xParentContext->getAccessibleChildCount();
for (sal_Int32 i=0; i<nChildCount; i++)
{
uno::Reference<XAccessible> xChild (xParentContext->getAccessibleChild (i));
if (xChild.is())
{
uno::Reference<XAccessibleContext> xChildContext = xChild->getAccessibleContext();
if (xChildContext == static_cast<XAccessibleContext*>(this))
return i;
}
}
}
}
// Return -1 to indicate that this object's parent does not know about the
// object.
return -1;
}
sal_Int16 SAL_CALL
AccessibleContextBase::getAccessibleRole()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
return maRole;
}
OUString SAL_CALL
AccessibleContextBase::getAccessibleDescription()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
return msDescription;
}
OUString SAL_CALL
AccessibleContextBase::getAccessibleName()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
if (meNameOrigin == NotSet)
{
// Do not send an event because this is the first time it has been
// requested.
msName = CreateAccessibleName();
meNameOrigin = AutomaticallyCreated;
}
return msName;
}
/** Return a copy of the relation set.
*/
uno::Reference<XAccessibleRelationSet> SAL_CALL
AccessibleContextBase::getAccessibleRelationSet()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
// Create a copy of the relation set and return it.
::utl::AccessibleRelationSetHelper* pRelationSet =
static_cast< ::utl::AccessibleRelationSetHelper*>(mxRelationSet.get());
if (pRelationSet != nullptr)
{
return uno::Reference<XAccessibleRelationSet> (
new ::utl::AccessibleRelationSetHelper (*pRelationSet));
}
else
return uno::Reference<XAccessibleRelationSet>(nullptr);
}
/** Return a copy of the state set.
Possible states are:
ENABLED
SHOWING
VISIBLE
*/
uno::Reference<XAccessibleStateSet> SAL_CALL
AccessibleContextBase::getAccessibleStateSet()
throw (css::uno::RuntimeException, std::exception)
{
::utl::AccessibleStateSetHelper* pStateSet = nullptr;
if (rBHelper.bDisposed)
{
// We are already disposed!
// Create a new state set that has only set the DEFUNC state.
pStateSet = new ::utl::AccessibleStateSetHelper ();
pStateSet->AddState (AccessibleStateType::DEFUNC);
}
else
{
// Create a copy of the state set and return it.
pStateSet = static_cast< ::utl::AccessibleStateSetHelper*>(mxStateSet.get());
// Merge current focused state from edit engine.
#if 0
if (aState == AccessibleStateType::FOCUSED
&& pStateSet != NULL
&& mpText != NULL)
{
if (mpText->GetFocusedState ())
pStateSet->AddState (aState);
else
pStateSet->RemoveState (aState);
}
#endif
if (pStateSet != nullptr)
pStateSet = new ::utl::AccessibleStateSetHelper (*pStateSet);
}
return uno::Reference<XAccessibleStateSet>(pStateSet);
}
lang::Locale SAL_CALL
AccessibleContextBase::getLocale()
throw (IllegalAccessibleComponentStateException,
css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
// Delegate request to parent.
if (mxParent.is())
{
uno::Reference<XAccessibleContext> xParentContext (
mxParent->getAccessibleContext());
if (xParentContext.is())
return xParentContext->getLocale ();
}
// No locale and no parent. Therefore throw exception to indicate this
// cluelessness.
throw IllegalAccessibleComponentStateException ();
}
// XAccessibleEventListener
void SAL_CALL AccessibleContextBase::addAccessibleEventListener (
const uno::Reference<XAccessibleEventListener >& rxListener)
throw (uno::RuntimeException, std::exception)
{
if (rxListener.is())
{
if (rBHelper.bDisposed || rBHelper.bInDispose)
{
uno::Reference<uno::XInterface> x (static_cast<lang::XComponent *>(this), uno::UNO_QUERY);
rxListener->disposing (lang::EventObject (x));
}
else
{
if (!mnClientId)
mnClientId = comphelper::AccessibleEventNotifier::registerClient( );
comphelper::AccessibleEventNotifier::addEventListener( mnClientId, rxListener );
}
}
}
void SAL_CALL AccessibleContextBase::removeAccessibleEventListener (
const uno::Reference<XAccessibleEventListener >& rxListener )
throw (uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
if (rxListener.is())
{
sal_Int32 nListenerCount = comphelper::AccessibleEventNotifier::removeEventListener( mnClientId, rxListener );
if ( !nListenerCount )
{
// no listeners anymore
// -> revoke ourself. This may lead to the notifier thread dying (if we were the last client),
// and at least to us not firing any events anymore, in case somebody calls
// NotifyAccessibleEvent, again
comphelper::AccessibleEventNotifier::revokeClient( mnClientId );
mnClientId = 0;
}
}
}
// XServiceInfo
OUString SAL_CALL AccessibleContextBase::getImplementationName()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
return OUString("AccessibleContextBase");
}
sal_Bool SAL_CALL AccessibleContextBase::supportsService (const OUString& sServiceName)
throw (css::uno::RuntimeException, std::exception)
{
return cppu::supportsService(this, sServiceName);
}
uno::Sequence< OUString > SAL_CALL
AccessibleContextBase::getSupportedServiceNames()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
static const OUString sServiceNames[2] = {
OUString("com.sun.star.accessibility.Accessible"),
OUString("com.sun.star.accessibility.AccessibleContext")
};
return uno::Sequence<OUString> (sServiceNames, 2);
}
// XTypeProvider
uno::Sequence< css::uno::Type>
AccessibleContextBase::getTypes()
throw (css::uno::RuntimeException, std::exception)
{
ThrowIfDisposed ();
// This class supports no interfaces on its own. Just return those
// supported by the base class.
return WeakComponentImplHelper::getTypes();
}
uno::Sequence<sal_Int8> SAL_CALL
AccessibleContextBase::getImplementationId()
throw (css::uno::RuntimeException, std::exception)
{
return css::uno::Sequence<sal_Int8>();
}
// internal
void SAL_CALL AccessibleContextBase::disposing()
{
SetState (AccessibleStateType::DEFUNC);
::osl::MutexGuard aGuard (maMutex);
// Send a disposing to all listeners.
if ( mnClientId )
{
comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing( mnClientId, *this );
mnClientId = 0;
}
}
void AccessibleContextBase::SetAccessibleDescription (
const OUString& rDescription,
StringOrigin eDescriptionOrigin)
throw (uno::RuntimeException)
{
if (eDescriptionOrigin < meDescriptionOrigin
|| (eDescriptionOrigin == meDescriptionOrigin && msDescription != rDescription))
{
uno::Any aOldValue, aNewValue;
aOldValue <<= msDescription;
aNewValue <<= rDescription;
msDescription = rDescription;
meDescriptionOrigin = eDescriptionOrigin;
CommitChange(
AccessibleEventId::DESCRIPTION_CHANGED,
aNewValue,
aOldValue);
}
}
void AccessibleContextBase::SetAccessibleName (
const OUString& rName,
StringOrigin eNameOrigin)
throw (uno::RuntimeException)
{
if (eNameOrigin < meNameOrigin
|| (eNameOrigin == meNameOrigin && msName != rName))
{
uno::Any aOldValue, aNewValue;
aOldValue <<= msName;
aNewValue <<= rName;
msName = rName;
meNameOrigin = eNameOrigin;
CommitChange(
AccessibleEventId::NAME_CHANGED,
aNewValue,
aOldValue);
}
}
OUString AccessibleContextBase::CreateAccessibleDescription()
throw (css::uno::RuntimeException, std::exception)
{
return OUString("Empty Description");
}
OUString AccessibleContextBase::CreateAccessibleName()
throw (css::uno::RuntimeException, std::exception)
{
return OUString("Empty Name");
}
void AccessibleContextBase::CommitChange (
sal_Int16 nEventId,
const uno::Any& rNewValue,
const uno::Any& rOldValue)
{
// Do not call FireEvent and do not even create the event object when no
// listener has been registered yet. Creating the event object can
// otherwise lead to a crash. See issue 93419 for details.
if (mnClientId != 0)
{
AccessibleEventObject aEvent (
static_cast<XAccessibleContext*>(this),
nEventId,
rNewValue,
rOldValue);
FireEvent (aEvent);
}
}
void AccessibleContextBase::FireEvent (const AccessibleEventObject& aEvent)
{
if (mnClientId)
comphelper::AccessibleEventNotifier::addEvent( mnClientId, aEvent );
}
void AccessibleContextBase::ThrowIfDisposed()
throw (css::lang::DisposedException)
{
if (rBHelper.bDisposed || rBHelper.bInDispose)
{
OSL_TRACE ("Calling disposed object. Throwing exception:");
throw lang::DisposedException ("object has been already disposed",
static_cast<uno::XWeak*>(this));
}
}
bool AccessibleContextBase::IsDisposed()
{
return (rBHelper.bDisposed || rBHelper.bInDispose);
}
void AccessibleContextBase::SetAccessibleRole( sal_Int16 _nRole )
{
maRole = _nRole;
}
} // end of namespace accessibility
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|