sc/source/ui/Accessibility/AccessibleContextBase.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <AccessibleContextBase.hxx>
  21 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  22 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  23 #include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp>
  24 #include <tools/gen.hxx>
  25 #include <tools/color.hxx>
  26 #include <toolkit/helper/vclunohelper.hxx>
  27 #include <svl/hint.hxx>
  28 #include <comphelper/sequence.hxx>
  29 #include <cppuhelper/supportsservice.hxx>
  30 #include <unotools/accessiblerelationsethelper.hxx>
  31 #include <utility>
  32 #include <vcl/unohelp.hxx>
  33 #include <comphelper/accessibleeventnotifier.hxx>
  34 #include <vcl/svapp.hxx>
  35
  36 using namespace ::com::sun::star;
  37 using namespace ::com::sun::star::accessibility;
  38
  39 /**
  40  The listener is an internal class to prevent reference-counting cycles and therefore memory leaks.
  41 */
  42 typedef cppu::WeakComponentImplHelper<
  43                 css::accessibility::XAccessibleEventListener
  44                 > ScAccessibleContextBaseEventListenerWeakImpl;
  45 class ScAccessibleContextBase::ScAccessibleContextBaseEventListener : public cppu::BaseMutex, public ScAccessibleContextBaseEventListenerWeakImpl
  46 {
  47 public:
  48     ScAccessibleContextBaseEventListener(ScAccessibleContextBase& rBase)
  49         : ScAccessibleContextBaseEventListenerWeakImpl(m_aMutex), mrBase(rBase) {}
  50
  51     using WeakComponentImplHelperBase::disposing;
  52
  53     ///=====  XAccessibleEventListener  ========================================
  54
  55     virtual void SAL_CALL disposing( const lang::EventObject& rSource ) override
  56     {
  57         SolarMutexGuard aGuard;
  58         if (rSource.Source == mrBase.mxParent)
  59             dispose();
  60     }
  61
  62     virtual void SAL_CALL
  63         notifyEvent(
  64         const css::accessibility::AccessibleEventObject& /*aEvent*/ ) override {}
  65 private:
  66     ScAccessibleContextBase& mrBase;
  67 };
  68
  69
  70 ScAccessibleContextBase::ScAccessibleContextBase(
  71                                                  uno::Reference<XAccessible> xParent,
  72                                                  const sal_Int16 aRole)
  73                                                  :
  74     ScAccessibleContextBaseWeakImpl(m_aMutex),
  75     mxParent(std::move(xParent)),
  76     mnClientId(0),
  77     maRole(aRole)
  78 {
  79 }
  80
  81 ScAccessibleContextBase::~ScAccessibleContextBase()
  82 {
  83     if (!IsDefunc() && !rBHelper.bInDispose)
  84     {
  85         // increment refcount to prevent double call off dtor
  86         osl_atomic_increment( &m_refCount );
  87         // call dispose to inform object which have a weak reference to this object
  88         dispose();
  89     }
  90 }
  91
  92 void ScAccessibleContextBase::Init()
  93 {
  94     // hold reference to make sure that the destructor is not called
  95     uno::Reference< XAccessibleContext > xKeepAlive(this);
  96
  97     if (mxParent.is())
  98     {
  99         uno::Reference< XAccessibleEventBroadcaster > xBroadcaster (mxParent->getAccessibleContext(), uno::UNO_QUERY);
 100         if (xBroadcaster.is())
 101         {
 102             if (!mxEventListener)
 103                 mxEventListener = new ScAccessibleContextBaseEventListener(*this);
 104             xBroadcaster->addAccessibleEventListener(mxEventListener);
 105         }
 106     }
 107     msName = createAccessibleName();
 108     msDescription = createAccessibleDescription();
 109 }
 110
 111 void SAL_CALL ScAccessibleContextBase::disposing()
 112 {
 113     SolarMutexGuard aGuard;
 114 //  CommitDefunc(); not necessary and should not be send, because it cost a lot of time
 115
 116     // hold reference to make sure that the destructor is not called
 117     uno::Reference< XAccessibleContext > xKeepAlive(this);
 118
 119     if ( mnClientId )
 120     {
 121         sal_Int32 nTemClientId(mnClientId);
 122         mnClientId =  0;
 123         comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing( nTemClientId, *this );
 124     }
 125
 126     if (mxParent.is())
 127     {
 128         uno::Reference< XAccessibleEventBroadcaster > xBroadcaster (mxParent->getAccessibleContext(), uno::UNO_QUERY);
 129         if (xBroadcaster && mxEventListener)
 130             xBroadcaster->removeAccessibleEventListener(mxEventListener);
 131         mxParent = nullptr;
 132     }
 133 }
 134
 135
 136 //=====  SfxListener  =====================================================
 137
 138 void ScAccessibleContextBase::Notify( SfxBroadcaster&, const SfxHint& rHint )
 139 {
 140     if (rHint.GetId() == SfxHintId::Dying)
 141     {
 142         // it seems the Broadcaster is dying, since the view is dying
 143         dispose();
 144     }
 145 }
 146
 147 //=====  XAccessible  =========================================================
 148
 149 uno::Reference< XAccessibleContext> SAL_CALL
 150     ScAccessibleContextBase::getAccessibleContext()
 151 {
 152     return this;
 153 }
 154
 155 //=====  XAccessibleComponent  ================================================
 156
 157 sal_Bool SAL_CALL ScAccessibleContextBase::containsPoint(const awt::Point& rPoint )
 158 {
 159     SolarMutexGuard aGuard;
 160     IsObjectValid();
 161     return tools::Rectangle(Point(), GetBoundingBox().GetSize())
 162         .Contains(vcl::unohelper::ConvertToVCLPoint(rPoint));
 163 }
 164
 165 uno::Reference< XAccessible > SAL_CALL ScAccessibleContextBase::getAccessibleAtPoint(
 166         const awt::Point& /* rPoint */ )
 167 {
 168     OSL_FAIL("not implemented");
 169     return uno::Reference<XAccessible>();
 170 }
 171
 172 awt::Rectangle SAL_CALL ScAccessibleContextBase::getBounds(  )
 173 {
 174     SolarMutexGuard aGuard;
 175     IsObjectValid();
 176     return vcl::unohelper::ConvertToAWTRect(GetBoundingBox());
 177 }
 178
 179 awt::Point SAL_CALL ScAccessibleContextBase::getLocation(  )
 180 {
 181     SolarMutexGuard aGuard;
 182     IsObjectValid();
 183     return vcl::unohelper::ConvertToAWTPoint(GetBoundingBox().TopLeft());
 184 }
 185
 186 awt::Point SAL_CALL ScAccessibleContextBase::getLocationOnScreen(  )
 187 {
 188     SolarMutexGuard aGuard;
 189     IsObjectValid();
 190     return vcl::unohelper::ConvertToAWTPoint(GetBoundingBoxOnScreen().TopLeft());
 191 }
 192
 193 awt::Size SAL_CALL ScAccessibleContextBase::getSize(  )
 194 {
 195     SolarMutexGuard aGuard;
 196     IsObjectValid();
 197     return vcl::unohelper::ConvertToAWTSize(GetBoundingBox().GetSize());
 198 }
 199
 200 bool ScAccessibleContextBase::isShowing(  )
 201 {
 202     SolarMutexGuard aGuard;
 203     IsObjectValid();
 204     bool bShowing(false);
 205     if (mxParent.is())
 206     {
 207         uno::Reference<XAccessibleComponent> xParentComponent (mxParent->getAccessibleContext(), uno::UNO_QUERY);
 208         if (xParentComponent.is())
 209         {
 210             tools::Rectangle aParentBounds(
 211                 vcl::unohelper::ConvertToVCLRect(xParentComponent->getBounds()));
 212             tools::Rectangle aBounds(vcl::unohelper::ConvertToVCLRect(getBounds()));
 213             bShowing = aBounds.Overlaps(aParentBounds);
 214         }
 215     }
 216     return bShowing;
 217 }
 218
 219 bool ScAccessibleContextBase::isVisible()
 220 {
 221     return true;
 222 }
 223
 224 void SAL_CALL ScAccessibleContextBase::grabFocus(  )
 225 {
 226     OSL_FAIL("not implemented");
 227 }
 228
 229 sal_Int32 SAL_CALL ScAccessibleContextBase::getForeground(  )
 230 {
 231     return sal_Int32(COL_BLACK);
 232 }
 233
 234 sal_Int32 SAL_CALL ScAccessibleContextBase::getBackground(  )
 235 {
 236     return sal_Int32(COL_WHITE);
 237 }
 238
 239 //=====  XAccessibleContext  ==================================================
 240
 241 sal_Int64 SAL_CALL ScAccessibleContextBase::getAccessibleChildCount()
 242 {
 243     OSL_FAIL("should be implemented in the abrevated class");
 244     return 0;
 245 }
 246
 247 uno::Reference<XAccessible> SAL_CALL
 248     ScAccessibleContextBase::getAccessibleChild(sal_Int64 /* nIndex */)
 249 {
 250     OSL_FAIL("should be implemented in the abrevated class");
 251     return uno::Reference<XAccessible>();
 252 }
 253
 254 uno::Reference<XAccessible> SAL_CALL
 255        ScAccessibleContextBase::getAccessibleParent()
 256 {
 257     return mxParent;
 258 }
 259
 260 sal_Int64 SAL_CALL
 261        ScAccessibleContextBase::getAccessibleIndexInParent()
 262 {
 263     SolarMutexGuard aGuard;
 264     IsObjectValid();
 265     //  Use a simple but slow solution for now.  Optimize later.
 266    //   Return -1 to indicate that this object's parent does not know about the
 267    //   object.
 268     sal_Int64 nIndex(-1);
 269
 270     //  Iterate over all the parent's children and search for this object.
 271     if (mxParent.is())
 272     {
 273         uno::Reference<XAccessibleContext> xParentContext (
 274             mxParent->getAccessibleContext());
 275         if (xParentContext.is())
 276         {
 277             sal_Int64 nChildCount = xParentContext->getAccessibleChildCount();
 278             for (sal_Int64 i=0; i<nChildCount; ++i)
 279             {
 280                 uno::Reference<XAccessible> xChild (xParentContext->getAccessibleChild (i));
 281                 if (xChild.is() && xChild.get() == this)
 282                     nIndex = i;
 283             }
 284         }
 285     }
 286
 287     return nIndex;
 288 }
 289
 290 sal_Int16 SAL_CALL
 291     ScAccessibleContextBase::getAccessibleRole()
 292 {
 293     return maRole;
 294 }
 295
 296 OUString SAL_CALL
 297        ScAccessibleContextBase::getAccessibleDescription()
 298 {
 299     SolarMutexGuard aGuard;
 300     IsObjectValid();
 301     if (msDescription.isEmpty())
 302     {
 303         OUString sDescription(createAccessibleDescription());
 304
 305         if (msDescription != sDescription)
 306         {
 307             AccessibleEventObject aEvent;
 308             aEvent.EventId = AccessibleEventId::DESCRIPTION_CHANGED;
 309             aEvent.Source = uno::Reference< XAccessibleContext >(this);
 310             aEvent.OldValue <<= msDescription;
 311             aEvent.NewValue <<= sDescription;
 312
 313             msDescription = sDescription;
 314
 315             CommitChange(aEvent);
 316         }
 317     }
 318     return msDescription;
 319 }
 320
 321 OUString SAL_CALL
 322        ScAccessibleContextBase::getAccessibleName()
 323 {
 324     SolarMutexGuard aGuard;
 325     IsObjectValid();
 326     if (msName.isEmpty())
 327     {
 328         OUString sName(createAccessibleName());
 329         OSL_ENSURE(!sName.isEmpty(), "We should give always a name.");
 330
 331         if (msName != sName)
 332         {
 333             AccessibleEventObject aEvent;
 334             aEvent.EventId = AccessibleEventId::NAME_CHANGED;
 335             aEvent.Source = uno::Reference< XAccessibleContext >(this);
 336             aEvent.OldValue <<= msName;
 337             aEvent.NewValue <<= sName;
 338
 339             msName = sName;
 340
 341             CommitChange(aEvent);
 342         }
 343     }
 344     return msName;
 345 }
 346
 347 uno::Reference<XAccessibleRelationSet> SAL_CALL
 348        ScAccessibleContextBase::getAccessibleRelationSet()
 349 {
 350     return new utl::AccessibleRelationSetHelper();
 351 }
 352
 353 sal_Int64 SAL_CALL ScAccessibleContextBase::getAccessibleStateSet()
 354 {
 355     return 0;
 356 }
 357
 358 lang::Locale SAL_CALL
 359        ScAccessibleContextBase::getLocale()
 360 {
 361     SolarMutexGuard aGuard;
 362     IsObjectValid();
 363     if (mxParent.is())
 364     {
 365         uno::Reference<XAccessibleContext> xParentContext (
 366             mxParent->getAccessibleContext());
 367         if (xParentContext.is())
 368             return xParentContext->getLocale ();
 369     }
 370
 371     //  No locale and no parent.  Therefore throw exception to indicate this
 372     //  cluelessness.
 373     throw IllegalAccessibleComponentStateException ();
 374 }
 375
 376     //=====  XAccessibleEventBroadcaster  =====================================
 377
 378 void SAL_CALL
 379        ScAccessibleContextBase::addAccessibleEventListener(
 380            const uno::Reference<XAccessibleEventListener>& xListener)
 381 {
 382     if (xListener.is())
 383     {
 384         SolarMutexGuard aGuard;
 385         IsObjectValid();
 386         if (!IsDefunc())
 387         {
 388             if (!mnClientId)
 389                 mnClientId = comphelper::AccessibleEventNotifier::registerClient( );
 390             comphelper::AccessibleEventNotifier::addEventListener( mnClientId, xListener );
 391         }
 392     }
 393 }
 394
 395 void SAL_CALL
 396        ScAccessibleContextBase::removeAccessibleEventListener(
 397         const uno::Reference<XAccessibleEventListener>& xListener)
 398 {
 399     if (!xListener.is())
 400         return;
 401
 402     SolarMutexGuard aGuard;
 403     if (IsDefunc() || !mnClientId)
 404         return;
 405
 406     sal_Int32 nListenerCount = comphelper::AccessibleEventNotifier::removeEventListener( mnClientId, xListener );
 407     if ( !nListenerCount )
 408     {
 409         // no listeners anymore
 410         // -> revoke ourself. This may lead to the notifier thread dying (if we were the last client),
 411         // and at least to us not firing any events anymore, in case somebody calls
 412         // NotifyAccessibleEvent, again
 413         comphelper::AccessibleEventNotifier::revokeClient( mnClientId );
 414         mnClientId = 0;
 415     }
 416 }
 417
 418 // XServiceInfo
 419 OUString SAL_CALL ScAccessibleContextBase::getImplementationName()
 420 {
 421     return u"ScAccessibleContextBase"_ustr;
 422 }
 423
 424 sal_Bool SAL_CALL ScAccessibleContextBase::supportsService(const OUString& sServiceName)
 425 {
 426     return cppu::supportsService(this, sServiceName);
 427 }
 428
 429 uno::Sequence< OUString> SAL_CALL
 430        ScAccessibleContextBase::getSupportedServiceNames()
 431 {
 432     return {u"com.sun.star.accessibility.Accessible"_ustr,
 433             u"com.sun.star.accessibility.AccessibleContext"_ustr};
 434 }
 435
 436 //=====  internal  ============================================================
 437
 438 OUString
 439     ScAccessibleContextBase::createAccessibleDescription()
 440 {
 441     OSL_FAIL("should be implemented in the abrevated class");
 442     return OUString();
 443 }
 444
 445 OUString ScAccessibleContextBase::createAccessibleName()
 446 {
 447     OSL_FAIL("should be implemented in the abrevated class");
 448     return OUString();
 449 }
 450
 451 void ScAccessibleContextBase::CommitChange(const AccessibleEventObject& rEvent) const
 452 {
 453     if (mnClientId)
 454         comphelper::AccessibleEventNotifier::addEvent( mnClientId, rEvent );
 455 }
 456
 457 void ScAccessibleContextBase::CommitFocusGained() const
 458 {
 459     AccessibleEventObject aEvent;
 460     aEvent.EventId = AccessibleEventId::STATE_CHANGED;
 461     aEvent.Source = uno::Reference< XAccessibleContext >(const_cast<ScAccessibleContextBase*>(this));
 462     aEvent.NewValue <<= AccessibleStateType::FOCUSED;
 463
 464     CommitChange(aEvent);
 465 }
 466
 467 void ScAccessibleContextBase::CommitFocusLost() const
 468 {
 469     AccessibleEventObject aEvent;
 470     aEvent.EventId = AccessibleEventId::STATE_CHANGED;
 471     aEvent.Source = uno::Reference< XAccessibleContext >(const_cast<ScAccessibleContextBase*>(this));
 472     aEvent.OldValue <<= AccessibleStateType::FOCUSED;
 473
 474     CommitChange(aEvent);
 475 }
 476
 477 AbsoluteScreenPixelRectangle ScAccessibleContextBase::GetBoundingBoxOnScreen() const
 478 {
 479     OSL_FAIL("not implemented");
 480     return AbsoluteScreenPixelRectangle();
 481 }
 482
 483 tools::Rectangle ScAccessibleContextBase::GetBoundingBox() const
 484 {
 485     OSL_FAIL("not implemented");
 486     return tools::Rectangle();
 487 }
 488
 489 void ScAccessibleContextBase::IsObjectValid() const
 490 {
 491     if (rBHelper.bDisposed || rBHelper.bInDispose)
 492         throw lang::DisposedException();
 493 }
 494
 495 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */