svtools/inc/flbytes.hxx

   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: flbytes.hxx,v $
  10  * $Revision: 1.3 $
  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 #ifndef _FLBYTES_HXX
  32 #define _FLBYTES_HXX
  33
  34 #include <tools/debug.hxx>
  35 #include <tools/stream.hxx>
  36
  37 //============================================================================
  38 class SvFillLockBytes : public SvLockBytes
  39 {
  40     SvLockBytesRef xLockBytes;
  41     ULONG nFilledSize;
  42     BOOL bTerminated;
  43     BOOL bSync;
  44 public:
  45     TYPEINFO();
  46
  47     SvFillLockBytes( SvLockBytes* pLockBytes );
  48     virtual ErrCode ReadAt(
  49         ULONG nPos, void* pBuffer, ULONG nCount, ULONG* pRead ) const;
  50     virtual ErrCode WriteAt(
  51         ULONG nPos, const void* pBuffer, ULONG nCount, ULONG* pWritten );
  52     virtual ErrCode Flush() const;
  53     virtual ErrCode SetSize( ULONG nSize );
  54     virtual ErrCode LockRegion( ULONG nPos, ULONG nCount, LockType );
  55     virtual ErrCode UnlockRegion( ULONG nPos, ULONG nCount, LockType );
  56     virtual ErrCode Stat( SvLockBytesStat*, SvLockBytesStatFlag ) const;
  57     ErrCode FillAppend( const void* pBuffer, ULONG nCount, ULONG *pWritten );
  58     ULONG   Tell() const { return nFilledSize; }
  59     void    Seek( ULONG nPos ) { nFilledSize = nPos; }
  60
  61     void Terminate();
  62 };
  63
  64 SV_DECL_IMPL_REF( SvFillLockBytes )
  65
  66 //============================================================================
  67 class SvSyncLockBytes: public SvOpenLockBytes
  68 {
  69     SvAsyncLockBytesRef m_xAsyncLockBytes;
  70
  71 public:
  72     TYPEINFO();
  73
  74     /// Create a synchronous wrapper around existing asynchronous lock bytes.
  75     ///
  76     /// @param pTheAsyncLockBytes  Must not be null.
  77     inline SvSyncLockBytes(SvAsyncLockBytes * pTheAsyncLockBytes);
  78
  79     /// Create a synchronous wrapper around an existing stream.
  80     ///
  81     /// @descr  This is like first creating asynchronous lock bytes around the
  82     /// stream and than creating a synchronous wrapper around the asynchronous
  83     /// lock bytes.
  84     ///
  85     /// @param pStream  Must not be null.
  86     ///
  87     /// @param bOwner  True if these lock bytes own the stream (delete it on
  88     /// destruction).
  89     SvSyncLockBytes(SvStream * pStream, BOOL bOwner):
  90         m_xAsyncLockBytes(new SvAsyncLockBytes(pStream, bOwner)) {}
  91
  92     virtual const SvStream * GetStream() const
  93     { return m_xAsyncLockBytes->GetStream(); }
  94
  95     virtual void SetSynchronMode(BOOL bSync = TRUE)
  96     { m_xAsyncLockBytes->SetSynchronMode(bSync); }
  97
  98     virtual BOOL IsSynchronMode() const
  99     { return m_xAsyncLockBytes->IsSynchronMode(); }
 100
 101     virtual ErrCode ReadAt(ULONG nPos, void * pBuffer, ULONG nCount,
 102                            ULONG * pRead) const;
 103
 104     virtual ErrCode WriteAt(ULONG nPos, const void * pBuffer, ULONG nCount,
 105                             ULONG * pWritten);
 106
 107     virtual ErrCode Flush() const { return m_xAsyncLockBytes->Flush(); }
 108
 109     virtual ErrCode SetSize(ULONG nSize)
 110     { return m_xAsyncLockBytes->SetSize(nSize); }
 111
 112     virtual ErrCode LockRegion(ULONG nPos, ULONG nCount, LockType eType)
 113     { return m_xAsyncLockBytes->LockRegion(nPos, nCount, eType); }
 114
 115     virtual ErrCode UnlockRegion(ULONG nPos, ULONG nCount, LockType eType)
 116     { return m_xAsyncLockBytes->UnlockRegion(nPos, nCount, eType); }
 117
 118     virtual ErrCode Stat(SvLockBytesStat * pStat, SvLockBytesStatFlag eFlag)
 119         const
 120     { return m_xAsyncLockBytes->Stat(pStat, eFlag); }
 121
 122     virtual ErrCode FillAppend(const void * pBuffer, ULONG nCount,
 123                                ULONG * pWritten)
 124     { return m_xAsyncLockBytes->FillAppend(pBuffer, nCount, pWritten); }
 125
 126     virtual ULONG Tell() const { return m_xAsyncLockBytes->Tell(); }
 127
 128     virtual ULONG Seek(ULONG nPos)
 129     { return m_xAsyncLockBytes->Seek(nPos); }
 130
 131     virtual void Terminate() { m_xAsyncLockBytes->Terminate(); }
 132 };
 133
 134 inline SvSyncLockBytes::SvSyncLockBytes(SvAsyncLockBytes *
 135                                          pTheAsyncLockBytes):
 136     m_xAsyncLockBytes(pTheAsyncLockBytes)
 137 {
 138     DBG_ASSERT(m_xAsyncLockBytes.Is(),
 139                "SvSyncLockBytes::SvSyncLockBytes(): Null");
 140 }
 141
 142 SV_DECL_IMPL_REF(SvSyncLockBytes);
 143
 144 //============================================================================
 145 struct SvCompositeLockBytes_Impl;
 146 class SvCompositeLockBytes : public SvLockBytes
 147 {
 148     SvCompositeLockBytes_Impl* pImpl;
 149 public:
 150     TYPEINFO();
 151
 152     SvCompositeLockBytes( );
 153     ~SvCompositeLockBytes();
 154
 155     void Append( SvLockBytes* pLockBytes, ULONG nPos, ULONG nOffset );
 156     ULONG RelativeOffset( ULONG nPos ) const;
 157     void  SetIsPending( BOOL bSet );
 158     SvLockBytes*    GetLastLockBytes() const;
 159
 160     virtual ErrCode ReadAt(
 161         ULONG nPos, void* pBuffer, ULONG nCount, ULONG* pRead ) const;
 162     virtual ErrCode WriteAt(
 163         ULONG nPos, const void* pBuffer, ULONG nCount, ULONG* pWritten );
 164     virtual ErrCode Flush() const;
 165     virtual ErrCode SetSize( ULONG nSize );
 166     virtual ErrCode LockRegion( ULONG nPos, ULONG nCount, LockType );
 167     virtual ErrCode UnlockRegion( ULONG nPos, ULONG nCount, LockType );
 168     virtual ErrCode Stat( SvLockBytesStat*, SvLockBytesStatFlag ) const;
 169 };
 170
 171 SV_DECL_IMPL_REF( SvCompositeLockBytes )
 172
 173
 174 #endif