MWAWStringStream.hxx Source File documentation

MWAWStringStream.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Alternatively, the contents of this file may be used under the terms of
17 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
18 * in which case the provisions of the LGPLv2+ are applicable
19 * instead of those above.
20 */
21
22 #ifndef MWAW_STRING_STREAM_HXX
23 #define MWAW_STRING_STREAM_HXX
24
25 #include <memory>
26
27 #include <librevenge-stream/librevenge-stream.h>
28
29 class MWAWStringStreamPrivate;
30
36 class MWAWStringStream final : public librevenge::RVNGInputStream
37 {
38 public:
40 MWAWStringStream(const unsigned char *data, const unsigned int dataSize);
42 ~MWAWStringStream() final;
43
45 void append(const unsigned char *data, const unsigned int dataSize);
50 const unsigned char *read(unsigned long numBytes, unsigned long &numBytesRead) final;
52 long tell() final;
56 int seek(long offset, librevenge::RVNG_SEEK_TYPE seekType) final;
58 bool isEnd() final;
59
63 bool isStructured() final;
67 unsigned subStreamCount() final;
71 const char *subStreamName(unsigned) final;
75 bool existsSubStream(const char *name) final;
79 librevenge::RVNGInputStream *getSubStreamByName(const char *name) final;
83 librevenge::RVNGInputStream *getSubStreamById(unsigned) final;
84
85 private:
87 std::shared_ptr<MWAWStringStreamPrivate> m_data;
88 MWAWStringStream(const MWAWStringStream &) = delete; // copy is not allowed
89 MWAWStringStream &operator=(const MWAWStringStream &) = delete; // assignment is not allowed
90 };
91
92 #endif
93
94 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWStringStreamPrivate
internal data of a MWAWStringStream
Definition: MWAWStringStream.cxx:30
MWAWStringStream::getSubStreamById
librevenge::RVNGInputStream * getSubStreamById(unsigned) final
return a new stream for a ole zone
Definition: MWAWStringStream.cxx:166
MWAWStringStream::~MWAWStringStream
~MWAWStringStream() final
destructor
Definition: MWAWStringStream.cxx:76
MWAWStringStream::read
const unsigned char * read(unsigned long numBytes, unsigned long &numBytesRead) final
! reads numbytes data.
Definition: MWAWStringStream.cxx:85
MWAWStringStream::seek
int seek(long offset, librevenge::RVNG_SEEK_TYPE seekType) final
seeks to a offset position, from actual, beginning or ending position
Definition: MWAWStringStream.cxx:116
MWAWStringStream::isEnd
bool isEnd() final
returns true if we are at the end of the section/file
Definition: MWAWStringStream.cxx:138
MWAWStringStream::append
void append(const unsigned char *data, const unsigned int dataSize)
append some data at the end of the string
Definition: MWAWStringStream.cxx:80
MWAWStringStream::subStreamCount
unsigned subStreamCount() final
returns the number of sub streams.
Definition: MWAWStringStream.cxx:151
MWAWStringStream::subStreamName
const char * subStreamName(unsigned) final
returns the ith sub streams name
Definition: MWAWStringStream.cxx:156
MWAWStringStream::existsSubStream
bool existsSubStream(const char *name) final
returns true if a substream with name exists
Definition: MWAWStringStream.cxx:161
MWAWStringStream
internal class used to create a RVNGInputStream from a unsigned char&#39;s pointer
Definition: MWAWStringStream.hxx:36
MWAWStringStream::operator=
MWAWStringStream & operator=(const MWAWStringStream &)=delete
MWAWStringStream::getSubStreamByName
librevenge::RVNGInputStream * getSubStreamByName(const char *name) final
return a new stream for a ole zone
Definition: MWAWStringStream.cxx:171
MWAWStringStream::MWAWStringStream
MWAWStringStream(const unsigned char *data, const unsigned int dataSize)
constructor
Definition: MWAWStringStream.cxx:70
MWAWStringStream::m_data
std::shared_ptr< MWAWStringStreamPrivate > m_data
the string stream data
Definition: MWAWStringStream.hxx:87
MWAWStringStream::tell
long tell() final
returns actual offset position
Definition: MWAWStringStream.cxx:111
MWAWStringStream::isStructured
bool isStructured() final
returns true if the stream is ole
Definition: MWAWStringStream.cxx:146