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
|
/* -*- 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_OOX_HELPER_STORAGEBASE_HXX
#define INCLUDED_OOX_HELPER_STORAGEBASE_HXX
#include <functional>
#include <memory>
#include <vector>
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <oox/helper/refmap.hxx>
#include <rtl/ustring.hxx>
namespace com::sun::star {
namespace embed { class XStorage; }
namespace io { class XInputStream; }
namespace io { class XOutputStream; }
namespace io { class XStream; }
}
namespace oox {
class StorageBase;
typedef std::shared_ptr< StorageBase > StorageRef;
/** Base class for storage access implementations.
Derived classes will be used to encapsulate storage access implementations
for ZIP storages containing XML streams, and OLE storages containing binary
data streams.
*/
class OOX_DLLPUBLIC StorageBase
{
public:
explicit StorageBase(
const css::uno::Reference< css::io::XInputStream >& rxInStream,
bool bBaseStreamAccess );
explicit StorageBase(
const css::uno::Reference< css::io::XStream >& rxOutStream,
bool bBaseStreamAccess );
virtual ~StorageBase();
/** Returns true, if the object represents a valid storage. */
bool isStorage() const;
/** Returns true, if the object represents the root storage. */
bool isRootStorage() const;
/** Returns true, if the storage operates in read-only mode (based on an
input stream). */
bool isReadOnly() const { return mbReadOnly;}
/** Returns the com.sun.star.embed.XStorage interface of the current storage. */
css::uno::Reference< css::embed::XStorage >
getXStorage() const;
/** Returns the element name of this storage. */
const OUString& getName() const { return maStorageName;}
/** Returns the full path of this storage. */
OUString getPath() const;
/** Fills the passed vector with the names of all direct elements of this
storage. */
void getElementNames( ::std::vector< OUString >& orElementNames ) const;
/** Opens and returns the specified sub storage from the storage.
@param rStorageName
The name of the embedded storage. The name may contain slashes to
open storages from embedded substorages.
@param bCreateMissing
True = create missing sub storages (for export filters). Must be
false for storages based on input streams.
*/
StorageRef openSubStorage( const OUString& rStorageName, bool bCreateMissing );
/** Opens and returns the specified input stream from the storage.
@param rStreamName
The name of the embedded storage stream. The name may contain
slashes to open streams from embedded substorages. If base stream
access has been enabled in the constructor, the base stream can be
accessed by passing an empty string as stream name.
*/
css::uno::Reference< css::io::XInputStream >
openInputStream( const OUString& rStreamName );
/** Opens and returns the specified output stream from the storage.
@param rStreamName
The name of the embedded storage stream. The name may contain
slashes to create and open streams in embedded substorages. If base
stream access has been enabled in the constructor, the base stream
can be accessed by passing an empty string as stream name.
*/
css::uno::Reference< css::io::XOutputStream >
openOutputStream( const OUString& rStreamName );
/** Copies the specified element from this storage to the passed
destination storage.
@param rElementName
The name of the embedded storage or stream. The name may contain
slashes to specify an element in an embedded substorage. In this
case, the element will be copied to the same substorage in the
destination storage.
*/
void copyToStorage( StorageBase& rDestStrg, const OUString& rElementName );
/** Copies all streams of this storage and of all substorages to the passed
destination. */
void copyStorageToStorage( StorageBase& rDestStrg );
/** Commits the changes to the storage and all substorages. */
void commit();
protected:
/** Special constructor for sub storage objects. */
explicit StorageBase( const StorageBase& rParentStorage, const OUString& rStorageName, bool bReadOnly );
private:
StorageBase( const StorageBase& ) = delete;
StorageBase& operator=( const StorageBase& ) = delete;
/** Returns true, if the object represents a valid storage. */
virtual bool implIsStorage() const = 0;
/** Returns the com.sun.star.embed.XStorage interface of the current storage. */
virtual css::uno::Reference< css::embed::XStorage >
implGetXStorage() const = 0;
/** Returns the names of all elements of this storage. */
virtual void implGetElementNames( ::std::vector< OUString >& orElementNames ) const = 0;
/** Implementation of opening a storage element. */
virtual StorageRef implOpenSubStorage( const OUString& rElementName, bool bCreate ) = 0;
/** Implementation of opening an input stream element. */
virtual css::uno::Reference< css::io::XInputStream >
implOpenInputStream( const OUString& rElementName ) = 0;
/** Implementation of opening an output stream element. */
virtual css::uno::Reference< css::io::XOutputStream >
implOpenOutputStream( const OUString& rElementName ) = 0;
/** Commits the current storage. */
virtual void implCommit() const = 0;
/** Helper that opens and caches the specified direct substorage. */
StorageRef getSubStorage( const OUString& rElementName, bool bCreateMissing );
private:
RefMap< OUString, StorageBase >
maSubStorages; ///< Map of direct sub storages.
css::uno::Reference< css::io::XInputStream >
mxInStream; ///< Cached base input stream (to keep it alive).
css::uno::Reference< css::io::XStream >
mxOutStream; ///< Cached base output stream (to keep it alive).
OUString maParentPath; ///< Full path of parent storage.
OUString maStorageName; ///< Name of this storage, if it is a substorage.
bool mbBaseStreamAccess; ///< True = access base streams with empty stream name.
bool mbReadOnly; ///< True = storage opened read-only (based on input stream).
};
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
