vcl/win/dtrans/MtaOleClipb.hxx

   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 #pragma once
  21
  22 #include <sal/types.h>
  23 #include <osl/mutex.hxx>
  24
  25 #include <objidl.h>
  26
  27 // the Mta-Ole clipboard class is for internal use only!
  28 // only one instance of this class should be created, the
  29 // user has to ensure this!
  30 // the class is not thread-safe because it will be used
  31 // only from within the clipboard service and the methods
  32 // of the clipboard service are already synchronized
  33
  34 class CMtaOleClipboard
  35 {
  36 public:
  37     typedef void ( WINAPI *LPFNC_CLIPVIEWER_CALLBACK_t )( void );
  38
  39 public:
  40     CMtaOleClipboard( );
  41     ~CMtaOleClipboard( );
  42
  43     // clipboard functions
  44     HRESULT setClipboard( IDataObject* pIDataObject );
  45     HRESULT getClipboard( IDataObject** ppIDataObject );
  46     HRESULT flushClipboard( );
  47
  48     // register/unregister a clipboard viewer; there can only
  49     // be one at a time; parameter NULL means unregister
  50     // a clipboard viewer
  51     // returns true on success else false; use GetLastError( ) in
  52     // false case
  53     bool registerClipViewer( LPFNC_CLIPVIEWER_CALLBACK_t pfncClipViewerCallback );
  54
  55 private:
  56     unsigned int run( );
  57
  58     // create a hidden window which serves as a request target; so we
  59     // guarantee synchronization
  60     void createMtaOleReqWnd( );
  61
  62     // message support
  63     bool     postMessage( UINT msg, WPARAM wParam = 0, LPARAM lParam = 0 );
  64     LRESULT  sendMessage( UINT msg, WPARAM wParam = 0, LPARAM lParam = 0 );
  65
  66     // message handler functions; remember these functions are called
  67     // from a different thread context!
  68
  69     static HRESULT onSetClipboard( IDataObject* pIDataObject );
  70     static HRESULT onGetClipboard( LPSTREAM* ppStream );
  71     static HRESULT onFlushClipboard( );
  72     bool     onRegisterClipViewer( LPFNC_CLIPVIEWER_CALLBACK_t pfncClipViewerCallback );
  73
  74     // win32 clipboard listener support
  75     LRESULT onClipboardUpdate();
  76
  77     static LRESULT CALLBACK mtaOleReqWndProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
  78     static unsigned int WINAPI oleThreadProc( LPVOID pParam );
  79
  80     static unsigned int WINAPI clipboardChangedNotifierThreadProc( LPVOID pParam );
  81
  82     bool WaitForThreadReady( ) const;
  83
  84 private:
  85     HANDLE                      m_hOleThread;
  86     unsigned                    m_uOleThreadId;
  87     HANDLE                      m_hEvtThrdReady;
  88     HWND                        m_hwndMtaOleReqWnd;
  89     HANDLE                      m_hEvtWndDisposed;
  90     ATOM                        m_MtaOleReqWndClassAtom;
  91     LPFNC_CLIPVIEWER_CALLBACK_t m_pfncClipViewerCallback;
  92     bool                        m_bInRegisterClipViewer;
  93
  94     bool                        m_bRunClipboardNotifierThread;
  95     HANDLE                      m_hClipboardChangedNotifierThread;
  96     HANDLE                      m_hClipboardChangedNotifierEvents[2];
  97     HANDLE&                     m_hClipboardChangedEvent;
  98     HANDLE&                     m_hTerminateClipboardChangedNotifierEvent;
  99     osl::Mutex                  m_ClipboardChangedEventCountMutex;
 100     sal_Int32                   m_ClipboardChangedEventCount;
 101
 102     osl::Mutex                  m_pfncClipViewerCallbackMutex;
 103
 104     static CMtaOleClipboard*    s_theMtaOleClipboardInst;
 105
 106 // not allowed
 107 private:
 108     CMtaOleClipboard( const CMtaOleClipboard& );
 109     CMtaOleClipboard& operator=( const CMtaOleClipboard& );
 110
 111     friend LRESULT CALLBACK mtaOleReqWndProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam );
 112 };
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */