RVNGOLEStream.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* librevenge
3 
4  Original source: POLE - Portable C++ library to access OLE Storage
5  Copyright (C) 2002-2005 Ariya Hidayat <ariya@kde.org>
6 
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions
9  are met:
10  * Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12  * Redistributions in binary form must reproduce the above copyright notice,
13  this list of conditions and the following disclaimer in the documentation
14  and/or other materials provided with the distribution.
15  * Neither the name of the authors nor the names of its contributors may be
16  used to endorse or promote products derived from this software without
17  specific prior written permission.
18 
19  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29  THE POSSIBILITY OF SUCH DAMAGE.
30 */
31 
32 #ifndef RVNGOLESTREAM_H
33 #define RVNGOLESTREAM_H
34 
35 #include <memory>
36 #include <string>
37 #include <vector>
38 
39 namespace librevenge
40 {
41 
42 class RVNGInputStream;
43 
44 class IStorage;
45 class Stream;
46 class IStream;
47 
48 class Storage
49 {
50  friend class Stream;
51 
52 public:
53 
54  // for Storage::result()
56 
61 
65  ~Storage();
66 
70  bool isStructured();
71 
75  std::vector<std::string> getSubStreamNamesList();
76 
80  Result result();
81 
82 private:
83  std::unique_ptr<IStorage> m_io;
84 
85  // no copy or assign
86  Storage(const Storage &);
87  Storage &operator=(const Storage &);
88 
89 };
90 
91 class Stream
92 {
93  friend class Storage;
94  friend class IStorage;
95 
96 public:
97 
101  Stream(Storage *storage, const std::string &name);
102 
106  ~Stream();
107 
111  unsigned long size();
112 
116  unsigned long read(unsigned char *data, unsigned long maxlen);
117 
118 private:
119  std::unique_ptr<IStream> m_io;
120 
121  // no copy or assign
122  Stream(const Stream &);
123  Stream &operator=(const Stream &);
124 };
125 
126 } // namespace librevenge
127 
128 #endif // RVNGOLESTREAM_H
129 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
Result result()
Returns the error code of last operation.
Definition: RVNGOLEStream.cpp:1757
unsigned long read(unsigned char *data, unsigned long maxlen)
Reads a block of data.
Definition: RVNGOLEStream.cpp:1800
std::vector< std::string > getSubStreamNamesList()
Returns the list of substream name.
Definition: RVNGOLEStream.cpp:1767
unsigned long size()
Returns the stream size.
Definition: RVNGOLEStream.cpp:1795
Definition: RVNGBinaryData.cpp:39
Definition: RVNGOLEStream.cpp:466
Definition: RVNGOLEStream.h:48
std::unique_ptr< IStorage > m_io
Definition: RVNGOLEStream.h:83
Definition: RVNGOLEStream.h:55
Definition: RVNGOLEStream.h:91
std::unique_ptr< IStream > m_io
Definition: RVNGOLEStream.h:119
Result
Definition: RVNGOLEStream.h:55
~Storage()
Destroys the storage.
Definition: RVNGOLEStream.cpp:1753
Definition: RVNGOLEStream.h:55
Stream(Storage *storage, const std::string &name)
Creates a new stream.
Definition: RVNGOLEStream.cpp:1785
Definition: RVNGOLEStream.h:55
Definition: RVNGOLEStream.h:55
Storage & operator=(const Storage &)
Stream & operator=(const Stream &)
Definition: RVNGOLEStream.h:55
bool isStructured()
Checks whether the storage is OLE2 storage.
Definition: RVNGOLEStream.cpp:1762
~Stream()
Destroys the stream.
Definition: RVNGOLEStream.cpp:1791
Storage(RVNGInputStream *is)
Constructs a storage with data.
Definition: RVNGOLEStream.cpp:1748
Definition: RVNGStream.h:33

Generated for librevenge by doxygen 1.8.10