unotools/source/misc/eventlisteneradapter.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: eventlisteneradapter.cxx,v $
  10  * $Revision: 1.5 $
  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_unotools.hxx"
  33 #include <unotools/eventlisteneradapter.hxx>
  34 #include <osl/diagnose.h>
  35 #include <cppuhelper/implbase1.hxx>
  36 #include <comphelper/stl_types.hxx>
  37
  38 //.........................................................................
  39 namespace utl
  40 {
  41 //.........................................................................
  42
  43     using namespace ::com::sun::star::uno;
  44     using namespace ::com::sun::star::lang;
  45
  46     //=====================================================================
  47     //= OEventListenerImpl
  48     //=====================================================================
  49     class OEventListenerImpl : public ::cppu::WeakImplHelper1< XEventListener >
  50     {
  51     protected:
  52         OEventListenerAdapter*                  m_pAdapter;
  53         Reference< XEventListener >             m_xKeepMeAlive;
  54             // imagine an implementation of XComponent which holds it's listeners with a weak reference ...
  55             // would be very bad if we don't hold ourself
  56         Reference< XComponent >                 m_xComponent;
  57
  58     public:
  59         OEventListenerImpl( OEventListenerAdapter* _pAdapter, const Reference< XComponent >& _rxComp );
  60
  61         void                                                    dispose();
  62         const Reference< XComponent >&  getComponent() const { return m_xComponent; }
  63
  64     protected:
  65         virtual void SAL_CALL disposing( const EventObject& _rSource ) throw (RuntimeException);
  66     };
  67
  68     //---------------------------------------------------------------------
  69     OEventListenerImpl::OEventListenerImpl( OEventListenerAdapter* _pAdapter, const Reference< XComponent >& _rxComp )
  70         :m_pAdapter(_pAdapter)
  71     {
  72         OSL_ENSURE(m_pAdapter, "OEventListenerImpl::OEventListenerImpl: invalid adapter!");
  73         // no checks of _rxComp !!
  74         // (OEventListenerAdapter is responsible for this)
  75
  76         // just in case addEventListener throws an exception ... don't initialize m_xKeepMeAlive before this
  77         // is done
  78         Reference< XEventListener > xMeMyselfAndI = this;
  79         _rxComp->addEventListener(xMeMyselfAndI);
  80
  81         m_xComponent = _rxComp;
  82         m_xKeepMeAlive = xMeMyselfAndI;
  83     }
  84
  85     //---------------------------------------------------------------------
  86     void OEventListenerImpl::dispose()
  87     {
  88         if (m_xComponent.is())
  89         {
  90             m_xComponent->removeEventListener(m_xKeepMeAlive);
  91             m_xComponent.clear();
  92             m_xKeepMeAlive.clear();
  93         }
  94     }
  95
  96     //---------------------------------------------------------------------
  97     void SAL_CALL OEventListenerImpl::disposing( const EventObject& _rSource ) throw (RuntimeException)
  98     {
  99         Reference< XEventListener > xDeleteUponLeaving = m_xKeepMeAlive;
 100         m_xKeepMeAlive.clear();
 101         m_xComponent.clear();
 102
 103         m_pAdapter->_disposing(_rSource);
 104     }
 105
 106     //=====================================================================
 107     //= OEventListenerAdapterImpl
 108     //=====================================================================
 109     struct OEventListenerAdapterImpl
 110     {
 111     public:
 112         ::std::vector< void* >  aListeners;
 113     };
 114
 115     //=====================================================================
 116     //= OEventListenerAdapter
 117     //=====================================================================
 118     //---------------------------------------------------------------------
 119     OEventListenerAdapter::OEventListenerAdapter()
 120         :m_pImpl(new OEventListenerAdapterImpl)
 121     {
 122     }
 123
 124     //---------------------------------------------------------------------
 125     OEventListenerAdapter::~OEventListenerAdapter()
 126     {
 127         stopAllComponentListening( );
 128         delete m_pImpl;
 129         m_pImpl = NULL;
 130     }
 131
 132     //---------------------------------------------------------------------
 133     void OEventListenerAdapter::stopComponentListening( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& _rxComp )
 134     {
 135         if ( m_pImpl->aListeners.empty() )
 136             return;
 137
 138         ::std::vector< void* >::iterator dispose = m_pImpl->aListeners.begin();
 139         do
 140         {
 141             OEventListenerImpl* pListenerImpl = static_cast< OEventListenerImpl* >( *dispose );
 142             if ( pListenerImpl->getComponent().get() == _rxComp.get() )
 143             {
 144                 pListenerImpl->dispose();
 145                 pListenerImpl->release();
 146                 dispose = m_pImpl->aListeners.erase( dispose );
 147             }
 148             else
 149                 ++dispose;
 150         }
 151         while ( dispose != m_pImpl->aListeners.end() );
 152     }
 153
 154     //---------------------------------------------------------------------
 155     void OEventListenerAdapter::stopAllComponentListening(  )
 156     {
 157         for (   ::std::vector< void* >::const_iterator aDisposeLoop = m_pImpl->aListeners.begin();
 158                 aDisposeLoop != m_pImpl->aListeners.end();
 159                 ++aDisposeLoop
 160             )
 161         {
 162             OEventListenerImpl* pListenerImpl = static_cast< OEventListenerImpl* >(*aDisposeLoop);
 163             pListenerImpl->dispose();
 164             pListenerImpl->release();
 165         }
 166         m_pImpl->aListeners.clear();
 167     }
 168
 169     //---------------------------------------------------------------------
 170     void OEventListenerAdapter::startComponentListening( const Reference< XComponent >& _rxComp )
 171     {
 172         if (!_rxComp.is())
 173         {
 174             OSL_ENSURE(sal_False, "OEventListenerAdapter::startComponentListening: invalid component!");
 175             return;
 176         }
 177
 178         OEventListenerImpl* pListenerImpl = new OEventListenerImpl(this, _rxComp);
 179         pListenerImpl->acquire();
 180         m_pImpl->aListeners.push_back(pListenerImpl);
 181     }
 182
 183 //.........................................................................
 184 }       // namespace utl
 185 //.........................................................................