svx/source/form/formfeaturedispatcher.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
  21 #include "formfeaturedispatcher.hxx"
  22
  23 #include <comphelper/namedvaluecollection.hxx>
  24 #include <tools/diagnose_ex.h>
  25
  26
  27 namespace svx
  28 {
  29
  30
  31     using namespace ::com::sun::star::uno;
  32     using namespace ::com::sun::star::lang;
  33     using namespace ::com::sun::star::frame;
  34     using namespace ::com::sun::star::beans;
  35     using namespace ::com::sun::star::util;
  36     using namespace ::com::sun::star::form::runtime;
  37
  38     OSingleFeatureDispatcher::OSingleFeatureDispatcher( const URL& _rFeatureURL, const sal_Int16 _nFormFeature,
  39             const Reference< XFormOperations >& _rxFormOperations, ::osl::Mutex& _rMutex )
  40         :m_rMutex( _rMutex )
  41         ,m_aStatusListeners( _rMutex )
  42         ,m_xFormOperations( _rxFormOperations )
  43         ,m_aFeatureURL( _rFeatureURL )
  44         ,m_nFormFeature( _nFormFeature )
  45         ,m_bLastKnownEnabled( false )
  46         ,m_bDisposed( false )
  47     {
  48     }
  49
  50
  51     void OSingleFeatureDispatcher::getUnoState( FeatureStateEvent& /* [out] */ _rState ) const
  52     {
  53         _rState.Source = *const_cast< OSingleFeatureDispatcher* >( this );
  54
  55         FeatureState aState( m_xFormOperations->getState( m_nFormFeature ) );
  56
  57         _rState.FeatureURL = m_aFeatureURL;
  58         _rState.IsEnabled = aState.Enabled;
  59         _rState.Requery = sal_False;
  60         _rState.State = aState.State;
  61     }
  62
  63
  64     void OSingleFeatureDispatcher::updateAllListeners()
  65     {
  66         ::osl::ClearableMutexGuard aGuard( m_rMutex );
  67
  68         FeatureStateEvent aUnoState;
  69         getUnoState( aUnoState );
  70
  71         if ( ( m_aLastKnownState == aUnoState.State ) && ( m_bLastKnownEnabled == bool(aUnoState.IsEnabled) ) )
  72             return;
  73
  74         m_aLastKnownState = aUnoState.State;
  75         m_bLastKnownEnabled = aUnoState.IsEnabled;
  76
  77         notifyStatus( NULL, aGuard );
  78     }
  79
  80
  81     void OSingleFeatureDispatcher::notifyStatus( const Reference< XStatusListener >& _rxListener, ::osl::ClearableMutexGuard& _rFreeForNotification )
  82     {
  83         FeatureStateEvent aUnoState;
  84         getUnoState( aUnoState );
  85
  86         if ( _rxListener.is() )
  87         {
  88             try
  89             {
  90                 _rFreeForNotification.clear();
  91                 _rxListener->statusChanged( aUnoState );
  92             }
  93             catch( const Exception& )
  94             {
  95                 OSL_FAIL( "OSingleFeatureDispatcher::notifyStatus: caught an exception!" );
  96             }
  97         }
  98         else
  99         {
 100             ::cppu::OInterfaceIteratorHelper aIter( m_aStatusListeners );
 101             _rFreeForNotification.clear();
 102
 103             while ( aIter.hasMoreElements() )
 104             {
 105                 try
 106                 {
 107                     static_cast< XStatusListener* >( aIter.next() )->statusChanged( aUnoState );
 108                 }
 109                 catch( const DisposedException& )
 110                 {
 111                     OSL_FAIL( "OSingleFeatureDispatcher::notifyStatus: caught a DisposedException - removing the listener!" );
 112                     aIter.remove( );
 113                 }
 114                 catch( const Exception& )
 115                 {
 116                     OSL_FAIL( "OSingleFeatureDispatcher::notifyStatus: caught a generic exception while notifying a single listener!" );
 117                 }
 118             }
 119         }
 120     }
 121
 122
 123     void SAL_CALL OSingleFeatureDispatcher::dispatch( const URL& _rURL, const Sequence< PropertyValue >& _rArguments ) throw (RuntimeException, std::exception)
 124     {
 125         ::osl::ClearableMutexGuard aGuard( m_rMutex );
 126         checkAlive();
 127
 128         OSL_ENSURE( _rURL.Complete == m_aFeatureURL.Complete, "OSingleFeatureDispatcher::dispatch: not responsible for this URL!" );
 129         (void)_rURL;
 130
 131         if ( !m_xFormOperations->isEnabled( m_nFormFeature ) )
 132             return;
 133
 134         // release our mutex before executing the command
 135         sal_Int16 nFormFeature( m_nFormFeature );
 136         Reference< XFormOperations > xFormOperations( m_xFormOperations );
 137         aGuard.clear();
 138
 139         try
 140         {
 141             if ( !_rArguments.getLength() )
 142             {
 143                 xFormOperations->execute( nFormFeature );
 144             }
 145             else
 146             {   // at the moment we only support one parameter
 147                 ::comphelper::NamedValueCollection aArgs( _rArguments );
 148                 xFormOperations->executeWithArguments( nFormFeature, aArgs.getNamedValues() );
 149             }
 150         }
 151         catch( const RuntimeException& )
 152         {
 153             throw;
 154         }
 155         catch( const Exception& )
 156         {
 157             DBG_UNHANDLED_EXCEPTION();
 158         }
 159     }
 160
 161
 162     void SAL_CALL OSingleFeatureDispatcher::addStatusListener( const Reference< XStatusListener >& _rxControl, const URL& _rURL ) throw (RuntimeException, std::exception)
 163     {
 164         (void)_rURL;
 165         OSL_ENSURE( _rURL.Complete == m_aFeatureURL.Complete, "OSingleFeatureDispatcher::addStatusListener: unexpected URL!" );
 166         OSL_ENSURE( _rxControl.is(), "OSingleFeatureDispatcher::addStatusListener: senseless call!" );
 167         if ( !_rxControl.is() )
 168             return;
 169
 170         ::osl::ClearableMutexGuard aGuard( m_rMutex );
 171         if ( m_bDisposed )
 172         {
 173             EventObject aDisposeEvent( *this );
 174             aGuard.clear();
 175             _rxControl->disposing( aDisposeEvent );
 176             return;
 177         }
 178
 179         m_aStatusListeners.addInterface( _rxControl );
 180
 181         // initially update the status
 182         notifyStatus( _rxControl, aGuard );
 183     }
 184
 185
 186     void SAL_CALL OSingleFeatureDispatcher::removeStatusListener( const Reference< XStatusListener >& _rxControl, const URL& _rURL ) throw (RuntimeException, std::exception)
 187     {
 188         (void)_rURL;
 189         OSL_ENSURE( _rURL.Complete == m_aFeatureURL.Complete, "OSingleFeatureDispatcher::removeStatusListener: unexpected URL!" );
 190         OSL_ENSURE( _rxControl.is(), "OSingleFeatureDispatcher::removeStatusListener: senseless call!" );
 191         if ( !_rxControl.is() )
 192             return;
 193
 194         ::osl::MutexGuard aGuard( m_rMutex );
 195         checkAlive();
 196
 197         m_aStatusListeners.removeInterface( _rxControl );
 198     }
 199
 200
 201     void OSingleFeatureDispatcher::checkAlive() const
 202     {
 203         if ( m_bDisposed )
 204             throw DisposedException( OUString(), *const_cast< OSingleFeatureDispatcher* >( this ) );
 205     }
 206
 207
 208 }
 209
 210
 211 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */