Merge comphelper::OAccessibleContextHelper into comphelper::OCommonAccessibleComponent

Change-Id: I586ae8fe2842fd879ae2ae506c659d06dda16843
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/145160
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>

5 files changed, 208 insertions, 249 deletions

diff --git a/comphelper/Library_comphelper.mk b/comphelper/Library_comphelper.mk
index 0bad46866d54..be60c4dc886c 100644
--- a/comphelper/Library_comphelper.mk
+++ b/comphelper/Library_comphelper.mk
@@ -77,7 +77,6 @@ $(eval $(call gb_Library_add_exception_objects,comphelper,\
     comphelper/source/container/namecontainer \
     comphelper/source/eventattachermgr/eventattachermgr \
     comphelper/source/misc/accessiblecomponenthelper \
-    comphelper/source/misc/accessiblecontexthelper \
     comphelper/source/misc/accessibleeventnotifier \
     comphelper/source/misc/accessiblekeybindinghelper \
     comphelper/source/misc/accessibleselectionhelper \
diff --git a/comphelper/source/misc/accessiblecomponenthelper.cxx b/comphelper/source/misc/accessiblecomponenthelper.cxx
index 2962bbac95a8..b5ca0bbd9af1 100644
--- a/comphelper/source/misc/accessiblecomponenthelper.cxx
+++ b/comphelper/source/misc/accessiblecomponenthelper.cxx
@@ -18,6 +18,11 @@
  */
 
 #include <comphelper/accessiblecomponenthelper.hxx>
+#include <comphelper/accessiblecontexthelper.hxx>
+#include <osl/diagnose.h>
+#include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp>
+#include <comphelper/accessibleeventnotifier.hxx>
+#include <comphelper/solarmutex.hxx>
 
 
 namespace comphelper
@@ -30,12 +35,213 @@ namespace comphelper
     using namespace ::com::sun::star::accessibility;
 
     OCommonAccessibleComponent::OCommonAccessibleComponent( )
+        :OCommonAccessibleComponent_Base( GetMutex() )
+        ,m_nClientId( 0 )
     {
     }
 
 
     OCommonAccessibleComponent::~OCommonAccessibleComponent( )
     {
+            // this ensures that the lock, which may be already destroyed as part of the derivee,
+            // is not used anymore
+
+        ensureDisposed();
+    }
+
+
+    void SAL_CALL OCommonAccessibleComponent::disposing()
+    {
+        // rhbz#1001768: de facto this class is locked by SolarMutex;
+        // do not lock m_Mutex because it may cause deadlock
+        osl::Guard<SolarMutex> aGuard(SolarMutex::get());
+
+        if ( m_nClientId )
+        {
+            AccessibleEventNotifier::revokeClientNotifyDisposing( m_nClientId, *this );
+            m_nClientId=0;
+        }
+    }
+
+
+    void SAL_CALL OCommonAccessibleComponent::addAccessibleEventListener( const Reference< XAccessibleEventListener >& _rxListener )
+    {
+        osl::Guard<SolarMutex> aGuard(SolarMutex::get());
+            // don't use the OContextEntryGuard - it will throw an exception if we're not alive
+            // anymore, while the most recent specification for XComponent states that we should
+            // silently ignore the call in such a situation
+        if ( !isAlive() )
+        {
+            if ( _rxListener.is() )
+                _rxListener->disposing( EventObject( *this ) );
+            return;
+        }
+
+        if ( _rxListener.is() )
+        {
+            if ( !m_nClientId )
+                m_nClientId = AccessibleEventNotifier::registerClient( );
+
+            AccessibleEventNotifier::addEventListener( m_nClientId, _rxListener );
+        }
+    }
+
+
+    void SAL_CALL OCommonAccessibleComponent::removeAccessibleEventListener( const Reference< XAccessibleEventListener >& _rxListener )
+    {
+        osl::Guard<SolarMutex> aGuard(SolarMutex::get());
+            // don't use the OContextEntryGuard - it will throw an exception if we're not alive
+            // anymore, while the most recent specification for XComponent states that we should
+            // silently ignore the call in such a situation
+        if ( !isAlive() )
+            return;
+
+        if ( !(_rxListener.is() && m_nClientId) )
+            return;
+
+        sal_Int32 nListenerCount = AccessibleEventNotifier::removeEventListener( m_nClientId, _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
+            AccessibleEventNotifier::revokeClient( m_nClientId );
+            m_nClientId = 0;
+        }
+    }
+
+
+    void OCommonAccessibleComponent::NotifyAccessibleEvent( const sal_Int16 _nEventId,
+        const Any& _rOldValue, const Any& _rNewValue )
+    {
+        if ( !m_nClientId )
+            // if we don't have a client id for the notifier, then we don't have listeners, then
+            // we don't need to notify anything
+            return;
+
+        // build an event object
+        AccessibleEventObject aEvent;
+        aEvent.Source = *this;
+        aEvent.EventId = _nEventId;
+        aEvent.OldValue = _rOldValue;
+        aEvent.NewValue = _rNewValue;
+
+        // let the notifier handle this event
+        AccessibleEventNotifier::addEvent( m_nClientId, aEvent );
+    }
+
+
+    bool OCommonAccessibleComponent::isAlive() const
+    {
+        return !rBHelper.bDisposed && !rBHelper.bInDispose;
+    }
+
+
+    void OCommonAccessibleComponent::ensureAlive() const
+    {
+        if( !isAlive() )
+            throw DisposedException();
+    }
+
+
+    void OCommonAccessibleComponent::ensureDisposed( )
+    {
+        if ( !rBHelper.bDisposed )
+        {
+            OSL_ENSURE( 0 == m_refCount, "OCommonAccessibleComponent::ensureDisposed: this method _has_ to be called from without your dtor only!" );
+            acquire();
+            dispose();
+        }
+    }
+
+
+    void OCommonAccessibleComponent::lateInit( const Reference< XAccessible >& _rxAccessible )
+    {
+        m_aCreator = _rxAccessible;
+    }
+
+
+    Reference< XAccessible > OCommonAccessibleComponent::getAccessibleCreator( ) const
+    {
+        return m_aCreator;
+    }
+
+
+    OUString SAL_CALL OCommonAccessibleComponent::getAccessibleId(  )
+    {
+        return OUString();
+    }
+
+
+    sal_Int64 SAL_CALL OCommonAccessibleComponent::getAccessibleIndexInParent(  )
+    {
+        OExternalLockGuard aGuard( this );
+
+        // -1 for child not found/no parent (according to specification)
+        sal_Int64 nRet = -1;
+
+        try
+        {
+
+            Reference< XAccessibleContext > xParentContext( implGetParentContext() );
+
+            //  iterate over parent's children and search for this object
+            if ( xParentContext.is() )
+            {
+                // our own XAccessible for comparing with the children of our parent
+                Reference< XAccessible > xCreator( m_aCreator);
+
+                OSL_ENSURE( xCreator.is(), "OCommonAccessibleComponent::getAccessibleIndexInParent: invalid creator!" );
+                    // two ideas why this could be NULL:
+                    // * nobody called our late ctor (init), so we never had a creator at all -> bad
+                    // * the creator is already dead. In this case, we should have been disposed, and
+                    //   never survived the above OContextEntryGuard.
+                    // in all other situations the creator should be non-NULL
+
+                if ( xCreator.is() )
+                {
+                    sal_Int64 nChildCount = xParentContext->getAccessibleChildCount();
+                    for ( sal_Int64 nChild = 0; ( nChild < nChildCount ) && ( -1 == nRet ); ++nChild )
+                    {
+                        Reference< XAccessible > xChild( xParentContext->getAccessibleChild( nChild ) );
+                        if ( xChild.get() == xCreator.get() )
+                            nRet = nChild;
+                    }
+                }
+            }
+        }
+        catch( const Exception& )
+        {
+            OSL_FAIL( "OCommonAccessibleComponent::getAccessibleIndexInParent: caught an exception!" );
+        }
+
+        return nRet;
+    }
+
+
+    Locale SAL_CALL OCommonAccessibleComponent::getLocale(  )
+    {
+        // simply ask the parent
+        Reference< XAccessible > xParent = getAccessibleParent();
+        Reference< XAccessibleContext > xParentContext;
+        if ( xParent.is() )
+            xParentContext = xParent->getAccessibleContext();
+
+        if ( !xParentContext.is() )
+            throw IllegalAccessibleComponentStateException( OUString(), *this );
+
+        return xParentContext->getLocale();
+    }
+
+
+    Reference< XAccessibleContext > OCommonAccessibleComponent::implGetParentContext()
+    {
+        Reference< XAccessible > xParent = getAccessibleParent();
+        Reference< XAccessibleContext > xParentContext;
+        if ( xParent.is() )
+            xParentContext = xParent->getAccessibleContext();
+        return xParentContext;
     }
 
 
diff --git a/comphelper/source/misc/accessiblecontexthelper.cxx b/comphelper/source/misc/accessiblecontexthelper.cxx
deleted file mode 100644
index 854b3966036e..000000000000
--- a/comphelper/source/misc/accessiblecontexthelper.cxx
+++ /dev/null
@@ -1,248 +0,0 @@
-/* -*- 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 <comphelper/accessiblecontexthelper.hxx>
-#include <osl/diagnose.h>
-#include <cppuhelper/weakref.hxx>
-#include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp>
-#include <comphelper/accessibleeventnotifier.hxx>
-#include <comphelper/solarmutex.hxx>
-
-
-namespace comphelper
-{
-    using namespace ::com::sun::star::uno;
-    using namespace ::com::sun::star::lang;
-    using namespace ::com::sun::star::accessibility;
-
-    OAccessibleContextHelper::OAccessibleContextHelper( )
-        :OAccessibleContextHelper_Base( GetMutex() )
-        ,m_nClientId( 0 )
-    {
-    }
-
-
-    OAccessibleContextHelper::~OAccessibleContextHelper( )
-    {
-            // this ensures that the lock, which may be already destroyed as part of the derivee,
-            // is not used anymore
-
-        ensureDisposed();
-    }
-
-
-    void SAL_CALL OAccessibleContextHelper::disposing()
-    {
-        // rhbz#1001768: de facto this class is locked by SolarMutex;
-        // do not lock m_Mutex because it may cause deadlock
-        osl::Guard<SolarMutex> aGuard(SolarMutex::get());
-
-        if ( m_nClientId )
-        {
-            AccessibleEventNotifier::revokeClientNotifyDisposing( m_nClientId, *this );
-            m_nClientId=0;
-        }
-    }
-
-
-    void SAL_CALL OAccessibleContextHelper::addAccessibleEventListener( const Reference< XAccessibleEventListener >& _rxListener )
-    {
-        osl::Guard<SolarMutex> aGuard(SolarMutex::get());
-            // don't use the OContextEntryGuard - it will throw an exception if we're not alive
-            // anymore, while the most recent specification for XComponent states that we should
-            // silently ignore the call in such a situation
-        if ( !isAlive() )
-        {
-            if ( _rxListener.is() )
-                _rxListener->disposing( EventObject( *this ) );
-            return;
-        }
-
-        if ( _rxListener.is() )
-        {
-            if ( !m_nClientId )
-                m_nClientId = AccessibleEventNotifier::registerClient( );
-
-            AccessibleEventNotifier::addEventListener( m_nClientId, _rxListener );
-        }
-    }
-
-
-    void SAL_CALL OAccessibleContextHelper::removeAccessibleEventListener( const Reference< XAccessibleEventListener >& _rxListener )
-    {
-        osl::Guard<SolarMutex> aGuard(SolarMutex::get());
-            // don't use the OContextEntryGuard - it will throw an exception if we're not alive
-            // anymore, while the most recent specification for XComponent states that we should
-            // silently ignore the call in such a situation
-        if ( !isAlive() )
-            return;
-
-        if ( !(_rxListener.is() && m_nClientId) )
-            return;
-
-        sal_Int32 nListenerCount = AccessibleEventNotifier::removeEventListener( m_nClientId, _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
-            AccessibleEventNotifier::revokeClient( m_nClientId );
-            m_nClientId = 0;
-        }
-    }
-
-
-    void OAccessibleContextHelper::NotifyAccessibleEvent( const sal_Int16 _nEventId,
-        const Any& _rOldValue, const Any& _rNewValue )
-    {
-        if ( !m_nClientId )
-            // if we don't have a client id for the notifier, then we don't have listeners, then
-            // we don't need to notify anything
-            return;
-
-        // build an event object
-        AccessibleEventObject aEvent;
-        aEvent.Source = *this;
-        aEvent.EventId = _nEventId;
-        aEvent.OldValue = _rOldValue;
-        aEvent.NewValue = _rNewValue;
-
-        // let the notifier handle this event
-        AccessibleEventNotifier::addEvent( m_nClientId, aEvent );
-    }
-
-
-    bool OAccessibleContextHelper::isAlive() const
-    {
-        return !rBHelper.bDisposed && !rBHelper.bInDispose;
-    }
-
-
-    void OAccessibleContextHelper::ensureAlive() const
-    {
-        if( !isAlive() )
-            throw DisposedException();
-    }
-
-
-    void OAccessibleContextHelper::ensureDisposed( )
-    {
-        if ( !rBHelper.bDisposed )
-        {
-            OSL_ENSURE( 0 == m_refCount, "OAccessibleContextHelper::ensureDisposed: this method _has_ to be called from without your dtor only!" );
-            acquire();
-            dispose();
-        }
-    }
-
-
-    void OAccessibleContextHelper::lateInit( const Reference< XAccessible >& _rxAccessible )
-    {
-        m_aCreator = _rxAccessible;
-    }
-
-
-    Reference< XAccessible > OAccessibleContextHelper::getAccessibleCreator( ) const
-    {
-        return m_aCreator;
-    }
-
-
-    OUString SAL_CALL OAccessibleContextHelper::getAccessibleId(  )
-    {
-        return OUString();
-    }
-
-
-    sal_Int64 SAL_CALL OAccessibleContextHelper::getAccessibleIndexInParent(  )
-    {
-        OExternalLockGuard aGuard( this );
-
-        // -1 for child not found/no parent (according to specification)
-        sal_Int64 nRet = -1;
-
-        try
-        {
-
-            Reference< XAccessibleContext > xParentContext( implGetParentContext() );
-
-            //  iterate over parent's children and search for this object
-            if ( xParentContext.is() )
-            {
-                // our own XAccessible for comparing with the children of our parent
-                Reference< XAccessible > xCreator( m_aCreator);
-
-                OSL_ENSURE( xCreator.is(), "OAccessibleContextHelper::getAccessibleIndexInParent: invalid creator!" );
-                    // two ideas why this could be NULL:
-                    // * nobody called our late ctor (init), so we never had a creator at all -> bad
-                    // * the creator is already dead. In this case, we should have been disposed, and
-                    //   never survived the above OContextEntryGuard.
-                    // in all other situations the creator should be non-NULL
-
-                if ( xCreator.is() )
-                {
-                    sal_Int64 nChildCount = xParentContext->getAccessibleChildCount();
-                    for ( sal_Int64 nChild = 0; ( nChild < nChildCount ) && ( -1 == nRet ); ++nChild )
-                    {
-                        Reference< XAccessible > xChild( xParentContext->getAccessibleChild( nChild ) );
-                        if ( xChild.get() == xCreator.get() )
-                            nRet = nChild;
-                    }
-                }
-            }
-        }
-        catch( const Exception& )
-        {
-            OSL_FAIL( "OAccessibleContextHelper::getAccessibleIndexInParent: caught an exception!" );
-        }
-
-        return nRet;
-    }
-
-
-    Locale SAL_CALL OAccessibleContextHelper::getLocale(  )
-    {
-        // simply ask the parent
-        Reference< XAccessible > xParent = getAccessibleParent();
-        Reference< XAccessibleContext > xParentContext;
-        if ( xParent.is() )
-            xParentContext = xParent->getAccessibleContext();
-
-        if ( !xParentContext.is() )
-            throw IllegalAccessibleComponentStateException( OUString(), *this );
-
-        return xParentContext->getLocale();
-    }
-
-
-    Reference< XAccessibleContext > OAccessibleContextHelper::implGetParentContext()
-    {
-        Reference< XAccessible > xParent = getAccessibleParent();
-        Reference< XAccessibleContext > xParentContext;
-        if ( xParent.is() )
-            xParentContext = xParent->getAccessibleContext();
-        return xParentContext;
-    }
-
-
-}   // namespace comphelper
-
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/comphelper/source/misc/accessibleselectionhelper.cxx b/comphelper/source/misc/accessibleselectionhelper.cxx
index 97b75115e5e6..435655e85e1d 100644
--- a/comphelper/source/misc/accessibleselectionhelper.cxx
+++ b/comphelper/source/misc/accessibleselectionhelper.cxx
@@ -17,6 +17,7 @@
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
 
+#include <comphelper/accessiblecontexthelper.hxx>
 #include <comphelper/accessibleselectionhelper.hxx>
 
 
diff --git a/comphelper/source/misc/accessibletexthelper.cxx b/comphelper/source/misc/accessibletexthelper.cxx
index 27747b3bca12..cc7fa4cd3d15 100644
--- a/comphelper/source/misc/accessibletexthelper.cxx
+++ b/comphelper/source/misc/accessibletexthelper.cxx
@@ -17,6 +17,7 @@
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
 
+#include <comphelper/accessiblecontexthelper.hxx>
 #include <comphelper/accessibletexthelper.hxx>
 #include <com/sun/star/accessibility/AccessibleTextType.hpp>
 #include <com/sun/star/i18n/BreakIterator.hpp>