Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 199 insertions, 0 deletions

diff --git a/unotools/source/misc/sharedunocomponent.cxx b/unotools/source/misc/sharedunocomponent.cxx
new file mode 100644
index 000000000..789054104
--- /dev/null
+++ b/unotools/source/misc/sharedunocomponent.cxx
@@ -0,0 +1,199 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#include <sal/config.h>
+#include <osl/diagnose.h>
+
+#include <unotools/sharedunocomponent.hxx>
+#include <com/sun/star/lang/XComponent.hpp>
+#include <com/sun/star/util/CloseVetoException.hpp>
+#include <com/sun/star/util/XCloseable.hpp>
+#include <cppuhelper/implbase.hxx>
+#include <tools/debug.hxx>
+#include <tools/diagnose_ex.h>
+
+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::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& )
+            {
+                TOOLS_WARN_EXCEPTION( "unotools", "DisposableComponent::~DisposableComponent" );
+            }
+            m_xComponent.clear();
+        }
+    }
+
+    typedef ::cppu::WeakImplHelper <   XCloseListener
+                                    >   CloseableComponentImpl_Base;
+    class CloseableComponentImpl : public CloseableComponentImpl_Base
+    {
+    private:
+        Reference< XCloseable > m_xCloseable;
+
+        CloseableComponentImpl(const CloseableComponentImpl&) = delete;
+        CloseableComponentImpl& operator=(const CloseableComponentImpl&) = delete;
+
+    public:
+        explicit CloseableComponentImpl( const Reference< XInterface >& _rxComponent );
+
+        /** closes the component
+
+            @nofail
+        */
+        void    nf_closeComponent();
+
+    protected:
+        virtual ~CloseableComponentImpl() override;
+
+        // XCloseListener overridables
+        virtual void SAL_CALL queryClosing( const EventObject& Source, sal_Bool GetsOwnership ) override;
+        virtual void SAL_CALL notifyClosing( const EventObject& Source ) override;
+
+        // XEventListener overridables
+        virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
+
+    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 );
+    };
+
+    CloseableComponentImpl::CloseableComponentImpl( const Reference< XInterface >& _rxComponent )
+        :m_xCloseable( _rxComponent, UNO_QUERY )
+    {
+        DBG_ASSERT( m_xCloseable.is() || !_rxComponent.is(), "CloseableComponentImpl::CloseableComponentImpl: component is not an XCloseable!" );
+        impl_nf_switchListening( true );
+    }
+
+    CloseableComponentImpl::~CloseableComponentImpl()
+    {
+        nf_closeComponent();
+    }
+
+    void CloseableComponentImpl::nf_closeComponent()
+    {
+        if ( !m_xCloseable.is() )
+            // nothing to do
+            return;
+
+        // stop listening
+        impl_nf_switchListening( false );
+
+        // close
+        try
+        {
+            m_xCloseable->close( true );
+        }
+        catch( const CloseVetoException& ) { /* fine */ }
+        catch( const Exception& )
+        {
+            OSL_FAIL( "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& )
+        {
+            TOOLS_WARN_EXCEPTION( "unotools", "CloseableComponentImpl::impl_nf_switchListening" );
+        }
+    }
+
+    void SAL_CALL CloseableComponentImpl::queryClosing( const EventObject& Source, sal_Bool /*GetsOwnership*/ )
+    {
+        // 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& Source )
+    {
+        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 definitely wrong.
+        OSL_FAIL( "CloseableComponentImpl::notifyClosing: unreachable!" );
+    }
+
+    void SAL_CALL CloseableComponentImpl::disposing( const EventObject& Source )
+    {
+        DBG_ASSERT( Source.Source == m_xCloseable, "CloseableComponentImpl::disposing: where did this come from?" );
+        OSL_FAIL( "CloseableComponentImpl::disposing: unreachable!" );
+            // same reasoning for this assertion as in ->notifyClosing
+    }
+
+    CloseableComponent::CloseableComponent( const Reference< XInterface >& _rxComponent )
+        :m_pImpl( new CloseableComponentImpl( _rxComponent ) )
+    {
+    }
+
+    CloseableComponent::~CloseableComponent()
+    {
+        // close the component, deliver ownership to anybody who wants to veto the close
+        m_pImpl->nf_closeComponent();
+    }
+
+}   // namespace utl
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */