diff options
Diffstat (limited to 'dtrans/source/win32/dtobj/DTransHelper.hxx')
| -rw-r--r-- | dtrans/source/win32/dtobj/DTransHelper.hxx | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/dtrans/source/win32/dtobj/DTransHelper.hxx b/dtrans/source/win32/dtobj/DTransHelper.hxx new file mode 100644 index 000000000000..7975b84eec57 --- /dev/null +++ b/dtrans/source/win32/dtobj/DTransHelper.hxx @@ -0,0 +1,214 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + + +#ifndef _DTRANSHELPER_HXX_ +#define _DTRANSHELPER_HXX_ + +//------------------------------------------------------------------------ +// includes +//------------------------------------------------------------------------ + +#if defined _MSC_VER +#pragma warning(push,1) +#endif +#include <windows.h> +#if defined _MSC_VER +#pragma warning(pop) +#endif +#include "..\misc\WinClip.hxx" + +//------------------------------------------------------------------------ +// defines +//------------------------------------------------------------------------ + +#define AUTO_INIT TRUE +#define NO_AUTO_INIT FALSE +#define MEM_DESTROY_ON_RELEASE TRUE +#define NO_MEM_DESTROY_ON_RELEASE FALSE + +//------------------------------------------------------------------------ +// deklarations +//------------------------------------------------------------------------ + + +//------------------------------------------------------------------------- +// a helper class to manage a global memory area, the clients can write +// into the global memory area and extract the handle to the global mem +// note: not thread-safe +//------------------------------------------------------------------------- + +class CStgTransferHelper +{ +public: + // will be thrown in case of failures + class CStgTransferException + { + public: + HRESULT m_hr; + CStgTransferException( HRESULT hr ) : m_hr( hr ) {}; + }; + +public: + CStgTransferHelper( + sal_Bool bAutoInit = sal_False, + HGLOBAL hGlob = NULL, + sal_Bool bDelStgOnRelease = sal_False ); + + ~CStgTransferHelper( ); + + void SAL_CALL write( const void* lpData, ULONG cb, ULONG* cbWritten = NULL ); + void SAL_CALL read( LPVOID pv, ULONG cb, ULONG* pcbRead = NULL ); + + HGLOBAL SAL_CALL getHGlobal( ) const; + void SAL_CALL getIStream( LPSTREAM* ppStream ); + + void SAL_CALL init( + SIZE_T newSize, + sal_uInt32 uiFlags = GHND, + sal_Bool bDelStgOnRelease = sal_False ); + + void SAL_CALL init( + HGLOBAL hGlob, + sal_Bool bDelStgOnRelease = sal_False ); + + // returns the size of the managed memory + sal_uInt32 SAL_CALL memSize( CLIPFORMAT cf = CF_INVALID ) const; + + // free the global memory and necessary + // release the internal stream pointer + void SAL_CALL cleanup( ); + +private: + LPSTREAM m_lpStream; + sal_Bool m_bDelStgOnRelease; + +private: + CStgTransferHelper( const CStgTransferHelper& ); + CStgTransferHelper& operator=( const CStgTransferHelper& ); +}; + +//------------------------------------------------------------------------- +// something like an auto-pointer - allows access to the memory belonging +// to a HGLOBAL and automatically unlocks a global memory at destruction +// time +//------------------------------------------------------------------------- + +class CRawHGlobalPtr +{ +public: + + //--------------------------------------------- + // ctor + //--------------------------------------------- + + CRawHGlobalPtr( HGLOBAL hGlob ) : + m_hGlob( hGlob ), + m_bIsLocked( FALSE ), + m_pGlobMem( NULL ) + { + } + + + //--------------------------------------------- + // ctor + //--------------------------------------------- + + CRawHGlobalPtr( const CStgTransferHelper& theHGlobalHelper ) : + m_hGlob( theHGlobalHelper.getHGlobal( ) ), + m_bIsLocked( FALSE ), + m_pGlobMem( NULL ) + { + } + + //--------------------------------------------- + // dtor + //--------------------------------------------- + + ~CRawHGlobalPtr( ) + { + if ( m_bIsLocked ) + GlobalUnlock( m_hGlob ); + } + + //--------------------------------------------- + // lock the global memory (initializes a + // pointer to this memory) + //--------------------------------------------- + + BOOL Lock( ) + { + if ( !m_bIsLocked && ( NULL != m_hGlob ) ) + { + m_pGlobMem = GlobalLock( m_hGlob ); + m_bIsLocked = ( NULL != m_pGlobMem ); + } + + return m_bIsLocked; + } + + //--------------------------------------------- + // unlock the global memory (invalidates the + // pointer to this memory) + //--------------------------------------------- + + BOOL Unlock( ) + { + GlobalUnlock( m_hGlob ); + m_bIsLocked = FALSE; + m_pGlobMem = NULL; + + return ( NO_ERROR == GetLastError( ) ); + } + + //--------------------------------------------- + // locks the global memory and returns a + // pointer to this memory + //--------------------------------------------- + + LPVOID GetMemPtr( ) + { + Lock( ); + return m_pGlobMem; + } + + //--------------------------------------------- + // size of mem we point to + //--------------------------------------------- + + int MemSize( ) const + { + return GlobalSize( m_hGlob ); + } + +private: + HGLOBAL m_hGlob; + BOOL m_bIsLocked; + LPVOID m_pGlobMem; +}; + +#endif |