toolkit/source/hatchwindow/documentcloser.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 <com/sun/star/uno/XComponentContext.hpp>
  21 #include <com/sun/star/util/XCloseable.hpp>
  22 #include <com/sun/star/lang/DisposedException.hpp>
  23 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  24 #include <com/sun/star/lang/XComponent.hpp>
  25 #include <com/sun/star/lang/XServiceInfo.hpp>
  26 #include <com/sun/star/frame/XFrame.hpp>
  27 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  28 #include <cppuhelper/implbase.hxx>
  29 #include <comphelper/interfacecontainer4.hxx>
  30 #include <cppuhelper/supportsservice.hxx>
  31 #include <utility>
  32 #include <vcl/svapp.hxx>
  33 #include <vcl/dialoghelper.hxx>
  34 #include <vcl/window.hxx>
  35 #include <tools/link.hxx>
  36 #include <toolkit/helper/vclunohelper.hxx>
  37
  38 using namespace ::com::sun::star;
  39
  40 namespace {
  41
  42 // the service is implemented as a wrapper to be able to die by refcount
  43 // the disposing mechanics is required for java related scenarios
  44 class ODocumentCloser : public ::cppu::WeakImplHelper< css::lang::XComponent,
  45                                                         css::lang::XServiceInfo >
  46 {
  47     std::mutex m_aMutex;
  48     css::uno::Reference< css::frame::XFrame > m_xFrame;
  49     ::comphelper::OInterfaceContainerHelper4<lang::XEventListener> m_aListenersContainer; // list of listeners
  50
  51     bool m_bDisposed;
  52
  53 public:
  54     explicit ODocumentCloser(const css::uno::Sequence< css::uno::Any >& aArguments);
  55
  56 // XComponent
  57     virtual void SAL_CALL dispose() override;
  58     virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
  59     virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
  60
  61 // XServiceInfo
  62     virtual OUString SAL_CALL getImplementationName(  ) override;
  63     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
  64     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
  65 };
  66
  67 class MainThreadFrameCloserRequest
  68 {
  69     uno::Reference< frame::XFrame > m_xFrame;
  70
  71     public:
  72         explicit MainThreadFrameCloserRequest( uno::Reference< frame::XFrame > xFrame )
  73         : m_xFrame(std::move( xFrame ))
  74         {}
  75
  76         DECL_STATIC_LINK( MainThreadFrameCloserRequest, worker, void*, void );
  77
  78         static void Start( MainThreadFrameCloserRequest* pRequest );
  79 };
  80
  81
  82 void MainThreadFrameCloserRequest::Start( MainThreadFrameCloserRequest* pMTRequest )
  83 {
  84     if ( pMTRequest )
  85     {
  86         if ( Application::IsMainThread() )
  87         {
  88             // this is the main thread
  89             worker( nullptr, pMTRequest );
  90         }
  91         else
  92             Application::PostUserEvent( LINK( nullptr, MainThreadFrameCloserRequest, worker ), pMTRequest );
  93     }
  94 }
  95
  96
  97 IMPL_STATIC_LINK( MainThreadFrameCloserRequest, worker, void*, p, void )
  98 {
  99     MainThreadFrameCloserRequest* pMTRequest = static_cast<MainThreadFrameCloserRequest*>(p);
 100     if ( !pMTRequest )
 101         return;
 102
 103     if ( pMTRequest->m_xFrame.is() )
 104     {
 105         // this is the main thread, the solar mutex must be locked
 106         SolarMutexGuard aGuard;
 107
 108         try
 109         {
 110             uno::Reference< awt::XWindow > xWindow = pMTRequest->m_xFrame->getContainerWindow();
 111             uno::Reference< awt::XVclWindowPeer > xWinPeer( xWindow, uno::UNO_QUERY );
 112             if (xWinPeer)
 113             {
 114                 xWindow->setVisible( false );
 115
 116                 // reparent the window
 117                 xWinPeer->setProperty( u"PluginParent"_ustr, uno::Any( sal_Int64(0) ) );
 118
 119                 VclPtr<vcl::Window> pWindow = VCLUnoHelper::GetWindow( xWindow );
 120                 if (pWindow)
 121                     vcl::EndAllDialogs(pWindow);
 122             }
 123         }
 124         catch( uno::Exception& )
 125         {
 126             // ignore all the errors
 127         }
 128
 129         try
 130         {
 131             uno::Reference< util::XCloseable > xCloseable( pMTRequest->m_xFrame, uno::UNO_QUERY );
 132             if (xCloseable)
 133                 xCloseable->close( true );
 134         }
 135         catch( uno::Exception& )
 136         {
 137             // ignore all the errors
 138         }
 139     }
 140
 141     delete pMTRequest;
 142 }
 143
 144 ODocumentCloser::ODocumentCloser(const css::uno::Sequence< css::uno::Any >& aArguments)
 145 : m_bDisposed( false )
 146 {
 147     std::unique_lock aGuard( m_aMutex );
 148     if ( !m_refCount )
 149         throw uno::RuntimeException(); // the object must be refcounted already!
 150
 151     sal_Int32 nLen = aArguments.getLength();
 152     if ( nLen != 1 )
 153         throw lang::IllegalArgumentException(
 154                         u"Wrong count of parameters!"_ustr,
 155                         uno::Reference< uno::XInterface >(),
 156                         0 );
 157
 158     if ( !( aArguments[0] >>= m_xFrame ) || !m_xFrame.is() )
 159         throw lang::IllegalArgumentException(
 160                 u"Nonempty reference is expected as the first argument!"_ustr,
 161                 uno::Reference< uno::XInterface >(),
 162                 0 );
 163 }
 164
 165
 166 // XComponent
 167
 168 void SAL_CALL ODocumentCloser::dispose()
 169 {
 170     std::unique_lock aGuard( m_aMutex );
 171
 172     if ( m_bDisposed )
 173         return;
 174
 175     lang::EventObject aSource( getXWeak() );
 176     m_aListenersContainer.disposeAndClear( aGuard, aSource );
 177
 178     // TODO: trigger a main thread execution to close the frame
 179     if ( m_xFrame.is() )
 180     {
 181         // the created object will be deleted after thread execution
 182         MainThreadFrameCloserRequest* pCloser = new MainThreadFrameCloserRequest( m_xFrame );
 183         MainThreadFrameCloserRequest::Start( pCloser );
 184     }
 185
 186     m_bDisposed = true;
 187 }
 188
 189
 190 void SAL_CALL ODocumentCloser::addEventListener( const uno::Reference< lang::XEventListener >& xListener )
 191 {
 192     std::unique_lock aGuard( m_aMutex );
 193     if ( m_bDisposed )
 194         throw lang::DisposedException(); // TODO
 195
 196     m_aListenersContainer.addInterface( aGuard, xListener );
 197 }
 198
 199
 200 void SAL_CALL ODocumentCloser::removeEventListener( const uno::Reference< lang::XEventListener >& xListener )
 201 {
 202     std::unique_lock aGuard( m_aMutex );
 203     m_aListenersContainer.removeInterface( aGuard, xListener );
 204 }
 205
 206 // XServiceInfo
 207 OUString SAL_CALL ODocumentCloser::getImplementationName(  )
 208 {
 209     return u"com.sun.star.comp.embed.DocumentCloser"_ustr;
 210 }
 211
 212 sal_Bool SAL_CALL ODocumentCloser::supportsService( const OUString& ServiceName )
 213 {
 214     return cppu::supportsService(this, ServiceName);
 215 }
 216
 217 uno::Sequence< OUString > SAL_CALL ODocumentCloser::getSupportedServiceNames()
 218 {
 219     return { u"com.sun.star.embed.DocumentCloser"_ustr };
 220 }
 221
 222 }
 223
 224 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 225 com_sun_star_comp_embed_DocumentCloser_get_implementation(
 226     SAL_UNUSED_PARAMETER css::uno::XComponentContext *,
 227     css::uno::Sequence<css::uno::Any> const &arguments)
 228 {
 229     return cppu::acquire(new ODocumentCloser(arguments));
 230 }
 231
 232 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */