svx/source/form/fmdispatch.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: fmdispatch.cxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svx.hxx"
  33 #include "fmdispatch.hxx"
  34 #include "formcontrolling.hxx"
  35
  36 //........................................................................
  37 namespace svx
  38 {
  39 //........................................................................
  40
  41     using namespace ::com::sun::star::uno;
  42     using namespace ::com::sun::star::lang;
  43     using namespace ::com::sun::star::frame;
  44     using namespace ::com::sun::star::beans;
  45     using namespace ::com::sun::star::util;
  46     using namespace ::com::sun::star::form::runtime;
  47
  48     //====================================================================
  49     //= OSingleFeatureDispatcher
  50     //====================================================================
  51     //--------------------------------------------------------------------
  52     OSingleFeatureDispatcher::OSingleFeatureDispatcher( const URL& _rFeatureURL, sal_Int32 _nFeatureId,
  53             const FormControllerHelper& _rController, ::osl::Mutex& _rMutex )
  54         :m_rMutex( _rMutex )
  55         ,m_aStatusListeners( _rMutex )
  56         ,m_rController( _rController )
  57         ,m_aFeatureURL( _rFeatureURL )
  58         ,m_nFeatureId( _nFeatureId )
  59         ,m_bLastKnownEnabled( sal_False )
  60         ,m_bDisposed( sal_False )
  61     {
  62     }
  63
  64     //--------------------------------------------------------------------
  65     void OSingleFeatureDispatcher::dispose()
  66     {
  67         {
  68             ::osl::MutexGuard aGuard( m_rMutex );
  69             if ( m_bDisposed )
  70                 return;
  71         }
  72
  73         EventObject aDisposeEvent( *this );
  74         m_aStatusListeners.disposeAndClear( aDisposeEvent );
  75
  76         {
  77             ::osl::MutexGuard aGuard( m_rMutex );
  78             m_bDisposed = sal_True;
  79         }
  80     }
  81
  82     //--------------------------------------------------------------------
  83     void OSingleFeatureDispatcher::getUnoState( FeatureStateEvent& /* [out] */ _rState ) const
  84     {
  85         FeatureState aState;
  86         _rState.Source = *const_cast< OSingleFeatureDispatcher* >( this );
  87
  88         m_rController.getState( m_nFeatureId, aState );
  89
  90         _rState.FeatureURL = m_aFeatureURL;
  91         _rState.IsEnabled = aState.Enabled;
  92         _rState.Requery = sal_False;
  93         _rState.State = aState.State;
  94     }
  95
  96     //--------------------------------------------------------------------
  97     void OSingleFeatureDispatcher::updateAllListeners()
  98     {
  99         ::osl::ClearableMutexGuard aGuard( m_rMutex );
 100
 101         FeatureStateEvent aUnoState;
 102         getUnoState( aUnoState );
 103
 104         if ( ( m_aLastKnownState == aUnoState.State ) && ( m_bLastKnownEnabled == aUnoState.IsEnabled ) )
 105             return;
 106
 107         m_aLastKnownState = aUnoState.State;
 108         m_bLastKnownEnabled = aUnoState.IsEnabled;
 109
 110         notifyStatus( NULL, aGuard );
 111     }
 112
 113     //--------------------------------------------------------------------
 114     void OSingleFeatureDispatcher::notifyStatus( const Reference< XStatusListener >& _rxListener, ::osl::ClearableMutexGuard& _rFreeForNotification )
 115     {
 116         FeatureStateEvent aUnoState;
 117         getUnoState( aUnoState );
 118
 119         if ( _rxListener.is() )
 120         {
 121             try
 122             {
 123                 _rFreeForNotification.clear();
 124                 _rxListener->statusChanged( aUnoState );
 125             }
 126             catch( const Exception& )
 127             {
 128                 OSL_ENSURE( sal_False, "OSingleFeatureDispatcher::notifyStatus: caught an exception!" );
 129             }
 130         }
 131         else
 132         {
 133             ::cppu::OInterfaceIteratorHelper aIter( m_aStatusListeners );
 134             _rFreeForNotification.clear();
 135
 136             while ( aIter.hasMoreElements() )
 137             {
 138                 try
 139                 {
 140                     static_cast< XStatusListener* >( aIter.next() )->statusChanged( aUnoState );
 141                 }
 142                 catch( const DisposedException& )
 143                 {
 144                     OSL_ENSURE( sal_False, "OSingleFeatureDispatcher::notifyStatus: caught a DisposedException - removing the listener!" );
 145                     aIter.remove( );
 146                 }
 147                 catch( const Exception& )
 148                 {
 149                     OSL_ENSURE( sal_False, "OSingleFeatureDispatcher::notifyStatus: caught a generic exception while notifying a single listener!" );
 150                 }
 151             }
 152         }
 153     }
 154
 155     //--------------------------------------------------------------------
 156     void SAL_CALL OSingleFeatureDispatcher::dispatch( const URL& _rURL, const Sequence< PropertyValue >& _rArguments ) throw (RuntimeException)
 157     {
 158         ::osl::ClearableMutexGuard aGuard( m_rMutex );
 159         checkAlive();
 160
 161         OSL_ENSURE( _rURL.Complete == m_aFeatureURL.Complete, "OSingleFeatureDispatcher::dispatch: not responsible for this URL!" );
 162         (void)_rURL;
 163
 164         if ( m_rController.isEnabled( m_nFeatureId ) )
 165         {
 166             // release our mutex before executing the slot?
 167             sal_Int32 nFeatureId( m_nFeatureId );
 168             aGuard.clear();
 169
 170             if ( !_rArguments.getLength() )
 171             {
 172                 m_rController.execute( nFeatureId );
 173             }
 174             else
 175             {   // at the moment we only support one parameter
 176                 m_rController.execute( nFeatureId, _rArguments[0].Name, _rArguments[0].Value );
 177             }
 178         }
 179     }
 180
 181     //--------------------------------------------------------------------
 182     void SAL_CALL OSingleFeatureDispatcher::addStatusListener( const Reference< XStatusListener >& _rxControl, const URL& _rURL ) throw (RuntimeException)
 183     {
 184         (void)_rURL;
 185         OSL_ENSURE( _rURL.Complete == m_aFeatureURL.Complete, "OSingleFeatureDispatcher::addStatusListener: unexpected URL!" );
 186         OSL_ENSURE( _rxControl.is(), "OSingleFeatureDispatcher::addStatusListener: senseless call!" );
 187         if ( !_rxControl.is() )
 188             return;
 189
 190         ::osl::ClearableMutexGuard aGuard( m_rMutex );
 191         if ( m_bDisposed )
 192         {
 193             EventObject aDisposeEvent( *this );
 194             aGuard.clear();
 195             _rxControl->disposing( aDisposeEvent );
 196             return;
 197         }
 198
 199         m_aStatusListeners.addInterface( _rxControl );
 200
 201         // initially update the status
 202         notifyStatus( _rxControl, aGuard );
 203     }
 204
 205     //--------------------------------------------------------------------
 206     void SAL_CALL OSingleFeatureDispatcher::removeStatusListener( const Reference< XStatusListener >& _rxControl, const URL& _rURL ) throw (RuntimeException)
 207     {
 208         (void)_rURL;
 209         OSL_ENSURE( _rURL.Complete == m_aFeatureURL.Complete, "OSingleFeatureDispatcher::removeStatusListener: unexpected URL!" );
 210         OSL_ENSURE( _rxControl.is(), "OSingleFeatureDispatcher::removeStatusListener: senseless call!" );
 211         if ( !_rxControl.is() )
 212             return;
 213
 214         ::osl::MutexGuard aGuard( m_rMutex );
 215         checkAlive();
 216
 217         m_aStatusListeners.removeInterface( _rxControl );
 218     }
 219
 220     //--------------------------------------------------------------------
 221     void OSingleFeatureDispatcher::checkAlive() const SAL_THROW((DisposedException))
 222     {
 223         if ( m_bDisposed )
 224             throw DisposedException( ::rtl::OUString(), *const_cast< OSingleFeatureDispatcher* >( this ) );
 225     }
 226
 227 //........................................................................
 228 }   // namespace svx
 229 //........................................................................