ecd05fb081
2005/09/23 03:15:26 sb 1.7.128.2: RESYNC: (1.7-1.8); FILE MERGED 2005/09/01 13:59:58 sb 1.7.128.1: #i53898# Made code warning-free.
276 lines
10 KiB
C++
276 lines
10 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: accessibleeventnotifier.cxx,v $
|
|
*
|
|
* $Revision: 1.9 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2006-06-19 22:46:44 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef COMPHELPER_ACCESSIBLE_EVENT_NOTIFIER
|
|
#include <comphelper/accessibleeventnotifier.hxx>
|
|
#endif
|
|
|
|
#ifndef _OSL_DIAGNOSE_H_
|
|
#include <osl/diagnose.h>
|
|
#endif
|
|
#ifndef INCLUDED_RTL_INSTANCE_HXX
|
|
#include <rtl/instance.hxx>
|
|
#endif
|
|
|
|
#ifndef _COMPHELPER_GUARDING_HXX_
|
|
#include <comphelper/guarding.hxx>
|
|
#endif
|
|
|
|
using namespace ::com::sun::star::uno;
|
|
using namespace ::com::sun::star::lang;
|
|
using namespace ::com::sun::star::accessibility;
|
|
using namespace ::comphelper;
|
|
|
|
//=====================================================================
|
|
//= AccessibleEventNotifier
|
|
//=====================================================================
|
|
//---------------------------------------------------------------------
|
|
namespace
|
|
{
|
|
struct lclMutex
|
|
: public rtl::Static< ::osl::Mutex, lclMutex > {};
|
|
struct Clients
|
|
: public rtl::Static< AccessibleEventNotifier::ClientMap, Clients > {};
|
|
}
|
|
|
|
//.........................................................................
|
|
namespace comphelper
|
|
{
|
|
//.........................................................................
|
|
|
|
//---------------------------------------------------------------------
|
|
AccessibleEventNotifier::TClientId AccessibleEventNotifier::generateId()
|
|
{
|
|
TClientId nBiggestUsedId = 0;
|
|
TClientId nFreeId = 0;
|
|
|
|
// look through all registered clients until we find a "gap" in the ids
|
|
|
|
// Note that the following relies on the fact the elements in the map are traveled with
|
|
// ascending keys (aka client ids)
|
|
AccessibleEventNotifier::ClientMap &rClients = Clients::get();
|
|
for ( ClientMap::const_iterator aLookup = rClients.begin();
|
|
aLookup != rClients.end();
|
|
++aLookup
|
|
)
|
|
{
|
|
TClientId nCurrent = aLookup->first;
|
|
OSL_ENSURE( nCurrent > nBiggestUsedId, "AccessibleEventNotifier::generateId: map is expected to be sorted ascending!" );
|
|
|
|
if ( nCurrent - nBiggestUsedId > 1 )
|
|
{ // found a "gap"
|
|
nFreeId = nBiggestUsedId + 1;
|
|
break;
|
|
}
|
|
|
|
nBiggestUsedId = nCurrent;
|
|
}
|
|
|
|
if ( !nFreeId )
|
|
nFreeId = nBiggestUsedId + 1;
|
|
|
|
OSL_ENSURE( rClients.end() == rClients.find( nFreeId ),
|
|
"AccessibleEventNotifier::generateId: algorithm broken!" );
|
|
|
|
return nFreeId;
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
AccessibleEventNotifier::TClientId AccessibleEventNotifier::registerClient( )
|
|
{
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
// generate a new client id
|
|
TClientId nNewClientId = generateId( );
|
|
|
|
// the event listeners for the new client
|
|
EventListeners* pNewListeners = new EventListeners( lclMutex::get() );
|
|
// note that we're using our own mutex here, so the listener containers for all
|
|
// our clients share this same mutex.
|
|
// this is a reminiscense to the days where the notifier was asynchronous. Today this is
|
|
// completely nonsense, and potentially slowing down the Office me thinks ...
|
|
|
|
// add the client
|
|
Clients::get().insert( ClientMap::value_type( nNewClientId, pNewListeners ) );
|
|
|
|
// outta here
|
|
return nNewClientId;
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
sal_Bool AccessibleEventNotifier::implLookupClient( const TClientId _nClient, ClientMap::iterator& _rPos )
|
|
{
|
|
// look up this client
|
|
AccessibleEventNotifier::ClientMap &rClients = Clients::get();
|
|
_rPos = rClients.find( _nClient );
|
|
OSL_ENSURE( rClients.end() != _rPos, "AccessibleEventNotifier::implLookupClient: invalid client id (did you register your client?)!" );
|
|
|
|
return ( rClients.end() != _rPos );
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
void AccessibleEventNotifier::revokeClient( const TClientId _nClient )
|
|
{
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
ClientMap::iterator aClientPos;
|
|
if ( !implLookupClient( _nClient, aClientPos ) )
|
|
// already asserted in implLookupClient
|
|
return;
|
|
|
|
// remove it from the clients map
|
|
delete aClientPos->second;
|
|
Clients::get().erase( aClientPos );
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
void AccessibleEventNotifier::revokeClientNotifyDisposing( const TClientId _nClient,
|
|
const Reference< XInterface >& _rxEventSource ) SAL_THROW( ( ) )
|
|
{
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
ClientMap::iterator aClientPos;
|
|
if ( !implLookupClient( _nClient, aClientPos ) )
|
|
// already asserted in implLookupClient
|
|
return;
|
|
|
|
// notify the "disposing" event for this client
|
|
EventObject aDisposalEvent;
|
|
aDisposalEvent.Source = _rxEventSource;
|
|
|
|
// notify the listeners
|
|
EventListeners* pListeners = aClientPos->second;
|
|
|
|
// we do not need the entry in the clients map anymore
|
|
// (do this before actually notifying, because some client implementations have re-entrance
|
|
// problems and call into revokeClient while we are notifying from hereing)
|
|
Clients::get().erase( aClientPos );
|
|
|
|
// now really do the notification
|
|
pListeners->disposeAndClear( aDisposalEvent );
|
|
delete pListeners;
|
|
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
sal_Int32 AccessibleEventNotifier::addEventListener(
|
|
const TClientId _nClient, const Reference< XAccessibleEventListener >& _rxListener ) SAL_THROW( ( ) )
|
|
{
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
ClientMap::iterator aClientPos;
|
|
if ( !implLookupClient( _nClient, aClientPos ) )
|
|
// already asserted in implLookupClient
|
|
return 0;
|
|
|
|
if ( _rxListener.is() )
|
|
aClientPos->second->addInterface( _rxListener );
|
|
|
|
return aClientPos->second->getLength();
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
sal_Int32 AccessibleEventNotifier::removeEventListener(
|
|
const TClientId _nClient, const Reference< XAccessibleEventListener >& _rxListener ) SAL_THROW( ( ) )
|
|
{
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
ClientMap::iterator aClientPos;
|
|
if ( !implLookupClient( _nClient, aClientPos ) )
|
|
// already asserted in implLookupClient
|
|
return 0;
|
|
|
|
if ( _rxListener.is() )
|
|
aClientPos->second->removeInterface( _rxListener );
|
|
|
|
return aClientPos->second->getLength();
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
Sequence< Reference< XInterface > > AccessibleEventNotifier::getEventListeners( const TClientId _nClient ) SAL_THROW( ( ) )
|
|
{
|
|
Sequence< Reference< XInterface > > aListeners;
|
|
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
ClientMap::iterator aClientPos;
|
|
if ( implLookupClient( _nClient, aClientPos ) )
|
|
aListeners = aClientPos->second->getElements();
|
|
|
|
return aListeners;
|
|
}
|
|
|
|
//---------------------------------------------------------------------
|
|
void AccessibleEventNotifier::addEvent( const TClientId _nClient, const AccessibleEventObject& _rEvent ) SAL_THROW( ( ) )
|
|
{
|
|
Sequence< Reference< XInterface > > aListeners;
|
|
|
|
// --- <mutex lock> -------------------------------
|
|
{
|
|
::osl::MutexGuard aGuard( lclMutex::get() );
|
|
|
|
ClientMap::iterator aClientPos;
|
|
if ( !implLookupClient( _nClient, aClientPos ) )
|
|
// already asserted in implLookupClient
|
|
return;
|
|
|
|
// since we're synchronous, again, we want to notify immediately
|
|
aListeners = aClientPos->second->getElements();
|
|
}
|
|
// --- </mutex lock> ------------------------------
|
|
|
|
// default handling: loop through all listeners, and notify them
|
|
const Reference< XInterface >* pListeners = aListeners.getConstArray();
|
|
const Reference< XInterface >* pListenersEnd = pListeners + aListeners.getLength();
|
|
while ( pListeners != pListenersEnd )
|
|
{
|
|
try
|
|
{
|
|
static_cast< XAccessibleEventListener* >( pListeners->get() )->notifyEvent( _rEvent );
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
// no assertion, because a broken access remote bridge or something like this
|
|
// can cause this exception
|
|
}
|
|
++pListeners;
|
|
}
|
|
}
|
|
|
|
//.........................................................................
|
|
} // namespace comphelper
|
|
//.........................................................................
|
|
|