dtrans/source/win32/clipb/WinClipbImpl.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: WinClipbImpl.cxx,v $
  10  * $Revision: 1.20 $
  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_dtrans.hxx"
  33
  34 //------------------------------------------------------------------------
  35 // includes
  36 //------------------------------------------------------------------------
  37 #include <osl/diagnose.h>
  38 #include "WinClipbImpl.hxx"
  39
  40 #include <systools/win32/comtools.hxx>
  41 #include "..\..\inc\DtObjFactory.hxx"
  42 #include "..\dtobj\APNDataObject.hxx"
  43 #include "WinClipboard.hxx"
  44 #include <com/sun/star/datatransfer/clipboard/RenderingCapabilities.hpp>
  45 #include "..\dtobj\XNotifyingDataObject.hxx"
  46
  47 #if defined _MSC_VER
  48 #pragma warning(push,1)
  49 #endif
  50 #include <windows.h>
  51 #include <ole2.h>
  52 #include <objidl.h>
  53 #if defined _MSC_VER
  54 #pragma warning(pop)
  55 #endif
  56
  57 //------------------------------------------------------------------------
  58 // namespace directives
  59 //------------------------------------------------------------------------
  60
  61 using namespace rtl;
  62 using namespace osl;
  63 using namespace std;
  64 using namespace cppu;
  65
  66 using namespace com::sun::star::uno;
  67 using namespace com::sun::star::datatransfer;
  68 using namespace com::sun::star::datatransfer::clipboard;
  69 using namespace com::sun::star::datatransfer::clipboard::RenderingCapabilities;
  70
  71 //------------------------------------------------------------------------
  72 // deklarations
  73 //------------------------------------------------------------------------
  74
  75 // definition of static members
  76 CWinClipbImpl* CWinClipbImpl::s_pCWinClipbImpl = NULL;
  77 osl::Mutex     CWinClipbImpl::s_aMutex;
  78
  79 //------------------------------------------------------------------------
  80 //
  81 //------------------------------------------------------------------------
  82
  83 CWinClipbImpl::CWinClipbImpl( const OUString& aClipboardName, CWinClipboard* theWinClipboard ) :
  84     m_itsName( aClipboardName ),
  85     m_pWinClipboard( theWinClipboard ),
  86     m_pCurrentClipContent( NULL )
  87 {
  88     OSL_ASSERT( NULL != m_pWinClipboard );
  89
  90     // necessary to reassociate from
  91     // the static callback function
  92     s_pCWinClipbImpl = this;
  93     registerClipboardViewer( );
  94 }
  95
  96 //------------------------------------------------------------------------
  97 //
  98 //------------------------------------------------------------------------
  99
 100 CWinClipbImpl::~CWinClipbImpl( )
 101 {
 102     ClearableMutexGuard aGuard( s_aMutex );
 103     s_pCWinClipbImpl = NULL;
 104     aGuard.clear( );
 105
 106     unregisterClipboardViewer( );
 107 }
 108
 109 //------------------------------------------------------------------------
 110 // getContent
 111 //------------------------------------------------------------------------
 112
 113 Reference< XTransferable > SAL_CALL CWinClipbImpl::getContents( ) throw( RuntimeException )
 114 {
 115     // use the shotcut or create a transferable from
 116     // system clipboard
 117     ClearableMutexGuard aGuard( m_ClipContentMutex );
 118
 119     if ( NULL != m_pCurrentClipContent )
 120     {
 121         return m_pCurrentClipContent->m_XTransferable;
 122     }
 123
 124     // release the mutex, so that the variable may be
 125     // changed by other threads
 126     aGuard.clear( );
 127
 128     Reference< XTransferable > rClipContent;
 129
 130     // get the current dataobject from clipboard
 131     IDataObjectPtr pIDataObject;
 132     HRESULT hr = m_MtaOleClipboard.getClipboard( &pIDataObject );
 133
 134     if ( SUCCEEDED( hr ) )
 135     {
 136         // create an apartment neutral dataobject and initialize it with a
 137         // com smart pointer to the IDataObject from clipboard
 138         IDataObjectPtr pIDo( new CAPNDataObject( pIDataObject ) );
 139
 140         CDTransObjFactory objFactory;
 141
 142         // remeber pIDo destroys itself due to the smart pointer
 143         rClipContent = objFactory.createTransferableFromDataObj( m_pWinClipboard->m_SrvMgr, pIDo );
 144     }
 145
 146     return rClipContent;
 147 }
 148
 149 //------------------------------------------------------------------------
 150 // setContent
 151 //------------------------------------------------------------------------
 152
 153 void SAL_CALL CWinClipbImpl::setContents(
 154     const Reference< XTransferable >& xTransferable,
 155     const Reference< XClipboardOwner >& xClipboardOwner )
 156     throw( RuntimeException )
 157 {
 158     CDTransObjFactory objFactory;
 159     IDataObjectPtr    pIDataObj;
 160
 161     if ( xTransferable.is( ) )
 162     {
 163         ClearableMutexGuard aGuard( m_ClipContentMutex );
 164
 165         m_pCurrentClipContent = new CXNotifyingDataObject(
 166             objFactory.createDataObjFromTransferable( m_pWinClipboard->m_SrvMgr , xTransferable ),
 167             xTransferable,
 168             xClipboardOwner,
 169             this );
 170
 171         aGuard.clear( );
 172
 173         pIDataObj = IDataObjectPtr( m_pCurrentClipContent );
 174     }
 175
 176     m_MtaOleClipboard.setClipboard(pIDataObj.get());
 177 }
 178
 179 //------------------------------------------------------------------------
 180 //
 181 //------------------------------------------------------------------------
 182
 183 OUString SAL_CALL CWinClipbImpl::getName(  ) throw( RuntimeException )
 184 {
 185     return m_itsName;
 186 }
 187
 188 //------------------------------------------------------------------------
 189 //
 190 //------------------------------------------------------------------------
 191
 192 sal_Int8 SAL_CALL CWinClipbImpl::getRenderingCapabilities(  ) throw( RuntimeException )
 193 {
 194     return ( Delayed | Persistant );
 195 }
 196
 197 //------------------------------------------------------------------------
 198 //
 199 //------------------------------------------------------------------------
 200
 201 void SAL_CALL CWinClipbImpl::flushClipboard( ) throw( RuntimeException )
 202 {
 203     // sollte eigentlich hier stehen: ClearableMutexGuard aGuard( m_ClipContentMutex );
 204     // geht aber nicht, da FlushClipboard zurückruft und das DataObject
 205     // freigibt und damit würde es einen Deadlock in onReleaseDataObject geben
 206     // FlushClipboard muß synchron sein, damit das runterfahren ggf. erst weitergeht,
 207     // wenn alle Clipboard-Formate gerendert wurden
 208     // die Abfrage ist nötig, damit nur geflusht wird, wenn wir wirklich Clipboardowner
 209     // sind (ich weiss nicht genau was passiert, wenn man flusht und nicht Clipboard
 210     // owner ist).
 211     // eventuell kann man aber die Abfrage in den Clipboard STA Thread verlagern, indem
 212     // man sich dort das DataObject merkt und vor dem flushen OleIsCurrentClipboard ruft
 213
 214     if ( NULL != m_pCurrentClipContent )
 215         m_MtaOleClipboard.flushClipboard( );
 216 }
 217
 218 //------------------------------------------------------------------------
 219 //
 220 //------------------------------------------------------------------------
 221
 222 void SAL_CALL CWinClipbImpl::registerClipboardViewer( )
 223 {
 224     m_MtaOleClipboard.registerClipViewer( CWinClipbImpl::onClipboardContentChanged );
 225 }
 226
 227 //------------------------------------------------------------------------
 228 //
 229 //------------------------------------------------------------------------
 230
 231 void SAL_CALL CWinClipbImpl::unregisterClipboardViewer( )
 232 {
 233     m_MtaOleClipboard.registerClipViewer( NULL );
 234 }
 235
 236 //------------------------------------------------------------------------
 237 //
 238 //------------------------------------------------------------------------
 239
 240 void SAL_CALL CWinClipbImpl::dispose() throw( RuntimeException )
 241 {
 242     OSL_ENSURE( !m_pCurrentClipContent, "Clipboard was not flushed before shutdown!" );
 243 }
 244
 245 //------------------------------------------------------------------------
 246 //
 247 //------------------------------------------------------------------------
 248
 249 void WINAPI CWinClipbImpl::onClipboardContentChanged( void )
 250 {
 251     MutexGuard aGuard( s_aMutex );
 252
 253     // reassocition to instance through static member
 254     if ( NULL != s_pCWinClipbImpl )
 255         s_pCWinClipbImpl->m_pWinClipboard->notifyAllClipboardListener( );
 256 }
 257
 258 //------------------------------------------------------------------------
 259 //
 260 //------------------------------------------------------------------------
 261
 262 void SAL_CALL CWinClipbImpl::onReleaseDataObject( CXNotifyingDataObject* theCaller )
 263 {
 264     OSL_ASSERT( NULL != theCaller );
 265
 266     if ( theCaller )
 267         theCaller->lostOwnership( );
 268
 269     // if the current caller is the one we currently
 270     // hold, then set it to NULL because an external
 271     // source must be the clipboardowner now
 272     MutexGuard aGuard( m_ClipContentMutex );
 273
 274     if ( m_pCurrentClipContent == theCaller )
 275         m_pCurrentClipContent = NULL;
 276 }