dtrans/source/win32/clipb/WinClipbImpl.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 <osl/diagnose.h>
  21 #include "WinClipbImpl.hxx"
  22
  23 #include <systools/win32/comtools.hxx>
  24 #include "../../inc/DtObjFactory.hxx"
  25 #include "../dtobj/APNDataObject.hxx"
  26 #include "WinClipboard.hxx"
  27 #include <com/sun/star/datatransfer/clipboard/RenderingCapabilities.hpp>
  28 #include "../dtobj/XNotifyingDataObject.hxx"
  29
  30 #if defined _MSC_VER
  31 #pragma warning(push,1)
  32 #endif
  33 #include <windows.h>
  34 #include <ole2.h>
  35 #include <objidl.h>
  36 #if defined _MSC_VER
  37 #pragma warning(pop)
  38 #endif
  39
  40 //------------------------------------------------------------------------
  41 // namespace directives
  42 //------------------------------------------------------------------------
  43
  44 using namespace osl;
  45 using namespace std;
  46 using namespace cppu;
  47
  48 using namespace com::sun::star::uno;
  49 using namespace com::sun::star::datatransfer;
  50 using namespace com::sun::star::datatransfer::clipboard;
  51 using namespace com::sun::star::datatransfer::clipboard::RenderingCapabilities;
  52
  53
  54 // definition of static members
  55 CWinClipbImpl* CWinClipbImpl::s_pCWinClipbImpl = NULL;
  56 osl::Mutex     CWinClipbImpl::s_aMutex;
  57
  58 //------------------------------------------------------------------------
  59 //
  60 //------------------------------------------------------------------------
  61
  62 CWinClipbImpl::CWinClipbImpl( const OUString& aClipboardName, CWinClipboard* theWinClipboard ) :
  63     m_itsName( aClipboardName ),
  64     m_pWinClipboard( theWinClipboard ),
  65     m_pCurrentClipContent( NULL )
  66 {
  67     OSL_ASSERT( NULL != m_pWinClipboard );
  68
  69     // necessary to reassociate from
  70     // the static callback function
  71     s_pCWinClipbImpl = this;
  72     registerClipboardViewer( );
  73 }
  74
  75 //------------------------------------------------------------------------
  76 //
  77 //------------------------------------------------------------------------
  78
  79 CWinClipbImpl::~CWinClipbImpl( )
  80 {
  81     ClearableMutexGuard aGuard( s_aMutex );
  82     s_pCWinClipbImpl = NULL;
  83     aGuard.clear( );
  84
  85     unregisterClipboardViewer( );
  86 }
  87
  88 //------------------------------------------------------------------------
  89 // getContent
  90 //------------------------------------------------------------------------
  91
  92 Reference< XTransferable > SAL_CALL CWinClipbImpl::getContents( ) throw( RuntimeException )
  93 {
  94     // use the shotcut or create a transferable from
  95     // system clipboard
  96     ClearableMutexGuard aGuard( m_ClipContentMutex );
  97
  98     if ( NULL != m_pCurrentClipContent )
  99     {
 100         return m_pCurrentClipContent->m_XTransferable;
 101     }
 102
 103     // release the mutex, so that the variable may be
 104     // changed by other threads
 105     aGuard.clear( );
 106
 107     Reference< XTransferable > rClipContent;
 108
 109     // get the current dataobject from clipboard
 110     IDataObjectPtr pIDataObject;
 111     HRESULT hr = m_MtaOleClipboard.getClipboard( &pIDataObject );
 112
 113     if ( SUCCEEDED( hr ) )
 114     {
 115         // create an apartment neutral dataobject and initialize it with a
 116         // com smart pointer to the IDataObject from clipboard
 117         IDataObjectPtr pIDo( new CAPNDataObject( pIDataObject ) );
 118
 119         CDTransObjFactory objFactory;
 120
 121         // remember pIDo destroys itself due to the smart pointer
 122         rClipContent = objFactory.createTransferableFromDataObj( m_pWinClipboard->m_xContext, pIDo );
 123     }
 124
 125     return rClipContent;
 126 }
 127
 128 //------------------------------------------------------------------------
 129 // setContent
 130 //------------------------------------------------------------------------
 131
 132 void SAL_CALL CWinClipbImpl::setContents(
 133     const Reference< XTransferable >& xTransferable,
 134     const Reference< XClipboardOwner >& xClipboardOwner )
 135     throw( RuntimeException )
 136 {
 137     CDTransObjFactory objFactory;
 138     IDataObjectPtr    pIDataObj;
 139
 140     if ( xTransferable.is( ) )
 141     {
 142         ClearableMutexGuard aGuard( m_ClipContentMutex );
 143
 144         m_pCurrentClipContent = new CXNotifyingDataObject(
 145             objFactory.createDataObjFromTransferable( m_pWinClipboard->m_xContext , xTransferable ),
 146             xTransferable,
 147             xClipboardOwner,
 148             this );
 149
 150         aGuard.clear( );
 151
 152         pIDataObj = IDataObjectPtr( m_pCurrentClipContent );
 153     }
 154
 155     m_MtaOleClipboard.setClipboard(pIDataObj.get());
 156 }
 157
 158 //------------------------------------------------------------------------
 159 //
 160 //------------------------------------------------------------------------
 161
 162 OUString SAL_CALL CWinClipbImpl::getName(  ) throw( RuntimeException )
 163 {
 164     return m_itsName;
 165 }
 166
 167 //------------------------------------------------------------------------
 168 //
 169 //------------------------------------------------------------------------
 170
 171 sal_Int8 SAL_CALL CWinClipbImpl::getRenderingCapabilities(  ) throw( RuntimeException )
 172 {
 173     return ( Delayed | Persistant );
 174 }
 175
 176 //------------------------------------------------------------------------
 177 //
 178 //------------------------------------------------------------------------
 179
 180 void SAL_CALL CWinClipbImpl::flushClipboard( ) throw( RuntimeException )
 181 {
 182     // actually it should be ClearableMutexGuard aGuard( m_ClipContentMutex );
 183     // but it does not work since FlushClipboard does a callback and frees DataObject
 184     // which results in a deadlock in onReleaseDataObject.
 185     // FlushClipboard had to be synchron in order to prevent shutdown until all
 186     // clipboard-formats are redered.
 187     // The request is needed to prevent flushing if we are not clipboard owner (it is
 188     // not known what happens if we flush but aren't clipoard owner).
 189     // It may be possible to move the request to the clipboard STA thread by saving the
 190     // DataObject and call OleIsCurrentClipboard bevore flushing.
 191
 192     if ( NULL != m_pCurrentClipContent )
 193         m_MtaOleClipboard.flushClipboard( );
 194 }
 195
 196 //------------------------------------------------------------------------
 197 //
 198 //------------------------------------------------------------------------
 199
 200 void SAL_CALL CWinClipbImpl::registerClipboardViewer( )
 201 {
 202     m_MtaOleClipboard.registerClipViewer( CWinClipbImpl::onClipboardContentChanged );
 203 }
 204
 205 //------------------------------------------------------------------------
 206 //
 207 //------------------------------------------------------------------------
 208
 209 void SAL_CALL CWinClipbImpl::unregisterClipboardViewer( )
 210 {
 211     m_MtaOleClipboard.registerClipViewer( NULL );
 212 }
 213
 214 //------------------------------------------------------------------------
 215 //
 216 //------------------------------------------------------------------------
 217
 218 void SAL_CALL CWinClipbImpl::dispose() throw( RuntimeException )
 219 {
 220     OSL_ENSURE( !m_pCurrentClipContent, "Clipboard was not flushed before shutdown!" );
 221 }
 222
 223 //------------------------------------------------------------------------
 224 //
 225 //------------------------------------------------------------------------
 226
 227 void WINAPI CWinClipbImpl::onClipboardContentChanged( void )
 228 {
 229     MutexGuard aGuard( s_aMutex );
 230
 231     // reassocition to instance through static member
 232     if ( NULL != s_pCWinClipbImpl )
 233         s_pCWinClipbImpl->m_pWinClipboard->notifyAllClipboardListener( );
 234 }
 235
 236 //------------------------------------------------------------------------
 237 //
 238 //------------------------------------------------------------------------
 239
 240 void SAL_CALL CWinClipbImpl::onReleaseDataObject( CXNotifyingDataObject* theCaller )
 241 {
 242     OSL_ASSERT( NULL != theCaller );
 243
 244     if ( theCaller )
 245         theCaller->lostOwnership( );
 246
 247     // if the current caller is the one we currently
 248     // hold, then set it to NULL because an external
 249     // source must be the clipboardowner now
 250     MutexGuard aGuard( m_ClipContentMutex );
 251
 252     if ( m_pCurrentClipContent == theCaller )
 253         m_pCurrentClipContent = NULL;
 254 }
 255
 256 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */