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
29class MWAWStringStreamPrivate;
30
36 class MWAWStringStream final : public librevenge::RVNGInputStream
37{
38public:
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);
47 void resize(unsigned long newSize);
48
53 const unsigned char *read(unsigned long numBytes, unsigned long &numBytesRead) final;
55 long tell() final;
59 int seek(long offset, librevenge::RVNG_SEEK_TYPE seekType) final;
61 bool isEnd() final;
62
66 bool isStructured() final;
70 unsigned subStreamCount() final;
74 const char *subStreamName(unsigned) final;
78 bool existsSubStream(const char *name) final;
82 librevenge::RVNGInputStream *getSubStreamByName(const char *name) final;
86 librevenge::RVNGInputStream *getSubStreamById(unsigned) final;
87
88private:
90 std::shared_ptr<MWAWStringStreamPrivate> m_data;
91 MWAWStringStream(const MWAWStringStream &) = delete; // copy is not allowed
92 MWAWStringStream &operator=(const MWAWStringStream &) = delete; // assignment is not allowed
93};
94
95#endif
96
97// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWStringStreamPrivate
internal data of a MWAWStringStream
Definition MWAWStringStream.cxx:31
MWAWStringStream
internal class used to create a RVNGInputStream from a unsigned char's pointer
Definition MWAWStringStream.hxx:37
MWAWStringStream::subStreamName
const char * subStreamName(unsigned) final
returns the ith sub streams name
Definition MWAWStringStream.cxx:168
MWAWStringStream::existsSubStream
bool existsSubStream(const char *name) final
returns true if a substream with name exists
Definition MWAWStringStream.cxx:173
MWAWStringStream::getSubStreamByName
librevenge::RVNGInputStream * getSubStreamByName(const char *name) final
return a new stream for a ole zone
Definition MWAWStringStream.cxx:183
MWAWStringStream::tell
long tell() final
returns actual offset position
Definition MWAWStringStream.cxx:123
MWAWStringStream::append
void append(const unsigned char *data, const unsigned int dataSize)
append some data at the end of the string
Definition MWAWStringStream.cxx:87
MWAWStringStream::isStructured
bool isStructured() final
returns true if the stream is ole
Definition MWAWStringStream.cxx:158
MWAWStringStream::resize
void resize(unsigned long newSize)
resize the buffer stream (very low level)
Definition MWAWStringStream.cxx:92
MWAWStringStream::m_data
std::shared_ptr< MWAWStringStreamPrivate > m_data
the string stream data
Definition MWAWStringStream.hxx:90
MWAWStringStream::MWAWStringStream
MWAWStringStream(const MWAWStringStream &)=delete
MWAWStringStream::MWAWStringStream
MWAWStringStream(const unsigned char *data, const unsigned int dataSize)
constructor
Definition MWAWStringStream.cxx:77
MWAWStringStream::read
const unsigned char * read(unsigned long numBytes, unsigned long &numBytesRead) final
! reads numbytes data.
Definition MWAWStringStream.cxx:97
MWAWStringStream::operator=
MWAWStringStream & operator=(const MWAWStringStream &)=delete
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:128
MWAWStringStream::subStreamCount
unsigned subStreamCount() final
returns the number of sub streams.
Definition MWAWStringStream.cxx:163
MWAWStringStream::isEnd
bool isEnd() final
returns true if we are at the end of the section/file
Definition MWAWStringStream.cxx:150
MWAWStringStream::~MWAWStringStream
~MWAWStringStream() final
destructor
Definition MWAWStringStream.cxx:83
MWAWStringStream::getSubStreamById
librevenge::RVNGInputStream * getSubStreamById(unsigned) final
return a new stream for a ole zone
Definition MWAWStringStream.cxx:178