summaryrefslogtreecommitdiff
path: root/sot/inc/stg.hxx
blob: 4a823d6b47fedf7193ecaee0c8b6785d3a55be93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*************************************************************************
 *
 *  $RCSfile: stg.hxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mba $ $Date: 2000-10-16 14:05:36 $
 *
 *  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 _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;

class StorageBase                          // common helper class
{
protected:
    StgIo*       pIo;                      // I/O subsystem
    StgDirEntry* pEntry;                   // the dir entry
    ULONG        nError;                   // error code
    StreamMode   nMode;                    // open mode
    BOOL         bAutoCommit;
    StorageBase( StgIo*, StgDirEntry* );
   ~StorageBase();
    BOOL Validate( BOOL=FALSE ) const;
    BOOL ValidateMode( StreamMode, StgDirEntry* ) const;
public:
    void  ResetError() const;
    void  SetError( ULONG ) const;
    ULONG GetError() const;
    BOOL  Good() const          { return BOOL( nError == SVSTREAM_OK ); }
    StreamMode GetMode() const  { return nMode;  }
    const SvStream* GetSvStream() const;
};

class StorageStream : public StorageBase
{
    friend class Storage;                   // for the following ctor
    ULONG nPos;                             // current position
    StorageStream( StgIo*, StgDirEntry*, StreamMode );
public:
    ~StorageStream();
    ULONG Read( void * pData, ULONG nSize );
    ULONG Write( const void* pData, ULONG nSize );
    ULONG Seek( ULONG nPos );
    ULONG Tell() { return nPos; }
    void  Flush();
    BOOL  SetSize( ULONG nNewSize );
    BOOL  CopyTo( StorageStream * pDestStm );
    BOOL  Commit();
    BOOL  Revert();
};

class SvStorageInfoList;

class Storage : public StorageBase
{
    String aName;
    BOOL   bIsRoot;           // TRUE if root storage
    void   Init( BOOL bCreate );
    Storage( StgIo*, StgDirEntry*, StreamMode );
public:
                      Storage( const String &,
                               StreamMode = STREAM_STD_READWRITE,
                               BOOL bDirect = TRUE );
                      Storage( SvStream& rStrm,
                               BOOL bDirect = TRUE );
    ~Storage();
    static BOOL       IsStorageFile( const String & rFileName );
    static BOOL       IsStorageFile( SvStream* );
    const String&     GetName() const;
    BOOL              IsRoot() const { return bIsRoot; }

                      // eigener Datenbereich
    void              SetClass( const SvGlobalName & rClass,
                                ULONG nOriginalClipFormat,
                                const String & rUserTypeName );
    void              SetConvertClass( const SvGlobalName & rConvertClass,
                                       ULONG nOriginalClipFormat,
                                       const String & rUserTypeName );
    SvGlobalName      GetClassName();// Typ der Daten im Storage
    ULONG             GetFormat();
    String            GetUserName();
    BOOL              ShouldConvert();

                      // Liste aller Elemente
    void              FillInfoList( SvStorageInfoList* ) const;
    BOOL              CopyTo( Storage* pDestStg ) const;
    BOOL              Commit();
    BOOL              Revert();
                      /* Element Methoden     */
                      // Stream mit Verbindung zu Storage erzeugen,
                      // in etwa eine Parent-Child Beziehung
    StorageStream*    OpenStream( const String & rEleName,
                                  StreamMode = STREAM_STD_READWRITE,
                                  BOOL bDirect = TRUE );
    Storage*          OpenStorage( const String & rEleName,
                                   StreamMode = STREAM_STD_READWRITE,
                                   BOOL bDirect = FALSE );
                      // Abfrage auf Storage oder Stream
    BOOL              IsStream( const String& rEleName ) const;
    BOOL              IsStorage( const String& rEleName ) const;
    BOOL              IsContained( const String& rEleName ) const;
                      // Element loeschen
    BOOL              Remove( const String & rEleName );
                      // Elementnamen aendern
    BOOL              Rename( const String & rEleName,
                              const String & rNewName );
    BOOL              CopyTo( const String & rEleName, Storage * pDest,
                              const String & rNewName );
    BOOL              MoveTo( const String & rEleName, Storage * pDest,
                              const String & rNewName );
    BOOL              ValidateFAT();
};

#endif