1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove 29*cdf0e10cSrcweir #include "precompiled_comphelper.hxx" 30*cdf0e10cSrcweir #include <comphelper/accessibleeventnotifier.hxx> 31*cdf0e10cSrcweir #include <osl/diagnose.h> 32*cdf0e10cSrcweir #include <rtl/instance.hxx> 33*cdf0e10cSrcweir #include <comphelper/guarding.hxx> 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir using namespace ::com::sun::star::uno; 36*cdf0e10cSrcweir using namespace ::com::sun::star::lang; 37*cdf0e10cSrcweir using namespace ::com::sun::star::accessibility; 38*cdf0e10cSrcweir using namespace ::comphelper; 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir //===================================================================== 41*cdf0e10cSrcweir //= AccessibleEventNotifier 42*cdf0e10cSrcweir //===================================================================== 43*cdf0e10cSrcweir //--------------------------------------------------------------------- 44*cdf0e10cSrcweir namespace 45*cdf0e10cSrcweir { 46*cdf0e10cSrcweir struct lclMutex 47*cdf0e10cSrcweir : public rtl::Static< ::osl::Mutex, lclMutex > {}; 48*cdf0e10cSrcweir struct Clients 49*cdf0e10cSrcweir : public rtl::Static< AccessibleEventNotifier::ClientMap, Clients > {}; 50*cdf0e10cSrcweir } 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir //......................................................................... 53*cdf0e10cSrcweir namespace comphelper 54*cdf0e10cSrcweir { 55*cdf0e10cSrcweir //......................................................................... 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir //--------------------------------------------------------------------- 58*cdf0e10cSrcweir AccessibleEventNotifier::TClientId AccessibleEventNotifier::generateId() 59*cdf0e10cSrcweir { 60*cdf0e10cSrcweir TClientId nBiggestUsedId = 0; 61*cdf0e10cSrcweir TClientId nFreeId = 0; 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir // look through all registered clients until we find a "gap" in the ids 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir // Note that the following relies on the fact the elements in the map are traveled with 66*cdf0e10cSrcweir // ascending keys (aka client ids) 67*cdf0e10cSrcweir AccessibleEventNotifier::ClientMap &rClients = Clients::get(); 68*cdf0e10cSrcweir for ( ClientMap::const_iterator aLookup = rClients.begin(); 69*cdf0e10cSrcweir aLookup != rClients.end(); 70*cdf0e10cSrcweir ++aLookup 71*cdf0e10cSrcweir ) 72*cdf0e10cSrcweir { 73*cdf0e10cSrcweir TClientId nCurrent = aLookup->first; 74*cdf0e10cSrcweir OSL_ENSURE( nCurrent > nBiggestUsedId, "AccessibleEventNotifier::generateId: map is expected to be sorted ascending!" ); 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir if ( nCurrent - nBiggestUsedId > 1 ) 77*cdf0e10cSrcweir { // found a "gap" 78*cdf0e10cSrcweir nFreeId = nBiggestUsedId + 1; 79*cdf0e10cSrcweir break; 80*cdf0e10cSrcweir } 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir nBiggestUsedId = nCurrent; 83*cdf0e10cSrcweir } 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir if ( !nFreeId ) 86*cdf0e10cSrcweir nFreeId = nBiggestUsedId + 1; 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir OSL_ENSURE( rClients.end() == rClients.find( nFreeId ), 89*cdf0e10cSrcweir "AccessibleEventNotifier::generateId: algorithm broken!" ); 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir return nFreeId; 92*cdf0e10cSrcweir } 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir //--------------------------------------------------------------------- 95*cdf0e10cSrcweir AccessibleEventNotifier::TClientId AccessibleEventNotifier::registerClient( ) 96*cdf0e10cSrcweir { 97*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir // generate a new client id 100*cdf0e10cSrcweir TClientId nNewClientId = generateId( ); 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir // the event listeners for the new client 103*cdf0e10cSrcweir EventListeners* pNewListeners = new EventListeners( lclMutex::get() ); 104*cdf0e10cSrcweir // note that we're using our own mutex here, so the listener containers for all 105*cdf0e10cSrcweir // our clients share this same mutex. 106*cdf0e10cSrcweir // this is a reminiscense to the days where the notifier was asynchronous. Today this is 107*cdf0e10cSrcweir // completely nonsense, and potentially slowing down the Office me thinks ... 108*cdf0e10cSrcweir 109*cdf0e10cSrcweir // add the client 110*cdf0e10cSrcweir Clients::get().insert( ClientMap::value_type( nNewClientId, pNewListeners ) ); 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir // outta here 113*cdf0e10cSrcweir return nNewClientId; 114*cdf0e10cSrcweir } 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir //--------------------------------------------------------------------- 117*cdf0e10cSrcweir sal_Bool AccessibleEventNotifier::implLookupClient( const TClientId _nClient, ClientMap::iterator& _rPos ) 118*cdf0e10cSrcweir { 119*cdf0e10cSrcweir // look up this client 120*cdf0e10cSrcweir AccessibleEventNotifier::ClientMap &rClients = Clients::get(); 121*cdf0e10cSrcweir _rPos = rClients.find( _nClient ); 122*cdf0e10cSrcweir OSL_ENSURE( rClients.end() != _rPos, "AccessibleEventNotifier::implLookupClient: invalid client id (did you register your client?)!" ); 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir return ( rClients.end() != _rPos ); 125*cdf0e10cSrcweir } 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir //--------------------------------------------------------------------- 128*cdf0e10cSrcweir void AccessibleEventNotifier::revokeClient( const TClientId _nClient ) 129*cdf0e10cSrcweir { 130*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir ClientMap::iterator aClientPos; 133*cdf0e10cSrcweir if ( !implLookupClient( _nClient, aClientPos ) ) 134*cdf0e10cSrcweir // already asserted in implLookupClient 135*cdf0e10cSrcweir return; 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir // remove it from the clients map 138*cdf0e10cSrcweir delete aClientPos->second; 139*cdf0e10cSrcweir Clients::get().erase( aClientPos ); 140*cdf0e10cSrcweir } 141*cdf0e10cSrcweir 142*cdf0e10cSrcweir //--------------------------------------------------------------------- 143*cdf0e10cSrcweir void AccessibleEventNotifier::revokeClientNotifyDisposing( const TClientId _nClient, 144*cdf0e10cSrcweir const Reference< XInterface >& _rxEventSource ) SAL_THROW( ( ) ) 145*cdf0e10cSrcweir { 146*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 147*cdf0e10cSrcweir 148*cdf0e10cSrcweir ClientMap::iterator aClientPos; 149*cdf0e10cSrcweir if ( !implLookupClient( _nClient, aClientPos ) ) 150*cdf0e10cSrcweir // already asserted in implLookupClient 151*cdf0e10cSrcweir return; 152*cdf0e10cSrcweir 153*cdf0e10cSrcweir // notify the "disposing" event for this client 154*cdf0e10cSrcweir EventObject aDisposalEvent; 155*cdf0e10cSrcweir aDisposalEvent.Source = _rxEventSource; 156*cdf0e10cSrcweir 157*cdf0e10cSrcweir // notify the listeners 158*cdf0e10cSrcweir EventListeners* pListeners = aClientPos->second; 159*cdf0e10cSrcweir 160*cdf0e10cSrcweir // we do not need the entry in the clients map anymore 161*cdf0e10cSrcweir // (do this before actually notifying, because some client implementations have re-entrance 162*cdf0e10cSrcweir // problems and call into revokeClient while we are notifying from hereing) 163*cdf0e10cSrcweir Clients::get().erase( aClientPos ); 164*cdf0e10cSrcweir 165*cdf0e10cSrcweir // now really do the notification 166*cdf0e10cSrcweir pListeners->disposeAndClear( aDisposalEvent ); 167*cdf0e10cSrcweir delete pListeners; 168*cdf0e10cSrcweir 169*cdf0e10cSrcweir } 170*cdf0e10cSrcweir 171*cdf0e10cSrcweir //--------------------------------------------------------------------- 172*cdf0e10cSrcweir sal_Int32 AccessibleEventNotifier::addEventListener( 173*cdf0e10cSrcweir const TClientId _nClient, const Reference< XAccessibleEventListener >& _rxListener ) SAL_THROW( ( ) ) 174*cdf0e10cSrcweir { 175*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 176*cdf0e10cSrcweir 177*cdf0e10cSrcweir ClientMap::iterator aClientPos; 178*cdf0e10cSrcweir if ( !implLookupClient( _nClient, aClientPos ) ) 179*cdf0e10cSrcweir // already asserted in implLookupClient 180*cdf0e10cSrcweir return 0; 181*cdf0e10cSrcweir 182*cdf0e10cSrcweir if ( _rxListener.is() ) 183*cdf0e10cSrcweir aClientPos->second->addInterface( _rxListener ); 184*cdf0e10cSrcweir 185*cdf0e10cSrcweir return aClientPos->second->getLength(); 186*cdf0e10cSrcweir } 187*cdf0e10cSrcweir 188*cdf0e10cSrcweir //--------------------------------------------------------------------- 189*cdf0e10cSrcweir sal_Int32 AccessibleEventNotifier::removeEventListener( 190*cdf0e10cSrcweir const TClientId _nClient, const Reference< XAccessibleEventListener >& _rxListener ) SAL_THROW( ( ) ) 191*cdf0e10cSrcweir { 192*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 193*cdf0e10cSrcweir 194*cdf0e10cSrcweir ClientMap::iterator aClientPos; 195*cdf0e10cSrcweir if ( !implLookupClient( _nClient, aClientPos ) ) 196*cdf0e10cSrcweir // already asserted in implLookupClient 197*cdf0e10cSrcweir return 0; 198*cdf0e10cSrcweir 199*cdf0e10cSrcweir if ( _rxListener.is() ) 200*cdf0e10cSrcweir aClientPos->second->removeInterface( _rxListener ); 201*cdf0e10cSrcweir 202*cdf0e10cSrcweir return aClientPos->second->getLength(); 203*cdf0e10cSrcweir } 204*cdf0e10cSrcweir 205*cdf0e10cSrcweir //--------------------------------------------------------------------- 206*cdf0e10cSrcweir Sequence< Reference< XInterface > > AccessibleEventNotifier::getEventListeners( const TClientId _nClient ) SAL_THROW( ( ) ) 207*cdf0e10cSrcweir { 208*cdf0e10cSrcweir Sequence< Reference< XInterface > > aListeners; 209*cdf0e10cSrcweir 210*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 211*cdf0e10cSrcweir 212*cdf0e10cSrcweir ClientMap::iterator aClientPos; 213*cdf0e10cSrcweir if ( implLookupClient( _nClient, aClientPos ) ) 214*cdf0e10cSrcweir aListeners = aClientPos->second->getElements(); 215*cdf0e10cSrcweir 216*cdf0e10cSrcweir return aListeners; 217*cdf0e10cSrcweir } 218*cdf0e10cSrcweir 219*cdf0e10cSrcweir //--------------------------------------------------------------------- 220*cdf0e10cSrcweir void AccessibleEventNotifier::addEvent( const TClientId _nClient, const AccessibleEventObject& _rEvent ) SAL_THROW( ( ) ) 221*cdf0e10cSrcweir { 222*cdf0e10cSrcweir Sequence< Reference< XInterface > > aListeners; 223*cdf0e10cSrcweir 224*cdf0e10cSrcweir // --- <mutex lock> ------------------------------- 225*cdf0e10cSrcweir { 226*cdf0e10cSrcweir ::osl::MutexGuard aGuard( lclMutex::get() ); 227*cdf0e10cSrcweir 228*cdf0e10cSrcweir ClientMap::iterator aClientPos; 229*cdf0e10cSrcweir if ( !implLookupClient( _nClient, aClientPos ) ) 230*cdf0e10cSrcweir // already asserted in implLookupClient 231*cdf0e10cSrcweir return; 232*cdf0e10cSrcweir 233*cdf0e10cSrcweir // since we're synchronous, again, we want to notify immediately 234*cdf0e10cSrcweir aListeners = aClientPos->second->getElements(); 235*cdf0e10cSrcweir } 236*cdf0e10cSrcweir // --- </mutex lock> ------------------------------ 237*cdf0e10cSrcweir 238*cdf0e10cSrcweir // default handling: loop through all listeners, and notify them 239*cdf0e10cSrcweir const Reference< XInterface >* pListeners = aListeners.getConstArray(); 240*cdf0e10cSrcweir const Reference< XInterface >* pListenersEnd = pListeners + aListeners.getLength(); 241*cdf0e10cSrcweir while ( pListeners != pListenersEnd ) 242*cdf0e10cSrcweir { 243*cdf0e10cSrcweir try 244*cdf0e10cSrcweir { 245*cdf0e10cSrcweir static_cast< XAccessibleEventListener* >( pListeners->get() )->notifyEvent( _rEvent ); 246*cdf0e10cSrcweir } 247*cdf0e10cSrcweir catch( const Exception& ) 248*cdf0e10cSrcweir { 249*cdf0e10cSrcweir // no assertion, because a broken access remote bridge or something like this 250*cdf0e10cSrcweir // can cause this exception 251*cdf0e10cSrcweir } 252*cdf0e10cSrcweir ++pListeners; 253*cdf0e10cSrcweir } 254*cdf0e10cSrcweir } 255*cdf0e10cSrcweir 256*cdf0e10cSrcweir //......................................................................... 257*cdf0e10cSrcweir } // namespace comphelper 258*cdf0e10cSrcweir //......................................................................... 259*cdf0e10cSrcweir 260