svtools/source/uno/framestatuslistener.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 #include <svtools/framestatuslistener.hxx>
  21 #include <com/sun/star/frame/XDispatchProvider.hpp>
  22 #include <com/sun/star/lang/DisposedException.hpp>
  23 #include <com/sun/star/util/URLTransformer.hpp>
  24 #include <osl/mutex.hxx>
  25 #include <vcl/svapp.hxx>
  26 #include <comphelper/processfactory.hxx>
  27
  28 using namespace ::cppu;
  29 using namespace ::com::sun::star::awt;
  30 using namespace ::com::sun::star::uno;
  31 using namespace ::com::sun::star::util;
  32 using namespace ::com::sun::star::beans;
  33 using namespace ::com::sun::star::lang;
  34 using namespace ::com::sun::star::frame;
  35
  36 namespace svt
  37 {
  38
  39 FrameStatusListener::FrameStatusListener(
  40     const Reference< XComponentContext >& rxContext,
  41     const Reference< XFrame >& xFrame ) :
  42     OWeakObject()
  43     ,   m_bInitialized( sal_True )
  44     ,   m_bDisposed( sal_False )
  45     ,   m_xFrame( xFrame )
  46     ,   m_xContext( rxContext )
  47 {
  48 }
  49
  50 FrameStatusListener::~FrameStatusListener()
  51 {
  52 }
  53
  54 // XInterface
  55 Any SAL_CALL FrameStatusListener::queryInterface( const Type& rType )
  56 throw ( RuntimeException )
  57 {
  58     Any a = ::cppu::queryInterface(
  59                 rType ,
  60                 static_cast< XComponent* >( this ),
  61                 static_cast< XFrameActionListener* >( this ),
  62                 static_cast< XStatusListener* >( this ),
  63                 static_cast< XEventListener* >( static_cast< XStatusListener* >( this )),
  64                 static_cast< XEventListener* >( static_cast< XFrameActionListener* >( this )));
  65
  66     if ( a.hasValue() )
  67         return a;
  68
  69     return OWeakObject::queryInterface( rType );
  70 }
  71
  72 void SAL_CALL FrameStatusListener::acquire() throw ()
  73 {
  74     OWeakObject::acquire();
  75 }
  76
  77 void SAL_CALL FrameStatusListener::release() throw ()
  78 {
  79     OWeakObject::release();
  80 }
  81
  82 // XComponent
  83 void SAL_CALL FrameStatusListener::dispose()
  84 throw (::com::sun::star::uno::RuntimeException)
  85 {
  86     Reference< XComponent > xThis( static_cast< OWeakObject* >(this), UNO_QUERY );
  87
  88     SolarMutexGuard aSolarMutexGuard;
  89     if ( m_bDisposed )
  90         throw DisposedException();
  91
  92     Reference< XStatusListener > xStatusListener( static_cast< OWeakObject* >( this ), UNO_QUERY );
  93     URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
  94     while ( pIter != m_aListenerMap.end() )
  95     {
  96         try
  97         {
  98             Reference< XDispatch > xDispatch( pIter->second );
  99             Reference< XURLTransformer > xURLTransformer( com::sun::star::util::URLTransformer::create( m_xContext ) );
 100             com::sun::star::util::URL aTargetURL;
 101             aTargetURL.Complete = pIter->first;
 102             xURLTransformer->parseStrict( aTargetURL );
 103
 104             if ( xDispatch.is() && xStatusListener.is() )
 105                 xDispatch->removeStatusListener( xStatusListener, aTargetURL );
 106         }
 107         catch (const Exception&)
 108         {
 109         }
 110
 111         ++pIter;
 112     }
 113
 114     m_bDisposed = sal_True;
 115 }
 116
 117 void SAL_CALL FrameStatusListener::addEventListener( const Reference< XEventListener >& )
 118 throw ( RuntimeException )
 119 {
 120     // helper class for status updates - no need to support listener
 121 }
 122
 123 void SAL_CALL FrameStatusListener::removeEventListener( const Reference< XEventListener >& )
 124 throw ( RuntimeException )
 125 {
 126     // helper class for status updates - no need to support listener
 127 }
 128
 129 // XEventListener
 130 void SAL_CALL FrameStatusListener::disposing( const EventObject& Source )
 131 throw ( RuntimeException )
 132 {
 133     Reference< XInterface > xSource( Source.Source );
 134
 135     SolarMutexGuard aSolarMutexGuard;
 136
 137     URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
 138     while ( pIter != m_aListenerMap.end() )
 139     {
 140         // Compare references and release dispatch references if they are equal.
 141         Reference< XInterface > xIfac( pIter->second, UNO_QUERY );
 142         if ( xSource == xIfac )
 143             pIter->second.clear();
 144     }
 145
 146     Reference< XInterface > xIfac( m_xFrame, UNO_QUERY );
 147     if ( xIfac == xSource )
 148         m_xFrame.clear();
 149 }
 150
 151 void FrameStatusListener::frameAction( const FrameActionEvent& Action )
 152 throw ( RuntimeException )
 153 {
 154     if ( Action.Action == FrameAction_CONTEXT_CHANGED )
 155         bindListener();
 156 }
 157
 158 void FrameStatusListener::addStatusListener( const OUString& aCommandURL )
 159 {
 160     Reference< XDispatch >       xDispatch;
 161     Reference< XStatusListener > xStatusListener;
 162     com::sun::star::util::URL    aTargetURL;
 163
 164     {
 165         SolarMutexGuard aSolarMutexGuard;
 166         URLToDispatchMap::iterator pIter = m_aListenerMap.find( aCommandURL );
 167
 168         // Already in the list of status listener. Do nothing.
 169         if ( pIter != m_aListenerMap.end() )
 170             return;
 171
 172         // Check if we are already initialized. Implementation starts adding itself as status listener when
 173         // intialize is called.
 174         if ( !m_bInitialized )
 175         {
 176             // Put into the boost::unordered_map of status listener. Will be activated when initialized is called
 177             m_aListenerMap.insert( URLToDispatchMap::value_type( aCommandURL, Reference< XDispatch >() ));
 178             return;
 179         }
 180         else
 181         {
 182             // Add status listener directly as intialize has already been called.
 183             Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
 184             if ( m_xContext.is() && xDispatchProvider.is() )
 185             {
 186                 Reference< XURLTransformer > xURLTransformer( com::sun::star::util::URLTransformer::create( m_xContext ) );
 187                 aTargetURL.Complete = aCommandURL;
 188                 xURLTransformer->parseStrict( aTargetURL );
 189                 xDispatch = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 190
 191                 xStatusListener = Reference< XStatusListener >( static_cast< OWeakObject* >( this ), UNO_QUERY );
 192                 URLToDispatchMap::iterator aIter = m_aListenerMap.find( aCommandURL );
 193                 if ( aIter != m_aListenerMap.end() )
 194                 {
 195                     Reference< XDispatch > xOldDispatch( aIter->second );
 196                     aIter->second = xDispatch;
 197
 198                     try
 199                     {
 200                         if ( xOldDispatch.is() )
 201                             xOldDispatch->removeStatusListener( xStatusListener, aTargetURL );
 202                     }
 203                     catch (const Exception&)
 204                     {
 205                     }
 206                 }
 207                 else
 208                     m_aListenerMap.insert( URLToDispatchMap::value_type( aCommandURL, xDispatch ));
 209             }
 210         }
 211     }
 212
 213     // Call without locked mutex as we are called back from dispatch implementation
 214     try
 215     {
 216         if ( xDispatch.is() )
 217             xDispatch->addStatusListener( xStatusListener, aTargetURL );
 218     }
 219     catch (const Exception&)
 220     {
 221     }
 222 }
 223
 224
 225 void FrameStatusListener::bindListener()
 226 {
 227     std::vector< Listener > aDispatchVector;
 228     Reference< XStatusListener > xStatusListener;
 229
 230     {
 231         SolarMutexGuard aSolarMutexGuard;
 232
 233         if ( !m_bInitialized )
 234             return;
 235
 236         // Collect all registered command URL's and store them temporary
 237         Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
 238         if ( m_xContext.is() && xDispatchProvider.is() )
 239         {
 240             xStatusListener = Reference< XStatusListener >( static_cast< OWeakObject* >( this ), UNO_QUERY );
 241             URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
 242             while ( pIter != m_aListenerMap.end() )
 243             {
 244                 Reference< XURLTransformer > xURLTransformer( com::sun::star::util::URLTransformer::create( m_xContext ) );
 245                 com::sun::star::util::URL aTargetURL;
 246                 aTargetURL.Complete = pIter->first;
 247                 xURLTransformer->parseStrict( aTargetURL );
 248
 249                 Reference< XDispatch > xDispatch( pIter->second );
 250                 if ( xDispatch.is() )
 251                 {
 252                     // We already have a dispatch object => we have to requery.
 253                     // Release old dispatch object and remove it as listener
 254                     try
 255                     {
 256                         xDispatch->removeStatusListener( xStatusListener, aTargetURL );
 257                     }
 258                     catch (const Exception&)
 259                     {
 260                     }
 261                 }
 262
 263                 // Query for dispatch object. Old dispatch will be released with this, too.
 264                 try
 265                 {
 266                     xDispatch = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 267                 }
 268                 catch (const Exception&)
 269                 {
 270                 }
 271                 pIter->second = xDispatch;
 272
 273                 Listener aListener( aTargetURL, xDispatch );
 274                 aDispatchVector.push_back( aListener );
 275                 ++pIter;
 276             }
 277         }
 278     }
 279
 280     // Call without locked mutex as we are called back from dispatch implementation
 281     if ( xStatusListener.is() )
 282     {
 283         try
 284         {
 285             for ( sal_uInt32 i = 0; i < aDispatchVector.size(); i++ )
 286             {
 287                 Listener& rListener = aDispatchVector[i];
 288                 if ( rListener.xDispatch.is() )
 289                     rListener.xDispatch->addStatusListener( xStatusListener, rListener.aURL );
 290             }
 291         }
 292         catch (const Exception&)
 293         {
 294         }
 295     }
 296 }
 297
 298 void FrameStatusListener::unbindListener()
 299 {
 300     SolarMutexGuard aSolarMutexGuard;
 301
 302     if ( !m_bInitialized )
 303         return;
 304
 305     // Collect all registered command URL's and store them temporary
 306     Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
 307     if ( m_xContext.is() && xDispatchProvider.is() )
 308     {
 309         Reference< XStatusListener > xStatusListener( static_cast< OWeakObject* >( this ), UNO_QUERY );
 310         URLToDispatchMap::iterator pIter = m_aListenerMap.begin();
 311         while ( pIter != m_aListenerMap.end() )
 312         {
 313             Reference< XURLTransformer > xURLTransformer( com::sun::star::util::URLTransformer::create( m_xContext ) );
 314             com::sun::star::util::URL aTargetURL;
 315             aTargetURL.Complete = pIter->first;
 316             xURLTransformer->parseStrict( aTargetURL );
 317
 318             Reference< XDispatch > xDispatch( pIter->second );
 319             if ( xDispatch.is() )
 320             {
 321                 // We already have a dispatch object => we have to requery.
 322                 // Release old dispatch object and remove it as listener
 323                 try
 324                 {
 325                     xDispatch->removeStatusListener( xStatusListener, aTargetURL );
 326                 }
 327                 catch (const Exception&)
 328                 {
 329                 }
 330             }
 331             pIter->second.clear();
 332             ++pIter;
 333         }
 334     }
 335 }
 336
 337 } // svt
 338
 339 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */