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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SOT_STG_HXX
#define INCLUDED_SOT_STG_HXX
#include <tools/stream.hxx>
#include <tools/globname.hxx>
#include <sot/storinfo.hxx>
#include <sot/sotdllapi.h>
#include <config_options.h>
namespace com::sun::star::ucb { class XProgressHandler; }
namespace com::sun::star::uno { class Any; }
namespace com::sun::star::uno { template <typename > class Reference; }
class StgIo;
class StgDirEntry;
typedef struct SvGUID ClsId;
class StorageBase : public SvRefBase
{
protected:
mutable ErrCode m_nError; // error code
StreamMode m_nMode; // open mode
bool m_bAutoCommit;
StorageBase();
virtual ~StorageBase() override;
public:
virtual bool Validate( bool=false ) const = 0;
virtual bool ValidateMode( StreamMode ) const = 0;
void ResetError() const;
void SetError( ErrCode ) const;
ErrCode GetError() const;
bool Good() const { return m_nError == ERRCODE_NONE; }
StreamMode GetMode() const { return m_nMode; }
void SetAutoCommit( bool bSet )
{ m_bAutoCommit = bSet; }
};
class BaseStorageStream : public StorageBase
{
public:
virtual sal_Int32 Read( void * pData, sal_Int32 nSize ) = 0;
virtual sal_Int32 Write( const void* pData, sal_Int32 nSize ) = 0;
virtual sal_uInt64 Seek( sal_uInt64 nPos ) = 0;
virtual sal_uInt64 Tell() = 0;
virtual void Flush() = 0;
virtual bool SetSize( sal_uInt64 nNewSize ) = 0;
virtual sal_uInt64 GetSize() const = 0;
virtual void CopyTo( BaseStorageStream * pDestStm ) = 0;
virtual bool Commit() = 0;
virtual bool Equals( const BaseStorageStream& rStream ) const = 0;
};
enum class SotClipboardFormatId : sal_uInt32;
class SAL_DLLPUBLIC_RTTI BaseStorage : public StorageBase
{
public:
virtual const OUString& 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,
SotClipboardFormatId nOriginalClipFormat,
const OUString & rUserTypeName ) = 0;
virtual SvGlobalName GetClassName() = 0;
virtual SotClipboardFormatId GetFormat() = 0;
virtual OUString GetUserName() = 0;
virtual void FillInfoList( SvStorageInfoList* ) const = 0;
virtual bool CopyTo( BaseStorage& rDestStg ) const = 0;
virtual bool Commit() = 0;
virtual bool Revert() = 0;
virtual BaseStorageStream* OpenStream( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = true ) = 0;
virtual BaseStorage* OpenStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) = 0;
virtual BaseStorage* OpenUCBStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) = 0;
virtual BaseStorage* OpenOLEStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) = 0;
virtual bool IsStream( const OUString& rEleName ) const = 0;
virtual bool IsStorage( const OUString& rEleName ) const = 0;
virtual bool IsContained( const OUString& rEleName ) const = 0;
virtual void Remove( const OUString & rEleName ) = 0;
virtual bool CopyTo( const OUString & rEleName, BaseStorage * pDest, const OUString & 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 ) const;
static bool ValidateMode_Impl( StreamMode, StgDirEntry const * p = nullptr );
};
class StorageStream final : public BaseStorageStream, public OLEStorageBase
{
//friend class Storage;
sal_uInt64 nPos; // current position
virtual ~StorageStream() override;
public:
StorageStream( StgIo*, StgDirEntry*, StreamMode );
virtual sal_Int32 Read( void * pData, sal_Int32 nSize ) override;
virtual sal_Int32 Write( const void* pData, sal_Int32 nSize ) override;
virtual sal_uInt64 Seek( sal_uInt64 nPos ) override;
virtual sal_uInt64 Tell() override { return nPos; }
virtual void Flush() override;
virtual bool SetSize( sal_uInt64 nNewSize ) override;
virtual sal_uInt64 GetSize() const override;
virtual void CopyTo( BaseStorageStream * pDestStm ) override;
virtual bool Commit() final override;
virtual bool Validate( bool=false ) const override;
virtual bool ValidateMode( StreamMode ) const override;
virtual bool Equals( const BaseStorageStream& rStream ) const override;
};
class UCBStorageStream;
class UNLESS_MERGELIBS(SOT_DLLPUBLIC) Storage final : public BaseStorage, public OLEStorageBase
{
OUString aName;
bool bIsRoot;
void Init( bool bCreate );
Storage( StgIo*, StgDirEntry*, StreamMode );
virtual ~Storage() override;
public:
Storage( OUString, StreamMode, bool bDirect );
Storage( SvStream& rStrm, bool bDirect );
Storage( UCBStorageStream& rStrm, bool bDirect );
static bool IsStorageFile( const OUString & rFileName );
static bool IsStorageFile( SvStream* );
virtual const OUString& GetName() const final override;
virtual bool IsRoot() const override { return bIsRoot; }
virtual void SetClassId( const ClsId& ) override;
virtual const ClsId& GetClassId() const override;
virtual void SetDirty() override;
virtual void SetClass( const SvGlobalName & rClass,
SotClipboardFormatId nOriginalClipFormat,
const OUString & rUserTypeName ) override;
virtual SvGlobalName GetClassName() override;
virtual SotClipboardFormatId GetFormat() override;
virtual OUString GetUserName() override;
virtual void FillInfoList( SvStorageInfoList* ) const override;
virtual bool CopyTo( BaseStorage& rDestStg ) const override;
virtual bool Commit() final override;
virtual bool Revert() override;
virtual BaseStorageStream* OpenStream( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = true ) override;
virtual BaseStorage* OpenStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) override;
virtual BaseStorage* OpenUCBStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) override;
virtual BaseStorage* OpenOLEStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) override;
virtual bool IsStream( const OUString& rEleName ) const override;
virtual bool IsStorage( const OUString& rEleName ) const override;
virtual bool IsContained( const OUString& rEleName ) const override;
virtual void Remove( const OUString & rEleName ) override;
virtual bool CopyTo( const OUString & rEleName, BaseStorage * pDest, const OUString & rNewName ) override;
virtual bool ValidateFAT() override;
virtual bool Validate( bool=false ) const override;
virtual bool ValidateMode( StreamMode ) const override;
bool ValidateMode( StreamMode, StgDirEntry const * p ) const;
virtual bool Equals( const BaseStorage& rStream ) const override;
};
class UCBStorageStream_Impl;
class UCBStorageStream final : public BaseStorageStream
{
friend class UCBStorage;
UCBStorageStream_Impl*
pImp;
virtual ~UCBStorageStream() override;
public:
UCBStorageStream( const OUString& rName, StreamMode nMode, bool bDirect, bool bRepair, css::uno::Reference< css::ucb::XProgressHandler > const & xProgress );
UCBStorageStream( UCBStorageStream_Impl* );
virtual sal_Int32 Read( void * pData, sal_Int32 nSize ) override;
virtual sal_Int32 Write( const void* pData, sal_Int32 nSize ) override;
virtual sal_uInt64 Seek( sal_uInt64 nPos ) override;
virtual sal_uInt64 Tell() override;
virtual void Flush() override;
virtual bool SetSize( sal_uInt64 nNewSize ) override;
virtual sal_uInt64 GetSize() const override;
virtual void CopyTo( BaseStorageStream * pDestStm ) override;
virtual bool Commit() override;
virtual bool Validate( bool=false ) const override;
virtual bool ValidateMode( StreamMode ) const override;
virtual bool Equals( const BaseStorageStream& rStream ) const override;
bool SetProperty( const OUString& rName, const css::uno::Any& rValue );
SvStream* GetModifySvStream();
};
namespace ucbhelper
{
class Content;
}
class UCBStorage_Impl;
struct UCBStorageElement_Impl;
class UCBStorage final : public BaseStorage
{
UCBStorage_Impl* pImp;
virtual ~UCBStorage() override;
public:
SOT_DLLPUBLIC static bool IsStorageFile( SvStream* );
SOT_DLLPUBLIC UCBStorage( const ::ucbhelper::Content& rContent,
const OUString& rName,
StreamMode nMode,
bool bDirect,
bool bIsRoot );
UCBStorage( const OUString& rName,
StreamMode nMode,
bool bDirect,
bool bIsRoot );
UCBStorage( const OUString& rName,
StreamMode nMode,
bool bDirect,
bool bIsRoot,
bool bIsRepair,
css::uno::Reference< css::ucb::XProgressHandler > const &
xProgressHandler );
UCBStorage( UCBStorage_Impl* );
UCBStorage( SvStream& rStrm, bool bDirect );
virtual const OUString& GetName() const override;
virtual bool IsRoot() const override;
virtual void SetClassId( const ClsId& ) override;
virtual const ClsId& GetClassId() const override;
virtual void SetDirty() override;
virtual void SetClass( const SvGlobalName & rClass,
SotClipboardFormatId nOriginalClipFormat,
const OUString & rUserTypeName ) override;
virtual SvGlobalName GetClassName() override;
virtual SotClipboardFormatId GetFormat() override;
virtual OUString GetUserName() override;
virtual void FillInfoList( SvStorageInfoList* ) const override;
virtual bool CopyTo( BaseStorage& rDestStg ) const override;
virtual bool Commit() final override;
virtual bool Revert() override;
virtual BaseStorageStream* OpenStream( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = true ) override;
virtual BaseStorage* OpenStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) override;
virtual BaseStorage* OpenUCBStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) override;
virtual BaseStorage* OpenOLEStorage( const OUString & rEleName,
StreamMode = StreamMode::STD_READWRITE,
bool bDirect = false ) override;
virtual bool IsStream( const OUString& rEleName ) const override;
virtual bool IsStorage( const OUString& rEleName ) const override;
virtual bool IsContained( const OUString& rEleName ) const override;
virtual void Remove( const OUString & rEleName ) override;
virtual bool CopyTo( const OUString & rEleName, BaseStorage * pDest, const OUString & rNewName ) override;
virtual bool ValidateFAT() override;
virtual bool Validate( bool=false ) const override;
virtual bool ValidateMode( StreamMode ) const override;
virtual bool Equals( const BaseStorage& rStream ) const override;
UCBStorageElement_Impl* FindElement_Impl( std::u16string_view rName ) const;
bool CopyStorageElement_Impl( UCBStorageElement_Impl const & rElement,
BaseStorage* pDest, const OUString& rNew ) const;
BaseStorage* OpenStorage_Impl( const OUString & rEleName,
StreamMode, bool bDirect, bool bForceUCBStorage );
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
