diff options
Diffstat (limited to 'unotools/source/misc/sharedunocomponent.cxx')
| -rw-r--r-- | unotools/source/misc/sharedunocomponent.cxx | 246 |
1 files changed, 246 insertions, 0 deletions
diff --git a/unotools/source/misc/sharedunocomponent.cxx b/unotools/source/misc/sharedunocomponent.cxx new file mode 100644 index 000000000000..5402ebc06085 --- /dev/null +++ b/unotools/source/misc/sharedunocomponent.cxx @@ -0,0 +1,246 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +// MARKER(update_precomp.py): autogen include statement, do not remove +#include "precompiled_unotools.hxx" +#include <unotools/sharedunocomponent.hxx> +#include <com/sun/star/lang/XComponent.hpp> +#include <com/sun/star/util/XCloseable.hpp> +#include <cppuhelper/implbase1.hxx> +#include <tools/debug.hxx> + +//............................................................................ +namespace utl +{ +//............................................................................ + + using ::com::sun::star::uno::XInterface; + using ::com::sun::star::uno::Reference; + using ::com::sun::star::uno::Exception; + using ::com::sun::star::uno::UNO_QUERY; + using ::com::sun::star::uno::RuntimeException; + using ::com::sun::star::lang::XComponent; + using ::com::sun::star::lang::EventObject; + using ::com::sun::star::util::XCloseable; + using ::com::sun::star::util::XCloseListener; + using ::com::sun::star::util::CloseVetoException; + + //======================================================================== + //= DisposableComponent + //======================================================================== + //------------------------------------------------------------------------ + DisposableComponent::DisposableComponent( const Reference< XInterface >& _rxComponent ) + :m_xComponent( _rxComponent, UNO_QUERY ) + { + DBG_ASSERT( m_xComponent.is() || !_rxComponent.is(), "DisposableComponent::DisposableComponent: should be an XComponent!" ); + } + + //------------------------------------------------------------------------ + DisposableComponent::~DisposableComponent() + { + if ( m_xComponent.is() ) + { + try + { + m_xComponent->dispose(); + } + catch( const Exception& ) + { + OSL_ENSURE( sal_False, "DisposableComponent::~DisposableComponent: caught an exception!" ); + } + m_xComponent.clear(); + } + } + + //======================================================================== + //= CloseableComponentImpl + //======================================================================== + DBG_NAME( CloseableComponentImpl ) + typedef ::cppu::WeakImplHelper1 < XCloseListener + > CloseableComponentImpl_Base; + class CloseableComponentImpl : public CloseableComponentImpl_Base + { + private: + Reference< XCloseable > m_xCloseable; + + public: + CloseableComponentImpl( const Reference< XInterface >& _rxComponent ); + + /** closes the component + + @nofail + */ + void nf_closeComponent(); + + protected: + virtual ~CloseableComponentImpl(); + + // XCloseListener overridables + virtual void SAL_CALL queryClosing( const EventObject& Source, ::sal_Bool GetsOwnership ) throw (CloseVetoException, RuntimeException); + virtual void SAL_CALL notifyClosing( const EventObject& Source ) throw (RuntimeException); + + // XEventListener overridables + virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException); + + private: + /** starts or stops being a CloseListener at the component + + Only to be called upon construction of the instance, or when the component + is to be closed. + + @nofail + */ + void impl_nf_switchListening( bool _bListen ); + + + private: + CloseableComponentImpl(); // never implemented + CloseableComponentImpl( const CloseableComponentImpl& ); // never implemented + CloseableComponentImpl& operator=( const CloseableComponentImpl& ); // never implemented + }; + + //------------------------------------------------------------------------ + CloseableComponentImpl::CloseableComponentImpl( const Reference< XInterface >& _rxComponent ) + :m_xCloseable( _rxComponent, UNO_QUERY ) + { + DBG_CTOR( CloseableComponentImpl, NULL ); + DBG_ASSERT( m_xCloseable.is() || !_rxComponent.is(), "CloseableComponentImpl::CloseableComponentImpl: component is not an XCloseable!" ); + impl_nf_switchListening( true ); + } + //------------------------------------------------------------------------ + CloseableComponentImpl::~CloseableComponentImpl() + { + nf_closeComponent(); + DBG_DTOR( CloseableComponentImpl, NULL ); + } + + //------------------------------------------------------------------------ + void CloseableComponentImpl::nf_closeComponent() + { + if ( !m_xCloseable.is() ) + // nothing to do + return; + + // stop listening + impl_nf_switchListening( false ); + + // close + try + { + m_xCloseable->close( sal_True ); + } + catch( const CloseVetoException& ) { /* fine */ } + catch( const Exception& ) + { + OSL_ENSURE( sal_False, "CloseableComponentImpl::nf_closeComponent: caught an unexpected exception!" ); + } + + // reset + m_xCloseable.clear(); + } + + //------------------------------------------------------------------------ + void CloseableComponentImpl::impl_nf_switchListening( bool _bListen ) + { + if ( !m_xCloseable.is() ) + return; + + try + { + if ( _bListen ) + m_xCloseable->addCloseListener( this ); + else + m_xCloseable->removeCloseListener( this ); + } + catch( const Exception& ) + { + OSL_ENSURE( sal_False, "CloseableComponentImpl::impl_nf_switchListening: caught an exception!" ); + } + } + + //-------------------------------------------------------------------- + void SAL_CALL CloseableComponentImpl::queryClosing( const EventObject& + #ifdef DBG_UTIL + Source + #endif + , ::sal_Bool /*GetsOwnership*/ ) throw (CloseVetoException, RuntimeException) + { + // as long as we live, somebody wants to keep the object alive. So, veto the + // closing + DBG_ASSERT( Source.Source == m_xCloseable, "CloseableComponentImpl::queryClosing: where did this come from?" ); + throw CloseVetoException(); + } + + //-------------------------------------------------------------------- + void SAL_CALL CloseableComponentImpl::notifyClosing( const EventObject& + #ifdef DBG_UTIL + Source + #endif + ) throw (RuntimeException) + { + DBG_ASSERT( Source.Source == m_xCloseable, "CloseableComponentImpl::notifyClosing: where did this come from?" ); + + // this should be unreachable: As long as we're a CloseListener, we veto the closing. If we're going + // to close the component ourself, then we revoke ourself as listener *before* the close call. So, + // if this here fires, something went definately wrong. + DBG_ERROR( "CloseableComponentImpl::notifyClosing: unreachable!" ); + } + + //-------------------------------------------------------------------- + void SAL_CALL CloseableComponentImpl::disposing( const EventObject& + #ifdef DBG_UTIL + Source + #endif + ) throw (RuntimeException) + { + DBG_ASSERT( Source.Source == m_xCloseable, "CloseableComponentImpl::disposing: where did this come from?" ); + DBG_ERROR( "CloseableComponentImpl::disposing: unreachable!" ); + // same reasoning for this assertion as in ->notifyClosing + } + + //======================================================================== + //= CloseableComponentImpl + //======================================================================== + DBG_NAME( CloseableComponent ) + //------------------------------------------------------------------------ + CloseableComponent::CloseableComponent( const Reference< XInterface >& _rxComponent ) + :m_pImpl( new CloseableComponentImpl( _rxComponent ) ) + { + DBG_CTOR( CloseableComponent, NULL ); + } + + //------------------------------------------------------------------------ + CloseableComponent::~CloseableComponent() + { + // close the component, deliver ownership to anybody who wants to veto the close + m_pImpl->nf_closeComponent(); + DBG_DTOR( CloseableComponent, NULL ); + } + +//............................................................................ +} // namespace utl +//............................................................................ |