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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: stg.hxx,v $
* $Revision: 1.27 $
*
* 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 _STG_HXX
#define _STG_HXX
#include <com/sun/star/uno/Any.h>
#include <com/sun/star/uno/Reference.h>
#ifndef _COM_SUN_STAR_IO_XINPUTSTREAM_H_
#include <com/sun/star/io/XInputStream.hpp>
#endif
#ifndef _COM_SUN_STAR_UCB_XCOMMANDENVIRONMENT_H_
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#endif
#ifndef _COM_SUN_STAR_EMBED_XSTORAGE_H_
#include <com/sun/star/embed/XStorage.hpp>
#endif
#include <tools/rtti.hxx>
#ifndef _TOOLS_STREAM_HXX //autogen
#include <tools/stream.hxx>
#endif
#ifndef _TOOLS_GLOBNAME_HXX //autogen
#include <tools/globname.hxx>
#endif
#include "sot/sotdllapi.h"
#include <list>
class UNOStorageHolder;
typedef ::std::list< UNOStorageHolder* > UNOStorageHolderList;
class Storage;
class StorageStream;
class StgIo;
class StgDirEntry;
class StgStrm;
class SvGlobalName;
struct ClsId
{
INT32 n1;
INT16 n2, n3;
UINT8 n4, n5, n6, n7, n8, n9, n10, n11;
};
class SOT_DLLPUBLIC StorageBase : public SvRefBase
{
protected:
ULONG m_nError; // error code
StreamMode m_nMode; // open mode
BOOL m_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( m_nError == SVSTREAM_OK ); }
StreamMode GetMode() const { return m_nMode; }
void SetAutoCommit( BOOL bSet )
{ m_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, const ByteString* pKey=0 ) = 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 BaseStorage* OpenOLEStorage( 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 UCBStorageStream;
class SOT_DLLPUBLIC 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 );
Storage( UCBStorageStream& 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, const ByteString* pKey=0 );
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 BaseStorage* OpenOLEStorage( 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, const ByteString* pKey=0 );
UCBStorageStream( const String& rName, StreamMode nMode, BOOL bDirect, const ByteString* pKey, BOOL bRepair, ::com::sun::star::uno::Reference< ::com::sun::star::ucb::XProgressHandler > xProgress );
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;
BOOL SetProperty( const String& rName, const ::com::sun::star::uno::Any& rValue );
BOOL GetProperty( const String& rName, ::com::sun::star::uno::Any& rValue );
SvStream* GetModifySvStream();
::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > GetXInputStream() const;
};
namespace ucbhelper
{
class Content;
}
class UCBStorage_Impl;
struct UCBStorageElement_Impl;
class SOT_DLLPUBLIC UCBStorage : public BaseStorage
{
UCBStorage_Impl* pImp;
protected:
~UCBStorage();
public:
static BOOL IsStorageFile( SvStream* );
static BOOL IsStorageFile( const String& rName );
static BOOL IsDiskSpannedFile( SvStream* );
static String GetLinkedFile( SvStream& );
static String CreateLinkFile( const String& rName );
UCBStorage( const ::ucbhelper::Content& rContent, const String& rName, StreamMode nMode, BOOL bDirect = TRUE, BOOL bIsRoot = TRUE );
UCBStorage( const String& rName,
StreamMode nMode,
BOOL bDirect = TRUE,
BOOL bIsRoot = TRUE );
UCBStorage( const String& rName,
StreamMode nMode,
BOOL bDirect,
BOOL bIsRoot,
BOOL bIsRepair,
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XProgressHandler >
xProgressHandler );
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, const ByteString* pKey=0 );
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 BaseStorage* OpenOLEStorage( 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;
BOOL SetProperty( const String& rName, const ::com::sun::star::uno::Any& rValue );
BOOL GetProperty( const String& rName, ::com::sun::star::uno::Any& rValue );
BOOL GetProperty( const String& rEleName, const String& rName, ::com::sun::star::uno::Any& rValue );
// HACK to avoid incompatible build, can be done since this feature is only for development
// should be removed before release
UNOStorageHolderList* GetUNOStorageHolderList();
//#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
|
