strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/sot/inc/stg.hxx
Jens-Heiner Rechtien e1ace37d81 #58628#,#65293# __PRIVATE -> _SOLAR__PRIVATE
2000-12-07 11:45:56 +00:00

360 lines
16 KiB
C++
Raw Blame History

/*************************************************************************
*
* $RCSfile: stg.hxx,v $
*
* $Revision: 1.7 $
*
* last change: $Author: hr $ $Date: 2000-12-07 12:45:56 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _STG_HXX
#define _STG_HXX
#ifndef _RTTI_HXX //autogen
#include <tools/rtti.hxx>
#endif
#ifndef _TOOLS_STREAM_HXX //autogen
#include <tools/stream.hxx>
#endif
#ifndef _TOOLS_GLOBNAME_HXX //autogen
#include <tools/globname.hxx>
#endif
class Storage;
class StorageStream;
class StgIo;
class StgDirEntry;
class StgStrm;
class SvGlobalName;
struct ClsId;
class StorageBase : public SvRefBase
{
protected:
ULONG nError; // error code
StreamMode nMode; // open mode
BOOL bAutoCommit;
StorageBase();
virtual ~StorageBase();
public:
TYPEINFO();
virtual const SvStream* GetSvStream() const = 0;
virtual BOOL Validate( BOOL=FALSE ) const = 0;
virtual BOOL ValidateMode( StreamMode ) const = 0;
void ResetError() const;
void SetError( ULONG ) const;
ULONG GetError() const;
BOOL Good() const { return BOOL( nError == SVSTREAM_OK ); }
StreamMode GetMode() const { return nMode; }
void SetAutoCommit( BOOL bSet )
{ bAutoCommit = bSet; }
};
class BaseStorageStream : public StorageBase
{
public:
TYPEINFO();
virtual ULONG Read( void * pData, ULONG nSize ) = 0;
virtual ULONG Write( const void* pData, ULONG nSize ) = 0;
virtual ULONG Seek( ULONG nPos ) = 0;
virtual ULONG Tell() = 0;
virtual void Flush() = 0;
virtual BOOL SetSize( ULONG nNewSize ) = 0;
virtual BOOL CopyTo( BaseStorageStream * pDestStm ) = 0;
virtual BOOL Commit() = 0;
virtual BOOL Revert() = 0;
virtual BOOL Equals( const BaseStorageStream& rStream ) const = 0;
};
class SvStorageInfoList;
class BaseStorage : public StorageBase
{
public:
TYPEINFO();
virtual const String& GetName() const = 0;
virtual BOOL IsRoot() const = 0;
virtual void SetClassId( const ClsId& ) = 0;
virtual const ClsId& GetClassId() const = 0;
virtual void SetDirty() = 0;
virtual void SetClass( const SvGlobalName & rClass,
ULONG nOriginalClipFormat,
const String & rUserTypeName ) = 0;
virtual void SetConvertClass( const SvGlobalName & rConvertClass,
ULONG nOriginalClipFormat,
const String & rUserTypeName ) = 0;
virtual SvGlobalName GetClassName() = 0;
virtual ULONG GetFormat() = 0;
virtual String GetUserName() = 0;
virtual BOOL ShouldConvert() = 0;
virtual void FillInfoList( SvStorageInfoList* ) const = 0;
virtual BOOL CopyTo( BaseStorage* pDestStg ) const = 0;
virtual BOOL Commit() = 0;
virtual BOOL Revert() = 0;
virtual BaseStorageStream* OpenStream( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = TRUE ) = 0;
virtual BaseStorage* OpenStorage( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = FALSE ) = 0;
virtual BaseStorage* OpenUCBStorage( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = FALSE ) = 0;
virtual BOOL IsStream( const String& rEleName ) const = 0;
virtual BOOL IsStorage( const String& rEleName ) const = 0;
virtual BOOL IsContained( const String& rEleName ) const = 0;
virtual BOOL Remove( const String & rEleName ) = 0;
virtual BOOL Rename( const String & rEleName, const String & rNewName ) = 0;
virtual BOOL CopyTo( const String & rEleName, BaseStorage * pDest, const String & rNewName ) = 0;
virtual BOOL MoveTo( const String & rEleName, BaseStorage * pDest, const String & rNewName ) = 0;
virtual BOOL ValidateFAT() = 0;
virtual BOOL Equals( const BaseStorage& rStream ) const = 0;
};
class OLEStorageBase
{
protected:
StreamMode& nStreamMode; // open mode
StgIo* pIo; // I/O subsystem
StgDirEntry* pEntry; // the dir entry
OLEStorageBase( StgIo*, StgDirEntry*, StreamMode& );
~OLEStorageBase();
BOOL Validate_Impl( BOOL=FALSE ) const;
BOOL ValidateMode_Impl( StreamMode, StgDirEntry* p = NULL ) const ;
const SvStream* GetSvStream_Impl() const;
public:
};
class StorageStream : public BaseStorageStream, public OLEStorageBase
{
//friend class Storage;
ULONG nPos; // current position
protected:
~StorageStream();
public:
TYPEINFO();
StorageStream( StgIo*, StgDirEntry*, StreamMode );
virtual ULONG Read( void * pData, ULONG nSize );
virtual ULONG Write( const void* pData, ULONG nSize );
virtual ULONG Seek( ULONG nPos );
virtual ULONG Tell() { return nPos; }
virtual void Flush();
virtual BOOL SetSize( ULONG nNewSize );
virtual BOOL CopyTo( BaseStorageStream * pDestStm );
virtual BOOL Commit();
virtual BOOL Revert();
virtual BOOL Validate( BOOL=FALSE ) const;
virtual BOOL ValidateMode( StreamMode ) const;
BOOL ValidateMode( StreamMode, StgDirEntry* p ) const;
const SvStream* GetSvStream() const;
virtual BOOL Equals( const BaseStorageStream& rStream ) const;
};
class Storage : public BaseStorage, public OLEStorageBase
{
String aName;
BOOL bIsRoot;
void Init( BOOL bCreate );
Storage( StgIo*, StgDirEntry*, StreamMode );
protected:
~Storage();
public:
TYPEINFO();
Storage( const String &, StreamMode = STREAM_STD_READWRITE, BOOL bDirect = TRUE );
Storage( SvStream& rStrm, BOOL bDirect = TRUE );
static BOOL IsStorageFile( const String & rFileName );
static BOOL IsStorageFile( SvStream* );
virtual const String& GetName() const;
virtual BOOL IsRoot() const { return bIsRoot; }
virtual void SetClassId( const ClsId& );
virtual const ClsId& GetClassId() const;
virtual void SetDirty();
virtual void SetClass( const SvGlobalName & rClass,
ULONG nOriginalClipFormat,
const String & rUserTypeName );
virtual void SetConvertClass( const SvGlobalName & rConvertClass,
ULONG nOriginalClipFormat,
const String & rUserTypeName );
virtual SvGlobalName GetClassName();
virtual ULONG GetFormat();
virtual String GetUserName();
virtual BOOL ShouldConvert();
virtual void FillInfoList( SvStorageInfoList* ) const;
virtual BOOL CopyTo( BaseStorage* pDestStg ) const;
virtual BOOL Commit();
virtual BOOL Revert();
virtual BaseStorageStream* OpenStream( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = TRUE );
virtual BaseStorage* OpenStorage( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = FALSE );
virtual BaseStorage* OpenUCBStorage( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = FALSE );
virtual BOOL IsStream( const String& rEleName ) const;
virtual BOOL IsStorage( const String& rEleName ) const;
virtual BOOL IsContained( const String& rEleName ) const;
virtual BOOL Remove( const String & rEleName );
virtual BOOL Rename( const String & rEleName, const String & rNewName );
virtual BOOL CopyTo( const String & rEleName, BaseStorage * pDest, const String & rNewName );
virtual BOOL MoveTo( const String & rEleName, BaseStorage * pDest, const String & rNewName );
virtual BOOL ValidateFAT();
virtual BOOL Validate( BOOL=FALSE ) const;
virtual BOOL ValidateMode( StreamMode ) const;
BOOL ValidateMode( StreamMode, StgDirEntry* p ) const;
virtual const SvStream* GetSvStream() const;
virtual BOOL Equals( const BaseStorage& rStream ) const;
};
class UCBStorageStream_Impl;
class UCBStorageStream : public BaseStorageStream
{
friend class UCBStorage;
UCBStorageStream_Impl*
pImp;
protected:
~UCBStorageStream();
public:
TYPEINFO();
UCBStorageStream( const String& rName, StreamMode nMode, BOOL bDirect );
UCBStorageStream( UCBStorageStream_Impl* );
virtual ULONG Read( void * pData, ULONG nSize );
virtual ULONG Write( const void* pData, ULONG nSize );
virtual ULONG Seek( ULONG nPos );
virtual ULONG Tell();
virtual void Flush();
virtual BOOL SetSize( ULONG nNewSize );
virtual BOOL CopyTo( BaseStorageStream * pDestStm );
virtual BOOL Commit();
virtual BOOL Revert();
virtual BOOL Validate( BOOL=FALSE ) const;
virtual BOOL ValidateMode( StreamMode ) const;
const SvStream* GetSvStream() const;
virtual BOOL Equals( const BaseStorageStream& rStream ) const;
};
class UCBStorage_Impl;
struct UCBStorageElement_Impl;
class UCBStorage : public BaseStorage
{
UCBStorage_Impl* pImp;
protected:
~UCBStorage();
public:
static BOOL IsStorageFile( SvStream* );
UCBStorage( const String& rName, StreamMode nMode, BOOL bDirect = TRUE, BOOL bIsRoot = TRUE );
UCBStorage( UCBStorage_Impl* );
UCBStorage( SvStream& rStrm, BOOL bDirect = TRUE );
TYPEINFO();
virtual const String& GetName() const;
virtual BOOL IsRoot() const;
virtual void SetClassId( const ClsId& );
virtual const ClsId& GetClassId() const;
virtual void SetDirty();
virtual void SetClass( const SvGlobalName & rClass,
ULONG nOriginalClipFormat,
const String & rUserTypeName );
virtual void SetConvertClass( const SvGlobalName & rConvertClass,
ULONG nOriginalClipFormat,
const String & rUserTypeName );
virtual SvGlobalName GetClassName();
virtual ULONG GetFormat();
virtual String GetUserName();
virtual BOOL ShouldConvert();
virtual void FillInfoList( SvStorageInfoList* ) const;
virtual BOOL CopyTo( BaseStorage* pDestStg ) const;
virtual BOOL Commit();
virtual BOOL Revert();
virtual BaseStorageStream* OpenStream( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = TRUE );
virtual BaseStorage* OpenStorage( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = FALSE );
virtual BaseStorage* OpenUCBStorage( const String & rEleName,
StreamMode = STREAM_STD_READWRITE,
BOOL bDirect = FALSE );
virtual BOOL IsStream( const String& rEleName ) const;
virtual BOOL IsStorage( const String& rEleName ) const;
virtual BOOL IsContained( const String& rEleName ) const;
virtual BOOL Remove( const String & rEleName );
virtual BOOL Rename( const String & rEleName, const String & rNewName );
virtual BOOL CopyTo( const String & rEleName, BaseStorage * pDest, const String & rNewName );
virtual BOOL MoveTo( const String & rEleName, BaseStorage * pDest, const String & rNewName );
virtual BOOL ValidateFAT();
virtual BOOL Validate( BOOL=FALSE ) const;
virtual BOOL ValidateMode( StreamMode ) const;
virtual const SvStream* GetSvStream() const;
virtual BOOL Equals( const BaseStorage& rStream ) const;
#if _SOLAR__PRIVATE
UCBStorageElement_Impl* FindElement_Impl( const String& rName ) const;
BOOL CopyStorageElement_Impl( UCBStorageElement_Impl& rElement,
BaseStorage* pDest, const String& rNew ) const;
BaseStorage* OpenStorage_Impl( const String & rEleName,
StreamMode, BOOL bDirect, BOOL bForceUCBStorage );
#endif
};
#endif
Reference in a new issue View git blame Copy permalink